From fe08201250d3262d186b369681e8e55c15f29c1a Mon Sep 17 00:00:00 2001 From: Bas Dado Date: Fri, 3 Jul 2026 20:42:47 +0200 Subject: [PATCH] [CLEANUP] Cleaner API gen (less unneeded stuff) --- .openapi-generator/FILES | 384 ++ .openapi-generator/VERSION | 1 + README.md | 12 +- generated/immich/openapi_client/__init__.py | 1219 ++-- .../immich/openapi_client/api/__init__.py | 34 - .../openapi_client/api/activities_api.py | 1191 ---- .../immich/openapi_client/api/albums_api.py | 135 +- .../immich/openapi_client/api/api_keys_api.py | 1626 ------ .../immich/openapi_client/api/assets_api.py | 253 +- .../openapi_client/api/authentication_api.py | 4509 --------------- .../openapi_client/api/deprecated_api.py | 4940 ----------------- .../immich/openapi_client/api/download_api.py | 660 --- .../openapi_client/api/duplicates_api.py | 1090 ---- .../immich/openapi_client/api/faces_api.py | 1153 ---- .../immich/openapi_client/api/jobs_api.py | 854 --- .../openapi_client/api/libraries_api.py | 2190 -------- .../immich/openapi_client/api/map_api.py | 691 --- .../immich/openapi_client/api/memories_api.py | 2437 -------- .../openapi_client/api/notifications_api.py | 1709 ------ .../immich/openapi_client/api/partners_api.py | 1395 ----- .../immich/openapi_client/api/people_api.py | 3124 ----------- .../immich/openapi_client/api/search_api.py | 51 +- .../immich/openapi_client/api/server_api.py | 3527 ------------ .../immich/openapi_client/api/sessions_api.py | 1612 ------ .../openapi_client/api/shared_links_api.py | 2587 --------- .../immich/openapi_client/api/stacks_api.py | 1937 ------- .../immich/openapi_client/api/sync_api.py | 1095 ---- .../openapi_client/api/system_config_api.py | 1057 ---- .../openapi_client/api/system_metadata_api.py | 1051 ---- .../immich/openapi_client/api/tags_api.py | 2516 --------- .../immich/openapi_client/api/timeline_api.py | 1067 ---- .../immich/openapi_client/api/trash_api.py | 809 --- .../openapi_client/api/users_admin_api.py | 3186 ----------- .../immich/openapi_client/api/users_api.py | 4244 -------------- generated/immich/openapi_client/api_client.py | 25 +- .../immich/openapi_client/configuration.py | 207 +- .../immich/openapi_client/docs/APIKeysApi.md | 559 -- .../openapi_client/docs/ActivitiesApi.md | 390 -- .../openapi_client/docs/ActivityCreateDto.md | 33 - .../docs/ActivityResponseDto.md | 34 - .../docs/ActivityStatisticsResponseDto.md | 30 - .../immich/openapi_client/docs/AddUsersDto.md | 29 - .../docs/AdminOnboardingUpdateDto.md | 29 - .../openapi_client/docs/AlbumResponseDto.md | 44 - .../docs/AlbumStatisticsResponseDto.md | 31 - .../openapi_client/docs/AlbumUserAddDto.md | 30 - .../openapi_client/docs/AlbumUserCreateDto.md | 30 - .../docs/AlbumUserResponseDto.md | 30 - .../openapi_client/docs/AlbumUserRole.md | 15 - .../immich/openapi_client/docs/AlbumsApi.md | 1241 ----- .../openapi_client/docs/AssetBulkDeleteDto.md | 30 - .../openapi_client/docs/AssetBulkUpdateDto.md | 39 - .../docs/AssetBulkUploadCheckDto.md | 29 - .../docs/AssetBulkUploadCheckItem.md | 30 - .../docs/AssetBulkUploadCheckResponseDto.md | 29 - .../docs/AssetBulkUploadCheckResult.md | 33 - .../openapi_client/docs/AssetFaceCreateDto.md | 36 - .../openapi_client/docs/AssetFaceDeleteDto.md | 29 - .../docs/AssetFaceResponseDto.md | 38 - .../openapi_client/docs/AssetFaceUpdateDto.md | 29 - .../docs/AssetFaceUpdateItem.md | 30 - .../immich/openapi_client/docs/AssetIdsDto.md | 29 - .../docs/AssetIdsResponseDto.md | 31 - .../openapi_client/docs/AssetJobName.md | 17 - .../openapi_client/docs/AssetJobsDto.md | 30 - .../docs/AssetMediaResponseDto.md | 30 - .../openapi_client/docs/AssetMediaSize.md | 17 - .../openapi_client/docs/AssetMediaStatus.md | 13 - .../immich/openapi_client/docs/AssetOrder.md | 13 - .../openapi_client/docs/AssetResponseDto.md | 60 - .../docs/AssetStackResponseDto.md | 31 - .../docs/AssetStatsResponseDto.md | 31 - .../openapi_client/docs/AssetTypeEnum.md | 17 - .../immich/openapi_client/docs/AssetsApi.md | 2503 --------- .../immich/openapi_client/docs/AudioCodec.md | 17 - .../openapi_client/docs/AuthenticationApi.md | 1410 ----- .../openapi_client/docs/AvatarUpdate.md | 29 - .../openapi_client/docs/BulkIdResponseDto.md | 32 - .../immich/openapi_client/docs/BulkIdsDto.md | 29 - .../immich/openapi_client/docs/CLIPConfig.md | 30 - .../immich/openapi_client/docs/CQMode.md | 15 - .../openapi_client/docs/ChangePasswordDto.md | 31 - .../immich/openapi_client/docs/Colorspace.md | 13 - .../openapi_client/docs/CreateAlbumDto.md | 32 - .../openapi_client/docs/CreateLibraryDto.md | 32 - .../docs/CreateProfileImageResponseDto.md | 31 - .../docs/DatabaseBackupConfig.md | 31 - .../openapi_client/docs/DeprecatedApi.md | 1622 ------ .../immich/openapi_client/docs/DownloadApi.md | 203 - .../docs/DownloadArchiveInfo.md | 30 - .../openapi_client/docs/DownloadInfoDto.md | 32 - .../openapi_client/docs/DownloadResponse.md | 30 - .../docs/DownloadResponseDto.md | 30 - .../openapi_client/docs/DownloadUpdate.md | 30 - .../docs/DuplicateDetectionConfig.md | 30 - .../docs/DuplicateResponseDto.md | 31 - .../openapi_client/docs/DuplicatesApi.md | 372 -- .../docs/EmailNotificationsResponse.md | 31 - .../docs/EmailNotificationsUpdate.md | 31 - .../openapi_client/docs/ExifResponseDto.md | 51 - .../immich/openapi_client/docs/FaceDto.md | 29 - .../immich/openapi_client/docs/FacesApi.md | 381 -- .../docs/FacialRecognitionConfig.md | 33 - .../openapi_client/docs/FoldersResponse.md | 30 - .../openapi_client/docs/FoldersUpdate.md | 30 - .../immich/openapi_client/docs/ImageFormat.md | 13 - .../openapi_client/docs/JobCreateDto.md | 29 - .../immich/openapi_client/docs/JobName.md | 141 - .../openapi_client/docs/JobSettingsDto.md | 29 - .../immich/openapi_client/docs/JobsApi.md | 285 - .../openapi_client/docs/LibrariesApi.md | 749 --- .../openapi_client/docs/LibraryResponseDto.md | 37 - .../docs/LibraryStatsResponseDto.md | 32 - .../openapi_client/docs/LicenseKeyDto.md | 30 - .../immich/openapi_client/docs/LogLevel.md | 21 - .../openapi_client/docs/LoginCredentialDto.md | 30 - .../openapi_client/docs/LoginResponseDto.md | 36 - .../openapi_client/docs/LogoutResponseDto.md | 30 - .../openapi_client/docs/ManualJobName.md | 39 - .../immich/openapi_client/docs/MapApi.md | 206 - .../docs/MapMarkerResponseDto.md | 34 - .../docs/MapReverseGeocodeResponseDto.md | 31 - .../immich/openapi_client/docs/MemoriesApi.md | 783 --- .../openapi_client/docs/MemoriesResponse.md | 30 - .../openapi_client/docs/MemoriesUpdate.md | 30 - .../openapi_client/docs/MemoryCreateDto.md | 36 - .../openapi_client/docs/MemoryResponseDto.md | 41 - .../immich/openapi_client/docs/MemoryType.md | 11 - .../openapi_client/docs/MemoryUpdateDto.md | 31 - .../openapi_client/docs/MergePersonDto.md | 29 - .../openapi_client/docs/MetadataSearchDto.md | 70 - .../openapi_client/docs/NotificationsApi.md | 570 -- .../docs/OAuthAuthorizeResponseDto.md | 29 - .../openapi_client/docs/OAuthCallbackDto.md | 31 - .../openapi_client/docs/OAuthConfigDto.md | 31 - .../openapi_client/docs/OnThisDayDto.md | 29 - .../openapi_client/docs/PartnerDirection.md | 13 - .../openapi_client/docs/PartnerResponseDto.md | 36 - .../immich/openapi_client/docs/PartnersApi.md | 475 -- .../immich/openapi_client/docs/PeopleApi.md | 1044 ---- .../openapi_client/docs/PeopleResponse.md | 31 - .../openapi_client/docs/PeopleResponseDto.md | 33 - .../openapi_client/docs/PeopleUpdate.md | 31 - .../openapi_client/docs/PeopleUpdateDto.md | 29 - .../openapi_client/docs/PeopleUpdateItem.md | 35 - .../immich/openapi_client/docs/Permission.md | 319 -- .../openapi_client/docs/PersonCreateDto.md | 33 - .../openapi_client/docs/PersonResponseDto.md | 36 - .../docs/PersonStatisticsResponseDto.md | 29 - .../openapi_client/docs/PersonUpdateDto.md | 34 - .../openapi_client/docs/PlacesResponseDto.md | 33 - .../openapi_client/docs/PurchaseResponse.md | 30 - .../openapi_client/docs/PurchaseUpdate.md | 30 - .../openapi_client/docs/RandomSearchDto.md | 60 - .../openapi_client/docs/RatingsResponse.md | 29 - .../openapi_client/docs/RatingsUpdate.md | 29 - .../openapi_client/docs/ReactionLevel.md | 13 - .../openapi_client/docs/ReactionType.md | 13 - .../docs/ReverseGeocodingStateResponseDto.md | 30 - .../docs/SearchAlbumResponseDto.md | 32 - .../immich/openapi_client/docs/SearchApi.md | 1010 ---- .../docs/SearchAssetResponseDto.md | 33 - .../openapi_client/docs/SearchExploreItem.md | 30 - .../docs/SearchExploreResponseDto.md | 30 - .../docs/SearchFacetCountResponseDto.md | 30 - .../docs/SearchFacetResponseDto.md | 30 - .../openapi_client/docs/SearchResponseDto.md | 30 - .../docs/SearchSuggestionType.md | 21 - .../docs/ServerAboutResponseDto.md | 49 - .../immich/openapi_client/docs/ServerApi.md | 1113 ---- .../openapi_client/docs/ServerConfigDto.md | 40 - .../openapi_client/docs/ServerFeaturesDto.md | 44 - .../docs/ServerMediaTypesResponseDto.md | 31 - .../openapi_client/docs/ServerPingResponse.md | 29 - .../docs/ServerStatsResponseDto.md | 34 - .../docs/ServerStorageResponseDto.md | 35 - .../docs/ServerVersionHistoryResponseDto.md | 31 - .../docs/ServerVersionResponseDto.md | 32 - .../openapi_client/docs/SessionResponseDto.md | 37 - .../immich/openapi_client/docs/SessionsApi.md | 553 -- .../docs/SharedLinkCreateDto.md | 38 - .../openapi_client/docs/SharedLinkEditDto.md | 35 - .../docs/SharedLinkResponseDto.md | 43 - .../openapi_client/docs/SharedLinkType.md | 13 - .../openapi_client/docs/SharedLinksApi.md | 861 --- .../docs/SharedLinksResponse.md | 30 - .../openapi_client/docs/SharedLinksUpdate.md | 30 - .../immich/openapi_client/docs/SignUpDto.md | 31 - .../openapi_client/docs/SmartSearchDto.md | 62 - .../immich/openapi_client/docs/SourceType.md | 15 - .../openapi_client/docs/StackCreateDto.md | 29 - .../openapi_client/docs/StackResponseDto.md | 32 - .../openapi_client/docs/StackUpdateDto.md | 29 - .../immich/openapi_client/docs/StacksApi.md | 657 --- .../openapi_client/docs/SyncAckDeleteDto.md | 29 - .../immich/openapi_client/docs/SyncAckDto.md | 30 - .../openapi_client/docs/SyncAckSetDto.md | 29 - .../immich/openapi_client/docs/SyncApi.md | 370 -- .../openapi_client/docs/SyncAssetDeleteV1.md | 29 - .../openapi_client/docs/SyncAssetExifV1.md | 53 - .../immich/openapi_client/docs/SyncAssetV1.md | 48 - .../openapi_client/docs/SyncEntityType.md | 127 - .../docs/SyncPartnerDeleteV1.md | 30 - .../openapi_client/docs/SyncPartnerV1.md | 31 - .../openapi_client/docs/SyncRequestType.md | 63 - .../openapi_client/docs/SyncStreamDto.md | 30 - .../openapi_client/docs/SyncUserDeleteV1.md | 29 - .../immich/openapi_client/docs/SyncUserV1.md | 35 - .../openapi_client/docs/SystemConfigApi.md | 368 -- .../docs/SystemConfigBackupsDto.md | 29 - .../openapi_client/docs/SystemConfigDto.md | 51 - .../docs/SystemConfigFFmpegDto.md | 50 - .../docs/SystemConfigFacesDto.md | 29 - .../SystemConfigGeneratedFullsizeImageDto.md | 32 - .../docs/SystemConfigGeneratedImageDto.md | 32 - .../docs/SystemConfigImageDto.md | 33 - .../openapi_client/docs/SystemConfigJobDto.md | 43 - .../docs/SystemConfigLibraryDto.md | 30 - .../docs/SystemConfigLibraryScanDto.md | 30 - .../docs/SystemConfigLibraryWatchDto.md | 29 - .../docs/SystemConfigLoggingDto.md | 30 - .../docs/SystemConfigMachineLearningDto.md | 35 - .../openapi_client/docs/SystemConfigMapDto.md | 31 - .../docs/SystemConfigMetadataDto.md | 29 - .../docs/SystemConfigNewVersionCheckDto.md | 30 - .../docs/SystemConfigNotificationsDto.md | 29 - .../docs/SystemConfigOAuthDto.md | 49 - .../docs/SystemConfigPasswordLoginDto.md | 29 - .../docs/SystemConfigReverseGeocodingDto.md | 29 - .../docs/SystemConfigServerDto.md | 31 - .../docs/SystemConfigSmtpDto.md | 32 - .../docs/SystemConfigSmtpTransportDto.md | 34 - .../docs/SystemConfigStorageTemplateDto.md | 31 - .../docs/SystemConfigTemplateEmailsDto.md | 31 - .../SystemConfigTemplateStorageOptionDto.md | 36 - .../docs/SystemConfigTemplatesDto.md | 29 - .../docs/SystemConfigThemeDto.md | 29 - .../docs/SystemConfigTrashDto.md | 30 - .../docs/SystemConfigUserDto.md | 29 - .../openapi_client/docs/SystemMetadataApi.md | 366 -- .../openapi_client/docs/TagBulkAssetsDto.md | 30 - .../docs/TagBulkAssetsResponseDto.md | 29 - .../openapi_client/docs/TagCreateDto.md | 31 - .../openapi_client/docs/TagResponseDto.md | 35 - .../openapi_client/docs/TagUpdateDto.md | 29 - .../openapi_client/docs/TagUpsertDto.md | 29 - .../immich/openapi_client/docs/TagsApi.md | 850 --- .../openapi_client/docs/TagsResponse.md | 30 - .../immich/openapi_client/docs/TagsUpdate.md | 30 - .../immich/openapi_client/docs/TemplateDto.md | 29 - .../docs/TemplateResponseDto.md | 30 - .../docs/TestEmailResponseDto.md | 29 - .../immich/openapi_client/docs/TimelineApi.md | 258 - .../immich/openapi_client/docs/ToneMapping.md | 17 - .../openapi_client/docs/TranscodeHWAccel.md | 19 - .../openapi_client/docs/TranscodePolicy.md | 19 - .../immich/openapi_client/docs/TrashApi.md | 280 - .../openapi_client/docs/TrashResponseDto.md | 29 - .../openapi_client/docs/UpdateAlbumDto.md | 33 - .../openapi_client/docs/UpdateAlbumUserDto.md | 29 - .../openapi_client/docs/UpdateAssetDto.md | 36 - .../openapi_client/docs/UpdateLibraryDto.md | 31 - .../openapi_client/docs/UsageByUserDto.md | 36 - .../openapi_client/docs/UserAdminCreateDto.md | 38 - .../openapi_client/docs/UserAdminDeleteDto.md | 29 - .../docs/UserAdminResponseDto.md | 45 - .../openapi_client/docs/UserAdminUpdateDto.md | 37 - .../openapi_client/docs/UserAvatarColor.md | 29 - .../immich/openapi_client/docs/UserLicense.md | 31 - .../docs/UserPreferencesResponseDto.md | 40 - .../docs/UserPreferencesUpdateDto.md | 41 - .../openapi_client/docs/UserResponseDto.md | 34 - .../immich/openapi_client/docs/UserStatus.md | 15 - .../openapi_client/docs/UserUpdateMeDto.md | 32 - .../openapi_client/docs/UsersAdminApi.md | 1057 ---- .../immich/openapi_client/docs/UsersApi.md | 1463 ----- .../docs/ValidateAccessTokenResponseDto.md | 29 - .../openapi_client/docs/ValidateLibraryDto.md | 30 - .../ValidateLibraryImportPathResponseDto.md | 31 - .../docs/ValidateLibraryResponseDto.md | 29 - .../immich/openapi_client/docs/VideoCodec.md | 17 - .../openapi_client/docs/VideoContainer.md | 17 - generated/immich/openapi_client/exceptions.py | 26 +- .../immich/openapi_client/models/__init__.py | 2 +- .../models/activity_create_dto.py | 8 +- .../models/activity_response_dto.py | 8 +- .../models/album_response_dto.py | 7 +- .../models/album_user_add_dto.py | 6 +- .../models/album_user_create_dto.py | 6 +- .../models/albums_add_assets_dto.py | 91 + .../models/albums_add_assets_response_dto.py | 90 + .../openapi_client/models/albums_response.py | 88 + .../openapi_client/models/albums_update.py | 88 + .../models/api_key_response_dto.py | 6 +- .../models/asset_bulk_delete_dto.py | 6 +- .../models/asset_bulk_update_dto.py | 5 +- .../models/asset_bulk_upload_check_result.py | 6 +- .../openapi_client/models/asset_copy_dto.py | 114 + .../models/asset_edit_action.py | 38 + .../models/asset_edit_action_item_dto.py | 94 + .../asset_edit_action_item_dto_parameters.py | 149 + .../asset_edit_action_item_response_dto.py | 104 + .../models/asset_edits_create_dto.py | 96 + .../models/asset_edits_response_dto.py | 105 + .../models/asset_face_create_dto.py | 7 +- .../models/asset_face_response_dto.py | 5 +- .../models/asset_face_update_item.py | 8 +- .../models/asset_id_error_reason.py | 38 + .../openapi_client/models/asset_ids_dto.py | 6 +- .../models/asset_ids_response_dto.py | 6 +- .../openapi_client/models/asset_jobs_dto.py | 6 +- .../models/asset_media_response_dto.py | 6 +- .../models/asset_metadata_bulk_delete_dto.py | 95 + .../asset_metadata_bulk_delete_item_dto.py | 97 + .../asset_metadata_bulk_response_dto.py | 109 + .../models/asset_metadata_bulk_upsert_dto.py | 95 + .../asset_metadata_bulk_upsert_item_dto.py | 99 + .../models/asset_metadata_response_dto.py | 99 + .../models/asset_metadata_upsert_dto.py | 95 + .../models/asset_metadata_upsert_item_dto.py | 89 + .../models/asset_ocr_response_dto.py | 126 + .../openapi_client/models/asset_order_by.py | 37 + .../models/asset_reject_reason.py | 37 + .../models/asset_response_dto.py | 11 +- .../models/asset_stack_response_dto.py | 7 +- .../models/asset_upload_action.py | 37 + .../openapi_client/models/asset_visibility.py | 39 + .../models/auth_status_response_dto.py | 95 + .../models/bulk_id_error_reason.py | 40 + .../models/bulk_id_response_dto.py | 6 +- .../openapi_client/models/bulk_ids_dto.py | 6 +- .../models/calendar_heatmap_response_dto.py | 102 + ...endar_heatmap_response_dto_series_inner.py | 90 + .../models/calendar_heatmap_type.py | 37 + .../openapi_client/models/cast_response.py | 87 + .../openapi_client/models/cast_update.py | 87 + .../models/contributor_count_response_dto.py | 97 + .../openapi_client/models/create_album_dto.py | 6 +- .../models/create_library_dto.py | 5 +- .../create_profile_image_response_dto.py | 6 +- .../openapi_client/models/crop_parameters.py | 94 + .../models/database_backup_delete_dto.py | 87 + .../models/database_backup_dto.py | 92 + .../database_backup_list_response_dto.py | 95 + .../models/download_archive_dto.py | 90 + .../models/download_archive_info.py | 5 +- .../models/download_info_dto.py | 9 +- .../models/duplicate_resolve_dto.py | 96 + .../models/duplicate_resolve_group_dto.py | 99 + .../models/duplicate_response_dto.py | 8 +- .../immich/openapi_client/models/face_dto.py | 6 +- .../openapi_client/models/integrity_report.py | 38 + .../models/integrity_report_response_dto.py | 97 + ...tegrity_report_response_dto_items_inner.py | 100 + .../integrity_report_summary_response_dto.py | 92 + .../models/library_response_dto.py | 7 +- .../models/login_response_dto.py | 3 +- ...achine_learning_availability_checks_dto.py | 92 + .../models/maintenance_action.py | 39 + .../models/maintenance_auth_dto.py | 87 + ...maintenance_detect_install_response_dto.py | 95 + ...nance_detect_install_storage_folder_dto.py | 95 + .../models/maintenance_login_dto.py | 87 + .../models/maintenance_status_response_dto.py | 97 + .../models/map_marker_response_dto.py | 6 +- .../models/memory_create_dto.py | 6 +- .../models/memory_response_dto.py | 8 +- .../models/memory_search_order.py | 38 + .../models/memory_statistics_response_dto.py | 88 + .../models/memory_update_dto.py | 2 +- .../openapi_client/models/merge_person_dto.py | 6 +- .../models/metadata_search_dto.py | 13 +- .../openapi_client/models/mirror_axis.py | 37 + .../models/mirror_parameters.py | 88 + .../models/notification_create_dto.py | 130 + .../models/notification_delete_all_dto.py | 88 + .../openapi_client/models/notification_dto.py | 129 + .../models/notification_level.py | 39 + .../models/notification_type.py | 41 + .../models/notification_update_all_dto.py | 106 + .../models/notification_update_dto.py | 103 + .../o_auth_token_endpoint_auth_method.py | 37 + .../openapi_client/models/ocr_config.py | 96 + .../openapi_client/models/onboarding_dto.py | 87 + .../models/onboarding_response_dto.py | 87 + .../models/partner_create_dto.py | 95 + .../models/partner_response_dto.py | 3 +- .../models/partner_update_dto.py | 87 + .../models/people_update_item.py | 5 +- .../models/person_response_dto.py | 6 +- .../models/person_update_dto.py | 3 +- .../models/pin_code_change_dto.py | 109 + .../models/pin_code_reset_dto.py | 100 + .../models/pin_code_setup_dto.py | 95 + .../models/plugin_method_response_dto.py | 102 + .../models/plugin_response_dto.py | 119 + .../models/plugin_template_response_dto.py | 106 + .../plugin_template_step_response_dto.py | 96 + .../openapi_client/models/queue_command.py | 40 + .../models/queue_command_dto.py | 90 + .../openapi_client/models/queue_delete_dto.py | 87 + .../models/queue_job_response_dto.py | 95 + .../openapi_client/models/queue_job_status.py | 41 + .../openapi_client/models/queue_name.py | 54 + .../models/queue_response_dto.py | 96 + .../models/queue_response_legacy_dto.py | 97 + .../models/queue_statistics_dto.py | 98 + .../models/queue_status_legacy_dto.py | 89 + .../openapi_client/models/queue_update_dto.py | 87 + .../models/queues_response_legacy_dto.py | 181 + .../models/random_search_dto.py | 11 +- .../models/recently_added_response.py | 87 + .../models/recently_added_update.py | 87 + .../openapi_client/models/release_channel.py | 37 + .../openapi_client/models/release_event_v1.py | 103 + .../openapi_client/models/release_type.py | 42 + .../models/rotate_parameters.py | 87 + .../models/search_statistics_response_dto.py | 88 + .../models/server_apk_links_dto.py | 93 + .../server_version_history_response_dto.py | 6 +- .../models/session_create_dto.py | 92 + .../models/session_create_response_dto.py | 118 + .../models/session_response_dto.py | 6 +- .../models/session_unlock_dto.py | 100 + .../models/session_update_dto.py | 87 + .../models/set_maintenance_mode_dto.py | 90 + .../models/shared_link_create_dto.py | 8 +- .../models/shared_link_edit_dto.py | 2 +- .../models/shared_link_login_dto.py | 87 + .../models/shared_link_response_dto.py | 8 +- .../openapi_client/models/smart_search_dto.py | 13 +- .../openapi_client/models/stack_create_dto.py | 5 +- .../models/stack_response_dto.py | 8 +- .../openapi_client/models/stack_update_dto.py | 6 +- .../models/statistics_search_dto.py | 280 + .../openapi_client/models/storage_folder.py | 41 + .../models/sync_album_delete_v1.py | 95 + .../models/sync_album_to_asset_delete_v1.py | 104 + .../models/sync_album_to_asset_v1.py | 104 + .../models/sync_album_user_delete_v1.py | 104 + .../models/sync_album_user_v1.py | 107 + .../openapi_client/models/sync_album_v1.py | 139 + .../openapi_client/models/sync_album_v2.py | 130 + .../models/sync_asset_delete_v1.py | 6 +- .../models/sync_asset_edit_delete_v1.py | 95 + .../models/sync_asset_edit_v1.py | 111 + .../models/sync_asset_exif_v1.py | 5 +- .../models/sync_asset_face_delete_v1.py | 95 + .../models/sync_asset_face_v1.py | 125 + .../models/sync_asset_face_v2.py | 145 + .../models/sync_asset_metadata_delete_v1.py | 97 + .../models/sync_asset_metadata_v1.py | 99 + .../models/sync_asset_ocr_delete_v1.py | 99 + .../models/sync_asset_ocr_v1.py | 128 + .../openapi_client/models/sync_asset_v1.py | 7 +- .../openapi_client/models/sync_asset_v2.py | 253 + .../models/sync_auth_user_v1.py | 163 + .../models/sync_memory_asset_delete_v1.py | 104 + .../models/sync_memory_asset_v1.py | 104 + .../models/sync_memory_delete_v1.py | 95 + .../openapi_client/models/sync_memory_v1.py | 207 + .../models/sync_partner_delete_v1.py | 8 +- .../openapi_client/models/sync_partner_v1.py | 8 +- .../models/sync_person_delete_v1.py | 95 + .../openapi_client/models/sync_person_v1.py | 160 + .../models/sync_stack_delete_v1.py | 95 + .../openapi_client/models/sync_stack_v1.py | 132 + .../models/sync_user_delete_v1.py | 6 +- .../models/sync_user_metadata_delete_v1.py | 98 + .../models/sync_user_metadata_v1.py | 100 + .../openapi_client/models/sync_user_v1.py | 6 +- .../system_config_f_fmpeg_realtime_dto.py | 87 + .../models/system_config_integrity_checks.py | 102 + .../system_config_integrity_checksum_job.py | 94 + .../models/system_config_integrity_job.py | 89 + .../models/system_config_nightly_tasks_dto.py | 105 + .../models/tag_bulk_assets_dto.py | 8 +- .../openapi_client/models/tag_create_dto.py | 3 +- .../openapi_client/models/tag_response_dto.py | 6 +- .../models/time_bucket_asset_response_dto.py | 125 + .../models/time_buckets_response_dto.py | 90 + .../openapi_client/models/update_album_dto.py | 6 +- .../openapi_client/models/update_asset_dto.py | 5 +- .../models/usage_by_user_dto.py | 5 +- .../models/user_admin_response_dto.py | 3 +- .../models/user_metadata_key.py | 38 + .../models/user_response_dto.py | 3 +- .../version_check_state_response_dto.py | 99 + .../models/workflow_create_dto.py | 114 + .../models/workflow_response_dto.py | 128 + .../models/workflow_share_response_dto.py | 112 + .../models/workflow_share_step_dto.py | 96 + .../models/workflow_step_dto.py | 96 + .../openapi_client/models/workflow_trigger.py | 37 + .../models/workflow_trigger_response_dto.py | 91 + .../openapi_client/models/workflow_type.py | 36 + .../models/workflow_update_dto.py | 114 + generated/immich/openapi_client/rest.py | 10 +- .../immich/openapi_client/test/__init__.py | 0 .../test/test_activities_api.py | 59 - .../test/test_activity_create_dto.py | 56 - .../test/test_activity_response_dto.py | 73 - .../test_activity_statistics_response_dto.py | 54 - .../openapi_client/test/test_add_users_dto.py | 60 - .../test/test_admin_onboarding_update_dto.py | 52 - .../test/test_album_response_dto.py | 101 - .../test_album_statistics_response_dto.py | 56 - .../test/test_album_user_add_dto.py | 53 - .../test/test_album_user_create_dto.py | 54 - .../test/test_album_user_response_dto.py | 66 - .../test/test_album_user_role.py | 33 - .../openapi_client/test/test_albums_api.py | 122 - .../test/test_api_key_create_dto.py | 57 - .../test/test_api_key_create_response_dto.py | 68 - .../test/test_api_key_response_dto.py | 64 - .../test/test_api_key_update_dto.py | 54 - .../openapi_client/test/test_api_keys_api.py | 73 - .../test/test_asset_bulk_delete_dto.py | 57 - .../test/test_asset_bulk_update_dto.py | 66 - .../test/test_asset_bulk_upload_check_dto.py | 60 - .../test/test_asset_bulk_upload_check_item.py | 54 - ...st_asset_bulk_upload_check_response_dto.py | 66 - .../test_asset_bulk_upload_check_result.py | 57 - .../test/test_asset_face_create_dto.py | 66 - .../test/test_asset_face_delete_dto.py | 52 - .../test/test_asset_face_response_dto.py | 83 - .../test/test_asset_face_update_dto.py | 60 - .../test/test_asset_face_update_item.py | 54 - .../openapi_client/test/test_asset_ids_dto.py | 56 - .../test/test_asset_ids_response_dto.py | 55 - .../test/test_asset_job_name.py | 33 - .../test/test_asset_jobs_dto.py | 58 - .../test/test_asset_media_response_dto.py | 54 - .../test/test_asset_media_size.py | 33 - .../test/test_asset_media_status.py | 33 - .../openapi_client/test/test_asset_order.py | 33 - .../test/test_asset_response_dto.py | 154 - .../test/test_asset_stack_response_dto.py | 56 - .../test/test_asset_stats_response_dto.py | 56 - .../test/test_asset_type_enum.py | 33 - .../openapi_client/test/test_assets_api.py | 213 - .../openapi_client/test/test_audio_codec.py | 33 - .../test/test_authentication_api.py | 150 - .../openapi_client/test/test_avatar_update.py | 51 - .../test/test_bulk_id_response_dto.py | 56 - .../openapi_client/test/test_bulk_ids_dto.py | 56 - .../test/test_change_password_dto.py | 55 - .../openapi_client/test/test_clip_config.py | 54 - .../openapi_client/test/test_colorspace.py | 33 - .../openapi_client/test/test_cq_mode.py | 33 - .../test/test_create_album_dto.py | 61 - .../test/test_create_library_dto.py | 59 - .../test_create_profile_image_response_dto.py | 56 - .../test/test_database_backup_config.py | 56 - .../test/test_deprecated_api.py | 150 - .../openapi_client/test/test_download_api.py | 45 - .../test/test_download_archive_info.py | 58 - .../test/test_download_info_dto.py | 56 - .../test/test_download_response.py | 54 - .../test/test_download_response_dto.py | 66 - .../test/test_download_update.py | 52 - .../test/test_duplicate_detection_config.py | 54 - .../test/test_duplicate_response_dto.py | 222 - .../test/test_duplicates_api.py | 59 - .../test/test_email_notifications_response.py | 56 - .../test/test_email_notifications_update.py | 53 - .../test/test_exif_response_dto.py | 72 - .../openapi_client/test/test_face_dto.py | 52 - .../openapi_client/test/test_faces_api.py | 59 - .../test/test_facial_recognition_config.py | 60 - .../test/test_folders_response.py | 54 - .../test/test_folders_update.py | 52 - .../openapi_client/test/test_image_format.py | 33 - .../test/test_job_create_dto.py | 52 - .../openapi_client/test/test_job_name.py | 33 - .../test/test_job_settings_dto.py | 52 - .../openapi_client/test/test_jobs_api.py | 52 - .../openapi_client/test/test_libraries_api.py | 87 - .../test/test_library_response_dto.py | 76 - .../test/test_library_stats_response_dto.py | 58 - .../test/test_license_key_dto.py | 54 - .../openapi_client/test/test_log_level.py | 33 - .../test/test_login_credential_dto.py | 54 - .../test/test_login_response_dto.py | 66 - .../test/test_logout_response_dto.py | 54 - .../test/test_manual_job_name.py | 33 - .../openapi_client/test/test_map_api.py | 45 - .../test/test_map_marker_response_dto.py | 62 - .../test_map_reverse_geocode_response_dto.py | 56 - .../openapi_client/test/test_memories_api.py | 87 - .../test/test_memories_response.py | 54 - .../test/test_memories_update.py | 52 - .../test/test_memory_create_dto.py | 65 - .../test/test_memory_response_dto.py | 236 - .../openapi_client/test/test_memory_type.py | 33 - .../test/test_memory_update_dto.py | 53 - .../test/test_merge_person_dto.py | 56 - .../test/test_metadata_search_dto.py | 98 - .../test/test_notifications_api.py | 73 - .../test_o_auth_authorize_response_dto.py | 52 - .../test/test_o_auth_callback_dto.py | 54 - .../test/test_o_auth_config_dto.py | 54 - .../test/test_on_this_day_dto.py | 52 - .../test/test_partner_direction.py | 33 - .../test/test_partner_response_dto.py | 63 - .../openapi_client/test/test_partners_api.py | 66 - .../openapi_client/test/test_people_api.py | 108 - .../test/test_people_response.py | 55 - .../test/test_people_response_dto.py | 77 - .../openapi_client/test/test_people_update.py | 53 - .../test/test_people_update_dto.py | 70 - .../test/test_people_update_item.py | 58 - .../openapi_client/test/test_permission.py | 33 - .../test/test_person_create_dto.py | 55 - .../test/test_person_response_dto.py | 63 - .../test_person_statistics_response_dto.py | 52 - .../test/test_person_update_dto.py | 56 - .../test/test_places_response_dto.py | 58 - .../test/test_purchase_response.py | 54 - .../test/test_purchase_update.py | 52 - .../test/test_random_search_dto.py | 88 - .../test/test_ratings_response.py | 52 - .../test/test_ratings_update.py | 51 - .../test/test_reaction_level.py | 33 - .../openapi_client/test/test_reaction_type.py | 33 - ...st_reverse_geocoding_state_response_dto.py | 54 - .../test/test_search_album_response_dto.py | 138 - .../openapi_client/test/test_search_api.py | 101 - .../test/test_search_asset_response_dto.py | 238 - .../test/test_search_explore_item.py | 212 - .../test/test_search_explore_response_dto.py | 220 - .../test_search_facet_count_response_dto.py | 54 - .../test/test_search_facet_response_dto.py | 62 - .../test/test_search_response_dto.py | 330 -- .../test/test_search_suggestion_type.py | 33 - .../test/test_server_about_response_dto.py | 74 - .../openapi_client/test/test_server_api.py | 129 - .../test/test_server_config_dto.py | 74 - .../test/test_server_features_dto.py | 82 - .../test_server_media_types_response_dto.py | 68 - .../test/test_server_ping_response.py | 52 - .../test/test_server_stats_response_dto.py | 82 - .../test/test_server_storage_response_dto.py | 64 - ...est_server_version_history_response_dto.py | 56 - .../test/test_server_version_response_dto.py | 58 - .../test/test_session_response_dto.py | 67 - .../openapi_client/test/test_sessions_api.py | 73 - .../test/test_shared_link_create_dto.py | 63 - .../test/test_shared_link_edit_dto.py | 57 - .../test/test_shared_link_response_dto.py | 269 - .../test/test_shared_link_type.py | 33 - .../test/test_shared_links_api.py | 94 - .../test/test_shared_links_response.py | 54 - .../test/test_shared_links_update.py | 52 - .../openapi_client/test/test_sign_up_dto.py | 56 - .../test/test_smart_search_dto.py | 90 - .../openapi_client/test/test_source_type.py | 33 - .../test/test_stack_create_dto.py | 56 - .../test/test_stack_response_dto.py | 218 - .../test/test_stack_update_dto.py | 51 - .../openapi_client/test/test_stacks_api.py | 80 - .../test/test_sync_ack_delete_dto.py | 53 - .../openapi_client/test/test_sync_ack_dto.py | 54 - .../test/test_sync_ack_set_dto.py | 56 - .../openapi_client/test/test_sync_api.py | 59 - .../test/test_sync_asset_delete_v1.py | 52 - .../test/test_sync_asset_exif_v1.py | 100 - .../openapi_client/test/test_sync_asset_v1.py | 90 - .../test/test_sync_entity_type.py | 33 - .../test/test_sync_partner_delete_v1.py | 54 - .../test/test_sync_partner_v1.py | 56 - .../test/test_sync_request_type.py | 33 - .../test/test_sync_stream_dto.py | 57 - .../test/test_sync_user_delete_v1.py | 52 - .../openapi_client/test/test_sync_user_v1.py | 63 - .../test/test_system_config_api.py | 59 - .../test/test_system_config_backups_dto.py | 58 - .../test/test_system_config_dto.py | 438 -- .../test/test_system_config_f_fmpeg_dto.py | 108 - .../test/test_system_config_faces_dto.py | 52 - ...tem_config_generated_fullsize_image_dto.py | 57 - .../test_system_config_generated_image_dto.py | 57 - .../test/test_system_config_image_dto.py | 84 - .../test/test_system_config_job_dto.py | 110 - .../test/test_system_config_library_dto.py | 60 - .../test_system_config_library_scan_dto.py | 54 - .../test_system_config_library_watch_dto.py | 52 - .../test/test_system_config_logging_dto.py | 54 - ...test_system_config_machine_learning_dto.py | 102 - .../test/test_system_config_map_dto.py | 56 - .../test/test_system_config_metadata_dto.py | 54 - ...est_system_config_new_version_check_dto.py | 54 - .../test_system_config_notifications_dto.py | 72 - .../test/test_system_config_o_auth_dto.py | 92 - .../test_system_config_password_login_dto.py | 52 - ...est_system_config_reverse_geocoding_dto.py | 52 - .../test/test_system_config_server_dto.py | 56 - .../test/test_system_config_smtp_dto.py | 70 - .../test_system_config_smtp_transport_dto.py | 62 - ...test_system_config_storage_template_dto.py | 56 - .../test_system_config_template_emails_dto.py | 56 - ...stem_config_template_storage_option_dto.py | 98 - .../test/test_system_config_templates_dto.py | 58 - .../test/test_system_config_theme_dto.py | 52 - .../test/test_system_config_trash_dto.py | 54 - .../test/test_system_config_user_dto.py | 52 - .../test/test_system_metadata_api.py | 59 - .../test/test_tag_bulk_assets_dto.py | 62 - .../test/test_tag_bulk_assets_response_dto.py | 52 - .../test/test_tag_create_dto.py | 54 - .../test/test_tag_response_dto.py | 62 - .../test/test_tag_update_dto.py | 51 - .../test/test_tag_upsert_dto.py | 56 - .../openapi_client/test/test_tags_api.py | 94 - .../openapi_client/test/test_tags_response.py | 54 - .../openapi_client/test/test_tags_update.py | 52 - .../openapi_client/test/test_template_dto.py | 52 - .../test/test_template_response_dto.py | 54 - .../test/test_test_email_response_dto.py | 52 - .../openapi_client/test/test_timeline_api.py | 45 - .../openapi_client/test/test_tone_mapping.py | 33 - .../test/test_transcode_hw_accel.py | 33 - .../test/test_transcode_policy.py | 33 - .../openapi_client/test/test_trash_api.py | 52 - .../test/test_trash_response_dto.py | 52 - .../test/test_update_album_dto.py | 55 - .../test/test_update_album_user_dto.py | 52 - .../test/test_update_asset_dto.py | 58 - .../test/test_update_library_dto.py | 57 - .../test/test_usage_by_user_dto.py | 66 - .../test/test_user_admin_create_dto.py | 63 - .../test/test_user_admin_delete_dto.py | 51 - .../test/test_user_admin_response_dto.py | 90 - .../test/test_user_admin_update_dto.py | 59 - .../test/test_user_avatar_color.py | 33 - .../openapi_client/test/test_user_license.py | 56 - .../test_user_preferences_response_dto.py | 118 - .../test/test_user_preferences_update_dto.py | 86 - .../test/test_user_response_dto.py | 62 - .../openapi_client/test/test_user_status.py | 33 - .../test/test_user_update_me_dto.py | 54 - .../test/test_users_admin_api.py | 108 - .../openapi_client/test/test_users_api.py | 143 - ...test_validate_access_token_response_dto.py | 52 - .../test/test_validate_library_dto.py | 56 - ...lidate_library_import_path_response_dto.py | 55 - .../test_validate_library_response_dto.py | 56 - .../openapi_client/test/test_video_codec.py | 33 - .../test/test_video_container.py | 33 - generated/immich/openapi_client_README.md | 241 +- 750 files changed, 15316 insertions(+), 100454 deletions(-) create mode 100644 .openapi-generator/FILES create mode 100644 .openapi-generator/VERSION delete mode 100644 generated/immich/openapi_client/api/activities_api.py delete mode 100644 generated/immich/openapi_client/api/api_keys_api.py delete mode 100644 generated/immich/openapi_client/api/authentication_api.py delete mode 100644 generated/immich/openapi_client/api/deprecated_api.py delete mode 100644 generated/immich/openapi_client/api/download_api.py delete mode 100644 generated/immich/openapi_client/api/duplicates_api.py delete mode 100644 generated/immich/openapi_client/api/faces_api.py delete mode 100644 generated/immich/openapi_client/api/jobs_api.py delete mode 100644 generated/immich/openapi_client/api/libraries_api.py delete mode 100644 generated/immich/openapi_client/api/map_api.py delete mode 100644 generated/immich/openapi_client/api/memories_api.py delete mode 100644 generated/immich/openapi_client/api/notifications_api.py delete mode 100644 generated/immich/openapi_client/api/partners_api.py delete mode 100644 generated/immich/openapi_client/api/people_api.py delete mode 100644 generated/immich/openapi_client/api/server_api.py delete mode 100644 generated/immich/openapi_client/api/sessions_api.py delete mode 100644 generated/immich/openapi_client/api/shared_links_api.py delete mode 100644 generated/immich/openapi_client/api/stacks_api.py delete mode 100644 generated/immich/openapi_client/api/sync_api.py delete mode 100644 generated/immich/openapi_client/api/system_config_api.py delete mode 100644 generated/immich/openapi_client/api/system_metadata_api.py delete mode 100644 generated/immich/openapi_client/api/tags_api.py delete mode 100644 generated/immich/openapi_client/api/timeline_api.py delete mode 100644 generated/immich/openapi_client/api/trash_api.py delete mode 100644 generated/immich/openapi_client/api/users_admin_api.py delete mode 100644 generated/immich/openapi_client/api/users_api.py delete mode 100644 generated/immich/openapi_client/docs/APIKeysApi.md delete mode 100644 generated/immich/openapi_client/docs/ActivitiesApi.md delete mode 100644 generated/immich/openapi_client/docs/ActivityCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/ActivityResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ActivityStatisticsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AddUsersDto.md delete mode 100644 generated/immich/openapi_client/docs/AdminOnboardingUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/AlbumResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AlbumStatisticsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AlbumUserAddDto.md delete mode 100644 generated/immich/openapi_client/docs/AlbumUserCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/AlbumUserResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AlbumUserRole.md delete mode 100644 generated/immich/openapi_client/docs/AlbumsApi.md delete mode 100644 generated/immich/openapi_client/docs/AssetBulkDeleteDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetBulkUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetBulkUploadCheckDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetBulkUploadCheckItem.md delete mode 100644 generated/immich/openapi_client/docs/AssetBulkUploadCheckResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetBulkUploadCheckResult.md delete mode 100644 generated/immich/openapi_client/docs/AssetFaceCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetFaceDeleteDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetFaceResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetFaceUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetFaceUpdateItem.md delete mode 100644 generated/immich/openapi_client/docs/AssetIdsDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetIdsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetJobName.md delete mode 100644 generated/immich/openapi_client/docs/AssetJobsDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetMediaResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetMediaSize.md delete mode 100644 generated/immich/openapi_client/docs/AssetMediaStatus.md delete mode 100644 generated/immich/openapi_client/docs/AssetOrder.md delete mode 100644 generated/immich/openapi_client/docs/AssetResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetStackResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetStatsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/AssetTypeEnum.md delete mode 100644 generated/immich/openapi_client/docs/AssetsApi.md delete mode 100644 generated/immich/openapi_client/docs/AudioCodec.md delete mode 100644 generated/immich/openapi_client/docs/AuthenticationApi.md delete mode 100644 generated/immich/openapi_client/docs/AvatarUpdate.md delete mode 100644 generated/immich/openapi_client/docs/BulkIdResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/BulkIdsDto.md delete mode 100644 generated/immich/openapi_client/docs/CLIPConfig.md delete mode 100644 generated/immich/openapi_client/docs/CQMode.md delete mode 100644 generated/immich/openapi_client/docs/ChangePasswordDto.md delete mode 100644 generated/immich/openapi_client/docs/Colorspace.md delete mode 100644 generated/immich/openapi_client/docs/CreateAlbumDto.md delete mode 100644 generated/immich/openapi_client/docs/CreateLibraryDto.md delete mode 100644 generated/immich/openapi_client/docs/CreateProfileImageResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/DatabaseBackupConfig.md delete mode 100644 generated/immich/openapi_client/docs/DeprecatedApi.md delete mode 100644 generated/immich/openapi_client/docs/DownloadApi.md delete mode 100644 generated/immich/openapi_client/docs/DownloadArchiveInfo.md delete mode 100644 generated/immich/openapi_client/docs/DownloadInfoDto.md delete mode 100644 generated/immich/openapi_client/docs/DownloadResponse.md delete mode 100644 generated/immich/openapi_client/docs/DownloadResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/DownloadUpdate.md delete mode 100644 generated/immich/openapi_client/docs/DuplicateDetectionConfig.md delete mode 100644 generated/immich/openapi_client/docs/DuplicateResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/DuplicatesApi.md delete mode 100644 generated/immich/openapi_client/docs/EmailNotificationsResponse.md delete mode 100644 generated/immich/openapi_client/docs/EmailNotificationsUpdate.md delete mode 100644 generated/immich/openapi_client/docs/ExifResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/FaceDto.md delete mode 100644 generated/immich/openapi_client/docs/FacesApi.md delete mode 100644 generated/immich/openapi_client/docs/FacialRecognitionConfig.md delete mode 100644 generated/immich/openapi_client/docs/FoldersResponse.md delete mode 100644 generated/immich/openapi_client/docs/FoldersUpdate.md delete mode 100644 generated/immich/openapi_client/docs/ImageFormat.md delete mode 100644 generated/immich/openapi_client/docs/JobCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/JobName.md delete mode 100644 generated/immich/openapi_client/docs/JobSettingsDto.md delete mode 100644 generated/immich/openapi_client/docs/JobsApi.md delete mode 100644 generated/immich/openapi_client/docs/LibrariesApi.md delete mode 100644 generated/immich/openapi_client/docs/LibraryResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/LibraryStatsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/LicenseKeyDto.md delete mode 100644 generated/immich/openapi_client/docs/LogLevel.md delete mode 100644 generated/immich/openapi_client/docs/LoginCredentialDto.md delete mode 100644 generated/immich/openapi_client/docs/LoginResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/LogoutResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ManualJobName.md delete mode 100644 generated/immich/openapi_client/docs/MapApi.md delete mode 100644 generated/immich/openapi_client/docs/MapMarkerResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/MapReverseGeocodeResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/MemoriesApi.md delete mode 100644 generated/immich/openapi_client/docs/MemoriesResponse.md delete mode 100644 generated/immich/openapi_client/docs/MemoriesUpdate.md delete mode 100644 generated/immich/openapi_client/docs/MemoryCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/MemoryResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/MemoryType.md delete mode 100644 generated/immich/openapi_client/docs/MemoryUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/MergePersonDto.md delete mode 100644 generated/immich/openapi_client/docs/MetadataSearchDto.md delete mode 100644 generated/immich/openapi_client/docs/NotificationsApi.md delete mode 100644 generated/immich/openapi_client/docs/OAuthAuthorizeResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/OAuthCallbackDto.md delete mode 100644 generated/immich/openapi_client/docs/OAuthConfigDto.md delete mode 100644 generated/immich/openapi_client/docs/OnThisDayDto.md delete mode 100644 generated/immich/openapi_client/docs/PartnerDirection.md delete mode 100644 generated/immich/openapi_client/docs/PartnerResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/PartnersApi.md delete mode 100644 generated/immich/openapi_client/docs/PeopleApi.md delete mode 100644 generated/immich/openapi_client/docs/PeopleResponse.md delete mode 100644 generated/immich/openapi_client/docs/PeopleResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/PeopleUpdate.md delete mode 100644 generated/immich/openapi_client/docs/PeopleUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/PeopleUpdateItem.md delete mode 100644 generated/immich/openapi_client/docs/Permission.md delete mode 100644 generated/immich/openapi_client/docs/PersonCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/PersonResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/PersonStatisticsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/PersonUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/PlacesResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/PurchaseResponse.md delete mode 100644 generated/immich/openapi_client/docs/PurchaseUpdate.md delete mode 100644 generated/immich/openapi_client/docs/RandomSearchDto.md delete mode 100644 generated/immich/openapi_client/docs/RatingsResponse.md delete mode 100644 generated/immich/openapi_client/docs/RatingsUpdate.md delete mode 100644 generated/immich/openapi_client/docs/ReactionLevel.md delete mode 100644 generated/immich/openapi_client/docs/ReactionType.md delete mode 100644 generated/immich/openapi_client/docs/ReverseGeocodingStateResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchAlbumResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchApi.md delete mode 100644 generated/immich/openapi_client/docs/SearchAssetResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchExploreItem.md delete mode 100644 generated/immich/openapi_client/docs/SearchExploreResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchFacetCountResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchFacetResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SearchSuggestionType.md delete mode 100644 generated/immich/openapi_client/docs/ServerAboutResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerApi.md delete mode 100644 generated/immich/openapi_client/docs/ServerConfigDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerFeaturesDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerMediaTypesResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerPingResponse.md delete mode 100644 generated/immich/openapi_client/docs/ServerStatsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerStorageResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerVersionHistoryResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ServerVersionResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SessionResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SessionsApi.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinkCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinkEditDto.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinkResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinkType.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinksApi.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinksResponse.md delete mode 100644 generated/immich/openapi_client/docs/SharedLinksUpdate.md delete mode 100644 generated/immich/openapi_client/docs/SignUpDto.md delete mode 100644 generated/immich/openapi_client/docs/SmartSearchDto.md delete mode 100644 generated/immich/openapi_client/docs/SourceType.md delete mode 100644 generated/immich/openapi_client/docs/StackCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/StackResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/StackUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/StacksApi.md delete mode 100644 generated/immich/openapi_client/docs/SyncAckDeleteDto.md delete mode 100644 generated/immich/openapi_client/docs/SyncAckDto.md delete mode 100644 generated/immich/openapi_client/docs/SyncAckSetDto.md delete mode 100644 generated/immich/openapi_client/docs/SyncApi.md delete mode 100644 generated/immich/openapi_client/docs/SyncAssetDeleteV1.md delete mode 100644 generated/immich/openapi_client/docs/SyncAssetExifV1.md delete mode 100644 generated/immich/openapi_client/docs/SyncAssetV1.md delete mode 100644 generated/immich/openapi_client/docs/SyncEntityType.md delete mode 100644 generated/immich/openapi_client/docs/SyncPartnerDeleteV1.md delete mode 100644 generated/immich/openapi_client/docs/SyncPartnerV1.md delete mode 100644 generated/immich/openapi_client/docs/SyncRequestType.md delete mode 100644 generated/immich/openapi_client/docs/SyncStreamDto.md delete mode 100644 generated/immich/openapi_client/docs/SyncUserDeleteV1.md delete mode 100644 generated/immich/openapi_client/docs/SyncUserV1.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigApi.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigBackupsDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigFFmpegDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigFacesDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigGeneratedFullsizeImageDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigGeneratedImageDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigImageDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigJobDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigLibraryDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigLibraryScanDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigLibraryWatchDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigLoggingDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigMachineLearningDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigMapDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigMetadataDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigNewVersionCheckDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigNotificationsDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigOAuthDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigPasswordLoginDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigReverseGeocodingDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigServerDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigSmtpDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigSmtpTransportDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigStorageTemplateDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigTemplateEmailsDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigTemplateStorageOptionDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigTemplatesDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigThemeDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigTrashDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemConfigUserDto.md delete mode 100644 generated/immich/openapi_client/docs/SystemMetadataApi.md delete mode 100644 generated/immich/openapi_client/docs/TagBulkAssetsDto.md delete mode 100644 generated/immich/openapi_client/docs/TagBulkAssetsResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/TagCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/TagResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/TagUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/TagUpsertDto.md delete mode 100644 generated/immich/openapi_client/docs/TagsApi.md delete mode 100644 generated/immich/openapi_client/docs/TagsResponse.md delete mode 100644 generated/immich/openapi_client/docs/TagsUpdate.md delete mode 100644 generated/immich/openapi_client/docs/TemplateDto.md delete mode 100644 generated/immich/openapi_client/docs/TemplateResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/TestEmailResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/TimelineApi.md delete mode 100644 generated/immich/openapi_client/docs/ToneMapping.md delete mode 100644 generated/immich/openapi_client/docs/TranscodeHWAccel.md delete mode 100644 generated/immich/openapi_client/docs/TranscodePolicy.md delete mode 100644 generated/immich/openapi_client/docs/TrashApi.md delete mode 100644 generated/immich/openapi_client/docs/TrashResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/UpdateAlbumDto.md delete mode 100644 generated/immich/openapi_client/docs/UpdateAlbumUserDto.md delete mode 100644 generated/immich/openapi_client/docs/UpdateAssetDto.md delete mode 100644 generated/immich/openapi_client/docs/UpdateLibraryDto.md delete mode 100644 generated/immich/openapi_client/docs/UsageByUserDto.md delete mode 100644 generated/immich/openapi_client/docs/UserAdminCreateDto.md delete mode 100644 generated/immich/openapi_client/docs/UserAdminDeleteDto.md delete mode 100644 generated/immich/openapi_client/docs/UserAdminResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/UserAdminUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/UserAvatarColor.md delete mode 100644 generated/immich/openapi_client/docs/UserLicense.md delete mode 100644 generated/immich/openapi_client/docs/UserPreferencesResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/UserPreferencesUpdateDto.md delete mode 100644 generated/immich/openapi_client/docs/UserResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/UserStatus.md delete mode 100644 generated/immich/openapi_client/docs/UserUpdateMeDto.md delete mode 100644 generated/immich/openapi_client/docs/UsersAdminApi.md delete mode 100644 generated/immich/openapi_client/docs/UsersApi.md delete mode 100644 generated/immich/openapi_client/docs/ValidateAccessTokenResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ValidateLibraryDto.md delete mode 100644 generated/immich/openapi_client/docs/ValidateLibraryImportPathResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/ValidateLibraryResponseDto.md delete mode 100644 generated/immich/openapi_client/docs/VideoCodec.md delete mode 100644 generated/immich/openapi_client/docs/VideoContainer.md create mode 100644 generated/immich/openapi_client/models/albums_add_assets_dto.py create mode 100644 generated/immich/openapi_client/models/albums_add_assets_response_dto.py create mode 100644 generated/immich/openapi_client/models/albums_response.py create mode 100644 generated/immich/openapi_client/models/albums_update.py create mode 100644 generated/immich/openapi_client/models/asset_copy_dto.py create mode 100644 generated/immich/openapi_client/models/asset_edit_action.py create mode 100644 generated/immich/openapi_client/models/asset_edit_action_item_dto.py create mode 100644 generated/immich/openapi_client/models/asset_edit_action_item_dto_parameters.py create mode 100644 generated/immich/openapi_client/models/asset_edit_action_item_response_dto.py create mode 100644 generated/immich/openapi_client/models/asset_edits_create_dto.py create mode 100644 generated/immich/openapi_client/models/asset_edits_response_dto.py create mode 100644 generated/immich/openapi_client/models/asset_id_error_reason.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_bulk_delete_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_bulk_delete_item_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_bulk_response_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_bulk_upsert_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_bulk_upsert_item_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_response_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_upsert_dto.py create mode 100644 generated/immich/openapi_client/models/asset_metadata_upsert_item_dto.py create mode 100644 generated/immich/openapi_client/models/asset_ocr_response_dto.py create mode 100644 generated/immich/openapi_client/models/asset_order_by.py create mode 100644 generated/immich/openapi_client/models/asset_reject_reason.py create mode 100644 generated/immich/openapi_client/models/asset_upload_action.py create mode 100644 generated/immich/openapi_client/models/asset_visibility.py create mode 100644 generated/immich/openapi_client/models/auth_status_response_dto.py create mode 100644 generated/immich/openapi_client/models/bulk_id_error_reason.py create mode 100644 generated/immich/openapi_client/models/calendar_heatmap_response_dto.py create mode 100644 generated/immich/openapi_client/models/calendar_heatmap_response_dto_series_inner.py create mode 100644 generated/immich/openapi_client/models/calendar_heatmap_type.py create mode 100644 generated/immich/openapi_client/models/cast_response.py create mode 100644 generated/immich/openapi_client/models/cast_update.py create mode 100644 generated/immich/openapi_client/models/contributor_count_response_dto.py create mode 100644 generated/immich/openapi_client/models/crop_parameters.py create mode 100644 generated/immich/openapi_client/models/database_backup_delete_dto.py create mode 100644 generated/immich/openapi_client/models/database_backup_dto.py create mode 100644 generated/immich/openapi_client/models/database_backup_list_response_dto.py create mode 100644 generated/immich/openapi_client/models/download_archive_dto.py create mode 100644 generated/immich/openapi_client/models/duplicate_resolve_dto.py create mode 100644 generated/immich/openapi_client/models/duplicate_resolve_group_dto.py create mode 100644 generated/immich/openapi_client/models/integrity_report.py create mode 100644 generated/immich/openapi_client/models/integrity_report_response_dto.py create mode 100644 generated/immich/openapi_client/models/integrity_report_response_dto_items_inner.py create mode 100644 generated/immich/openapi_client/models/integrity_report_summary_response_dto.py create mode 100644 generated/immich/openapi_client/models/machine_learning_availability_checks_dto.py create mode 100644 generated/immich/openapi_client/models/maintenance_action.py create mode 100644 generated/immich/openapi_client/models/maintenance_auth_dto.py create mode 100644 generated/immich/openapi_client/models/maintenance_detect_install_response_dto.py create mode 100644 generated/immich/openapi_client/models/maintenance_detect_install_storage_folder_dto.py create mode 100644 generated/immich/openapi_client/models/maintenance_login_dto.py create mode 100644 generated/immich/openapi_client/models/maintenance_status_response_dto.py create mode 100644 generated/immich/openapi_client/models/memory_search_order.py create mode 100644 generated/immich/openapi_client/models/memory_statistics_response_dto.py create mode 100644 generated/immich/openapi_client/models/mirror_axis.py create mode 100644 generated/immich/openapi_client/models/mirror_parameters.py create mode 100644 generated/immich/openapi_client/models/notification_create_dto.py create mode 100644 generated/immich/openapi_client/models/notification_delete_all_dto.py create mode 100644 generated/immich/openapi_client/models/notification_dto.py create mode 100644 generated/immich/openapi_client/models/notification_level.py create mode 100644 generated/immich/openapi_client/models/notification_type.py create mode 100644 generated/immich/openapi_client/models/notification_update_all_dto.py create mode 100644 generated/immich/openapi_client/models/notification_update_dto.py create mode 100644 generated/immich/openapi_client/models/o_auth_token_endpoint_auth_method.py create mode 100644 generated/immich/openapi_client/models/ocr_config.py create mode 100644 generated/immich/openapi_client/models/onboarding_dto.py create mode 100644 generated/immich/openapi_client/models/onboarding_response_dto.py create mode 100644 generated/immich/openapi_client/models/partner_create_dto.py create mode 100644 generated/immich/openapi_client/models/partner_update_dto.py create mode 100644 generated/immich/openapi_client/models/pin_code_change_dto.py create mode 100644 generated/immich/openapi_client/models/pin_code_reset_dto.py create mode 100644 generated/immich/openapi_client/models/pin_code_setup_dto.py create mode 100644 generated/immich/openapi_client/models/plugin_method_response_dto.py create mode 100644 generated/immich/openapi_client/models/plugin_response_dto.py create mode 100644 generated/immich/openapi_client/models/plugin_template_response_dto.py create mode 100644 generated/immich/openapi_client/models/plugin_template_step_response_dto.py create mode 100644 generated/immich/openapi_client/models/queue_command.py create mode 100644 generated/immich/openapi_client/models/queue_command_dto.py create mode 100644 generated/immich/openapi_client/models/queue_delete_dto.py create mode 100644 generated/immich/openapi_client/models/queue_job_response_dto.py create mode 100644 generated/immich/openapi_client/models/queue_job_status.py create mode 100644 generated/immich/openapi_client/models/queue_name.py create mode 100644 generated/immich/openapi_client/models/queue_response_dto.py create mode 100644 generated/immich/openapi_client/models/queue_response_legacy_dto.py create mode 100644 generated/immich/openapi_client/models/queue_statistics_dto.py create mode 100644 generated/immich/openapi_client/models/queue_status_legacy_dto.py create mode 100644 generated/immich/openapi_client/models/queue_update_dto.py create mode 100644 generated/immich/openapi_client/models/queues_response_legacy_dto.py create mode 100644 generated/immich/openapi_client/models/recently_added_response.py create mode 100644 generated/immich/openapi_client/models/recently_added_update.py create mode 100644 generated/immich/openapi_client/models/release_channel.py create mode 100644 generated/immich/openapi_client/models/release_event_v1.py create mode 100644 generated/immich/openapi_client/models/release_type.py create mode 100644 generated/immich/openapi_client/models/rotate_parameters.py create mode 100644 generated/immich/openapi_client/models/search_statistics_response_dto.py create mode 100644 generated/immich/openapi_client/models/server_apk_links_dto.py create mode 100644 generated/immich/openapi_client/models/session_create_dto.py create mode 100644 generated/immich/openapi_client/models/session_create_response_dto.py create mode 100644 generated/immich/openapi_client/models/session_unlock_dto.py create mode 100644 generated/immich/openapi_client/models/session_update_dto.py create mode 100644 generated/immich/openapi_client/models/set_maintenance_mode_dto.py create mode 100644 generated/immich/openapi_client/models/shared_link_login_dto.py create mode 100644 generated/immich/openapi_client/models/statistics_search_dto.py create mode 100644 generated/immich/openapi_client/models/storage_folder.py create mode 100644 generated/immich/openapi_client/models/sync_album_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_album_to_asset_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_album_to_asset_v1.py create mode 100644 generated/immich/openapi_client/models/sync_album_user_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_album_user_v1.py create mode 100644 generated/immich/openapi_client/models/sync_album_v1.py create mode 100644 generated/immich/openapi_client/models/sync_album_v2.py create mode 100644 generated/immich/openapi_client/models/sync_asset_edit_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_edit_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_face_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_face_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_face_v2.py create mode 100644 generated/immich/openapi_client/models/sync_asset_metadata_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_metadata_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_ocr_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_ocr_v1.py create mode 100644 generated/immich/openapi_client/models/sync_asset_v2.py create mode 100644 generated/immich/openapi_client/models/sync_auth_user_v1.py create mode 100644 generated/immich/openapi_client/models/sync_memory_asset_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_memory_asset_v1.py create mode 100644 generated/immich/openapi_client/models/sync_memory_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_memory_v1.py create mode 100644 generated/immich/openapi_client/models/sync_person_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_person_v1.py create mode 100644 generated/immich/openapi_client/models/sync_stack_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_stack_v1.py create mode 100644 generated/immich/openapi_client/models/sync_user_metadata_delete_v1.py create mode 100644 generated/immich/openapi_client/models/sync_user_metadata_v1.py create mode 100644 generated/immich/openapi_client/models/system_config_f_fmpeg_realtime_dto.py create mode 100644 generated/immich/openapi_client/models/system_config_integrity_checks.py create mode 100644 generated/immich/openapi_client/models/system_config_integrity_checksum_job.py create mode 100644 generated/immich/openapi_client/models/system_config_integrity_job.py create mode 100644 generated/immich/openapi_client/models/system_config_nightly_tasks_dto.py create mode 100644 generated/immich/openapi_client/models/time_bucket_asset_response_dto.py create mode 100644 generated/immich/openapi_client/models/time_buckets_response_dto.py create mode 100644 generated/immich/openapi_client/models/user_metadata_key.py create mode 100644 generated/immich/openapi_client/models/version_check_state_response_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_create_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_response_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_share_response_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_share_step_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_step_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_trigger.py create mode 100644 generated/immich/openapi_client/models/workflow_trigger_response_dto.py create mode 100644 generated/immich/openapi_client/models/workflow_type.py create mode 100644 generated/immich/openapi_client/models/workflow_update_dto.py delete mode 100644 generated/immich/openapi_client/test/__init__.py delete mode 100644 generated/immich/openapi_client/test/test_activities_api.py delete mode 100644 generated/immich/openapi_client/test/test_activity_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_activity_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_activity_statistics_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_add_users_dto.py delete mode 100644 generated/immich/openapi_client/test/test_admin_onboarding_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_album_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_album_statistics_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_album_user_add_dto.py delete mode 100644 generated/immich/openapi_client/test/test_album_user_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_album_user_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_album_user_role.py delete mode 100644 generated/immich/openapi_client/test/test_albums_api.py delete mode 100644 generated/immich/openapi_client/test/test_api_key_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_api_key_create_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_api_key_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_api_key_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_api_keys_api.py delete mode 100644 generated/immich/openapi_client/test/test_asset_bulk_delete_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_bulk_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_bulk_upload_check_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_bulk_upload_check_item.py delete mode 100644 generated/immich/openapi_client/test/test_asset_bulk_upload_check_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_bulk_upload_check_result.py delete mode 100644 generated/immich/openapi_client/test/test_asset_face_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_face_delete_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_face_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_face_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_face_update_item.py delete mode 100644 generated/immich/openapi_client/test/test_asset_ids_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_ids_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_job_name.py delete mode 100644 generated/immich/openapi_client/test/test_asset_jobs_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_media_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_media_size.py delete mode 100644 generated/immich/openapi_client/test/test_asset_media_status.py delete mode 100644 generated/immich/openapi_client/test/test_asset_order.py delete mode 100644 generated/immich/openapi_client/test/test_asset_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_stack_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_stats_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_asset_type_enum.py delete mode 100644 generated/immich/openapi_client/test/test_assets_api.py delete mode 100644 generated/immich/openapi_client/test/test_audio_codec.py delete mode 100644 generated/immich/openapi_client/test/test_authentication_api.py delete mode 100644 generated/immich/openapi_client/test/test_avatar_update.py delete mode 100644 generated/immich/openapi_client/test/test_bulk_id_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_bulk_ids_dto.py delete mode 100644 generated/immich/openapi_client/test/test_change_password_dto.py delete mode 100644 generated/immich/openapi_client/test/test_clip_config.py delete mode 100644 generated/immich/openapi_client/test/test_colorspace.py delete mode 100644 generated/immich/openapi_client/test/test_cq_mode.py delete mode 100644 generated/immich/openapi_client/test/test_create_album_dto.py delete mode 100644 generated/immich/openapi_client/test/test_create_library_dto.py delete mode 100644 generated/immich/openapi_client/test/test_create_profile_image_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_database_backup_config.py delete mode 100644 generated/immich/openapi_client/test/test_deprecated_api.py delete mode 100644 generated/immich/openapi_client/test/test_download_api.py delete mode 100644 generated/immich/openapi_client/test/test_download_archive_info.py delete mode 100644 generated/immich/openapi_client/test/test_download_info_dto.py delete mode 100644 generated/immich/openapi_client/test/test_download_response.py delete mode 100644 generated/immich/openapi_client/test/test_download_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_download_update.py delete mode 100644 generated/immich/openapi_client/test/test_duplicate_detection_config.py delete mode 100644 generated/immich/openapi_client/test/test_duplicate_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_duplicates_api.py delete mode 100644 generated/immich/openapi_client/test/test_email_notifications_response.py delete mode 100644 generated/immich/openapi_client/test/test_email_notifications_update.py delete mode 100644 generated/immich/openapi_client/test/test_exif_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_face_dto.py delete mode 100644 generated/immich/openapi_client/test/test_faces_api.py delete mode 100644 generated/immich/openapi_client/test/test_facial_recognition_config.py delete mode 100644 generated/immich/openapi_client/test/test_folders_response.py delete mode 100644 generated/immich/openapi_client/test/test_folders_update.py delete mode 100644 generated/immich/openapi_client/test/test_image_format.py delete mode 100644 generated/immich/openapi_client/test/test_job_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_job_name.py delete mode 100644 generated/immich/openapi_client/test/test_job_settings_dto.py delete mode 100644 generated/immich/openapi_client/test/test_jobs_api.py delete mode 100644 generated/immich/openapi_client/test/test_libraries_api.py delete mode 100644 generated/immich/openapi_client/test/test_library_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_library_stats_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_license_key_dto.py delete mode 100644 generated/immich/openapi_client/test/test_log_level.py delete mode 100644 generated/immich/openapi_client/test/test_login_credential_dto.py delete mode 100644 generated/immich/openapi_client/test/test_login_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_logout_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_manual_job_name.py delete mode 100644 generated/immich/openapi_client/test/test_map_api.py delete mode 100644 generated/immich/openapi_client/test/test_map_marker_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_map_reverse_geocode_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_memories_api.py delete mode 100644 generated/immich/openapi_client/test/test_memories_response.py delete mode 100644 generated/immich/openapi_client/test/test_memories_update.py delete mode 100644 generated/immich/openapi_client/test/test_memory_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_memory_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_memory_type.py delete mode 100644 generated/immich/openapi_client/test/test_memory_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_merge_person_dto.py delete mode 100644 generated/immich/openapi_client/test/test_metadata_search_dto.py delete mode 100644 generated/immich/openapi_client/test/test_notifications_api.py delete mode 100644 generated/immich/openapi_client/test/test_o_auth_authorize_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_o_auth_callback_dto.py delete mode 100644 generated/immich/openapi_client/test/test_o_auth_config_dto.py delete mode 100644 generated/immich/openapi_client/test/test_on_this_day_dto.py delete mode 100644 generated/immich/openapi_client/test/test_partner_direction.py delete mode 100644 generated/immich/openapi_client/test/test_partner_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_partners_api.py delete mode 100644 generated/immich/openapi_client/test/test_people_api.py delete mode 100644 generated/immich/openapi_client/test/test_people_response.py delete mode 100644 generated/immich/openapi_client/test/test_people_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_people_update.py delete mode 100644 generated/immich/openapi_client/test/test_people_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_people_update_item.py delete mode 100644 generated/immich/openapi_client/test/test_permission.py delete mode 100644 generated/immich/openapi_client/test/test_person_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_person_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_person_statistics_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_person_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_places_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_purchase_response.py delete mode 100644 generated/immich/openapi_client/test/test_purchase_update.py delete mode 100644 generated/immich/openapi_client/test/test_random_search_dto.py delete mode 100644 generated/immich/openapi_client/test/test_ratings_response.py delete mode 100644 generated/immich/openapi_client/test/test_ratings_update.py delete mode 100644 generated/immich/openapi_client/test/test_reaction_level.py delete mode 100644 generated/immich/openapi_client/test/test_reaction_type.py delete mode 100644 generated/immich/openapi_client/test/test_reverse_geocoding_state_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_album_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_api.py delete mode 100644 generated/immich/openapi_client/test/test_search_asset_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_explore_item.py delete mode 100644 generated/immich/openapi_client/test/test_search_explore_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_facet_count_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_facet_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_search_suggestion_type.py delete mode 100644 generated/immich/openapi_client/test/test_server_about_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_api.py delete mode 100644 generated/immich/openapi_client/test/test_server_config_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_features_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_media_types_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_ping_response.py delete mode 100644 generated/immich/openapi_client/test/test_server_stats_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_storage_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_version_history_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_server_version_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_session_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_sessions_api.py delete mode 100644 generated/immich/openapi_client/test/test_shared_link_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_shared_link_edit_dto.py delete mode 100644 generated/immich/openapi_client/test/test_shared_link_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_shared_link_type.py delete mode 100644 generated/immich/openapi_client/test/test_shared_links_api.py delete mode 100644 generated/immich/openapi_client/test/test_shared_links_response.py delete mode 100644 generated/immich/openapi_client/test/test_shared_links_update.py delete mode 100644 generated/immich/openapi_client/test/test_sign_up_dto.py delete mode 100644 generated/immich/openapi_client/test/test_smart_search_dto.py delete mode 100644 generated/immich/openapi_client/test/test_source_type.py delete mode 100644 generated/immich/openapi_client/test/test_stack_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_stack_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_stack_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_stacks_api.py delete mode 100644 generated/immich/openapi_client/test/test_sync_ack_delete_dto.py delete mode 100644 generated/immich/openapi_client/test/test_sync_ack_dto.py delete mode 100644 generated/immich/openapi_client/test/test_sync_ack_set_dto.py delete mode 100644 generated/immich/openapi_client/test/test_sync_api.py delete mode 100644 generated/immich/openapi_client/test/test_sync_asset_delete_v1.py delete mode 100644 generated/immich/openapi_client/test/test_sync_asset_exif_v1.py delete mode 100644 generated/immich/openapi_client/test/test_sync_asset_v1.py delete mode 100644 generated/immich/openapi_client/test/test_sync_entity_type.py delete mode 100644 generated/immich/openapi_client/test/test_sync_partner_delete_v1.py delete mode 100644 generated/immich/openapi_client/test/test_sync_partner_v1.py delete mode 100644 generated/immich/openapi_client/test/test_sync_request_type.py delete mode 100644 generated/immich/openapi_client/test/test_sync_stream_dto.py delete mode 100644 generated/immich/openapi_client/test/test_sync_user_delete_v1.py delete mode 100644 generated/immich/openapi_client/test/test_sync_user_v1.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_api.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_backups_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_f_fmpeg_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_faces_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_generated_fullsize_image_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_generated_image_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_image_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_job_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_library_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_library_scan_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_library_watch_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_logging_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_machine_learning_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_map_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_metadata_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_new_version_check_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_notifications_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_o_auth_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_password_login_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_reverse_geocoding_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_server_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_smtp_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_smtp_transport_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_storage_template_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_template_emails_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_template_storage_option_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_templates_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_theme_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_trash_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_config_user_dto.py delete mode 100644 generated/immich/openapi_client/test/test_system_metadata_api.py delete mode 100644 generated/immich/openapi_client/test/test_tag_bulk_assets_dto.py delete mode 100644 generated/immich/openapi_client/test/test_tag_bulk_assets_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_tag_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_tag_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_tag_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_tag_upsert_dto.py delete mode 100644 generated/immich/openapi_client/test/test_tags_api.py delete mode 100644 generated/immich/openapi_client/test/test_tags_response.py delete mode 100644 generated/immich/openapi_client/test/test_tags_update.py delete mode 100644 generated/immich/openapi_client/test/test_template_dto.py delete mode 100644 generated/immich/openapi_client/test/test_template_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_test_email_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_timeline_api.py delete mode 100644 generated/immich/openapi_client/test/test_tone_mapping.py delete mode 100644 generated/immich/openapi_client/test/test_transcode_hw_accel.py delete mode 100644 generated/immich/openapi_client/test/test_transcode_policy.py delete mode 100644 generated/immich/openapi_client/test/test_trash_api.py delete mode 100644 generated/immich/openapi_client/test/test_trash_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_update_album_dto.py delete mode 100644 generated/immich/openapi_client/test/test_update_album_user_dto.py delete mode 100644 generated/immich/openapi_client/test/test_update_asset_dto.py delete mode 100644 generated/immich/openapi_client/test/test_update_library_dto.py delete mode 100644 generated/immich/openapi_client/test/test_usage_by_user_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_admin_create_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_admin_delete_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_admin_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_admin_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_avatar_color.py delete mode 100644 generated/immich/openapi_client/test/test_user_license.py delete mode 100644 generated/immich/openapi_client/test/test_user_preferences_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_preferences_update_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_user_status.py delete mode 100644 generated/immich/openapi_client/test/test_user_update_me_dto.py delete mode 100644 generated/immich/openapi_client/test/test_users_admin_api.py delete mode 100644 generated/immich/openapi_client/test/test_users_api.py delete mode 100644 generated/immich/openapi_client/test/test_validate_access_token_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_validate_library_dto.py delete mode 100644 generated/immich/openapi_client/test/test_validate_library_import_path_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_validate_library_response_dto.py delete mode 100644 generated/immich/openapi_client/test/test_video_codec.py delete mode 100644 generated/immich/openapi_client/test/test_video_container.py diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES new file mode 100644 index 0000000..26f9b46 --- /dev/null +++ b/.openapi-generator/FILES @@ -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 diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION new file mode 100644 index 0000000..4bc5d61 --- /dev/null +++ b/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.9.0 diff --git a/README.md b/README.md index a8e5df3..2cd06cd 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/generated/immich/openapi_client/__init__.py b/generated/immich/openapi_client/__init__.py index a99f1df..ba20aa2 100644 --- a/generated/immich/openapi_client/__init__.py +++ b/generated/immich/openapi_client/__init__.py @@ -16,845 +16,390 @@ __version__ = "1.0.0" -# Define package exports -__all__ = [ - "APIKeysApi", - "ActivitiesApi", - "AlbumsApi", - "AssetsApi", - "AuthenticationApi", - "AuthenticationAdminApi", - "DatabaseBackupsAdminApi", - "DeprecatedApi", - "DownloadApi", - "DuplicatesApi", - "FacesApi", - "JobsApi", - "LibrariesApi", - "MaintenanceAdminApi", - "MapApi", - "MemoriesApi", - "NotificationsApi", - "NotificationsAdminApi", - "PartnersApi", - "PeopleApi", - "PluginsApi", - "QueuesApi", - "SearchApi", - "ServerApi", - "SessionsApi", - "SharedLinksApi", - "StacksApi", - "SyncApi", - "SystemConfigApi", - "SystemMetadataApi", - "TagsApi", - "TimelineApi", - "TrashApi", - "UsersApi", - "UsersAdminApi", - "ViewsApi", - "WorkflowsApi", - "ApiResponse", - "ApiClient", - "Configuration", - "OpenApiException", - "ApiTypeError", - "ApiValueError", - "ApiKeyError", - "ApiAttributeError", - "ApiException", - "ActivityCreateDto", - "ActivityResponseDto", - "ActivityStatisticsResponseDto", - "AddUsersDto", - "AdminOnboardingUpdateDto", - "AlbumResponseDto", - "AlbumStatisticsResponseDto", - "AlbumUserAddDto", - "AlbumUserCreateDto", - "AlbumUserResponseDto", - "AlbumUserRole", - "AlbumsAddAssetsDto", - "AlbumsAddAssetsResponseDto", - "AlbumsResponse", - "AlbumsUpdate", - "ApiKeyCreateDto", - "ApiKeyCreateResponseDto", - "ApiKeyResponseDto", - "ApiKeyUpdateDto", - "AssetBulkDeleteDto", - "AssetBulkUpdateDto", - "AssetBulkUploadCheckDto", - "AssetBulkUploadCheckItem", - "AssetBulkUploadCheckResponseDto", - "AssetBulkUploadCheckResult", - "AssetCopyDto", - "AssetEditAction", - "AssetEditActionItemDto", - "AssetEditActionItemDtoParameters", - "AssetEditActionItemResponseDto", - "AssetEditsCreateDto", - "AssetEditsResponseDto", - "AssetFaceCreateDto", - "AssetFaceDeleteDto", - "AssetFaceResponseDto", - "AssetFaceUpdateDto", - "AssetFaceUpdateItem", - "AssetIdErrorReason", - "AssetIdsDto", - "AssetIdsResponseDto", - "AssetJobName", - "AssetJobsDto", - "AssetMediaResponseDto", - "AssetMediaSize", - "AssetMediaStatus", - "AssetMetadataBulkDeleteDto", - "AssetMetadataBulkDeleteItemDto", - "AssetMetadataBulkResponseDto", - "AssetMetadataBulkUpsertDto", - "AssetMetadataBulkUpsertItemDto", - "AssetMetadataResponseDto", - "AssetMetadataUpsertDto", - "AssetMetadataUpsertItemDto", - "AssetOcrResponseDto", - "AssetOrder", - "AssetOrderBy", - "AssetRejectReason", - "AssetResponseDto", - "AssetStackResponseDto", - "AssetStatsResponseDto", - "AssetTypeEnum", - "AssetUploadAction", - "AssetVisibility", - "AudioCodec", - "AuthStatusResponseDto", - "AvatarUpdate", - "BulkIdErrorReason", - "BulkIdResponseDto", - "BulkIdsDto", - "CLIPConfig", - "CQMode", - "CalendarHeatmapResponseDto", - "CalendarHeatmapResponseDtoSeriesInner", - "CalendarHeatmapType", - "CastResponse", - "CastUpdate", - "ChangePasswordDto", - "Colorspace", - "ContributorCountResponseDto", - "CreateAlbumDto", - "CreateLibraryDto", - "CreateProfileImageResponseDto", - "CropParameters", - "DatabaseBackupConfig", - "DatabaseBackupDeleteDto", - "DatabaseBackupDto", - "DatabaseBackupListResponseDto", - "DownloadArchiveDto", - "DownloadArchiveInfo", - "DownloadInfoDto", - "DownloadResponse", - "DownloadResponseDto", - "DownloadUpdate", - "DuplicateDetectionConfig", - "DuplicateResolveDto", - "DuplicateResolveGroupDto", - "DuplicateResponseDto", - "EmailNotificationsResponse", - "EmailNotificationsUpdate", - "ExifResponseDto", - "FaceDto", - "FacialRecognitionConfig", - "FoldersResponse", - "FoldersUpdate", - "ImageFormat", - "IntegrityReport", - "IntegrityReportResponseDto", - "IntegrityReportResponseDtoItemsInner", - "IntegrityReportSummaryResponseDto", - "JobCreateDto", - "JobName", - "JobSettingsDto", - "LibraryResponseDto", - "LibraryStatsResponseDto", - "LicenseKeyDto", - "LogLevel", - "LoginCredentialDto", - "LoginResponseDto", - "LogoutResponseDto", - "MachineLearningAvailabilityChecksDto", - "MaintenanceAction", - "MaintenanceAuthDto", - "MaintenanceDetectInstallResponseDto", - "MaintenanceDetectInstallStorageFolderDto", - "MaintenanceLoginDto", - "MaintenanceStatusResponseDto", - "ManualJobName", - "MapMarkerResponseDto", - "MapReverseGeocodeResponseDto", - "MemoriesResponse", - "MemoriesUpdate", - "MemoryCreateDto", - "MemoryResponseDto", - "MemorySearchOrder", - "MemoryStatisticsResponseDto", - "MemoryType", - "MemoryUpdateDto", - "MergePersonDto", - "MetadataSearchDto", - "MirrorAxis", - "MirrorParameters", - "NotificationCreateDto", - "NotificationDeleteAllDto", - "NotificationDto", - "NotificationLevel", - "NotificationType", - "NotificationUpdateAllDto", - "NotificationUpdateDto", - "OAuthAuthorizeResponseDto", - "OAuthCallbackDto", - "OAuthConfigDto", - "OAuthTokenEndpointAuthMethod", - "OcrConfig", - "OnThisDayDto", - "OnboardingDto", - "OnboardingResponseDto", - "PartnerCreateDto", - "PartnerDirection", - "PartnerResponseDto", - "PartnerUpdateDto", - "PeopleResponse", - "PeopleResponseDto", - "PeopleUpdate", - "PeopleUpdateDto", - "PeopleUpdateItem", - "Permission", - "PersonCreateDto", - "PersonResponseDto", - "PersonStatisticsResponseDto", - "PersonUpdateDto", - "PinCodeChangeDto", - "PinCodeResetDto", - "PinCodeSetupDto", - "PlacesResponseDto", - "PluginMethodResponseDto", - "PluginResponseDto", - "PluginTemplateResponseDto", - "PluginTemplateStepResponseDto", - "PurchaseResponse", - "PurchaseUpdate", - "QueueCommand", - "QueueCommandDto", - "QueueDeleteDto", - "QueueJobResponseDto", - "QueueJobStatus", - "QueueName", - "QueueResponseDto", - "QueueResponseLegacyDto", - "QueueStatisticsDto", - "QueueStatusLegacyDto", - "QueueUpdateDto", - "QueuesResponseLegacyDto", - "RandomSearchDto", - "RatingsResponse", - "RatingsUpdate", - "ReactionLevel", - "ReactionType", - "RecentlyAddedResponse", - "RecentlyAddedUpdate", - "ReleaseChannel", - "ReleaseEventV1", - "ReleaseType", - "ReverseGeocodingStateResponseDto", - "RotateParameters", - "SearchAlbumResponseDto", - "SearchAssetResponseDto", - "SearchExploreItem", - "SearchExploreResponseDto", - "SearchFacetCountResponseDto", - "SearchFacetResponseDto", - "SearchResponseDto", - "SearchStatisticsResponseDto", - "SearchSuggestionType", - "ServerAboutResponseDto", - "ServerApkLinksDto", - "ServerConfigDto", - "ServerFeaturesDto", - "ServerMediaTypesResponseDto", - "ServerPingResponse", - "ServerStatsResponseDto", - "ServerStorageResponseDto", - "ServerVersionHistoryResponseDto", - "ServerVersionResponseDto", - "SessionCreateDto", - "SessionCreateResponseDto", - "SessionResponseDto", - "SessionUnlockDto", - "SessionUpdateDto", - "SetMaintenanceModeDto", - "SharedLinkCreateDto", - "SharedLinkEditDto", - "SharedLinkLoginDto", - "SharedLinkResponseDto", - "SharedLinkType", - "SharedLinksResponse", - "SharedLinksUpdate", - "SignUpDto", - "SmartSearchDto", - "SourceType", - "StackCreateDto", - "StackResponseDto", - "StackUpdateDto", - "StatisticsSearchDto", - "StorageFolder", - "SyncAckDeleteDto", - "SyncAckDto", - "SyncAckSetDto", - "SyncAlbumDeleteV1", - "SyncAlbumToAssetDeleteV1", - "SyncAlbumToAssetV1", - "SyncAlbumUserDeleteV1", - "SyncAlbumUserV1", - "SyncAlbumV1", - "SyncAlbumV2", - "SyncAssetDeleteV1", - "SyncAssetEditDeleteV1", - "SyncAssetEditV1", - "SyncAssetExifV1", - "SyncAssetFaceDeleteV1", - "SyncAssetFaceV1", - "SyncAssetFaceV2", - "SyncAssetMetadataDeleteV1", - "SyncAssetMetadataV1", - "SyncAssetOcrDeleteV1", - "SyncAssetOcrV1", - "SyncAssetV1", - "SyncAssetV2", - "SyncAuthUserV1", - "SyncEntityType", - "SyncMemoryAssetDeleteV1", - "SyncMemoryAssetV1", - "SyncMemoryDeleteV1", - "SyncMemoryV1", - "SyncPartnerDeleteV1", - "SyncPartnerV1", - "SyncPersonDeleteV1", - "SyncPersonV1", - "SyncRequestType", - "SyncStackDeleteV1", - "SyncStackV1", - "SyncStreamDto", - "SyncUserDeleteV1", - "SyncUserMetadataDeleteV1", - "SyncUserMetadataV1", - "SyncUserV1", - "SystemConfigBackupsDto", - "SystemConfigDto", - "SystemConfigFFmpegDto", - "SystemConfigFFmpegRealtimeDto", - "SystemConfigFacesDto", - "SystemConfigGeneratedFullsizeImageDto", - "SystemConfigGeneratedImageDto", - "SystemConfigImageDto", - "SystemConfigIntegrityChecks", - "SystemConfigIntegrityChecksumJob", - "SystemConfigIntegrityJob", - "SystemConfigJobDto", - "SystemConfigLibraryDto", - "SystemConfigLibraryScanDto", - "SystemConfigLibraryWatchDto", - "SystemConfigLoggingDto", - "SystemConfigMachineLearningDto", - "SystemConfigMapDto", - "SystemConfigMetadataDto", - "SystemConfigNewVersionCheckDto", - "SystemConfigNightlyTasksDto", - "SystemConfigNotificationsDto", - "SystemConfigOAuthDto", - "SystemConfigPasswordLoginDto", - "SystemConfigReverseGeocodingDto", - "SystemConfigServerDto", - "SystemConfigSmtpDto", - "SystemConfigSmtpTransportDto", - "SystemConfigStorageTemplateDto", - "SystemConfigTemplateEmailsDto", - "SystemConfigTemplateStorageOptionDto", - "SystemConfigTemplatesDto", - "SystemConfigThemeDto", - "SystemConfigTrashDto", - "SystemConfigUserDto", - "TagBulkAssetsDto", - "TagBulkAssetsResponseDto", - "TagCreateDto", - "TagResponseDto", - "TagUpdateDto", - "TagUpsertDto", - "TagsResponse", - "TagsUpdate", - "TemplateDto", - "TemplateResponseDto", - "TestEmailResponseDto", - "TimeBucketAssetResponseDto", - "TimeBucketsResponseDto", - "ToneMapping", - "TranscodeHWAccel", - "TranscodePolicy", - "TrashResponseDto", - "UpdateAlbumDto", - "UpdateAlbumUserDto", - "UpdateAssetDto", - "UpdateLibraryDto", - "UsageByUserDto", - "UserAdminCreateDto", - "UserAdminDeleteDto", - "UserAdminResponseDto", - "UserAdminUpdateDto", - "UserAvatarColor", - "UserLicense", - "UserMetadataKey", - "UserPreferencesResponseDto", - "UserPreferencesUpdateDto", - "UserResponseDto", - "UserStatus", - "UserUpdateMeDto", - "ValidateAccessTokenResponseDto", - "ValidateLibraryDto", - "ValidateLibraryImportPathResponseDto", - "ValidateLibraryResponseDto", - "VersionCheckStateResponseDto", - "VideoCodec", - "VideoContainer", - "WorkflowCreateDto", - "WorkflowResponseDto", - "WorkflowShareResponseDto", - "WorkflowShareStepDto", - "WorkflowStepDto", - "WorkflowTrigger", - "WorkflowTriggerResponseDto", - "WorkflowType", - "WorkflowUpdateDto", -] - # import apis into sdk package -from generated.immich.openapi_client.api.api_keys_api import APIKeysApi as APIKeysApi -from generated.immich.openapi_client.api.activities_api import ActivitiesApi as ActivitiesApi -from generated.immich.openapi_client.api.albums_api import AlbumsApi as AlbumsApi -from generated.immich.openapi_client.api.assets_api import AssetsApi as AssetsApi -from generated.immich.openapi_client.api.authentication_api import AuthenticationApi as AuthenticationApi -from generated.immich.openapi_client.api.authentication_admin_api import AuthenticationAdminApi as AuthenticationAdminApi -from generated.immich.openapi_client.api.database_backups_admin_api import DatabaseBackupsAdminApi as DatabaseBackupsAdminApi -from generated.immich.openapi_client.api.deprecated_api import DeprecatedApi as DeprecatedApi -from generated.immich.openapi_client.api.download_api import DownloadApi as DownloadApi -from generated.immich.openapi_client.api.duplicates_api import DuplicatesApi as DuplicatesApi -from generated.immich.openapi_client.api.faces_api import FacesApi as FacesApi -from generated.immich.openapi_client.api.jobs_api import JobsApi as JobsApi -from generated.immich.openapi_client.api.libraries_api import LibrariesApi as LibrariesApi -from generated.immich.openapi_client.api.maintenance_admin_api import MaintenanceAdminApi as MaintenanceAdminApi -from generated.immich.openapi_client.api.map_api import MapApi as MapApi -from generated.immich.openapi_client.api.memories_api import MemoriesApi as MemoriesApi -from generated.immich.openapi_client.api.notifications_api import NotificationsApi as NotificationsApi -from generated.immich.openapi_client.api.notifications_admin_api import NotificationsAdminApi as NotificationsAdminApi -from generated.immich.openapi_client.api.partners_api import PartnersApi as PartnersApi -from generated.immich.openapi_client.api.people_api import PeopleApi as PeopleApi -from generated.immich.openapi_client.api.plugins_api import PluginsApi as PluginsApi -from generated.immich.openapi_client.api.queues_api import QueuesApi as QueuesApi -from generated.immich.openapi_client.api.search_api import SearchApi as SearchApi -from generated.immich.openapi_client.api.server_api import ServerApi as ServerApi -from generated.immich.openapi_client.api.sessions_api import SessionsApi as SessionsApi -from generated.immich.openapi_client.api.shared_links_api import SharedLinksApi as SharedLinksApi -from generated.immich.openapi_client.api.stacks_api import StacksApi as StacksApi -from generated.immich.openapi_client.api.sync_api import SyncApi as SyncApi -from generated.immich.openapi_client.api.system_config_api import SystemConfigApi as SystemConfigApi -from generated.immich.openapi_client.api.system_metadata_api import SystemMetadataApi as SystemMetadataApi -from generated.immich.openapi_client.api.tags_api import TagsApi as TagsApi -from generated.immich.openapi_client.api.timeline_api import TimelineApi as TimelineApi -from generated.immich.openapi_client.api.trash_api import TrashApi as TrashApi -from generated.immich.openapi_client.api.users_api import UsersApi as UsersApi -from generated.immich.openapi_client.api.users_admin_api import UsersAdminApi as UsersAdminApi -from generated.immich.openapi_client.api.views_api import ViewsApi as ViewsApi -from generated.immich.openapi_client.api.workflows_api import WorkflowsApi as WorkflowsApi +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.search_api import SearchApi # import ApiClient -from generated.immich.openapi_client.api_response import ApiResponse as ApiResponse -from generated.immich.openapi_client.api_client import ApiClient as ApiClient -from generated.immich.openapi_client.configuration import Configuration as Configuration -from generated.immich.openapi_client.exceptions import OpenApiException as OpenApiException -from generated.immich.openapi_client.exceptions import ApiTypeError as ApiTypeError -from generated.immich.openapi_client.exceptions import ApiValueError as ApiValueError -from generated.immich.openapi_client.exceptions import ApiKeyError as ApiKeyError -from generated.immich.openapi_client.exceptions import ApiAttributeError as ApiAttributeError -from generated.immich.openapi_client.exceptions import ApiException as ApiException +from generated.immich.openapi_client.api_response import ApiResponse +from generated.immich.openapi_client.api_client import ApiClient +from generated.immich.openapi_client.configuration import Configuration +from generated.immich.openapi_client.exceptions import OpenApiException +from generated.immich.openapi_client.exceptions import ApiTypeError +from generated.immich.openapi_client.exceptions import ApiValueError +from generated.immich.openapi_client.exceptions import ApiKeyError +from generated.immich.openapi_client.exceptions import ApiAttributeError +from generated.immich.openapi_client.exceptions import ApiException # import models into sdk package -from generated.immich.openapi_client.models.activity_create_dto import ActivityCreateDto as ActivityCreateDto -from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto as ActivityResponseDto -from generated.immich.openapi_client.models.activity_statistics_response_dto import ActivityStatisticsResponseDto as ActivityStatisticsResponseDto -from generated.immich.openapi_client.models.add_users_dto import AddUsersDto as AddUsersDto -from generated.immich.openapi_client.models.admin_onboarding_update_dto import AdminOnboardingUpdateDto as AdminOnboardingUpdateDto -from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto as AlbumResponseDto -from generated.immich.openapi_client.models.album_statistics_response_dto import AlbumStatisticsResponseDto as AlbumStatisticsResponseDto -from generated.immich.openapi_client.models.album_user_add_dto import AlbumUserAddDto as AlbumUserAddDto -from generated.immich.openapi_client.models.album_user_create_dto import AlbumUserCreateDto as AlbumUserCreateDto -from generated.immich.openapi_client.models.album_user_response_dto import AlbumUserResponseDto as AlbumUserResponseDto -from generated.immich.openapi_client.models.album_user_role import AlbumUserRole as AlbumUserRole -from generated.immich.openapi_client.models.albums_add_assets_dto import AlbumsAddAssetsDto as AlbumsAddAssetsDto -from generated.immich.openapi_client.models.albums_add_assets_response_dto import AlbumsAddAssetsResponseDto as AlbumsAddAssetsResponseDto -from generated.immich.openapi_client.models.albums_response import AlbumsResponse as AlbumsResponse -from generated.immich.openapi_client.models.albums_update import AlbumsUpdate as AlbumsUpdate -from generated.immich.openapi_client.models.api_key_create_dto import ApiKeyCreateDto as ApiKeyCreateDto -from generated.immich.openapi_client.models.api_key_create_response_dto import ApiKeyCreateResponseDto as ApiKeyCreateResponseDto -from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto as ApiKeyResponseDto -from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto as ApiKeyUpdateDto -from generated.immich.openapi_client.models.asset_bulk_delete_dto import AssetBulkDeleteDto as AssetBulkDeleteDto -from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto as AssetBulkUpdateDto -from generated.immich.openapi_client.models.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto as AssetBulkUploadCheckDto -from generated.immich.openapi_client.models.asset_bulk_upload_check_item import AssetBulkUploadCheckItem as AssetBulkUploadCheckItem -from generated.immich.openapi_client.models.asset_bulk_upload_check_response_dto import AssetBulkUploadCheckResponseDto as AssetBulkUploadCheckResponseDto -from generated.immich.openapi_client.models.asset_bulk_upload_check_result import AssetBulkUploadCheckResult as AssetBulkUploadCheckResult -from generated.immich.openapi_client.models.asset_copy_dto import AssetCopyDto as AssetCopyDto -from generated.immich.openapi_client.models.asset_edit_action import AssetEditAction as AssetEditAction -from generated.immich.openapi_client.models.asset_edit_action_item_dto import AssetEditActionItemDto as AssetEditActionItemDto -from generated.immich.openapi_client.models.asset_edit_action_item_dto_parameters import AssetEditActionItemDtoParameters as AssetEditActionItemDtoParameters -from generated.immich.openapi_client.models.asset_edit_action_item_response_dto import AssetEditActionItemResponseDto as AssetEditActionItemResponseDto -from generated.immich.openapi_client.models.asset_edits_create_dto import AssetEditsCreateDto as AssetEditsCreateDto -from generated.immich.openapi_client.models.asset_edits_response_dto import AssetEditsResponseDto as AssetEditsResponseDto -from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto as AssetFaceCreateDto -from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto as AssetFaceDeleteDto -from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto as AssetFaceResponseDto -from generated.immich.openapi_client.models.asset_face_update_dto import AssetFaceUpdateDto as AssetFaceUpdateDto -from generated.immich.openapi_client.models.asset_face_update_item import AssetFaceUpdateItem as AssetFaceUpdateItem -from generated.immich.openapi_client.models.asset_id_error_reason import AssetIdErrorReason as AssetIdErrorReason -from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto as AssetIdsDto -from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto as AssetIdsResponseDto -from generated.immich.openapi_client.models.asset_job_name import AssetJobName as AssetJobName -from generated.immich.openapi_client.models.asset_jobs_dto import AssetJobsDto as AssetJobsDto -from generated.immich.openapi_client.models.asset_media_response_dto import AssetMediaResponseDto as AssetMediaResponseDto -from generated.immich.openapi_client.models.asset_media_size import AssetMediaSize as AssetMediaSize -from generated.immich.openapi_client.models.asset_media_status import AssetMediaStatus as AssetMediaStatus -from generated.immich.openapi_client.models.asset_metadata_bulk_delete_dto import AssetMetadataBulkDeleteDto as AssetMetadataBulkDeleteDto -from generated.immich.openapi_client.models.asset_metadata_bulk_delete_item_dto import AssetMetadataBulkDeleteItemDto as AssetMetadataBulkDeleteItemDto -from generated.immich.openapi_client.models.asset_metadata_bulk_response_dto import AssetMetadataBulkResponseDto as AssetMetadataBulkResponseDto -from generated.immich.openapi_client.models.asset_metadata_bulk_upsert_dto import AssetMetadataBulkUpsertDto as AssetMetadataBulkUpsertDto -from generated.immich.openapi_client.models.asset_metadata_bulk_upsert_item_dto import AssetMetadataBulkUpsertItemDto as AssetMetadataBulkUpsertItemDto -from generated.immich.openapi_client.models.asset_metadata_response_dto import AssetMetadataResponseDto as AssetMetadataResponseDto -from generated.immich.openapi_client.models.asset_metadata_upsert_dto import AssetMetadataUpsertDto as AssetMetadataUpsertDto -from generated.immich.openapi_client.models.asset_metadata_upsert_item_dto import AssetMetadataUpsertItemDto as AssetMetadataUpsertItemDto -from generated.immich.openapi_client.models.asset_ocr_response_dto import AssetOcrResponseDto as AssetOcrResponseDto -from generated.immich.openapi_client.models.asset_order import AssetOrder as AssetOrder -from generated.immich.openapi_client.models.asset_order_by import AssetOrderBy as AssetOrderBy -from generated.immich.openapi_client.models.asset_reject_reason import AssetRejectReason as AssetRejectReason -from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto as AssetResponseDto -from generated.immich.openapi_client.models.asset_stack_response_dto import AssetStackResponseDto as AssetStackResponseDto -from generated.immich.openapi_client.models.asset_stats_response_dto import AssetStatsResponseDto as AssetStatsResponseDto -from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum as AssetTypeEnum -from generated.immich.openapi_client.models.asset_upload_action import AssetUploadAction as AssetUploadAction -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility as AssetVisibility -from generated.immich.openapi_client.models.audio_codec import AudioCodec as AudioCodec -from generated.immich.openapi_client.models.auth_status_response_dto import AuthStatusResponseDto as AuthStatusResponseDto -from generated.immich.openapi_client.models.avatar_update import AvatarUpdate as AvatarUpdate -from generated.immich.openapi_client.models.bulk_id_error_reason import BulkIdErrorReason as BulkIdErrorReason -from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto as BulkIdResponseDto -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto as BulkIdsDto -from generated.immich.openapi_client.models.clip_config import CLIPConfig as CLIPConfig -from generated.immich.openapi_client.models.cq_mode import CQMode as CQMode -from generated.immich.openapi_client.models.calendar_heatmap_response_dto import CalendarHeatmapResponseDto as CalendarHeatmapResponseDto -from generated.immich.openapi_client.models.calendar_heatmap_response_dto_series_inner import CalendarHeatmapResponseDtoSeriesInner as CalendarHeatmapResponseDtoSeriesInner -from generated.immich.openapi_client.models.calendar_heatmap_type import CalendarHeatmapType as CalendarHeatmapType -from generated.immich.openapi_client.models.cast_response import CastResponse as CastResponse -from generated.immich.openapi_client.models.cast_update import CastUpdate as CastUpdate -from generated.immich.openapi_client.models.change_password_dto import ChangePasswordDto as ChangePasswordDto -from generated.immich.openapi_client.models.colorspace import Colorspace as Colorspace -from generated.immich.openapi_client.models.contributor_count_response_dto import ContributorCountResponseDto as ContributorCountResponseDto -from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto as CreateAlbumDto -from generated.immich.openapi_client.models.create_library_dto import CreateLibraryDto as CreateLibraryDto -from generated.immich.openapi_client.models.create_profile_image_response_dto import CreateProfileImageResponseDto as CreateProfileImageResponseDto -from generated.immich.openapi_client.models.crop_parameters import CropParameters as CropParameters -from generated.immich.openapi_client.models.database_backup_config import DatabaseBackupConfig as DatabaseBackupConfig -from generated.immich.openapi_client.models.database_backup_delete_dto import DatabaseBackupDeleteDto as DatabaseBackupDeleteDto -from generated.immich.openapi_client.models.database_backup_dto import DatabaseBackupDto as DatabaseBackupDto -from generated.immich.openapi_client.models.database_backup_list_response_dto import DatabaseBackupListResponseDto as DatabaseBackupListResponseDto -from generated.immich.openapi_client.models.download_archive_dto import DownloadArchiveDto as DownloadArchiveDto -from generated.immich.openapi_client.models.download_archive_info import DownloadArchiveInfo as DownloadArchiveInfo -from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto as DownloadInfoDto -from generated.immich.openapi_client.models.download_response import DownloadResponse as DownloadResponse -from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto as DownloadResponseDto -from generated.immich.openapi_client.models.download_update import DownloadUpdate as DownloadUpdate -from generated.immich.openapi_client.models.duplicate_detection_config import DuplicateDetectionConfig as DuplicateDetectionConfig -from generated.immich.openapi_client.models.duplicate_resolve_dto import DuplicateResolveDto as DuplicateResolveDto -from generated.immich.openapi_client.models.duplicate_resolve_group_dto import DuplicateResolveGroupDto as DuplicateResolveGroupDto -from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto as DuplicateResponseDto -from generated.immich.openapi_client.models.email_notifications_response import EmailNotificationsResponse as EmailNotificationsResponse -from generated.immich.openapi_client.models.email_notifications_update import EmailNotificationsUpdate as EmailNotificationsUpdate -from generated.immich.openapi_client.models.exif_response_dto import ExifResponseDto as ExifResponseDto -from generated.immich.openapi_client.models.face_dto import FaceDto as FaceDto -from generated.immich.openapi_client.models.facial_recognition_config import FacialRecognitionConfig as FacialRecognitionConfig -from generated.immich.openapi_client.models.folders_response import FoldersResponse as FoldersResponse -from generated.immich.openapi_client.models.folders_update import FoldersUpdate as FoldersUpdate -from generated.immich.openapi_client.models.image_format import ImageFormat as ImageFormat -from generated.immich.openapi_client.models.integrity_report import IntegrityReport as IntegrityReport -from generated.immich.openapi_client.models.integrity_report_response_dto import IntegrityReportResponseDto as IntegrityReportResponseDto -from generated.immich.openapi_client.models.integrity_report_response_dto_items_inner import IntegrityReportResponseDtoItemsInner as IntegrityReportResponseDtoItemsInner -from generated.immich.openapi_client.models.integrity_report_summary_response_dto import IntegrityReportSummaryResponseDto as IntegrityReportSummaryResponseDto -from generated.immich.openapi_client.models.job_create_dto import JobCreateDto as JobCreateDto -from generated.immich.openapi_client.models.job_name import JobName as JobName -from generated.immich.openapi_client.models.job_settings_dto import JobSettingsDto as JobSettingsDto -from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto as LibraryResponseDto -from generated.immich.openapi_client.models.library_stats_response_dto import LibraryStatsResponseDto as LibraryStatsResponseDto -from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto as LicenseKeyDto -from generated.immich.openapi_client.models.log_level import LogLevel as LogLevel -from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto as LoginCredentialDto -from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto as LoginResponseDto -from generated.immich.openapi_client.models.logout_response_dto import LogoutResponseDto as LogoutResponseDto -from generated.immich.openapi_client.models.machine_learning_availability_checks_dto import MachineLearningAvailabilityChecksDto as MachineLearningAvailabilityChecksDto -from generated.immich.openapi_client.models.maintenance_action import MaintenanceAction as MaintenanceAction -from generated.immich.openapi_client.models.maintenance_auth_dto import MaintenanceAuthDto as MaintenanceAuthDto -from generated.immich.openapi_client.models.maintenance_detect_install_response_dto import MaintenanceDetectInstallResponseDto as MaintenanceDetectInstallResponseDto -from generated.immich.openapi_client.models.maintenance_detect_install_storage_folder_dto import MaintenanceDetectInstallStorageFolderDto as MaintenanceDetectInstallStorageFolderDto -from generated.immich.openapi_client.models.maintenance_login_dto import MaintenanceLoginDto as MaintenanceLoginDto -from generated.immich.openapi_client.models.maintenance_status_response_dto import MaintenanceStatusResponseDto as MaintenanceStatusResponseDto -from generated.immich.openapi_client.models.manual_job_name import ManualJobName as ManualJobName -from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto as MapMarkerResponseDto -from generated.immich.openapi_client.models.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto as MapReverseGeocodeResponseDto -from generated.immich.openapi_client.models.memories_response import MemoriesResponse as MemoriesResponse -from generated.immich.openapi_client.models.memories_update import MemoriesUpdate as MemoriesUpdate -from generated.immich.openapi_client.models.memory_create_dto import MemoryCreateDto as MemoryCreateDto -from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto as MemoryResponseDto -from generated.immich.openapi_client.models.memory_search_order import MemorySearchOrder as MemorySearchOrder -from generated.immich.openapi_client.models.memory_statistics_response_dto import MemoryStatisticsResponseDto as MemoryStatisticsResponseDto -from generated.immich.openapi_client.models.memory_type import MemoryType as MemoryType -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto as MemoryUpdateDto -from generated.immich.openapi_client.models.merge_person_dto import MergePersonDto as MergePersonDto -from generated.immich.openapi_client.models.metadata_search_dto import MetadataSearchDto as MetadataSearchDto -from generated.immich.openapi_client.models.mirror_axis import MirrorAxis as MirrorAxis -from generated.immich.openapi_client.models.mirror_parameters import MirrorParameters as MirrorParameters -from generated.immich.openapi_client.models.notification_create_dto import NotificationCreateDto as NotificationCreateDto -from generated.immich.openapi_client.models.notification_delete_all_dto import NotificationDeleteAllDto as NotificationDeleteAllDto -from generated.immich.openapi_client.models.notification_dto import NotificationDto as NotificationDto -from generated.immich.openapi_client.models.notification_level import NotificationLevel as NotificationLevel -from generated.immich.openapi_client.models.notification_type import NotificationType as NotificationType -from generated.immich.openapi_client.models.notification_update_all_dto import NotificationUpdateAllDto as NotificationUpdateAllDto -from generated.immich.openapi_client.models.notification_update_dto import NotificationUpdateDto as NotificationUpdateDto -from generated.immich.openapi_client.models.o_auth_authorize_response_dto import OAuthAuthorizeResponseDto as OAuthAuthorizeResponseDto -from generated.immich.openapi_client.models.o_auth_callback_dto import OAuthCallbackDto as OAuthCallbackDto -from generated.immich.openapi_client.models.o_auth_config_dto import OAuthConfigDto as OAuthConfigDto -from generated.immich.openapi_client.models.o_auth_token_endpoint_auth_method import OAuthTokenEndpointAuthMethod as OAuthTokenEndpointAuthMethod -from generated.immich.openapi_client.models.ocr_config import OcrConfig as OcrConfig -from generated.immich.openapi_client.models.on_this_day_dto import OnThisDayDto as OnThisDayDto -from generated.immich.openapi_client.models.onboarding_dto import OnboardingDto as OnboardingDto -from generated.immich.openapi_client.models.onboarding_response_dto import OnboardingResponseDto as OnboardingResponseDto -from generated.immich.openapi_client.models.partner_create_dto import PartnerCreateDto as PartnerCreateDto -from generated.immich.openapi_client.models.partner_direction import PartnerDirection as PartnerDirection -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto as PartnerResponseDto -from generated.immich.openapi_client.models.partner_update_dto import PartnerUpdateDto as PartnerUpdateDto -from generated.immich.openapi_client.models.people_response import PeopleResponse as PeopleResponse -from generated.immich.openapi_client.models.people_response_dto import PeopleResponseDto as PeopleResponseDto -from generated.immich.openapi_client.models.people_update import PeopleUpdate as PeopleUpdate -from generated.immich.openapi_client.models.people_update_dto import PeopleUpdateDto as PeopleUpdateDto -from generated.immich.openapi_client.models.people_update_item import PeopleUpdateItem as PeopleUpdateItem -from generated.immich.openapi_client.models.permission import Permission as Permission -from generated.immich.openapi_client.models.person_create_dto import PersonCreateDto as PersonCreateDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto as PersonResponseDto -from generated.immich.openapi_client.models.person_statistics_response_dto import PersonStatisticsResponseDto as PersonStatisticsResponseDto -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto as PersonUpdateDto -from generated.immich.openapi_client.models.pin_code_change_dto import PinCodeChangeDto as PinCodeChangeDto -from generated.immich.openapi_client.models.pin_code_reset_dto import PinCodeResetDto as PinCodeResetDto -from generated.immich.openapi_client.models.pin_code_setup_dto import PinCodeSetupDto as PinCodeSetupDto -from generated.immich.openapi_client.models.places_response_dto import PlacesResponseDto as PlacesResponseDto -from generated.immich.openapi_client.models.plugin_method_response_dto import PluginMethodResponseDto as PluginMethodResponseDto -from generated.immich.openapi_client.models.plugin_response_dto import PluginResponseDto as PluginResponseDto -from generated.immich.openapi_client.models.plugin_template_response_dto import PluginTemplateResponseDto as PluginTemplateResponseDto -from generated.immich.openapi_client.models.plugin_template_step_response_dto import PluginTemplateStepResponseDto as PluginTemplateStepResponseDto -from generated.immich.openapi_client.models.purchase_response import PurchaseResponse as PurchaseResponse -from generated.immich.openapi_client.models.purchase_update import PurchaseUpdate as PurchaseUpdate -from generated.immich.openapi_client.models.queue_command import QueueCommand as QueueCommand -from generated.immich.openapi_client.models.queue_command_dto import QueueCommandDto as QueueCommandDto -from generated.immich.openapi_client.models.queue_delete_dto import QueueDeleteDto as QueueDeleteDto -from generated.immich.openapi_client.models.queue_job_response_dto import QueueJobResponseDto as QueueJobResponseDto -from generated.immich.openapi_client.models.queue_job_status import QueueJobStatus as QueueJobStatus -from generated.immich.openapi_client.models.queue_name import QueueName as QueueName -from generated.immich.openapi_client.models.queue_response_dto import QueueResponseDto as QueueResponseDto -from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto as QueueResponseLegacyDto -from generated.immich.openapi_client.models.queue_statistics_dto import QueueStatisticsDto as QueueStatisticsDto -from generated.immich.openapi_client.models.queue_status_legacy_dto import QueueStatusLegacyDto as QueueStatusLegacyDto -from generated.immich.openapi_client.models.queue_update_dto import QueueUpdateDto as QueueUpdateDto -from generated.immich.openapi_client.models.queues_response_legacy_dto import QueuesResponseLegacyDto as QueuesResponseLegacyDto -from generated.immich.openapi_client.models.random_search_dto import RandomSearchDto as RandomSearchDto -from generated.immich.openapi_client.models.ratings_response import RatingsResponse as RatingsResponse -from generated.immich.openapi_client.models.ratings_update import RatingsUpdate as RatingsUpdate -from generated.immich.openapi_client.models.reaction_level import ReactionLevel as ReactionLevel -from generated.immich.openapi_client.models.reaction_type import ReactionType as ReactionType -from generated.immich.openapi_client.models.recently_added_response import RecentlyAddedResponse as RecentlyAddedResponse -from generated.immich.openapi_client.models.recently_added_update import RecentlyAddedUpdate as RecentlyAddedUpdate -from generated.immich.openapi_client.models.release_channel import ReleaseChannel as ReleaseChannel -from generated.immich.openapi_client.models.release_event_v1 import ReleaseEventV1 as ReleaseEventV1 -from generated.immich.openapi_client.models.release_type import ReleaseType as ReleaseType -from generated.immich.openapi_client.models.reverse_geocoding_state_response_dto import ReverseGeocodingStateResponseDto as ReverseGeocodingStateResponseDto -from generated.immich.openapi_client.models.rotate_parameters import RotateParameters as RotateParameters -from generated.immich.openapi_client.models.search_album_response_dto import SearchAlbumResponseDto as SearchAlbumResponseDto -from generated.immich.openapi_client.models.search_asset_response_dto import SearchAssetResponseDto as SearchAssetResponseDto -from generated.immich.openapi_client.models.search_explore_item import SearchExploreItem as SearchExploreItem -from generated.immich.openapi_client.models.search_explore_response_dto import SearchExploreResponseDto as SearchExploreResponseDto -from generated.immich.openapi_client.models.search_facet_count_response_dto import SearchFacetCountResponseDto as SearchFacetCountResponseDto -from generated.immich.openapi_client.models.search_facet_response_dto import SearchFacetResponseDto as SearchFacetResponseDto -from generated.immich.openapi_client.models.search_response_dto import SearchResponseDto as SearchResponseDto -from generated.immich.openapi_client.models.search_statistics_response_dto import SearchStatisticsResponseDto as SearchStatisticsResponseDto -from generated.immich.openapi_client.models.search_suggestion_type import SearchSuggestionType as SearchSuggestionType -from generated.immich.openapi_client.models.server_about_response_dto import ServerAboutResponseDto as ServerAboutResponseDto -from generated.immich.openapi_client.models.server_apk_links_dto import ServerApkLinksDto as ServerApkLinksDto -from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto as ServerConfigDto -from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto as ServerFeaturesDto -from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto as ServerMediaTypesResponseDto -from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse as ServerPingResponse -from generated.immich.openapi_client.models.server_stats_response_dto import ServerStatsResponseDto as ServerStatsResponseDto -from generated.immich.openapi_client.models.server_storage_response_dto import ServerStorageResponseDto as ServerStorageResponseDto -from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto as ServerVersionHistoryResponseDto -from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto as ServerVersionResponseDto -from generated.immich.openapi_client.models.session_create_dto import SessionCreateDto as SessionCreateDto -from generated.immich.openapi_client.models.session_create_response_dto import SessionCreateResponseDto as SessionCreateResponseDto -from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto as SessionResponseDto -from generated.immich.openapi_client.models.session_unlock_dto import SessionUnlockDto as SessionUnlockDto -from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto as SessionUpdateDto -from generated.immich.openapi_client.models.set_maintenance_mode_dto import SetMaintenanceModeDto as SetMaintenanceModeDto -from generated.immich.openapi_client.models.shared_link_create_dto import SharedLinkCreateDto as SharedLinkCreateDto -from generated.immich.openapi_client.models.shared_link_edit_dto import SharedLinkEditDto as SharedLinkEditDto -from generated.immich.openapi_client.models.shared_link_login_dto import SharedLinkLoginDto as SharedLinkLoginDto -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto as SharedLinkResponseDto -from generated.immich.openapi_client.models.shared_link_type import SharedLinkType as SharedLinkType -from generated.immich.openapi_client.models.shared_links_response import SharedLinksResponse as SharedLinksResponse -from generated.immich.openapi_client.models.shared_links_update import SharedLinksUpdate as SharedLinksUpdate -from generated.immich.openapi_client.models.sign_up_dto import SignUpDto as SignUpDto -from generated.immich.openapi_client.models.smart_search_dto import SmartSearchDto as SmartSearchDto -from generated.immich.openapi_client.models.source_type import SourceType as SourceType -from generated.immich.openapi_client.models.stack_create_dto import StackCreateDto as StackCreateDto -from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto as StackResponseDto -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto as StackUpdateDto -from generated.immich.openapi_client.models.statistics_search_dto import StatisticsSearchDto as StatisticsSearchDto -from generated.immich.openapi_client.models.storage_folder import StorageFolder as StorageFolder -from generated.immich.openapi_client.models.sync_ack_delete_dto import SyncAckDeleteDto as SyncAckDeleteDto -from generated.immich.openapi_client.models.sync_ack_dto import SyncAckDto as SyncAckDto -from generated.immich.openapi_client.models.sync_ack_set_dto import SyncAckSetDto as SyncAckSetDto -from generated.immich.openapi_client.models.sync_album_delete_v1 import SyncAlbumDeleteV1 as SyncAlbumDeleteV1 -from generated.immich.openapi_client.models.sync_album_to_asset_delete_v1 import SyncAlbumToAssetDeleteV1 as SyncAlbumToAssetDeleteV1 -from generated.immich.openapi_client.models.sync_album_to_asset_v1 import SyncAlbumToAssetV1 as SyncAlbumToAssetV1 -from generated.immich.openapi_client.models.sync_album_user_delete_v1 import SyncAlbumUserDeleteV1 as SyncAlbumUserDeleteV1 -from generated.immich.openapi_client.models.sync_album_user_v1 import SyncAlbumUserV1 as SyncAlbumUserV1 -from generated.immich.openapi_client.models.sync_album_v1 import SyncAlbumV1 as SyncAlbumV1 -from generated.immich.openapi_client.models.sync_album_v2 import SyncAlbumV2 as SyncAlbumV2 -from generated.immich.openapi_client.models.sync_asset_delete_v1 import SyncAssetDeleteV1 as SyncAssetDeleteV1 -from generated.immich.openapi_client.models.sync_asset_edit_delete_v1 import SyncAssetEditDeleteV1 as SyncAssetEditDeleteV1 -from generated.immich.openapi_client.models.sync_asset_edit_v1 import SyncAssetEditV1 as SyncAssetEditV1 -from generated.immich.openapi_client.models.sync_asset_exif_v1 import SyncAssetExifV1 as SyncAssetExifV1 -from generated.immich.openapi_client.models.sync_asset_face_delete_v1 import SyncAssetFaceDeleteV1 as SyncAssetFaceDeleteV1 -from generated.immich.openapi_client.models.sync_asset_face_v1 import SyncAssetFaceV1 as SyncAssetFaceV1 -from generated.immich.openapi_client.models.sync_asset_face_v2 import SyncAssetFaceV2 as SyncAssetFaceV2 -from generated.immich.openapi_client.models.sync_asset_metadata_delete_v1 import SyncAssetMetadataDeleteV1 as SyncAssetMetadataDeleteV1 -from generated.immich.openapi_client.models.sync_asset_metadata_v1 import SyncAssetMetadataV1 as SyncAssetMetadataV1 -from generated.immich.openapi_client.models.sync_asset_ocr_delete_v1 import SyncAssetOcrDeleteV1 as SyncAssetOcrDeleteV1 -from generated.immich.openapi_client.models.sync_asset_ocr_v1 import SyncAssetOcrV1 as SyncAssetOcrV1 -from generated.immich.openapi_client.models.sync_asset_v1 import SyncAssetV1 as SyncAssetV1 -from generated.immich.openapi_client.models.sync_asset_v2 import SyncAssetV2 as SyncAssetV2 -from generated.immich.openapi_client.models.sync_auth_user_v1 import SyncAuthUserV1 as SyncAuthUserV1 -from generated.immich.openapi_client.models.sync_entity_type import SyncEntityType as SyncEntityType -from generated.immich.openapi_client.models.sync_memory_asset_delete_v1 import SyncMemoryAssetDeleteV1 as SyncMemoryAssetDeleteV1 -from generated.immich.openapi_client.models.sync_memory_asset_v1 import SyncMemoryAssetV1 as SyncMemoryAssetV1 -from generated.immich.openapi_client.models.sync_memory_delete_v1 import SyncMemoryDeleteV1 as SyncMemoryDeleteV1 -from generated.immich.openapi_client.models.sync_memory_v1 import SyncMemoryV1 as SyncMemoryV1 -from generated.immich.openapi_client.models.sync_partner_delete_v1 import SyncPartnerDeleteV1 as SyncPartnerDeleteV1 -from generated.immich.openapi_client.models.sync_partner_v1 import SyncPartnerV1 as SyncPartnerV1 -from generated.immich.openapi_client.models.sync_person_delete_v1 import SyncPersonDeleteV1 as SyncPersonDeleteV1 -from generated.immich.openapi_client.models.sync_person_v1 import SyncPersonV1 as SyncPersonV1 -from generated.immich.openapi_client.models.sync_request_type import SyncRequestType as SyncRequestType -from generated.immich.openapi_client.models.sync_stack_delete_v1 import SyncStackDeleteV1 as SyncStackDeleteV1 -from generated.immich.openapi_client.models.sync_stack_v1 import SyncStackV1 as SyncStackV1 -from generated.immich.openapi_client.models.sync_stream_dto import SyncStreamDto as SyncStreamDto -from generated.immich.openapi_client.models.sync_user_delete_v1 import SyncUserDeleteV1 as SyncUserDeleteV1 -from generated.immich.openapi_client.models.sync_user_metadata_delete_v1 import SyncUserMetadataDeleteV1 as SyncUserMetadataDeleteV1 -from generated.immich.openapi_client.models.sync_user_metadata_v1 import SyncUserMetadataV1 as SyncUserMetadataV1 -from generated.immich.openapi_client.models.sync_user_v1 import SyncUserV1 as SyncUserV1 -from generated.immich.openapi_client.models.system_config_backups_dto import SystemConfigBackupsDto as SystemConfigBackupsDto -from generated.immich.openapi_client.models.system_config_dto import SystemConfigDto as SystemConfigDto -from generated.immich.openapi_client.models.system_config_f_fmpeg_dto import SystemConfigFFmpegDto as SystemConfigFFmpegDto -from generated.immich.openapi_client.models.system_config_f_fmpeg_realtime_dto import SystemConfigFFmpegRealtimeDto as SystemConfigFFmpegRealtimeDto -from generated.immich.openapi_client.models.system_config_faces_dto import SystemConfigFacesDto as SystemConfigFacesDto -from generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto import SystemConfigGeneratedFullsizeImageDto as SystemConfigGeneratedFullsizeImageDto -from generated.immich.openapi_client.models.system_config_generated_image_dto import SystemConfigGeneratedImageDto as SystemConfigGeneratedImageDto -from generated.immich.openapi_client.models.system_config_image_dto import SystemConfigImageDto as SystemConfigImageDto -from generated.immich.openapi_client.models.system_config_integrity_checks import SystemConfigIntegrityChecks as SystemConfigIntegrityChecks -from generated.immich.openapi_client.models.system_config_integrity_checksum_job import SystemConfigIntegrityChecksumJob as SystemConfigIntegrityChecksumJob -from generated.immich.openapi_client.models.system_config_integrity_job import SystemConfigIntegrityJob as SystemConfigIntegrityJob -from generated.immich.openapi_client.models.system_config_job_dto import SystemConfigJobDto as SystemConfigJobDto -from generated.immich.openapi_client.models.system_config_library_dto import SystemConfigLibraryDto as SystemConfigLibraryDto -from generated.immich.openapi_client.models.system_config_library_scan_dto import SystemConfigLibraryScanDto as SystemConfigLibraryScanDto -from generated.immich.openapi_client.models.system_config_library_watch_dto import SystemConfigLibraryWatchDto as SystemConfigLibraryWatchDto -from generated.immich.openapi_client.models.system_config_logging_dto import SystemConfigLoggingDto as SystemConfigLoggingDto -from generated.immich.openapi_client.models.system_config_machine_learning_dto import SystemConfigMachineLearningDto as SystemConfigMachineLearningDto -from generated.immich.openapi_client.models.system_config_map_dto import SystemConfigMapDto as SystemConfigMapDto -from generated.immich.openapi_client.models.system_config_metadata_dto import SystemConfigMetadataDto as SystemConfigMetadataDto -from generated.immich.openapi_client.models.system_config_new_version_check_dto import SystemConfigNewVersionCheckDto as SystemConfigNewVersionCheckDto -from generated.immich.openapi_client.models.system_config_nightly_tasks_dto import SystemConfigNightlyTasksDto as SystemConfigNightlyTasksDto -from generated.immich.openapi_client.models.system_config_notifications_dto import SystemConfigNotificationsDto as SystemConfigNotificationsDto -from generated.immich.openapi_client.models.system_config_o_auth_dto import SystemConfigOAuthDto as SystemConfigOAuthDto -from generated.immich.openapi_client.models.system_config_password_login_dto import SystemConfigPasswordLoginDto as SystemConfigPasswordLoginDto -from generated.immich.openapi_client.models.system_config_reverse_geocoding_dto import SystemConfigReverseGeocodingDto as SystemConfigReverseGeocodingDto -from generated.immich.openapi_client.models.system_config_server_dto import SystemConfigServerDto as SystemConfigServerDto -from generated.immich.openapi_client.models.system_config_smtp_dto import SystemConfigSmtpDto as SystemConfigSmtpDto -from generated.immich.openapi_client.models.system_config_smtp_transport_dto import SystemConfigSmtpTransportDto as SystemConfigSmtpTransportDto -from generated.immich.openapi_client.models.system_config_storage_template_dto import SystemConfigStorageTemplateDto as SystemConfigStorageTemplateDto -from generated.immich.openapi_client.models.system_config_template_emails_dto import SystemConfigTemplateEmailsDto as SystemConfigTemplateEmailsDto -from generated.immich.openapi_client.models.system_config_template_storage_option_dto import SystemConfigTemplateStorageOptionDto as SystemConfigTemplateStorageOptionDto -from generated.immich.openapi_client.models.system_config_templates_dto import SystemConfigTemplatesDto as SystemConfigTemplatesDto -from generated.immich.openapi_client.models.system_config_theme_dto import SystemConfigThemeDto as SystemConfigThemeDto -from generated.immich.openapi_client.models.system_config_trash_dto import SystemConfigTrashDto as SystemConfigTrashDto -from generated.immich.openapi_client.models.system_config_user_dto import SystemConfigUserDto as SystemConfigUserDto -from generated.immich.openapi_client.models.tag_bulk_assets_dto import TagBulkAssetsDto as TagBulkAssetsDto -from generated.immich.openapi_client.models.tag_bulk_assets_response_dto import TagBulkAssetsResponseDto as TagBulkAssetsResponseDto -from generated.immich.openapi_client.models.tag_create_dto import TagCreateDto as TagCreateDto -from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto as TagResponseDto -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto as TagUpdateDto -from generated.immich.openapi_client.models.tag_upsert_dto import TagUpsertDto as TagUpsertDto -from generated.immich.openapi_client.models.tags_response import TagsResponse as TagsResponse -from generated.immich.openapi_client.models.tags_update import TagsUpdate as TagsUpdate -from generated.immich.openapi_client.models.template_dto import TemplateDto as TemplateDto -from generated.immich.openapi_client.models.template_response_dto import TemplateResponseDto as TemplateResponseDto -from generated.immich.openapi_client.models.test_email_response_dto import TestEmailResponseDto as TestEmailResponseDto -from generated.immich.openapi_client.models.time_bucket_asset_response_dto import TimeBucketAssetResponseDto as TimeBucketAssetResponseDto -from generated.immich.openapi_client.models.time_buckets_response_dto import TimeBucketsResponseDto as TimeBucketsResponseDto -from generated.immich.openapi_client.models.tone_mapping import ToneMapping as ToneMapping -from generated.immich.openapi_client.models.transcode_hw_accel import TranscodeHWAccel as TranscodeHWAccel -from generated.immich.openapi_client.models.transcode_policy import TranscodePolicy as TranscodePolicy -from generated.immich.openapi_client.models.trash_response_dto import TrashResponseDto as TrashResponseDto -from generated.immich.openapi_client.models.update_album_dto import UpdateAlbumDto as UpdateAlbumDto -from generated.immich.openapi_client.models.update_album_user_dto import UpdateAlbumUserDto as UpdateAlbumUserDto -from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto as UpdateAssetDto -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto as UpdateLibraryDto -from generated.immich.openapi_client.models.usage_by_user_dto import UsageByUserDto as UsageByUserDto -from generated.immich.openapi_client.models.user_admin_create_dto import UserAdminCreateDto as UserAdminCreateDto -from generated.immich.openapi_client.models.user_admin_delete_dto import UserAdminDeleteDto as UserAdminDeleteDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto as UserAdminResponseDto -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto as UserAdminUpdateDto -from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor as UserAvatarColor -from generated.immich.openapi_client.models.user_license import UserLicense as UserLicense -from generated.immich.openapi_client.models.user_metadata_key import UserMetadataKey as UserMetadataKey -from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto as UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto as UserPreferencesUpdateDto -from generated.immich.openapi_client.models.user_response_dto import UserResponseDto as UserResponseDto -from generated.immich.openapi_client.models.user_status import UserStatus as UserStatus -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto as UserUpdateMeDto -from generated.immich.openapi_client.models.validate_access_token_response_dto import ValidateAccessTokenResponseDto as ValidateAccessTokenResponseDto -from generated.immich.openapi_client.models.validate_library_dto import ValidateLibraryDto as ValidateLibraryDto -from generated.immich.openapi_client.models.validate_library_import_path_response_dto import ValidateLibraryImportPathResponseDto as ValidateLibraryImportPathResponseDto -from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto as ValidateLibraryResponseDto -from generated.immich.openapi_client.models.version_check_state_response_dto import VersionCheckStateResponseDto as VersionCheckStateResponseDto -from generated.immich.openapi_client.models.video_codec import VideoCodec as VideoCodec -from generated.immich.openapi_client.models.video_container import VideoContainer as VideoContainer -from generated.immich.openapi_client.models.workflow_create_dto import WorkflowCreateDto as WorkflowCreateDto -from generated.immich.openapi_client.models.workflow_response_dto import WorkflowResponseDto as WorkflowResponseDto -from generated.immich.openapi_client.models.workflow_share_response_dto import WorkflowShareResponseDto as WorkflowShareResponseDto -from generated.immich.openapi_client.models.workflow_share_step_dto import WorkflowShareStepDto as WorkflowShareStepDto -from generated.immich.openapi_client.models.workflow_step_dto import WorkflowStepDto as WorkflowStepDto -from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger as WorkflowTrigger -from generated.immich.openapi_client.models.workflow_trigger_response_dto import WorkflowTriggerResponseDto as WorkflowTriggerResponseDto -from generated.immich.openapi_client.models.workflow_type import WorkflowType as WorkflowType -from generated.immich.openapi_client.models.workflow_update_dto import WorkflowUpdateDto as WorkflowUpdateDto - +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.models.activity_statistics_response_dto import ActivityStatisticsResponseDto +from generated.immich.openapi_client.models.add_users_dto import AddUsersDto +from generated.immich.openapi_client.models.admin_onboarding_update_dto import AdminOnboardingUpdateDto +from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto +from generated.immich.openapi_client.models.album_statistics_response_dto import AlbumStatisticsResponseDto +from generated.immich.openapi_client.models.album_user_add_dto import AlbumUserAddDto +from generated.immich.openapi_client.models.album_user_create_dto import AlbumUserCreateDto +from generated.immich.openapi_client.models.album_user_response_dto import AlbumUserResponseDto +from generated.immich.openapi_client.models.album_user_role import AlbumUserRole +from generated.immich.openapi_client.models.albums_add_assets_dto import AlbumsAddAssetsDto +from generated.immich.openapi_client.models.albums_add_assets_response_dto import AlbumsAddAssetsResponseDto +from generated.immich.openapi_client.models.albums_response import AlbumsResponse +from generated.immich.openapi_client.models.albums_update import AlbumsUpdate +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.models.api_key_response_dto import ApiKeyResponseDto +from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto +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 +from generated.immich.openapi_client.models.asset_bulk_upload_check_item import AssetBulkUploadCheckItem +from generated.immich.openapi_client.models.asset_bulk_upload_check_response_dto import AssetBulkUploadCheckResponseDto +from generated.immich.openapi_client.models.asset_bulk_upload_check_result import AssetBulkUploadCheckResult +from generated.immich.openapi_client.models.asset_copy_dto import AssetCopyDto +from generated.immich.openapi_client.models.asset_edit_action import AssetEditAction +from generated.immich.openapi_client.models.asset_edit_action_item_dto import AssetEditActionItemDto +from generated.immich.openapi_client.models.asset_edit_action_item_dto_parameters import AssetEditActionItemDtoParameters +from generated.immich.openapi_client.models.asset_edit_action_item_response_dto import AssetEditActionItemResponseDto +from generated.immich.openapi_client.models.asset_edits_create_dto import AssetEditsCreateDto +from generated.immich.openapi_client.models.asset_edits_response_dto import AssetEditsResponseDto +from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto +from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto +from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto +from generated.immich.openapi_client.models.asset_face_update_dto import AssetFaceUpdateDto +from generated.immich.openapi_client.models.asset_face_update_item import AssetFaceUpdateItem +from generated.immich.openapi_client.models.asset_id_error_reason import AssetIdErrorReason +from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto +from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto +from generated.immich.openapi_client.models.asset_job_name import AssetJobName +from generated.immich.openapi_client.models.asset_jobs_dto import AssetJobsDto +from generated.immich.openapi_client.models.asset_media_response_dto import AssetMediaResponseDto +from generated.immich.openapi_client.models.asset_media_size import AssetMediaSize +from generated.immich.openapi_client.models.asset_media_status import AssetMediaStatus +from generated.immich.openapi_client.models.asset_metadata_bulk_delete_dto import AssetMetadataBulkDeleteDto +from generated.immich.openapi_client.models.asset_metadata_bulk_delete_item_dto import AssetMetadataBulkDeleteItemDto +from generated.immich.openapi_client.models.asset_metadata_bulk_response_dto import AssetMetadataBulkResponseDto +from generated.immich.openapi_client.models.asset_metadata_bulk_upsert_dto import AssetMetadataBulkUpsertDto +from generated.immich.openapi_client.models.asset_metadata_bulk_upsert_item_dto import AssetMetadataBulkUpsertItemDto +from generated.immich.openapi_client.models.asset_metadata_response_dto import AssetMetadataResponseDto +from generated.immich.openapi_client.models.asset_metadata_upsert_dto import AssetMetadataUpsertDto +from generated.immich.openapi_client.models.asset_metadata_upsert_item_dto import AssetMetadataUpsertItemDto +from generated.immich.openapi_client.models.asset_ocr_response_dto import AssetOcrResponseDto +from generated.immich.openapi_client.models.asset_order import AssetOrder +from generated.immich.openapi_client.models.asset_order_by import AssetOrderBy +from generated.immich.openapi_client.models.asset_reject_reason import AssetRejectReason +from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto +from generated.immich.openapi_client.models.asset_stack_response_dto import AssetStackResponseDto +from generated.immich.openapi_client.models.asset_stats_response_dto import AssetStatsResponseDto +from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum +from generated.immich.openapi_client.models.asset_upload_action import AssetUploadAction +from generated.immich.openapi_client.models.asset_visibility import AssetVisibility +from generated.immich.openapi_client.models.audio_codec import AudioCodec +from generated.immich.openapi_client.models.auth_status_response_dto import AuthStatusResponseDto +from generated.immich.openapi_client.models.avatar_update import AvatarUpdate +from generated.immich.openapi_client.models.bulk_id_error_reason import BulkIdErrorReason +from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto +from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto +from generated.immich.openapi_client.models.clip_config import CLIPConfig +from generated.immich.openapi_client.models.cq_mode import CQMode +from generated.immich.openapi_client.models.calendar_heatmap_response_dto import CalendarHeatmapResponseDto +from generated.immich.openapi_client.models.calendar_heatmap_response_dto_series_inner import CalendarHeatmapResponseDtoSeriesInner +from generated.immich.openapi_client.models.calendar_heatmap_type import CalendarHeatmapType +from generated.immich.openapi_client.models.cast_response import CastResponse +from generated.immich.openapi_client.models.cast_update import CastUpdate +from generated.immich.openapi_client.models.change_password_dto import ChangePasswordDto +from generated.immich.openapi_client.models.colorspace import Colorspace +from generated.immich.openapi_client.models.contributor_count_response_dto import ContributorCountResponseDto +from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto +from generated.immich.openapi_client.models.create_library_dto import CreateLibraryDto +from generated.immich.openapi_client.models.create_profile_image_response_dto import CreateProfileImageResponseDto +from generated.immich.openapi_client.models.crop_parameters import CropParameters +from generated.immich.openapi_client.models.database_backup_config import DatabaseBackupConfig +from generated.immich.openapi_client.models.database_backup_delete_dto import DatabaseBackupDeleteDto +from generated.immich.openapi_client.models.database_backup_dto import DatabaseBackupDto +from generated.immich.openapi_client.models.database_backup_list_response_dto import DatabaseBackupListResponseDto +from generated.immich.openapi_client.models.download_archive_dto import DownloadArchiveDto +from generated.immich.openapi_client.models.download_archive_info import DownloadArchiveInfo +from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto +from generated.immich.openapi_client.models.download_response import DownloadResponse +from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto +from generated.immich.openapi_client.models.download_update import DownloadUpdate +from generated.immich.openapi_client.models.duplicate_detection_config import DuplicateDetectionConfig +from generated.immich.openapi_client.models.duplicate_resolve_dto import DuplicateResolveDto +from generated.immich.openapi_client.models.duplicate_resolve_group_dto import DuplicateResolveGroupDto +from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto +from generated.immich.openapi_client.models.email_notifications_response import EmailNotificationsResponse +from generated.immich.openapi_client.models.email_notifications_update import EmailNotificationsUpdate +from generated.immich.openapi_client.models.exif_response_dto import ExifResponseDto +from generated.immich.openapi_client.models.face_dto import FaceDto +from generated.immich.openapi_client.models.facial_recognition_config import FacialRecognitionConfig +from generated.immich.openapi_client.models.folders_response import FoldersResponse +from generated.immich.openapi_client.models.folders_update import FoldersUpdate +from generated.immich.openapi_client.models.image_format import ImageFormat +from generated.immich.openapi_client.models.integrity_report import IntegrityReport +from generated.immich.openapi_client.models.integrity_report_response_dto import IntegrityReportResponseDto +from generated.immich.openapi_client.models.integrity_report_response_dto_items_inner import IntegrityReportResponseDtoItemsInner +from generated.immich.openapi_client.models.integrity_report_summary_response_dto import IntegrityReportSummaryResponseDto +from generated.immich.openapi_client.models.job_create_dto import JobCreateDto +from generated.immich.openapi_client.models.job_name import JobName +from generated.immich.openapi_client.models.job_settings_dto import JobSettingsDto +from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto +from generated.immich.openapi_client.models.library_stats_response_dto import LibraryStatsResponseDto +from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto +from generated.immich.openapi_client.models.log_level import LogLevel +from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto +from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto +from generated.immich.openapi_client.models.logout_response_dto import LogoutResponseDto +from generated.immich.openapi_client.models.machine_learning_availability_checks_dto import MachineLearningAvailabilityChecksDto +from generated.immich.openapi_client.models.maintenance_action import MaintenanceAction +from generated.immich.openapi_client.models.maintenance_auth_dto import MaintenanceAuthDto +from generated.immich.openapi_client.models.maintenance_detect_install_response_dto import MaintenanceDetectInstallResponseDto +from generated.immich.openapi_client.models.maintenance_detect_install_storage_folder_dto import MaintenanceDetectInstallStorageFolderDto +from generated.immich.openapi_client.models.maintenance_login_dto import MaintenanceLoginDto +from generated.immich.openapi_client.models.maintenance_status_response_dto import MaintenanceStatusResponseDto +from generated.immich.openapi_client.models.manual_job_name import ManualJobName +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.models.memories_response import MemoriesResponse +from generated.immich.openapi_client.models.memories_update import MemoriesUpdate +from generated.immich.openapi_client.models.memory_create_dto import MemoryCreateDto +from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto +from generated.immich.openapi_client.models.memory_search_order import MemorySearchOrder +from generated.immich.openapi_client.models.memory_statistics_response_dto import MemoryStatisticsResponseDto +from generated.immich.openapi_client.models.memory_type import MemoryType +from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto +from generated.immich.openapi_client.models.merge_person_dto import MergePersonDto +from generated.immich.openapi_client.models.metadata_search_dto import MetadataSearchDto +from generated.immich.openapi_client.models.mirror_axis import MirrorAxis +from generated.immich.openapi_client.models.mirror_parameters import MirrorParameters +from generated.immich.openapi_client.models.notification_create_dto import NotificationCreateDto +from generated.immich.openapi_client.models.notification_delete_all_dto import NotificationDeleteAllDto +from generated.immich.openapi_client.models.notification_dto import NotificationDto +from generated.immich.openapi_client.models.notification_level import NotificationLevel +from generated.immich.openapi_client.models.notification_type import NotificationType +from generated.immich.openapi_client.models.notification_update_all_dto import NotificationUpdateAllDto +from generated.immich.openapi_client.models.notification_update_dto import NotificationUpdateDto +from generated.immich.openapi_client.models.o_auth_authorize_response_dto import OAuthAuthorizeResponseDto +from generated.immich.openapi_client.models.o_auth_callback_dto import OAuthCallbackDto +from generated.immich.openapi_client.models.o_auth_config_dto import OAuthConfigDto +from generated.immich.openapi_client.models.o_auth_token_endpoint_auth_method import OAuthTokenEndpointAuthMethod +from generated.immich.openapi_client.models.ocr_config import OcrConfig +from generated.immich.openapi_client.models.on_this_day_dto import OnThisDayDto +from generated.immich.openapi_client.models.onboarding_dto import OnboardingDto +from generated.immich.openapi_client.models.onboarding_response_dto import OnboardingResponseDto +from generated.immich.openapi_client.models.partner_create_dto import PartnerCreateDto +from generated.immich.openapi_client.models.partner_direction import PartnerDirection +from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto +from generated.immich.openapi_client.models.partner_update_dto import PartnerUpdateDto +from generated.immich.openapi_client.models.people_response import PeopleResponse +from generated.immich.openapi_client.models.people_response_dto import PeopleResponseDto +from generated.immich.openapi_client.models.people_update import PeopleUpdate +from generated.immich.openapi_client.models.people_update_dto import PeopleUpdateDto +from generated.immich.openapi_client.models.people_update_item import PeopleUpdateItem +from generated.immich.openapi_client.models.permission import Permission +from generated.immich.openapi_client.models.person_create_dto import PersonCreateDto +from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto +from generated.immich.openapi_client.models.person_statistics_response_dto import PersonStatisticsResponseDto +from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto +from generated.immich.openapi_client.models.pin_code_change_dto import PinCodeChangeDto +from generated.immich.openapi_client.models.pin_code_reset_dto import PinCodeResetDto +from generated.immich.openapi_client.models.pin_code_setup_dto import PinCodeSetupDto +from generated.immich.openapi_client.models.places_response_dto import PlacesResponseDto +from generated.immich.openapi_client.models.plugin_method_response_dto import PluginMethodResponseDto +from generated.immich.openapi_client.models.plugin_response_dto import PluginResponseDto +from generated.immich.openapi_client.models.plugin_template_response_dto import PluginTemplateResponseDto +from generated.immich.openapi_client.models.plugin_template_step_response_dto import PluginTemplateStepResponseDto +from generated.immich.openapi_client.models.purchase_response import PurchaseResponse +from generated.immich.openapi_client.models.purchase_update import PurchaseUpdate +from generated.immich.openapi_client.models.queue_command import QueueCommand +from generated.immich.openapi_client.models.queue_command_dto import QueueCommandDto +from generated.immich.openapi_client.models.queue_delete_dto import QueueDeleteDto +from generated.immich.openapi_client.models.queue_job_response_dto import QueueJobResponseDto +from generated.immich.openapi_client.models.queue_job_status import QueueJobStatus +from generated.immich.openapi_client.models.queue_name import QueueName +from generated.immich.openapi_client.models.queue_response_dto import QueueResponseDto +from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto +from generated.immich.openapi_client.models.queue_statistics_dto import QueueStatisticsDto +from generated.immich.openapi_client.models.queue_status_legacy_dto import QueueStatusLegacyDto +from generated.immich.openapi_client.models.queue_update_dto import QueueUpdateDto +from generated.immich.openapi_client.models.queues_response_legacy_dto import QueuesResponseLegacyDto +from generated.immich.openapi_client.models.random_search_dto import RandomSearchDto +from generated.immich.openapi_client.models.ratings_response import RatingsResponse +from generated.immich.openapi_client.models.ratings_update import RatingsUpdate +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.models.recently_added_response import RecentlyAddedResponse +from generated.immich.openapi_client.models.recently_added_update import RecentlyAddedUpdate +from generated.immich.openapi_client.models.release_channel import ReleaseChannel +from generated.immich.openapi_client.models.release_event_v1 import ReleaseEventV1 +from generated.immich.openapi_client.models.release_type import ReleaseType +from generated.immich.openapi_client.models.reverse_geocoding_state_response_dto import ReverseGeocodingStateResponseDto +from generated.immich.openapi_client.models.rotate_parameters import RotateParameters +from generated.immich.openapi_client.models.search_album_response_dto import SearchAlbumResponseDto +from generated.immich.openapi_client.models.search_asset_response_dto import SearchAssetResponseDto +from generated.immich.openapi_client.models.search_explore_item import SearchExploreItem +from generated.immich.openapi_client.models.search_explore_response_dto import SearchExploreResponseDto +from generated.immich.openapi_client.models.search_facet_count_response_dto import SearchFacetCountResponseDto +from generated.immich.openapi_client.models.search_facet_response_dto import SearchFacetResponseDto +from generated.immich.openapi_client.models.search_response_dto import SearchResponseDto +from generated.immich.openapi_client.models.search_statistics_response_dto import SearchStatisticsResponseDto +from generated.immich.openapi_client.models.search_suggestion_type import SearchSuggestionType +from generated.immich.openapi_client.models.server_about_response_dto import ServerAboutResponseDto +from generated.immich.openapi_client.models.server_apk_links_dto import ServerApkLinksDto +from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto +from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto +from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto +from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse +from generated.immich.openapi_client.models.server_stats_response_dto import ServerStatsResponseDto +from generated.immich.openapi_client.models.server_storage_response_dto import ServerStorageResponseDto +from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto +from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto +from generated.immich.openapi_client.models.session_create_dto import SessionCreateDto +from generated.immich.openapi_client.models.session_create_response_dto import SessionCreateResponseDto +from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto +from generated.immich.openapi_client.models.session_unlock_dto import SessionUnlockDto +from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto +from generated.immich.openapi_client.models.set_maintenance_mode_dto import SetMaintenanceModeDto +from generated.immich.openapi_client.models.shared_link_create_dto import SharedLinkCreateDto +from generated.immich.openapi_client.models.shared_link_edit_dto import SharedLinkEditDto +from generated.immich.openapi_client.models.shared_link_login_dto import SharedLinkLoginDto +from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto +from generated.immich.openapi_client.models.shared_link_type import SharedLinkType +from generated.immich.openapi_client.models.shared_links_response import SharedLinksResponse +from generated.immich.openapi_client.models.shared_links_update import SharedLinksUpdate +from generated.immich.openapi_client.models.sign_up_dto import SignUpDto +from generated.immich.openapi_client.models.smart_search_dto import SmartSearchDto +from generated.immich.openapi_client.models.source_type import SourceType +from generated.immich.openapi_client.models.stack_create_dto import StackCreateDto +from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto +from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto +from generated.immich.openapi_client.models.statistics_search_dto import StatisticsSearchDto +from generated.immich.openapi_client.models.storage_folder import StorageFolder +from generated.immich.openapi_client.models.sync_ack_delete_dto import SyncAckDeleteDto +from generated.immich.openapi_client.models.sync_ack_dto import SyncAckDto +from generated.immich.openapi_client.models.sync_ack_set_dto import SyncAckSetDto +from generated.immich.openapi_client.models.sync_album_delete_v1 import SyncAlbumDeleteV1 +from generated.immich.openapi_client.models.sync_album_to_asset_delete_v1 import SyncAlbumToAssetDeleteV1 +from generated.immich.openapi_client.models.sync_album_to_asset_v1 import SyncAlbumToAssetV1 +from generated.immich.openapi_client.models.sync_album_user_delete_v1 import SyncAlbumUserDeleteV1 +from generated.immich.openapi_client.models.sync_album_user_v1 import SyncAlbumUserV1 +from generated.immich.openapi_client.models.sync_album_v1 import SyncAlbumV1 +from generated.immich.openapi_client.models.sync_album_v2 import SyncAlbumV2 +from generated.immich.openapi_client.models.sync_asset_delete_v1 import SyncAssetDeleteV1 +from generated.immich.openapi_client.models.sync_asset_edit_delete_v1 import SyncAssetEditDeleteV1 +from generated.immich.openapi_client.models.sync_asset_edit_v1 import SyncAssetEditV1 +from generated.immich.openapi_client.models.sync_asset_exif_v1 import SyncAssetExifV1 +from generated.immich.openapi_client.models.sync_asset_face_delete_v1 import SyncAssetFaceDeleteV1 +from generated.immich.openapi_client.models.sync_asset_face_v1 import SyncAssetFaceV1 +from generated.immich.openapi_client.models.sync_asset_face_v2 import SyncAssetFaceV2 +from generated.immich.openapi_client.models.sync_asset_metadata_delete_v1 import SyncAssetMetadataDeleteV1 +from generated.immich.openapi_client.models.sync_asset_metadata_v1 import SyncAssetMetadataV1 +from generated.immich.openapi_client.models.sync_asset_ocr_delete_v1 import SyncAssetOcrDeleteV1 +from generated.immich.openapi_client.models.sync_asset_ocr_v1 import SyncAssetOcrV1 +from generated.immich.openapi_client.models.sync_asset_v1 import SyncAssetV1 +from generated.immich.openapi_client.models.sync_asset_v2 import SyncAssetV2 +from generated.immich.openapi_client.models.sync_auth_user_v1 import SyncAuthUserV1 +from generated.immich.openapi_client.models.sync_entity_type import SyncEntityType +from generated.immich.openapi_client.models.sync_memory_asset_delete_v1 import SyncMemoryAssetDeleteV1 +from generated.immich.openapi_client.models.sync_memory_asset_v1 import SyncMemoryAssetV1 +from generated.immich.openapi_client.models.sync_memory_delete_v1 import SyncMemoryDeleteV1 +from generated.immich.openapi_client.models.sync_memory_v1 import SyncMemoryV1 +from generated.immich.openapi_client.models.sync_partner_delete_v1 import SyncPartnerDeleteV1 +from generated.immich.openapi_client.models.sync_partner_v1 import SyncPartnerV1 +from generated.immich.openapi_client.models.sync_person_delete_v1 import SyncPersonDeleteV1 +from generated.immich.openapi_client.models.sync_person_v1 import SyncPersonV1 +from generated.immich.openapi_client.models.sync_request_type import SyncRequestType +from generated.immich.openapi_client.models.sync_stack_delete_v1 import SyncStackDeleteV1 +from generated.immich.openapi_client.models.sync_stack_v1 import SyncStackV1 +from generated.immich.openapi_client.models.sync_stream_dto import SyncStreamDto +from generated.immich.openapi_client.models.sync_user_delete_v1 import SyncUserDeleteV1 +from generated.immich.openapi_client.models.sync_user_metadata_delete_v1 import SyncUserMetadataDeleteV1 +from generated.immich.openapi_client.models.sync_user_metadata_v1 import SyncUserMetadataV1 +from generated.immich.openapi_client.models.sync_user_v1 import SyncUserV1 +from generated.immich.openapi_client.models.system_config_backups_dto import SystemConfigBackupsDto +from generated.immich.openapi_client.models.system_config_dto import SystemConfigDto +from generated.immich.openapi_client.models.system_config_f_fmpeg_dto import SystemConfigFFmpegDto +from generated.immich.openapi_client.models.system_config_f_fmpeg_realtime_dto import SystemConfigFFmpegRealtimeDto +from generated.immich.openapi_client.models.system_config_faces_dto import SystemConfigFacesDto +from generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto import SystemConfigGeneratedFullsizeImageDto +from generated.immich.openapi_client.models.system_config_generated_image_dto import SystemConfigGeneratedImageDto +from generated.immich.openapi_client.models.system_config_image_dto import SystemConfigImageDto +from generated.immich.openapi_client.models.system_config_integrity_checks import SystemConfigIntegrityChecks +from generated.immich.openapi_client.models.system_config_integrity_checksum_job import SystemConfigIntegrityChecksumJob +from generated.immich.openapi_client.models.system_config_integrity_job import SystemConfigIntegrityJob +from generated.immich.openapi_client.models.system_config_job_dto import SystemConfigJobDto +from generated.immich.openapi_client.models.system_config_library_dto import SystemConfigLibraryDto +from generated.immich.openapi_client.models.system_config_library_scan_dto import SystemConfigLibraryScanDto +from generated.immich.openapi_client.models.system_config_library_watch_dto import SystemConfigLibraryWatchDto +from generated.immich.openapi_client.models.system_config_logging_dto import SystemConfigLoggingDto +from generated.immich.openapi_client.models.system_config_machine_learning_dto import SystemConfigMachineLearningDto +from generated.immich.openapi_client.models.system_config_map_dto import SystemConfigMapDto +from generated.immich.openapi_client.models.system_config_metadata_dto import SystemConfigMetadataDto +from generated.immich.openapi_client.models.system_config_new_version_check_dto import SystemConfigNewVersionCheckDto +from generated.immich.openapi_client.models.system_config_nightly_tasks_dto import SystemConfigNightlyTasksDto +from generated.immich.openapi_client.models.system_config_notifications_dto import SystemConfigNotificationsDto +from generated.immich.openapi_client.models.system_config_o_auth_dto import SystemConfigOAuthDto +from generated.immich.openapi_client.models.system_config_password_login_dto import SystemConfigPasswordLoginDto +from generated.immich.openapi_client.models.system_config_reverse_geocoding_dto import SystemConfigReverseGeocodingDto +from generated.immich.openapi_client.models.system_config_server_dto import SystemConfigServerDto +from generated.immich.openapi_client.models.system_config_smtp_dto import SystemConfigSmtpDto +from generated.immich.openapi_client.models.system_config_smtp_transport_dto import SystemConfigSmtpTransportDto +from generated.immich.openapi_client.models.system_config_storage_template_dto import SystemConfigStorageTemplateDto +from generated.immich.openapi_client.models.system_config_template_emails_dto import SystemConfigTemplateEmailsDto +from generated.immich.openapi_client.models.system_config_template_storage_option_dto import SystemConfigTemplateStorageOptionDto +from generated.immich.openapi_client.models.system_config_templates_dto import SystemConfigTemplatesDto +from generated.immich.openapi_client.models.system_config_theme_dto import SystemConfigThemeDto +from generated.immich.openapi_client.models.system_config_trash_dto import SystemConfigTrashDto +from generated.immich.openapi_client.models.system_config_user_dto import SystemConfigUserDto +from generated.immich.openapi_client.models.tag_bulk_assets_dto import TagBulkAssetsDto +from generated.immich.openapi_client.models.tag_bulk_assets_response_dto import TagBulkAssetsResponseDto +from generated.immich.openapi_client.models.tag_create_dto import TagCreateDto +from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto +from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto +from generated.immich.openapi_client.models.tag_upsert_dto import TagUpsertDto +from generated.immich.openapi_client.models.tags_response import TagsResponse +from generated.immich.openapi_client.models.tags_update import TagsUpdate +from generated.immich.openapi_client.models.template_dto import TemplateDto +from generated.immich.openapi_client.models.template_response_dto import TemplateResponseDto +from generated.immich.openapi_client.models.test_email_response_dto import TestEmailResponseDto +from generated.immich.openapi_client.models.time_bucket_asset_response_dto import TimeBucketAssetResponseDto +from generated.immich.openapi_client.models.time_buckets_response_dto import TimeBucketsResponseDto +from generated.immich.openapi_client.models.tone_mapping import ToneMapping +from generated.immich.openapi_client.models.transcode_hw_accel import TranscodeHWAccel +from generated.immich.openapi_client.models.transcode_policy import TranscodePolicy +from generated.immich.openapi_client.models.trash_response_dto import TrashResponseDto +from generated.immich.openapi_client.models.update_album_dto import UpdateAlbumDto +from generated.immich.openapi_client.models.update_album_user_dto import UpdateAlbumUserDto +from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto +from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto +from generated.immich.openapi_client.models.usage_by_user_dto import UsageByUserDto +from generated.immich.openapi_client.models.user_admin_create_dto import UserAdminCreateDto +from generated.immich.openapi_client.models.user_admin_delete_dto import UserAdminDeleteDto +from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto +from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto +from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor +from generated.immich.openapi_client.models.user_license import UserLicense +from generated.immich.openapi_client.models.user_metadata_key import UserMetadataKey +from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto +from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto +from generated.immich.openapi_client.models.user_response_dto import UserResponseDto +from generated.immich.openapi_client.models.user_status import UserStatus +from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto +from generated.immich.openapi_client.models.validate_access_token_response_dto import ValidateAccessTokenResponseDto +from generated.immich.openapi_client.models.validate_library_dto import ValidateLibraryDto +from generated.immich.openapi_client.models.validate_library_import_path_response_dto import ValidateLibraryImportPathResponseDto +from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto +from generated.immich.openapi_client.models.version_check_state_response_dto import VersionCheckStateResponseDto +from generated.immich.openapi_client.models.video_codec import VideoCodec +from generated.immich.openapi_client.models.video_container import VideoContainer +from generated.immich.openapi_client.models.workflow_create_dto import WorkflowCreateDto +from generated.immich.openapi_client.models.workflow_response_dto import WorkflowResponseDto +from generated.immich.openapi_client.models.workflow_share_response_dto import WorkflowShareResponseDto +from generated.immich.openapi_client.models.workflow_share_step_dto import WorkflowShareStepDto +from generated.immich.openapi_client.models.workflow_step_dto import WorkflowStepDto +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from generated.immich.openapi_client.models.workflow_trigger_response_dto import WorkflowTriggerResponseDto +from generated.immich.openapi_client.models.workflow_type import WorkflowType +from generated.immich.openapi_client.models.workflow_update_dto import WorkflowUpdateDto diff --git a/generated/immich/openapi_client/api/__init__.py b/generated/immich/openapi_client/api/__init__.py index 0d54d4f..316c0cb 100644 --- a/generated/immich/openapi_client/api/__init__.py +++ b/generated/immich/openapi_client/api/__init__.py @@ -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 diff --git a/generated/immich/openapi_client/api/activities_api.py b/generated/immich/openapi_client/api/activities_api.py deleted file mode 100644 index 96e84a8..0000000 --- a/generated/immich/openapi_client/api/activities_api.py +++ /dev/null @@ -1,1191 +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 Field -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -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.models.activity_statistics_response_dto import ActivityStatisticsResponseDto -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.api_client import ApiClient, RequestSerialized -from generated.immich.openapi_client.api_response import ApiResponse -from generated.immich.openapi_client.rest import RESTResponseType - - -class ActivitiesApi: - """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_activity( - self, - activity_create_dto: ActivityCreateDto, - _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, - ) -> ActivityResponseDto: - """Create an activity - - Create a like or a comment for an album, or an asset in an album. - - :param activity_create_dto: (required) - :type activity_create_dto: ActivityCreateDto - :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_activity_serialize( - activity_create_dto=activity_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "ActivityResponseDto", - } - 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_activity_with_http_info( - self, - activity_create_dto: ActivityCreateDto, - _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[ActivityResponseDto]: - """Create an activity - - Create a like or a comment for an album, or an asset in an album. - - :param activity_create_dto: (required) - :type activity_create_dto: ActivityCreateDto - :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_activity_serialize( - activity_create_dto=activity_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "ActivityResponseDto", - } - 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_activity_without_preload_content( - self, - activity_create_dto: ActivityCreateDto, - _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 an activity - - Create a like or a comment for an album, or an asset in an album. - - :param activity_create_dto: (required) - :type activity_create_dto: ActivityCreateDto - :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_activity_serialize( - activity_create_dto=activity_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "ActivityResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_activity_serialize( - self, - activity_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 activity_create_dto is not None: - _body_params = activity_create_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='/activities', - 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 delete_activity( - self, - id: UUID, - _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: - """Delete an activity - - Removes a like or comment from a given album or asset in an album. - - :param id: (required) - :type id: UUID - :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._delete_activity_serialize( - id=id, - _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 delete_activity_with_http_info( - self, - id: UUID, - _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]: - """Delete an activity - - Removes a like or comment from a given album or asset in an album. - - :param id: (required) - :type id: UUID - :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._delete_activity_serialize( - id=id, - _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 delete_activity_without_preload_content( - self, - id: UUID, - _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: - """Delete an activity - - Removes a like or comment from a given album or asset in an album. - - :param id: (required) - :type id: UUID - :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._delete_activity_serialize( - id=id, - _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 _delete_activity_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/activities/{id}', - 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_activities( - self, - album_id: Annotated[UUID, Field(description="Album ID")], - asset_id: Annotated[Optional[UUID], Field(description="Asset ID (if activity is for an asset)")] = None, - level: Optional[ReactionLevel] = None, - type: Optional[ReactionType] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter by user ID")] = 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[ActivityResponseDto]: - """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. - - :param album_id: Album ID (required) - :type album_id: UUID - :param asset_id: Asset ID (if activity is for an asset) - :type asset_id: UUID - :param level: - :type level: ReactionLevel - :param type: - :type type: ReactionType - :param user_id: Filter by user ID - :type user_id: UUID - :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_activities_serialize( - album_id=album_id, - asset_id=asset_id, - level=level, - type=type, - user_id=user_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ActivityResponseDto]", - } - 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_activities_with_http_info( - self, - album_id: Annotated[UUID, Field(description="Album ID")], - asset_id: Annotated[Optional[UUID], Field(description="Asset ID (if activity is for an asset)")] = None, - level: Optional[ReactionLevel] = None, - type: Optional[ReactionType] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter by user ID")] = 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[ActivityResponseDto]]: - """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. - - :param album_id: Album ID (required) - :type album_id: UUID - :param asset_id: Asset ID (if activity is for an asset) - :type asset_id: UUID - :param level: - :type level: ReactionLevel - :param type: - :type type: ReactionType - :param user_id: Filter by user ID - :type user_id: UUID - :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_activities_serialize( - album_id=album_id, - asset_id=asset_id, - level=level, - type=type, - user_id=user_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ActivityResponseDto]", - } - 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_activities_without_preload_content( - self, - album_id: Annotated[UUID, Field(description="Album ID")], - asset_id: Annotated[Optional[UUID], Field(description="Asset ID (if activity is for an asset)")] = None, - level: Optional[ReactionLevel] = None, - type: Optional[ReactionType] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter by user ID")] = 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: - """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. - - :param album_id: Album ID (required) - :type album_id: UUID - :param asset_id: Asset ID (if activity is for an asset) - :type asset_id: UUID - :param level: - :type level: ReactionLevel - :param type: - :type type: ReactionType - :param user_id: Filter by user ID - :type user_id: UUID - :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_activities_serialize( - album_id=album_id, - asset_id=asset_id, - level=level, - type=type, - user_id=user_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ActivityResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_activities_serialize( - self, - album_id, - asset_id, - level, - type, - user_id, - _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 album_id is not None: - - _query_params.append(('albumId', album_id)) - - if asset_id is not None: - - _query_params.append(('assetId', asset_id)) - - if level is not None: - - _query_params.append(('level', level.value)) - - if type is not None: - - _query_params.append(('type', type.value)) - - if user_id is not None: - - _query_params.append(('userId', user_id)) - - # 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='/activities', - 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_activity_statistics( - self, - album_id: Annotated[UUID, Field(description="Album ID")], - asset_id: Annotated[Optional[UUID], Field(description="Asset ID (if activity is for an asset)")] = 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, - ) -> ActivityStatisticsResponseDto: - """Retrieve activity statistics - - Returns the number of likes and comments for a given album or asset in an album. - - :param album_id: Album ID (required) - :type album_id: UUID - :param asset_id: Asset ID (if activity is for an asset) - :type asset_id: UUID - :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_activity_statistics_serialize( - album_id=album_id, - asset_id=asset_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ActivityStatisticsResponseDto", - } - 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_activity_statistics_with_http_info( - self, - album_id: Annotated[UUID, Field(description="Album ID")], - asset_id: Annotated[Optional[UUID], Field(description="Asset ID (if activity is for an asset)")] = 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[ActivityStatisticsResponseDto]: - """Retrieve activity statistics - - Returns the number of likes and comments for a given album or asset in an album. - - :param album_id: Album ID (required) - :type album_id: UUID - :param asset_id: Asset ID (if activity is for an asset) - :type asset_id: UUID - :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_activity_statistics_serialize( - album_id=album_id, - asset_id=asset_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ActivityStatisticsResponseDto", - } - 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_activity_statistics_without_preload_content( - self, - album_id: Annotated[UUID, Field(description="Album ID")], - asset_id: Annotated[Optional[UUID], Field(description="Asset ID (if activity is for an asset)")] = 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 activity statistics - - Returns the number of likes and comments for a given album or asset in an album. - - :param album_id: Album ID (required) - :type album_id: UUID - :param asset_id: Asset ID (if activity is for an asset) - :type asset_id: UUID - :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_activity_statistics_serialize( - album_id=album_id, - asset_id=asset_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ActivityStatisticsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_activity_statistics_serialize( - self, - album_id, - asset_id, - _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 album_id is not None: - - _query_params.append(('albumId', album_id)) - - if asset_id is not None: - - _query_params.append(('assetId', asset_id)) - - # 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='/activities/statistics', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/albums_api.py b/generated/immich/openapi_client/api/albums_api.py index 5716a2e..545d902 100644 --- a/generated/immich/openapi_client/api/albums_api.py +++ b/generated/immich/openapi_client/api/albums_api.py @@ -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) diff --git a/generated/immich/openapi_client/api/api_keys_api.py b/generated/immich/openapi_client/api/api_keys_api.py deleted file mode 100644 index a57029c..0000000 --- a/generated/immich/openapi_client/api/api_keys_api.py +++ /dev/null @@ -1,1626 +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 typing import List -from uuid import UUID -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.models.api_key_response_dto import ApiKeyResponseDto -from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto - -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 APIKeysApi: - """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_api_key( - self, - api_key_create_dto: ApiKeyCreateDto, - _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, - ) -> ApiKeyCreateResponseDto: - """Create an API key - - Creates a new API key. It will be limited to the permissions specified. - - :param api_key_create_dto: (required) - :type api_key_create_dto: ApiKeyCreateDto - :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_api_key_serialize( - api_key_create_dto=api_key_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "ApiKeyCreateResponseDto", - } - 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_api_key_with_http_info( - self, - api_key_create_dto: ApiKeyCreateDto, - _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[ApiKeyCreateResponseDto]: - """Create an API key - - Creates a new API key. It will be limited to the permissions specified. - - :param api_key_create_dto: (required) - :type api_key_create_dto: ApiKeyCreateDto - :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_api_key_serialize( - api_key_create_dto=api_key_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "ApiKeyCreateResponseDto", - } - 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_api_key_without_preload_content( - self, - api_key_create_dto: ApiKeyCreateDto, - _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 an API key - - Creates a new API key. It will be limited to the permissions specified. - - :param api_key_create_dto: (required) - :type api_key_create_dto: ApiKeyCreateDto - :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_api_key_serialize( - api_key_create_dto=api_key_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "ApiKeyCreateResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_api_key_serialize( - self, - api_key_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 api_key_create_dto is not None: - _body_params = api_key_create_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='/api-keys', - 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 delete_api_key( - self, - id: UUID, - _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: - """Delete an API key - - Deletes an API key identified by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :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._delete_api_key_serialize( - id=id, - _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 delete_api_key_with_http_info( - self, - id: UUID, - _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]: - """Delete an API key - - Deletes an API key identified by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :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._delete_api_key_serialize( - id=id, - _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 delete_api_key_without_preload_content( - self, - id: UUID, - _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: - """Delete an API key - - Deletes an API key identified by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :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._delete_api_key_serialize( - id=id, - _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 _delete_api_key_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/api-keys/{id}', - 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_api_key( - self, - id: UUID, - _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, - ) -> ApiKeyResponseDto: - """Retrieve an API key - - Retrieve an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :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_api_key_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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_api_key_with_http_info( - self, - id: UUID, - _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[ApiKeyResponseDto]: - """Retrieve an API key - - Retrieve an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :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_api_key_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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_api_key_without_preload_content( - self, - id: UUID, - _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 an API key - - Retrieve an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :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_api_key_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_api_key_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/api-keys/{id}', - 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_api_keys( - 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, - ) -> List[ApiKeyResponseDto]: - """List all API keys - - Retrieve all API keys of the current user. - - :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_api_keys_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ApiKeyResponseDto]", - } - 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_api_keys_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[List[ApiKeyResponseDto]]: - """List all API keys - - Retrieve all API keys of the current user. - - :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_api_keys_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ApiKeyResponseDto]", - } - 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_api_keys_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: - """List all API keys - - Retrieve all API keys of the current user. - - :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_api_keys_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ApiKeyResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_api_keys_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='/api-keys', - 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_my_api_key( - 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, - ) -> ApiKeyResponseDto: - """Retrieve the current API key - - Retrieve the API key that is used to access this endpoint. - - :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_my_api_key_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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_my_api_key_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[ApiKeyResponseDto]: - """Retrieve the current API key - - Retrieve the API key that is used to access this endpoint. - - :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_my_api_key_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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_my_api_key_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: - """Retrieve the current API key - - Retrieve the API key that is used to access this endpoint. - - :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_my_api_key_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_my_api_key_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='/api-keys/me', - 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 update_api_key( - self, - id: UUID, - api_key_update_dto: ApiKeyUpdateDto, - _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, - ) -> ApiKeyResponseDto: - """(Deprecated) Update an API key - - Updates the name and permissions of an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :param api_key_update_dto: (required) - :type api_key_update_dto: ApiKeyUpdateDto - :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 /api-keys/{id} is deprecated.", DeprecationWarning) - - _param = self._update_api_key_serialize( - id=id, - api_key_update_dto=api_key_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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 update_api_key_with_http_info( - self, - id: UUID, - api_key_update_dto: ApiKeyUpdateDto, - _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[ApiKeyResponseDto]: - """(Deprecated) Update an API key - - Updates the name and permissions of an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :param api_key_update_dto: (required) - :type api_key_update_dto: ApiKeyUpdateDto - :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 /api-keys/{id} is deprecated.", DeprecationWarning) - - _param = self._update_api_key_serialize( - id=id, - api_key_update_dto=api_key_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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 update_api_key_without_preload_content( - self, - id: UUID, - api_key_update_dto: ApiKeyUpdateDto, - _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) Update an API key - - Updates the name and permissions of an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :param api_key_update_dto: (required) - :type api_key_update_dto: ApiKeyUpdateDto - :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 /api-keys/{id} is deprecated.", DeprecationWarning) - - _param = self._update_api_key_serialize( - id=id, - api_key_update_dto=api_key_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_api_key_serialize( - self, - id, - api_key_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if api_key_update_dto is not None: - _body_params = api_key_update_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='/api-keys/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/assets_api.py b/generated/immich/openapi_client/api/assets_api.py index 48c106a..4147ffa 100644 --- a/generated/immich/openapi_client/api/assets_api.py +++ b/generated/immich/openapi_client/api/assets_api.py @@ -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: diff --git a/generated/immich/openapi_client/api/authentication_api.py b/generated/immich/openapi_client/api/authentication_api.py deleted file mode 100644 index f4ca8c2..0000000 --- a/generated/immich/openapi_client/api/authentication_api.py +++ /dev/null @@ -1,4509 +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 Field, StrictStr -from typing_extensions import Annotated -from generated.immich.openapi_client.models.auth_status_response_dto import AuthStatusResponseDto -from generated.immich.openapi_client.models.change_password_dto import ChangePasswordDto -from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto -from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto -from generated.immich.openapi_client.models.logout_response_dto import LogoutResponseDto -from generated.immich.openapi_client.models.o_auth_authorize_response_dto import OAuthAuthorizeResponseDto -from generated.immich.openapi_client.models.o_auth_callback_dto import OAuthCallbackDto -from generated.immich.openapi_client.models.o_auth_config_dto import OAuthConfigDto -from generated.immich.openapi_client.models.pin_code_change_dto import PinCodeChangeDto -from generated.immich.openapi_client.models.pin_code_reset_dto import PinCodeResetDto -from generated.immich.openapi_client.models.pin_code_setup_dto import PinCodeSetupDto -from generated.immich.openapi_client.models.session_unlock_dto import SessionUnlockDto -from generated.immich.openapi_client.models.sign_up_dto import SignUpDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.validate_access_token_response_dto import ValidateAccessTokenResponseDto - -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 AuthenticationApi: - """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 change_password( - self, - change_password_dto: ChangePasswordDto, - _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, - ) -> UserAdminResponseDto: - """Change password - - Change the password of the current user. - - :param change_password_dto: (required) - :type change_password_dto: ChangePasswordDto - :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._change_password_serialize( - change_password_dto=change_password_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 change_password_with_http_info( - self, - change_password_dto: ChangePasswordDto, - _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[UserAdminResponseDto]: - """Change password - - Change the password of the current user. - - :param change_password_dto: (required) - :type change_password_dto: ChangePasswordDto - :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._change_password_serialize( - change_password_dto=change_password_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 change_password_without_preload_content( - self, - change_password_dto: ChangePasswordDto, - _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: - """Change password - - Change the password of the current user. - - :param change_password_dto: (required) - :type change_password_dto: ChangePasswordDto - :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._change_password_serialize( - change_password_dto=change_password_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _change_password_serialize( - self, - change_password_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 change_password_dto is not None: - _body_params = change_password_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='/auth/change-password', - 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 change_pin_code( - self, - pin_code_change_dto: PinCodeChangeDto, - _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: - """Change pin code - - Change the pin code for the current user. - - :param pin_code_change_dto: (required) - :type pin_code_change_dto: PinCodeChangeDto - :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._change_pin_code_serialize( - pin_code_change_dto=pin_code_change_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 change_pin_code_with_http_info( - self, - pin_code_change_dto: PinCodeChangeDto, - _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]: - """Change pin code - - Change the pin code for the current user. - - :param pin_code_change_dto: (required) - :type pin_code_change_dto: PinCodeChangeDto - :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._change_pin_code_serialize( - pin_code_change_dto=pin_code_change_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 change_pin_code_without_preload_content( - self, - pin_code_change_dto: PinCodeChangeDto, - _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: - """Change pin code - - Change the pin code for the current user. - - :param pin_code_change_dto: (required) - :type pin_code_change_dto: PinCodeChangeDto - :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._change_pin_code_serialize( - pin_code_change_dto=pin_code_change_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 _change_pin_code_serialize( - self, - pin_code_change_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 pin_code_change_dto is not None: - _body_params = pin_code_change_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='PUT', - resource_path='/auth/pin-code', - 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 finish_o_auth( - self, - o_auth_callback_dto: OAuthCallbackDto, - _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, - ) -> LoginResponseDto: - """Finish OAuth - - Complete the OAuth authorization process by exchanging the authorization code for a session token. - - :param o_auth_callback_dto: (required) - :type o_auth_callback_dto: OAuthCallbackDto - :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._finish_o_auth_serialize( - o_auth_callback_dto=o_auth_callback_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LoginResponseDto", - } - 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 finish_o_auth_with_http_info( - self, - o_auth_callback_dto: OAuthCallbackDto, - _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[LoginResponseDto]: - """Finish OAuth - - Complete the OAuth authorization process by exchanging the authorization code for a session token. - - :param o_auth_callback_dto: (required) - :type o_auth_callback_dto: OAuthCallbackDto - :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._finish_o_auth_serialize( - o_auth_callback_dto=o_auth_callback_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LoginResponseDto", - } - 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 finish_o_auth_without_preload_content( - self, - o_auth_callback_dto: OAuthCallbackDto, - _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: - """Finish OAuth - - Complete the OAuth authorization process by exchanging the authorization code for a session token. - - :param o_auth_callback_dto: (required) - :type o_auth_callback_dto: OAuthCallbackDto - :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._finish_o_auth_serialize( - o_auth_callback_dto=o_auth_callback_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LoginResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _finish_o_auth_serialize( - self, - o_auth_callback_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 o_auth_callback_dto is not None: - _body_params = o_auth_callback_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] = [ - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/oauth/callback', - 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_auth_status( - 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, - ) -> AuthStatusResponseDto: - """Retrieve auth status - - Get information about the current session, including whether the user has a password, and if the session can access locked assets. - - :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_auth_status_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AuthStatusResponseDto", - } - 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_auth_status_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[AuthStatusResponseDto]: - """Retrieve auth status - - Get information about the current session, including whether the user has a password, and if the session can access locked assets. - - :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_auth_status_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AuthStatusResponseDto", - } - 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_auth_status_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: - """Retrieve auth status - - Get information about the current session, including whether the user has a password, and if the session can access locked assets. - - :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_auth_status_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AuthStatusResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_auth_status_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='/auth/status', - 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 link_o_auth_account( - self, - o_auth_callback_dto: OAuthCallbackDto, - _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, - ) -> UserAdminResponseDto: - """Link OAuth account - - Link an OAuth account to the authenticated user. - - :param o_auth_callback_dto: (required) - :type o_auth_callback_dto: OAuthCallbackDto - :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._link_o_auth_account_serialize( - o_auth_callback_dto=o_auth_callback_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 link_o_auth_account_with_http_info( - self, - o_auth_callback_dto: OAuthCallbackDto, - _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[UserAdminResponseDto]: - """Link OAuth account - - Link an OAuth account to the authenticated user. - - :param o_auth_callback_dto: (required) - :type o_auth_callback_dto: OAuthCallbackDto - :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._link_o_auth_account_serialize( - o_auth_callback_dto=o_auth_callback_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 link_o_auth_account_without_preload_content( - self, - o_auth_callback_dto: OAuthCallbackDto, - _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: - """Link OAuth account - - Link an OAuth account to the authenticated user. - - :param o_auth_callback_dto: (required) - :type o_auth_callback_dto: OAuthCallbackDto - :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._link_o_auth_account_serialize( - o_auth_callback_dto=o_auth_callback_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _link_o_auth_account_serialize( - self, - o_auth_callback_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 o_auth_callback_dto is not None: - _body_params = o_auth_callback_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='/oauth/link', - 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 lock_auth_session( - 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, - ) -> None: - """Lock auth session - - Remove elevated access to locked assets from the current session. - - :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._lock_auth_session_serialize( - _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 lock_auth_session_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[None]: - """Lock auth session - - Remove elevated access to locked assets from the current session. - - :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._lock_auth_session_serialize( - _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 lock_auth_session_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: - """Lock auth session - - Remove elevated access to locked assets from the current session. - - :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._lock_auth_session_serialize( - _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 _lock_auth_session_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/auth/session/lock', - 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 login( - self, - login_credential_dto: LoginCredentialDto, - _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, - ) -> LoginResponseDto: - """Login - - Login with username and password and receive a session token. - - :param login_credential_dto: (required) - :type login_credential_dto: LoginCredentialDto - :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._login_serialize( - login_credential_dto=login_credential_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LoginResponseDto", - } - 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 login_with_http_info( - self, - login_credential_dto: LoginCredentialDto, - _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[LoginResponseDto]: - """Login - - Login with username and password and receive a session token. - - :param login_credential_dto: (required) - :type login_credential_dto: LoginCredentialDto - :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._login_serialize( - login_credential_dto=login_credential_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LoginResponseDto", - } - 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 login_without_preload_content( - self, - login_credential_dto: LoginCredentialDto, - _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: - """Login - - Login with username and password and receive a session token. - - :param login_credential_dto: (required) - :type login_credential_dto: LoginCredentialDto - :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._login_serialize( - login_credential_dto=login_credential_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LoginResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _login_serialize( - self, - login_credential_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 login_credential_dto is not None: - _body_params = login_credential_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] = [ - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/auth/login', - 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 logout( - 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, - ) -> LogoutResponseDto: - """Logout - - Logout the current user and invalidate the session token. - - :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._logout_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LogoutResponseDto", - } - 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 logout_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[LogoutResponseDto]: - """Logout - - Logout the current user and invalidate the session token. - - :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._logout_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LogoutResponseDto", - } - 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 logout_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: - """Logout - - Logout the current user and invalidate the session token. - - :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._logout_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LogoutResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _logout_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='/auth/logout', - 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 logout_o_auth( - self, - logout_token: Annotated[StrictStr, Field(description="OAuth logout token")], - _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: - """Backchannel OAuth logout - - Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present. - - :param logout_token: OAuth logout token (required) - :type logout_token: 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._logout_o_auth_serialize( - logout_token=logout_token, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': 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 logout_o_auth_with_http_info( - self, - logout_token: Annotated[StrictStr, Field(description="OAuth logout token")], - _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]: - """Backchannel OAuth logout - - Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present. - - :param logout_token: OAuth logout token (required) - :type logout_token: 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._logout_o_auth_serialize( - logout_token=logout_token, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': 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 logout_o_auth_without_preload_content( - self, - logout_token: Annotated[StrictStr, Field(description="OAuth logout token")], - _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: - """Backchannel OAuth logout - - Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present. - - :param logout_token: OAuth logout token (required) - :type logout_token: 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._logout_o_auth_serialize( - logout_token=logout_token, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _logout_o_auth_serialize( - self, - logout_token, - _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 - if logout_token is not None: - _form_params.append(('logout_token', logout_token)) - # process the body parameter - - - - # 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/x-www-form-urlencoded' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/oauth/backchannel-logout', - 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 redirect_o_auth_to_mobile( - 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, - ) -> None: - """Redirect OAuth to mobile - - Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting. - - :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._redirect_o_auth_to_mobile_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': 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 redirect_o_auth_to_mobile_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[None]: - """Redirect OAuth to mobile - - Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting. - - :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._redirect_o_auth_to_mobile_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': 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 redirect_o_auth_to_mobile_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: - """Redirect OAuth to mobile - - Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting. - - :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._redirect_o_auth_to_mobile_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _redirect_o_auth_to_mobile_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/oauth/mobile-redirect', - 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 reset_pin_code( - self, - pin_code_reset_dto: PinCodeResetDto, - _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: - """Reset pin code - - Reset the pin code for the current user by providing the account password - - :param pin_code_reset_dto: (required) - :type pin_code_reset_dto: PinCodeResetDto - :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._reset_pin_code_serialize( - pin_code_reset_dto=pin_code_reset_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 reset_pin_code_with_http_info( - self, - pin_code_reset_dto: PinCodeResetDto, - _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]: - """Reset pin code - - Reset the pin code for the current user by providing the account password - - :param pin_code_reset_dto: (required) - :type pin_code_reset_dto: PinCodeResetDto - :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._reset_pin_code_serialize( - pin_code_reset_dto=pin_code_reset_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 reset_pin_code_without_preload_content( - self, - pin_code_reset_dto: PinCodeResetDto, - _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: - """Reset pin code - - Reset the pin code for the current user by providing the account password - - :param pin_code_reset_dto: (required) - :type pin_code_reset_dto: PinCodeResetDto - :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._reset_pin_code_serialize( - pin_code_reset_dto=pin_code_reset_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 _reset_pin_code_serialize( - self, - pin_code_reset_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 pin_code_reset_dto is not None: - _body_params = pin_code_reset_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='DELETE', - resource_path='/auth/pin-code', - 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 setup_pin_code( - self, - pin_code_setup_dto: PinCodeSetupDto, - _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: - """Setup pin code - - Setup a new pin code for the current user. - - :param pin_code_setup_dto: (required) - :type pin_code_setup_dto: PinCodeSetupDto - :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._setup_pin_code_serialize( - pin_code_setup_dto=pin_code_setup_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 setup_pin_code_with_http_info( - self, - pin_code_setup_dto: PinCodeSetupDto, - _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]: - """Setup pin code - - Setup a new pin code for the current user. - - :param pin_code_setup_dto: (required) - :type pin_code_setup_dto: PinCodeSetupDto - :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._setup_pin_code_serialize( - pin_code_setup_dto=pin_code_setup_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 setup_pin_code_without_preload_content( - self, - pin_code_setup_dto: PinCodeSetupDto, - _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: - """Setup pin code - - Setup a new pin code for the current user. - - :param pin_code_setup_dto: (required) - :type pin_code_setup_dto: PinCodeSetupDto - :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._setup_pin_code_serialize( - pin_code_setup_dto=pin_code_setup_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 _setup_pin_code_serialize( - self, - pin_code_setup_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 pin_code_setup_dto is not None: - _body_params = pin_code_setup_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='/auth/pin-code', - 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 sign_up_admin( - self, - sign_up_dto: SignUpDto, - _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, - ) -> UserAdminResponseDto: - """Register admin - - Create the first admin user in the system. - - :param sign_up_dto: (required) - :type sign_up_dto: SignUpDto - :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._sign_up_admin_serialize( - sign_up_dto=sign_up_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "UserAdminResponseDto", - } - 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 sign_up_admin_with_http_info( - self, - sign_up_dto: SignUpDto, - _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[UserAdminResponseDto]: - """Register admin - - Create the first admin user in the system. - - :param sign_up_dto: (required) - :type sign_up_dto: SignUpDto - :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._sign_up_admin_serialize( - sign_up_dto=sign_up_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "UserAdminResponseDto", - } - 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 sign_up_admin_without_preload_content( - self, - sign_up_dto: SignUpDto, - _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: - """Register admin - - Create the first admin user in the system. - - :param sign_up_dto: (required) - :type sign_up_dto: SignUpDto - :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._sign_up_admin_serialize( - sign_up_dto=sign_up_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _sign_up_admin_serialize( - self, - sign_up_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 sign_up_dto is not None: - _body_params = sign_up_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] = [ - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/auth/admin-sign-up', - 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 start_o_auth( - self, - o_auth_config_dto: OAuthConfigDto, - _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, - ) -> OAuthAuthorizeResponseDto: - """Start OAuth - - Initiate the OAuth authorization process. - - :param o_auth_config_dto: (required) - :type o_auth_config_dto: OAuthConfigDto - :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._start_o_auth_serialize( - o_auth_config_dto=o_auth_config_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "OAuthAuthorizeResponseDto", - } - 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 start_o_auth_with_http_info( - self, - o_auth_config_dto: OAuthConfigDto, - _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[OAuthAuthorizeResponseDto]: - """Start OAuth - - Initiate the OAuth authorization process. - - :param o_auth_config_dto: (required) - :type o_auth_config_dto: OAuthConfigDto - :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._start_o_auth_serialize( - o_auth_config_dto=o_auth_config_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "OAuthAuthorizeResponseDto", - } - 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 start_o_auth_without_preload_content( - self, - o_auth_config_dto: OAuthConfigDto, - _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: - """Start OAuth - - Initiate the OAuth authorization process. - - :param o_auth_config_dto: (required) - :type o_auth_config_dto: OAuthConfigDto - :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._start_o_auth_serialize( - o_auth_config_dto=o_auth_config_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "OAuthAuthorizeResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _start_o_auth_serialize( - self, - o_auth_config_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 o_auth_config_dto is not None: - _body_params = o_auth_config_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] = [ - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/oauth/authorize', - 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 unlink_o_auth_account( - 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, - ) -> UserAdminResponseDto: - """Unlink OAuth account - - Unlink the OAuth account from the authenticated user. - - :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._unlink_o_auth_account_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 unlink_o_auth_account_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[UserAdminResponseDto]: - """Unlink OAuth account - - Unlink the OAuth account from the authenticated user. - - :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._unlink_o_auth_account_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 unlink_o_auth_account_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: - """Unlink OAuth account - - Unlink the OAuth account from the authenticated user. - - :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._unlink_o_auth_account_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _unlink_o_auth_account_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='/oauth/unlink', - 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 unlock_auth_session( - self, - session_unlock_dto: SessionUnlockDto, - _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: - """Unlock auth session - - Temporarily grant the session elevated access to locked assets by providing the correct PIN code. - - :param session_unlock_dto: (required) - :type session_unlock_dto: SessionUnlockDto - :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._unlock_auth_session_serialize( - session_unlock_dto=session_unlock_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 unlock_auth_session_with_http_info( - self, - session_unlock_dto: SessionUnlockDto, - _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]: - """Unlock auth session - - Temporarily grant the session elevated access to locked assets by providing the correct PIN code. - - :param session_unlock_dto: (required) - :type session_unlock_dto: SessionUnlockDto - :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._unlock_auth_session_serialize( - session_unlock_dto=session_unlock_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 unlock_auth_session_without_preload_content( - self, - session_unlock_dto: SessionUnlockDto, - _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: - """Unlock auth session - - Temporarily grant the session elevated access to locked assets by providing the correct PIN code. - - :param session_unlock_dto: (required) - :type session_unlock_dto: SessionUnlockDto - :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._unlock_auth_session_serialize( - session_unlock_dto=session_unlock_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 _unlock_auth_session_serialize( - self, - session_unlock_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 session_unlock_dto is not None: - _body_params = session_unlock_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='/auth/session/unlock', - 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 validate_access_token( - 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, - ) -> ValidateAccessTokenResponseDto: - """Validate access token - - Validate the current authorization method is still valid. - - :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._validate_access_token_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ValidateAccessTokenResponseDto", - } - 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 validate_access_token_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[ValidateAccessTokenResponseDto]: - """Validate access token - - Validate the current authorization method is still valid. - - :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._validate_access_token_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ValidateAccessTokenResponseDto", - } - 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 validate_access_token_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: - """Validate access token - - Validate the current authorization method is still valid. - - :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._validate_access_token_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ValidateAccessTokenResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _validate_access_token_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='/auth/validateToken', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/deprecated_api.py b/generated/immich/openapi_client/api/deprecated_api.py deleted file mode 100644 index a6fa866..0000000 --- a/generated/immich/openapi_client/api/deprecated_api.py +++ /dev/null @@ -1,4940 +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 uuid import UUID -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.models.asset_bulk_update_dto import AssetBulkUpdateDto -from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto -from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto -from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto -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.models.session_response_dto import SessionResponseDto -from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto -from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto -from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto -from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto -from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto -from generated.immich.openapi_client.models.workflow_response_dto import WorkflowResponseDto -from generated.immich.openapi_client.models.workflow_update_dto import WorkflowUpdateDto - -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 DeprecatedApi: - """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_partner_deprecated( - self, - id: UUID, - _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, - ) -> PartnerResponseDto: - """(Deprecated) Create a partner - - Create a new partner to share assets with. - - :param id: (required) - :type id: UUID - :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("POST /partners/{id} is deprecated.", DeprecationWarning) - - _param = self._create_partner_deprecated_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - 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_partner_deprecated_with_http_info( - self, - id: UUID, - _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[PartnerResponseDto]: - """(Deprecated) Create a partner - - Create a new partner to share assets with. - - :param id: (required) - :type id: UUID - :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("POST /partners/{id} is deprecated.", DeprecationWarning) - - _param = self._create_partner_deprecated_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - 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_partner_deprecated_without_preload_content( - self, - id: UUID, - _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) Create a partner - - Create a new partner to share assets with. - - :param id: (required) - :type id: UUID - :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("POST /partners/{id} is deprecated.", DeprecationWarning) - - _param = self._create_partner_deprecated_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_partner_deprecated_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/partners/{id}', - 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 - ) - - - - - @validate_call - def update_api_key( - self, - id: UUID, - api_key_update_dto: ApiKeyUpdateDto, - _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, - ) -> ApiKeyResponseDto: - """(Deprecated) Update an API key - - Updates the name and permissions of an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :param api_key_update_dto: (required) - :type api_key_update_dto: ApiKeyUpdateDto - :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 /api-keys/{id} is deprecated.", DeprecationWarning) - - _param = self._update_api_key_serialize( - id=id, - api_key_update_dto=api_key_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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 update_api_key_with_http_info( - self, - id: UUID, - api_key_update_dto: ApiKeyUpdateDto, - _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[ApiKeyResponseDto]: - """(Deprecated) Update an API key - - Updates the name and permissions of an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :param api_key_update_dto: (required) - :type api_key_update_dto: ApiKeyUpdateDto - :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 /api-keys/{id} is deprecated.", DeprecationWarning) - - _param = self._update_api_key_serialize( - id=id, - api_key_update_dto=api_key_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - 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 update_api_key_without_preload_content( - self, - id: UUID, - api_key_update_dto: ApiKeyUpdateDto, - _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) Update an API key - - Updates the name and permissions of an API key by its ID. The current user must own this API key. - - :param id: (required) - :type id: UUID - :param api_key_update_dto: (required) - :type api_key_update_dto: ApiKeyUpdateDto - :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 /api-keys/{id} is deprecated.", DeprecationWarning) - - _param = self._update_api_key_serialize( - id=id, - api_key_update_dto=api_key_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ApiKeyResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_api_key_serialize( - self, - id, - api_key_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if api_key_update_dto is not None: - _body_params = api_key_update_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='/api-keys/{id}', - 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 update_asset( - self, - id: UUID, - update_asset_dto: UpdateAssetDto, - _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, - ) -> AssetResponseDto: - """(Deprecated) Update an asset - - Update information of a specific asset. - - :param id: (required) - :type id: UUID - :param update_asset_dto: (required) - :type update_asset_dto: UpdateAssetDto - :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 /assets/{id} is deprecated.", DeprecationWarning) - - _param = self._update_asset_serialize( - id=id, - update_asset_dto=update_asset_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AssetResponseDto", - } - 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 update_asset_with_http_info( - self, - id: UUID, - update_asset_dto: UpdateAssetDto, - _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[AssetResponseDto]: - """(Deprecated) Update an asset - - Update information of a specific asset. - - :param id: (required) - :type id: UUID - :param update_asset_dto: (required) - :type update_asset_dto: UpdateAssetDto - :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 /assets/{id} is deprecated.", DeprecationWarning) - - _param = self._update_asset_serialize( - id=id, - update_asset_dto=update_asset_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AssetResponseDto", - } - 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 update_asset_without_preload_content( - self, - id: UUID, - update_asset_dto: UpdateAssetDto, - _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) Update an asset - - Update information of a specific asset. - - :param id: (required) - :type id: UUID - :param update_asset_dto: (required) - :type update_asset_dto: UpdateAssetDto - :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 /assets/{id} is deprecated.", DeprecationWarning) - - _param = self._update_asset_serialize( - id=id, - update_asset_dto=update_asset_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AssetResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_asset_serialize( - self, - id, - update_asset_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if update_asset_dto is not None: - _body_params = update_asset_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='/assets/{id}', - 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 update_assets( - self, - asset_bulk_update_dto: AssetBulkUpdateDto, - _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: - """(Deprecated) Update assets - - Updates multiple assets at the same time. - - :param asset_bulk_update_dto: (required) - :type asset_bulk_update_dto: AssetBulkUpdateDto - :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 /assets is deprecated.", DeprecationWarning) - - _param = self._update_assets_serialize( - asset_bulk_update_dto=asset_bulk_update_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 update_assets_with_http_info( - self, - asset_bulk_update_dto: AssetBulkUpdateDto, - _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]: - """(Deprecated) Update assets - - Updates multiple assets at the same time. - - :param asset_bulk_update_dto: (required) - :type asset_bulk_update_dto: AssetBulkUpdateDto - :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 /assets is deprecated.", DeprecationWarning) - - _param = self._update_assets_serialize( - asset_bulk_update_dto=asset_bulk_update_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 update_assets_without_preload_content( - self, - asset_bulk_update_dto: AssetBulkUpdateDto, - _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) Update assets - - Updates multiple assets at the same time. - - :param asset_bulk_update_dto: (required) - :type asset_bulk_update_dto: AssetBulkUpdateDto - :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 /assets is deprecated.", DeprecationWarning) - - _param = self._update_assets_serialize( - asset_bulk_update_dto=asset_bulk_update_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 _update_assets_serialize( - self, - asset_bulk_update_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 asset_bulk_update_dto is not None: - _body_params = asset_bulk_update_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='PUT', - resource_path='/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 update_library( - self, - id: UUID, - update_library_dto: UpdateLibraryDto, - _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, - ) -> LibraryResponseDto: - """(Deprecated) Update a library - - Update an existing external library. - - :param id: (required) - :type id: UUID - :param update_library_dto: (required) - :type update_library_dto: UpdateLibraryDto - :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 /libraries/{id} is deprecated.", DeprecationWarning) - - _param = self._update_library_serialize( - id=id, - update_library_dto=update_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - 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 update_library_with_http_info( - self, - id: UUID, - update_library_dto: UpdateLibraryDto, - _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[LibraryResponseDto]: - """(Deprecated) Update a library - - Update an existing external library. - - :param id: (required) - :type id: UUID - :param update_library_dto: (required) - :type update_library_dto: UpdateLibraryDto - :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 /libraries/{id} is deprecated.", DeprecationWarning) - - _param = self._update_library_serialize( - id=id, - update_library_dto=update_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - 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 update_library_without_preload_content( - self, - id: UUID, - update_library_dto: UpdateLibraryDto, - _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) Update a library - - Update an existing external library. - - :param id: (required) - :type id: UUID - :param update_library_dto: (required) - :type update_library_dto: UpdateLibraryDto - :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 /libraries/{id} is deprecated.", DeprecationWarning) - - _param = self._update_library_serialize( - id=id, - update_library_dto=update_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_library_serialize( - self, - id, - update_library_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if update_library_dto is not None: - _body_params = update_library_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='/libraries/{id}', - 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 update_memory( - self, - id: UUID, - memory_update_dto: MemoryUpdateDto, - _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, - ) -> MemoryResponseDto: - """(Deprecated) Update a memory - - Update an existing memory by its ID. - - :param id: (required) - :type id: UUID - :param memory_update_dto: (required) - :type memory_update_dto: MemoryUpdateDto - :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 /memories/{id} is deprecated.", DeprecationWarning) - - _param = self._update_memory_serialize( - id=id, - memory_update_dto=memory_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - 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 update_memory_with_http_info( - self, - id: UUID, - memory_update_dto: MemoryUpdateDto, - _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[MemoryResponseDto]: - """(Deprecated) Update a memory - - Update an existing memory by its ID. - - :param id: (required) - :type id: UUID - :param memory_update_dto: (required) - :type memory_update_dto: MemoryUpdateDto - :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 /memories/{id} is deprecated.", DeprecationWarning) - - _param = self._update_memory_serialize( - id=id, - memory_update_dto=memory_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - 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 update_memory_without_preload_content( - self, - id: UUID, - memory_update_dto: MemoryUpdateDto, - _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) Update a memory - - Update an existing memory by its ID. - - :param id: (required) - :type id: UUID - :param memory_update_dto: (required) - :type memory_update_dto: MemoryUpdateDto - :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 /memories/{id} is deprecated.", DeprecationWarning) - - _param = self._update_memory_serialize( - id=id, - memory_update_dto=memory_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_memory_serialize( - self, - id, - memory_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if memory_update_dto is not None: - _body_params = memory_update_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='/memories/{id}', - 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 update_my_preferences( - self, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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, - ) -> UserPreferencesResponseDto: - """(Deprecated) Update my preferences - - Update the preferences of the current user. - - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /users/me/preferences is deprecated.", DeprecationWarning) - - _param = self._update_my_preferences_serialize( - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_my_preferences_with_http_info( - self, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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[UserPreferencesResponseDto]: - """(Deprecated) Update my preferences - - Update the preferences of the current user. - - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /users/me/preferences is deprecated.", DeprecationWarning) - - _param = self._update_my_preferences_serialize( - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_my_preferences_without_preload_content( - self, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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) Update my preferences - - Update the preferences of the current user. - - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /users/me/preferences is deprecated.", DeprecationWarning) - - _param = self._update_my_preferences_serialize( - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_my_preferences_serialize( - self, - user_preferences_update_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 user_preferences_update_dto is not None: - _body_params = user_preferences_update_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='/users/me/preferences', - 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 update_my_user( - self, - user_update_me_dto: UserUpdateMeDto, - _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, - ) -> UserAdminResponseDto: - """(Deprecated) Update current user - - Update the current user making the API request. - - :param user_update_me_dto: (required) - :type user_update_me_dto: UserUpdateMeDto - :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 /users/me is deprecated.", DeprecationWarning) - - _param = self._update_my_user_serialize( - user_update_me_dto=user_update_me_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_my_user_with_http_info( - self, - user_update_me_dto: UserUpdateMeDto, - _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[UserAdminResponseDto]: - """(Deprecated) Update current user - - Update the current user making the API request. - - :param user_update_me_dto: (required) - :type user_update_me_dto: UserUpdateMeDto - :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 /users/me is deprecated.", DeprecationWarning) - - _param = self._update_my_user_serialize( - user_update_me_dto=user_update_me_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_my_user_without_preload_content( - self, - user_update_me_dto: UserUpdateMeDto, - _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) Update current user - - Update the current user making the API request. - - :param user_update_me_dto: (required) - :type user_update_me_dto: UserUpdateMeDto - :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 /users/me is deprecated.", DeprecationWarning) - - _param = self._update_my_user_serialize( - user_update_me_dto=user_update_me_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_my_user_serialize( - self, - user_update_me_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 user_update_me_dto is not None: - _body_params = user_update_me_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='/users/me', - 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 update_person( - self, - id: UUID, - person_update_dto: PersonUpdateDto, - _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, - ) -> PersonResponseDto: - """(Deprecated) Update person - - Update an individual person. - - :param id: (required) - :type id: UUID - :param person_update_dto: (required) - :type person_update_dto: PersonUpdateDto - :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 /people/{id} is deprecated.", DeprecationWarning) - - _param = self._update_person_serialize( - id=id, - person_update_dto=person_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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 update_person_with_http_info( - self, - id: UUID, - person_update_dto: PersonUpdateDto, - _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[PersonResponseDto]: - """(Deprecated) Update person - - Update an individual person. - - :param id: (required) - :type id: UUID - :param person_update_dto: (required) - :type person_update_dto: PersonUpdateDto - :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 /people/{id} is deprecated.", DeprecationWarning) - - _param = self._update_person_serialize( - id=id, - person_update_dto=person_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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 update_person_without_preload_content( - self, - id: UUID, - person_update_dto: PersonUpdateDto, - _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) Update person - - Update an individual person. - - :param id: (required) - :type id: UUID - :param person_update_dto: (required) - :type person_update_dto: PersonUpdateDto - :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 /people/{id} is deprecated.", DeprecationWarning) - - _param = self._update_person_serialize( - id=id, - person_update_dto=person_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_person_serialize( - self, - id, - person_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if person_update_dto is not None: - _body_params = person_update_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='/people/{id}', - 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 update_session( - self, - id: UUID, - session_update_dto: SessionUpdateDto, - _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, - ) -> SessionResponseDto: - """(Deprecated) Update a session - - Update a specific session identified by id. - - :param id: (required) - :type id: UUID - :param session_update_dto: (required) - :type session_update_dto: SessionUpdateDto - :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 /sessions/{id} is deprecated.", DeprecationWarning) - - _param = self._update_session_serialize( - id=id, - session_update_dto=session_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionResponseDto", - } - 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 update_session_with_http_info( - self, - id: UUID, - session_update_dto: SessionUpdateDto, - _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[SessionResponseDto]: - """(Deprecated) Update a session - - Update a specific session identified by id. - - :param id: (required) - :type id: UUID - :param session_update_dto: (required) - :type session_update_dto: SessionUpdateDto - :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 /sessions/{id} is deprecated.", DeprecationWarning) - - _param = self._update_session_serialize( - id=id, - session_update_dto=session_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionResponseDto", - } - 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 update_session_without_preload_content( - self, - id: UUID, - session_update_dto: SessionUpdateDto, - _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) Update a session - - Update a specific session identified by id. - - :param id: (required) - :type id: UUID - :param session_update_dto: (required) - :type session_update_dto: SessionUpdateDto - :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 /sessions/{id} is deprecated.", DeprecationWarning) - - _param = self._update_session_serialize( - id=id, - session_update_dto=session_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_session_serialize( - self, - id, - session_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if session_update_dto is not None: - _body_params = session_update_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='/sessions/{id}', - 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 update_stack( - self, - id: UUID, - stack_update_dto: StackUpdateDto, - _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, - ) -> StackResponseDto: - """(Deprecated) Update a stack - - Update an existing stack by its ID. - - :param id: (required) - :type id: UUID - :param stack_update_dto: (required) - :type stack_update_dto: StackUpdateDto - :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 /stacks/{id} is deprecated.", DeprecationWarning) - - _param = self._update_stack_serialize( - id=id, - stack_update_dto=stack_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - 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 update_stack_with_http_info( - self, - id: UUID, - stack_update_dto: StackUpdateDto, - _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[StackResponseDto]: - """(Deprecated) Update a stack - - Update an existing stack by its ID. - - :param id: (required) - :type id: UUID - :param stack_update_dto: (required) - :type stack_update_dto: StackUpdateDto - :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 /stacks/{id} is deprecated.", DeprecationWarning) - - _param = self._update_stack_serialize( - id=id, - stack_update_dto=stack_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - 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 update_stack_without_preload_content( - self, - id: UUID, - stack_update_dto: StackUpdateDto, - _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) Update a stack - - Update an existing stack by its ID. - - :param id: (required) - :type id: UUID - :param stack_update_dto: (required) - :type stack_update_dto: StackUpdateDto - :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 /stacks/{id} is deprecated.", DeprecationWarning) - - _param = self._update_stack_serialize( - id=id, - stack_update_dto=stack_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_stack_serialize( - self, - id, - stack_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if stack_update_dto is not None: - _body_params = stack_update_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='/stacks/{id}', - 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 update_tag( - self, - id: UUID, - tag_update_dto: TagUpdateDto, - _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, - ) -> TagResponseDto: - """(Deprecated) Update a tag - - Update an existing tag identified by its ID. - - :param id: (required) - :type id: UUID - :param tag_update_dto: (required) - :type tag_update_dto: TagUpdateDto - :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 /tags/{id} is deprecated.", DeprecationWarning) - - _param = self._update_tag_serialize( - id=id, - tag_update_dto=tag_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - 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 update_tag_with_http_info( - self, - id: UUID, - tag_update_dto: TagUpdateDto, - _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[TagResponseDto]: - """(Deprecated) Update a tag - - Update an existing tag identified by its ID. - - :param id: (required) - :type id: UUID - :param tag_update_dto: (required) - :type tag_update_dto: TagUpdateDto - :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 /tags/{id} is deprecated.", DeprecationWarning) - - _param = self._update_tag_serialize( - id=id, - tag_update_dto=tag_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - 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 update_tag_without_preload_content( - self, - id: UUID, - tag_update_dto: TagUpdateDto, - _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) Update a tag - - Update an existing tag identified by its ID. - - :param id: (required) - :type id: UUID - :param tag_update_dto: (required) - :type tag_update_dto: TagUpdateDto - :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 /tags/{id} is deprecated.", DeprecationWarning) - - _param = self._update_tag_serialize( - id=id, - tag_update_dto=tag_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_tag_serialize( - self, - id, - tag_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if tag_update_dto is not None: - _body_params = tag_update_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='/tags/{id}', - 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 update_user_admin( - self, - id: UUID, - user_admin_update_dto: UserAdminUpdateDto, - _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, - ) -> UserAdminResponseDto: - """(Deprecated) Update a user - - Update an existing user. - - :param id: (required) - :type id: UUID - :param user_admin_update_dto: (required) - :type user_admin_update_dto: UserAdminUpdateDto - :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 /admin/users/{id} is deprecated.", DeprecationWarning) - - _param = self._update_user_admin_serialize( - id=id, - user_admin_update_dto=user_admin_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_user_admin_with_http_info( - self, - id: UUID, - user_admin_update_dto: UserAdminUpdateDto, - _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[UserAdminResponseDto]: - """(Deprecated) Update a user - - Update an existing user. - - :param id: (required) - :type id: UUID - :param user_admin_update_dto: (required) - :type user_admin_update_dto: UserAdminUpdateDto - :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 /admin/users/{id} is deprecated.", DeprecationWarning) - - _param = self._update_user_admin_serialize( - id=id, - user_admin_update_dto=user_admin_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_user_admin_without_preload_content( - self, - id: UUID, - user_admin_update_dto: UserAdminUpdateDto, - _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) Update a user - - Update an existing user. - - :param id: (required) - :type id: UUID - :param user_admin_update_dto: (required) - :type user_admin_update_dto: UserAdminUpdateDto - :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 /admin/users/{id} is deprecated.", DeprecationWarning) - - _param = self._update_user_admin_serialize( - id=id, - user_admin_update_dto=user_admin_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_user_admin_serialize( - self, - id, - user_admin_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if user_admin_update_dto is not None: - _body_params = user_admin_update_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='/admin/users/{id}', - 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 update_user_preferences_admin( - self, - id: UUID, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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, - ) -> UserPreferencesResponseDto: - """(Deprecated) Update user preferences - - Update the preferences of a specific user. - - :param id: (required) - :type id: UUID - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /admin/users/{id}/preferences is deprecated.", DeprecationWarning) - - _param = self._update_user_preferences_admin_serialize( - id=id, - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_user_preferences_admin_with_http_info( - self, - id: UUID, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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[UserPreferencesResponseDto]: - """(Deprecated) Update user preferences - - Update the preferences of a specific user. - - :param id: (required) - :type id: UUID - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /admin/users/{id}/preferences is deprecated.", DeprecationWarning) - - _param = self._update_user_preferences_admin_serialize( - id=id, - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_user_preferences_admin_without_preload_content( - self, - id: UUID, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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) Update user preferences - - Update the preferences of a specific user. - - :param id: (required) - :type id: UUID - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /admin/users/{id}/preferences is deprecated.", DeprecationWarning) - - _param = self._update_user_preferences_admin_serialize( - id=id, - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_user_preferences_admin_serialize( - self, - id, - user_preferences_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if user_preferences_update_dto is not None: - _body_params = user_preferences_update_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='/admin/users/{id}/preferences', - 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 update_workflow( - self, - id: UUID, - workflow_update_dto: WorkflowUpdateDto, - _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, - ) -> WorkflowResponseDto: - """(Deprecated) Update a workflow - - Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. - - :param id: (required) - :type id: UUID - :param workflow_update_dto: (required) - :type workflow_update_dto: WorkflowUpdateDto - :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 /workflows/{id} is deprecated.", DeprecationWarning) - - _param = self._update_workflow_serialize( - id=id, - workflow_update_dto=workflow_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "WorkflowResponseDto", - } - 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 update_workflow_with_http_info( - self, - id: UUID, - workflow_update_dto: WorkflowUpdateDto, - _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[WorkflowResponseDto]: - """(Deprecated) Update a workflow - - Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. - - :param id: (required) - :type id: UUID - :param workflow_update_dto: (required) - :type workflow_update_dto: WorkflowUpdateDto - :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 /workflows/{id} is deprecated.", DeprecationWarning) - - _param = self._update_workflow_serialize( - id=id, - workflow_update_dto=workflow_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "WorkflowResponseDto", - } - 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 update_workflow_without_preload_content( - self, - id: UUID, - workflow_update_dto: WorkflowUpdateDto, - _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) Update a workflow - - Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. - - :param id: (required) - :type id: UUID - :param workflow_update_dto: (required) - :type workflow_update_dto: WorkflowUpdateDto - :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 /workflows/{id} is deprecated.", DeprecationWarning) - - _param = self._update_workflow_serialize( - id=id, - workflow_update_dto=workflow_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "WorkflowResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_workflow_serialize( - self, - id, - workflow_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if workflow_update_dto is not None: - _body_params = workflow_update_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='/workflows/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/download_api.py b/generated/immich/openapi_client/api/download_api.py deleted file mode 100644 index ef2ecc6..0000000 --- a/generated/immich/openapi_client/api/download_api.py +++ /dev/null @@ -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 - ) - - diff --git a/generated/immich/openapi_client/api/duplicates_api.py b/generated/immich/openapi_client/api/duplicates_api.py deleted file mode 100644 index 349c53e..0000000 --- a/generated/immich/openapi_client/api/duplicates_api.py +++ /dev/null @@ -1,1090 +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 typing import List -from uuid import UUID -from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto -from generated.immich.openapi_client.models.duplicate_resolve_dto import DuplicateResolveDto -from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto - -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 DuplicatesApi: - """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 delete_duplicate( - self, - id: UUID, - _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: - """Dismiss a duplicate group - - Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them. - - :param id: (required) - :type id: UUID - :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._delete_duplicate_serialize( - id=id, - _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 delete_duplicate_with_http_info( - self, - id: UUID, - _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]: - """Dismiss a duplicate group - - Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them. - - :param id: (required) - :type id: UUID - :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._delete_duplicate_serialize( - id=id, - _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 delete_duplicate_without_preload_content( - self, - id: UUID, - _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: - """Dismiss a duplicate group - - Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them. - - :param id: (required) - :type id: UUID - :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._delete_duplicate_serialize( - id=id, - _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 _delete_duplicate_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/duplicates/{id}', - 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 delete_duplicates( - 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, - ) -> None: - """Delete duplicates - - Delete multiple duplicate assets specified by their IDs. - - :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._delete_duplicates_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]] = { - '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 delete_duplicates_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[None]: - """Delete duplicates - - Delete multiple duplicate assets specified by their IDs. - - :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._delete_duplicates_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]] = { - '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 delete_duplicates_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: - """Delete duplicates - - Delete multiple duplicate assets specified by their IDs. - - :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._delete_duplicates_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]] = { - '204': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _delete_duplicates_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 `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='DELETE', - resource_path='/duplicates', - 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_asset_duplicates( - 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, - ) -> List[DuplicateResponseDto]: - """Retrieve duplicates - - Retrieve a list of duplicate assets available to the authenticated user. - - :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_asset_duplicates_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[DuplicateResponseDto]", - } - 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_asset_duplicates_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[List[DuplicateResponseDto]]: - """Retrieve duplicates - - Retrieve a list of duplicate assets available to the authenticated user. - - :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_asset_duplicates_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[DuplicateResponseDto]", - } - 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_asset_duplicates_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: - """Retrieve duplicates - - Retrieve a list of duplicate assets available to the authenticated user. - - :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_asset_duplicates_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[DuplicateResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_asset_duplicates_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='/duplicates', - 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 resolve_duplicates( - self, - duplicate_resolve_dto: DuplicateResolveDto, - _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[BulkIdResponseDto]: - """Resolve duplicate groups - - Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates. - - :param duplicate_resolve_dto: (required) - :type duplicate_resolve_dto: DuplicateResolveDto - :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._resolve_duplicates_serialize( - duplicate_resolve_dto=duplicate_resolve_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - 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 resolve_duplicates_with_http_info( - self, - duplicate_resolve_dto: DuplicateResolveDto, - _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[BulkIdResponseDto]]: - """Resolve duplicate groups - - Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates. - - :param duplicate_resolve_dto: (required) - :type duplicate_resolve_dto: DuplicateResolveDto - :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._resolve_duplicates_serialize( - duplicate_resolve_dto=duplicate_resolve_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - 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 resolve_duplicates_without_preload_content( - self, - duplicate_resolve_dto: DuplicateResolveDto, - _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: - """Resolve duplicate groups - - Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates. - - :param duplicate_resolve_dto: (required) - :type duplicate_resolve_dto: DuplicateResolveDto - :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._resolve_duplicates_serialize( - duplicate_resolve_dto=duplicate_resolve_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _resolve_duplicates_serialize( - self, - duplicate_resolve_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 duplicate_resolve_dto is not None: - _body_params = duplicate_resolve_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='/duplicates/resolve', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/faces_api.py b/generated/immich/openapi_client/api/faces_api.py deleted file mode 100644 index 2c9fb34..0000000 --- a/generated/immich/openapi_client/api/faces_api.py +++ /dev/null @@ -1,1153 +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 Field -from typing import List -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto -from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto -from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto -from generated.immich.openapi_client.models.face_dto import FaceDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto - -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 FacesApi: - """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_face( - self, - asset_face_create_dto: AssetFaceCreateDto, - _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 face - - Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face. - - :param asset_face_create_dto: (required) - :type asset_face_create_dto: AssetFaceCreateDto - :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_face_serialize( - asset_face_create_dto=asset_face_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': 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_face_with_http_info( - self, - asset_face_create_dto: AssetFaceCreateDto, - _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 face - - Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face. - - :param asset_face_create_dto: (required) - :type asset_face_create_dto: AssetFaceCreateDto - :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_face_serialize( - asset_face_create_dto=asset_face_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': 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_face_without_preload_content( - self, - asset_face_create_dto: AssetFaceCreateDto, - _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 face - - Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face. - - :param asset_face_create_dto: (required) - :type asset_face_create_dto: AssetFaceCreateDto - :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_face_serialize( - asset_face_create_dto=asset_face_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_face_serialize( - self, - asset_face_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 asset_face_create_dto is not None: - _body_params = asset_face_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='/faces', - 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 delete_face( - self, - id: UUID, - asset_face_delete_dto: AssetFaceDeleteDto, - _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: - """Delete a face - - Delete a face identified by the id. Optionally can be force deleted. - - :param id: (required) - :type id: UUID - :param asset_face_delete_dto: (required) - :type asset_face_delete_dto: AssetFaceDeleteDto - :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._delete_face_serialize( - id=id, - asset_face_delete_dto=asset_face_delete_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 delete_face_with_http_info( - self, - id: UUID, - asset_face_delete_dto: AssetFaceDeleteDto, - _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]: - """Delete a face - - Delete a face identified by the id. Optionally can be force deleted. - - :param id: (required) - :type id: UUID - :param asset_face_delete_dto: (required) - :type asset_face_delete_dto: AssetFaceDeleteDto - :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._delete_face_serialize( - id=id, - asset_face_delete_dto=asset_face_delete_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 delete_face_without_preload_content( - self, - id: UUID, - asset_face_delete_dto: AssetFaceDeleteDto, - _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: - """Delete a face - - Delete a face identified by the id. Optionally can be force deleted. - - :param id: (required) - :type id: UUID - :param asset_face_delete_dto: (required) - :type asset_face_delete_dto: AssetFaceDeleteDto - :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._delete_face_serialize( - id=id, - asset_face_delete_dto=asset_face_delete_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 _delete_face_serialize( - self, - id, - asset_face_delete_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if asset_face_delete_dto is not None: - _body_params = asset_face_delete_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='DELETE', - resource_path='/faces/{id}', - 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_faces( - self, - id: Annotated[UUID, Field(description="Face ID")], - _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[AssetFaceResponseDto]: - """Retrieve faces for asset - - Retrieve all faces belonging to an asset. - - :param id: Face ID (required) - :type id: UUID - :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_faces_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetFaceResponseDto]", - } - 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_faces_with_http_info( - self, - id: Annotated[UUID, Field(description="Face ID")], - _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[AssetFaceResponseDto]]: - """Retrieve faces for asset - - Retrieve all faces belonging to an asset. - - :param id: Face ID (required) - :type id: UUID - :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_faces_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetFaceResponseDto]", - } - 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_faces_without_preload_content( - self, - id: Annotated[UUID, Field(description="Face ID")], - _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 faces for asset - - Retrieve all faces belonging to an asset. - - :param id: Face ID (required) - :type id: UUID - :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_faces_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetFaceResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_faces_serialize( - self, - id, - _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 id is not None: - - _query_params.append(('id', id)) - - # 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='/faces', - 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 reassign_faces_by_id( - self, - id: UUID, - face_dto: FaceDto, - _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, - ) -> PersonResponseDto: - """Re-assign a face to another person - - Re-assign the face provided in the body to the person identified by the id in the path parameter. - - :param id: (required) - :type id: UUID - :param face_dto: (required) - :type face_dto: FaceDto - :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._reassign_faces_by_id_serialize( - id=id, - face_dto=face_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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 reassign_faces_by_id_with_http_info( - self, - id: UUID, - face_dto: FaceDto, - _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[PersonResponseDto]: - """Re-assign a face to another person - - Re-assign the face provided in the body to the person identified by the id in the path parameter. - - :param id: (required) - :type id: UUID - :param face_dto: (required) - :type face_dto: FaceDto - :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._reassign_faces_by_id_serialize( - id=id, - face_dto=face_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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 reassign_faces_by_id_without_preload_content( - self, - id: UUID, - face_dto: FaceDto, - _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: - """Re-assign a face to another person - - Re-assign the face provided in the body to the person identified by the id in the path parameter. - - :param id: (required) - :type id: UUID - :param face_dto: (required) - :type face_dto: FaceDto - :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._reassign_faces_by_id_serialize( - id=id, - face_dto=face_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _reassign_faces_by_id_serialize( - self, - id, - face_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if face_dto is not None: - _body_params = face_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='/faces/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/jobs_api.py b/generated/immich/openapi_client/api/jobs_api.py deleted file mode 100644 index a0cfe83..0000000 --- a/generated/immich/openapi_client/api/jobs_api.py +++ /dev/null @@ -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 - ) - - diff --git a/generated/immich/openapi_client/api/libraries_api.py b/generated/immich/openapi_client/api/libraries_api.py deleted file mode 100644 index 8e0ddcc..0000000 --- a/generated/immich/openapi_client/api/libraries_api.py +++ /dev/null @@ -1,2190 +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 typing import List -from uuid import UUID -from generated.immich.openapi_client.models.create_library_dto import CreateLibraryDto -from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto -from generated.immich.openapi_client.models.library_stats_response_dto import LibraryStatsResponseDto -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto -from generated.immich.openapi_client.models.validate_library_dto import ValidateLibraryDto -from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto - -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 LibrariesApi: - """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_library( - self, - create_library_dto: CreateLibraryDto, - _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, - ) -> LibraryResponseDto: - """Create a library - - Create a new external library. - - :param create_library_dto: (required) - :type create_library_dto: CreateLibraryDto - :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_library_serialize( - create_library_dto=create_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LibraryResponseDto", - } - 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_library_with_http_info( - self, - create_library_dto: CreateLibraryDto, - _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[LibraryResponseDto]: - """Create a library - - Create a new external library. - - :param create_library_dto: (required) - :type create_library_dto: CreateLibraryDto - :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_library_serialize( - create_library_dto=create_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LibraryResponseDto", - } - 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_library_without_preload_content( - self, - create_library_dto: CreateLibraryDto, - _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 library - - Create a new external library. - - :param create_library_dto: (required) - :type create_library_dto: CreateLibraryDto - :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_library_serialize( - create_library_dto=create_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "LibraryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_library_serialize( - self, - create_library_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 create_library_dto is not None: - _body_params = create_library_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='/libraries', - 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 delete_library( - self, - id: UUID, - _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: - """Delete a library - - Delete an external library by its ID. - - :param id: (required) - :type id: UUID - :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._delete_library_serialize( - id=id, - _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 delete_library_with_http_info( - self, - id: UUID, - _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]: - """Delete a library - - Delete an external library by its ID. - - :param id: (required) - :type id: UUID - :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._delete_library_serialize( - id=id, - _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 delete_library_without_preload_content( - self, - id: UUID, - _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: - """Delete a library - - Delete an external library by its ID. - - :param id: (required) - :type id: UUID - :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._delete_library_serialize( - id=id, - _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 _delete_library_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/libraries/{id}', - 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_all_libraries( - 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, - ) -> List[LibraryResponseDto]: - """Retrieve libraries - - Retrieve a list of external libraries. - - :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_all_libraries_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[LibraryResponseDto]", - } - 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_all_libraries_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[List[LibraryResponseDto]]: - """Retrieve libraries - - Retrieve a list of external libraries. - - :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_all_libraries_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[LibraryResponseDto]", - } - 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_all_libraries_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: - """Retrieve libraries - - Retrieve a list of external libraries. - - :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_all_libraries_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[LibraryResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_all_libraries_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='/libraries', - 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_library( - self, - id: UUID, - _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, - ) -> LibraryResponseDto: - """Retrieve a library - - Retrieve an external library by its ID. - - :param id: (required) - :type id: UUID - :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_library_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - 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_library_with_http_info( - self, - id: UUID, - _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[LibraryResponseDto]: - """Retrieve a library - - Retrieve an external library by its ID. - - :param id: (required) - :type id: UUID - :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_library_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - 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_library_without_preload_content( - self, - id: UUID, - _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 a library - - Retrieve an external library by its ID. - - :param id: (required) - :type id: UUID - :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_library_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_library_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/libraries/{id}', - 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_library_statistics( - self, - id: UUID, - _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, - ) -> LibraryStatsResponseDto: - """Retrieve library statistics - - Retrieve statistics for a specific external library, including number of videos, images, and storage usage. - - :param id: (required) - :type id: UUID - :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_library_statistics_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryStatsResponseDto", - } - 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_library_statistics_with_http_info( - self, - id: UUID, - _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[LibraryStatsResponseDto]: - """Retrieve library statistics - - Retrieve statistics for a specific external library, including number of videos, images, and storage usage. - - :param id: (required) - :type id: UUID - :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_library_statistics_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryStatsResponseDto", - } - 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_library_statistics_without_preload_content( - self, - id: UUID, - _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 library statistics - - Retrieve statistics for a specific external library, including number of videos, images, and storage usage. - - :param id: (required) - :type id: UUID - :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_library_statistics_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryStatsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_library_statistics_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/libraries/{id}/statistics', - 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 scan_library( - self, - id: UUID, - _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: - """Scan a library - - Queue a scan for the external library to find and import new assets. - - :param id: (required) - :type id: UUID - :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._scan_library_serialize( - id=id, - _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 scan_library_with_http_info( - self, - id: UUID, - _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]: - """Scan a library - - Queue a scan for the external library to find and import new assets. - - :param id: (required) - :type id: UUID - :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._scan_library_serialize( - id=id, - _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 scan_library_without_preload_content( - self, - id: UUID, - _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: - """Scan a library - - Queue a scan for the external library to find and import new assets. - - :param id: (required) - :type id: UUID - :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._scan_library_serialize( - id=id, - _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 _scan_library_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/libraries/{id}/scan', - 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 update_library( - self, - id: UUID, - update_library_dto: UpdateLibraryDto, - _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, - ) -> LibraryResponseDto: - """(Deprecated) Update a library - - Update an existing external library. - - :param id: (required) - :type id: UUID - :param update_library_dto: (required) - :type update_library_dto: UpdateLibraryDto - :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 /libraries/{id} is deprecated.", DeprecationWarning) - - _param = self._update_library_serialize( - id=id, - update_library_dto=update_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - 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 update_library_with_http_info( - self, - id: UUID, - update_library_dto: UpdateLibraryDto, - _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[LibraryResponseDto]: - """(Deprecated) Update a library - - Update an existing external library. - - :param id: (required) - :type id: UUID - :param update_library_dto: (required) - :type update_library_dto: UpdateLibraryDto - :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 /libraries/{id} is deprecated.", DeprecationWarning) - - _param = self._update_library_serialize( - id=id, - update_library_dto=update_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - 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 update_library_without_preload_content( - self, - id: UUID, - update_library_dto: UpdateLibraryDto, - _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) Update a library - - Update an existing external library. - - :param id: (required) - :type id: UUID - :param update_library_dto: (required) - :type update_library_dto: UpdateLibraryDto - :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 /libraries/{id} is deprecated.", DeprecationWarning) - - _param = self._update_library_serialize( - id=id, - update_library_dto=update_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "LibraryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_library_serialize( - self, - id, - update_library_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if update_library_dto is not None: - _body_params = update_library_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='/libraries/{id}', - 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 validate( - self, - id: UUID, - validate_library_dto: ValidateLibraryDto, - _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, - ) -> ValidateLibraryResponseDto: - """Validate library settings - - Validate the settings of an external library. - - :param id: (required) - :type id: UUID - :param validate_library_dto: (required) - :type validate_library_dto: ValidateLibraryDto - :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._validate_serialize( - id=id, - validate_library_dto=validate_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ValidateLibraryResponseDto", - } - 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 validate_with_http_info( - self, - id: UUID, - validate_library_dto: ValidateLibraryDto, - _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[ValidateLibraryResponseDto]: - """Validate library settings - - Validate the settings of an external library. - - :param id: (required) - :type id: UUID - :param validate_library_dto: (required) - :type validate_library_dto: ValidateLibraryDto - :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._validate_serialize( - id=id, - validate_library_dto=validate_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ValidateLibraryResponseDto", - } - 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 validate_without_preload_content( - self, - id: UUID, - validate_library_dto: ValidateLibraryDto, - _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: - """Validate library settings - - Validate the settings of an external library. - - :param id: (required) - :type id: UUID - :param validate_library_dto: (required) - :type validate_library_dto: ValidateLibraryDto - :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._validate_serialize( - id=id, - validate_library_dto=validate_library_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ValidateLibraryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _validate_serialize( - self, - id, - validate_library_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if validate_library_dto is not None: - _body_params = validate_library_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='/libraries/{id}/validate', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/map_api.py b/generated/immich/openapi_client/api/map_api.py deleted file mode 100644 index edfb737..0000000 --- a/generated/immich/openapi_client/api/map_api.py +++ /dev/null @@ -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 - ) - - diff --git a/generated/immich/openapi_client/api/memories_api.py b/generated/immich/openapi_client/api/memories_api.py deleted file mode 100644 index 3dd67d1..0000000 --- a/generated/immich/openapi_client/api/memories_api.py +++ /dev/null @@ -1,2437 +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 -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto -from generated.immich.openapi_client.models.memory_create_dto import MemoryCreateDto -from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto -from generated.immich.openapi_client.models.memory_search_order import MemorySearchOrder -from generated.immich.openapi_client.models.memory_statistics_response_dto import MemoryStatisticsResponseDto -from generated.immich.openapi_client.models.memory_type import MemoryType -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto - -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 MemoriesApi: - """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 add_memory_assets( - self, - id: UUID, - 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, - ) -> List[BulkIdResponseDto]: - """Add assets to a memory - - Add a list of asset IDs to a specific memory. - - :param id: (required) - :type id: UUID - :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._add_memory_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 add_memory_assets_with_http_info( - self, - id: UUID, - 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[List[BulkIdResponseDto]]: - """Add assets to a memory - - Add a list of asset IDs to a specific memory. - - :param id: (required) - :type id: UUID - :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._add_memory_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 add_memory_assets_without_preload_content( - self, - id: UUID, - 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: - """Add assets to a memory - - Add a list of asset IDs to a specific memory. - - :param id: (required) - :type id: UUID - :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._add_memory_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _add_memory_assets_serialize( - self, - id, - 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 - if id is not None: - _path_params['id'] = id - # 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='PUT', - resource_path='/memories/{id}/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 create_memory( - self, - memory_create_dto: MemoryCreateDto, - _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, - ) -> MemoryResponseDto: - """Create a memory - - Create a new memory by providing a name, description, and a list of asset IDs to include in the memory. - - :param memory_create_dto: (required) - :type memory_create_dto: MemoryCreateDto - :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_memory_serialize( - memory_create_dto=memory_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "MemoryResponseDto", - } - 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_memory_with_http_info( - self, - memory_create_dto: MemoryCreateDto, - _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[MemoryResponseDto]: - """Create a memory - - Create a new memory by providing a name, description, and a list of asset IDs to include in the memory. - - :param memory_create_dto: (required) - :type memory_create_dto: MemoryCreateDto - :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_memory_serialize( - memory_create_dto=memory_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "MemoryResponseDto", - } - 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_memory_without_preload_content( - self, - memory_create_dto: MemoryCreateDto, - _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 memory - - Create a new memory by providing a name, description, and a list of asset IDs to include in the memory. - - :param memory_create_dto: (required) - :type memory_create_dto: MemoryCreateDto - :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_memory_serialize( - memory_create_dto=memory_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "MemoryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_memory_serialize( - self, - memory_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 memory_create_dto is not None: - _body_params = memory_create_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='/memories', - 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 delete_memory( - self, - id: UUID, - _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: - """Delete a memory - - Delete a specific memory by its ID. - - :param id: (required) - :type id: UUID - :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._delete_memory_serialize( - id=id, - _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 delete_memory_with_http_info( - self, - id: UUID, - _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]: - """Delete a memory - - Delete a specific memory by its ID. - - :param id: (required) - :type id: UUID - :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._delete_memory_serialize( - id=id, - _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 delete_memory_without_preload_content( - self, - id: UUID, - _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: - """Delete a memory - - Delete a specific memory by its ID. - - :param id: (required) - :type id: UUID - :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._delete_memory_serialize( - id=id, - _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 _delete_memory_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/memories/{id}', - 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_memory( - self, - id: UUID, - _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, - ) -> MemoryResponseDto: - """Retrieve a memory - - Retrieve a specific memory by its ID. - - :param id: (required) - :type id: UUID - :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_memory_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - 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_memory_with_http_info( - self, - id: UUID, - _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[MemoryResponseDto]: - """Retrieve a memory - - Retrieve a specific memory by its ID. - - :param id: (required) - :type id: UUID - :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_memory_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - 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_memory_without_preload_content( - self, - id: UUID, - _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 a memory - - Retrieve a specific memory by its ID. - - :param id: (required) - :type id: UUID - :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_memory_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_memory_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/memories/{id}', - 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 memories_statistics( - self, - var_for: Annotated[Optional[datetime], Field(description="Filter by date")] = None, - is_saved: Annotated[Optional[StrictBool], Field(description="Filter by saved status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Include trashed memories")] = None, - order: Optional[MemorySearchOrder] = None, - size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Number of memories to return")] = None, - type: Optional[MemoryType] = 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, - ) -> MemoryStatisticsResponseDto: - """Retrieve memories statistics - - Retrieve statistics about memories, such as total count and other relevant metrics. - - :param var_for: Filter by date - :type var_for: datetime - :param is_saved: Filter by saved status - :type is_saved: bool - :param is_trashed: Include trashed memories - :type is_trashed: bool - :param order: - :type order: MemorySearchOrder - :param size: Number of memories to return - :type size: int - :param type: - :type type: MemoryType - :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._memories_statistics_serialize( - var_for=var_for, - is_saved=is_saved, - is_trashed=is_trashed, - order=order, - size=size, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryStatisticsResponseDto", - } - 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 memories_statistics_with_http_info( - self, - var_for: Annotated[Optional[datetime], Field(description="Filter by date")] = None, - is_saved: Annotated[Optional[StrictBool], Field(description="Filter by saved status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Include trashed memories")] = None, - order: Optional[MemorySearchOrder] = None, - size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Number of memories to return")] = None, - type: Optional[MemoryType] = 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[MemoryStatisticsResponseDto]: - """Retrieve memories statistics - - Retrieve statistics about memories, such as total count and other relevant metrics. - - :param var_for: Filter by date - :type var_for: datetime - :param is_saved: Filter by saved status - :type is_saved: bool - :param is_trashed: Include trashed memories - :type is_trashed: bool - :param order: - :type order: MemorySearchOrder - :param size: Number of memories to return - :type size: int - :param type: - :type type: MemoryType - :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._memories_statistics_serialize( - var_for=var_for, - is_saved=is_saved, - is_trashed=is_trashed, - order=order, - size=size, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryStatisticsResponseDto", - } - 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 memories_statistics_without_preload_content( - self, - var_for: Annotated[Optional[datetime], Field(description="Filter by date")] = None, - is_saved: Annotated[Optional[StrictBool], Field(description="Filter by saved status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Include trashed memories")] = None, - order: Optional[MemorySearchOrder] = None, - size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Number of memories to return")] = None, - type: Optional[MemoryType] = 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 memories statistics - - Retrieve statistics about memories, such as total count and other relevant metrics. - - :param var_for: Filter by date - :type var_for: datetime - :param is_saved: Filter by saved status - :type is_saved: bool - :param is_trashed: Include trashed memories - :type is_trashed: bool - :param order: - :type order: MemorySearchOrder - :param size: Number of memories to return - :type size: int - :param type: - :type type: MemoryType - :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._memories_statistics_serialize( - var_for=var_for, - is_saved=is_saved, - is_trashed=is_trashed, - order=order, - size=size, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryStatisticsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _memories_statistics_serialize( - self, - var_for, - is_saved, - is_trashed, - order, - size, - type, - _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 var_for is not None: - if isinstance(var_for, datetime): - _query_params.append( - ( - 'for', - var_for.strftime( - self.api_client.configuration.datetime_format - ) - ) - ) - else: - _query_params.append(('for', var_for)) - - if is_saved is not None: - - _query_params.append(('isSaved', is_saved)) - - if is_trashed is not None: - - _query_params.append(('isTrashed', is_trashed)) - - if order is not None: - - _query_params.append(('order', order.value)) - - if size is not None: - - _query_params.append(('size', size)) - - if type is not None: - - _query_params.append(('type', type.value)) - - # 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='/memories/statistics', - 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 remove_memory_assets( - self, - id: UUID, - 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, - ) -> List[BulkIdResponseDto]: - """Remove assets from a memory - - Remove a list of asset IDs from a specific memory. - - :param id: (required) - :type id: UUID - :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._remove_memory_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 remove_memory_assets_with_http_info( - self, - id: UUID, - 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[List[BulkIdResponseDto]]: - """Remove assets from a memory - - Remove a list of asset IDs from a specific memory. - - :param id: (required) - :type id: UUID - :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._remove_memory_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 remove_memory_assets_without_preload_content( - self, - id: UUID, - 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: - """Remove assets from a memory - - Remove a list of asset IDs from a specific memory. - - :param id: (required) - :type id: UUID - :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._remove_memory_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _remove_memory_assets_serialize( - self, - id, - 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 - if id is not None: - _path_params['id'] = id - # 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='DELETE', - resource_path='/memories/{id}/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 search_memories( - self, - var_for: Annotated[Optional[datetime], Field(description="Filter by date")] = None, - is_saved: Annotated[Optional[StrictBool], Field(description="Filter by saved status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Include trashed memories")] = None, - order: Optional[MemorySearchOrder] = None, - size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Number of memories to return")] = None, - type: Optional[MemoryType] = 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[MemoryResponseDto]: - """Retrieve memories - - Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly. - - :param var_for: Filter by date - :type var_for: datetime - :param is_saved: Filter by saved status - :type is_saved: bool - :param is_trashed: Include trashed memories - :type is_trashed: bool - :param order: - :type order: MemorySearchOrder - :param size: Number of memories to return - :type size: int - :param type: - :type type: MemoryType - :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._search_memories_serialize( - var_for=var_for, - is_saved=is_saved, - is_trashed=is_trashed, - order=order, - size=size, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[MemoryResponseDto]", - } - 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 search_memories_with_http_info( - self, - var_for: Annotated[Optional[datetime], Field(description="Filter by date")] = None, - is_saved: Annotated[Optional[StrictBool], Field(description="Filter by saved status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Include trashed memories")] = None, - order: Optional[MemorySearchOrder] = None, - size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Number of memories to return")] = None, - type: Optional[MemoryType] = 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[MemoryResponseDto]]: - """Retrieve memories - - Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly. - - :param var_for: Filter by date - :type var_for: datetime - :param is_saved: Filter by saved status - :type is_saved: bool - :param is_trashed: Include trashed memories - :type is_trashed: bool - :param order: - :type order: MemorySearchOrder - :param size: Number of memories to return - :type size: int - :param type: - :type type: MemoryType - :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._search_memories_serialize( - var_for=var_for, - is_saved=is_saved, - is_trashed=is_trashed, - order=order, - size=size, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[MemoryResponseDto]", - } - 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 search_memories_without_preload_content( - self, - var_for: Annotated[Optional[datetime], Field(description="Filter by date")] = None, - is_saved: Annotated[Optional[StrictBool], Field(description="Filter by saved status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Include trashed memories")] = None, - order: Optional[MemorySearchOrder] = None, - size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Number of memories to return")] = None, - type: Optional[MemoryType] = 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 memories - - Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly. - - :param var_for: Filter by date - :type var_for: datetime - :param is_saved: Filter by saved status - :type is_saved: bool - :param is_trashed: Include trashed memories - :type is_trashed: bool - :param order: - :type order: MemorySearchOrder - :param size: Number of memories to return - :type size: int - :param type: - :type type: MemoryType - :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._search_memories_serialize( - var_for=var_for, - is_saved=is_saved, - is_trashed=is_trashed, - order=order, - size=size, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[MemoryResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _search_memories_serialize( - self, - var_for, - is_saved, - is_trashed, - order, - size, - type, - _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 var_for is not None: - if isinstance(var_for, datetime): - _query_params.append( - ( - 'for', - var_for.strftime( - self.api_client.configuration.datetime_format - ) - ) - ) - else: - _query_params.append(('for', var_for)) - - if is_saved is not None: - - _query_params.append(('isSaved', is_saved)) - - if is_trashed is not None: - - _query_params.append(('isTrashed', is_trashed)) - - if order is not None: - - _query_params.append(('order', order.value)) - - if size is not None: - - _query_params.append(('size', size)) - - if type is not None: - - _query_params.append(('type', type.value)) - - # 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='/memories', - 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 update_memory( - self, - id: UUID, - memory_update_dto: MemoryUpdateDto, - _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, - ) -> MemoryResponseDto: - """(Deprecated) Update a memory - - Update an existing memory by its ID. - - :param id: (required) - :type id: UUID - :param memory_update_dto: (required) - :type memory_update_dto: MemoryUpdateDto - :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 /memories/{id} is deprecated.", DeprecationWarning) - - _param = self._update_memory_serialize( - id=id, - memory_update_dto=memory_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - 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 update_memory_with_http_info( - self, - id: UUID, - memory_update_dto: MemoryUpdateDto, - _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[MemoryResponseDto]: - """(Deprecated) Update a memory - - Update an existing memory by its ID. - - :param id: (required) - :type id: UUID - :param memory_update_dto: (required) - :type memory_update_dto: MemoryUpdateDto - :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 /memories/{id} is deprecated.", DeprecationWarning) - - _param = self._update_memory_serialize( - id=id, - memory_update_dto=memory_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - 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 update_memory_without_preload_content( - self, - id: UUID, - memory_update_dto: MemoryUpdateDto, - _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) Update a memory - - Update an existing memory by its ID. - - :param id: (required) - :type id: UUID - :param memory_update_dto: (required) - :type memory_update_dto: MemoryUpdateDto - :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 /memories/{id} is deprecated.", DeprecationWarning) - - _param = self._update_memory_serialize( - id=id, - memory_update_dto=memory_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "MemoryResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_memory_serialize( - self, - id, - memory_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if memory_update_dto is not None: - _body_params = memory_update_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='/memories/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/notifications_api.py b/generated/immich/openapi_client/api/notifications_api.py deleted file mode 100644 index fad20e1..0000000 --- a/generated/immich/openapi_client/api/notifications_api.py +++ /dev/null @@ -1,1709 +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 Field, StrictBool -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.notification_delete_all_dto import NotificationDeleteAllDto -from generated.immich.openapi_client.models.notification_dto import NotificationDto -from generated.immich.openapi_client.models.notification_level import NotificationLevel -from generated.immich.openapi_client.models.notification_type import NotificationType -from generated.immich.openapi_client.models.notification_update_all_dto import NotificationUpdateAllDto -from generated.immich.openapi_client.models.notification_update_dto import NotificationUpdateDto - -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 NotificationsApi: - """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 delete_notification( - self, - id: UUID, - _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: - """Delete a notification - - Delete a specific notification. - - :param id: (required) - :type id: UUID - :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._delete_notification_serialize( - id=id, - _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 delete_notification_with_http_info( - self, - id: UUID, - _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]: - """Delete a notification - - Delete a specific notification. - - :param id: (required) - :type id: UUID - :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._delete_notification_serialize( - id=id, - _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 delete_notification_without_preload_content( - self, - id: UUID, - _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: - """Delete a notification - - Delete a specific notification. - - :param id: (required) - :type id: UUID - :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._delete_notification_serialize( - id=id, - _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 _delete_notification_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/notifications/{id}', - 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 delete_notifications( - self, - notification_delete_all_dto: NotificationDeleteAllDto, - _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: - """Delete notifications - - Delete a list of notifications at once. - - :param notification_delete_all_dto: (required) - :type notification_delete_all_dto: NotificationDeleteAllDto - :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._delete_notifications_serialize( - notification_delete_all_dto=notification_delete_all_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 delete_notifications_with_http_info( - self, - notification_delete_all_dto: NotificationDeleteAllDto, - _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]: - """Delete notifications - - Delete a list of notifications at once. - - :param notification_delete_all_dto: (required) - :type notification_delete_all_dto: NotificationDeleteAllDto - :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._delete_notifications_serialize( - notification_delete_all_dto=notification_delete_all_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 delete_notifications_without_preload_content( - self, - notification_delete_all_dto: NotificationDeleteAllDto, - _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: - """Delete notifications - - Delete a list of notifications at once. - - :param notification_delete_all_dto: (required) - :type notification_delete_all_dto: NotificationDeleteAllDto - :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._delete_notifications_serialize( - notification_delete_all_dto=notification_delete_all_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 _delete_notifications_serialize( - self, - notification_delete_all_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 notification_delete_all_dto is not None: - _body_params = notification_delete_all_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='DELETE', - resource_path='/notifications', - 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_notification( - self, - id: UUID, - _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, - ) -> NotificationDto: - """Get a notification - - Retrieve a specific notification identified by id. - - :param id: (required) - :type id: UUID - :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_notification_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "NotificationDto", - } - 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_notification_with_http_info( - self, - id: UUID, - _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[NotificationDto]: - """Get a notification - - Retrieve a specific notification identified by id. - - :param id: (required) - :type id: UUID - :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_notification_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "NotificationDto", - } - 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_notification_without_preload_content( - self, - id: UUID, - _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: - """Get a notification - - Retrieve a specific notification identified by id. - - :param id: (required) - :type id: UUID - :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_notification_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "NotificationDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_notification_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/notifications/{id}', - 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_notifications( - self, - id: Annotated[Optional[UUID], Field(description="Filter by notification ID")] = None, - level: Optional[NotificationLevel] = None, - type: Optional[NotificationType] = None, - unread: Annotated[Optional[StrictBool], Field(description="Filter by unread status")] = 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[NotificationDto]: - """Retrieve notifications - - Retrieve a list of notifications. - - :param id: Filter by notification ID - :type id: UUID - :param level: - :type level: NotificationLevel - :param type: - :type type: NotificationType - :param unread: Filter by unread status - :type unread: 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_notifications_serialize( - id=id, - level=level, - type=type, - unread=unread, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[NotificationDto]", - } - 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_notifications_with_http_info( - self, - id: Annotated[Optional[UUID], Field(description="Filter by notification ID")] = None, - level: Optional[NotificationLevel] = None, - type: Optional[NotificationType] = None, - unread: Annotated[Optional[StrictBool], Field(description="Filter by unread status")] = 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[NotificationDto]]: - """Retrieve notifications - - Retrieve a list of notifications. - - :param id: Filter by notification ID - :type id: UUID - :param level: - :type level: NotificationLevel - :param type: - :type type: NotificationType - :param unread: Filter by unread status - :type unread: 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_notifications_serialize( - id=id, - level=level, - type=type, - unread=unread, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[NotificationDto]", - } - 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_notifications_without_preload_content( - self, - id: Annotated[Optional[UUID], Field(description="Filter by notification ID")] = None, - level: Optional[NotificationLevel] = None, - type: Optional[NotificationType] = None, - unread: Annotated[Optional[StrictBool], Field(description="Filter by unread status")] = 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 notifications - - Retrieve a list of notifications. - - :param id: Filter by notification ID - :type id: UUID - :param level: - :type level: NotificationLevel - :param type: - :type type: NotificationType - :param unread: Filter by unread status - :type unread: 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_notifications_serialize( - id=id, - level=level, - type=type, - unread=unread, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[NotificationDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_notifications_serialize( - self, - id, - level, - type, - unread, - _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 id is not None: - - _query_params.append(('id', id)) - - if level is not None: - - _query_params.append(('level', level.value)) - - if type is not None: - - _query_params.append(('type', type.value)) - - if unread is not None: - - _query_params.append(('unread', unread)) - - # 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='/notifications', - 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 update_notification( - self, - id: UUID, - notification_update_dto: NotificationUpdateDto, - _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, - ) -> NotificationDto: - """Update a notification - - Update a specific notification to set its read status. - - :param id: (required) - :type id: UUID - :param notification_update_dto: (required) - :type notification_update_dto: NotificationUpdateDto - :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._update_notification_serialize( - id=id, - notification_update_dto=notification_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "NotificationDto", - } - 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 update_notification_with_http_info( - self, - id: UUID, - notification_update_dto: NotificationUpdateDto, - _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[NotificationDto]: - """Update a notification - - Update a specific notification to set its read status. - - :param id: (required) - :type id: UUID - :param notification_update_dto: (required) - :type notification_update_dto: NotificationUpdateDto - :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._update_notification_serialize( - id=id, - notification_update_dto=notification_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "NotificationDto", - } - 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 update_notification_without_preload_content( - self, - id: UUID, - notification_update_dto: NotificationUpdateDto, - _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: - """Update a notification - - Update a specific notification to set its read status. - - :param id: (required) - :type id: UUID - :param notification_update_dto: (required) - :type notification_update_dto: NotificationUpdateDto - :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._update_notification_serialize( - id=id, - notification_update_dto=notification_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "NotificationDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_notification_serialize( - self, - id, - notification_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if notification_update_dto is not None: - _body_params = notification_update_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='/notifications/{id}', - 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 update_notifications( - self, - notification_update_all_dto: NotificationUpdateAllDto, - _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: - """Update notifications - - Update a list of notifications. Allows to bulk-set the read status of notifications. - - :param notification_update_all_dto: (required) - :type notification_update_all_dto: NotificationUpdateAllDto - :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._update_notifications_serialize( - notification_update_all_dto=notification_update_all_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 update_notifications_with_http_info( - self, - notification_update_all_dto: NotificationUpdateAllDto, - _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]: - """Update notifications - - Update a list of notifications. Allows to bulk-set the read status of notifications. - - :param notification_update_all_dto: (required) - :type notification_update_all_dto: NotificationUpdateAllDto - :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._update_notifications_serialize( - notification_update_all_dto=notification_update_all_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 update_notifications_without_preload_content( - self, - notification_update_all_dto: NotificationUpdateAllDto, - _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: - """Update notifications - - Update a list of notifications. Allows to bulk-set the read status of notifications. - - :param notification_update_all_dto: (required) - :type notification_update_all_dto: NotificationUpdateAllDto - :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._update_notifications_serialize( - notification_update_all_dto=notification_update_all_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 _update_notifications_serialize( - self, - notification_update_all_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 notification_update_all_dto is not None: - _body_params = notification_update_all_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='PUT', - resource_path='/notifications', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/partners_api.py b/generated/immich/openapi_client/api/partners_api.py deleted file mode 100644 index 8ceb41f..0000000 --- a/generated/immich/openapi_client/api/partners_api.py +++ /dev/null @@ -1,1395 +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 typing import List -from uuid import UUID -from generated.immich.openapi_client.models.partner_create_dto import PartnerCreateDto -from generated.immich.openapi_client.models.partner_direction import PartnerDirection -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto -from generated.immich.openapi_client.models.partner_update_dto import PartnerUpdateDto - -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 PartnersApi: - """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_partner( - self, - partner_create_dto: PartnerCreateDto, - _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, - ) -> PartnerResponseDto: - """Create a partner - - Create a new partner to share assets with. - - :param partner_create_dto: (required) - :type partner_create_dto: PartnerCreateDto - :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_partner_serialize( - partner_create_dto=partner_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - 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_partner_with_http_info( - self, - partner_create_dto: PartnerCreateDto, - _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[PartnerResponseDto]: - """Create a partner - - Create a new partner to share assets with. - - :param partner_create_dto: (required) - :type partner_create_dto: PartnerCreateDto - :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_partner_serialize( - partner_create_dto=partner_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - 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_partner_without_preload_content( - self, - partner_create_dto: PartnerCreateDto, - _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 partner - - Create a new partner to share assets with. - - :param partner_create_dto: (required) - :type partner_create_dto: PartnerCreateDto - :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_partner_serialize( - partner_create_dto=partner_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_partner_serialize( - self, - partner_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 partner_create_dto is not None: - _body_params = partner_create_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='/partners', - 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 create_partner_deprecated( - self, - id: UUID, - _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, - ) -> PartnerResponseDto: - """(Deprecated) Create a partner - - Create a new partner to share assets with. - - :param id: (required) - :type id: UUID - :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("POST /partners/{id} is deprecated.", DeprecationWarning) - - _param = self._create_partner_deprecated_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - 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_partner_deprecated_with_http_info( - self, - id: UUID, - _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[PartnerResponseDto]: - """(Deprecated) Create a partner - - Create a new partner to share assets with. - - :param id: (required) - :type id: UUID - :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("POST /partners/{id} is deprecated.", DeprecationWarning) - - _param = self._create_partner_deprecated_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - 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_partner_deprecated_without_preload_content( - self, - id: UUID, - _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) Create a partner - - Create a new partner to share assets with. - - :param id: (required) - :type id: UUID - :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("POST /partners/{id} is deprecated.", DeprecationWarning) - - _param = self._create_partner_deprecated_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PartnerResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_partner_deprecated_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/partners/{id}', - 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_partners( - self, - direction: PartnerDirection, - _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[PartnerResponseDto]: - """Retrieve partners - - Retrieve a list of partners with whom assets are shared. - - :param direction: (required) - :type direction: PartnerDirection - :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_partners_serialize( - direction=direction, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PartnerResponseDto]", - } - 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_partners_with_http_info( - self, - direction: PartnerDirection, - _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[PartnerResponseDto]]: - """Retrieve partners - - Retrieve a list of partners with whom assets are shared. - - :param direction: (required) - :type direction: PartnerDirection - :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_partners_serialize( - direction=direction, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PartnerResponseDto]", - } - 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_partners_without_preload_content( - self, - direction: PartnerDirection, - _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 partners - - Retrieve a list of partners with whom assets are shared. - - :param direction: (required) - :type direction: PartnerDirection - :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_partners_serialize( - direction=direction, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PartnerResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_partners_serialize( - self, - direction, - _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 direction is not None: - - _query_params.append(('direction', direction.value)) - - # 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='/partners', - 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 remove_partner( - self, - id: UUID, - _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: - """Remove a partner - - Stop sharing assets with a partner. - - :param id: (required) - :type id: UUID - :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._remove_partner_serialize( - id=id, - _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 remove_partner_with_http_info( - self, - id: UUID, - _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]: - """Remove a partner - - Stop sharing assets with a partner. - - :param id: (required) - :type id: UUID - :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._remove_partner_serialize( - id=id, - _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 remove_partner_without_preload_content( - self, - id: UUID, - _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: - """Remove a partner - - Stop sharing assets with a partner. - - :param id: (required) - :type id: UUID - :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._remove_partner_serialize( - id=id, - _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 _remove_partner_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/partners/{id}', - 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 update_partner( - self, - id: UUID, - partner_update_dto: PartnerUpdateDto, - _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, - ) -> PartnerResponseDto: - """Update a partner - - Specify whether a partner's assets should appear in the user's timeline. - - :param id: (required) - :type id: UUID - :param partner_update_dto: (required) - :type partner_update_dto: PartnerUpdateDto - :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._update_partner_serialize( - id=id, - partner_update_dto=partner_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PartnerResponseDto", - } - 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 update_partner_with_http_info( - self, - id: UUID, - partner_update_dto: PartnerUpdateDto, - _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[PartnerResponseDto]: - """Update a partner - - Specify whether a partner's assets should appear in the user's timeline. - - :param id: (required) - :type id: UUID - :param partner_update_dto: (required) - :type partner_update_dto: PartnerUpdateDto - :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._update_partner_serialize( - id=id, - partner_update_dto=partner_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PartnerResponseDto", - } - 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 update_partner_without_preload_content( - self, - id: UUID, - partner_update_dto: PartnerUpdateDto, - _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: - """Update a partner - - Specify whether a partner's assets should appear in the user's timeline. - - :param id: (required) - :type id: UUID - :param partner_update_dto: (required) - :type partner_update_dto: PartnerUpdateDto - :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._update_partner_serialize( - id=id, - partner_update_dto=partner_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PartnerResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_partner_serialize( - self, - id, - partner_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if partner_update_dto is not None: - _body_params = partner_update_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='/partners/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/people_api.py b/generated/immich/openapi_client/api/people_api.py deleted file mode 100644 index ce8b2e9..0000000 --- a/generated/immich/openapi_client/api/people_api.py +++ /dev/null @@ -1,3124 +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 Field, StrictBool, StrictBytes, StrictStr -from typing import List, Optional, Tuple, Union -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.asset_face_update_dto import AssetFaceUpdateDto -from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto -from generated.immich.openapi_client.models.merge_person_dto import MergePersonDto -from generated.immich.openapi_client.models.people_response_dto import PeopleResponseDto -from generated.immich.openapi_client.models.people_update_dto import PeopleUpdateDto -from generated.immich.openapi_client.models.person_create_dto import PersonCreateDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto -from generated.immich.openapi_client.models.person_statistics_response_dto import PersonStatisticsResponseDto -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto - -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 PeopleApi: - """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_person( - self, - person_create_dto: PersonCreateDto, - _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, - ) -> PersonResponseDto: - """Create a person - - Create a new person that can have multiple faces assigned to them. - - :param person_create_dto: (required) - :type person_create_dto: PersonCreateDto - :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_person_serialize( - person_create_dto=person_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PersonResponseDto", - } - 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_person_with_http_info( - self, - person_create_dto: PersonCreateDto, - _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[PersonResponseDto]: - """Create a person - - Create a new person that can have multiple faces assigned to them. - - :param person_create_dto: (required) - :type person_create_dto: PersonCreateDto - :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_person_serialize( - person_create_dto=person_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PersonResponseDto", - } - 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_person_without_preload_content( - self, - person_create_dto: PersonCreateDto, - _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 person - - Create a new person that can have multiple faces assigned to them. - - :param person_create_dto: (required) - :type person_create_dto: PersonCreateDto - :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_person_serialize( - person_create_dto=person_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "PersonResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_person_serialize( - self, - person_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 person_create_dto is not None: - _body_params = person_create_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='/people', - 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 delete_people( - 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, - ) -> None: - """Delete people - - Bulk delete a list of people at once. - - :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._delete_people_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]] = { - '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 delete_people_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[None]: - """Delete people - - Bulk delete a list of people at once. - - :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._delete_people_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]] = { - '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 delete_people_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: - """Delete people - - Bulk delete a list of people at once. - - :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._delete_people_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]] = { - '204': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _delete_people_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 `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='DELETE', - resource_path='/people', - 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 delete_person( - self, - id: UUID, - _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: - """Delete person - - Delete an individual person. - - :param id: (required) - :type id: UUID - :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._delete_person_serialize( - id=id, - _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 delete_person_with_http_info( - self, - id: UUID, - _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]: - """Delete person - - Delete an individual person. - - :param id: (required) - :type id: UUID - :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._delete_person_serialize( - id=id, - _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 delete_person_without_preload_content( - self, - id: UUID, - _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: - """Delete person - - Delete an individual person. - - :param id: (required) - :type id: UUID - :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._delete_person_serialize( - id=id, - _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 _delete_person_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/people/{id}', - 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_all_people( - self, - closest_asset_id: Annotated[Optional[UUID], Field(description="Closest asset ID for similarity search")] = None, - closest_person_id: Annotated[Optional[UUID], Field(description="Closest person ID for similarity search")] = None, - page: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Page number for pagination")] = None, - size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of items per page")] = None, - with_hidden: Annotated[Optional[StrictBool], Field(description="Include hidden people")] = 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, - ) -> PeopleResponseDto: - """Get all people - - Retrieve a list of all people. - - :param closest_asset_id: Closest asset ID for similarity search - :type closest_asset_id: UUID - :param closest_person_id: Closest person ID for similarity search - :type closest_person_id: UUID - :param page: Page number for pagination - :type page: int - :param size: Number of items per page - :type size: int - :param with_hidden: Include hidden people - :type with_hidden: 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_all_people_serialize( - closest_asset_id=closest_asset_id, - closest_person_id=closest_person_id, - page=page, - size=size, - with_hidden=with_hidden, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PeopleResponseDto", - } - 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_all_people_with_http_info( - self, - closest_asset_id: Annotated[Optional[UUID], Field(description="Closest asset ID for similarity search")] = None, - closest_person_id: Annotated[Optional[UUID], Field(description="Closest person ID for similarity search")] = None, - page: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Page number for pagination")] = None, - size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of items per page")] = None, - with_hidden: Annotated[Optional[StrictBool], Field(description="Include hidden people")] = 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[PeopleResponseDto]: - """Get all people - - Retrieve a list of all people. - - :param closest_asset_id: Closest asset ID for similarity search - :type closest_asset_id: UUID - :param closest_person_id: Closest person ID for similarity search - :type closest_person_id: UUID - :param page: Page number for pagination - :type page: int - :param size: Number of items per page - :type size: int - :param with_hidden: Include hidden people - :type with_hidden: 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_all_people_serialize( - closest_asset_id=closest_asset_id, - closest_person_id=closest_person_id, - page=page, - size=size, - with_hidden=with_hidden, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PeopleResponseDto", - } - 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_all_people_without_preload_content( - self, - closest_asset_id: Annotated[Optional[UUID], Field(description="Closest asset ID for similarity search")] = None, - closest_person_id: Annotated[Optional[UUID], Field(description="Closest person ID for similarity search")] = None, - page: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]], Field(description="Page number for pagination")] = None, - size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of items per page")] = None, - with_hidden: Annotated[Optional[StrictBool], Field(description="Include hidden people")] = 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: - """Get all people - - Retrieve a list of all people. - - :param closest_asset_id: Closest asset ID for similarity search - :type closest_asset_id: UUID - :param closest_person_id: Closest person ID for similarity search - :type closest_person_id: UUID - :param page: Page number for pagination - :type page: int - :param size: Number of items per page - :type size: int - :param with_hidden: Include hidden people - :type with_hidden: 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_all_people_serialize( - closest_asset_id=closest_asset_id, - closest_person_id=closest_person_id, - page=page, - size=size, - with_hidden=with_hidden, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PeopleResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_all_people_serialize( - self, - closest_asset_id, - closest_person_id, - page, - size, - with_hidden, - _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 closest_asset_id is not None: - - _query_params.append(('closestAssetId', closest_asset_id)) - - if closest_person_id is not None: - - _query_params.append(('closestPersonId', closest_person_id)) - - if page is not None: - - _query_params.append(('page', page)) - - if size is not None: - - _query_params.append(('size', size)) - - if with_hidden is not None: - - _query_params.append(('withHidden', with_hidden)) - - # 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='/people', - 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_person( - self, - id: UUID, - _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, - ) -> PersonResponseDto: - """Get a person - - Retrieve a person by id. - - :param id: (required) - :type id: UUID - :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_person_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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_person_with_http_info( - self, - id: UUID, - _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[PersonResponseDto]: - """Get a person - - Retrieve a person by id. - - :param id: (required) - :type id: UUID - :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_person_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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_person_without_preload_content( - self, - id: UUID, - _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: - """Get a person - - Retrieve a person by id. - - :param id: (required) - :type id: UUID - :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_person_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_person_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/people/{id}', - 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_person_statistics( - self, - id: UUID, - _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, - ) -> PersonStatisticsResponseDto: - """Get person statistics - - Retrieve statistics about a specific person. - - :param id: (required) - :type id: UUID - :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_person_statistics_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonStatisticsResponseDto", - } - 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_person_statistics_with_http_info( - self, - id: UUID, - _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[PersonStatisticsResponseDto]: - """Get person statistics - - Retrieve statistics about a specific person. - - :param id: (required) - :type id: UUID - :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_person_statistics_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonStatisticsResponseDto", - } - 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_person_statistics_without_preload_content( - self, - id: UUID, - _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: - """Get person statistics - - Retrieve statistics about a specific person. - - :param id: (required) - :type id: UUID - :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_person_statistics_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonStatisticsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_person_statistics_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/people/{id}/statistics', - 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_person_thumbnail( - self, - id: UUID, - _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: - """Get person thumbnail - - Retrieve the thumbnail file for a person. - - :param id: (required) - :type id: UUID - :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_person_thumbnail_serialize( - id=id, - _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 get_person_thumbnail_with_http_info( - self, - id: UUID, - _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]: - """Get person thumbnail - - Retrieve the thumbnail file for a person. - - :param id: (required) - :type id: UUID - :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_person_thumbnail_serialize( - id=id, - _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 get_person_thumbnail_without_preload_content( - self, - id: UUID, - _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: - """Get person thumbnail - - Retrieve the thumbnail file for a person. - - :param id: (required) - :type id: UUID - :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_person_thumbnail_serialize( - id=id, - _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 _get_person_thumbnail_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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/octet-stream' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/people/{id}/thumbnail', - 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 merge_person( - self, - id: UUID, - merge_person_dto: MergePersonDto, - _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[BulkIdResponseDto]: - """Merge people - - Merge a list of people into the person specified in the path parameter. - - :param id: (required) - :type id: UUID - :param merge_person_dto: (required) - :type merge_person_dto: MergePersonDto - :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._merge_person_serialize( - id=id, - merge_person_dto=merge_person_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - 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 merge_person_with_http_info( - self, - id: UUID, - merge_person_dto: MergePersonDto, - _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[BulkIdResponseDto]]: - """Merge people - - Merge a list of people into the person specified in the path parameter. - - :param id: (required) - :type id: UUID - :param merge_person_dto: (required) - :type merge_person_dto: MergePersonDto - :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._merge_person_serialize( - id=id, - merge_person_dto=merge_person_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - 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 merge_person_without_preload_content( - self, - id: UUID, - merge_person_dto: MergePersonDto, - _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: - """Merge people - - Merge a list of people into the person specified in the path parameter. - - :param id: (required) - :type id: UUID - :param merge_person_dto: (required) - :type merge_person_dto: MergePersonDto - :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._merge_person_serialize( - id=id, - merge_person_dto=merge_person_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _merge_person_serialize( - self, - id, - merge_person_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if merge_person_dto is not None: - _body_params = merge_person_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='/people/{id}/merge', - 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 reassign_faces( - self, - id: UUID, - asset_face_update_dto: AssetFaceUpdateDto, - _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[PersonResponseDto]: - """Reassign faces - - Bulk reassign a list of faces to a different person. - - :param id: (required) - :type id: UUID - :param asset_face_update_dto: (required) - :type asset_face_update_dto: AssetFaceUpdateDto - :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._reassign_faces_serialize( - id=id, - asset_face_update_dto=asset_face_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PersonResponseDto]", - } - 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 reassign_faces_with_http_info( - self, - id: UUID, - asset_face_update_dto: AssetFaceUpdateDto, - _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[PersonResponseDto]]: - """Reassign faces - - Bulk reassign a list of faces to a different person. - - :param id: (required) - :type id: UUID - :param asset_face_update_dto: (required) - :type asset_face_update_dto: AssetFaceUpdateDto - :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._reassign_faces_serialize( - id=id, - asset_face_update_dto=asset_face_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PersonResponseDto]", - } - 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 reassign_faces_without_preload_content( - self, - id: UUID, - asset_face_update_dto: AssetFaceUpdateDto, - _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: - """Reassign faces - - Bulk reassign a list of faces to a different person. - - :param id: (required) - :type id: UUID - :param asset_face_update_dto: (required) - :type asset_face_update_dto: AssetFaceUpdateDto - :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._reassign_faces_serialize( - id=id, - asset_face_update_dto=asset_face_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PersonResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _reassign_faces_serialize( - self, - id, - asset_face_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if asset_face_update_dto is not None: - _body_params = asset_face_update_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='/people/{id}/reassign', - 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 update_people( - self, - people_update_dto: PeopleUpdateDto, - _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[BulkIdResponseDto]: - """Update people - - Bulk update multiple people at once. - - :param people_update_dto: (required) - :type people_update_dto: PeopleUpdateDto - :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._update_people_serialize( - people_update_dto=people_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - 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 update_people_with_http_info( - self, - people_update_dto: PeopleUpdateDto, - _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[BulkIdResponseDto]]: - """Update people - - Bulk update multiple people at once. - - :param people_update_dto: (required) - :type people_update_dto: PeopleUpdateDto - :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._update_people_serialize( - people_update_dto=people_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - 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 update_people_without_preload_content( - self, - people_update_dto: PeopleUpdateDto, - _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: - """Update people - - Bulk update multiple people at once. - - :param people_update_dto: (required) - :type people_update_dto: PeopleUpdateDto - :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._update_people_serialize( - people_update_dto=people_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_people_serialize( - self, - people_update_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 people_update_dto is not None: - _body_params = people_update_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='/people', - 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 update_person( - self, - id: UUID, - person_update_dto: PersonUpdateDto, - _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, - ) -> PersonResponseDto: - """(Deprecated) Update person - - Update an individual person. - - :param id: (required) - :type id: UUID - :param person_update_dto: (required) - :type person_update_dto: PersonUpdateDto - :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 /people/{id} is deprecated.", DeprecationWarning) - - _param = self._update_person_serialize( - id=id, - person_update_dto=person_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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 update_person_with_http_info( - self, - id: UUID, - person_update_dto: PersonUpdateDto, - _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[PersonResponseDto]: - """(Deprecated) Update person - - Update an individual person. - - :param id: (required) - :type id: UUID - :param person_update_dto: (required) - :type person_update_dto: PersonUpdateDto - :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 /people/{id} is deprecated.", DeprecationWarning) - - _param = self._update_person_serialize( - id=id, - person_update_dto=person_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - 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 update_person_without_preload_content( - self, - id: UUID, - person_update_dto: PersonUpdateDto, - _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) Update person - - Update an individual person. - - :param id: (required) - :type id: UUID - :param person_update_dto: (required) - :type person_update_dto: PersonUpdateDto - :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 /people/{id} is deprecated.", DeprecationWarning) - - _param = self._update_person_serialize( - id=id, - person_update_dto=person_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PersonResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_person_serialize( - self, - id, - person_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if person_update_dto is not None: - _body_params = person_update_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='/people/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/search_api.py b/generated/immich/openapi_client/api/search_api.py index bd52c47..448ba8c 100644 --- a/generated/immich/openapi_client/api/search_api.py +++ b/generated/immich/openapi_client/api/search_api.py @@ -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) diff --git a/generated/immich/openapi_client/api/server_api.py b/generated/immich/openapi_client/api/server_api.py deleted file mode 100644 index 08c5886..0000000 --- a/generated/immich/openapi_client/api/server_api.py +++ /dev/null @@ -1,3527 +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 typing import List -from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto -from generated.immich.openapi_client.models.server_about_response_dto import ServerAboutResponseDto -from generated.immich.openapi_client.models.server_apk_links_dto import ServerApkLinksDto -from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto -from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto -from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto -from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse -from generated.immich.openapi_client.models.server_stats_response_dto import ServerStatsResponseDto -from generated.immich.openapi_client.models.server_storage_response_dto import ServerStorageResponseDto -from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto -from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto -from generated.immich.openapi_client.models.user_license import UserLicense -from generated.immich.openapi_client.models.version_check_state_response_dto import VersionCheckStateResponseDto - -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 ServerApi: - """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 delete_server_license( - 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, - ) -> None: - """Delete server product key - - Delete the currently set server product key. - - :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._delete_server_license_serialize( - _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 delete_server_license_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[None]: - """Delete server product key - - Delete the currently set server product key. - - :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._delete_server_license_serialize( - _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 delete_server_license_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: - """Delete server product key - - Delete the currently set server product key. - - :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._delete_server_license_serialize( - _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 _delete_server_license_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/server/license', - 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_about_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, - ) -> ServerAboutResponseDto: - """Get server information - - Retrieve a list of information about the server. - - :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_about_info_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerAboutResponseDto", - } - 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_about_info_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[ServerAboutResponseDto]: - """Get server information - - Retrieve a list of information about the server. - - :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_about_info_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerAboutResponseDto", - } - 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_about_info_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: - """Get server information - - Retrieve a list of information about the server. - - :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_about_info_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerAboutResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_about_info_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='/server/about', - 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_apk_links( - 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, - ) -> ServerApkLinksDto: - """Get APK links - - Retrieve links to the APKs for the current server version. - - :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_apk_links_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerApkLinksDto", - } - 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_apk_links_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[ServerApkLinksDto]: - """Get APK links - - Retrieve links to the APKs for the current server version. - - :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_apk_links_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerApkLinksDto", - } - 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_apk_links_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: - """Get APK links - - Retrieve links to the APKs for the current server version. - - :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_apk_links_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerApkLinksDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_apk_links_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='/server/apk-links', - 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_server_config( - 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, - ) -> ServerConfigDto: - """Get config - - Retrieve the current server configuration. - - :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_server_config_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerConfigDto", - } - 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_server_config_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[ServerConfigDto]: - """Get config - - Retrieve the current server configuration. - - :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_server_config_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerConfigDto", - } - 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_server_config_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: - """Get config - - Retrieve the current server configuration. - - :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_server_config_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerConfigDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_server_config_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] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/server/config', - 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_server_features( - 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, - ) -> ServerFeaturesDto: - """Get features - - Retrieve available features supported by this server. - - :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_server_features_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerFeaturesDto", - } - 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_server_features_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[ServerFeaturesDto]: - """Get features - - Retrieve available features supported by this server. - - :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_server_features_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerFeaturesDto", - } - 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_server_features_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: - """Get features - - Retrieve available features supported by this server. - - :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_server_features_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerFeaturesDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_server_features_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] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/server/features', - 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_server_license( - 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, - ) -> UserLicense: - """Get product key - - Retrieve information about whether the server currently has a product key registered. - - :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_server_license_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - '404': 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 get_server_license_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[UserLicense]: - """Get product key - - Retrieve information about whether the server currently has a product key registered. - - :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_server_license_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - '404': 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 get_server_license_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: - """Get product key - - Retrieve information about whether the server currently has a product key registered. - - :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_server_license_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - '404': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_server_license_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='/server/license', - 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_server_statistics( - 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, - ) -> ServerStatsResponseDto: - """Get statistics - - Retrieve statistics about the entire Immich instance such as asset counts. - - :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_server_statistics_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerStatsResponseDto", - } - 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_server_statistics_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[ServerStatsResponseDto]: - """Get statistics - - Retrieve statistics about the entire Immich instance such as asset counts. - - :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_server_statistics_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerStatsResponseDto", - } - 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_server_statistics_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: - """Get statistics - - Retrieve statistics about the entire Immich instance such as asset counts. - - :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_server_statistics_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerStatsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_server_statistics_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='/server/statistics', - 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_server_version( - 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, - ) -> ServerVersionResponseDto: - """Get server version - - Retrieve the current server version in semantic versioning (semver) format. - - :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_server_version_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerVersionResponseDto", - } - 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_server_version_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[ServerVersionResponseDto]: - """Get server version - - Retrieve the current server version in semantic versioning (semver) format. - - :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_server_version_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerVersionResponseDto", - } - 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_server_version_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: - """Get server version - - Retrieve the current server version in semantic versioning (semver) format. - - :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_server_version_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerVersionResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_server_version_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] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/server/version', - 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_storage( - 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, - ) -> ServerStorageResponseDto: - """Get storage - - Retrieve the current storage utilization information of the server. - - :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_storage_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerStorageResponseDto", - } - 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_storage_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[ServerStorageResponseDto]: - """Get storage - - Retrieve the current storage utilization information of the server. - - :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_storage_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerStorageResponseDto", - } - 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_storage_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: - """Get storage - - Retrieve the current storage utilization information of the server. - - :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_storage_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerStorageResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_storage_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='/server/storage', - 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_supported_media_types( - 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, - ) -> ServerMediaTypesResponseDto: - """Get supported media types - - Retrieve all media types supported by the server. - - :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_supported_media_types_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerMediaTypesResponseDto", - } - 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_supported_media_types_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[ServerMediaTypesResponseDto]: - """Get supported media types - - Retrieve all media types supported by the server. - - :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_supported_media_types_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerMediaTypesResponseDto", - } - 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_supported_media_types_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: - """Get supported media types - - Retrieve all media types supported by the server. - - :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_supported_media_types_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerMediaTypesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_supported_media_types_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] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/server/media-types', - 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_version_check( - 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, - ) -> VersionCheckStateResponseDto: - """Get version check status - - Retrieve information about the last time the version check ran. - - :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_version_check_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "VersionCheckStateResponseDto", - } - 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_version_check_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[VersionCheckStateResponseDto]: - """Get version check status - - Retrieve information about the last time the version check ran. - - :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_version_check_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "VersionCheckStateResponseDto", - } - 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_version_check_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: - """Get version check status - - Retrieve information about the last time the version check ran. - - :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_version_check_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "VersionCheckStateResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_version_check_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='/server/version-check', - 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_version_history( - 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, - ) -> List[ServerVersionHistoryResponseDto]: - """Get version history - - Retrieve a list of past versions the server has been on. - - :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_version_history_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ServerVersionHistoryResponseDto]", - } - 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_version_history_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[List[ServerVersionHistoryResponseDto]]: - """Get version history - - Retrieve a list of past versions the server has been on. - - :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_version_history_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ServerVersionHistoryResponseDto]", - } - 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_version_history_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: - """Get version history - - Retrieve a list of past versions the server has been on. - - :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_version_history_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ServerVersionHistoryResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_version_history_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] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/server/version-history', - 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 ping_server( - 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, - ) -> ServerPingResponse: - """Ping - - Pong - - :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._ping_server_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerPingResponse", - } - 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 ping_server_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[ServerPingResponse]: - """Ping - - Pong - - :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._ping_server_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerPingResponse", - } - 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 ping_server_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: - """Ping - - Pong - - :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._ping_server_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ServerPingResponse", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _ping_server_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] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/server/ping', - 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 set_server_license( - self, - license_key_dto: LicenseKeyDto, - _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, - ) -> UserLicense: - """Set server product key - - Validate and set the server product key if successful. - - :param license_key_dto: (required) - :type license_key_dto: LicenseKeyDto - :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._set_server_license_serialize( - license_key_dto=license_key_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - 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 set_server_license_with_http_info( - self, - license_key_dto: LicenseKeyDto, - _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[UserLicense]: - """Set server product key - - Validate and set the server product key if successful. - - :param license_key_dto: (required) - :type license_key_dto: LicenseKeyDto - :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._set_server_license_serialize( - license_key_dto=license_key_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - 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 set_server_license_without_preload_content( - self, - license_key_dto: LicenseKeyDto, - _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: - """Set server product key - - Validate and set the server product key if successful. - - :param license_key_dto: (required) - :type license_key_dto: LicenseKeyDto - :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._set_server_license_serialize( - license_key_dto=license_key_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _set_server_license_serialize( - self, - license_key_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 license_key_dto is not None: - _body_params = license_key_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='/server/license', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/sessions_api.py b/generated/immich/openapi_client/api/sessions_api.py deleted file mode 100644 index 60ddcbf..0000000 --- a/generated/immich/openapi_client/api/sessions_api.py +++ /dev/null @@ -1,1612 +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 typing import List -from uuid import UUID -from generated.immich.openapi_client.models.session_create_dto import SessionCreateDto -from generated.immich.openapi_client.models.session_create_response_dto import SessionCreateResponseDto -from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto -from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto - -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 SessionsApi: - """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_session( - self, - session_create_dto: SessionCreateDto, - _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, - ) -> SessionCreateResponseDto: - """Create a session - - Create a session as a child to the current session. This endpoint is used for casting. - - :param session_create_dto: (required) - :type session_create_dto: SessionCreateDto - :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_session_serialize( - session_create_dto=session_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "SessionCreateResponseDto", - } - 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_session_with_http_info( - self, - session_create_dto: SessionCreateDto, - _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[SessionCreateResponseDto]: - """Create a session - - Create a session as a child to the current session. This endpoint is used for casting. - - :param session_create_dto: (required) - :type session_create_dto: SessionCreateDto - :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_session_serialize( - session_create_dto=session_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "SessionCreateResponseDto", - } - 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_session_without_preload_content( - self, - session_create_dto: SessionCreateDto, - _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 session - - Create a session as a child to the current session. This endpoint is used for casting. - - :param session_create_dto: (required) - :type session_create_dto: SessionCreateDto - :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_session_serialize( - session_create_dto=session_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "SessionCreateResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_session_serialize( - self, - session_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 session_create_dto is not None: - _body_params = session_create_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='/sessions', - 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 delete_all_sessions( - 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, - ) -> None: - """Delete all sessions - - Delete all sessions for the user. This will not delete the current session. - - :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._delete_all_sessions_serialize( - _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 delete_all_sessions_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[None]: - """Delete all sessions - - Delete all sessions for the user. This will not delete the current session. - - :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._delete_all_sessions_serialize( - _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 delete_all_sessions_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: - """Delete all sessions - - Delete all sessions for the user. This will not delete the current session. - - :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._delete_all_sessions_serialize( - _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 _delete_all_sessions_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/sessions', - 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 delete_session( - self, - id: UUID, - _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: - """Delete a session - - Delete a specific session by id. - - :param id: (required) - :type id: UUID - :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._delete_session_serialize( - id=id, - _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 delete_session_with_http_info( - self, - id: UUID, - _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]: - """Delete a session - - Delete a specific session by id. - - :param id: (required) - :type id: UUID - :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._delete_session_serialize( - id=id, - _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 delete_session_without_preload_content( - self, - id: UUID, - _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: - """Delete a session - - Delete a specific session by id. - - :param id: (required) - :type id: UUID - :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._delete_session_serialize( - id=id, - _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 _delete_session_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/sessions/{id}', - 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_sessions( - 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, - ) -> List[SessionResponseDto]: - """Retrieve sessions - - Retrieve a list of sessions for the user. - - :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_sessions_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SessionResponseDto]", - } - 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_sessions_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[List[SessionResponseDto]]: - """Retrieve sessions - - Retrieve a list of sessions for the user. - - :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_sessions_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SessionResponseDto]", - } - 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_sessions_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: - """Retrieve sessions - - Retrieve a list of sessions for the user. - - :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_sessions_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SessionResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_sessions_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='/sessions', - 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 lock_session( - self, - id: UUID, - _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: - """Lock a session - - Lock a specific session by id. - - :param id: (required) - :type id: UUID - :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._lock_session_serialize( - id=id, - _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 lock_session_with_http_info( - self, - id: UUID, - _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]: - """Lock a session - - Lock a specific session by id. - - :param id: (required) - :type id: UUID - :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._lock_session_serialize( - id=id, - _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 lock_session_without_preload_content( - self, - id: UUID, - _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: - """Lock a session - - Lock a specific session by id. - - :param id: (required) - :type id: UUID - :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._lock_session_serialize( - id=id, - _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 _lock_session_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/sessions/{id}/lock', - 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 update_session( - self, - id: UUID, - session_update_dto: SessionUpdateDto, - _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, - ) -> SessionResponseDto: - """(Deprecated) Update a session - - Update a specific session identified by id. - - :param id: (required) - :type id: UUID - :param session_update_dto: (required) - :type session_update_dto: SessionUpdateDto - :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 /sessions/{id} is deprecated.", DeprecationWarning) - - _param = self._update_session_serialize( - id=id, - session_update_dto=session_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionResponseDto", - } - 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 update_session_with_http_info( - self, - id: UUID, - session_update_dto: SessionUpdateDto, - _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[SessionResponseDto]: - """(Deprecated) Update a session - - Update a specific session identified by id. - - :param id: (required) - :type id: UUID - :param session_update_dto: (required) - :type session_update_dto: SessionUpdateDto - :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 /sessions/{id} is deprecated.", DeprecationWarning) - - _param = self._update_session_serialize( - id=id, - session_update_dto=session_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionResponseDto", - } - 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 update_session_without_preload_content( - self, - id: UUID, - session_update_dto: SessionUpdateDto, - _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) Update a session - - Update a specific session identified by id. - - :param id: (required) - :type id: UUID - :param session_update_dto: (required) - :type session_update_dto: SessionUpdateDto - :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 /sessions/{id} is deprecated.", DeprecationWarning) - - _param = self._update_session_serialize( - id=id, - session_update_dto=session_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_session_serialize( - self, - id, - session_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if session_update_dto is not None: - _body_params = session_update_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='/sessions/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/shared_links_api.py b/generated/immich/openapi_client/api/shared_links_api.py deleted file mode 100644 index 6816b73..0000000 --- a/generated/immich/openapi_client/api/shared_links_api.py +++ /dev/null @@ -1,2587 +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 Field, StrictStr -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto -from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto -from generated.immich.openapi_client.models.shared_link_create_dto import SharedLinkCreateDto -from generated.immich.openapi_client.models.shared_link_edit_dto import SharedLinkEditDto -from generated.immich.openapi_client.models.shared_link_login_dto import SharedLinkLoginDto -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto - -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 SharedLinksApi: - """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 add_shared_link_assets( - self, - id: UUID, - asset_ids_dto: AssetIdsDto, - _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[AssetIdsResponseDto]: - """Add assets to a shared link - - Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - - :param id: (required) - :type id: UUID - :param asset_ids_dto: (required) - :type asset_ids_dto: AssetIdsDto - :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._add_shared_link_assets_serialize( - id=id, - asset_ids_dto=asset_ids_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetIdsResponseDto]", - } - 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 add_shared_link_assets_with_http_info( - self, - id: UUID, - asset_ids_dto: AssetIdsDto, - _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[AssetIdsResponseDto]]: - """Add assets to a shared link - - Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - - :param id: (required) - :type id: UUID - :param asset_ids_dto: (required) - :type asset_ids_dto: AssetIdsDto - :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._add_shared_link_assets_serialize( - id=id, - asset_ids_dto=asset_ids_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetIdsResponseDto]", - } - 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 add_shared_link_assets_without_preload_content( - self, - id: UUID, - asset_ids_dto: AssetIdsDto, - _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: - """Add assets to a shared link - - Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - - :param id: (required) - :type id: UUID - :param asset_ids_dto: (required) - :type asset_ids_dto: AssetIdsDto - :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._add_shared_link_assets_serialize( - id=id, - asset_ids_dto=asset_ids_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetIdsResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _add_shared_link_assets_serialize( - self, - id, - asset_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 - if id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if asset_ids_dto is not None: - _body_params = asset_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='PUT', - resource_path='/shared-links/{id}/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 create_shared_link( - self, - shared_link_create_dto: SharedLinkCreateDto, - _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, - ) -> SharedLinkResponseDto: - """Create a shared link - - Create a new shared link. - - :param shared_link_create_dto: (required) - :type shared_link_create_dto: SharedLinkCreateDto - :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_shared_link_serialize( - shared_link_create_dto=shared_link_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "SharedLinkResponseDto", - } - 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_shared_link_with_http_info( - self, - shared_link_create_dto: SharedLinkCreateDto, - _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[SharedLinkResponseDto]: - """Create a shared link - - Create a new shared link. - - :param shared_link_create_dto: (required) - :type shared_link_create_dto: SharedLinkCreateDto - :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_shared_link_serialize( - shared_link_create_dto=shared_link_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "SharedLinkResponseDto", - } - 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_shared_link_without_preload_content( - self, - shared_link_create_dto: SharedLinkCreateDto, - _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 shared link - - Create a new shared link. - - :param shared_link_create_dto: (required) - :type shared_link_create_dto: SharedLinkCreateDto - :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_shared_link_serialize( - shared_link_create_dto=shared_link_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "SharedLinkResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_shared_link_serialize( - self, - shared_link_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 shared_link_create_dto is not None: - _body_params = shared_link_create_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='/shared-links', - 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_all_shared_links( - self, - album_id: Annotated[Optional[UUID], Field(description="Filter by album ID")] = None, - id: Annotated[Optional[UUID], Field(description="Filter by shared link ID")] = 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[SharedLinkResponseDto]: - """Retrieve all shared links - - Retrieve a list of all shared links. - - :param album_id: Filter by album ID - :type album_id: UUID - :param id: Filter by shared link ID - :type id: UUID - :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_all_shared_links_serialize( - album_id=album_id, - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SharedLinkResponseDto]", - } - 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_all_shared_links_with_http_info( - self, - album_id: Annotated[Optional[UUID], Field(description="Filter by album ID")] = None, - id: Annotated[Optional[UUID], Field(description="Filter by shared link ID")] = 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[SharedLinkResponseDto]]: - """Retrieve all shared links - - Retrieve a list of all shared links. - - :param album_id: Filter by album ID - :type album_id: UUID - :param id: Filter by shared link ID - :type id: UUID - :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_all_shared_links_serialize( - album_id=album_id, - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SharedLinkResponseDto]", - } - 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_all_shared_links_without_preload_content( - self, - album_id: Annotated[Optional[UUID], Field(description="Filter by album ID")] = None, - id: Annotated[Optional[UUID], Field(description="Filter by shared link ID")] = 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 all shared links - - Retrieve a list of all shared links. - - :param album_id: Filter by album ID - :type album_id: UUID - :param id: Filter by shared link ID - :type id: UUID - :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_all_shared_links_serialize( - album_id=album_id, - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SharedLinkResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_all_shared_links_serialize( - self, - album_id, - id, - _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 album_id is not None: - - _query_params.append(('albumId', album_id)) - - if id is not None: - - _query_params.append(('id', id)) - - # 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='/shared-links', - 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_my_shared_link( - self, - 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, - ) -> SharedLinkResponseDto: - """Retrieve current shared link - - Retrieve the current shared link associated with authentication method. - - :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_my_shared_link_serialize( - 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': "SharedLinkResponseDto", - } - 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_my_shared_link_with_http_info( - self, - 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[SharedLinkResponseDto]: - """Retrieve current shared link - - Retrieve the current shared link associated with authentication method. - - :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_my_shared_link_serialize( - 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': "SharedLinkResponseDto", - } - 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_my_shared_link_without_preload_content( - self, - 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 current shared link - - Retrieve the current shared link associated with authentication method. - - :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_my_shared_link_serialize( - 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': "SharedLinkResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_my_shared_link_serialize( - self, - 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 - - - # 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='/shared-links/me', - 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_shared_link_by_id( - self, - id: UUID, - _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, - ) -> SharedLinkResponseDto: - """Retrieve a shared link - - Retrieve a specific shared link by its ID. - - :param id: (required) - :type id: UUID - :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_shared_link_by_id_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SharedLinkResponseDto", - } - 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_shared_link_by_id_with_http_info( - self, - id: UUID, - _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[SharedLinkResponseDto]: - """Retrieve a shared link - - Retrieve a specific shared link by its ID. - - :param id: (required) - :type id: UUID - :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_shared_link_by_id_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SharedLinkResponseDto", - } - 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_shared_link_by_id_without_preload_content( - self, - id: UUID, - _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 a shared link - - Retrieve a specific shared link by its ID. - - :param id: (required) - :type id: UUID - :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_shared_link_by_id_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SharedLinkResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_shared_link_by_id_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/shared-links/{id}', - 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 remove_shared_link( - self, - id: UUID, - _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: - """Delete a shared link - - Delete a specific shared link by its ID. - - :param id: (required) - :type id: UUID - :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._remove_shared_link_serialize( - id=id, - _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 remove_shared_link_with_http_info( - self, - id: UUID, - _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]: - """Delete a shared link - - Delete a specific shared link by its ID. - - :param id: (required) - :type id: UUID - :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._remove_shared_link_serialize( - id=id, - _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 remove_shared_link_without_preload_content( - self, - id: UUID, - _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: - """Delete a shared link - - Delete a specific shared link by its ID. - - :param id: (required) - :type id: UUID - :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._remove_shared_link_serialize( - id=id, - _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 _remove_shared_link_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/shared-links/{id}', - 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 remove_shared_link_assets( - self, - id: UUID, - asset_ids_dto: AssetIdsDto, - _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[AssetIdsResponseDto]: - """Remove assets from a shared link - - Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - - :param id: (required) - :type id: UUID - :param asset_ids_dto: (required) - :type asset_ids_dto: AssetIdsDto - :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._remove_shared_link_assets_serialize( - id=id, - asset_ids_dto=asset_ids_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetIdsResponseDto]", - } - 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 remove_shared_link_assets_with_http_info( - self, - id: UUID, - asset_ids_dto: AssetIdsDto, - _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[AssetIdsResponseDto]]: - """Remove assets from a shared link - - Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - - :param id: (required) - :type id: UUID - :param asset_ids_dto: (required) - :type asset_ids_dto: AssetIdsDto - :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._remove_shared_link_assets_serialize( - id=id, - asset_ids_dto=asset_ids_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetIdsResponseDto]", - } - 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 remove_shared_link_assets_without_preload_content( - self, - id: UUID, - asset_ids_dto: AssetIdsDto, - _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: - """Remove assets from a shared link - - Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - - :param id: (required) - :type id: UUID - :param asset_ids_dto: (required) - :type asset_ids_dto: AssetIdsDto - :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._remove_shared_link_assets_serialize( - id=id, - asset_ids_dto=asset_ids_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[AssetIdsResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _remove_shared_link_assets_serialize( - self, - id, - asset_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 - if id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if asset_ids_dto is not None: - _body_params = asset_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='DELETE', - resource_path='/shared-links/{id}/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 shared_link_login( - self, - shared_link_login_dto: SharedLinkLoginDto, - 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, - ) -> SharedLinkResponseDto: - """Shared link login - - Login to a password protected shared link - - :param shared_link_login_dto: (required) - :type shared_link_login_dto: SharedLinkLoginDto - :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._shared_link_login_serialize( - shared_link_login_dto=shared_link_login_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': "SharedLinkResponseDto", - } - 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 shared_link_login_with_http_info( - self, - shared_link_login_dto: SharedLinkLoginDto, - 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[SharedLinkResponseDto]: - """Shared link login - - Login to a password protected shared link - - :param shared_link_login_dto: (required) - :type shared_link_login_dto: SharedLinkLoginDto - :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._shared_link_login_serialize( - shared_link_login_dto=shared_link_login_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': "SharedLinkResponseDto", - } - 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 shared_link_login_without_preload_content( - self, - shared_link_login_dto: SharedLinkLoginDto, - 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: - """Shared link login - - Login to a password protected shared link - - :param shared_link_login_dto: (required) - :type shared_link_login_dto: SharedLinkLoginDto - :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._shared_link_login_serialize( - shared_link_login_dto=shared_link_login_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': "SharedLinkResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _shared_link_login_serialize( - self, - shared_link_login_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 shared_link_login_dto is not None: - _body_params = shared_link_login_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='/shared-links/login', - 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 update_shared_link( - self, - id: UUID, - shared_link_edit_dto: SharedLinkEditDto, - _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, - ) -> SharedLinkResponseDto: - """Update a shared link - - Update an existing shared link by its ID. - - :param id: (required) - :type id: UUID - :param shared_link_edit_dto: (required) - :type shared_link_edit_dto: SharedLinkEditDto - :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._update_shared_link_serialize( - id=id, - shared_link_edit_dto=shared_link_edit_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SharedLinkResponseDto", - } - 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 update_shared_link_with_http_info( - self, - id: UUID, - shared_link_edit_dto: SharedLinkEditDto, - _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[SharedLinkResponseDto]: - """Update a shared link - - Update an existing shared link by its ID. - - :param id: (required) - :type id: UUID - :param shared_link_edit_dto: (required) - :type shared_link_edit_dto: SharedLinkEditDto - :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._update_shared_link_serialize( - id=id, - shared_link_edit_dto=shared_link_edit_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SharedLinkResponseDto", - } - 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 update_shared_link_without_preload_content( - self, - id: UUID, - shared_link_edit_dto: SharedLinkEditDto, - _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: - """Update a shared link - - Update an existing shared link by its ID. - - :param id: (required) - :type id: UUID - :param shared_link_edit_dto: (required) - :type shared_link_edit_dto: SharedLinkEditDto - :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._update_shared_link_serialize( - id=id, - shared_link_edit_dto=shared_link_edit_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SharedLinkResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_shared_link_serialize( - self, - id, - shared_link_edit_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if shared_link_edit_dto is not None: - _body_params = shared_link_edit_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='PATCH', - resource_path='/shared-links/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/stacks_api.py b/generated/immich/openapi_client/api/stacks_api.py deleted file mode 100644 index d107fe3..0000000 --- a/generated/immich/openapi_client/api/stacks_api.py +++ /dev/null @@ -1,1937 +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 Field -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto -from generated.immich.openapi_client.models.stack_create_dto import StackCreateDto -from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto - -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 StacksApi: - """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_stack( - self, - stack_create_dto: StackCreateDto, - _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, - ) -> StackResponseDto: - """Create a stack - - Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack. - - :param stack_create_dto: (required) - :type stack_create_dto: StackCreateDto - :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_stack_serialize( - stack_create_dto=stack_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "StackResponseDto", - } - 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_stack_with_http_info( - self, - stack_create_dto: StackCreateDto, - _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[StackResponseDto]: - """Create a stack - - Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack. - - :param stack_create_dto: (required) - :type stack_create_dto: StackCreateDto - :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_stack_serialize( - stack_create_dto=stack_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "StackResponseDto", - } - 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_stack_without_preload_content( - self, - stack_create_dto: StackCreateDto, - _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 stack - - Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack. - - :param stack_create_dto: (required) - :type stack_create_dto: StackCreateDto - :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_stack_serialize( - stack_create_dto=stack_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "StackResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_stack_serialize( - self, - stack_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 stack_create_dto is not None: - _body_params = stack_create_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='/stacks', - 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 delete_stack( - self, - id: UUID, - _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: - """Delete a stack - - Delete a specific stack by its ID. - - :param id: (required) - :type id: UUID - :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._delete_stack_serialize( - id=id, - _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 delete_stack_with_http_info( - self, - id: UUID, - _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]: - """Delete a stack - - Delete a specific stack by its ID. - - :param id: (required) - :type id: UUID - :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._delete_stack_serialize( - id=id, - _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 delete_stack_without_preload_content( - self, - id: UUID, - _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: - """Delete a stack - - Delete a specific stack by its ID. - - :param id: (required) - :type id: UUID - :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._delete_stack_serialize( - id=id, - _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 _delete_stack_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/stacks/{id}', - 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 delete_stacks( - 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, - ) -> None: - """Delete stacks - - Delete multiple stacks by providing a list of stack IDs. - - :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._delete_stacks_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]] = { - '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 delete_stacks_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[None]: - """Delete stacks - - Delete multiple stacks by providing a list of stack IDs. - - :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._delete_stacks_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]] = { - '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 delete_stacks_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: - """Delete stacks - - Delete multiple stacks by providing a list of stack IDs. - - :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._delete_stacks_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]] = { - '204': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _delete_stacks_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 `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='DELETE', - resource_path='/stacks', - 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_stack( - self, - id: UUID, - _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, - ) -> StackResponseDto: - """Retrieve a stack - - Retrieve a specific stack by its ID. - - :param id: (required) - :type id: UUID - :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_stack_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - 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_stack_with_http_info( - self, - id: UUID, - _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[StackResponseDto]: - """Retrieve a stack - - Retrieve a specific stack by its ID. - - :param id: (required) - :type id: UUID - :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_stack_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - 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_stack_without_preload_content( - self, - id: UUID, - _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 a stack - - Retrieve a specific stack by its ID. - - :param id: (required) - :type id: UUID - :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_stack_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_stack_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/stacks/{id}', - 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 remove_asset_from_stack( - self, - asset_id: UUID, - id: UUID, - _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: - """Remove an asset from a stack - - Remove a specific asset from a stack by providing the stack ID and asset ID. - - :param asset_id: (required) - :type asset_id: UUID - :param id: (required) - :type id: UUID - :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._remove_asset_from_stack_serialize( - asset_id=asset_id, - id=id, - _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 remove_asset_from_stack_with_http_info( - self, - asset_id: UUID, - id: UUID, - _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]: - """Remove an asset from a stack - - Remove a specific asset from a stack by providing the stack ID and asset ID. - - :param asset_id: (required) - :type asset_id: UUID - :param id: (required) - :type id: UUID - :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._remove_asset_from_stack_serialize( - asset_id=asset_id, - id=id, - _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 remove_asset_from_stack_without_preload_content( - self, - asset_id: UUID, - id: UUID, - _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: - """Remove an asset from a stack - - Remove a specific asset from a stack by providing the stack ID and asset ID. - - :param asset_id: (required) - :type asset_id: UUID - :param id: (required) - :type id: UUID - :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._remove_asset_from_stack_serialize( - asset_id=asset_id, - id=id, - _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 _remove_asset_from_stack_serialize( - self, - asset_id, - id, - _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 asset_id is not None: - _path_params['assetId'] = asset_id - if id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/stacks/{id}/assets/{assetId}', - 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 search_stacks( - self, - primary_asset_id: Annotated[Optional[UUID], Field(description="Filter by primary asset ID")] = 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[StackResponseDto]: - """Retrieve stacks - - Retrieve a list of stacks. - - :param primary_asset_id: Filter by primary asset ID - :type primary_asset_id: UUID - :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._search_stacks_serialize( - primary_asset_id=primary_asset_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[StackResponseDto]", - } - 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 search_stacks_with_http_info( - self, - primary_asset_id: Annotated[Optional[UUID], Field(description="Filter by primary asset ID")] = 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[StackResponseDto]]: - """Retrieve stacks - - Retrieve a list of stacks. - - :param primary_asset_id: Filter by primary asset ID - :type primary_asset_id: UUID - :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._search_stacks_serialize( - primary_asset_id=primary_asset_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[StackResponseDto]", - } - 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 search_stacks_without_preload_content( - self, - primary_asset_id: Annotated[Optional[UUID], Field(description="Filter by primary asset ID")] = 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 stacks - - Retrieve a list of stacks. - - :param primary_asset_id: Filter by primary asset ID - :type primary_asset_id: UUID - :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._search_stacks_serialize( - primary_asset_id=primary_asset_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[StackResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _search_stacks_serialize( - self, - primary_asset_id, - _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 primary_asset_id is not None: - - _query_params.append(('primaryAssetId', primary_asset_id)) - - # 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='/stacks', - 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 update_stack( - self, - id: UUID, - stack_update_dto: StackUpdateDto, - _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, - ) -> StackResponseDto: - """(Deprecated) Update a stack - - Update an existing stack by its ID. - - :param id: (required) - :type id: UUID - :param stack_update_dto: (required) - :type stack_update_dto: StackUpdateDto - :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 /stacks/{id} is deprecated.", DeprecationWarning) - - _param = self._update_stack_serialize( - id=id, - stack_update_dto=stack_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - 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 update_stack_with_http_info( - self, - id: UUID, - stack_update_dto: StackUpdateDto, - _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[StackResponseDto]: - """(Deprecated) Update a stack - - Update an existing stack by its ID. - - :param id: (required) - :type id: UUID - :param stack_update_dto: (required) - :type stack_update_dto: StackUpdateDto - :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 /stacks/{id} is deprecated.", DeprecationWarning) - - _param = self._update_stack_serialize( - id=id, - stack_update_dto=stack_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - 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 update_stack_without_preload_content( - self, - id: UUID, - stack_update_dto: StackUpdateDto, - _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) Update a stack - - Update an existing stack by its ID. - - :param id: (required) - :type id: UUID - :param stack_update_dto: (required) - :type stack_update_dto: StackUpdateDto - :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 /stacks/{id} is deprecated.", DeprecationWarning) - - _param = self._update_stack_serialize( - id=id, - stack_update_dto=stack_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StackResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_stack_serialize( - self, - id, - stack_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if stack_update_dto is not None: - _body_params = stack_update_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='/stacks/{id}', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/sync_api.py b/generated/immich/openapi_client/api/sync_api.py deleted file mode 100644 index 820d157..0000000 --- a/generated/immich/openapi_client/api/sync_api.py +++ /dev/null @@ -1,1095 +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 typing import List -from generated.immich.openapi_client.models.sync_ack_delete_dto import SyncAckDeleteDto -from generated.immich.openapi_client.models.sync_ack_dto import SyncAckDto -from generated.immich.openapi_client.models.sync_ack_set_dto import SyncAckSetDto -from generated.immich.openapi_client.models.sync_stream_dto import SyncStreamDto - -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 SyncApi: - """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 delete_sync_ack( - self, - sync_ack_delete_dto: SyncAckDeleteDto, - _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: - """Delete acknowledgements - - Delete specific synchronization acknowledgments. - - :param sync_ack_delete_dto: (required) - :type sync_ack_delete_dto: SyncAckDeleteDto - :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._delete_sync_ack_serialize( - sync_ack_delete_dto=sync_ack_delete_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 delete_sync_ack_with_http_info( - self, - sync_ack_delete_dto: SyncAckDeleteDto, - _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]: - """Delete acknowledgements - - Delete specific synchronization acknowledgments. - - :param sync_ack_delete_dto: (required) - :type sync_ack_delete_dto: SyncAckDeleteDto - :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._delete_sync_ack_serialize( - sync_ack_delete_dto=sync_ack_delete_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 delete_sync_ack_without_preload_content( - self, - sync_ack_delete_dto: SyncAckDeleteDto, - _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: - """Delete acknowledgements - - Delete specific synchronization acknowledgments. - - :param sync_ack_delete_dto: (required) - :type sync_ack_delete_dto: SyncAckDeleteDto - :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._delete_sync_ack_serialize( - sync_ack_delete_dto=sync_ack_delete_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 _delete_sync_ack_serialize( - self, - sync_ack_delete_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 sync_ack_delete_dto is not None: - _body_params = sync_ack_delete_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='DELETE', - resource_path='/sync/ack', - 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_sync_ack( - 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, - ) -> List[SyncAckDto]: - """Retrieve acknowledgements - - Retrieve the synchronization acknowledgments for the current session. - - :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_sync_ack_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SyncAckDto]", - } - 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_sync_ack_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[List[SyncAckDto]]: - """Retrieve acknowledgements - - Retrieve the synchronization acknowledgments for the current session. - - :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_sync_ack_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SyncAckDto]", - } - 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_sync_ack_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: - """Retrieve acknowledgements - - Retrieve the synchronization acknowledgments for the current session. - - :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_sync_ack_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SyncAckDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_sync_ack_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='/sync/ack', - 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_sync_stream( - self, - sync_stream_dto: SyncStreamDto, - _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: - """Stream sync changes - - Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes. - - :param sync_stream_dto: (required) - :type sync_stream_dto: SyncStreamDto - :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_sync_stream_serialize( - sync_stream_dto=sync_stream_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': 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 get_sync_stream_with_http_info( - self, - sync_stream_dto: SyncStreamDto, - _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]: - """Stream sync changes - - Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes. - - :param sync_stream_dto: (required) - :type sync_stream_dto: SyncStreamDto - :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_sync_stream_serialize( - sync_stream_dto=sync_stream_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': 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 get_sync_stream_without_preload_content( - self, - sync_stream_dto: SyncStreamDto, - _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: - """Stream sync changes - - Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes. - - :param sync_stream_dto: (required) - :type sync_stream_dto: SyncStreamDto - :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_sync_stream_serialize( - sync_stream_dto=sync_stream_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_sync_stream_serialize( - self, - sync_stream_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 sync_stream_dto is not None: - _body_params = sync_stream_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='/sync/stream', - 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 send_sync_ack( - self, - sync_ack_set_dto: SyncAckSetDto, - _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: - """Acknowledge changes - - Send a list of synchronization acknowledgements to confirm that the latest changes have been received. - - :param sync_ack_set_dto: (required) - :type sync_ack_set_dto: SyncAckSetDto - :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._send_sync_ack_serialize( - sync_ack_set_dto=sync_ack_set_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 send_sync_ack_with_http_info( - self, - sync_ack_set_dto: SyncAckSetDto, - _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]: - """Acknowledge changes - - Send a list of synchronization acknowledgements to confirm that the latest changes have been received. - - :param sync_ack_set_dto: (required) - :type sync_ack_set_dto: SyncAckSetDto - :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._send_sync_ack_serialize( - sync_ack_set_dto=sync_ack_set_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 send_sync_ack_without_preload_content( - self, - sync_ack_set_dto: SyncAckSetDto, - _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: - """Acknowledge changes - - Send a list of synchronization acknowledgements to confirm that the latest changes have been received. - - :param sync_ack_set_dto: (required) - :type sync_ack_set_dto: SyncAckSetDto - :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._send_sync_ack_serialize( - sync_ack_set_dto=sync_ack_set_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 _send_sync_ack_serialize( - self, - sync_ack_set_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 sync_ack_set_dto is not None: - _body_params = sync_ack_set_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='/sync/ack', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/system_config_api.py b/generated/immich/openapi_client/api/system_config_api.py deleted file mode 100644 index 80fc0c5..0000000 --- a/generated/immich/openapi_client/api/system_config_api.py +++ /dev/null @@ -1,1057 +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.system_config_dto import SystemConfigDto -from generated.immich.openapi_client.models.system_config_template_storage_option_dto import SystemConfigTemplateStorageOptionDto - -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 SystemConfigApi: - """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_config( - 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, - ) -> SystemConfigDto: - """Get system configuration - - Retrieve the current system configuration. - - :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_config_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - 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_config_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[SystemConfigDto]: - """Get system configuration - - Retrieve the current system configuration. - - :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_config_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - 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_config_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: - """Get system configuration - - Retrieve the current system configuration. - - :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_config_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_config_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='/system-config', - 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_config_defaults( - 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, - ) -> SystemConfigDto: - """Get system configuration defaults - - Retrieve the default values for the system configuration. - - :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_config_defaults_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - 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_config_defaults_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[SystemConfigDto]: - """Get system configuration defaults - - Retrieve the default values for the system configuration. - - :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_config_defaults_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - 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_config_defaults_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: - """Get system configuration defaults - - Retrieve the default values for the system configuration. - - :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_config_defaults_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_config_defaults_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='/system-config/defaults', - 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_storage_template_options( - 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, - ) -> SystemConfigTemplateStorageOptionDto: - """Get storage template options - - Retrieve exemplary storage template options. - - :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_storage_template_options_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigTemplateStorageOptionDto", - } - 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_storage_template_options_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[SystemConfigTemplateStorageOptionDto]: - """Get storage template options - - Retrieve exemplary storage template options. - - :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_storage_template_options_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigTemplateStorageOptionDto", - } - 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_storage_template_options_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: - """Get storage template options - - Retrieve exemplary storage template options. - - :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_storage_template_options_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigTemplateStorageOptionDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_storage_template_options_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='/system-config/storage-template-options', - 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 update_config( - self, - system_config_dto: SystemConfigDto, - _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, - ) -> SystemConfigDto: - """Update system configuration - - Update the system configuration with a new system configuration. - - :param system_config_dto: (required) - :type system_config_dto: SystemConfigDto - :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._update_config_serialize( - system_config_dto=system_config_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - 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 update_config_with_http_info( - self, - system_config_dto: SystemConfigDto, - _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[SystemConfigDto]: - """Update system configuration - - Update the system configuration with a new system configuration. - - :param system_config_dto: (required) - :type system_config_dto: SystemConfigDto - :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._update_config_serialize( - system_config_dto=system_config_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - 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 update_config_without_preload_content( - self, - system_config_dto: SystemConfigDto, - _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: - """Update system configuration - - Update the system configuration with a new system configuration. - - :param system_config_dto: (required) - :type system_config_dto: SystemConfigDto - :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._update_config_serialize( - system_config_dto=system_config_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SystemConfigDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_config_serialize( - self, - system_config_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 system_config_dto is not None: - _body_params = system_config_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='/system-config', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/system_metadata_api.py b/generated/immich/openapi_client/api/system_metadata_api.py deleted file mode 100644 index abed451..0000000 --- a/generated/immich/openapi_client/api/system_metadata_api.py +++ /dev/null @@ -1,1051 +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.admin_onboarding_update_dto import AdminOnboardingUpdateDto -from generated.immich.openapi_client.models.reverse_geocoding_state_response_dto import ReverseGeocodingStateResponseDto -from generated.immich.openapi_client.models.version_check_state_response_dto import VersionCheckStateResponseDto - -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 SystemMetadataApi: - """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_admin_onboarding( - 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, - ) -> AdminOnboardingUpdateDto: - """Retrieve admin onboarding - - Retrieve the current admin onboarding 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 - - _param = self._get_admin_onboarding_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AdminOnboardingUpdateDto", - } - 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_admin_onboarding_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[AdminOnboardingUpdateDto]: - """Retrieve admin onboarding - - Retrieve the current admin onboarding 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 - - _param = self._get_admin_onboarding_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AdminOnboardingUpdateDto", - } - 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_admin_onboarding_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: - """Retrieve admin onboarding - - Retrieve the current admin onboarding 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 - - _param = self._get_admin_onboarding_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AdminOnboardingUpdateDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_admin_onboarding_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='/system-metadata/admin-onboarding', - 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_reverse_geocoding_state( - 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, - ) -> ReverseGeocodingStateResponseDto: - """Retrieve reverse geocoding state - - Retrieve the current state of the reverse geocoding import. - - :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_reverse_geocoding_state_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ReverseGeocodingStateResponseDto", - } - 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_reverse_geocoding_state_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[ReverseGeocodingStateResponseDto]: - """Retrieve reverse geocoding state - - Retrieve the current state of the reverse geocoding import. - - :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_reverse_geocoding_state_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ReverseGeocodingStateResponseDto", - } - 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_reverse_geocoding_state_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: - """Retrieve reverse geocoding state - - Retrieve the current state of the reverse geocoding import. - - :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_reverse_geocoding_state_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ReverseGeocodingStateResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_reverse_geocoding_state_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='/system-metadata/reverse-geocoding-state', - 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_version_check_state( - 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, - ) -> VersionCheckStateResponseDto: - """Retrieve version check state - - Retrieve the current state of the version check process. - - :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_version_check_state_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "VersionCheckStateResponseDto", - } - 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_version_check_state_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[VersionCheckStateResponseDto]: - """Retrieve version check state - - Retrieve the current state of the version check process. - - :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_version_check_state_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "VersionCheckStateResponseDto", - } - 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_version_check_state_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: - """Retrieve version check state - - Retrieve the current state of the version check process. - - :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_version_check_state_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "VersionCheckStateResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_version_check_state_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='/system-metadata/version-check-state', - 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 update_admin_onboarding( - self, - admin_onboarding_update_dto: AdminOnboardingUpdateDto, - _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: - """Update admin onboarding - - Update the admin onboarding status. - - :param admin_onboarding_update_dto: (required) - :type admin_onboarding_update_dto: AdminOnboardingUpdateDto - :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._update_admin_onboarding_serialize( - admin_onboarding_update_dto=admin_onboarding_update_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 update_admin_onboarding_with_http_info( - self, - admin_onboarding_update_dto: AdminOnboardingUpdateDto, - _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]: - """Update admin onboarding - - Update the admin onboarding status. - - :param admin_onboarding_update_dto: (required) - :type admin_onboarding_update_dto: AdminOnboardingUpdateDto - :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._update_admin_onboarding_serialize( - admin_onboarding_update_dto=admin_onboarding_update_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 update_admin_onboarding_without_preload_content( - self, - admin_onboarding_update_dto: AdminOnboardingUpdateDto, - _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: - """Update admin onboarding - - Update the admin onboarding status. - - :param admin_onboarding_update_dto: (required) - :type admin_onboarding_update_dto: AdminOnboardingUpdateDto - :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._update_admin_onboarding_serialize( - admin_onboarding_update_dto=admin_onboarding_update_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 _update_admin_onboarding_serialize( - self, - admin_onboarding_update_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 admin_onboarding_update_dto is not None: - _body_params = admin_onboarding_update_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='/system-metadata/admin-onboarding', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/tags_api.py b/generated/immich/openapi_client/api/tags_api.py deleted file mode 100644 index 6a3cd9f..0000000 --- a/generated/immich/openapi_client/api/tags_api.py +++ /dev/null @@ -1,2516 +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 typing import List -from uuid import UUID -from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto -from generated.immich.openapi_client.models.tag_bulk_assets_dto import TagBulkAssetsDto -from generated.immich.openapi_client.models.tag_bulk_assets_response_dto import TagBulkAssetsResponseDto -from generated.immich.openapi_client.models.tag_create_dto import TagCreateDto -from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto -from generated.immich.openapi_client.models.tag_upsert_dto import TagUpsertDto - -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 TagsApi: - """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 bulk_tag_assets( - self, - tag_bulk_assets_dto: TagBulkAssetsDto, - _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, - ) -> TagBulkAssetsResponseDto: - """Tag assets - - Add multiple tags to multiple assets in a single request. - - :param tag_bulk_assets_dto: (required) - :type tag_bulk_assets_dto: TagBulkAssetsDto - :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._bulk_tag_assets_serialize( - tag_bulk_assets_dto=tag_bulk_assets_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagBulkAssetsResponseDto", - } - 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 bulk_tag_assets_with_http_info( - self, - tag_bulk_assets_dto: TagBulkAssetsDto, - _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[TagBulkAssetsResponseDto]: - """Tag assets - - Add multiple tags to multiple assets in a single request. - - :param tag_bulk_assets_dto: (required) - :type tag_bulk_assets_dto: TagBulkAssetsDto - :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._bulk_tag_assets_serialize( - tag_bulk_assets_dto=tag_bulk_assets_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagBulkAssetsResponseDto", - } - 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 bulk_tag_assets_without_preload_content( - self, - tag_bulk_assets_dto: TagBulkAssetsDto, - _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: - """Tag assets - - Add multiple tags to multiple assets in a single request. - - :param tag_bulk_assets_dto: (required) - :type tag_bulk_assets_dto: TagBulkAssetsDto - :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._bulk_tag_assets_serialize( - tag_bulk_assets_dto=tag_bulk_assets_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagBulkAssetsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _bulk_tag_assets_serialize( - self, - tag_bulk_assets_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 tag_bulk_assets_dto is not None: - _body_params = tag_bulk_assets_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='/tags/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 create_tag( - self, - tag_create_dto: TagCreateDto, - _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, - ) -> TagResponseDto: - """Create a tag - - Create a new tag by providing a name and optional color. - - :param tag_create_dto: (required) - :type tag_create_dto: TagCreateDto - :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_tag_serialize( - tag_create_dto=tag_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "TagResponseDto", - } - 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_tag_with_http_info( - self, - tag_create_dto: TagCreateDto, - _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[TagResponseDto]: - """Create a tag - - Create a new tag by providing a name and optional color. - - :param tag_create_dto: (required) - :type tag_create_dto: TagCreateDto - :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_tag_serialize( - tag_create_dto=tag_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "TagResponseDto", - } - 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_tag_without_preload_content( - self, - tag_create_dto: TagCreateDto, - _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 tag - - Create a new tag by providing a name and optional color. - - :param tag_create_dto: (required) - :type tag_create_dto: TagCreateDto - :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_tag_serialize( - tag_create_dto=tag_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "TagResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_tag_serialize( - self, - tag_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 tag_create_dto is not None: - _body_params = tag_create_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='/tags', - 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 delete_tag( - self, - id: UUID, - _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: - """Delete a tag - - Delete a specific tag by its ID. - - :param id: (required) - :type id: UUID - :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._delete_tag_serialize( - id=id, - _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 delete_tag_with_http_info( - self, - id: UUID, - _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]: - """Delete a tag - - Delete a specific tag by its ID. - - :param id: (required) - :type id: UUID - :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._delete_tag_serialize( - id=id, - _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 delete_tag_without_preload_content( - self, - id: UUID, - _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: - """Delete a tag - - Delete a specific tag by its ID. - - :param id: (required) - :type id: UUID - :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._delete_tag_serialize( - id=id, - _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 _delete_tag_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/tags/{id}', - 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_all_tags( - 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, - ) -> List[TagResponseDto]: - """Retrieve tags - - Retrieve a list of all tags. - - :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_all_tags_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TagResponseDto]", - } - 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_all_tags_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[List[TagResponseDto]]: - """Retrieve tags - - Retrieve a list of all tags. - - :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_all_tags_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TagResponseDto]", - } - 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_all_tags_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: - """Retrieve tags - - Retrieve a list of all tags. - - :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_all_tags_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TagResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_all_tags_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='/tags', - 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_tag_by_id( - self, - id: UUID, - _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, - ) -> TagResponseDto: - """Retrieve a tag - - Retrieve a specific tag by its ID. - - :param id: (required) - :type id: UUID - :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_tag_by_id_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - 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_tag_by_id_with_http_info( - self, - id: UUID, - _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[TagResponseDto]: - """Retrieve a tag - - Retrieve a specific tag by its ID. - - :param id: (required) - :type id: UUID - :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_tag_by_id_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - 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_tag_by_id_without_preload_content( - self, - id: UUID, - _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 a tag - - Retrieve a specific tag by its ID. - - :param id: (required) - :type id: UUID - :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_tag_by_id_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_tag_by_id_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/tags/{id}', - 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 tag_assets( - self, - id: UUID, - 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, - ) -> List[BulkIdResponseDto]: - """Tag assets - - Add a tag to all the specified assets. - - :param id: (required) - :type id: UUID - :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._tag_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 tag_assets_with_http_info( - self, - id: UUID, - 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[List[BulkIdResponseDto]]: - """Tag assets - - Add a tag to all the specified assets. - - :param id: (required) - :type id: UUID - :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._tag_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 tag_assets_without_preload_content( - self, - id: UUID, - 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: - """Tag assets - - Add a tag to all the specified assets. - - :param id: (required) - :type id: UUID - :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._tag_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _tag_assets_serialize( - self, - id, - 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 - if id is not None: - _path_params['id'] = id - # 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='PUT', - resource_path='/tags/{id}/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 untag_assets( - self, - id: UUID, - 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, - ) -> List[BulkIdResponseDto]: - """Untag assets - - Remove a tag from all the specified assets. - - :param id: (required) - :type id: UUID - :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._untag_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 untag_assets_with_http_info( - self, - id: UUID, - 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[List[BulkIdResponseDto]]: - """Untag assets - - Remove a tag from all the specified assets. - - :param id: (required) - :type id: UUID - :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._untag_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - 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 untag_assets_without_preload_content( - self, - id: UUID, - 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: - """Untag assets - - Remove a tag from all the specified assets. - - :param id: (required) - :type id: UUID - :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._untag_assets_serialize( - id=id, - 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': "List[BulkIdResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _untag_assets_serialize( - self, - id, - 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 - if id is not None: - _path_params['id'] = id - # 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='DELETE', - resource_path='/tags/{id}/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 update_tag( - self, - id: UUID, - tag_update_dto: TagUpdateDto, - _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, - ) -> TagResponseDto: - """(Deprecated) Update a tag - - Update an existing tag identified by its ID. - - :param id: (required) - :type id: UUID - :param tag_update_dto: (required) - :type tag_update_dto: TagUpdateDto - :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 /tags/{id} is deprecated.", DeprecationWarning) - - _param = self._update_tag_serialize( - id=id, - tag_update_dto=tag_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - 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 update_tag_with_http_info( - self, - id: UUID, - tag_update_dto: TagUpdateDto, - _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[TagResponseDto]: - """(Deprecated) Update a tag - - Update an existing tag identified by its ID. - - :param id: (required) - :type id: UUID - :param tag_update_dto: (required) - :type tag_update_dto: TagUpdateDto - :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 /tags/{id} is deprecated.", DeprecationWarning) - - _param = self._update_tag_serialize( - id=id, - tag_update_dto=tag_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - 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 update_tag_without_preload_content( - self, - id: UUID, - tag_update_dto: TagUpdateDto, - _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) Update a tag - - Update an existing tag identified by its ID. - - :param id: (required) - :type id: UUID - :param tag_update_dto: (required) - :type tag_update_dto: TagUpdateDto - :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 /tags/{id} is deprecated.", DeprecationWarning) - - _param = self._update_tag_serialize( - id=id, - tag_update_dto=tag_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TagResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_tag_serialize( - self, - id, - tag_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if tag_update_dto is not None: - _body_params = tag_update_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='/tags/{id}', - 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 upsert_tags( - self, - tag_upsert_dto: TagUpsertDto, - _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[TagResponseDto]: - """Upsert tags - - Create or update multiple tags in a single request. - - :param tag_upsert_dto: (required) - :type tag_upsert_dto: TagUpsertDto - :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._upsert_tags_serialize( - tag_upsert_dto=tag_upsert_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TagResponseDto]", - } - 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 upsert_tags_with_http_info( - self, - tag_upsert_dto: TagUpsertDto, - _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[TagResponseDto]]: - """Upsert tags - - Create or update multiple tags in a single request. - - :param tag_upsert_dto: (required) - :type tag_upsert_dto: TagUpsertDto - :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._upsert_tags_serialize( - tag_upsert_dto=tag_upsert_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TagResponseDto]", - } - 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 upsert_tags_without_preload_content( - self, - tag_upsert_dto: TagUpsertDto, - _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: - """Upsert tags - - Create or update multiple tags in a single request. - - :param tag_upsert_dto: (required) - :type tag_upsert_dto: TagUpsertDto - :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._upsert_tags_serialize( - tag_upsert_dto=tag_upsert_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TagResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _upsert_tags_serialize( - self, - tag_upsert_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 tag_upsert_dto is not None: - _body_params = tag_upsert_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='/tags', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/timeline_api.py b/generated/immich/openapi_client/api/timeline_api.py deleted file mode 100644 index d79f14d..0000000 --- a/generated/immich/openapi_client/api/timeline_api.py +++ /dev/null @@ -1,1067 +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 Field, StrictBool, StrictStr -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.asset_order import AssetOrder -from generated.immich.openapi_client.models.asset_order_by import AssetOrderBy -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -from generated.immich.openapi_client.models.time_bucket_asset_response_dto import TimeBucketAssetResponseDto -from generated.immich.openapi_client.models.time_buckets_response_dto import TimeBucketsResponseDto - -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 TimelineApi: - """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_time_bucket( - self, - time_bucket: Annotated[StrictStr, Field(description="Time bucket identifier in YYYY-MM-DD format")], - album_id: Annotated[Optional[UUID], Field(description="Filter assets belonging to a specific album")] = None, - bbox: Annotated[Optional[StrictStr], Field(description="Bounding box coordinates as west,south,east,north (WGS84)")] = None, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status (true for favorites only, false for non-favorites only)")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status (true for trashed assets only, false for non-trashed only)")] = None, - key: Optional[StrictStr] = None, - order: Annotated[Optional[AssetOrder], Field(description="Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)")] = None, - order_by: Annotated[Optional[AssetOrderBy], Field(description="Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)")] = None, - person_id: Annotated[Optional[UUID], Field(description="Filter assets containing a specific person (face recognition)")] = None, - slug: Optional[StrictStr] = None, - tag_id: Annotated[Optional[UUID], Field(description="Filter assets with a specific tag")] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter assets by specific user ID")] = None, - visibility: Annotated[Optional[AssetVisibility], Field(description="Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)")] = None, - with_coordinates: Annotated[Optional[StrictBool], Field(description="Include location data in the response")] = None, - with_partners: Annotated[Optional[StrictBool], Field(description="Include assets shared by partners")] = None, - with_stacked: Annotated[Optional[StrictBool], Field(description="Include stacked assets in the response. When true, only primary assets from stacks are returned.")] = 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, - ) -> TimeBucketAssetResponseDto: - """Get time bucket - - Retrieve a string of all asset ids in a given time bucket. - - :param time_bucket: Time bucket identifier in YYYY-MM-DD format (required) - :type time_bucket: str - :param album_id: Filter assets belonging to a specific album - :type album_id: UUID - :param bbox: Bounding box coordinates as west,south,east,north (WGS84) - :type bbox: str - :param is_favorite: Filter by favorite status (true for favorites only, false for non-favorites only) - :type is_favorite: bool - :param is_trashed: Filter by trash status (true for trashed assets only, false for non-trashed only) - :type is_trashed: bool - :param key: - :type key: str - :param order: Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) - :type order: AssetOrder - :param order_by: Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) - :type order_by: AssetOrderBy - :param person_id: Filter assets containing a specific person (face recognition) - :type person_id: UUID - :param slug: - :type slug: str - :param tag_id: Filter assets with a specific tag - :type tag_id: UUID - :param user_id: Filter assets by specific user ID - :type user_id: UUID - :param visibility: Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) - :type visibility: AssetVisibility - :param with_coordinates: Include location data in the response - :type with_coordinates: bool - :param with_partners: Include assets shared by partners - :type with_partners: bool - :param with_stacked: Include stacked assets in the response. When true, only primary assets from stacks are returned. - :type with_stacked: 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_time_bucket_serialize( - time_bucket=time_bucket, - album_id=album_id, - bbox=bbox, - is_favorite=is_favorite, - is_trashed=is_trashed, - key=key, - order=order, - order_by=order_by, - person_id=person_id, - slug=slug, - tag_id=tag_id, - user_id=user_id, - visibility=visibility, - with_coordinates=with_coordinates, - with_partners=with_partners, - with_stacked=with_stacked, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TimeBucketAssetResponseDto", - } - 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_time_bucket_with_http_info( - self, - time_bucket: Annotated[StrictStr, Field(description="Time bucket identifier in YYYY-MM-DD format")], - album_id: Annotated[Optional[UUID], Field(description="Filter assets belonging to a specific album")] = None, - bbox: Annotated[Optional[StrictStr], Field(description="Bounding box coordinates as west,south,east,north (WGS84)")] = None, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status (true for favorites only, false for non-favorites only)")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status (true for trashed assets only, false for non-trashed only)")] = None, - key: Optional[StrictStr] = None, - order: Annotated[Optional[AssetOrder], Field(description="Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)")] = None, - order_by: Annotated[Optional[AssetOrderBy], Field(description="Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)")] = None, - person_id: Annotated[Optional[UUID], Field(description="Filter assets containing a specific person (face recognition)")] = None, - slug: Optional[StrictStr] = None, - tag_id: Annotated[Optional[UUID], Field(description="Filter assets with a specific tag")] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter assets by specific user ID")] = None, - visibility: Annotated[Optional[AssetVisibility], Field(description="Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)")] = None, - with_coordinates: Annotated[Optional[StrictBool], Field(description="Include location data in the response")] = None, - with_partners: Annotated[Optional[StrictBool], Field(description="Include assets shared by partners")] = None, - with_stacked: Annotated[Optional[StrictBool], Field(description="Include stacked assets in the response. When true, only primary assets from stacks are returned.")] = 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[TimeBucketAssetResponseDto]: - """Get time bucket - - Retrieve a string of all asset ids in a given time bucket. - - :param time_bucket: Time bucket identifier in YYYY-MM-DD format (required) - :type time_bucket: str - :param album_id: Filter assets belonging to a specific album - :type album_id: UUID - :param bbox: Bounding box coordinates as west,south,east,north (WGS84) - :type bbox: str - :param is_favorite: Filter by favorite status (true for favorites only, false for non-favorites only) - :type is_favorite: bool - :param is_trashed: Filter by trash status (true for trashed assets only, false for non-trashed only) - :type is_trashed: bool - :param key: - :type key: str - :param order: Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) - :type order: AssetOrder - :param order_by: Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) - :type order_by: AssetOrderBy - :param person_id: Filter assets containing a specific person (face recognition) - :type person_id: UUID - :param slug: - :type slug: str - :param tag_id: Filter assets with a specific tag - :type tag_id: UUID - :param user_id: Filter assets by specific user ID - :type user_id: UUID - :param visibility: Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) - :type visibility: AssetVisibility - :param with_coordinates: Include location data in the response - :type with_coordinates: bool - :param with_partners: Include assets shared by partners - :type with_partners: bool - :param with_stacked: Include stacked assets in the response. When true, only primary assets from stacks are returned. - :type with_stacked: 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_time_bucket_serialize( - time_bucket=time_bucket, - album_id=album_id, - bbox=bbox, - is_favorite=is_favorite, - is_trashed=is_trashed, - key=key, - order=order, - order_by=order_by, - person_id=person_id, - slug=slug, - tag_id=tag_id, - user_id=user_id, - visibility=visibility, - with_coordinates=with_coordinates, - with_partners=with_partners, - with_stacked=with_stacked, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TimeBucketAssetResponseDto", - } - 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_time_bucket_without_preload_content( - self, - time_bucket: Annotated[StrictStr, Field(description="Time bucket identifier in YYYY-MM-DD format")], - album_id: Annotated[Optional[UUID], Field(description="Filter assets belonging to a specific album")] = None, - bbox: Annotated[Optional[StrictStr], Field(description="Bounding box coordinates as west,south,east,north (WGS84)")] = None, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status (true for favorites only, false for non-favorites only)")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status (true for trashed assets only, false for non-trashed only)")] = None, - key: Optional[StrictStr] = None, - order: Annotated[Optional[AssetOrder], Field(description="Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)")] = None, - order_by: Annotated[Optional[AssetOrderBy], Field(description="Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)")] = None, - person_id: Annotated[Optional[UUID], Field(description="Filter assets containing a specific person (face recognition)")] = None, - slug: Optional[StrictStr] = None, - tag_id: Annotated[Optional[UUID], Field(description="Filter assets with a specific tag")] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter assets by specific user ID")] = None, - visibility: Annotated[Optional[AssetVisibility], Field(description="Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)")] = None, - with_coordinates: Annotated[Optional[StrictBool], Field(description="Include location data in the response")] = None, - with_partners: Annotated[Optional[StrictBool], Field(description="Include assets shared by partners")] = None, - with_stacked: Annotated[Optional[StrictBool], Field(description="Include stacked assets in the response. When true, only primary assets from stacks are returned.")] = 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: - """Get time bucket - - Retrieve a string of all asset ids in a given time bucket. - - :param time_bucket: Time bucket identifier in YYYY-MM-DD format (required) - :type time_bucket: str - :param album_id: Filter assets belonging to a specific album - :type album_id: UUID - :param bbox: Bounding box coordinates as west,south,east,north (WGS84) - :type bbox: str - :param is_favorite: Filter by favorite status (true for favorites only, false for non-favorites only) - :type is_favorite: bool - :param is_trashed: Filter by trash status (true for trashed assets only, false for non-trashed only) - :type is_trashed: bool - :param key: - :type key: str - :param order: Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) - :type order: AssetOrder - :param order_by: Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) - :type order_by: AssetOrderBy - :param person_id: Filter assets containing a specific person (face recognition) - :type person_id: UUID - :param slug: - :type slug: str - :param tag_id: Filter assets with a specific tag - :type tag_id: UUID - :param user_id: Filter assets by specific user ID - :type user_id: UUID - :param visibility: Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) - :type visibility: AssetVisibility - :param with_coordinates: Include location data in the response - :type with_coordinates: bool - :param with_partners: Include assets shared by partners - :type with_partners: bool - :param with_stacked: Include stacked assets in the response. When true, only primary assets from stacks are returned. - :type with_stacked: 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_time_bucket_serialize( - time_bucket=time_bucket, - album_id=album_id, - bbox=bbox, - is_favorite=is_favorite, - is_trashed=is_trashed, - key=key, - order=order, - order_by=order_by, - person_id=person_id, - slug=slug, - tag_id=tag_id, - user_id=user_id, - visibility=visibility, - with_coordinates=with_coordinates, - with_partners=with_partners, - with_stacked=with_stacked, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "TimeBucketAssetResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_time_bucket_serialize( - self, - time_bucket, - album_id, - bbox, - is_favorite, - is_trashed, - key, - order, - order_by, - person_id, - slug, - tag_id, - user_id, - visibility, - with_coordinates, - with_partners, - with_stacked, - _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 album_id is not None: - - _query_params.append(('albumId', album_id)) - - if bbox is not None: - - _query_params.append(('bbox', bbox)) - - if is_favorite is not None: - - _query_params.append(('isFavorite', is_favorite)) - - if is_trashed is not None: - - _query_params.append(('isTrashed', is_trashed)) - - if key is not None: - - _query_params.append(('key', key)) - - if order is not None: - - _query_params.append(('order', order.value)) - - if order_by is not None: - - _query_params.append(('orderBy', order_by.value)) - - if person_id is not None: - - _query_params.append(('personId', person_id)) - - if slug is not None: - - _query_params.append(('slug', slug)) - - if tag_id is not None: - - _query_params.append(('tagId', tag_id)) - - if time_bucket is not None: - - _query_params.append(('timeBucket', time_bucket)) - - if user_id is not None: - - _query_params.append(('userId', user_id)) - - if visibility is not None: - - _query_params.append(('visibility', visibility.value)) - - if with_coordinates is not None: - - _query_params.append(('withCoordinates', with_coordinates)) - - if with_partners is not None: - - _query_params.append(('withPartners', with_partners)) - - if with_stacked is not None: - - _query_params.append(('withStacked', with_stacked)) - - # 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='/timeline/bucket', - 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_time_buckets( - self, - album_id: Annotated[Optional[UUID], Field(description="Filter assets belonging to a specific album")] = None, - bbox: Annotated[Optional[StrictStr], Field(description="Bounding box coordinates as west,south,east,north (WGS84)")] = None, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status (true for favorites only, false for non-favorites only)")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status (true for trashed assets only, false for non-trashed only)")] = None, - key: Optional[StrictStr] = None, - order: Annotated[Optional[AssetOrder], Field(description="Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)")] = None, - order_by: Annotated[Optional[AssetOrderBy], Field(description="Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)")] = None, - person_id: Annotated[Optional[UUID], Field(description="Filter assets containing a specific person (face recognition)")] = None, - slug: Optional[StrictStr] = None, - tag_id: Annotated[Optional[UUID], Field(description="Filter assets with a specific tag")] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter assets by specific user ID")] = None, - visibility: Annotated[Optional[AssetVisibility], Field(description="Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)")] = None, - with_coordinates: Annotated[Optional[StrictBool], Field(description="Include location data in the response")] = None, - with_partners: Annotated[Optional[StrictBool], Field(description="Include assets shared by partners")] = None, - with_stacked: Annotated[Optional[StrictBool], Field(description="Include stacked assets in the response. When true, only primary assets from stacks are returned.")] = 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[TimeBucketsResponseDto]: - """Get time buckets - - Retrieve a list of all minimal time buckets. - - :param album_id: Filter assets belonging to a specific album - :type album_id: UUID - :param bbox: Bounding box coordinates as west,south,east,north (WGS84) - :type bbox: str - :param is_favorite: Filter by favorite status (true for favorites only, false for non-favorites only) - :type is_favorite: bool - :param is_trashed: Filter by trash status (true for trashed assets only, false for non-trashed only) - :type is_trashed: bool - :param key: - :type key: str - :param order: Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) - :type order: AssetOrder - :param order_by: Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) - :type order_by: AssetOrderBy - :param person_id: Filter assets containing a specific person (face recognition) - :type person_id: UUID - :param slug: - :type slug: str - :param tag_id: Filter assets with a specific tag - :type tag_id: UUID - :param user_id: Filter assets by specific user ID - :type user_id: UUID - :param visibility: Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) - :type visibility: AssetVisibility - :param with_coordinates: Include location data in the response - :type with_coordinates: bool - :param with_partners: Include assets shared by partners - :type with_partners: bool - :param with_stacked: Include stacked assets in the response. When true, only primary assets from stacks are returned. - :type with_stacked: 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_time_buckets_serialize( - album_id=album_id, - bbox=bbox, - is_favorite=is_favorite, - is_trashed=is_trashed, - key=key, - order=order, - order_by=order_by, - person_id=person_id, - slug=slug, - tag_id=tag_id, - user_id=user_id, - visibility=visibility, - with_coordinates=with_coordinates, - with_partners=with_partners, - with_stacked=with_stacked, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TimeBucketsResponseDto]", - } - 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_time_buckets_with_http_info( - self, - album_id: Annotated[Optional[UUID], Field(description="Filter assets belonging to a specific album")] = None, - bbox: Annotated[Optional[StrictStr], Field(description="Bounding box coordinates as west,south,east,north (WGS84)")] = None, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status (true for favorites only, false for non-favorites only)")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status (true for trashed assets only, false for non-trashed only)")] = None, - key: Optional[StrictStr] = None, - order: Annotated[Optional[AssetOrder], Field(description="Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)")] = None, - order_by: Annotated[Optional[AssetOrderBy], Field(description="Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)")] = None, - person_id: Annotated[Optional[UUID], Field(description="Filter assets containing a specific person (face recognition)")] = None, - slug: Optional[StrictStr] = None, - tag_id: Annotated[Optional[UUID], Field(description="Filter assets with a specific tag")] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter assets by specific user ID")] = None, - visibility: Annotated[Optional[AssetVisibility], Field(description="Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)")] = None, - with_coordinates: Annotated[Optional[StrictBool], Field(description="Include location data in the response")] = None, - with_partners: Annotated[Optional[StrictBool], Field(description="Include assets shared by partners")] = None, - with_stacked: Annotated[Optional[StrictBool], Field(description="Include stacked assets in the response. When true, only primary assets from stacks are returned.")] = 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[TimeBucketsResponseDto]]: - """Get time buckets - - Retrieve a list of all minimal time buckets. - - :param album_id: Filter assets belonging to a specific album - :type album_id: UUID - :param bbox: Bounding box coordinates as west,south,east,north (WGS84) - :type bbox: str - :param is_favorite: Filter by favorite status (true for favorites only, false for non-favorites only) - :type is_favorite: bool - :param is_trashed: Filter by trash status (true for trashed assets only, false for non-trashed only) - :type is_trashed: bool - :param key: - :type key: str - :param order: Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) - :type order: AssetOrder - :param order_by: Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) - :type order_by: AssetOrderBy - :param person_id: Filter assets containing a specific person (face recognition) - :type person_id: UUID - :param slug: - :type slug: str - :param tag_id: Filter assets with a specific tag - :type tag_id: UUID - :param user_id: Filter assets by specific user ID - :type user_id: UUID - :param visibility: Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) - :type visibility: AssetVisibility - :param with_coordinates: Include location data in the response - :type with_coordinates: bool - :param with_partners: Include assets shared by partners - :type with_partners: bool - :param with_stacked: Include stacked assets in the response. When true, only primary assets from stacks are returned. - :type with_stacked: 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_time_buckets_serialize( - album_id=album_id, - bbox=bbox, - is_favorite=is_favorite, - is_trashed=is_trashed, - key=key, - order=order, - order_by=order_by, - person_id=person_id, - slug=slug, - tag_id=tag_id, - user_id=user_id, - visibility=visibility, - with_coordinates=with_coordinates, - with_partners=with_partners, - with_stacked=with_stacked, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TimeBucketsResponseDto]", - } - 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_time_buckets_without_preload_content( - self, - album_id: Annotated[Optional[UUID], Field(description="Filter assets belonging to a specific album")] = None, - bbox: Annotated[Optional[StrictStr], Field(description="Bounding box coordinates as west,south,east,north (WGS84)")] = None, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status (true for favorites only, false for non-favorites only)")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status (true for trashed assets only, false for non-trashed only)")] = None, - key: Optional[StrictStr] = None, - order: Annotated[Optional[AssetOrder], Field(description="Sort order for assets within time buckets (ASC for oldest first, DESC for newest first)")] = None, - order_by: Annotated[Optional[AssetOrderBy], Field(description="Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich)")] = None, - person_id: Annotated[Optional[UUID], Field(description="Filter assets containing a specific person (face recognition)")] = None, - slug: Optional[StrictStr] = None, - tag_id: Annotated[Optional[UUID], Field(description="Filter assets with a specific tag")] = None, - user_id: Annotated[Optional[UUID], Field(description="Filter assets by specific user ID")] = None, - visibility: Annotated[Optional[AssetVisibility], Field(description="Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)")] = None, - with_coordinates: Annotated[Optional[StrictBool], Field(description="Include location data in the response")] = None, - with_partners: Annotated[Optional[StrictBool], Field(description="Include assets shared by partners")] = None, - with_stacked: Annotated[Optional[StrictBool], Field(description="Include stacked assets in the response. When true, only primary assets from stacks are returned.")] = 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: - """Get time buckets - - Retrieve a list of all minimal time buckets. - - :param album_id: Filter assets belonging to a specific album - :type album_id: UUID - :param bbox: Bounding box coordinates as west,south,east,north (WGS84) - :type bbox: str - :param is_favorite: Filter by favorite status (true for favorites only, false for non-favorites only) - :type is_favorite: bool - :param is_trashed: Filter by trash status (true for trashed assets only, false for non-trashed only) - :type is_trashed: bool - :param key: - :type key: str - :param order: Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) - :type order: AssetOrder - :param order_by: Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) - :type order_by: AssetOrderBy - :param person_id: Filter assets containing a specific person (face recognition) - :type person_id: UUID - :param slug: - :type slug: str - :param tag_id: Filter assets with a specific tag - :type tag_id: UUID - :param user_id: Filter assets by specific user ID - :type user_id: UUID - :param visibility: Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) - :type visibility: AssetVisibility - :param with_coordinates: Include location data in the response - :type with_coordinates: bool - :param with_partners: Include assets shared by partners - :type with_partners: bool - :param with_stacked: Include stacked assets in the response. When true, only primary assets from stacks are returned. - :type with_stacked: 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_time_buckets_serialize( - album_id=album_id, - bbox=bbox, - is_favorite=is_favorite, - is_trashed=is_trashed, - key=key, - order=order, - order_by=order_by, - person_id=person_id, - slug=slug, - tag_id=tag_id, - user_id=user_id, - visibility=visibility, - with_coordinates=with_coordinates, - with_partners=with_partners, - with_stacked=with_stacked, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TimeBucketsResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_time_buckets_serialize( - self, - album_id, - bbox, - is_favorite, - is_trashed, - key, - order, - order_by, - person_id, - slug, - tag_id, - user_id, - visibility, - with_coordinates, - with_partners, - with_stacked, - _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 album_id is not None: - - _query_params.append(('albumId', album_id)) - - if bbox is not None: - - _query_params.append(('bbox', bbox)) - - if is_favorite is not None: - - _query_params.append(('isFavorite', is_favorite)) - - if is_trashed is not None: - - _query_params.append(('isTrashed', is_trashed)) - - if key is not None: - - _query_params.append(('key', key)) - - if order is not None: - - _query_params.append(('order', order.value)) - - if order_by is not None: - - _query_params.append(('orderBy', order_by.value)) - - if person_id is not None: - - _query_params.append(('personId', person_id)) - - if slug is not None: - - _query_params.append(('slug', slug)) - - if tag_id is not None: - - _query_params.append(('tagId', tag_id)) - - if user_id is not None: - - _query_params.append(('userId', user_id)) - - if visibility is not None: - - _query_params.append(('visibility', visibility.value)) - - if with_coordinates is not None: - - _query_params.append(('withCoordinates', with_coordinates)) - - if with_partners is not None: - - _query_params.append(('withPartners', with_partners)) - - if with_stacked is not None: - - _query_params.append(('withStacked', with_stacked)) - - # 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='/timeline/buckets', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/trash_api.py b/generated/immich/openapi_client/api/trash_api.py deleted file mode 100644 index dc4edb2..0000000 --- a/generated/immich/openapi_client/api/trash_api.py +++ /dev/null @@ -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 - ) - - diff --git a/generated/immich/openapi_client/api/users_admin_api.py b/generated/immich/openapi_client/api/users_admin_api.py deleted file mode 100644 index cbca9b5..0000000 --- a/generated/immich/openapi_client/api/users_admin_api.py +++ /dev/null @@ -1,3186 +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 date -from pydantic import Field, StrictBool -from typing import List, Optional -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.asset_stats_response_dto import AssetStatsResponseDto -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -from generated.immich.openapi_client.models.calendar_heatmap_response_dto import CalendarHeatmapResponseDto -from generated.immich.openapi_client.models.calendar_heatmap_type import CalendarHeatmapType -from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto -from generated.immich.openapi_client.models.user_admin_create_dto import UserAdminCreateDto -from generated.immich.openapi_client.models.user_admin_delete_dto import UserAdminDeleteDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto -from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto - -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 UsersAdminApi: - """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_user_admin( - self, - user_admin_create_dto: UserAdminCreateDto, - _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, - ) -> UserAdminResponseDto: - """Create a user - - Create a new user. - - :param user_admin_create_dto: (required) - :type user_admin_create_dto: UserAdminCreateDto - :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_user_admin_serialize( - user_admin_create_dto=user_admin_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "UserAdminResponseDto", - } - 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_user_admin_with_http_info( - self, - user_admin_create_dto: UserAdminCreateDto, - _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[UserAdminResponseDto]: - """Create a user - - Create a new user. - - :param user_admin_create_dto: (required) - :type user_admin_create_dto: UserAdminCreateDto - :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_user_admin_serialize( - user_admin_create_dto=user_admin_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "UserAdminResponseDto", - } - 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_user_admin_without_preload_content( - self, - user_admin_create_dto: UserAdminCreateDto, - _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 user - - Create a new user. - - :param user_admin_create_dto: (required) - :type user_admin_create_dto: UserAdminCreateDto - :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_user_admin_serialize( - user_admin_create_dto=user_admin_create_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_user_admin_serialize( - self, - user_admin_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 user_admin_create_dto is not None: - _body_params = user_admin_create_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='/admin/users', - 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 delete_user_admin( - self, - id: UUID, - user_admin_delete_dto: UserAdminDeleteDto, - _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, - ) -> UserAdminResponseDto: - """Delete a user - - Delete a user. - - :param id: (required) - :type id: UUID - :param user_admin_delete_dto: (required) - :type user_admin_delete_dto: UserAdminDeleteDto - :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._delete_user_admin_serialize( - id=id, - user_admin_delete_dto=user_admin_delete_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 delete_user_admin_with_http_info( - self, - id: UUID, - user_admin_delete_dto: UserAdminDeleteDto, - _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[UserAdminResponseDto]: - """Delete a user - - Delete a user. - - :param id: (required) - :type id: UUID - :param user_admin_delete_dto: (required) - :type user_admin_delete_dto: UserAdminDeleteDto - :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._delete_user_admin_serialize( - id=id, - user_admin_delete_dto=user_admin_delete_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 delete_user_admin_without_preload_content( - self, - id: UUID, - user_admin_delete_dto: UserAdminDeleteDto, - _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: - """Delete a user - - Delete a user. - - :param id: (required) - :type id: UUID - :param user_admin_delete_dto: (required) - :type user_admin_delete_dto: UserAdminDeleteDto - :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._delete_user_admin_serialize( - id=id, - user_admin_delete_dto=user_admin_delete_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _delete_user_admin_serialize( - self, - id, - user_admin_delete_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if user_admin_delete_dto is not None: - _body_params = user_admin_delete_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='DELETE', - resource_path='/admin/users/{id}', - 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_user_admin( - self, - id: UUID, - _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, - ) -> UserAdminResponseDto: - """Retrieve a user - - Retrieve a specific user by their ID. - - :param id: (required) - :type id: UUID - :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_user_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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_user_admin_with_http_info( - self, - id: UUID, - _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[UserAdminResponseDto]: - """Retrieve a user - - Retrieve a specific user by their ID. - - :param id: (required) - :type id: UUID - :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_user_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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_user_admin_without_preload_content( - self, - id: UUID, - _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 a user - - Retrieve a specific user by their ID. - - :param id: (required) - :type id: UUID - :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_user_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_admin_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/admin/users/{id}', - 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_user_calendar_heatmap_admin( - self, - id: UUID, - var_from: Annotated[Optional[date], Field(description="Start date in UTC")] = None, - to: Annotated[Optional[date], Field(description="End date in UTC")] = None, - type: Optional[CalendarHeatmapType] = 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, - ) -> CalendarHeatmapResponseDto: - """Retrieve calendar heatmap activity - - Retrieve activity counts for a specified period, in a calendar heatmap format. - - :param id: (required) - :type id: UUID - :param var_from: Start date in UTC - :type var_from: date - :param to: End date in UTC - :type to: date - :param type: - :type type: CalendarHeatmapType - :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_user_calendar_heatmap_admin_serialize( - id=id, - var_from=var_from, - to=to, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "CalendarHeatmapResponseDto", - } - 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_user_calendar_heatmap_admin_with_http_info( - self, - id: UUID, - var_from: Annotated[Optional[date], Field(description="Start date in UTC")] = None, - to: Annotated[Optional[date], Field(description="End date in UTC")] = None, - type: Optional[CalendarHeatmapType] = 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[CalendarHeatmapResponseDto]: - """Retrieve calendar heatmap activity - - Retrieve activity counts for a specified period, in a calendar heatmap format. - - :param id: (required) - :type id: UUID - :param var_from: Start date in UTC - :type var_from: date - :param to: End date in UTC - :type to: date - :param type: - :type type: CalendarHeatmapType - :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_user_calendar_heatmap_admin_serialize( - id=id, - var_from=var_from, - to=to, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "CalendarHeatmapResponseDto", - } - 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_user_calendar_heatmap_admin_without_preload_content( - self, - id: UUID, - var_from: Annotated[Optional[date], Field(description="Start date in UTC")] = None, - to: Annotated[Optional[date], Field(description="End date in UTC")] = None, - type: Optional[CalendarHeatmapType] = 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 calendar heatmap activity - - Retrieve activity counts for a specified period, in a calendar heatmap format. - - :param id: (required) - :type id: UUID - :param var_from: Start date in UTC - :type var_from: date - :param to: End date in UTC - :type to: date - :param type: - :type type: CalendarHeatmapType - :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_user_calendar_heatmap_admin_serialize( - id=id, - var_from=var_from, - to=to, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "CalendarHeatmapResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_calendar_heatmap_admin_serialize( - self, - id, - var_from, - to, - type, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - if var_from is not None: - if isinstance(var_from, date): - _query_params.append( - ( - 'from', - var_from.strftime( - self.api_client.configuration.date_format - ) - ) - ) - else: - _query_params.append(('from', var_from)) - - if to is not None: - if isinstance(to, date): - _query_params.append( - ( - 'to', - to.strftime( - self.api_client.configuration.date_format - ) - ) - ) - else: - _query_params.append(('to', to)) - - if type is not None: - - _query_params.append(('type', type.value)) - - # 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='/admin/users/{id}/calendar-heatmap', - 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_user_preferences_admin( - self, - id: UUID, - _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, - ) -> UserPreferencesResponseDto: - """Retrieve user preferences - - Retrieve the preferences of a specific user. - - :param id: (required) - :type id: UUID - :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_user_preferences_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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_user_preferences_admin_with_http_info( - self, - id: UUID, - _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[UserPreferencesResponseDto]: - """Retrieve user preferences - - Retrieve the preferences of a specific user. - - :param id: (required) - :type id: UUID - :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_user_preferences_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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_user_preferences_admin_without_preload_content( - self, - id: UUID, - _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 user preferences - - Retrieve the preferences of a specific user. - - :param id: (required) - :type id: UUID - :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_user_preferences_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_preferences_admin_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/admin/users/{id}/preferences', - 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_user_sessions_admin( - self, - id: UUID, - _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[SessionResponseDto]: - """Retrieve user sessions - - Retrieve all sessions for a specific user. - - :param id: (required) - :type id: UUID - :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_user_sessions_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SessionResponseDto]", - } - 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_user_sessions_admin_with_http_info( - self, - id: UUID, - _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[SessionResponseDto]]: - """Retrieve user sessions - - Retrieve all sessions for a specific user. - - :param id: (required) - :type id: UUID - :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_user_sessions_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SessionResponseDto]", - } - 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_user_sessions_admin_without_preload_content( - self, - id: UUID, - _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 user sessions - - Retrieve all sessions for a specific user. - - :param id: (required) - :type id: UUID - :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_user_sessions_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[SessionResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_sessions_admin_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/admin/users/{id}/sessions', - 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_user_statistics_admin( - self, - id: UUID, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status")] = None, - visibility: Optional[AssetVisibility] = 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, - ) -> AssetStatsResponseDto: - """Retrieve user statistics - - Retrieve asset statistics for a specific user. - - :param id: (required) - :type id: UUID - :param is_favorite: Filter by favorite status - :type is_favorite: bool - :param is_trashed: Filter by trash status - :type is_trashed: bool - :param visibility: - :type visibility: AssetVisibility - :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_user_statistics_admin_serialize( - id=id, - is_favorite=is_favorite, - is_trashed=is_trashed, - visibility=visibility, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AssetStatsResponseDto", - } - 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_user_statistics_admin_with_http_info( - self, - id: UUID, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status")] = None, - visibility: Optional[AssetVisibility] = 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[AssetStatsResponseDto]: - """Retrieve user statistics - - Retrieve asset statistics for a specific user. - - :param id: (required) - :type id: UUID - :param is_favorite: Filter by favorite status - :type is_favorite: bool - :param is_trashed: Filter by trash status - :type is_trashed: bool - :param visibility: - :type visibility: AssetVisibility - :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_user_statistics_admin_serialize( - id=id, - is_favorite=is_favorite, - is_trashed=is_trashed, - visibility=visibility, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AssetStatsResponseDto", - } - 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_user_statistics_admin_without_preload_content( - self, - id: UUID, - is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None, - is_trashed: Annotated[Optional[StrictBool], Field(description="Filter by trash status")] = None, - visibility: Optional[AssetVisibility] = 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 user statistics - - Retrieve asset statistics for a specific user. - - :param id: (required) - :type id: UUID - :param is_favorite: Filter by favorite status - :type is_favorite: bool - :param is_trashed: Filter by trash status - :type is_trashed: bool - :param visibility: - :type visibility: AssetVisibility - :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_user_statistics_admin_serialize( - id=id, - is_favorite=is_favorite, - is_trashed=is_trashed, - visibility=visibility, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "AssetStatsResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_statistics_admin_serialize( - self, - id, - is_favorite, - is_trashed, - visibility, - _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 id is not None: - _path_params['id'] = id - # process the query parameters - if is_favorite is not None: - - _query_params.append(('isFavorite', is_favorite)) - - if is_trashed is not None: - - _query_params.append(('isTrashed', is_trashed)) - - if visibility is not None: - - _query_params.append(('visibility', visibility.value)) - - # 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='/admin/users/{id}/statistics', - 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_user_admin( - self, - id: UUID, - _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, - ) -> UserAdminResponseDto: - """Restore a deleted user - - Restore a previously deleted user. - - :param id: (required) - :type id: UUID - :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_user_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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_user_admin_with_http_info( - self, - id: UUID, - _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[UserAdminResponseDto]: - """Restore a deleted user - - Restore a previously deleted user. - - :param id: (required) - :type id: UUID - :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_user_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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_user_admin_without_preload_content( - self, - id: UUID, - _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 a deleted user - - Restore a previously deleted user. - - :param id: (required) - :type id: UUID - :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_user_admin_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _restore_user_admin_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/admin/users/{id}/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 - ) - - - - - @validate_call - def search_users_admin( - self, - id: Annotated[Optional[UUID], Field(description="User ID filter")] = None, - with_deleted: Annotated[Optional[StrictBool], Field(description="Include deleted users")] = 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[UserAdminResponseDto]: - """Search users - - Search for users. - - :param id: User ID filter - :type id: UUID - :param with_deleted: Include deleted users - :type with_deleted: 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._search_users_admin_serialize( - id=id, - with_deleted=with_deleted, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[UserAdminResponseDto]", - } - 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 search_users_admin_with_http_info( - self, - id: Annotated[Optional[UUID], Field(description="User ID filter")] = None, - with_deleted: Annotated[Optional[StrictBool], Field(description="Include deleted users")] = 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[UserAdminResponseDto]]: - """Search users - - Search for users. - - :param id: User ID filter - :type id: UUID - :param with_deleted: Include deleted users - :type with_deleted: 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._search_users_admin_serialize( - id=id, - with_deleted=with_deleted, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[UserAdminResponseDto]", - } - 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 search_users_admin_without_preload_content( - self, - id: Annotated[Optional[UUID], Field(description="User ID filter")] = None, - with_deleted: Annotated[Optional[StrictBool], Field(description="Include deleted users")] = 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: - """Search users - - Search for users. - - :param id: User ID filter - :type id: UUID - :param with_deleted: Include deleted users - :type with_deleted: 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._search_users_admin_serialize( - id=id, - with_deleted=with_deleted, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[UserAdminResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _search_users_admin_serialize( - self, - id, - with_deleted, - _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 id is not None: - - _query_params.append(('id', id)) - - if with_deleted is not None: - - _query_params.append(('withDeleted', with_deleted)) - - # 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='/admin/users', - 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 update_user_admin( - self, - id: UUID, - user_admin_update_dto: UserAdminUpdateDto, - _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, - ) -> UserAdminResponseDto: - """(Deprecated) Update a user - - Update an existing user. - - :param id: (required) - :type id: UUID - :param user_admin_update_dto: (required) - :type user_admin_update_dto: UserAdminUpdateDto - :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 /admin/users/{id} is deprecated.", DeprecationWarning) - - _param = self._update_user_admin_serialize( - id=id, - user_admin_update_dto=user_admin_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_user_admin_with_http_info( - self, - id: UUID, - user_admin_update_dto: UserAdminUpdateDto, - _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[UserAdminResponseDto]: - """(Deprecated) Update a user - - Update an existing user. - - :param id: (required) - :type id: UUID - :param user_admin_update_dto: (required) - :type user_admin_update_dto: UserAdminUpdateDto - :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 /admin/users/{id} is deprecated.", DeprecationWarning) - - _param = self._update_user_admin_serialize( - id=id, - user_admin_update_dto=user_admin_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_user_admin_without_preload_content( - self, - id: UUID, - user_admin_update_dto: UserAdminUpdateDto, - _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) Update a user - - Update an existing user. - - :param id: (required) - :type id: UUID - :param user_admin_update_dto: (required) - :type user_admin_update_dto: UserAdminUpdateDto - :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 /admin/users/{id} is deprecated.", DeprecationWarning) - - _param = self._update_user_admin_serialize( - id=id, - user_admin_update_dto=user_admin_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_user_admin_serialize( - self, - id, - user_admin_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if user_admin_update_dto is not None: - _body_params = user_admin_update_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='/admin/users/{id}', - 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 update_user_preferences_admin( - self, - id: UUID, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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, - ) -> UserPreferencesResponseDto: - """(Deprecated) Update user preferences - - Update the preferences of a specific user. - - :param id: (required) - :type id: UUID - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /admin/users/{id}/preferences is deprecated.", DeprecationWarning) - - _param = self._update_user_preferences_admin_serialize( - id=id, - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_user_preferences_admin_with_http_info( - self, - id: UUID, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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[UserPreferencesResponseDto]: - """(Deprecated) Update user preferences - - Update the preferences of a specific user. - - :param id: (required) - :type id: UUID - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /admin/users/{id}/preferences is deprecated.", DeprecationWarning) - - _param = self._update_user_preferences_admin_serialize( - id=id, - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_user_preferences_admin_without_preload_content( - self, - id: UUID, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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) Update user preferences - - Update the preferences of a specific user. - - :param id: (required) - :type id: UUID - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /admin/users/{id}/preferences is deprecated.", DeprecationWarning) - - _param = self._update_user_preferences_admin_serialize( - id=id, - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_user_preferences_admin_serialize( - self, - id, - user_preferences_update_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 id is not None: - _path_params['id'] = id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if user_preferences_update_dto is not None: - _body_params = user_preferences_update_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='/admin/users/{id}/preferences', - 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 - ) - - diff --git a/generated/immich/openapi_client/api/users_api.py b/generated/immich/openapi_client/api/users_api.py deleted file mode 100644 index bb55934..0000000 --- a/generated/immich/openapi_client/api/users_api.py +++ /dev/null @@ -1,4244 +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 date -from pydantic import Field, StrictBytes, StrictStr -from typing import List, Optional, Tuple, Union -from typing_extensions import Annotated -from uuid import UUID -from generated.immich.openapi_client.models.calendar_heatmap_response_dto import CalendarHeatmapResponseDto -from generated.immich.openapi_client.models.calendar_heatmap_type import CalendarHeatmapType -from generated.immich.openapi_client.models.create_profile_image_response_dto import CreateProfileImageResponseDto -from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto -from generated.immich.openapi_client.models.onboarding_dto import OnboardingDto -from generated.immich.openapi_client.models.onboarding_response_dto import OnboardingResponseDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_license import UserLicense -from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto -from generated.immich.openapi_client.models.user_response_dto import UserResponseDto -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto - -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 UsersApi: - """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_profile_image( - self, - file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="Profile image file")], - _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, - ) -> CreateProfileImageResponseDto: - """Create user profile image - - Upload and set a new profile image for the current user. - - :param file: Profile image file (required) - :type file: bytearray - :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_profile_image_serialize( - file=file, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "CreateProfileImageResponseDto", - } - 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_profile_image_with_http_info( - self, - file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="Profile image file")], - _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[CreateProfileImageResponseDto]: - """Create user profile image - - Upload and set a new profile image for the current user. - - :param file: Profile image file (required) - :type file: bytearray - :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_profile_image_serialize( - file=file, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "CreateProfileImageResponseDto", - } - 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_profile_image_without_preload_content( - self, - file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="Profile image file")], - _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 user profile image - - Upload and set a new profile image for the current user. - - :param file: Profile image file (required) - :type file: bytearray - :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_profile_image_serialize( - file=file, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '201': "CreateProfileImageResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _create_profile_image_serialize( - self, - file, - _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 - if file is not None: - _files['file'] = file - # 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' - ] - ) - - # 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( - [ - 'multipart/form-data' - ] - ) - ) - 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='/users/profile-image', - 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 delete_profile_image( - 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, - ) -> None: - """Delete user profile image - - Delete the profile image of the current user. - - :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._delete_profile_image_serialize( - _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 delete_profile_image_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[None]: - """Delete user profile image - - Delete the profile image of the current user. - - :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._delete_profile_image_serialize( - _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 delete_profile_image_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: - """Delete user profile image - - Delete the profile image of the current user. - - :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._delete_profile_image_serialize( - _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 _delete_profile_image_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/users/profile-image', - 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 delete_user_license( - 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, - ) -> None: - """Delete user product key - - Delete the registered product key for the current user. - - :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._delete_user_license_serialize( - _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 delete_user_license_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[None]: - """Delete user product key - - Delete the registered product key for the current user. - - :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._delete_user_license_serialize( - _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 delete_user_license_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: - """Delete user product key - - Delete the registered product key for the current user. - - :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._delete_user_license_serialize( - _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 _delete_user_license_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/users/me/license', - 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 delete_user_onboarding( - 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, - ) -> None: - """Delete user onboarding - - Delete the onboarding status of the current user. - - :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._delete_user_onboarding_serialize( - _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 delete_user_onboarding_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[None]: - """Delete user onboarding - - Delete the onboarding status of the current user. - - :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._delete_user_onboarding_serialize( - _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 delete_user_onboarding_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: - """Delete user onboarding - - Delete the onboarding status of the current user. - - :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._delete_user_onboarding_serialize( - _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 _delete_user_onboarding_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 - - - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/users/me/onboarding', - 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_my_calendar_heatmap( - self, - var_from: Annotated[Optional[date], Field(description="Start date in UTC")] = None, - to: Annotated[Optional[date], Field(description="End date in UTC")] = None, - type: Optional[CalendarHeatmapType] = 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, - ) -> CalendarHeatmapResponseDto: - """Retrieve calendar heatmap activity - - Retrieve activity counts for a specified period, in a calendar heatmap format. - - :param var_from: Start date in UTC - :type var_from: date - :param to: End date in UTC - :type to: date - :param type: - :type type: CalendarHeatmapType - :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_my_calendar_heatmap_serialize( - var_from=var_from, - to=to, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "CalendarHeatmapResponseDto", - } - 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_my_calendar_heatmap_with_http_info( - self, - var_from: Annotated[Optional[date], Field(description="Start date in UTC")] = None, - to: Annotated[Optional[date], Field(description="End date in UTC")] = None, - type: Optional[CalendarHeatmapType] = 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[CalendarHeatmapResponseDto]: - """Retrieve calendar heatmap activity - - Retrieve activity counts for a specified period, in a calendar heatmap format. - - :param var_from: Start date in UTC - :type var_from: date - :param to: End date in UTC - :type to: date - :param type: - :type type: CalendarHeatmapType - :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_my_calendar_heatmap_serialize( - var_from=var_from, - to=to, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "CalendarHeatmapResponseDto", - } - 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_my_calendar_heatmap_without_preload_content( - self, - var_from: Annotated[Optional[date], Field(description="Start date in UTC")] = None, - to: Annotated[Optional[date], Field(description="End date in UTC")] = None, - type: Optional[CalendarHeatmapType] = 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 calendar heatmap activity - - Retrieve activity counts for a specified period, in a calendar heatmap format. - - :param var_from: Start date in UTC - :type var_from: date - :param to: End date in UTC - :type to: date - :param type: - :type type: CalendarHeatmapType - :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_my_calendar_heatmap_serialize( - var_from=var_from, - to=to, - type=type, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "CalendarHeatmapResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_my_calendar_heatmap_serialize( - self, - var_from, - to, - type, - _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 var_from is not None: - if isinstance(var_from, date): - _query_params.append( - ( - 'from', - var_from.strftime( - self.api_client.configuration.date_format - ) - ) - ) - else: - _query_params.append(('from', var_from)) - - if to is not None: - if isinstance(to, date): - _query_params.append( - ( - 'to', - to.strftime( - self.api_client.configuration.date_format - ) - ) - ) - else: - _query_params.append(('to', to)) - - if type is not None: - - _query_params.append(('type', type.value)) - - # 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='/users/me/calendar-heatmap', - 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_my_preferences( - 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, - ) -> UserPreferencesResponseDto: - """Get my preferences - - Retrieve the preferences for the current user. - - :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_my_preferences_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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_my_preferences_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[UserPreferencesResponseDto]: - """Get my preferences - - Retrieve the preferences for the current user. - - :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_my_preferences_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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_my_preferences_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: - """Get my preferences - - Retrieve the preferences for the current user. - - :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_my_preferences_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_my_preferences_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='/users/me/preferences', - 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_my_user( - 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, - ) -> UserAdminResponseDto: - """Get current user - - Retrieve information about the user making the API request. - - :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_my_user_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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_my_user_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[UserAdminResponseDto]: - """Get current user - - Retrieve information about the user making the API request. - - :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_my_user_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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_my_user_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: - """Get current user - - Retrieve information about the user making the API request. - - :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_my_user_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_my_user_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='/users/me', - 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_profile_image( - self, - id: UUID, - _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: - """Retrieve user profile image - - Retrieve the profile image file for a user. - - :param id: (required) - :type id: UUID - :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_profile_image_serialize( - id=id, - _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 get_profile_image_with_http_info( - self, - id: UUID, - _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]: - """Retrieve user profile image - - Retrieve the profile image file for a user. - - :param id: (required) - :type id: UUID - :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_profile_image_serialize( - id=id, - _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 get_profile_image_without_preload_content( - self, - id: UUID, - _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 user profile image - - Retrieve the profile image file for a user. - - :param id: (required) - :type id: UUID - :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_profile_image_serialize( - id=id, - _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 _get_profile_image_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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/octet-stream' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'cookie', - 'api_key', - 'bearer' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/users/{id}/profile-image', - 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_user( - self, - id: UUID, - _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, - ) -> UserResponseDto: - """Retrieve a user - - Retrieve a specific user by their ID. - - :param id: (required) - :type id: UUID - :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_user_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserResponseDto", - } - 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_user_with_http_info( - self, - id: UUID, - _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[UserResponseDto]: - """Retrieve a user - - Retrieve a specific user by their ID. - - :param id: (required) - :type id: UUID - :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_user_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserResponseDto", - } - 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_user_without_preload_content( - self, - id: UUID, - _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 a user - - Retrieve a specific user by their ID. - - :param id: (required) - :type id: UUID - :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_user_serialize( - id=id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_serialize( - self, - id, - _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 id is not None: - _path_params['id'] = id - # 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='/users/{id}', - 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_user_license( - 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, - ) -> UserLicense: - """Retrieve user product key - - Retrieve information about whether the current user has a registered product key. - - :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_user_license_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - 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_user_license_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[UserLicense]: - """Retrieve user product key - - Retrieve information about whether the current user has a registered product key. - - :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_user_license_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - 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_user_license_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: - """Retrieve user product key - - Retrieve information about whether the current user has a registered product key. - - :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_user_license_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_license_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='/users/me/license', - 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_user_onboarding( - 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, - ) -> OnboardingResponseDto: - """Retrieve user onboarding - - Retrieve the onboarding status of the current user. - - :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_user_onboarding_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "OnboardingResponseDto", - } - 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_user_onboarding_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[OnboardingResponseDto]: - """Retrieve user onboarding - - Retrieve the onboarding status of the current user. - - :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_user_onboarding_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "OnboardingResponseDto", - } - 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_user_onboarding_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: - """Retrieve user onboarding - - Retrieve the onboarding status of the current user. - - :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_user_onboarding_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "OnboardingResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_user_onboarding_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='/users/me/onboarding', - 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 search_users( - 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, - ) -> List[UserResponseDto]: - """Get all users - - Retrieve a list of all users on the server. - - :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._search_users_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[UserResponseDto]", - } - 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 search_users_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[List[UserResponseDto]]: - """Get all users - - Retrieve a list of all users on the server. - - :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._search_users_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[UserResponseDto]", - } - 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 search_users_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: - """Get all users - - Retrieve a list of all users on the server. - - :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._search_users_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[UserResponseDto]", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _search_users_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='/users', - 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 set_user_license( - self, - license_key_dto: LicenseKeyDto, - _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, - ) -> UserLicense: - """Set user product key - - Register a product key for the current user. - - :param license_key_dto: (required) - :type license_key_dto: LicenseKeyDto - :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._set_user_license_serialize( - license_key_dto=license_key_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - 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 set_user_license_with_http_info( - self, - license_key_dto: LicenseKeyDto, - _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[UserLicense]: - """Set user product key - - Register a product key for the current user. - - :param license_key_dto: (required) - :type license_key_dto: LicenseKeyDto - :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._set_user_license_serialize( - license_key_dto=license_key_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - 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 set_user_license_without_preload_content( - self, - license_key_dto: LicenseKeyDto, - _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: - """Set user product key - - Register a product key for the current user. - - :param license_key_dto: (required) - :type license_key_dto: LicenseKeyDto - :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._set_user_license_serialize( - license_key_dto=license_key_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserLicense", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _set_user_license_serialize( - self, - license_key_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 license_key_dto is not None: - _body_params = license_key_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='/users/me/license', - 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 set_user_onboarding( - self, - onboarding_dto: OnboardingDto, - _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, - ) -> OnboardingResponseDto: - """Update user onboarding - - Update the onboarding status of the current user. - - :param onboarding_dto: (required) - :type onboarding_dto: OnboardingDto - :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._set_user_onboarding_serialize( - onboarding_dto=onboarding_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "OnboardingResponseDto", - } - 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 set_user_onboarding_with_http_info( - self, - onboarding_dto: OnboardingDto, - _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[OnboardingResponseDto]: - """Update user onboarding - - Update the onboarding status of the current user. - - :param onboarding_dto: (required) - :type onboarding_dto: OnboardingDto - :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._set_user_onboarding_serialize( - onboarding_dto=onboarding_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "OnboardingResponseDto", - } - 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 set_user_onboarding_without_preload_content( - self, - onboarding_dto: OnboardingDto, - _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: - """Update user onboarding - - Update the onboarding status of the current user. - - :param onboarding_dto: (required) - :type onboarding_dto: OnboardingDto - :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._set_user_onboarding_serialize( - onboarding_dto=onboarding_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "OnboardingResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _set_user_onboarding_serialize( - self, - onboarding_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 onboarding_dto is not None: - _body_params = onboarding_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='/users/me/onboarding', - 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 update_my_preferences( - self, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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, - ) -> UserPreferencesResponseDto: - """(Deprecated) Update my preferences - - Update the preferences of the current user. - - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /users/me/preferences is deprecated.", DeprecationWarning) - - _param = self._update_my_preferences_serialize( - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_my_preferences_with_http_info( - self, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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[UserPreferencesResponseDto]: - """(Deprecated) Update my preferences - - Update the preferences of the current user. - - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /users/me/preferences is deprecated.", DeprecationWarning) - - _param = self._update_my_preferences_serialize( - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - 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 update_my_preferences_without_preload_content( - self, - user_preferences_update_dto: UserPreferencesUpdateDto, - _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) Update my preferences - - Update the preferences of the current user. - - :param user_preferences_update_dto: (required) - :type user_preferences_update_dto: UserPreferencesUpdateDto - :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 /users/me/preferences is deprecated.", DeprecationWarning) - - _param = self._update_my_preferences_serialize( - user_preferences_update_dto=user_preferences_update_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserPreferencesResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_my_preferences_serialize( - self, - user_preferences_update_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 user_preferences_update_dto is not None: - _body_params = user_preferences_update_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='/users/me/preferences', - 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 update_my_user( - self, - user_update_me_dto: UserUpdateMeDto, - _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, - ) -> UserAdminResponseDto: - """(Deprecated) Update current user - - Update the current user making the API request. - - :param user_update_me_dto: (required) - :type user_update_me_dto: UserUpdateMeDto - :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 /users/me is deprecated.", DeprecationWarning) - - _param = self._update_my_user_serialize( - user_update_me_dto=user_update_me_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_my_user_with_http_info( - self, - user_update_me_dto: UserUpdateMeDto, - _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[UserAdminResponseDto]: - """(Deprecated) Update current user - - Update the current user making the API request. - - :param user_update_me_dto: (required) - :type user_update_me_dto: UserUpdateMeDto - :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 /users/me is deprecated.", DeprecationWarning) - - _param = self._update_my_user_serialize( - user_update_me_dto=user_update_me_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - 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 update_my_user_without_preload_content( - self, - user_update_me_dto: UserUpdateMeDto, - _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) Update current user - - Update the current user making the API request. - - :param user_update_me_dto: (required) - :type user_update_me_dto: UserUpdateMeDto - :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 /users/me is deprecated.", DeprecationWarning) - - _param = self._update_my_user_serialize( - user_update_me_dto=user_update_me_dto, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "UserAdminResponseDto", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _update_my_user_serialize( - self, - user_update_me_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 user_update_me_dto is not None: - _body_params = user_update_me_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='/users/me', - 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 - ) - - diff --git a/generated/immich/openapi_client/api_client.py b/generated/immich/openapi_client/api_client.py index 215ba34..ebf12a5 100644 --- a/generated/immich/openapi_client/api_client.py +++ b/generated/immich/openapi_client/api_client.py @@ -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]+)[\'"]?', diff --git a/generated/immich/openapi_client/configuration.py b/generated/immich/openapi_client/configuration.py index 6389e2f..92e984d 100644 --- a/generated/immich/openapi_client/configuration.py +++ b/generated/immich/openapi_client/configuration.py @@ -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 diff --git a/generated/immich/openapi_client/docs/APIKeysApi.md b/generated/immich/openapi_client/docs/APIKeysApi.md deleted file mode 100644 index 1013d9d..0000000 --- a/generated/immich/openapi_client/docs/APIKeysApi.md +++ /dev/null @@ -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) - diff --git a/generated/immich/openapi_client/docs/ActivitiesApi.md b/generated/immich/openapi_client/docs/ActivitiesApi.md deleted file mode 100644 index 6d616cc..0000000 --- a/generated/immich/openapi_client/docs/ActivitiesApi.md +++ /dev/null @@ -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) - diff --git a/generated/immich/openapi_client/docs/ActivityCreateDto.md b/generated/immich/openapi_client/docs/ActivityCreateDto.md deleted file mode 100644 index 962f1cf..0000000 --- a/generated/immich/openapi_client/docs/ActivityCreateDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/ActivityResponseDto.md b/generated/immich/openapi_client/docs/ActivityResponseDto.md deleted file mode 100644 index 7b196b1..0000000 --- a/generated/immich/openapi_client/docs/ActivityResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/ActivityStatisticsResponseDto.md b/generated/immich/openapi_client/docs/ActivityStatisticsResponseDto.md deleted file mode 100644 index 4bc1bb6..0000000 --- a/generated/immich/openapi_client/docs/ActivityStatisticsResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AddUsersDto.md b/generated/immich/openapi_client/docs/AddUsersDto.md deleted file mode 100644 index 603a9de..0000000 --- a/generated/immich/openapi_client/docs/AddUsersDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AdminOnboardingUpdateDto.md b/generated/immich/openapi_client/docs/AdminOnboardingUpdateDto.md deleted file mode 100644 index c35d843..0000000 --- a/generated/immich/openapi_client/docs/AdminOnboardingUpdateDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumResponseDto.md b/generated/immich/openapi_client/docs/AlbumResponseDto.md deleted file mode 100644 index 0388f50..0000000 --- a/generated/immich/openapi_client/docs/AlbumResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumStatisticsResponseDto.md b/generated/immich/openapi_client/docs/AlbumStatisticsResponseDto.md deleted file mode 100644 index 9cdd363..0000000 --- a/generated/immich/openapi_client/docs/AlbumStatisticsResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumUserAddDto.md b/generated/immich/openapi_client/docs/AlbumUserAddDto.md deleted file mode 100644 index b8eecc6..0000000 --- a/generated/immich/openapi_client/docs/AlbumUserAddDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumUserCreateDto.md b/generated/immich/openapi_client/docs/AlbumUserCreateDto.md deleted file mode 100644 index c0fa5c2..0000000 --- a/generated/immich/openapi_client/docs/AlbumUserCreateDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumUserResponseDto.md b/generated/immich/openapi_client/docs/AlbumUserResponseDto.md deleted file mode 100644 index 82ec299..0000000 --- a/generated/immich/openapi_client/docs/AlbumUserResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumUserRole.md b/generated/immich/openapi_client/docs/AlbumUserRole.md deleted file mode 100644 index 5f8fcdf..0000000 --- a/generated/immich/openapi_client/docs/AlbumUserRole.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AlbumsApi.md b/generated/immich/openapi_client/docs/AlbumsApi.md deleted file mode 100644 index cc255df..0000000 --- a/generated/immich/openapi_client/docs/AlbumsApi.md +++ /dev/null @@ -1,1241 +0,0 @@ -# generated.immich.openapi_client.AlbumsApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_assets_to_album**](AlbumsApi.md#add_assets_to_album) | **PUT** /albums/{id}/assets | Add assets to an album -[**add_assets_to_albums**](AlbumsApi.md#add_assets_to_albums) | **PUT** /albums/assets | Add assets to albums -[**add_users_to_album**](AlbumsApi.md#add_users_to_album) | **PUT** /albums/{id}/users | Share album with users -[**create_album**](AlbumsApi.md#create_album) | **POST** /albums | Create an album -[**delete_album**](AlbumsApi.md#delete_album) | **DELETE** /albums/{id} | Delete an album -[**get_album_info**](AlbumsApi.md#get_album_info) | **GET** /albums/{id} | Retrieve an album -[**get_album_map_markers**](AlbumsApi.md#get_album_map_markers) | **GET** /albums/{id}/map-markers | Retrieve album map markers -[**get_album_statistics**](AlbumsApi.md#get_album_statistics) | **GET** /albums/statistics | Retrieve album statistics -[**get_all_albums**](AlbumsApi.md#get_all_albums) | **GET** /albums | List all albums -[**remove_asset_from_album**](AlbumsApi.md#remove_asset_from_album) | **DELETE** /albums/{id}/assets | Remove assets from an album -[**remove_user_from_album**](AlbumsApi.md#remove_user_from_album) | **DELETE** /albums/{id}/user/{userId} | Remove user from album -[**update_album_info**](AlbumsApi.md#update_album_info) | **PATCH** /albums/{id} | Update an album -[**update_album_user**](AlbumsApi.md#update_album_user) | **PUT** /albums/{id}/user/{userId} | Update user role - - -# **add_assets_to_album** -> List[BulkIdResponseDto] add_assets_to_album(id, bulk_ids_dto) - -Add assets to an album - -Add multiple assets to a specific album by its ID. - -### 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.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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Add assets to an album - api_response = api_instance.add_assets_to_album(id, bulk_ids_dto) - print("The response of AlbumsApi->add_assets_to_album:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->add_assets_to_album: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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) - -# **add_assets_to_albums** -> AlbumsAddAssetsResponseDto add_assets_to_albums(albums_add_assets_dto) - -Add assets to albums - -Send a list of asset IDs and album IDs to add each asset to each 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.albums_add_assets_dto import AlbumsAddAssetsDto -from generated.immich.openapi_client.models.albums_add_assets_response_dto import AlbumsAddAssetsResponseDto -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.AlbumsApi(api_client) - albums_add_assets_dto = generated.immich.openapi_client.AlbumsAddAssetsDto() # AlbumsAddAssetsDto | - - try: - # Add assets to albums - api_response = api_instance.add_assets_to_albums(albums_add_assets_dto) - print("The response of AlbumsApi->add_assets_to_albums:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->add_assets_to_albums: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **albums_add_assets_dto** | [**AlbumsAddAssetsDto**](AlbumsAddAssetsDto.md)| | - -### Return type - -[**AlbumsAddAssetsResponseDto**](AlbumsAddAssetsResponseDto.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) - -# **add_users_to_album** -> AlbumResponseDto add_users_to_album(id, add_users_dto) - -Share album with users - -Share an album with multiple users. Each user can be given a specific role in the 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.add_users_dto import AddUsersDto -from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto -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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - add_users_dto = generated.immich.openapi_client.AddUsersDto() # AddUsersDto | - - try: - # Share album with users - api_response = api_instance.add_users_to_album(id, add_users_dto) - print("The response of AlbumsApi->add_users_to_album:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->add_users_to_album: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **add_users_dto** | [**AddUsersDto**](AddUsersDto.md)| | - -### Return type - -[**AlbumResponseDto**](AlbumResponseDto.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) - -# **create_album** -> AlbumResponseDto create_album(create_album_dto) - -Create an album - -Create a new album. The album can also be created with initial users and assets. - -### 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.album_response_dto import AlbumResponseDto -from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto -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.AlbumsApi(api_client) - create_album_dto = generated.immich.openapi_client.CreateAlbumDto() # CreateAlbumDto | - - try: - # Create an album - api_response = api_instance.create_album(create_album_dto) - print("The response of AlbumsApi->create_album:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->create_album: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_album_dto** | [**CreateAlbumDto**](CreateAlbumDto.md)| | - -### Return type - -[**AlbumResponseDto**](AlbumResponseDto.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_album** -> delete_album(id) - -Delete an album - -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. - -### 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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete an album - api_instance.delete_album(id) - except Exception as e: - print("Exception when calling AlbumsApi->delete_album: %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_album_info** -> AlbumResponseDto get_album_info(id, key=key, slug=slug) - -Retrieve an album - -Retrieve information about a specific album by its ID. - -### 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.album_response_dto import AlbumResponseDto -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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Retrieve an album - api_response = api_instance.get_album_info(id, key=key, slug=slug) - print("The response of AlbumsApi->get_album_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->get_album_info: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### Return type - -[**AlbumResponseDto**](AlbumResponseDto.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_album_map_markers** -> List[MapMarkerResponseDto] get_album_map_markers(id, key=key, slug=slug) - -Retrieve album map markers - -Retrieve map marker information for a specific album by its ID. - -### 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.map_marker_response_dto import MapMarkerResponseDto -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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Retrieve album map markers - api_response = api_instance.get_album_map_markers(id, key=key, slug=slug) - print("The response of AlbumsApi->get_album_map_markers:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->get_album_map_markers: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### Return type - -[**List[MapMarkerResponseDto]**](MapMarkerResponseDto.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_album_statistics** -> AlbumStatisticsResponseDto get_album_statistics() - -Retrieve album statistics - -Returns statistics about the albums 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.album_statistics_response_dto import AlbumStatisticsResponseDto -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.AlbumsApi(api_client) - - try: - # Retrieve album statistics - api_response = api_instance.get_album_statistics() - print("The response of AlbumsApi->get_album_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->get_album_statistics: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**AlbumStatisticsResponseDto**](AlbumStatisticsResponseDto.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_all_albums** -> List[AlbumResponseDto] get_all_albums(asset_id=asset_id, id=id, is_owned=is_owned, is_shared=is_shared, name=name) - -List all albums - -Retrieve a list of albums 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.album_response_dto import AlbumResponseDto -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.AlbumsApi(api_client) - asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter albums containing this asset ID (ignores other parameters) (optional) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Album ID (optional) - is_owned = True # bool | Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter (optional) - is_shared = True # bool | Filter by shared status: true = only shared, false = not shared, undefined = no filter (optional) - name = 'name_example' # str | Album name (exact match) (optional) - - try: - # List all albums - api_response = api_instance.get_all_albums(asset_id=asset_id, id=id, is_owned=is_owned, is_shared=is_shared, name=name) - print("The response of AlbumsApi->get_all_albums:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->get_all_albums: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_id** | **UUID**| Filter albums containing this asset ID (ignores other parameters) | [optional] - **id** | **UUID**| Album ID | [optional] - **is_owned** | **bool**| Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter | [optional] - **is_shared** | **bool**| Filter by shared status: true = only shared, false = not shared, undefined = no filter | [optional] - **name** | **str**| Album name (exact match) | [optional] - -### Return type - -[**List[AlbumResponseDto]**](AlbumResponseDto.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) - -# **remove_asset_from_album** -> List[BulkIdResponseDto] remove_asset_from_album(id, bulk_ids_dto) - -Remove assets from an album - -Remove multiple assets from a specific album by its ID. - -### 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.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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Remove assets from an album - api_response = api_instance.remove_asset_from_album(id, bulk_ids_dto) - print("The response of AlbumsApi->remove_asset_from_album:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->remove_asset_from_album: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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) - -# **remove_user_from_album** -> remove_user_from_album(id, user_id) - -Remove user from album - -Remove a user from an album. Use an ID of "me" to leave a shared 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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_id = 'user_id_example' # str | - - try: - # Remove user from album - api_instance.remove_user_from_album(id, user_id) - except Exception as e: - print("Exception when calling AlbumsApi->remove_user_from_album: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_id** | **str**| | - -### 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) - -# **update_album_info** -> AlbumResponseDto update_album_info(id, update_album_dto) - -Update an album - -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. - -### 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.album_response_dto import AlbumResponseDto -from generated.immich.openapi_client.models.update_album_dto import UpdateAlbumDto -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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - update_album_dto = generated.immich.openapi_client.UpdateAlbumDto() # UpdateAlbumDto | - - try: - # Update an album - api_response = api_instance.update_album_info(id, update_album_dto) - print("The response of AlbumsApi->update_album_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AlbumsApi->update_album_info: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **update_album_dto** | [**UpdateAlbumDto**](UpdateAlbumDto.md)| | - -### Return type - -[**AlbumResponseDto**](AlbumResponseDto.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) - -# **update_album_user** -> update_album_user(id, user_id, update_album_user_dto) - -Update user role - -Change the role for a specific user in a specific 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.update_album_user_dto import UpdateAlbumUserDto -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.AlbumsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_id = 'user_id_example' # str | - update_album_user_dto = generated.immich.openapi_client.UpdateAlbumUserDto() # UpdateAlbumUserDto | - - try: - # Update user role - api_instance.update_album_user(id, user_id, update_album_user_dto) - except Exception as e: - print("Exception when calling AlbumsApi->update_album_user: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_id** | **str**| | - **update_album_user_dto** | [**UpdateAlbumUserDto**](UpdateAlbumUserDto.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) - diff --git a/generated/immich/openapi_client/docs/AssetBulkDeleteDto.md b/generated/immich/openapi_client/docs/AssetBulkDeleteDto.md deleted file mode 100644 index 9d1b34c..0000000 --- a/generated/immich/openapi_client/docs/AssetBulkDeleteDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetBulkUpdateDto.md b/generated/immich/openapi_client/docs/AssetBulkUpdateDto.md deleted file mode 100644 index 3982ebb..0000000 --- a/generated/immich/openapi_client/docs/AssetBulkUpdateDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetBulkUploadCheckDto.md b/generated/immich/openapi_client/docs/AssetBulkUploadCheckDto.md deleted file mode 100644 index 7c5af92..0000000 --- a/generated/immich/openapi_client/docs/AssetBulkUploadCheckDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetBulkUploadCheckItem.md b/generated/immich/openapi_client/docs/AssetBulkUploadCheckItem.md deleted file mode 100644 index ae258b2..0000000 --- a/generated/immich/openapi_client/docs/AssetBulkUploadCheckItem.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetBulkUploadCheckResponseDto.md b/generated/immich/openapi_client/docs/AssetBulkUploadCheckResponseDto.md deleted file mode 100644 index e7a35f1..0000000 --- a/generated/immich/openapi_client/docs/AssetBulkUploadCheckResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetBulkUploadCheckResult.md b/generated/immich/openapi_client/docs/AssetBulkUploadCheckResult.md deleted file mode 100644 index 4ba14a7..0000000 --- a/generated/immich/openapi_client/docs/AssetBulkUploadCheckResult.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetFaceCreateDto.md b/generated/immich/openapi_client/docs/AssetFaceCreateDto.md deleted file mode 100644 index f8f5fc1..0000000 --- a/generated/immich/openapi_client/docs/AssetFaceCreateDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetFaceDeleteDto.md b/generated/immich/openapi_client/docs/AssetFaceDeleteDto.md deleted file mode 100644 index 4001036..0000000 --- a/generated/immich/openapi_client/docs/AssetFaceDeleteDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetFaceResponseDto.md b/generated/immich/openapi_client/docs/AssetFaceResponseDto.md deleted file mode 100644 index 7344024..0000000 --- a/generated/immich/openapi_client/docs/AssetFaceResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetFaceUpdateDto.md b/generated/immich/openapi_client/docs/AssetFaceUpdateDto.md deleted file mode 100644 index edc22d8..0000000 --- a/generated/immich/openapi_client/docs/AssetFaceUpdateDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetFaceUpdateItem.md b/generated/immich/openapi_client/docs/AssetFaceUpdateItem.md deleted file mode 100644 index 05be2d4..0000000 --- a/generated/immich/openapi_client/docs/AssetFaceUpdateItem.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetIdsDto.md b/generated/immich/openapi_client/docs/AssetIdsDto.md deleted file mode 100644 index 3bedaa2..0000000 --- a/generated/immich/openapi_client/docs/AssetIdsDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetIdsResponseDto.md b/generated/immich/openapi_client/docs/AssetIdsResponseDto.md deleted file mode 100644 index 1cb2ef7..0000000 --- a/generated/immich/openapi_client/docs/AssetIdsResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetJobName.md b/generated/immich/openapi_client/docs/AssetJobName.md deleted file mode 100644 index 0e7f727..0000000 --- a/generated/immich/openapi_client/docs/AssetJobName.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetJobsDto.md b/generated/immich/openapi_client/docs/AssetJobsDto.md deleted file mode 100644 index a61eb0e..0000000 --- a/generated/immich/openapi_client/docs/AssetJobsDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetMediaResponseDto.md b/generated/immich/openapi_client/docs/AssetMediaResponseDto.md deleted file mode 100644 index 2722776..0000000 --- a/generated/immich/openapi_client/docs/AssetMediaResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetMediaSize.md b/generated/immich/openapi_client/docs/AssetMediaSize.md deleted file mode 100644 index 3125e2f..0000000 --- a/generated/immich/openapi_client/docs/AssetMediaSize.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetMediaStatus.md b/generated/immich/openapi_client/docs/AssetMediaStatus.md deleted file mode 100644 index 78b9bc6..0000000 --- a/generated/immich/openapi_client/docs/AssetMediaStatus.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetOrder.md b/generated/immich/openapi_client/docs/AssetOrder.md deleted file mode 100644 index f082eaa..0000000 --- a/generated/immich/openapi_client/docs/AssetOrder.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetResponseDto.md b/generated/immich/openapi_client/docs/AssetResponseDto.md deleted file mode 100644 index 0590be6..0000000 --- a/generated/immich/openapi_client/docs/AssetResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetStackResponseDto.md b/generated/immich/openapi_client/docs/AssetStackResponseDto.md deleted file mode 100644 index 5a4995c..0000000 --- a/generated/immich/openapi_client/docs/AssetStackResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetStatsResponseDto.md b/generated/immich/openapi_client/docs/AssetStatsResponseDto.md deleted file mode 100644 index 4bcbc1c..0000000 --- a/generated/immich/openapi_client/docs/AssetStatsResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetTypeEnum.md b/generated/immich/openapi_client/docs/AssetTypeEnum.md deleted file mode 100644 index 82a2a25..0000000 --- a/generated/immich/openapi_client/docs/AssetTypeEnum.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AssetsApi.md b/generated/immich/openapi_client/docs/AssetsApi.md deleted file mode 100644 index 3eb8d9e..0000000 --- a/generated/immich/openapi_client/docs/AssetsApi.md +++ /dev/null @@ -1,2503 +0,0 @@ -# generated.immich.openapi_client.AssetsApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**check_bulk_upload**](AssetsApi.md#check_bulk_upload) | **POST** /assets/bulk-upload-check | Check bulk upload -[**copy_asset**](AssetsApi.md#copy_asset) | **PUT** /assets/copy | Copy asset -[**delete_asset_metadata**](AssetsApi.md#delete_asset_metadata) | **DELETE** /assets/{id}/metadata/{key} | Delete asset metadata by key -[**delete_assets**](AssetsApi.md#delete_assets) | **DELETE** /assets | Delete assets -[**delete_bulk_asset_metadata**](AssetsApi.md#delete_bulk_asset_metadata) | **DELETE** /assets/metadata | Delete asset metadata -[**download_asset**](AssetsApi.md#download_asset) | **GET** /assets/{id}/original | Download original asset -[**edit_asset**](AssetsApi.md#edit_asset) | **PUT** /assets/{id}/edits | Apply edits to an existing asset -[**end_session**](AssetsApi.md#end_session) | **DELETE** /assets/{id}/video/stream/{sessionId} | End HLS streaming session -[**get_asset_edits**](AssetsApi.md#get_asset_edits) | **GET** /assets/{id}/edits | Retrieve edits for an existing asset -[**get_asset_info**](AssetsApi.md#get_asset_info) | **GET** /assets/{id} | Retrieve an asset -[**get_asset_metadata**](AssetsApi.md#get_asset_metadata) | **GET** /assets/{id}/metadata | Get asset metadata -[**get_asset_metadata_by_key**](AssetsApi.md#get_asset_metadata_by_key) | **GET** /assets/{id}/metadata/{key} | Retrieve asset metadata by key -[**get_asset_ocr**](AssetsApi.md#get_asset_ocr) | **GET** /assets/{id}/ocr | Retrieve asset OCR data -[**get_asset_statistics**](AssetsApi.md#get_asset_statistics) | **GET** /assets/statistics | Get asset statistics -[**get_main_playlist**](AssetsApi.md#get_main_playlist) | **GET** /assets/{id}/video/stream/main.m3u8 | Get HLS main playlist -[**get_media_playlist**](AssetsApi.md#get_media_playlist) | **GET** /assets/{id}/video/stream/{sessionId}/{variantIndex}/playlist.m3u8 | Get HLS media playlist -[**get_segment**](AssetsApi.md#get_segment) | **GET** /assets/{id}/video/stream/{sessionId}/{variantIndex}/{filename} | Get HLS segment or init file -[**play_asset_video**](AssetsApi.md#play_asset_video) | **GET** /assets/{id}/video/playback | Play asset video -[**remove_asset_edits**](AssetsApi.md#remove_asset_edits) | **DELETE** /assets/{id}/edits | Remove edits from an existing asset -[**run_asset_jobs**](AssetsApi.md#run_asset_jobs) | **POST** /assets/jobs | Run an asset job -[**update_asset**](AssetsApi.md#update_asset) | **PUT** /assets/{id} | Update an asset -[**update_asset_metadata**](AssetsApi.md#update_asset_metadata) | **PUT** /assets/{id}/metadata | Update asset metadata -[**update_assets**](AssetsApi.md#update_assets) | **PUT** /assets | Update assets -[**update_bulk_asset_metadata**](AssetsApi.md#update_bulk_asset_metadata) | **PUT** /assets/metadata | Upsert asset metadata -[**upload_asset**](AssetsApi.md#upload_asset) | **POST** /assets | Upload asset -[**view_asset**](AssetsApi.md#view_asset) | **GET** /assets/{id}/thumbnail | View asset thumbnail - - -# **check_bulk_upload** -> AssetBulkUploadCheckResponseDto check_bulk_upload(asset_bulk_upload_check_dto) - -Check bulk upload - -Determine which assets have already been uploaded to the server based on their SHA1 checksums. - -### 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.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto -from generated.immich.openapi_client.models.asset_bulk_upload_check_response_dto import AssetBulkUploadCheckResponseDto -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.AssetsApi(api_client) - asset_bulk_upload_check_dto = generated.immich.openapi_client.AssetBulkUploadCheckDto() # AssetBulkUploadCheckDto | - - try: - # Check bulk upload - api_response = api_instance.check_bulk_upload(asset_bulk_upload_check_dto) - print("The response of AssetsApi->check_bulk_upload:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->check_bulk_upload: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_bulk_upload_check_dto** | [**AssetBulkUploadCheckDto**](AssetBulkUploadCheckDto.md)| | - -### Return type - -[**AssetBulkUploadCheckResponseDto**](AssetBulkUploadCheckResponseDto.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) - -# **copy_asset** -> copy_asset(asset_copy_dto) - -Copy asset - -Copy asset information like albums, tags, etc. from one asset to another. - -### 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.asset_copy_dto import AssetCopyDto -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.AssetsApi(api_client) - asset_copy_dto = generated.immich.openapi_client.AssetCopyDto() # AssetCopyDto | - - try: - # Copy asset - api_instance.copy_asset(asset_copy_dto) - except Exception as e: - print("Exception when calling AssetsApi->copy_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_copy_dto** | [**AssetCopyDto**](AssetCopyDto.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) - -# **delete_asset_metadata** -> delete_asset_metadata(id, key) - -Delete asset metadata by key - -Delete a specific metadata key-value pair associated with the specified asset. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Asset ID - key = 'key_example' # str | Metadata key - - try: - # Delete asset metadata by key - api_instance.delete_asset_metadata(id, key) - except Exception as e: - print("Exception when calling AssetsApi->delete_asset_metadata: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| Asset ID | - **key** | **str**| Metadata key | - -### 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_assets** -> delete_assets(asset_bulk_delete_dto) - -Delete assets - -Deletes multiple assets at the same time. - -### 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.asset_bulk_delete_dto import AssetBulkDeleteDto -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.AssetsApi(api_client) - asset_bulk_delete_dto = generated.immich.openapi_client.AssetBulkDeleteDto() # AssetBulkDeleteDto | - - try: - # Delete assets - api_instance.delete_assets(asset_bulk_delete_dto) - except Exception as e: - print("Exception when calling AssetsApi->delete_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_bulk_delete_dto** | [**AssetBulkDeleteDto**](AssetBulkDeleteDto.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) - -# **delete_bulk_asset_metadata** -> delete_bulk_asset_metadata(asset_metadata_bulk_delete_dto) - -Delete asset metadata - -Delete metadata key-value pairs for multiple assets. - -### 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.asset_metadata_bulk_delete_dto import AssetMetadataBulkDeleteDto -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.AssetsApi(api_client) - asset_metadata_bulk_delete_dto = generated.immich.openapi_client.AssetMetadataBulkDeleteDto() # AssetMetadataBulkDeleteDto | - - try: - # Delete asset metadata - api_instance.delete_bulk_asset_metadata(asset_metadata_bulk_delete_dto) - except Exception as e: - print("Exception when calling AssetsApi->delete_bulk_asset_metadata: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_metadata_bulk_delete_dto** | [**AssetMetadataBulkDeleteDto**](AssetMetadataBulkDeleteDto.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) - -# **download_asset** -> bytearray download_asset(id, edited=edited, key=key, slug=slug) - -Download original asset - -Downloads the original file of the specified asset. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - edited = False # bool | Return edited asset if available (optional) (default to False) - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Download original asset - api_response = api_instance.download_asset(id, edited=edited, key=key, slug=slug) - print("The response of AssetsApi->download_asset:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->download_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **edited** | **bool**| Return edited asset if available | [optional] [default to False] - **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**: Not defined - - **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) - -# **edit_asset** -> AssetEditsResponseDto edit_asset(id, asset_edits_create_dto) - -Apply edits to an existing asset - -Apply a series of edit actions (crop, rotate, mirror) to the specified asset. - -### 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.asset_edits_create_dto import AssetEditsCreateDto -from generated.immich.openapi_client.models.asset_edits_response_dto import AssetEditsResponseDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - asset_edits_create_dto = generated.immich.openapi_client.AssetEditsCreateDto() # AssetEditsCreateDto | - - try: - # Apply edits to an existing asset - api_response = api_instance.edit_asset(id, asset_edits_create_dto) - print("The response of AssetsApi->edit_asset:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->edit_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **asset_edits_create_dto** | [**AssetEditsCreateDto**](AssetEditsCreateDto.md)| | - -### Return type - -[**AssetEditsResponseDto**](AssetEditsResponseDto.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) - -# **end_session** -> end_session(id, session_id, key=key, slug=slug) - -End HLS streaming session - -Releases server resources for the streaming session. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - session_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # End HLS streaming session - api_instance.end_session(id, session_id, key=key, slug=slug) - except Exception as e: - print("Exception when calling AssetsApi->end_session: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **session_id** | **UUID**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### 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_asset_edits** -> AssetEditsResponseDto get_asset_edits(id) - -Retrieve edits for an existing asset - -Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset. - -### 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.asset_edits_response_dto import AssetEditsResponseDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve edits for an existing asset - api_response = api_instance.get_asset_edits(id) - print("The response of AssetsApi->get_asset_edits:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_asset_edits: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**AssetEditsResponseDto**](AssetEditsResponseDto.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_asset_info** -> AssetResponseDto get_asset_info(id, key=key, slug=slug) - -Retrieve an asset - -Retrieve detailed information about a specific asset. - -### 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.asset_response_dto import AssetResponseDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Retrieve an asset - api_response = api_instance.get_asset_info(id, key=key, slug=slug) - print("The response of AssetsApi->get_asset_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_asset_info: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### Return type - -[**AssetResponseDto**](AssetResponseDto.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_asset_metadata** -> List[AssetMetadataResponseDto] get_asset_metadata(id) - -Get asset metadata - -Retrieve all metadata key-value pairs associated with the specified asset. - -### 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.asset_metadata_response_dto import AssetMetadataResponseDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Get asset metadata - api_response = api_instance.get_asset_metadata(id) - print("The response of AssetsApi->get_asset_metadata:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_asset_metadata: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**List[AssetMetadataResponseDto]**](AssetMetadataResponseDto.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_asset_metadata_by_key** -> AssetMetadataResponseDto get_asset_metadata_by_key(id, key) - -Retrieve asset metadata by key - -Retrieve the value of a specific metadata key associated with the specified asset. - -### 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.asset_metadata_response_dto import AssetMetadataResponseDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Asset ID - key = 'key_example' # str | Metadata key - - try: - # Retrieve asset metadata by key - api_response = api_instance.get_asset_metadata_by_key(id, key) - print("The response of AssetsApi->get_asset_metadata_by_key:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_asset_metadata_by_key: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| Asset ID | - **key** | **str**| Metadata key | - -### Return type - -[**AssetMetadataResponseDto**](AssetMetadataResponseDto.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_asset_ocr** -> List[AssetOcrResponseDto] get_asset_ocr(id) - -Retrieve asset OCR data - -Retrieve all OCR (Optical Character Recognition) data associated with the specified asset. - -### 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.asset_ocr_response_dto import AssetOcrResponseDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve asset OCR data - api_response = api_instance.get_asset_ocr(id) - print("The response of AssetsApi->get_asset_ocr:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_asset_ocr: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**List[AssetOcrResponseDto]**](AssetOcrResponseDto.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_asset_statistics** -> AssetStatsResponseDto get_asset_statistics(is_favorite=is_favorite, is_trashed=is_trashed, visibility=visibility) - -Get asset statistics - -Retrieve various statistics about the assets owned by 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.asset_stats_response_dto import AssetStatsResponseDto -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -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.AssetsApi(api_client) - is_favorite = True # bool | Filter by favorite status (optional) - is_trashed = True # bool | Filter by trash status (optional) - visibility = generated.immich.openapi_client.AssetVisibility() # AssetVisibility | (optional) - - try: - # Get asset statistics - api_response = api_instance.get_asset_statistics(is_favorite=is_favorite, is_trashed=is_trashed, visibility=visibility) - print("The response of AssetsApi->get_asset_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_asset_statistics: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **is_favorite** | **bool**| Filter by favorite status | [optional] - **is_trashed** | **bool**| Filter by trash status | [optional] - **visibility** | [**AssetVisibility**](.md)| | [optional] - -### Return type - -[**AssetStatsResponseDto**](AssetStatsResponseDto.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_main_playlist** -> str get_main_playlist(id, key=key, slug=slug) - -Get HLS main playlist - -Returns an HLS main playlist with all available variants for the asset. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Get HLS main playlist - api_response = api_instance.get_main_playlist(id, key=key, slug=slug) - print("The response of AssetsApi->get_main_playlist:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_main_playlist: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### Return type - -**str** - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.apple.mpegurl - -### 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_media_playlist** -> str get_media_playlist(id, session_id, variant_index, key=key, slug=slug, x_immich_hls_pos=x_immich_hls_pos) - -Get HLS media playlist - -Returns an HLS media playlist for one variant of the streaming session. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - session_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - variant_index = 56 # int | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - x_immich_hls_pos = 3.4 # float | (optional) - - try: - # Get HLS media playlist - api_response = api_instance.get_media_playlist(id, session_id, variant_index, key=key, slug=slug, x_immich_hls_pos=x_immich_hls_pos) - print("The response of AssetsApi->get_media_playlist:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_media_playlist: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **session_id** | **UUID**| | - **variant_index** | **int**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - **x_immich_hls_pos** | **float**| | [optional] - -### Return type - -**str** - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.apple.mpegurl - -### 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_segment** -> bytearray get_segment(filename, id, session_id, variant_index, key=key, slug=slug, x_immich_hls_msn=x_immich_hls_msn) - -Get HLS segment or init file - -Streams an HLS init segment (init.mp4) or media segment (seg_N.m4s). - -### 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.AssetsApi(api_client) - filename = 'filename_example' # str | - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - session_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - variant_index = 56 # int | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - x_immich_hls_msn = 56 # int | (optional) - - try: - # Get HLS segment or init file - api_response = api_instance.get_segment(filename, id, session_id, variant_index, key=key, slug=slug, x_immich_hls_msn=x_immich_hls_msn) - print("The response of AssetsApi->get_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->get_segment: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **filename** | **str**| | - **id** | **UUID**| | - **session_id** | **UUID**| | - **variant_index** | **int**| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - **x_immich_hls_msn** | **int**| | [optional] - -### Return type - -**bytearray** - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **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) - -# **play_asset_video** -> bytearray play_asset_video(id, key=key, slug=slug) - -Play asset video - -Streams the video file for the specified asset. This endpoint also supports byte range requests. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Play asset video - api_response = api_instance.play_asset_video(id, key=key, slug=slug) - print("The response of AssetsApi->play_asset_video:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->play_asset_video: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **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**: Not defined - - **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) - -# **remove_asset_edits** -> remove_asset_edits(id) - -Remove edits from an existing asset - -Removes all edit actions (crop, rotate, mirror) associated with the specified asset. - -### 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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Remove edits from an existing asset - api_instance.remove_asset_edits(id) - except Exception as e: - print("Exception when calling AssetsApi->remove_asset_edits: %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) - -# **run_asset_jobs** -> run_asset_jobs(asset_jobs_dto) - -Run an asset job - -Run a specific job on a set of assets. - -### 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.asset_jobs_dto import AssetJobsDto -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.AssetsApi(api_client) - asset_jobs_dto = generated.immich.openapi_client.AssetJobsDto() # AssetJobsDto | - - try: - # Run an asset job - api_instance.run_asset_jobs(asset_jobs_dto) - except Exception as e: - print("Exception when calling AssetsApi->run_asset_jobs: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_jobs_dto** | [**AssetJobsDto**](AssetJobsDto.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) - -# **update_asset** -> AssetResponseDto update_asset(id, update_asset_dto) - -Update an asset - -Update information of a specific asset. - -### 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.asset_response_dto import AssetResponseDto -from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - update_asset_dto = generated.immich.openapi_client.UpdateAssetDto() # UpdateAssetDto | - - try: - # Update an asset - api_response = api_instance.update_asset(id, update_asset_dto) - print("The response of AssetsApi->update_asset:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->update_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **update_asset_dto** | [**UpdateAssetDto**](UpdateAssetDto.md)| | - -### Return type - -[**AssetResponseDto**](AssetResponseDto.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) - -# **update_asset_metadata** -> List[AssetMetadataResponseDto] update_asset_metadata(id, asset_metadata_upsert_dto) - -Update asset metadata - -Update or add metadata key-value pairs for the specified asset. - -### 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.asset_metadata_response_dto import AssetMetadataResponseDto -from generated.immich.openapi_client.models.asset_metadata_upsert_dto import AssetMetadataUpsertDto -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - asset_metadata_upsert_dto = generated.immich.openapi_client.AssetMetadataUpsertDto() # AssetMetadataUpsertDto | - - try: - # Update asset metadata - api_response = api_instance.update_asset_metadata(id, asset_metadata_upsert_dto) - print("The response of AssetsApi->update_asset_metadata:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->update_asset_metadata: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **asset_metadata_upsert_dto** | [**AssetMetadataUpsertDto**](AssetMetadataUpsertDto.md)| | - -### Return type - -[**List[AssetMetadataResponseDto]**](AssetMetadataResponseDto.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) - -# **update_assets** -> update_assets(asset_bulk_update_dto) - -Update assets - -Updates multiple assets at the same time. - -### 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.asset_bulk_update_dto import AssetBulkUpdateDto -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.AssetsApi(api_client) - asset_bulk_update_dto = generated.immich.openapi_client.AssetBulkUpdateDto() # AssetBulkUpdateDto | - - try: - # Update assets - api_instance.update_assets(asset_bulk_update_dto) - except Exception as e: - print("Exception when calling AssetsApi->update_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_bulk_update_dto** | [**AssetBulkUpdateDto**](AssetBulkUpdateDto.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) - -# **update_bulk_asset_metadata** -> List[AssetMetadataBulkResponseDto] update_bulk_asset_metadata(asset_metadata_bulk_upsert_dto) - -Upsert asset metadata - -Upsert metadata key-value pairs for multiple assets. - -### 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.asset_metadata_bulk_response_dto import AssetMetadataBulkResponseDto -from generated.immich.openapi_client.models.asset_metadata_bulk_upsert_dto import AssetMetadataBulkUpsertDto -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.AssetsApi(api_client) - asset_metadata_bulk_upsert_dto = generated.immich.openapi_client.AssetMetadataBulkUpsertDto() # AssetMetadataBulkUpsertDto | - - try: - # Upsert asset metadata - api_response = api_instance.update_bulk_asset_metadata(asset_metadata_bulk_upsert_dto) - print("The response of AssetsApi->update_bulk_asset_metadata:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->update_bulk_asset_metadata: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_metadata_bulk_upsert_dto** | [**AssetMetadataBulkUpsertDto**](AssetMetadataBulkUpsertDto.md)| | - -### Return type - -[**List[AssetMetadataBulkResponseDto]**](AssetMetadataBulkResponseDto.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) - -# **upload_asset** -> AssetMediaResponseDto upload_asset(asset_data, file_created_at, file_modified_at, key=key, slug=slug, x_immich_checksum=x_immich_checksum, duration=duration, filename=filename, is_favorite=is_favorite, live_photo_video_id=live_photo_video_id, metadata=metadata, sidecar_data=sidecar_data, visibility=visibility) - -Upload asset - -Uploads a new asset to the server. - -### 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.asset_media_response_dto import AssetMediaResponseDto -from generated.immich.openapi_client.models.asset_metadata_upsert_item_dto import AssetMetadataUpsertItemDto -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -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.AssetsApi(api_client) - asset_data = None # bytearray | Asset file data - file_created_at = '2013-10-20T19:20:30+01:00' # datetime | File creation date - file_modified_at = '2013-10-20T19:20:30+01:00' # datetime | File modification date - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - x_immich_checksum = 'x_immich_checksum_example' # str | sha1 checksum that can be used for duplicate detection before the file is uploaded (optional) - duration = 56 # int | Duration in milliseconds (for videos) (optional) - filename = 'filename_example' # str | Filename (optional) - is_favorite = True # bool | Mark as favorite (optional) - live_photo_video_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Live photo video ID (optional) - metadata = [generated.immich.openapi_client.AssetMetadataUpsertItemDto()] # List[AssetMetadataUpsertItemDto] | Asset metadata items (optional) - sidecar_data = None # bytearray | Sidecar file data (optional) - visibility = generated.immich.openapi_client.AssetVisibility() # AssetVisibility | (optional) - - try: - # Upload asset - api_response = api_instance.upload_asset(asset_data, file_created_at, file_modified_at, key=key, slug=slug, x_immich_checksum=x_immich_checksum, duration=duration, filename=filename, is_favorite=is_favorite, live_photo_video_id=live_photo_video_id, metadata=metadata, sidecar_data=sidecar_data, visibility=visibility) - print("The response of AssetsApi->upload_asset:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->upload_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_data** | **bytearray**| Asset file data | - **file_created_at** | **datetime**| File creation date | - **file_modified_at** | **datetime**| File modification date | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - **x_immich_checksum** | **str**| sha1 checksum that can be used for duplicate detection before the file is uploaded | [optional] - **duration** | **int**| Duration in milliseconds (for videos) | [optional] - **filename** | **str**| Filename | [optional] - **is_favorite** | **bool**| Mark as favorite | [optional] - **live_photo_video_id** | **UUID**| Live photo video ID | [optional] - **metadata** | [**List[AssetMetadataUpsertItemDto]**](AssetMetadataUpsertItemDto.md)| Asset metadata items | [optional] - **sidecar_data** | **bytearray**| Sidecar file data | [optional] - **visibility** | [**AssetVisibility**](AssetVisibility.md)| | [optional] - -### Return type - -[**AssetMediaResponseDto**](AssetMediaResponseDto.md) - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Asset is a duplicate | - | -**201** | Asset uploaded successfully | - | - -[[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) - -# **view_asset** -> bytearray view_asset(id, edited=edited, key=key, size=size, slug=slug) - -View asset thumbnail - -Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission. - -### 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.asset_media_size import AssetMediaSize -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.AssetsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - edited = False # bool | Return edited asset if available (optional) (default to False) - key = 'key_example' # str | (optional) - size = generated.immich.openapi_client.AssetMediaSize() # AssetMediaSize | (optional) - slug = 'slug_example' # str | (optional) - - try: - # View asset thumbnail - api_response = api_instance.view_asset(id, edited=edited, key=key, size=size, slug=slug) - print("The response of AssetsApi->view_asset:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AssetsApi->view_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **edited** | **bool**| Return edited asset if available | [optional] [default to False] - **key** | **str**| | [optional] - **size** | [**AssetMediaSize**](.md)| | [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**: Not defined - - **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) - diff --git a/generated/immich/openapi_client/docs/AudioCodec.md b/generated/immich/openapi_client/docs/AudioCodec.md deleted file mode 100644 index 727577a..0000000 --- a/generated/immich/openapi_client/docs/AudioCodec.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/AuthenticationApi.md b/generated/immich/openapi_client/docs/AuthenticationApi.md deleted file mode 100644 index f25f242..0000000 --- a/generated/immich/openapi_client/docs/AuthenticationApi.md +++ /dev/null @@ -1,1410 +0,0 @@ -# generated.immich.openapi_client.AuthenticationApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**change_password**](AuthenticationApi.md#change_password) | **POST** /auth/change-password | Change password -[**change_pin_code**](AuthenticationApi.md#change_pin_code) | **PUT** /auth/pin-code | Change pin code -[**finish_o_auth**](AuthenticationApi.md#finish_o_auth) | **POST** /oauth/callback | Finish OAuth -[**get_auth_status**](AuthenticationApi.md#get_auth_status) | **GET** /auth/status | Retrieve auth status -[**link_o_auth_account**](AuthenticationApi.md#link_o_auth_account) | **POST** /oauth/link | Link OAuth account -[**lock_auth_session**](AuthenticationApi.md#lock_auth_session) | **POST** /auth/session/lock | Lock auth session -[**login**](AuthenticationApi.md#login) | **POST** /auth/login | Login -[**logout**](AuthenticationApi.md#logout) | **POST** /auth/logout | Logout -[**logout_o_auth**](AuthenticationApi.md#logout_o_auth) | **POST** /oauth/backchannel-logout | Backchannel OAuth logout -[**redirect_o_auth_to_mobile**](AuthenticationApi.md#redirect_o_auth_to_mobile) | **GET** /oauth/mobile-redirect | Redirect OAuth to mobile -[**reset_pin_code**](AuthenticationApi.md#reset_pin_code) | **DELETE** /auth/pin-code | Reset pin code -[**setup_pin_code**](AuthenticationApi.md#setup_pin_code) | **POST** /auth/pin-code | Setup pin code -[**sign_up_admin**](AuthenticationApi.md#sign_up_admin) | **POST** /auth/admin-sign-up | Register admin -[**start_o_auth**](AuthenticationApi.md#start_o_auth) | **POST** /oauth/authorize | Start OAuth -[**unlink_o_auth_account**](AuthenticationApi.md#unlink_o_auth_account) | **POST** /oauth/unlink | Unlink OAuth account -[**unlock_auth_session**](AuthenticationApi.md#unlock_auth_session) | **POST** /auth/session/unlock | Unlock auth session -[**validate_access_token**](AuthenticationApi.md#validate_access_token) | **POST** /auth/validateToken | Validate access token - - -# **change_password** -> UserAdminResponseDto change_password(change_password_dto) - -Change password - -Change the password 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.change_password_dto import ChangePasswordDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -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.AuthenticationApi(api_client) - change_password_dto = generated.immich.openapi_client.ChangePasswordDto() # ChangePasswordDto | - - try: - # Change password - api_response = api_instance.change_password(change_password_dto) - print("The response of AuthenticationApi->change_password:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->change_password: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **change_password_dto** | [**ChangePasswordDto**](ChangePasswordDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **change_pin_code** -> change_pin_code(pin_code_change_dto) - -Change pin code - -Change the pin code for 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.pin_code_change_dto import PinCodeChangeDto -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.AuthenticationApi(api_client) - pin_code_change_dto = generated.immich.openapi_client.PinCodeChangeDto() # PinCodeChangeDto | - - try: - # Change pin code - api_instance.change_pin_code(pin_code_change_dto) - except Exception as e: - print("Exception when calling AuthenticationApi->change_pin_code: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pin_code_change_dto** | [**PinCodeChangeDto**](PinCodeChangeDto.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) - -# **finish_o_auth** -> LoginResponseDto finish_o_auth(o_auth_callback_dto) - -Finish OAuth - -Complete the OAuth authorization process by exchanging the authorization code for a session token. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto -from generated.immich.openapi_client.models.o_auth_callback_dto import OAuthCallbackDto -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" -) - - -# 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.AuthenticationApi(api_client) - o_auth_callback_dto = generated.immich.openapi_client.OAuthCallbackDto() # OAuthCallbackDto | - - try: - # Finish OAuth - api_response = api_instance.finish_o_auth(o_auth_callback_dto) - print("The response of AuthenticationApi->finish_o_auth:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->finish_o_auth: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **o_auth_callback_dto** | [**OAuthCallbackDto**](OAuthCallbackDto.md)| | - -### Return type - -[**LoginResponseDto**](LoginResponseDto.md) - -### Authorization - -No authorization required - -### 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) - -# **get_auth_status** -> AuthStatusResponseDto get_auth_status() - -Retrieve auth status - -Get information about the current session, including whether the user has a password, and if the session can access locked assets. - -### 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.auth_status_response_dto import AuthStatusResponseDto -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.AuthenticationApi(api_client) - - try: - # Retrieve auth status - api_response = api_instance.get_auth_status() - print("The response of AuthenticationApi->get_auth_status:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->get_auth_status: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**AuthStatusResponseDto**](AuthStatusResponseDto.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) - -# **link_o_auth_account** -> UserAdminResponseDto link_o_auth_account(o_auth_callback_dto) - -Link OAuth account - -Link an OAuth account 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.o_auth_callback_dto import OAuthCallbackDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -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.AuthenticationApi(api_client) - o_auth_callback_dto = generated.immich.openapi_client.OAuthCallbackDto() # OAuthCallbackDto | - - try: - # Link OAuth account - api_response = api_instance.link_o_auth_account(o_auth_callback_dto) - print("The response of AuthenticationApi->link_o_auth_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->link_o_auth_account: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **o_auth_callback_dto** | [**OAuthCallbackDto**](OAuthCallbackDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **lock_auth_session** -> lock_auth_session() - -Lock auth session - -Remove elevated access to locked assets from the current session. - -### 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.AuthenticationApi(api_client) - - try: - # Lock auth session - api_instance.lock_auth_session() - except Exception as e: - print("Exception when calling AuthenticationApi->lock_auth_session: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### 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) - -# **login** -> LoginResponseDto login(login_credential_dto) - -Login - -Login with username and password and receive a session token. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto -from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto -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" -) - - -# 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.AuthenticationApi(api_client) - login_credential_dto = generated.immich.openapi_client.LoginCredentialDto() # LoginCredentialDto | - - try: - # Login - api_response = api_instance.login(login_credential_dto) - print("The response of AuthenticationApi->login:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->login: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **login_credential_dto** | [**LoginCredentialDto**](LoginCredentialDto.md)| | - -### Return type - -[**LoginResponseDto**](LoginResponseDto.md) - -### Authorization - -No authorization required - -### 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) - -# **logout** -> LogoutResponseDto logout() - -Logout - -Logout the current user and invalidate the session token. - -### 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.logout_response_dto import LogoutResponseDto -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.AuthenticationApi(api_client) - - try: - # Logout - api_response = api_instance.logout() - print("The response of AuthenticationApi->logout:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->logout: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**LogoutResponseDto**](LogoutResponseDto.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) - -# **logout_o_auth** -> logout_o_auth(logout_token) - -Backchannel OAuth logout - -Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present. - -### Example - - -```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" -) - - -# 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.AuthenticationApi(api_client) - logout_token = 'logout_token_example' # str | OAuth logout token - - try: - # Backchannel OAuth logout - api_instance.logout_o_auth(logout_token) - except Exception as e: - print("Exception when calling AuthenticationApi->logout_o_auth: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **logout_token** | **str**| OAuth logout token | - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined - -### 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) - -# **redirect_o_auth_to_mobile** -> redirect_o_auth_to_mobile() - -Redirect OAuth to mobile - -Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting. - -### Example - - -```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" -) - - -# 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.AuthenticationApi(api_client) - - try: - # Redirect OAuth to mobile - api_instance.redirect_o_auth_to_mobile() - except Exception as e: - print("Exception when calling AuthenticationApi->redirect_o_auth_to_mobile: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### 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) - -# **reset_pin_code** -> reset_pin_code(pin_code_reset_dto) - -Reset pin code - -Reset the pin code for the current user by providing the account password - -### 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.pin_code_reset_dto import PinCodeResetDto -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.AuthenticationApi(api_client) - pin_code_reset_dto = generated.immich.openapi_client.PinCodeResetDto() # PinCodeResetDto | - - try: - # Reset pin code - api_instance.reset_pin_code(pin_code_reset_dto) - except Exception as e: - print("Exception when calling AuthenticationApi->reset_pin_code: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pin_code_reset_dto** | [**PinCodeResetDto**](PinCodeResetDto.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) - -# **setup_pin_code** -> setup_pin_code(pin_code_setup_dto) - -Setup pin code - -Setup a new pin code for 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.pin_code_setup_dto import PinCodeSetupDto -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.AuthenticationApi(api_client) - pin_code_setup_dto = generated.immich.openapi_client.PinCodeSetupDto() # PinCodeSetupDto | - - try: - # Setup pin code - api_instance.setup_pin_code(pin_code_setup_dto) - except Exception as e: - print("Exception when calling AuthenticationApi->setup_pin_code: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pin_code_setup_dto** | [**PinCodeSetupDto**](PinCodeSetupDto.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) - -# **sign_up_admin** -> UserAdminResponseDto sign_up_admin(sign_up_dto) - -Register admin - -Create the first admin user in the system. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.sign_up_dto import SignUpDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -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" -) - - -# 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.AuthenticationApi(api_client) - sign_up_dto = generated.immich.openapi_client.SignUpDto() # SignUpDto | - - try: - # Register admin - api_response = api_instance.sign_up_admin(sign_up_dto) - print("The response of AuthenticationApi->sign_up_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->sign_up_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **sign_up_dto** | [**SignUpDto**](SignUpDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.md) - -### Authorization - -No authorization required - -### 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) - -# **start_o_auth** -> OAuthAuthorizeResponseDto start_o_auth(o_auth_config_dto) - -Start OAuth - -Initiate the OAuth authorization process. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.o_auth_authorize_response_dto import OAuthAuthorizeResponseDto -from generated.immich.openapi_client.models.o_auth_config_dto import OAuthConfigDto -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" -) - - -# 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.AuthenticationApi(api_client) - o_auth_config_dto = generated.immich.openapi_client.OAuthConfigDto() # OAuthConfigDto | - - try: - # Start OAuth - api_response = api_instance.start_o_auth(o_auth_config_dto) - print("The response of AuthenticationApi->start_o_auth:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->start_o_auth: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **o_auth_config_dto** | [**OAuthConfigDto**](OAuthConfigDto.md)| | - -### Return type - -[**OAuthAuthorizeResponseDto**](OAuthAuthorizeResponseDto.md) - -### Authorization - -No authorization required - -### 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) - -# **unlink_o_auth_account** -> UserAdminResponseDto unlink_o_auth_account() - -Unlink OAuth account - -Unlink the OAuth account from 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.user_admin_response_dto import UserAdminResponseDto -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.AuthenticationApi(api_client) - - try: - # Unlink OAuth account - api_response = api_instance.unlink_o_auth_account() - print("The response of AuthenticationApi->unlink_o_auth_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->unlink_o_auth_account: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **unlock_auth_session** -> unlock_auth_session(session_unlock_dto) - -Unlock auth session - -Temporarily grant the session elevated access to locked assets by providing the correct PIN code. - -### 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.session_unlock_dto import SessionUnlockDto -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.AuthenticationApi(api_client) - session_unlock_dto = generated.immich.openapi_client.SessionUnlockDto() # SessionUnlockDto | - - try: - # Unlock auth session - api_instance.unlock_auth_session(session_unlock_dto) - except Exception as e: - print("Exception when calling AuthenticationApi->unlock_auth_session: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **session_unlock_dto** | [**SessionUnlockDto**](SessionUnlockDto.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) - -# **validate_access_token** -> ValidateAccessTokenResponseDto validate_access_token() - -Validate access token - -Validate the current authorization method is still valid. - -### 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.validate_access_token_response_dto import ValidateAccessTokenResponseDto -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.AuthenticationApi(api_client) - - try: - # Validate access token - api_response = api_instance.validate_access_token() - print("The response of AuthenticationApi->validate_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthenticationApi->validate_access_token: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ValidateAccessTokenResponseDto**](ValidateAccessTokenResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/AvatarUpdate.md b/generated/immich/openapi_client/docs/AvatarUpdate.md deleted file mode 100644 index 58f933c..0000000 --- a/generated/immich/openapi_client/docs/AvatarUpdate.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/BulkIdResponseDto.md b/generated/immich/openapi_client/docs/BulkIdResponseDto.md deleted file mode 100644 index d7c224d..0000000 --- a/generated/immich/openapi_client/docs/BulkIdResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/BulkIdsDto.md b/generated/immich/openapi_client/docs/BulkIdsDto.md deleted file mode 100644 index bf7321a..0000000 --- a/generated/immich/openapi_client/docs/BulkIdsDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/CLIPConfig.md b/generated/immich/openapi_client/docs/CLIPConfig.md deleted file mode 100644 index 658b258..0000000 --- a/generated/immich/openapi_client/docs/CLIPConfig.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/CQMode.md b/generated/immich/openapi_client/docs/CQMode.md deleted file mode 100644 index 7fee1d2..0000000 --- a/generated/immich/openapi_client/docs/CQMode.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/ChangePasswordDto.md b/generated/immich/openapi_client/docs/ChangePasswordDto.md deleted file mode 100644 index 00cc2a6..0000000 --- a/generated/immich/openapi_client/docs/ChangePasswordDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/Colorspace.md b/generated/immich/openapi_client/docs/Colorspace.md deleted file mode 100644 index fbe2c3b..0000000 --- a/generated/immich/openapi_client/docs/Colorspace.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/CreateAlbumDto.md b/generated/immich/openapi_client/docs/CreateAlbumDto.md deleted file mode 100644 index 236fd98..0000000 --- a/generated/immich/openapi_client/docs/CreateAlbumDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/CreateLibraryDto.md b/generated/immich/openapi_client/docs/CreateLibraryDto.md deleted file mode 100644 index d8d93fa..0000000 --- a/generated/immich/openapi_client/docs/CreateLibraryDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/CreateProfileImageResponseDto.md b/generated/immich/openapi_client/docs/CreateProfileImageResponseDto.md deleted file mode 100644 index 4574a56..0000000 --- a/generated/immich/openapi_client/docs/CreateProfileImageResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DatabaseBackupConfig.md b/generated/immich/openapi_client/docs/DatabaseBackupConfig.md deleted file mode 100644 index fbe379b..0000000 --- a/generated/immich/openapi_client/docs/DatabaseBackupConfig.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DeprecatedApi.md b/generated/immich/openapi_client/docs/DeprecatedApi.md deleted file mode 100644 index 9eaf422..0000000 --- a/generated/immich/openapi_client/docs/DeprecatedApi.md +++ /dev/null @@ -1,1622 +0,0 @@ -# generated.immich.openapi_client.DeprecatedApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_partner_deprecated**](DeprecatedApi.md#create_partner_deprecated) | **POST** /partners/{id} | Create a partner -[**get_queues_legacy**](DeprecatedApi.md#get_queues_legacy) | **GET** /jobs | Retrieve queue counts and status -[**run_queue_command_legacy**](DeprecatedApi.md#run_queue_command_legacy) | **PUT** /jobs/{name} | Run jobs -[**update_api_key**](DeprecatedApi.md#update_api_key) | **PUT** /api-keys/{id} | Update an API key -[**update_asset**](DeprecatedApi.md#update_asset) | **PUT** /assets/{id} | Update an asset -[**update_assets**](DeprecatedApi.md#update_assets) | **PUT** /assets | Update assets -[**update_library**](DeprecatedApi.md#update_library) | **PUT** /libraries/{id} | Update a library -[**update_memory**](DeprecatedApi.md#update_memory) | **PUT** /memories/{id} | Update a memory -[**update_my_preferences**](DeprecatedApi.md#update_my_preferences) | **PUT** /users/me/preferences | Update my preferences -[**update_my_user**](DeprecatedApi.md#update_my_user) | **PUT** /users/me | Update current user -[**update_person**](DeprecatedApi.md#update_person) | **PUT** /people/{id} | Update person -[**update_session**](DeprecatedApi.md#update_session) | **PUT** /sessions/{id} | Update a session -[**update_stack**](DeprecatedApi.md#update_stack) | **PUT** /stacks/{id} | Update a stack -[**update_tag**](DeprecatedApi.md#update_tag) | **PUT** /tags/{id} | Update a tag -[**update_user_admin**](DeprecatedApi.md#update_user_admin) | **PUT** /admin/users/{id} | Update a user -[**update_user_preferences_admin**](DeprecatedApi.md#update_user_preferences_admin) | **PUT** /admin/users/{id}/preferences | Update user preferences -[**update_workflow**](DeprecatedApi.md#update_workflow) | **PUT** /workflows/{id} | Update a workflow - - -# **create_partner_deprecated** -> PartnerResponseDto create_partner_deprecated(id) - -Create a partner - -Create a new partner to share assets with. - -### 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.partner_response_dto import PartnerResponseDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Create a partner - api_response = api_instance.create_partner_deprecated(id) - print("The response of DeprecatedApi->create_partner_deprecated:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->create_partner_deprecated: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**PartnerResponseDto**](PartnerResponseDto.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 | -|-------------|-------------|------------------| -**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) - -# **get_queues_legacy** -> QueuesResponseLegacyDto get_queues_legacy() - -Retrieve queue counts and status - -Retrieve the counts of the current queue, as well as the current status. - -### 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.queues_response_legacy_dto import QueuesResponseLegacyDto -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.DeprecatedApi(api_client) - - try: - # Retrieve queue counts and status - api_response = api_instance.get_queues_legacy() - print("The response of DeprecatedApi->get_queues_legacy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->get_queues_legacy: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**QueuesResponseLegacyDto**](QueuesResponseLegacyDto.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) - -# **run_queue_command_legacy** -> QueueResponseLegacyDto run_queue_command_legacy(name, queue_command_dto) - -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. - -### 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.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.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.DeprecatedApi(api_client) - name = generated.immich.openapi_client.QueueName() # QueueName | - queue_command_dto = generated.immich.openapi_client.QueueCommandDto() # QueueCommandDto | - - try: - # Run jobs - api_response = api_instance.run_queue_command_legacy(name, queue_command_dto) - print("The response of DeprecatedApi->run_queue_command_legacy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->run_queue_command_legacy: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**QueueName**](.md)| | - **queue_command_dto** | [**QueueCommandDto**](QueueCommandDto.md)| | - -### Return type - -[**QueueResponseLegacyDto**](QueueResponseLegacyDto.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) - -# **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.DeprecatedApi(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 DeprecatedApi->update_api_key:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->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) - -# **update_asset** -> AssetResponseDto update_asset(id, update_asset_dto) - -Update an asset - -Update information of a specific asset. - -### 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.asset_response_dto import AssetResponseDto -from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - update_asset_dto = generated.immich.openapi_client.UpdateAssetDto() # UpdateAssetDto | - - try: - # Update an asset - api_response = api_instance.update_asset(id, update_asset_dto) - print("The response of DeprecatedApi->update_asset:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_asset: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **update_asset_dto** | [**UpdateAssetDto**](UpdateAssetDto.md)| | - -### Return type - -[**AssetResponseDto**](AssetResponseDto.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) - -# **update_assets** -> update_assets(asset_bulk_update_dto) - -Update assets - -Updates multiple assets at the same time. - -### 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.asset_bulk_update_dto import AssetBulkUpdateDto -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.DeprecatedApi(api_client) - asset_bulk_update_dto = generated.immich.openapi_client.AssetBulkUpdateDto() # AssetBulkUpdateDto | - - try: - # Update assets - api_instance.update_assets(asset_bulk_update_dto) - except Exception as e: - print("Exception when calling DeprecatedApi->update_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_bulk_update_dto** | [**AssetBulkUpdateDto**](AssetBulkUpdateDto.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) - -# **update_library** -> LibraryResponseDto update_library(id, update_library_dto) - -Update a library - -Update an existing external library. - -### 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.library_response_dto import LibraryResponseDto -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - update_library_dto = generated.immich.openapi_client.UpdateLibraryDto() # UpdateLibraryDto | - - try: - # Update a library - api_response = api_instance.update_library(id, update_library_dto) - print("The response of DeprecatedApi->update_library:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_library: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **update_library_dto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| | - -### Return type - -[**LibraryResponseDto**](LibraryResponseDto.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) - -# **update_memory** -> MemoryResponseDto update_memory(id, memory_update_dto) - -Update a memory - -Update an existing memory by its ID. - -### 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.memory_response_dto import MemoryResponseDto -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - memory_update_dto = generated.immich.openapi_client.MemoryUpdateDto() # MemoryUpdateDto | - - try: - # Update a memory - api_response = api_instance.update_memory(id, memory_update_dto) - print("The response of DeprecatedApi->update_memory:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_memory: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **memory_update_dto** | [**MemoryUpdateDto**](MemoryUpdateDto.md)| | - -### Return type - -[**MemoryResponseDto**](MemoryResponseDto.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) - -# **update_my_preferences** -> UserPreferencesResponseDto update_my_preferences(user_preferences_update_dto) - -Update my preferences - -Update the preferences 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.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto -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.DeprecatedApi(api_client) - user_preferences_update_dto = generated.immich.openapi_client.UserPreferencesUpdateDto() # UserPreferencesUpdateDto | - - try: - # Update my preferences - api_response = api_instance.update_my_preferences(user_preferences_update_dto) - print("The response of DeprecatedApi->update_my_preferences:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_my_preferences: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_preferences_update_dto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | - -### Return type - -[**UserPreferencesResponseDto**](UserPreferencesResponseDto.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) - -# **update_my_user** -> UserAdminResponseDto update_my_user(user_update_me_dto) - -Update current user - -Update the current user making the API request. - -### 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.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto -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.DeprecatedApi(api_client) - user_update_me_dto = generated.immich.openapi_client.UserUpdateMeDto() # UserUpdateMeDto | - - try: - # Update current user - api_response = api_instance.update_my_user(user_update_me_dto) - print("The response of DeprecatedApi->update_my_user:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_my_user: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_update_me_dto** | [**UserUpdateMeDto**](UserUpdateMeDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **update_person** -> PersonResponseDto update_person(id, person_update_dto) - -Update person - -Update an individual person. - -### 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.person_response_dto import PersonResponseDto -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - person_update_dto = generated.immich.openapi_client.PersonUpdateDto() # PersonUpdateDto | - - try: - # Update person - api_response = api_instance.update_person(id, person_update_dto) - print("The response of DeprecatedApi->update_person:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_person: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **person_update_dto** | [**PersonUpdateDto**](PersonUpdateDto.md)| | - -### Return type - -[**PersonResponseDto**](PersonResponseDto.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) - -# **update_session** -> SessionResponseDto update_session(id, session_update_dto) - -Update a session - -Update a specific session identified by id. - -### 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.session_response_dto import SessionResponseDto -from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - session_update_dto = generated.immich.openapi_client.SessionUpdateDto() # SessionUpdateDto | - - try: - # Update a session - api_response = api_instance.update_session(id, session_update_dto) - print("The response of DeprecatedApi->update_session:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_session: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **session_update_dto** | [**SessionUpdateDto**](SessionUpdateDto.md)| | - -### Return type - -[**SessionResponseDto**](SessionResponseDto.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) - -# **update_stack** -> StackResponseDto update_stack(id, stack_update_dto) - -Update a stack - -Update an existing stack by its ID. - -### 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.stack_response_dto import StackResponseDto -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - stack_update_dto = generated.immich.openapi_client.StackUpdateDto() # StackUpdateDto | - - try: - # Update a stack - api_response = api_instance.update_stack(id, stack_update_dto) - print("The response of DeprecatedApi->update_stack:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_stack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **stack_update_dto** | [**StackUpdateDto**](StackUpdateDto.md)| | - -### Return type - -[**StackResponseDto**](StackResponseDto.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) - -# **update_tag** -> TagResponseDto update_tag(id, tag_update_dto) - -Update a tag - -Update an existing tag identified by its ID. - -### 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.tag_response_dto import TagResponseDto -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - tag_update_dto = generated.immich.openapi_client.TagUpdateDto() # TagUpdateDto | - - try: - # Update a tag - api_response = api_instance.update_tag(id, tag_update_dto) - print("The response of DeprecatedApi->update_tag:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_tag: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **tag_update_dto** | [**TagUpdateDto**](TagUpdateDto.md)| | - -### Return type - -[**TagResponseDto**](TagResponseDto.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) - -# **update_user_admin** -> UserAdminResponseDto update_user_admin(id, user_admin_update_dto) - -Update a user - -Update an existing 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.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_admin_update_dto = generated.immich.openapi_client.UserAdminUpdateDto() # UserAdminUpdateDto | - - try: - # Update a user - api_response = api_instance.update_user_admin(id, user_admin_update_dto) - print("The response of DeprecatedApi->update_user_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_user_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_admin_update_dto** | [**UserAdminUpdateDto**](UserAdminUpdateDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **update_user_preferences_admin** -> UserPreferencesResponseDto update_user_preferences_admin(id, user_preferences_update_dto) - -Update user preferences - -Update the preferences of a specific 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.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_preferences_update_dto = generated.immich.openapi_client.UserPreferencesUpdateDto() # UserPreferencesUpdateDto | - - try: - # Update user preferences - api_response = api_instance.update_user_preferences_admin(id, user_preferences_update_dto) - print("The response of DeprecatedApi->update_user_preferences_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_user_preferences_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_preferences_update_dto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | - -### Return type - -[**UserPreferencesResponseDto**](UserPreferencesResponseDto.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) - -# **update_workflow** -> WorkflowResponseDto update_workflow(id, workflow_update_dto) - -Update a workflow - -Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. - -### 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.workflow_response_dto import WorkflowResponseDto -from generated.immich.openapi_client.models.workflow_update_dto import WorkflowUpdateDto -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.DeprecatedApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - workflow_update_dto = generated.immich.openapi_client.WorkflowUpdateDto() # WorkflowUpdateDto | - - try: - # Update a workflow - api_response = api_instance.update_workflow(id, workflow_update_dto) - print("The response of DeprecatedApi->update_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DeprecatedApi->update_workflow: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **workflow_update_dto** | [**WorkflowUpdateDto**](WorkflowUpdateDto.md)| | - -### Return type - -[**WorkflowResponseDto**](WorkflowResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/DownloadApi.md b/generated/immich/openapi_client/docs/DownloadApi.md deleted file mode 100644 index def34bc..0000000 --- a/generated/immich/openapi_client/docs/DownloadApi.md +++ /dev/null @@ -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) - diff --git a/generated/immich/openapi_client/docs/DownloadArchiveInfo.md b/generated/immich/openapi_client/docs/DownloadArchiveInfo.md deleted file mode 100644 index d5e8b4e..0000000 --- a/generated/immich/openapi_client/docs/DownloadArchiveInfo.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DownloadInfoDto.md b/generated/immich/openapi_client/docs/DownloadInfoDto.md deleted file mode 100644 index 365ae21..0000000 --- a/generated/immich/openapi_client/docs/DownloadInfoDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DownloadResponse.md b/generated/immich/openapi_client/docs/DownloadResponse.md deleted file mode 100644 index c9751e8..0000000 --- a/generated/immich/openapi_client/docs/DownloadResponse.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DownloadResponseDto.md b/generated/immich/openapi_client/docs/DownloadResponseDto.md deleted file mode 100644 index d27454e..0000000 --- a/generated/immich/openapi_client/docs/DownloadResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DownloadUpdate.md b/generated/immich/openapi_client/docs/DownloadUpdate.md deleted file mode 100644 index 54af760..0000000 --- a/generated/immich/openapi_client/docs/DownloadUpdate.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DuplicateDetectionConfig.md b/generated/immich/openapi_client/docs/DuplicateDetectionConfig.md deleted file mode 100644 index 0bbf104..0000000 --- a/generated/immich/openapi_client/docs/DuplicateDetectionConfig.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DuplicateResponseDto.md b/generated/immich/openapi_client/docs/DuplicateResponseDto.md deleted file mode 100644 index 396f927..0000000 --- a/generated/immich/openapi_client/docs/DuplicateResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/DuplicatesApi.md b/generated/immich/openapi_client/docs/DuplicatesApi.md deleted file mode 100644 index 75b9174..0000000 --- a/generated/immich/openapi_client/docs/DuplicatesApi.md +++ /dev/null @@ -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) - diff --git a/generated/immich/openapi_client/docs/EmailNotificationsResponse.md b/generated/immich/openapi_client/docs/EmailNotificationsResponse.md deleted file mode 100644 index 9a6efa4..0000000 --- a/generated/immich/openapi_client/docs/EmailNotificationsResponse.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/EmailNotificationsUpdate.md b/generated/immich/openapi_client/docs/EmailNotificationsUpdate.md deleted file mode 100644 index 3d8db75..0000000 --- a/generated/immich/openapi_client/docs/EmailNotificationsUpdate.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/ExifResponseDto.md b/generated/immich/openapi_client/docs/ExifResponseDto.md deleted file mode 100644 index 9a71fe8..0000000 --- a/generated/immich/openapi_client/docs/ExifResponseDto.md +++ /dev/null @@ -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) - - diff --git a/generated/immich/openapi_client/docs/FaceDto.md b/generated/immich/openapi_client/docs/FaceDto.md deleted file mode 100644 index bfe834d..0000000 --- a/generated/immich/openapi_client/docs/FaceDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# FaceDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **UUID** | Face ID | - -## Example - -```python -from generated.immich.openapi_client.models.face_dto import FaceDto - -# TODO update the JSON string below -json = "{}" -# create an instance of FaceDto from a JSON string -face_dto_instance = FaceDto.from_json(json) -# print the JSON string representation of the object -print(FaceDto.to_json()) - -# convert the object into a dict -face_dto_dict = face_dto_instance.to_dict() -# create an instance of FaceDto from a dict -face_dto_from_dict = FaceDto.from_dict(face_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) - - diff --git a/generated/immich/openapi_client/docs/FacesApi.md b/generated/immich/openapi_client/docs/FacesApi.md deleted file mode 100644 index 8ab8dec..0000000 --- a/generated/immich/openapi_client/docs/FacesApi.md +++ /dev/null @@ -1,381 +0,0 @@ -# generated.immich.openapi_client.FacesApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_face**](FacesApi.md#create_face) | **POST** /faces | Create a face -[**delete_face**](FacesApi.md#delete_face) | **DELETE** /faces/{id} | Delete a face -[**get_faces**](FacesApi.md#get_faces) | **GET** /faces | Retrieve faces for asset -[**reassign_faces_by_id**](FacesApi.md#reassign_faces_by_id) | **PUT** /faces/{id} | Re-assign a face to another person - - -# **create_face** -> create_face(asset_face_create_dto) - -Create a face - -Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face. - -### 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.asset_face_create_dto import AssetFaceCreateDto -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.FacesApi(api_client) - asset_face_create_dto = generated.immich.openapi_client.AssetFaceCreateDto() # AssetFaceCreateDto | - - try: - # Create a face - api_instance.create_face(asset_face_create_dto) - except Exception as e: - print("Exception when calling FacesApi->create_face: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_face_create_dto** | [**AssetFaceCreateDto**](AssetFaceCreateDto.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 | -|-------------|-------------|------------------| -**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_face** -> delete_face(id, asset_face_delete_dto) - -Delete a face - -Delete a face identified by the id. Optionally can be force deleted. - -### 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.asset_face_delete_dto import AssetFaceDeleteDto -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.FacesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - asset_face_delete_dto = generated.immich.openapi_client.AssetFaceDeleteDto() # AssetFaceDeleteDto | - - try: - # Delete a face - api_instance.delete_face(id, asset_face_delete_dto) - except Exception as e: - print("Exception when calling FacesApi->delete_face: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **asset_face_delete_dto** | [**AssetFaceDeleteDto**](AssetFaceDeleteDto.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_faces** -> List[AssetFaceResponseDto] get_faces(id) - -Retrieve faces for asset - -Retrieve all faces belonging to an asset. - -### 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.asset_face_response_dto import AssetFaceResponseDto -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.FacesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Face ID - - try: - # Retrieve faces for asset - api_response = api_instance.get_faces(id) - print("The response of FacesApi->get_faces:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling FacesApi->get_faces: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| Face ID | - -### Return type - -[**List[AssetFaceResponseDto]**](AssetFaceResponseDto.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) - -# **reassign_faces_by_id** -> PersonResponseDto reassign_faces_by_id(id, face_dto) - -Re-assign a face to another person - -Re-assign the face provided in the body to the person identified by the id in the path parameter. - -### 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.face_dto import FaceDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto -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.FacesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - face_dto = generated.immich.openapi_client.FaceDto() # FaceDto | - - try: - # Re-assign a face to another person - api_response = api_instance.reassign_faces_by_id(id, face_dto) - print("The response of FacesApi->reassign_faces_by_id:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling FacesApi->reassign_faces_by_id: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **face_dto** | [**FaceDto**](FaceDto.md)| | - -### Return type - -[**PersonResponseDto**](PersonResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/FacialRecognitionConfig.md b/generated/immich/openapi_client/docs/FacialRecognitionConfig.md deleted file mode 100644 index 71cd630..0000000 --- a/generated/immich/openapi_client/docs/FacialRecognitionConfig.md +++ /dev/null @@ -1,33 +0,0 @@ -# FacialRecognitionConfig - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether the task is enabled | -**max_distance** | **float** | Maximum distance threshold for face recognition | -**min_faces** | **int** | Minimum number of faces required for recognition | -**min_score** | **float** | Minimum confidence score for face detection | -**model_name** | **str** | Name of the model to use | - -## Example - -```python -from generated.immich.openapi_client.models.facial_recognition_config import FacialRecognitionConfig - -# TODO update the JSON string below -json = "{}" -# create an instance of FacialRecognitionConfig from a JSON string -facial_recognition_config_instance = FacialRecognitionConfig.from_json(json) -# print the JSON string representation of the object -print(FacialRecognitionConfig.to_json()) - -# convert the object into a dict -facial_recognition_config_dict = facial_recognition_config_instance.to_dict() -# create an instance of FacialRecognitionConfig from a dict -facial_recognition_config_from_dict = FacialRecognitionConfig.from_dict(facial_recognition_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) - - diff --git a/generated/immich/openapi_client/docs/FoldersResponse.md b/generated/immich/openapi_client/docs/FoldersResponse.md deleted file mode 100644 index fbc9370..0000000 --- a/generated/immich/openapi_client/docs/FoldersResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# FoldersResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether folders are enabled | -**sidebar_web** | **bool** | Whether folders appear in web sidebar | - -## Example - -```python -from generated.immich.openapi_client.models.folders_response import FoldersResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of FoldersResponse from a JSON string -folders_response_instance = FoldersResponse.from_json(json) -# print the JSON string representation of the object -print(FoldersResponse.to_json()) - -# convert the object into a dict -folders_response_dict = folders_response_instance.to_dict() -# create an instance of FoldersResponse from a dict -folders_response_from_dict = FoldersResponse.from_dict(folders_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) - - diff --git a/generated/immich/openapi_client/docs/FoldersUpdate.md b/generated/immich/openapi_client/docs/FoldersUpdate.md deleted file mode 100644 index ba542e7..0000000 --- a/generated/immich/openapi_client/docs/FoldersUpdate.md +++ /dev/null @@ -1,30 +0,0 @@ -# FoldersUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether folders are enabled | [optional] -**sidebar_web** | **bool** | Whether folders appear in web sidebar | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.folders_update import FoldersUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of FoldersUpdate from a JSON string -folders_update_instance = FoldersUpdate.from_json(json) -# print the JSON string representation of the object -print(FoldersUpdate.to_json()) - -# convert the object into a dict -folders_update_dict = folders_update_instance.to_dict() -# create an instance of FoldersUpdate from a dict -folders_update_from_dict = FoldersUpdate.from_dict(folders_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) - - diff --git a/generated/immich/openapi_client/docs/ImageFormat.md b/generated/immich/openapi_client/docs/ImageFormat.md deleted file mode 100644 index 0d35166..0000000 --- a/generated/immich/openapi_client/docs/ImageFormat.md +++ /dev/null @@ -1,13 +0,0 @@ -# ImageFormat - -Image format - -## Enum - -* `JPEG` (value: `'jpeg'`) - -* `WEBP` (value: `'webp'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/JobCreateDto.md b/generated/immich/openapi_client/docs/JobCreateDto.md deleted file mode 100644 index dc4a547..0000000 --- a/generated/immich/openapi_client/docs/JobCreateDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# JobCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**ManualJobName**](ManualJobName.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.job_create_dto import JobCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of JobCreateDto from a JSON string -job_create_dto_instance = JobCreateDto.from_json(json) -# print the JSON string representation of the object -print(JobCreateDto.to_json()) - -# convert the object into a dict -job_create_dto_dict = job_create_dto_instance.to_dict() -# create an instance of JobCreateDto from a dict -job_create_dto_from_dict = JobCreateDto.from_dict(job_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) - - diff --git a/generated/immich/openapi_client/docs/JobName.md b/generated/immich/openapi_client/docs/JobName.md deleted file mode 100644 index b1a2bbf..0000000 --- a/generated/immich/openapi_client/docs/JobName.md +++ /dev/null @@ -1,141 +0,0 @@ -# JobName - -Job name - -## Enum - -* `ASSETDELETE` (value: `'AssetDelete'`) - -* `ASSETDELETECHECK` (value: `'AssetDeleteCheck'`) - -* `ASSETDETECTFACESQUEUEALL` (value: `'AssetDetectFacesQueueAll'`) - -* `ASSETDETECTFACES` (value: `'AssetDetectFaces'`) - -* `ASSETDETECTDUPLICATESQUEUEALL` (value: `'AssetDetectDuplicatesQueueAll'`) - -* `ASSETDETECTDUPLICATES` (value: `'AssetDetectDuplicates'`) - -* `ASSETEDITTHUMBNAILGENERATION` (value: `'AssetEditThumbnailGeneration'`) - -* `ASSETENCODEVIDEOQUEUEALL` (value: `'AssetEncodeVideoQueueAll'`) - -* `ASSETENCODEVIDEO` (value: `'AssetEncodeVideo'`) - -* `ASSETEMPTYTRASH` (value: `'AssetEmptyTrash'`) - -* `ASSETEXTRACTMETADATAQUEUEALL` (value: `'AssetExtractMetadataQueueAll'`) - -* `ASSETEXTRACTMETADATA` (value: `'AssetExtractMetadata'`) - -* `ASSETFILEMIGRATION` (value: `'AssetFileMigration'`) - -* `ASSETGENERATETHUMBNAILSQUEUEALL` (value: `'AssetGenerateThumbnailsQueueAll'`) - -* `ASSETGENERATETHUMBNAILS` (value: `'AssetGenerateThumbnails'`) - -* `AUDITTABLECLEANUP` (value: `'AuditTableCleanup'`) - -* `DATABASEBACKUP` (value: `'DatabaseBackup'`) - -* `FACIALRECOGNITIONQUEUEALL` (value: `'FacialRecognitionQueueAll'`) - -* `FACIALRECOGNITION` (value: `'FacialRecognition'`) - -* `FILEDELETE` (value: `'FileDelete'`) - -* `FILEMIGRATIONQUEUEALL` (value: `'FileMigrationQueueAll'`) - -* `LIBRARYDELETECHECK` (value: `'LibraryDeleteCheck'`) - -* `LIBRARYDELETE` (value: `'LibraryDelete'`) - -* `LIBRARYREMOVEASSET` (value: `'LibraryRemoveAsset'`) - -* `LIBRARYSCANASSETSQUEUEALL` (value: `'LibraryScanAssetsQueueAll'`) - -* `LIBRARYSYNCASSETS` (value: `'LibrarySyncAssets'`) - -* `LIBRARYSYNCFILESQUEUEALL` (value: `'LibrarySyncFilesQueueAll'`) - -* `LIBRARYSYNCFILES` (value: `'LibrarySyncFiles'`) - -* `LIBRARYSCANQUEUEALL` (value: `'LibraryScanQueueAll'`) - -* `HLSSESSIONCLEANUP` (value: `'HlsSessionCleanup'`) - -* `MEMORYCLEANUP` (value: `'MemoryCleanup'`) - -* `MEMORYGENERATE` (value: `'MemoryGenerate'`) - -* `NOTIFICATIONSCLEANUP` (value: `'NotificationsCleanup'`) - -* `NOTIFYUSERSIGNUP` (value: `'NotifyUserSignup'`) - -* `NOTIFYALBUMINVITE` (value: `'NotifyAlbumInvite'`) - -* `NOTIFYALBUMUPDATE` (value: `'NotifyAlbumUpdate'`) - -* `USERDELETE` (value: `'UserDelete'`) - -* `USERDELETECHECK` (value: `'UserDeleteCheck'`) - -* `USERSYNCUSAGE` (value: `'UserSyncUsage'`) - -* `PERSONCLEANUP` (value: `'PersonCleanup'`) - -* `PERSONFILEMIGRATION` (value: `'PersonFileMigration'`) - -* `PERSONGENERATETHUMBNAIL` (value: `'PersonGenerateThumbnail'`) - -* `SESSIONCLEANUP` (value: `'SessionCleanup'`) - -* `SENDMAIL` (value: `'SendMail'`) - -* `SIDECARQUEUEALL` (value: `'SidecarQueueAll'`) - -* `SIDECARCHECK` (value: `'SidecarCheck'`) - -* `SIDECARWRITE` (value: `'SidecarWrite'`) - -* `SMARTSEARCHQUEUEALL` (value: `'SmartSearchQueueAll'`) - -* `SMARTSEARCH` (value: `'SmartSearch'`) - -* `STORAGETEMPLATEMIGRATION` (value: `'StorageTemplateMigration'`) - -* `STORAGETEMPLATEMIGRATIONSINGLE` (value: `'StorageTemplateMigrationSingle'`) - -* `TAGCLEANUP` (value: `'TagCleanup'`) - -* `VERSIONCHECK` (value: `'VersionCheck'`) - -* `OCRQUEUEALL` (value: `'OcrQueueAll'`) - -* `OCR` (value: `'Ocr'`) - -* `WORKFLOWASSETTRIGGER` (value: `'WorkflowAssetTrigger'`) - -* `INTEGRITYUNTRACKEDFILESQUEUEALL` (value: `'IntegrityUntrackedFilesQueueAll'`) - -* `INTEGRITYUNTRACKEDFILES` (value: `'IntegrityUntrackedFiles'`) - -* `INTEGRITYUNTRACKEDREFRESH` (value: `'IntegrityUntrackedRefresh'`) - -* `INTEGRITYMISSINGFILESQUEUEALL` (value: `'IntegrityMissingFilesQueueAll'`) - -* `INTEGRITYMISSINGFILES` (value: `'IntegrityMissingFiles'`) - -* `INTEGRITYMISSINGFILESREFRESH` (value: `'IntegrityMissingFilesRefresh'`) - -* `INTEGRITYCHECKSUMFILES` (value: `'IntegrityChecksumFiles'`) - -* `INTEGRITYCHECKSUMFILESREFRESH` (value: `'IntegrityChecksumFilesRefresh'`) - -* `INTEGRITYDELETEREPORTTYPE` (value: `'IntegrityDeleteReportType'`) - -* `INTEGRITYDELETEREPORTS` (value: `'IntegrityDeleteReports'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/JobSettingsDto.md b/generated/immich/openapi_client/docs/JobSettingsDto.md deleted file mode 100644 index 191ba55..0000000 --- a/generated/immich/openapi_client/docs/JobSettingsDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# JobSettingsDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**concurrency** | **int** | Concurrency | - -## Example - -```python -from generated.immich.openapi_client.models.job_settings_dto import JobSettingsDto - -# TODO update the JSON string below -json = "{}" -# create an instance of JobSettingsDto from a JSON string -job_settings_dto_instance = JobSettingsDto.from_json(json) -# print the JSON string representation of the object -print(JobSettingsDto.to_json()) - -# convert the object into a dict -job_settings_dto_dict = job_settings_dto_instance.to_dict() -# create an instance of JobSettingsDto from a dict -job_settings_dto_from_dict = JobSettingsDto.from_dict(job_settings_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) - - diff --git a/generated/immich/openapi_client/docs/JobsApi.md b/generated/immich/openapi_client/docs/JobsApi.md deleted file mode 100644 index 5bc1652..0000000 --- a/generated/immich/openapi_client/docs/JobsApi.md +++ /dev/null @@ -1,285 +0,0 @@ -# generated.immich.openapi_client.JobsApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_job**](JobsApi.md#create_job) | **POST** /jobs | Create a manual job -[**get_queues_legacy**](JobsApi.md#get_queues_legacy) | **GET** /jobs | Retrieve queue counts and status -[**run_queue_command_legacy**](JobsApi.md#run_queue_command_legacy) | **PUT** /jobs/{name} | Run jobs - - -# **create_job** -> create_job(job_create_dto) - -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. - -### 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.job_create_dto import JobCreateDto -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.JobsApi(api_client) - job_create_dto = generated.immich.openapi_client.JobCreateDto() # JobCreateDto | - - try: - # Create a manual job - api_instance.create_job(job_create_dto) - except Exception as e: - print("Exception when calling JobsApi->create_job: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **job_create_dto** | [**JobCreateDto**](JobCreateDto.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_queues_legacy** -> QueuesResponseLegacyDto get_queues_legacy() - -Retrieve queue counts and status - -Retrieve the counts of the current queue, as well as the current status. - -### 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.queues_response_legacy_dto import QueuesResponseLegacyDto -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.JobsApi(api_client) - - try: - # Retrieve queue counts and status - api_response = api_instance.get_queues_legacy() - print("The response of JobsApi->get_queues_legacy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling JobsApi->get_queues_legacy: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**QueuesResponseLegacyDto**](QueuesResponseLegacyDto.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) - -# **run_queue_command_legacy** -> QueueResponseLegacyDto run_queue_command_legacy(name, queue_command_dto) - -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. - -### 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.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.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.JobsApi(api_client) - name = generated.immich.openapi_client.QueueName() # QueueName | - queue_command_dto = generated.immich.openapi_client.QueueCommandDto() # QueueCommandDto | - - try: - # Run jobs - api_response = api_instance.run_queue_command_legacy(name, queue_command_dto) - print("The response of JobsApi->run_queue_command_legacy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling JobsApi->run_queue_command_legacy: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**QueueName**](.md)| | - **queue_command_dto** | [**QueueCommandDto**](QueueCommandDto.md)| | - -### Return type - -[**QueueResponseLegacyDto**](QueueResponseLegacyDto.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) - diff --git a/generated/immich/openapi_client/docs/LibrariesApi.md b/generated/immich/openapi_client/docs/LibrariesApi.md deleted file mode 100644 index fe7d529..0000000 --- a/generated/immich/openapi_client/docs/LibrariesApi.md +++ /dev/null @@ -1,749 +0,0 @@ -# generated.immich.openapi_client.LibrariesApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_library**](LibrariesApi.md#create_library) | **POST** /libraries | Create a library -[**delete_library**](LibrariesApi.md#delete_library) | **DELETE** /libraries/{id} | Delete a library -[**get_all_libraries**](LibrariesApi.md#get_all_libraries) | **GET** /libraries | Retrieve libraries -[**get_library**](LibrariesApi.md#get_library) | **GET** /libraries/{id} | Retrieve a library -[**get_library_statistics**](LibrariesApi.md#get_library_statistics) | **GET** /libraries/{id}/statistics | Retrieve library statistics -[**scan_library**](LibrariesApi.md#scan_library) | **POST** /libraries/{id}/scan | Scan a library -[**update_library**](LibrariesApi.md#update_library) | **PUT** /libraries/{id} | Update a library -[**validate**](LibrariesApi.md#validate) | **POST** /libraries/{id}/validate | Validate library settings - - -# **create_library** -> LibraryResponseDto create_library(create_library_dto) - -Create a library - -Create a new external library. - -### 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.create_library_dto import CreateLibraryDto -from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto -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.LibrariesApi(api_client) - create_library_dto = generated.immich.openapi_client.CreateLibraryDto() # CreateLibraryDto | - - try: - # Create a library - api_response = api_instance.create_library(create_library_dto) - print("The response of LibrariesApi->create_library:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LibrariesApi->create_library: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **create_library_dto** | [**CreateLibraryDto**](CreateLibraryDto.md)| | - -### Return type - -[**LibraryResponseDto**](LibraryResponseDto.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_library** -> delete_library(id) - -Delete a library - -Delete an external library by its ID. - -### 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.LibrariesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a library - api_instance.delete_library(id) - except Exception as e: - print("Exception when calling LibrariesApi->delete_library: %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_all_libraries** -> List[LibraryResponseDto] get_all_libraries() - -Retrieve libraries - -Retrieve a list of external libraries. - -### 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.library_response_dto import LibraryResponseDto -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.LibrariesApi(api_client) - - try: - # Retrieve libraries - api_response = api_instance.get_all_libraries() - print("The response of LibrariesApi->get_all_libraries:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LibrariesApi->get_all_libraries: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[LibraryResponseDto]**](LibraryResponseDto.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_library** -> LibraryResponseDto get_library(id) - -Retrieve a library - -Retrieve an external library by its ID. - -### 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.library_response_dto import LibraryResponseDto -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.LibrariesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a library - api_response = api_instance.get_library(id) - print("The response of LibrariesApi->get_library:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LibrariesApi->get_library: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**LibraryResponseDto**](LibraryResponseDto.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_library_statistics** -> LibraryStatsResponseDto get_library_statistics(id) - -Retrieve library statistics - -Retrieve statistics for a specific external library, including number of videos, images, and storage usage. - -### 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.library_stats_response_dto import LibraryStatsResponseDto -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.LibrariesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve library statistics - api_response = api_instance.get_library_statistics(id) - print("The response of LibrariesApi->get_library_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LibrariesApi->get_library_statistics: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**LibraryStatsResponseDto**](LibraryStatsResponseDto.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) - -# **scan_library** -> scan_library(id) - -Scan a library - -Queue a scan for the external library to find and import new assets. - -### 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.LibrariesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Scan a library - api_instance.scan_library(id) - except Exception as e: - print("Exception when calling LibrariesApi->scan_library: %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) - -# **update_library** -> LibraryResponseDto update_library(id, update_library_dto) - -Update a library - -Update an existing external library. - -### 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.library_response_dto import LibraryResponseDto -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto -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.LibrariesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - update_library_dto = generated.immich.openapi_client.UpdateLibraryDto() # UpdateLibraryDto | - - try: - # Update a library - api_response = api_instance.update_library(id, update_library_dto) - print("The response of LibrariesApi->update_library:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LibrariesApi->update_library: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **update_library_dto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| | - -### Return type - -[**LibraryResponseDto**](LibraryResponseDto.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) - -# **validate** -> ValidateLibraryResponseDto validate(id, validate_library_dto) - -Validate library settings - -Validate the settings of an external library. - -### 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.validate_library_dto import ValidateLibraryDto -from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto -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.LibrariesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - validate_library_dto = generated.immich.openapi_client.ValidateLibraryDto() # ValidateLibraryDto | - - try: - # Validate library settings - api_response = api_instance.validate(id, validate_library_dto) - print("The response of LibrariesApi->validate:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LibrariesApi->validate: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **validate_library_dto** | [**ValidateLibraryDto**](ValidateLibraryDto.md)| | - -### Return type - -[**ValidateLibraryResponseDto**](ValidateLibraryResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/LibraryResponseDto.md b/generated/immich/openapi_client/docs/LibraryResponseDto.md deleted file mode 100644 index 628be94..0000000 --- a/generated/immich/openapi_client/docs/LibraryResponseDto.md +++ /dev/null @@ -1,37 +0,0 @@ -# LibraryResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**asset_count** | **int** | Number of assets | -**created_at** | **datetime** | Creation date | -**exclusion_patterns** | **List[str]** | Exclusion patterns | -**id** | **UUID** | Library ID | -**import_paths** | **List[str]** | Import paths | -**name** | **str** | Library name | -**owner_id** | **UUID** | Owner user ID | -**refreshed_at** | **datetime** | Last refresh date | -**updated_at** | **datetime** | Last update date | - -## Example - -```python -from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of LibraryResponseDto from a JSON string -library_response_dto_instance = LibraryResponseDto.from_json(json) -# print the JSON string representation of the object -print(LibraryResponseDto.to_json()) - -# convert the object into a dict -library_response_dto_dict = library_response_dto_instance.to_dict() -# create an instance of LibraryResponseDto from a dict -library_response_dto_from_dict = LibraryResponseDto.from_dict(library_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) - - diff --git a/generated/immich/openapi_client/docs/LibraryStatsResponseDto.md b/generated/immich/openapi_client/docs/LibraryStatsResponseDto.md deleted file mode 100644 index cd37122..0000000 --- a/generated/immich/openapi_client/docs/LibraryStatsResponseDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# LibraryStatsResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**photos** | **int** | Number of photos | -**total** | **int** | Total number of assets | -**usage** | **int** | Storage usage in bytes | -**videos** | **int** | Number of videos | - -## Example - -```python -from generated.immich.openapi_client.models.library_stats_response_dto import LibraryStatsResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of LibraryStatsResponseDto from a JSON string -library_stats_response_dto_instance = LibraryStatsResponseDto.from_json(json) -# print the JSON string representation of the object -print(LibraryStatsResponseDto.to_json()) - -# convert the object into a dict -library_stats_response_dto_dict = library_stats_response_dto_instance.to_dict() -# create an instance of LibraryStatsResponseDto from a dict -library_stats_response_dto_from_dict = LibraryStatsResponseDto.from_dict(library_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) - - diff --git a/generated/immich/openapi_client/docs/LicenseKeyDto.md b/generated/immich/openapi_client/docs/LicenseKeyDto.md deleted file mode 100644 index 33ce47b..0000000 --- a/generated/immich/openapi_client/docs/LicenseKeyDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# LicenseKeyDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**activation_key** | **str** | Activation key | -**license_key** | **str** | License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) | - -## Example - -```python -from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto - -# TODO update the JSON string below -json = "{}" -# create an instance of LicenseKeyDto from a JSON string -license_key_dto_instance = LicenseKeyDto.from_json(json) -# print the JSON string representation of the object -print(LicenseKeyDto.to_json()) - -# convert the object into a dict -license_key_dto_dict = license_key_dto_instance.to_dict() -# create an instance of LicenseKeyDto from a dict -license_key_dto_from_dict = LicenseKeyDto.from_dict(license_key_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) - - diff --git a/generated/immich/openapi_client/docs/LogLevel.md b/generated/immich/openapi_client/docs/LogLevel.md deleted file mode 100644 index e84a7a5..0000000 --- a/generated/immich/openapi_client/docs/LogLevel.md +++ /dev/null @@ -1,21 +0,0 @@ -# LogLevel - -Log level - -## Enum - -* `VERBOSE` (value: `'verbose'`) - -* `DEBUG` (value: `'debug'`) - -* `LOG` (value: `'log'`) - -* `WARN` (value: `'warn'`) - -* `ERROR` (value: `'error'`) - -* `FATAL` (value: `'fatal'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/LoginCredentialDto.md b/generated/immich/openapi_client/docs/LoginCredentialDto.md deleted file mode 100644 index ea2e7fc..0000000 --- a/generated/immich/openapi_client/docs/LoginCredentialDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# LoginCredentialDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | User email | -**password** | **str** | User password | - -## Example - -```python -from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto - -# TODO update the JSON string below -json = "{}" -# create an instance of LoginCredentialDto from a JSON string -login_credential_dto_instance = LoginCredentialDto.from_json(json) -# print the JSON string representation of the object -print(LoginCredentialDto.to_json()) - -# convert the object into a dict -login_credential_dto_dict = login_credential_dto_instance.to_dict() -# create an instance of LoginCredentialDto from a dict -login_credential_dto_from_dict = LoginCredentialDto.from_dict(login_credential_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) - - diff --git a/generated/immich/openapi_client/docs/LoginResponseDto.md b/generated/immich/openapi_client/docs/LoginResponseDto.md deleted file mode 100644 index ceaea55..0000000 --- a/generated/immich/openapi_client/docs/LoginResponseDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# LoginResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | Access token | -**is_admin** | **bool** | Is admin user | -**is_onboarded** | **bool** | Is onboarded | -**name** | **str** | User name | -**profile_image_path** | **str** | Profile image path | -**should_change_password** | **bool** | Should change password | -**user_email** | **str** | User email | -**user_id** | **UUID** | User ID | - -## Example - -```python -from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of LoginResponseDto from a JSON string -login_response_dto_instance = LoginResponseDto.from_json(json) -# print the JSON string representation of the object -print(LoginResponseDto.to_json()) - -# convert the object into a dict -login_response_dto_dict = login_response_dto_instance.to_dict() -# create an instance of LoginResponseDto from a dict -login_response_dto_from_dict = LoginResponseDto.from_dict(login_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) - - diff --git a/generated/immich/openapi_client/docs/LogoutResponseDto.md b/generated/immich/openapi_client/docs/LogoutResponseDto.md deleted file mode 100644 index 8ec7287..0000000 --- a/generated/immich/openapi_client/docs/LogoutResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# LogoutResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**redirect_uri** | **str** | Redirect URI | -**successful** | **bool** | Logout successful | - -## Example - -```python -from generated.immich.openapi_client.models.logout_response_dto import LogoutResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of LogoutResponseDto from a JSON string -logout_response_dto_instance = LogoutResponseDto.from_json(json) -# print the JSON string representation of the object -print(LogoutResponseDto.to_json()) - -# convert the object into a dict -logout_response_dto_dict = logout_response_dto_instance.to_dict() -# create an instance of LogoutResponseDto from a dict -logout_response_dto_from_dict = LogoutResponseDto.from_dict(logout_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) - - diff --git a/generated/immich/openapi_client/docs/ManualJobName.md b/generated/immich/openapi_client/docs/ManualJobName.md deleted file mode 100644 index dd85833..0000000 --- a/generated/immich/openapi_client/docs/ManualJobName.md +++ /dev/null @@ -1,39 +0,0 @@ -# ManualJobName - -Manual job name - -## Enum - -* `PERSON_MINUS_CLEANUP` (value: `'person-cleanup'`) - -* `TAG_MINUS_CLEANUP` (value: `'tag-cleanup'`) - -* `USER_MINUS_CLEANUP` (value: `'user-cleanup'`) - -* `MEMORY_MINUS_CLEANUP` (value: `'memory-cleanup'`) - -* `MEMORY_MINUS_CREATE` (value: `'memory-create'`) - -* `BACKUP_MINUS_DATABASE` (value: `'backup-database'`) - -* `INTEGRITY_MINUS_MISSING_MINUS_FILES` (value: `'integrity-missing-files'`) - -* `INTEGRITY_MINUS_UNTRACKED_MINUS_FILES` (value: `'integrity-untracked-files'`) - -* `INTEGRITY_MINUS_CHECKSUM_MINUS_MISMATCH` (value: `'integrity-checksum-mismatch'`) - -* `INTEGRITY_MINUS_MISSING_MINUS_FILES_MINUS_REFRESH` (value: `'integrity-missing-files-refresh'`) - -* `INTEGRITY_MINUS_UNTRACKED_MINUS_FILES_MINUS_REFRESH` (value: `'integrity-untracked-files-refresh'`) - -* `INTEGRITY_MINUS_CHECKSUM_MINUS_MISMATCH_MINUS_REFRESH` (value: `'integrity-checksum-mismatch-refresh'`) - -* `INTEGRITY_MINUS_MISSING_MINUS_FILES_MINUS_DELETE_MINUS_ALL` (value: `'integrity-missing-files-delete-all'`) - -* `INTEGRITY_MINUS_UNTRACKED_MINUS_FILES_MINUS_DELETE_MINUS_ALL` (value: `'integrity-untracked-files-delete-all'`) - -* `INTEGRITY_MINUS_CHECKSUM_MINUS_MISMATCH_MINUS_DELETE_MINUS_ALL` (value: `'integrity-checksum-mismatch-delete-all'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/MapApi.md b/generated/immich/openapi_client/docs/MapApi.md deleted file mode 100644 index 7978a63..0000000 --- a/generated/immich/openapi_client/docs/MapApi.md +++ /dev/null @@ -1,206 +0,0 @@ -# generated.immich.openapi_client.MapApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_map_markers**](MapApi.md#get_map_markers) | **GET** /map/markers | Retrieve map markers -[**reverse_geocode**](MapApi.md#reverse_geocode) | **GET** /map/reverse-geocode | Reverse geocode coordinates - - -# **get_map_markers** -> List[MapMarkerResponseDto] get_map_markers(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) - -Retrieve map markers - -Retrieve a list of latitude and longitude coordinates for every asset with location data. - -### 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.map_marker_response_dto import MapMarkerResponseDto -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.MapApi(api_client) - file_created_after = '2024-01-01T00:00Z' # datetime | Filter assets created after this date (optional) - file_created_before = '2024-01-01T00:00Z' # datetime | Filter assets created before this date (optional) - is_archived = True # bool | Filter by archived status (optional) - is_favorite = True # bool | Filter by favorite status (optional) - with_partners = True # bool | Include partner assets (optional) - with_shared_albums = True # bool | Include shared album assets (optional) - - try: - # Retrieve map markers - api_response = api_instance.get_map_markers(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) - print("The response of MapApi->get_map_markers:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MapApi->get_map_markers: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file_created_after** | **datetime**| Filter assets created after this date | [optional] - **file_created_before** | **datetime**| Filter assets created before this date | [optional] - **is_archived** | **bool**| Filter by archived status | [optional] - **is_favorite** | **bool**| Filter by favorite status | [optional] - **with_partners** | **bool**| Include partner assets | [optional] - **with_shared_albums** | **bool**| Include shared album assets | [optional] - -### Return type - -[**List[MapMarkerResponseDto]**](MapMarkerResponseDto.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) - -# **reverse_geocode** -> List[MapReverseGeocodeResponseDto] reverse_geocode(lat, lon) - -Reverse geocode coordinates - -Retrieve location information (e.g., city, country) for given latitude and longitude coordinates. - -### 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.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto -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.MapApi(api_client) - lat = 3.4 # float | Latitude (-90 to 90) - lon = 3.4 # float | Longitude (-180 to 180) - - try: - # Reverse geocode coordinates - api_response = api_instance.reverse_geocode(lat, lon) - print("The response of MapApi->reverse_geocode:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MapApi->reverse_geocode: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lat** | **float**| Latitude (-90 to 90) | - **lon** | **float**| Longitude (-180 to 180) | - -### Return type - -[**List[MapReverseGeocodeResponseDto]**](MapReverseGeocodeResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/MapMarkerResponseDto.md b/generated/immich/openapi_client/docs/MapMarkerResponseDto.md deleted file mode 100644 index 20a5371..0000000 --- a/generated/immich/openapi_client/docs/MapMarkerResponseDto.md +++ /dev/null @@ -1,34 +0,0 @@ -# MapMarkerResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**city** | **str** | City name | -**country** | **str** | Country name | -**id** | **UUID** | Asset ID | -**lat** | **float** | Latitude | -**lon** | **float** | Longitude | -**state** | **str** | State/Province name | - -## Example - -```python -from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MapMarkerResponseDto from a JSON string -map_marker_response_dto_instance = MapMarkerResponseDto.from_json(json) -# print the JSON string representation of the object -print(MapMarkerResponseDto.to_json()) - -# convert the object into a dict -map_marker_response_dto_dict = map_marker_response_dto_instance.to_dict() -# create an instance of MapMarkerResponseDto from a dict -map_marker_response_dto_from_dict = MapMarkerResponseDto.from_dict(map_marker_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) - - diff --git a/generated/immich/openapi_client/docs/MapReverseGeocodeResponseDto.md b/generated/immich/openapi_client/docs/MapReverseGeocodeResponseDto.md deleted file mode 100644 index 3a5f15d..0000000 --- a/generated/immich/openapi_client/docs/MapReverseGeocodeResponseDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# MapReverseGeocodeResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**city** | **str** | City name | -**country** | **str** | Country name | -**state** | **str** | State/Province name | - -## Example - -```python -from generated.immich.openapi_client.models.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MapReverseGeocodeResponseDto from a JSON string -map_reverse_geocode_response_dto_instance = MapReverseGeocodeResponseDto.from_json(json) -# print the JSON string representation of the object -print(MapReverseGeocodeResponseDto.to_json()) - -# convert the object into a dict -map_reverse_geocode_response_dto_dict = map_reverse_geocode_response_dto_instance.to_dict() -# create an instance of MapReverseGeocodeResponseDto from a dict -map_reverse_geocode_response_dto_from_dict = MapReverseGeocodeResponseDto.from_dict(map_reverse_geocode_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) - - diff --git a/generated/immich/openapi_client/docs/MemoriesApi.md b/generated/immich/openapi_client/docs/MemoriesApi.md deleted file mode 100644 index 769da80..0000000 --- a/generated/immich/openapi_client/docs/MemoriesApi.md +++ /dev/null @@ -1,783 +0,0 @@ -# generated.immich.openapi_client.MemoriesApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_memory_assets**](MemoriesApi.md#add_memory_assets) | **PUT** /memories/{id}/assets | Add assets to a memory -[**create_memory**](MemoriesApi.md#create_memory) | **POST** /memories | Create a memory -[**delete_memory**](MemoriesApi.md#delete_memory) | **DELETE** /memories/{id} | Delete a memory -[**get_memory**](MemoriesApi.md#get_memory) | **GET** /memories/{id} | Retrieve a memory -[**memories_statistics**](MemoriesApi.md#memories_statistics) | **GET** /memories/statistics | Retrieve memories statistics -[**remove_memory_assets**](MemoriesApi.md#remove_memory_assets) | **DELETE** /memories/{id}/assets | Remove assets from a memory -[**search_memories**](MemoriesApi.md#search_memories) | **GET** /memories | Retrieve memories -[**update_memory**](MemoriesApi.md#update_memory) | **PUT** /memories/{id} | Update a memory - - -# **add_memory_assets** -> List[BulkIdResponseDto] add_memory_assets(id, bulk_ids_dto) - -Add assets to a memory - -Add a list of asset IDs to a specific memory. - -### 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.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.MemoriesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Add assets to a memory - api_response = api_instance.add_memory_assets(id, bulk_ids_dto) - print("The response of MemoriesApi->add_memory_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->add_memory_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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) - -# **create_memory** -> MemoryResponseDto create_memory(memory_create_dto) - -Create a memory - -Create a new memory by providing a name, description, and a list of asset IDs to include in the memory. - -### 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.memory_create_dto import MemoryCreateDto -from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto -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.MemoriesApi(api_client) - memory_create_dto = generated.immich.openapi_client.MemoryCreateDto() # MemoryCreateDto | - - try: - # Create a memory - api_response = api_instance.create_memory(memory_create_dto) - print("The response of MemoriesApi->create_memory:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->create_memory: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **memory_create_dto** | [**MemoryCreateDto**](MemoryCreateDto.md)| | - -### Return type - -[**MemoryResponseDto**](MemoryResponseDto.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_memory** -> delete_memory(id) - -Delete a memory - -Delete a specific memory by its ID. - -### 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.MemoriesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a memory - api_instance.delete_memory(id) - except Exception as e: - print("Exception when calling MemoriesApi->delete_memory: %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_memory** -> MemoryResponseDto get_memory(id) - -Retrieve a memory - -Retrieve a specific memory by its ID. - -### 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.memory_response_dto import MemoryResponseDto -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.MemoriesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a memory - api_response = api_instance.get_memory(id) - print("The response of MemoriesApi->get_memory:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->get_memory: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**MemoryResponseDto**](MemoryResponseDto.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) - -# **memories_statistics** -> MemoryStatisticsResponseDto memories_statistics(var_for=var_for, is_saved=is_saved, is_trashed=is_trashed, order=order, size=size, type=type) - -Retrieve memories statistics - -Retrieve statistics about memories, such as total count and other relevant metrics. - -### 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.memory_search_order import MemorySearchOrder -from generated.immich.openapi_client.models.memory_statistics_response_dto import MemoryStatisticsResponseDto -from generated.immich.openapi_client.models.memory_type import MemoryType -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.MemoriesApi(api_client) - var_for = '2024-01-01T00:00Z' # datetime | Filter by date (optional) - is_saved = True # bool | Filter by saved status (optional) - is_trashed = True # bool | Include trashed memories (optional) - order = generated.immich.openapi_client.MemorySearchOrder() # MemorySearchOrder | (optional) - size = 56 # int | Number of memories to return (optional) - type = generated.immich.openapi_client.MemoryType() # MemoryType | (optional) - - try: - # Retrieve memories statistics - api_response = api_instance.memories_statistics(var_for=var_for, is_saved=is_saved, is_trashed=is_trashed, order=order, size=size, type=type) - print("The response of MemoriesApi->memories_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->memories_statistics: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **var_for** | **datetime**| Filter by date | [optional] - **is_saved** | **bool**| Filter by saved status | [optional] - **is_trashed** | **bool**| Include trashed memories | [optional] - **order** | [**MemorySearchOrder**](.md)| | [optional] - **size** | **int**| Number of memories to return | [optional] - **type** | [**MemoryType**](.md)| | [optional] - -### Return type - -[**MemoryStatisticsResponseDto**](MemoryStatisticsResponseDto.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) - -# **remove_memory_assets** -> List[BulkIdResponseDto] remove_memory_assets(id, bulk_ids_dto) - -Remove assets from a memory - -Remove a list of asset IDs from a specific memory. - -### 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.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.MemoriesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Remove assets from a memory - api_response = api_instance.remove_memory_assets(id, bulk_ids_dto) - print("The response of MemoriesApi->remove_memory_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->remove_memory_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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) - -# **search_memories** -> List[MemoryResponseDto] search_memories(var_for=var_for, is_saved=is_saved, is_trashed=is_trashed, order=order, size=size, type=type) - -Retrieve memories - -Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly. - -### 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.memory_response_dto import MemoryResponseDto -from generated.immich.openapi_client.models.memory_search_order import MemorySearchOrder -from generated.immich.openapi_client.models.memory_type import MemoryType -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.MemoriesApi(api_client) - var_for = '2024-01-01T00:00Z' # datetime | Filter by date (optional) - is_saved = True # bool | Filter by saved status (optional) - is_trashed = True # bool | Include trashed memories (optional) - order = generated.immich.openapi_client.MemorySearchOrder() # MemorySearchOrder | (optional) - size = 56 # int | Number of memories to return (optional) - type = generated.immich.openapi_client.MemoryType() # MemoryType | (optional) - - try: - # Retrieve memories - api_response = api_instance.search_memories(var_for=var_for, is_saved=is_saved, is_trashed=is_trashed, order=order, size=size, type=type) - print("The response of MemoriesApi->search_memories:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->search_memories: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **var_for** | **datetime**| Filter by date | [optional] - **is_saved** | **bool**| Filter by saved status | [optional] - **is_trashed** | **bool**| Include trashed memories | [optional] - **order** | [**MemorySearchOrder**](.md)| | [optional] - **size** | **int**| Number of memories to return | [optional] - **type** | [**MemoryType**](.md)| | [optional] - -### Return type - -[**List[MemoryResponseDto]**](MemoryResponseDto.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_memory** -> MemoryResponseDto update_memory(id, memory_update_dto) - -Update a memory - -Update an existing memory by its ID. - -### 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.memory_response_dto import MemoryResponseDto -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto -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.MemoriesApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - memory_update_dto = generated.immich.openapi_client.MemoryUpdateDto() # MemoryUpdateDto | - - try: - # Update a memory - api_response = api_instance.update_memory(id, memory_update_dto) - print("The response of MemoriesApi->update_memory:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MemoriesApi->update_memory: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **memory_update_dto** | [**MemoryUpdateDto**](MemoryUpdateDto.md)| | - -### Return type - -[**MemoryResponseDto**](MemoryResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/MemoriesResponse.md b/generated/immich/openapi_client/docs/MemoriesResponse.md deleted file mode 100644 index b6a1890..0000000 --- a/generated/immich/openapi_client/docs/MemoriesResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# MemoriesResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**duration** | **int** | Memory duration in seconds | -**enabled** | **bool** | Whether memories are enabled | - -## Example - -```python -from generated.immich.openapi_client.models.memories_response import MemoriesResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of MemoriesResponse from a JSON string -memories_response_instance = MemoriesResponse.from_json(json) -# print the JSON string representation of the object -print(MemoriesResponse.to_json()) - -# convert the object into a dict -memories_response_dict = memories_response_instance.to_dict() -# create an instance of MemoriesResponse from a dict -memories_response_from_dict = MemoriesResponse.from_dict(memories_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) - - diff --git a/generated/immich/openapi_client/docs/MemoriesUpdate.md b/generated/immich/openapi_client/docs/MemoriesUpdate.md deleted file mode 100644 index edae010..0000000 --- a/generated/immich/openapi_client/docs/MemoriesUpdate.md +++ /dev/null @@ -1,30 +0,0 @@ -# MemoriesUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**duration** | **int** | Memory duration in seconds | [optional] -**enabled** | **bool** | Whether memories are enabled | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.memories_update import MemoriesUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of MemoriesUpdate from a JSON string -memories_update_instance = MemoriesUpdate.from_json(json) -# print the JSON string representation of the object -print(MemoriesUpdate.to_json()) - -# convert the object into a dict -memories_update_dict = memories_update_instance.to_dict() -# create an instance of MemoriesUpdate from a dict -memories_update_from_dict = MemoriesUpdate.from_dict(memories_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) - - diff --git a/generated/immich/openapi_client/docs/MemoryCreateDto.md b/generated/immich/openapi_client/docs/MemoryCreateDto.md deleted file mode 100644 index 8a5b6ee..0000000 --- a/generated/immich/openapi_client/docs/MemoryCreateDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# MemoryCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**asset_ids** | **List[UUID]** | Asset IDs to associate with memory | [optional] -**data** | [**OnThisDayDto**](OnThisDayDto.md) | | -**hide_at** | **datetime** | Date when memory should be hidden | [optional] -**is_saved** | **bool** | Is memory saved | [optional] -**memory_at** | **datetime** | Memory date | -**seen_at** | **datetime** | Date when memory was seen | [optional] -**show_at** | **datetime** | Date when memory should be shown | [optional] -**type** | [**MemoryType**](MemoryType.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.memory_create_dto import MemoryCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MemoryCreateDto from a JSON string -memory_create_dto_instance = MemoryCreateDto.from_json(json) -# print the JSON string representation of the object -print(MemoryCreateDto.to_json()) - -# convert the object into a dict -memory_create_dto_dict = memory_create_dto_instance.to_dict() -# create an instance of MemoryCreateDto from a dict -memory_create_dto_from_dict = MemoryCreateDto.from_dict(memory_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) - - diff --git a/generated/immich/openapi_client/docs/MemoryResponseDto.md b/generated/immich/openapi_client/docs/MemoryResponseDto.md deleted file mode 100644 index d158189..0000000 --- a/generated/immich/openapi_client/docs/MemoryResponseDto.md +++ /dev/null @@ -1,41 +0,0 @@ -# MemoryResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | | -**created_at** | **datetime** | Creation date | -**data** | [**OnThisDayDto**](OnThisDayDto.md) | | -**deleted_at** | **datetime** | Deletion date | [optional] -**hide_at** | **datetime** | Date when memory should be hidden | [optional] -**id** | **UUID** | Memory ID | -**is_saved** | **bool** | Is memory saved | -**memory_at** | **datetime** | Memory date | -**owner_id** | **UUID** | Owner user ID | -**seen_at** | **datetime** | Date when memory was seen | [optional] -**show_at** | **datetime** | Date when memory should be shown | [optional] -**type** | [**MemoryType**](MemoryType.md) | | -**updated_at** | **datetime** | Last update date | - -## Example - -```python -from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MemoryResponseDto from a JSON string -memory_response_dto_instance = MemoryResponseDto.from_json(json) -# print the JSON string representation of the object -print(MemoryResponseDto.to_json()) - -# convert the object into a dict -memory_response_dto_dict = memory_response_dto_instance.to_dict() -# create an instance of MemoryResponseDto from a dict -memory_response_dto_from_dict = MemoryResponseDto.from_dict(memory_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) - - diff --git a/generated/immich/openapi_client/docs/MemoryType.md b/generated/immich/openapi_client/docs/MemoryType.md deleted file mode 100644 index c4a1bfd..0000000 --- a/generated/immich/openapi_client/docs/MemoryType.md +++ /dev/null @@ -1,11 +0,0 @@ -# MemoryType - -Memory type - -## Enum - -* `ON_THIS_DAY` (value: `'on_this_day'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/MemoryUpdateDto.md b/generated/immich/openapi_client/docs/MemoryUpdateDto.md deleted file mode 100644 index f494c3c..0000000 --- a/generated/immich/openapi_client/docs/MemoryUpdateDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# MemoryUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**is_saved** | **bool** | Is memory saved | [optional] -**memory_at** | **datetime** | Memory date | [optional] -**seen_at** | **datetime** | Date when memory was seen | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MemoryUpdateDto from a JSON string -memory_update_dto_instance = MemoryUpdateDto.from_json(json) -# print the JSON string representation of the object -print(MemoryUpdateDto.to_json()) - -# convert the object into a dict -memory_update_dto_dict = memory_update_dto_instance.to_dict() -# create an instance of MemoryUpdateDto from a dict -memory_update_dto_from_dict = MemoryUpdateDto.from_dict(memory_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) - - diff --git a/generated/immich/openapi_client/docs/MergePersonDto.md b/generated/immich/openapi_client/docs/MergePersonDto.md deleted file mode 100644 index 66b0324..0000000 --- a/generated/immich/openapi_client/docs/MergePersonDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# MergePersonDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ids** | **List[UUID]** | Person IDs to merge | - -## Example - -```python -from generated.immich.openapi_client.models.merge_person_dto import MergePersonDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MergePersonDto from a JSON string -merge_person_dto_instance = MergePersonDto.from_json(json) -# print the JSON string representation of the object -print(MergePersonDto.to_json()) - -# convert the object into a dict -merge_person_dto_dict = merge_person_dto_instance.to_dict() -# create an instance of MergePersonDto from a dict -merge_person_dto_from_dict = MergePersonDto.from_dict(merge_person_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) - - diff --git a/generated/immich/openapi_client/docs/MetadataSearchDto.md b/generated/immich/openapi_client/docs/MetadataSearchDto.md deleted file mode 100644 index da55259..0000000 --- a/generated/immich/openapi_client/docs/MetadataSearchDto.md +++ /dev/null @@ -1,70 +0,0 @@ -# MetadataSearchDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album_ids** | **List[UUID]** | Filter by album IDs | [optional] -**checksum** | **str** | Filter by file checksum | [optional] -**city** | **str** | Filter by city name | [optional] -**country** | **str** | Filter by country name | [optional] -**created_after** | **datetime** | Filter by creation date (after) | [optional] -**created_before** | **datetime** | Filter by creation date (before) | [optional] -**description** | **str** | Filter by description text | [optional] -**encoded_video_path** | **str** | Filter by encoded video file path | [optional] -**id** | **UUID** | Filter by asset ID | [optional] -**is_encoded** | **bool** | Filter by encoded status | [optional] -**is_favorite** | **bool** | Filter by favorite status | [optional] -**is_motion** | **bool** | Filter by motion photo status | [optional] -**is_not_in_album** | **bool** | Filter assets not in any album | [optional] -**is_offline** | **bool** | Filter by offline status | [optional] -**lens_model** | **str** | Filter by lens model | [optional] -**library_id** | **UUID** | Library ID to filter by | [optional] -**make** | **str** | Filter by camera make | [optional] -**model** | **str** | Filter by camera model | [optional] -**ocr** | **str** | Filter by OCR text content | [optional] -**order** | [**AssetOrder**](AssetOrder.md) | | [optional] -**original_file_name** | **str** | Filter by original file name | [optional] -**original_path** | **str** | Filter by original file path | [optional] -**page** | **int** | Page number | [optional] -**person_ids** | **List[UUID]** | Filter by person IDs | [optional] -**preview_path** | **str** | Filter by preview file path | [optional] -**rating** | **int** | Filter by rating [1-5], or null for unrated | [optional] -**size** | **int** | Number of results to return | [optional] -**state** | **str** | Filter by state/province name | [optional] -**tag_ids** | **List[UUID]** | Filter by tag IDs | [optional] -**taken_after** | **datetime** | Filter by taken date (after) | [optional] -**taken_before** | **datetime** | Filter by taken date (before) | [optional] -**thumbnail_path** | **str** | Filter by thumbnail file path | [optional] -**trashed_after** | **datetime** | Filter by trash date (after) | [optional] -**trashed_before** | **datetime** | Filter by trash date (before) | [optional] -**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | [optional] -**updated_after** | **datetime** | Filter by update date (after) | [optional] -**updated_before** | **datetime** | Filter by update date (before) | [optional] -**visibility** | [**AssetVisibility**](AssetVisibility.md) | | [optional] -**with_deleted** | **bool** | Include deleted assets | [optional] -**with_exif** | **bool** | Include EXIF data in response | [optional] -**with_people** | **bool** | Include people data in response | [optional] -**with_stacked** | **bool** | Include stacked assets | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.metadata_search_dto import MetadataSearchDto - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataSearchDto from a JSON string -metadata_search_dto_instance = MetadataSearchDto.from_json(json) -# print the JSON string representation of the object -print(MetadataSearchDto.to_json()) - -# convert the object into a dict -metadata_search_dto_dict = metadata_search_dto_instance.to_dict() -# create an instance of MetadataSearchDto from a dict -metadata_search_dto_from_dict = MetadataSearchDto.from_dict(metadata_search_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) - - diff --git a/generated/immich/openapi_client/docs/NotificationsApi.md b/generated/immich/openapi_client/docs/NotificationsApi.md deleted file mode 100644 index 6389fe5..0000000 --- a/generated/immich/openapi_client/docs/NotificationsApi.md +++ /dev/null @@ -1,570 +0,0 @@ -# generated.immich.openapi_client.NotificationsApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_notification**](NotificationsApi.md#delete_notification) | **DELETE** /notifications/{id} | Delete a notification -[**delete_notifications**](NotificationsApi.md#delete_notifications) | **DELETE** /notifications | Delete notifications -[**get_notification**](NotificationsApi.md#get_notification) | **GET** /notifications/{id} | Get a notification -[**get_notifications**](NotificationsApi.md#get_notifications) | **GET** /notifications | Retrieve notifications -[**update_notification**](NotificationsApi.md#update_notification) | **PUT** /notifications/{id} | Update a notification -[**update_notifications**](NotificationsApi.md#update_notifications) | **PUT** /notifications | Update notifications - - -# **delete_notification** -> delete_notification(id) - -Delete a notification - -Delete a specific notification. - -### 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.NotificationsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a notification - api_instance.delete_notification(id) - except Exception as e: - print("Exception when calling NotificationsApi->delete_notification: %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_notifications** -> delete_notifications(notification_delete_all_dto) - -Delete notifications - -Delete a list of notifications at once. - -### 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.notification_delete_all_dto import NotificationDeleteAllDto -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.NotificationsApi(api_client) - notification_delete_all_dto = generated.immich.openapi_client.NotificationDeleteAllDto() # NotificationDeleteAllDto | - - try: - # Delete notifications - api_instance.delete_notifications(notification_delete_all_dto) - except Exception as e: - print("Exception when calling NotificationsApi->delete_notifications: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **notification_delete_all_dto** | [**NotificationDeleteAllDto**](NotificationDeleteAllDto.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_notification** -> NotificationDto get_notification(id) - -Get a notification - -Retrieve a specific notification identified by id. - -### 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.notification_dto import NotificationDto -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.NotificationsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Get a notification - api_response = api_instance.get_notification(id) - print("The response of NotificationsApi->get_notification:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->get_notification: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**NotificationDto**](NotificationDto.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_notifications** -> List[NotificationDto] get_notifications(id=id, level=level, type=type, unread=unread) - -Retrieve notifications - -Retrieve a list of notifications. - -### 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.notification_dto import NotificationDto -from generated.immich.openapi_client.models.notification_level import NotificationLevel -from generated.immich.openapi_client.models.notification_type import NotificationType -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.NotificationsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by notification ID (optional) - level = generated.immich.openapi_client.NotificationLevel() # NotificationLevel | (optional) - type = generated.immich.openapi_client.NotificationType() # NotificationType | (optional) - unread = True # bool | Filter by unread status (optional) - - try: - # Retrieve notifications - api_response = api_instance.get_notifications(id=id, level=level, type=type, unread=unread) - print("The response of NotificationsApi->get_notifications:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->get_notifications: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| Filter by notification ID | [optional] - **level** | [**NotificationLevel**](.md)| | [optional] - **type** | [**NotificationType**](.md)| | [optional] - **unread** | **bool**| Filter by unread status | [optional] - -### Return type - -[**List[NotificationDto]**](NotificationDto.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_notification** -> NotificationDto update_notification(id, notification_update_dto) - -Update a notification - -Update a specific notification to set its read status. - -### 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.notification_dto import NotificationDto -from generated.immich.openapi_client.models.notification_update_dto import NotificationUpdateDto -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.NotificationsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - notification_update_dto = generated.immich.openapi_client.NotificationUpdateDto() # NotificationUpdateDto | - - try: - # Update a notification - api_response = api_instance.update_notification(id, notification_update_dto) - print("The response of NotificationsApi->update_notification:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->update_notification: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **notification_update_dto** | [**NotificationUpdateDto**](NotificationUpdateDto.md)| | - -### Return type - -[**NotificationDto**](NotificationDto.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) - -# **update_notifications** -> update_notifications(notification_update_all_dto) - -Update notifications - -Update a list of notifications. Allows to bulk-set the read status of notifications. - -### 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.notification_update_all_dto import NotificationUpdateAllDto -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.NotificationsApi(api_client) - notification_update_all_dto = generated.immich.openapi_client.NotificationUpdateAllDto() # NotificationUpdateAllDto | - - try: - # Update notifications - api_instance.update_notifications(notification_update_all_dto) - except Exception as e: - print("Exception when calling NotificationsApi->update_notifications: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **notification_update_all_dto** | [**NotificationUpdateAllDto**](NotificationUpdateAllDto.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) - diff --git a/generated/immich/openapi_client/docs/OAuthAuthorizeResponseDto.md b/generated/immich/openapi_client/docs/OAuthAuthorizeResponseDto.md deleted file mode 100644 index 5ce03f1..0000000 --- a/generated/immich/openapi_client/docs/OAuthAuthorizeResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# OAuthAuthorizeResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | OAuth authorization URL | - -## Example - -```python -from generated.immich.openapi_client.models.o_auth_authorize_response_dto import OAuthAuthorizeResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of OAuthAuthorizeResponseDto from a JSON string -o_auth_authorize_response_dto_instance = OAuthAuthorizeResponseDto.from_json(json) -# print the JSON string representation of the object -print(OAuthAuthorizeResponseDto.to_json()) - -# convert the object into a dict -o_auth_authorize_response_dto_dict = o_auth_authorize_response_dto_instance.to_dict() -# create an instance of OAuthAuthorizeResponseDto from a dict -o_auth_authorize_response_dto_from_dict = OAuthAuthorizeResponseDto.from_dict(o_auth_authorize_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) - - diff --git a/generated/immich/openapi_client/docs/OAuthCallbackDto.md b/generated/immich/openapi_client/docs/OAuthCallbackDto.md deleted file mode 100644 index 68426e3..0000000 --- a/generated/immich/openapi_client/docs/OAuthCallbackDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# OAuthCallbackDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code_verifier** | **str** | OAuth code verifier (PKCE) | [optional] -**state** | **str** | OAuth state parameter | [optional] -**url** | **str** | OAuth callback URL | - -## Example - -```python -from generated.immich.openapi_client.models.o_auth_callback_dto import OAuthCallbackDto - -# TODO update the JSON string below -json = "{}" -# create an instance of OAuthCallbackDto from a JSON string -o_auth_callback_dto_instance = OAuthCallbackDto.from_json(json) -# print the JSON string representation of the object -print(OAuthCallbackDto.to_json()) - -# convert the object into a dict -o_auth_callback_dto_dict = o_auth_callback_dto_instance.to_dict() -# create an instance of OAuthCallbackDto from a dict -o_auth_callback_dto_from_dict = OAuthCallbackDto.from_dict(o_auth_callback_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) - - diff --git a/generated/immich/openapi_client/docs/OAuthConfigDto.md b/generated/immich/openapi_client/docs/OAuthConfigDto.md deleted file mode 100644 index dd02d32..0000000 --- a/generated/immich/openapi_client/docs/OAuthConfigDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# OAuthConfigDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code_challenge** | **str** | OAuth code challenge (PKCE) | [optional] -**redirect_uri** | **str** | OAuth redirect URI | -**state** | **str** | OAuth state parameter | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.o_auth_config_dto import OAuthConfigDto - -# TODO update the JSON string below -json = "{}" -# create an instance of OAuthConfigDto from a JSON string -o_auth_config_dto_instance = OAuthConfigDto.from_json(json) -# print the JSON string representation of the object -print(OAuthConfigDto.to_json()) - -# convert the object into a dict -o_auth_config_dto_dict = o_auth_config_dto_instance.to_dict() -# create an instance of OAuthConfigDto from a dict -o_auth_config_dto_from_dict = OAuthConfigDto.from_dict(o_auth_config_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) - - diff --git a/generated/immich/openapi_client/docs/OnThisDayDto.md b/generated/immich/openapi_client/docs/OnThisDayDto.md deleted file mode 100644 index 7ac4867..0000000 --- a/generated/immich/openapi_client/docs/OnThisDayDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# OnThisDayDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**year** | **int** | Year for on this day memory | - -## Example - -```python -from generated.immich.openapi_client.models.on_this_day_dto import OnThisDayDto - -# TODO update the JSON string below -json = "{}" -# create an instance of OnThisDayDto from a JSON string -on_this_day_dto_instance = OnThisDayDto.from_json(json) -# print the JSON string representation of the object -print(OnThisDayDto.to_json()) - -# convert the object into a dict -on_this_day_dto_dict = on_this_day_dto_instance.to_dict() -# create an instance of OnThisDayDto from a dict -on_this_day_dto_from_dict = OnThisDayDto.from_dict(on_this_day_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) - - diff --git a/generated/immich/openapi_client/docs/PartnerDirection.md b/generated/immich/openapi_client/docs/PartnerDirection.md deleted file mode 100644 index 2e6fc0a..0000000 --- a/generated/immich/openapi_client/docs/PartnerDirection.md +++ /dev/null @@ -1,13 +0,0 @@ -# PartnerDirection - -Partner direction - -## Enum - -* `SHARED_MINUS_BY` (value: `'shared-by'`) - -* `SHARED_MINUS_WITH` (value: `'shared-with'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/PartnerResponseDto.md b/generated/immich/openapi_client/docs/PartnerResponseDto.md deleted file mode 100644 index ec1d5cd..0000000 --- a/generated/immich/openapi_client/docs/PartnerResponseDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# PartnerResponseDto - -Partner response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | -**email** | **str** | User email | -**id** | **UUID** | User ID | -**in_timeline** | **bool** | Show in timeline | [optional] -**name** | **str** | User name | -**profile_changed_at** | **datetime** | Profile change date | -**profile_image_path** | **str** | Profile image path | - -## Example - -```python -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PartnerResponseDto from a JSON string -partner_response_dto_instance = PartnerResponseDto.from_json(json) -# print the JSON string representation of the object -print(PartnerResponseDto.to_json()) - -# convert the object into a dict -partner_response_dto_dict = partner_response_dto_instance.to_dict() -# create an instance of PartnerResponseDto from a dict -partner_response_dto_from_dict = PartnerResponseDto.from_dict(partner_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) - - diff --git a/generated/immich/openapi_client/docs/PartnersApi.md b/generated/immich/openapi_client/docs/PartnersApi.md deleted file mode 100644 index 3bac636..0000000 --- a/generated/immich/openapi_client/docs/PartnersApi.md +++ /dev/null @@ -1,475 +0,0 @@ -# generated.immich.openapi_client.PartnersApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_partner**](PartnersApi.md#create_partner) | **POST** /partners | Create a partner -[**create_partner_deprecated**](PartnersApi.md#create_partner_deprecated) | **POST** /partners/{id} | Create a partner -[**get_partners**](PartnersApi.md#get_partners) | **GET** /partners | Retrieve partners -[**remove_partner**](PartnersApi.md#remove_partner) | **DELETE** /partners/{id} | Remove a partner -[**update_partner**](PartnersApi.md#update_partner) | **PUT** /partners/{id} | Update a partner - - -# **create_partner** -> PartnerResponseDto create_partner(partner_create_dto) - -Create a partner - -Create a new partner to share assets with. - -### 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.partner_create_dto import PartnerCreateDto -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto -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.PartnersApi(api_client) - partner_create_dto = generated.immich.openapi_client.PartnerCreateDto() # PartnerCreateDto | - - try: - # Create a partner - api_response = api_instance.create_partner(partner_create_dto) - print("The response of PartnersApi->create_partner:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PartnersApi->create_partner: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **partner_create_dto** | [**PartnerCreateDto**](PartnerCreateDto.md)| | - -### Return type - -[**PartnerResponseDto**](PartnerResponseDto.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) - -# **create_partner_deprecated** -> PartnerResponseDto create_partner_deprecated(id) - -Create a partner - -Create a new partner to share assets with. - -### 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.partner_response_dto import PartnerResponseDto -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.PartnersApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Create a partner - api_response = api_instance.create_partner_deprecated(id) - print("The response of PartnersApi->create_partner_deprecated:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PartnersApi->create_partner_deprecated: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**PartnerResponseDto**](PartnerResponseDto.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 | -|-------------|-------------|------------------| -**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) - -# **get_partners** -> List[PartnerResponseDto] get_partners(direction) - -Retrieve partners - -Retrieve a list of partners with whom assets are shared. - -### 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.partner_direction import PartnerDirection -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto -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.PartnersApi(api_client) - direction = generated.immich.openapi_client.PartnerDirection() # PartnerDirection | - - try: - # Retrieve partners - api_response = api_instance.get_partners(direction) - print("The response of PartnersApi->get_partners:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PartnersApi->get_partners: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **direction** | [**PartnerDirection**](.md)| | - -### Return type - -[**List[PartnerResponseDto]**](PartnerResponseDto.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) - -# **remove_partner** -> remove_partner(id) - -Remove a partner - -Stop sharing assets with a partner. - -### 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.PartnersApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Remove a partner - api_instance.remove_partner(id) - except Exception as e: - print("Exception when calling PartnersApi->remove_partner: %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) - -# **update_partner** -> PartnerResponseDto update_partner(id, partner_update_dto) - -Update a partner - -Specify whether a partner's assets should appear in the user's timeline. - -### 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.partner_response_dto import PartnerResponseDto -from generated.immich.openapi_client.models.partner_update_dto import PartnerUpdateDto -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.PartnersApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - partner_update_dto = generated.immich.openapi_client.PartnerUpdateDto() # PartnerUpdateDto | - - try: - # Update a partner - api_response = api_instance.update_partner(id, partner_update_dto) - print("The response of PartnersApi->update_partner:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PartnersApi->update_partner: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **partner_update_dto** | [**PartnerUpdateDto**](PartnerUpdateDto.md)| | - -### Return type - -[**PartnerResponseDto**](PartnerResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/PeopleApi.md b/generated/immich/openapi_client/docs/PeopleApi.md deleted file mode 100644 index 86bb2fb..0000000 --- a/generated/immich/openapi_client/docs/PeopleApi.md +++ /dev/null @@ -1,1044 +0,0 @@ -# generated.immich.openapi_client.PeopleApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_person**](PeopleApi.md#create_person) | **POST** /people | Create a person -[**delete_people**](PeopleApi.md#delete_people) | **DELETE** /people | Delete people -[**delete_person**](PeopleApi.md#delete_person) | **DELETE** /people/{id} | Delete person -[**get_all_people**](PeopleApi.md#get_all_people) | **GET** /people | Get all people -[**get_person**](PeopleApi.md#get_person) | **GET** /people/{id} | Get a person -[**get_person_statistics**](PeopleApi.md#get_person_statistics) | **GET** /people/{id}/statistics | Get person statistics -[**get_person_thumbnail**](PeopleApi.md#get_person_thumbnail) | **GET** /people/{id}/thumbnail | Get person thumbnail -[**merge_person**](PeopleApi.md#merge_person) | **POST** /people/{id}/merge | Merge people -[**reassign_faces**](PeopleApi.md#reassign_faces) | **PUT** /people/{id}/reassign | Reassign faces -[**update_people**](PeopleApi.md#update_people) | **PUT** /people | Update people -[**update_person**](PeopleApi.md#update_person) | **PUT** /people/{id} | Update person - - -# **create_person** -> PersonResponseDto create_person(person_create_dto) - -Create a person - -Create a new person that can have multiple faces assigned to 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.models.person_create_dto import PersonCreateDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto -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.PeopleApi(api_client) - person_create_dto = generated.immich.openapi_client.PersonCreateDto() # PersonCreateDto | - - try: - # Create a person - api_response = api_instance.create_person(person_create_dto) - print("The response of PeopleApi->create_person:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->create_person: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **person_create_dto** | [**PersonCreateDto**](PersonCreateDto.md)| | - -### Return type - -[**PersonResponseDto**](PersonResponseDto.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_people** -> delete_people(bulk_ids_dto) - -Delete people - -Bulk delete a list of people at once. - -### 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.PeopleApi(api_client) - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Delete people - api_instance.delete_people(bulk_ids_dto) - except Exception as e: - print("Exception when calling PeopleApi->delete_people: %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) - -# **delete_person** -> delete_person(id) - -Delete person - -Delete an individual person. - -### 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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete person - api_instance.delete_person(id) - except Exception as e: - print("Exception when calling PeopleApi->delete_person: %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_all_people** -> PeopleResponseDto get_all_people(closest_asset_id=closest_asset_id, closest_person_id=closest_person_id, page=page, size=size, with_hidden=with_hidden) - -Get all people - -Retrieve a list of all people. - -### 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.people_response_dto import PeopleResponseDto -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.PeopleApi(api_client) - closest_asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Closest asset ID for similarity search (optional) - closest_person_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Closest person ID for similarity search (optional) - page = 1 # int | Page number for pagination (optional) (default to 1) - size = 500 # int | Number of items per page (optional) (default to 500) - with_hidden = True # bool | Include hidden people (optional) - - try: - # Get all people - api_response = api_instance.get_all_people(closest_asset_id=closest_asset_id, closest_person_id=closest_person_id, page=page, size=size, with_hidden=with_hidden) - print("The response of PeopleApi->get_all_people:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->get_all_people: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **closest_asset_id** | **UUID**| Closest asset ID for similarity search | [optional] - **closest_person_id** | **UUID**| Closest person ID for similarity search | [optional] - **page** | **int**| Page number for pagination | [optional] [default to 1] - **size** | **int**| Number of items per page | [optional] [default to 500] - **with_hidden** | **bool**| Include hidden people | [optional] - -### Return type - -[**PeopleResponseDto**](PeopleResponseDto.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_person** -> PersonResponseDto get_person(id) - -Get a person - -Retrieve a person by id. - -### 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.person_response_dto import PersonResponseDto -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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Get a person - api_response = api_instance.get_person(id) - print("The response of PeopleApi->get_person:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->get_person: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**PersonResponseDto**](PersonResponseDto.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_person_statistics** -> PersonStatisticsResponseDto get_person_statistics(id) - -Get person statistics - -Retrieve statistics about a specific person. - -### 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.person_statistics_response_dto import PersonStatisticsResponseDto -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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Get person statistics - api_response = api_instance.get_person_statistics(id) - print("The response of PeopleApi->get_person_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->get_person_statistics: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**PersonStatisticsResponseDto**](PersonStatisticsResponseDto.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_person_thumbnail** -> bytearray get_person_thumbnail(id) - -Get person thumbnail - -Retrieve the thumbnail file for a person. - -### 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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Get person thumbnail - api_response = api_instance.get_person_thumbnail(id) - print("The response of PeopleApi->get_person_thumbnail:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->get_person_thumbnail: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -**bytearray** - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **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) - -# **merge_person** -> List[BulkIdResponseDto] merge_person(id, merge_person_dto) - -Merge people - -Merge a list of people into the person specified in the path parameter. - -### 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.merge_person_dto import MergePersonDto -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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - merge_person_dto = generated.immich.openapi_client.MergePersonDto() # MergePersonDto | - - try: - # Merge people - api_response = api_instance.merge_person(id, merge_person_dto) - print("The response of PeopleApi->merge_person:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->merge_person: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **merge_person_dto** | [**MergePersonDto**](MergePersonDto.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) - -# **reassign_faces** -> List[PersonResponseDto] reassign_faces(id, asset_face_update_dto) - -Reassign faces - -Bulk reassign a list of faces to a different person. - -### 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.asset_face_update_dto import AssetFaceUpdateDto -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto -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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - asset_face_update_dto = generated.immich.openapi_client.AssetFaceUpdateDto() # AssetFaceUpdateDto | - - try: - # Reassign faces - api_response = api_instance.reassign_faces(id, asset_face_update_dto) - print("The response of PeopleApi->reassign_faces:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->reassign_faces: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **asset_face_update_dto** | [**AssetFaceUpdateDto**](AssetFaceUpdateDto.md)| | - -### Return type - -[**List[PersonResponseDto]**](PersonResponseDto.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) - -# **update_people** -> List[BulkIdResponseDto] update_people(people_update_dto) - -Update people - -Bulk update multiple people at once. - -### 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.people_update_dto import PeopleUpdateDto -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.PeopleApi(api_client) - people_update_dto = generated.immich.openapi_client.PeopleUpdateDto() # PeopleUpdateDto | - - try: - # Update people - api_response = api_instance.update_people(people_update_dto) - print("The response of PeopleApi->update_people:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->update_people: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **people_update_dto** | [**PeopleUpdateDto**](PeopleUpdateDto.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) - -# **update_person** -> PersonResponseDto update_person(id, person_update_dto) - -Update person - -Update an individual person. - -### 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.person_response_dto import PersonResponseDto -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto -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.PeopleApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - person_update_dto = generated.immich.openapi_client.PersonUpdateDto() # PersonUpdateDto | - - try: - # Update person - api_response = api_instance.update_person(id, person_update_dto) - print("The response of PeopleApi->update_person:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PeopleApi->update_person: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **person_update_dto** | [**PersonUpdateDto**](PersonUpdateDto.md)| | - -### Return type - -[**PersonResponseDto**](PersonResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/PeopleResponse.md b/generated/immich/openapi_client/docs/PeopleResponse.md deleted file mode 100644 index c12bebc..0000000 --- a/generated/immich/openapi_client/docs/PeopleResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# PeopleResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether people are enabled | -**minimum_faces** | **int** | People face threshold | [optional] -**sidebar_web** | **bool** | Whether people appear in web sidebar | - -## Example - -```python -from generated.immich.openapi_client.models.people_response import PeopleResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of PeopleResponse from a JSON string -people_response_instance = PeopleResponse.from_json(json) -# print the JSON string representation of the object -print(PeopleResponse.to_json()) - -# convert the object into a dict -people_response_dict = people_response_instance.to_dict() -# create an instance of PeopleResponse from a dict -people_response_from_dict = PeopleResponse.from_dict(people_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) - - diff --git a/generated/immich/openapi_client/docs/PeopleResponseDto.md b/generated/immich/openapi_client/docs/PeopleResponseDto.md deleted file mode 100644 index c70464d..0000000 --- a/generated/immich/openapi_client/docs/PeopleResponseDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# PeopleResponseDto - -People response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**has_next_page** | **bool** | Whether there are more pages | [optional] -**hidden** | **int** | Number of hidden people | -**people** | [**List[PersonResponseDto]**](PersonResponseDto.md) | | -**total** | **int** | Total number of people | - -## Example - -```python -from generated.immich.openapi_client.models.people_response_dto import PeopleResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PeopleResponseDto from a JSON string -people_response_dto_instance = PeopleResponseDto.from_json(json) -# print the JSON string representation of the object -print(PeopleResponseDto.to_json()) - -# convert the object into a dict -people_response_dto_dict = people_response_dto_instance.to_dict() -# create an instance of PeopleResponseDto from a dict -people_response_dto_from_dict = PeopleResponseDto.from_dict(people_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) - - diff --git a/generated/immich/openapi_client/docs/PeopleUpdate.md b/generated/immich/openapi_client/docs/PeopleUpdate.md deleted file mode 100644 index c054e4c..0000000 --- a/generated/immich/openapi_client/docs/PeopleUpdate.md +++ /dev/null @@ -1,31 +0,0 @@ -# PeopleUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether people are enabled | [optional] -**minimum_faces** | **int** | People face threshold | [optional] -**sidebar_web** | **bool** | Whether people appear in web sidebar | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.people_update import PeopleUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of PeopleUpdate from a JSON string -people_update_instance = PeopleUpdate.from_json(json) -# print the JSON string representation of the object -print(PeopleUpdate.to_json()) - -# convert the object into a dict -people_update_dict = people_update_instance.to_dict() -# create an instance of PeopleUpdate from a dict -people_update_from_dict = PeopleUpdate.from_dict(people_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) - - diff --git a/generated/immich/openapi_client/docs/PeopleUpdateDto.md b/generated/immich/openapi_client/docs/PeopleUpdateDto.md deleted file mode 100644 index 102c88a..0000000 --- a/generated/immich/openapi_client/docs/PeopleUpdateDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# PeopleUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**people** | [**List[PeopleUpdateItem]**](PeopleUpdateItem.md) | People to update | - -## Example - -```python -from generated.immich.openapi_client.models.people_update_dto import PeopleUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PeopleUpdateDto from a JSON string -people_update_dto_instance = PeopleUpdateDto.from_json(json) -# print the JSON string representation of the object -print(PeopleUpdateDto.to_json()) - -# convert the object into a dict -people_update_dto_dict = people_update_dto_instance.to_dict() -# create an instance of PeopleUpdateDto from a dict -people_update_dto_from_dict = PeopleUpdateDto.from_dict(people_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) - - diff --git a/generated/immich/openapi_client/docs/PeopleUpdateItem.md b/generated/immich/openapi_client/docs/PeopleUpdateItem.md deleted file mode 100644 index a534696..0000000 --- a/generated/immich/openapi_client/docs/PeopleUpdateItem.md +++ /dev/null @@ -1,35 +0,0 @@ -# PeopleUpdateItem - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**birth_date** | **date** | Person date of birth | [optional] -**color** | **str** | Person color (hex) | [optional] -**feature_face_asset_id** | **UUID** | Asset ID used for feature face thumbnail | [optional] -**id** | **UUID** | Person ID | -**is_favorite** | **bool** | Mark as favorite | [optional] -**is_hidden** | **bool** | Person visibility (hidden) | [optional] -**name** | **str** | Person name | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.people_update_item import PeopleUpdateItem - -# TODO update the JSON string below -json = "{}" -# create an instance of PeopleUpdateItem from a JSON string -people_update_item_instance = PeopleUpdateItem.from_json(json) -# print the JSON string representation of the object -print(PeopleUpdateItem.to_json()) - -# convert the object into a dict -people_update_item_dict = people_update_item_instance.to_dict() -# create an instance of PeopleUpdateItem from a dict -people_update_item_from_dict = PeopleUpdateItem.from_dict(people_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) - - diff --git a/generated/immich/openapi_client/docs/Permission.md b/generated/immich/openapi_client/docs/Permission.md deleted file mode 100644 index 4a81059..0000000 --- a/generated/immich/openapi_client/docs/Permission.md +++ /dev/null @@ -1,319 +0,0 @@ -# Permission - -List of permissions - -## Enum - -* `ALL` (value: `'all'`) - -* `ACTIVITY_DOT_CREATE` (value: `'activity.create'`) - -* `ACTIVITY_DOT_READ` (value: `'activity.read'`) - -* `ACTIVITY_DOT_UPDATE` (value: `'activity.update'`) - -* `ACTIVITY_DOT_DELETE` (value: `'activity.delete'`) - -* `ACTIVITY_DOT_STATISTICS` (value: `'activity.statistics'`) - -* `API_KEY_DOT_CREATE` (value: `'apiKey.create'`) - -* `API_KEY_DOT_READ` (value: `'apiKey.read'`) - -* `API_KEY_DOT_UPDATE` (value: `'apiKey.update'`) - -* `API_KEY_DOT_DELETE` (value: `'apiKey.delete'`) - -* `ASSET_DOT_READ` (value: `'asset.read'`) - -* `ASSET_DOT_UPDATE` (value: `'asset.update'`) - -* `ASSET_DOT_DELETE` (value: `'asset.delete'`) - -* `ASSET_DOT_STATISTICS` (value: `'asset.statistics'`) - -* `ASSET_DOT_SHARE` (value: `'asset.share'`) - -* `ASSET_DOT_VIEW` (value: `'asset.view'`) - -* `ASSET_DOT_DOWNLOAD` (value: `'asset.download'`) - -* `ASSET_DOT_UPLOAD` (value: `'asset.upload'`) - -* `ASSET_DOT_COPY` (value: `'asset.copy'`) - -* `ASSET_DOT_DERIVE` (value: `'asset.derive'`) - -* `ASSET_DOT_EDIT_DOT_GET` (value: `'asset.edit.get'`) - -* `ASSET_DOT_EDIT_DOT_CREATE` (value: `'asset.edit.create'`) - -* `ASSET_DOT_EDIT_DOT_DELETE` (value: `'asset.edit.delete'`) - -* `ALBUM_DOT_CREATE` (value: `'album.create'`) - -* `ALBUM_DOT_READ` (value: `'album.read'`) - -* `ALBUM_DOT_UPDATE` (value: `'album.update'`) - -* `ALBUM_DOT_DELETE` (value: `'album.delete'`) - -* `ALBUM_DOT_STATISTICS` (value: `'album.statistics'`) - -* `ALBUM_DOT_SHARE` (value: `'album.share'`) - -* `ALBUM_DOT_DOWNLOAD` (value: `'album.download'`) - -* `ALBUM_ASSET_DOT_CREATE` (value: `'albumAsset.create'`) - -* `ALBUM_ASSET_DOT_DELETE` (value: `'albumAsset.delete'`) - -* `ALBUM_USER_DOT_CREATE` (value: `'albumUser.create'`) - -* `ALBUM_USER_DOT_UPDATE` (value: `'albumUser.update'`) - -* `ALBUM_USER_DOT_DELETE` (value: `'albumUser.delete'`) - -* `AUTH_DOT_CHANGE_PASSWORD` (value: `'auth.changePassword'`) - -* `AUTH_DEVICE_DOT_DELETE` (value: `'authDevice.delete'`) - -* `ARCHIVE_DOT_READ` (value: `'archive.read'`) - -* `BACKUP_DOT_LIST` (value: `'backup.list'`) - -* `BACKUP_DOT_DOWNLOAD` (value: `'backup.download'`) - -* `BACKUP_DOT_UPLOAD` (value: `'backup.upload'`) - -* `BACKUP_DOT_DELETE` (value: `'backup.delete'`) - -* `DUPLICATE_DOT_READ` (value: `'duplicate.read'`) - -* `DUPLICATE_DOT_DELETE` (value: `'duplicate.delete'`) - -* `FACE_DOT_CREATE` (value: `'face.create'`) - -* `FACE_DOT_READ` (value: `'face.read'`) - -* `FACE_DOT_UPDATE` (value: `'face.update'`) - -* `FACE_DOT_DELETE` (value: `'face.delete'`) - -* `FOLDER_DOT_READ` (value: `'folder.read'`) - -* `JOB_DOT_CREATE` (value: `'job.create'`) - -* `JOB_DOT_READ` (value: `'job.read'`) - -* `LIBRARY_DOT_CREATE` (value: `'library.create'`) - -* `LIBRARY_DOT_READ` (value: `'library.read'`) - -* `LIBRARY_DOT_UPDATE` (value: `'library.update'`) - -* `LIBRARY_DOT_DELETE` (value: `'library.delete'`) - -* `LIBRARY_DOT_STATISTICS` (value: `'library.statistics'`) - -* `TIMELINE_DOT_READ` (value: `'timeline.read'`) - -* `TIMELINE_DOT_DOWNLOAD` (value: `'timeline.download'`) - -* `MAINTENANCE` (value: `'maintenance'`) - -* `MAP_DOT_READ` (value: `'map.read'`) - -* `MAP_DOT_SEARCH` (value: `'map.search'`) - -* `MEMORY_DOT_CREATE` (value: `'memory.create'`) - -* `MEMORY_DOT_READ` (value: `'memory.read'`) - -* `MEMORY_DOT_UPDATE` (value: `'memory.update'`) - -* `MEMORY_DOT_DELETE` (value: `'memory.delete'`) - -* `MEMORY_DOT_STATISTICS` (value: `'memory.statistics'`) - -* `MEMORY_ASSET_DOT_CREATE` (value: `'memoryAsset.create'`) - -* `MEMORY_ASSET_DOT_DELETE` (value: `'memoryAsset.delete'`) - -* `NOTIFICATION_DOT_CREATE` (value: `'notification.create'`) - -* `NOTIFICATION_DOT_READ` (value: `'notification.read'`) - -* `NOTIFICATION_DOT_UPDATE` (value: `'notification.update'`) - -* `NOTIFICATION_DOT_DELETE` (value: `'notification.delete'`) - -* `PARTNER_DOT_CREATE` (value: `'partner.create'`) - -* `PARTNER_DOT_READ` (value: `'partner.read'`) - -* `PARTNER_DOT_UPDATE` (value: `'partner.update'`) - -* `PARTNER_DOT_DELETE` (value: `'partner.delete'`) - -* `PERSON_DOT_CREATE` (value: `'person.create'`) - -* `PERSON_DOT_READ` (value: `'person.read'`) - -* `PERSON_DOT_UPDATE` (value: `'person.update'`) - -* `PERSON_DOT_DELETE` (value: `'person.delete'`) - -* `PERSON_DOT_STATISTICS` (value: `'person.statistics'`) - -* `PERSON_DOT_MERGE` (value: `'person.merge'`) - -* `PERSON_DOT_REASSIGN` (value: `'person.reassign'`) - -* `PIN_CODE_DOT_CREATE` (value: `'pinCode.create'`) - -* `PIN_CODE_DOT_UPDATE` (value: `'pinCode.update'`) - -* `PIN_CODE_DOT_DELETE` (value: `'pinCode.delete'`) - -* `PLUGIN_DOT_CREATE` (value: `'plugin.create'`) - -* `PLUGIN_DOT_READ` (value: `'plugin.read'`) - -* `PLUGIN_DOT_UPDATE` (value: `'plugin.update'`) - -* `PLUGIN_DOT_DELETE` (value: `'plugin.delete'`) - -* `SERVER_DOT_ABOUT` (value: `'server.about'`) - -* `SERVER_DOT_APK_LINKS` (value: `'server.apkLinks'`) - -* `SERVER_DOT_STORAGE` (value: `'server.storage'`) - -* `SERVER_DOT_STATISTICS` (value: `'server.statistics'`) - -* `SERVER_DOT_VERSION_CHECK` (value: `'server.versionCheck'`) - -* `SERVER_LICENSE_DOT_READ` (value: `'serverLicense.read'`) - -* `SERVER_LICENSE_DOT_UPDATE` (value: `'serverLicense.update'`) - -* `SERVER_LICENSE_DOT_DELETE` (value: `'serverLicense.delete'`) - -* `SESSION_DOT_CREATE` (value: `'session.create'`) - -* `SESSION_DOT_READ` (value: `'session.read'`) - -* `SESSION_DOT_UPDATE` (value: `'session.update'`) - -* `SESSION_DOT_DELETE` (value: `'session.delete'`) - -* `SESSION_DOT_LOCK` (value: `'session.lock'`) - -* `SHARED_LINK_DOT_CREATE` (value: `'sharedLink.create'`) - -* `SHARED_LINK_DOT_READ` (value: `'sharedLink.read'`) - -* `SHARED_LINK_DOT_UPDATE` (value: `'sharedLink.update'`) - -* `SHARED_LINK_DOT_DELETE` (value: `'sharedLink.delete'`) - -* `STACK_DOT_CREATE` (value: `'stack.create'`) - -* `STACK_DOT_READ` (value: `'stack.read'`) - -* `STACK_DOT_UPDATE` (value: `'stack.update'`) - -* `STACK_DOT_DELETE` (value: `'stack.delete'`) - -* `SYNC_DOT_STREAM` (value: `'sync.stream'`) - -* `SYNC_CHECKPOINT_DOT_READ` (value: `'syncCheckpoint.read'`) - -* `SYNC_CHECKPOINT_DOT_UPDATE` (value: `'syncCheckpoint.update'`) - -* `SYNC_CHECKPOINT_DOT_DELETE` (value: `'syncCheckpoint.delete'`) - -* `SYSTEM_CONFIG_DOT_READ` (value: `'systemConfig.read'`) - -* `SYSTEM_CONFIG_DOT_UPDATE` (value: `'systemConfig.update'`) - -* `SYSTEM_METADATA_DOT_READ` (value: `'systemMetadata.read'`) - -* `SYSTEM_METADATA_DOT_UPDATE` (value: `'systemMetadata.update'`) - -* `TAG_DOT_CREATE` (value: `'tag.create'`) - -* `TAG_DOT_READ` (value: `'tag.read'`) - -* `TAG_DOT_UPDATE` (value: `'tag.update'`) - -* `TAG_DOT_DELETE` (value: `'tag.delete'`) - -* `TAG_DOT_ASSET` (value: `'tag.asset'`) - -* `USER_DOT_READ` (value: `'user.read'`) - -* `USER_DOT_UPDATE` (value: `'user.update'`) - -* `USER_LICENSE_DOT_CREATE` (value: `'userLicense.create'`) - -* `USER_LICENSE_DOT_READ` (value: `'userLicense.read'`) - -* `USER_LICENSE_DOT_UPDATE` (value: `'userLicense.update'`) - -* `USER_LICENSE_DOT_DELETE` (value: `'userLicense.delete'`) - -* `USER_ONBOARDING_DOT_READ` (value: `'userOnboarding.read'`) - -* `USER_ONBOARDING_DOT_UPDATE` (value: `'userOnboarding.update'`) - -* `USER_ONBOARDING_DOT_DELETE` (value: `'userOnboarding.delete'`) - -* `USER_PREFERENCE_DOT_READ` (value: `'userPreference.read'`) - -* `USER_PREFERENCE_DOT_UPDATE` (value: `'userPreference.update'`) - -* `USER_PROFILE_IMAGE_DOT_CREATE` (value: `'userProfileImage.create'`) - -* `USER_PROFILE_IMAGE_DOT_READ` (value: `'userProfileImage.read'`) - -* `USER_PROFILE_IMAGE_DOT_UPDATE` (value: `'userProfileImage.update'`) - -* `USER_PROFILE_IMAGE_DOT_DELETE` (value: `'userProfileImage.delete'`) - -* `QUEUE_DOT_READ` (value: `'queue.read'`) - -* `QUEUE_DOT_UPDATE` (value: `'queue.update'`) - -* `QUEUE_JOB_DOT_CREATE` (value: `'queueJob.create'`) - -* `QUEUE_JOB_DOT_READ` (value: `'queueJob.read'`) - -* `QUEUE_JOB_DOT_UPDATE` (value: `'queueJob.update'`) - -* `QUEUE_JOB_DOT_DELETE` (value: `'queueJob.delete'`) - -* `WORKFLOW_DOT_CREATE` (value: `'workflow.create'`) - -* `WORKFLOW_DOT_READ` (value: `'workflow.read'`) - -* `WORKFLOW_DOT_UPDATE` (value: `'workflow.update'`) - -* `WORKFLOW_DOT_DELETE` (value: `'workflow.delete'`) - -* `ADMIN_USER_DOT_CREATE` (value: `'adminUser.create'`) - -* `ADMIN_USER_DOT_READ` (value: `'adminUser.read'`) - -* `ADMIN_USER_DOT_UPDATE` (value: `'adminUser.update'`) - -* `ADMIN_USER_DOT_DELETE` (value: `'adminUser.delete'`) - -* `ADMIN_SESSION_DOT_READ` (value: `'adminSession.read'`) - -* `ADMIN_AUTH_DOT_UNLINK_ALL` (value: `'adminAuth.unlinkAll'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/PersonCreateDto.md b/generated/immich/openapi_client/docs/PersonCreateDto.md deleted file mode 100644 index f68f0b9..0000000 --- a/generated/immich/openapi_client/docs/PersonCreateDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# PersonCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**birth_date** | **date** | Person date of birth | [optional] -**color** | **str** | Person color (hex) | [optional] -**is_favorite** | **bool** | Mark as favorite | [optional] -**is_hidden** | **bool** | Person visibility (hidden) | [optional] -**name** | **str** | Person name | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.person_create_dto import PersonCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PersonCreateDto from a JSON string -person_create_dto_instance = PersonCreateDto.from_json(json) -# print the JSON string representation of the object -print(PersonCreateDto.to_json()) - -# convert the object into a dict -person_create_dto_dict = person_create_dto_instance.to_dict() -# create an instance of PersonCreateDto from a dict -person_create_dto_from_dict = PersonCreateDto.from_dict(person_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) - - diff --git a/generated/immich/openapi_client/docs/PersonResponseDto.md b/generated/immich/openapi_client/docs/PersonResponseDto.md deleted file mode 100644 index ed40911..0000000 --- a/generated/immich/openapi_client/docs/PersonResponseDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# PersonResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**birth_date** | **date** | Person date of birth | -**color** | **str** | Person color (hex) | [optional] -**id** | **UUID** | Person ID | -**is_favorite** | **bool** | Is favorite | [optional] -**is_hidden** | **bool** | Is hidden | -**name** | **str** | Person name | -**thumbnail_path** | **str** | Thumbnail path | -**updated_at** | **datetime** | Last update date | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PersonResponseDto from a JSON string -person_response_dto_instance = PersonResponseDto.from_json(json) -# print the JSON string representation of the object -print(PersonResponseDto.to_json()) - -# convert the object into a dict -person_response_dto_dict = person_response_dto_instance.to_dict() -# create an instance of PersonResponseDto from a dict -person_response_dto_from_dict = PersonResponseDto.from_dict(person_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) - - diff --git a/generated/immich/openapi_client/docs/PersonStatisticsResponseDto.md b/generated/immich/openapi_client/docs/PersonStatisticsResponseDto.md deleted file mode 100644 index e1b7a65..0000000 --- a/generated/immich/openapi_client/docs/PersonStatisticsResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# PersonStatisticsResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assets** | **int** | Number of assets | - -## Example - -```python -from generated.immich.openapi_client.models.person_statistics_response_dto import PersonStatisticsResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PersonStatisticsResponseDto from a JSON string -person_statistics_response_dto_instance = PersonStatisticsResponseDto.from_json(json) -# print the JSON string representation of the object -print(PersonStatisticsResponseDto.to_json()) - -# convert the object into a dict -person_statistics_response_dto_dict = person_statistics_response_dto_instance.to_dict() -# create an instance of PersonStatisticsResponseDto from a dict -person_statistics_response_dto_from_dict = PersonStatisticsResponseDto.from_dict(person_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) - - diff --git a/generated/immich/openapi_client/docs/PersonUpdateDto.md b/generated/immich/openapi_client/docs/PersonUpdateDto.md deleted file mode 100644 index d8aff9a..0000000 --- a/generated/immich/openapi_client/docs/PersonUpdateDto.md +++ /dev/null @@ -1,34 +0,0 @@ -# PersonUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**birth_date** | **date** | Person date of birth | [optional] -**color** | **str** | Person color (hex) | [optional] -**feature_face_asset_id** | **UUID** | Asset ID used for feature face thumbnail | [optional] -**is_favorite** | **bool** | Mark as favorite | [optional] -**is_hidden** | **bool** | Person visibility (hidden) | [optional] -**name** | **str** | Person name | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PersonUpdateDto from a JSON string -person_update_dto_instance = PersonUpdateDto.from_json(json) -# print the JSON string representation of the object -print(PersonUpdateDto.to_json()) - -# convert the object into a dict -person_update_dto_dict = person_update_dto_instance.to_dict() -# create an instance of PersonUpdateDto from a dict -person_update_dto_from_dict = PersonUpdateDto.from_dict(person_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) - - diff --git a/generated/immich/openapi_client/docs/PlacesResponseDto.md b/generated/immich/openapi_client/docs/PlacesResponseDto.md deleted file mode 100644 index 2e25ab9..0000000 --- a/generated/immich/openapi_client/docs/PlacesResponseDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# PlacesResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**admin1name** | **str** | Administrative level 1 name (state/province) | [optional] -**admin2name** | **str** | Administrative level 2 name (county/district) | [optional] -**latitude** | **float** | Latitude coordinate | -**longitude** | **float** | Longitude coordinate | -**name** | **str** | Place name | - -## Example - -```python -from generated.immich.openapi_client.models.places_response_dto import PlacesResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of PlacesResponseDto from a JSON string -places_response_dto_instance = PlacesResponseDto.from_json(json) -# print the JSON string representation of the object -print(PlacesResponseDto.to_json()) - -# convert the object into a dict -places_response_dto_dict = places_response_dto_instance.to_dict() -# create an instance of PlacesResponseDto from a dict -places_response_dto_from_dict = PlacesResponseDto.from_dict(places_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) - - diff --git a/generated/immich/openapi_client/docs/PurchaseResponse.md b/generated/immich/openapi_client/docs/PurchaseResponse.md deleted file mode 100644 index d71b958..0000000 --- a/generated/immich/openapi_client/docs/PurchaseResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# PurchaseResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hide_buy_button_until** | **str** | Date until which to hide buy button | -**show_support_badge** | **bool** | Whether to show support badge | - -## Example - -```python -from generated.immich.openapi_client.models.purchase_response import PurchaseResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of PurchaseResponse from a JSON string -purchase_response_instance = PurchaseResponse.from_json(json) -# print the JSON string representation of the object -print(PurchaseResponse.to_json()) - -# convert the object into a dict -purchase_response_dict = purchase_response_instance.to_dict() -# create an instance of PurchaseResponse from a dict -purchase_response_from_dict = PurchaseResponse.from_dict(purchase_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) - - diff --git a/generated/immich/openapi_client/docs/PurchaseUpdate.md b/generated/immich/openapi_client/docs/PurchaseUpdate.md deleted file mode 100644 index 6294ba1..0000000 --- a/generated/immich/openapi_client/docs/PurchaseUpdate.md +++ /dev/null @@ -1,30 +0,0 @@ -# PurchaseUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hide_buy_button_until** | **str** | Date until which to hide buy button | [optional] -**show_support_badge** | **bool** | Whether to show support badge | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.purchase_update import PurchaseUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of PurchaseUpdate from a JSON string -purchase_update_instance = PurchaseUpdate.from_json(json) -# print the JSON string representation of the object -print(PurchaseUpdate.to_json()) - -# convert the object into a dict -purchase_update_dict = purchase_update_instance.to_dict() -# create an instance of PurchaseUpdate from a dict -purchase_update_from_dict = PurchaseUpdate.from_dict(purchase_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) - - diff --git a/generated/immich/openapi_client/docs/RandomSearchDto.md b/generated/immich/openapi_client/docs/RandomSearchDto.md deleted file mode 100644 index 1948132..0000000 --- a/generated/immich/openapi_client/docs/RandomSearchDto.md +++ /dev/null @@ -1,60 +0,0 @@ -# RandomSearchDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album_ids** | **List[UUID]** | Filter by album IDs | [optional] -**city** | **str** | Filter by city name | [optional] -**country** | **str** | Filter by country name | [optional] -**created_after** | **datetime** | Filter by creation date (after) | [optional] -**created_before** | **datetime** | Filter by creation date (before) | [optional] -**is_encoded** | **bool** | Filter by encoded status | [optional] -**is_favorite** | **bool** | Filter by favorite status | [optional] -**is_motion** | **bool** | Filter by motion photo status | [optional] -**is_not_in_album** | **bool** | Filter assets not in any album | [optional] -**is_offline** | **bool** | Filter by offline status | [optional] -**lens_model** | **str** | Filter by lens model | [optional] -**library_id** | **UUID** | Library ID to filter by | [optional] -**make** | **str** | Filter by camera make | [optional] -**model** | **str** | Filter by camera model | [optional] -**ocr** | **str** | Filter by OCR text content | [optional] -**person_ids** | **List[UUID]** | Filter by person IDs | [optional] -**rating** | **int** | Filter by rating [1-5], or null for unrated | [optional] -**size** | **int** | Number of results to return | [optional] -**state** | **str** | Filter by state/province name | [optional] -**tag_ids** | **List[UUID]** | Filter by tag IDs | [optional] -**taken_after** | **datetime** | Filter by taken date (after) | [optional] -**taken_before** | **datetime** | Filter by taken date (before) | [optional] -**trashed_after** | **datetime** | Filter by trash date (after) | [optional] -**trashed_before** | **datetime** | Filter by trash date (before) | [optional] -**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | [optional] -**updated_after** | **datetime** | Filter by update date (after) | [optional] -**updated_before** | **datetime** | Filter by update date (before) | [optional] -**visibility** | [**AssetVisibility**](AssetVisibility.md) | | [optional] -**with_deleted** | **bool** | Include deleted assets | [optional] -**with_exif** | **bool** | Include EXIF data in response | [optional] -**with_people** | **bool** | Include people data in response | [optional] -**with_stacked** | **bool** | Include stacked assets | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.random_search_dto import RandomSearchDto - -# TODO update the JSON string below -json = "{}" -# create an instance of RandomSearchDto from a JSON string -random_search_dto_instance = RandomSearchDto.from_json(json) -# print the JSON string representation of the object -print(RandomSearchDto.to_json()) - -# convert the object into a dict -random_search_dto_dict = random_search_dto_instance.to_dict() -# create an instance of RandomSearchDto from a dict -random_search_dto_from_dict = RandomSearchDto.from_dict(random_search_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) - - diff --git a/generated/immich/openapi_client/docs/RatingsResponse.md b/generated/immich/openapi_client/docs/RatingsResponse.md deleted file mode 100644 index 77ee856..0000000 --- a/generated/immich/openapi_client/docs/RatingsResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# RatingsResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether ratings are enabled | - -## Example - -```python -from generated.immich.openapi_client.models.ratings_response import RatingsResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of RatingsResponse from a JSON string -ratings_response_instance = RatingsResponse.from_json(json) -# print the JSON string representation of the object -print(RatingsResponse.to_json()) - -# convert the object into a dict -ratings_response_dict = ratings_response_instance.to_dict() -# create an instance of RatingsResponse from a dict -ratings_response_from_dict = RatingsResponse.from_dict(ratings_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) - - diff --git a/generated/immich/openapi_client/docs/RatingsUpdate.md b/generated/immich/openapi_client/docs/RatingsUpdate.md deleted file mode 100644 index 7660b52..0000000 --- a/generated/immich/openapi_client/docs/RatingsUpdate.md +++ /dev/null @@ -1,29 +0,0 @@ -# RatingsUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether ratings are enabled | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.ratings_update import RatingsUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of RatingsUpdate from a JSON string -ratings_update_instance = RatingsUpdate.from_json(json) -# print the JSON string representation of the object -print(RatingsUpdate.to_json()) - -# convert the object into a dict -ratings_update_dict = ratings_update_instance.to_dict() -# create an instance of RatingsUpdate from a dict -ratings_update_from_dict = RatingsUpdate.from_dict(ratings_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) - - diff --git a/generated/immich/openapi_client/docs/ReactionLevel.md b/generated/immich/openapi_client/docs/ReactionLevel.md deleted file mode 100644 index ce00964..0000000 --- a/generated/immich/openapi_client/docs/ReactionLevel.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReactionLevel - -Reaction level - -## Enum - -* `ALBUM` (value: `'album'`) - -* `ASSET` (value: `'asset'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/ReactionType.md b/generated/immich/openapi_client/docs/ReactionType.md deleted file mode 100644 index c826c43..0000000 --- a/generated/immich/openapi_client/docs/ReactionType.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReactionType - -Reaction type - -## Enum - -* `COMMENT` (value: `'comment'`) - -* `LIKE` (value: `'like'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/ReverseGeocodingStateResponseDto.md b/generated/immich/openapi_client/docs/ReverseGeocodingStateResponseDto.md deleted file mode 100644 index b1fec0a..0000000 --- a/generated/immich/openapi_client/docs/ReverseGeocodingStateResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# ReverseGeocodingStateResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last_import_file_name** | **str** | Last import file name | -**last_update** | **str** | Last update timestamp | - -## Example - -```python -from generated.immich.openapi_client.models.reverse_geocoding_state_response_dto import ReverseGeocodingStateResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ReverseGeocodingStateResponseDto from a JSON string -reverse_geocoding_state_response_dto_instance = ReverseGeocodingStateResponseDto.from_json(json) -# print the JSON string representation of the object -print(ReverseGeocodingStateResponseDto.to_json()) - -# convert the object into a dict -reverse_geocoding_state_response_dto_dict = reverse_geocoding_state_response_dto_instance.to_dict() -# create an instance of ReverseGeocodingStateResponseDto from a dict -reverse_geocoding_state_response_dto_from_dict = ReverseGeocodingStateResponseDto.from_dict(reverse_geocoding_state_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) - - diff --git a/generated/immich/openapi_client/docs/SearchAlbumResponseDto.md b/generated/immich/openapi_client/docs/SearchAlbumResponseDto.md deleted file mode 100644 index 558a7b5..0000000 --- a/generated/immich/openapi_client/docs/SearchAlbumResponseDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# SearchAlbumResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | Number of albums in this page | -**facets** | [**List[SearchFacetResponseDto]**](SearchFacetResponseDto.md) | | -**items** | [**List[AlbumResponseDto]**](AlbumResponseDto.md) | | -**total** | **int** | Total number of matching albums | - -## Example - -```python -from generated.immich.openapi_client.models.search_album_response_dto import SearchAlbumResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchAlbumResponseDto from a JSON string -search_album_response_dto_instance = SearchAlbumResponseDto.from_json(json) -# print the JSON string representation of the object -print(SearchAlbumResponseDto.to_json()) - -# convert the object into a dict -search_album_response_dto_dict = search_album_response_dto_instance.to_dict() -# create an instance of SearchAlbumResponseDto from a dict -search_album_response_dto_from_dict = SearchAlbumResponseDto.from_dict(search_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) - - diff --git a/generated/immich/openapi_client/docs/SearchApi.md b/generated/immich/openapi_client/docs/SearchApi.md deleted file mode 100644 index 4127dc1..0000000 --- a/generated/immich/openapi_client/docs/SearchApi.md +++ /dev/null @@ -1,1010 +0,0 @@ -# generated.immich.openapi_client.SearchApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_assets_by_city**](SearchApi.md#get_assets_by_city) | **GET** /search/cities | Retrieve assets by city -[**get_explore_data**](SearchApi.md#get_explore_data) | **GET** /search/explore | Retrieve explore data -[**get_search_suggestions**](SearchApi.md#get_search_suggestions) | **GET** /search/suggestions | Retrieve search suggestions -[**search_asset_statistics**](SearchApi.md#search_asset_statistics) | **POST** /search/statistics | Search asset statistics -[**search_assets**](SearchApi.md#search_assets) | **POST** /search/metadata | Search assets by metadata -[**search_large_assets**](SearchApi.md#search_large_assets) | **POST** /search/large-assets | Search large assets -[**search_person**](SearchApi.md#search_person) | **GET** /search/person | Search people -[**search_places**](SearchApi.md#search_places) | **GET** /search/places | Search places -[**search_random**](SearchApi.md#search_random) | **POST** /search/random | Search random assets -[**search_smart**](SearchApi.md#search_smart) | **POST** /search/smart | Smart asset search - - -# **get_assets_by_city** -> List[AssetResponseDto] get_assets_by_city() - -Retrieve assets by city - -Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in. - -### 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.asset_response_dto import AssetResponseDto -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.SearchApi(api_client) - - try: - # Retrieve assets by city - api_response = api_instance.get_assets_by_city() - print("The response of SearchApi->get_assets_by_city:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->get_assets_by_city: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[AssetResponseDto]**](AssetResponseDto.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_explore_data** -> List[SearchExploreResponseDto] get_explore_data() - -Retrieve explore data - -Retrieve data for the explore section, such as popular people and places. - -### 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.search_explore_response_dto import SearchExploreResponseDto -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.SearchApi(api_client) - - try: - # Retrieve explore data - api_response = api_instance.get_explore_data() - print("The response of SearchApi->get_explore_data:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->get_explore_data: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[SearchExploreResponseDto]**](SearchExploreResponseDto.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_search_suggestions** -> List[str] get_search_suggestions(type, country=country, include_null=include_null, lens_model=lens_model, make=make, model=model, state=state) - -Retrieve search suggestions - -Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features. - -### 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.search_suggestion_type import SearchSuggestionType -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.SearchApi(api_client) - type = generated.immich.openapi_client.SearchSuggestionType() # SearchSuggestionType | - country = 'country_example' # str | Filter by country (optional) - include_null = True # bool | Include null values in suggestions (optional) - lens_model = 'lens_model_example' # str | Filter by lens model (optional) - make = 'make_example' # str | Filter by camera make (optional) - model = 'model_example' # str | Filter by camera model (optional) - state = 'state_example' # str | Filter by state/province (optional) - - try: - # Retrieve search suggestions - api_response = api_instance.get_search_suggestions(type, country=country, include_null=include_null, lens_model=lens_model, make=make, model=model, state=state) - print("The response of SearchApi->get_search_suggestions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->get_search_suggestions: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **type** | [**SearchSuggestionType**](.md)| | - **country** | **str**| Filter by country | [optional] - **include_null** | **bool**| Include null values in suggestions | [optional] - **lens_model** | **str**| Filter by lens model | [optional] - **make** | **str**| Filter by camera make | [optional] - **model** | **str**| Filter by camera model | [optional] - **state** | **str**| Filter by state/province | [optional] - -### Return type - -**List[str]** - -### 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) - -# **search_asset_statistics** -> SearchStatisticsResponseDto search_asset_statistics(statistics_search_dto) - -Search asset statistics - -Retrieve statistical data about assets based on search criteria, such as the total matching count. - -### 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.search_statistics_response_dto import SearchStatisticsResponseDto -from generated.immich.openapi_client.models.statistics_search_dto import StatisticsSearchDto -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.SearchApi(api_client) - statistics_search_dto = generated.immich.openapi_client.StatisticsSearchDto() # StatisticsSearchDto | - - try: - # Search asset statistics - api_response = api_instance.search_asset_statistics(statistics_search_dto) - print("The response of SearchApi->search_asset_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_asset_statistics: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **statistics_search_dto** | [**StatisticsSearchDto**](StatisticsSearchDto.md)| | - -### Return type - -[**SearchStatisticsResponseDto**](SearchStatisticsResponseDto.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) - -# **search_assets** -> SearchResponseDto search_assets(metadata_search_dto) - -Search assets by metadata - -Search for assets based on various metadata criteria. - -### 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.metadata_search_dto import MetadataSearchDto -from generated.immich.openapi_client.models.search_response_dto import SearchResponseDto -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.SearchApi(api_client) - metadata_search_dto = generated.immich.openapi_client.MetadataSearchDto() # MetadataSearchDto | - - try: - # Search assets by metadata - api_response = api_instance.search_assets(metadata_search_dto) - print("The response of SearchApi->search_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata_search_dto** | [**MetadataSearchDto**](MetadataSearchDto.md)| | - -### Return type - -[**SearchResponseDto**](SearchResponseDto.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) - -# **search_large_assets** -> List[AssetResponseDto] search_large_assets(album_ids=album_ids, city=city, country=country, created_after=created_after, created_before=created_before, is_encoded=is_encoded, is_favorite=is_favorite, is_motion=is_motion, is_not_in_album=is_not_in_album, is_offline=is_offline, lens_model=lens_model, library_id=library_id, make=make, min_file_size=min_file_size, model=model, ocr=ocr, person_ids=person_ids, rating=rating, size=size, state=state, tag_ids=tag_ids, taken_after=taken_after, taken_before=taken_before, trashed_after=trashed_after, trashed_before=trashed_before, type=type, updated_after=updated_after, updated_before=updated_before, visibility=visibility, with_deleted=with_deleted, with_exif=with_exif) - -Search large assets - -Search for assets that are considered large based on specified criteria. - -### 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.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 -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.SearchApi(api_client) - album_ids = None # List[UUID] | Filter by album IDs (optional) - city = 'city_example' # str | Filter by city name (optional) - country = 'country_example' # str | Filter by country name (optional) - created_after = '2024-01-01T00:00Z' # datetime | Filter by creation date (after) (optional) - created_before = '2024-01-01T00:00Z' # datetime | Filter by creation date (before) (optional) - is_encoded = True # bool | Filter by encoded status (optional) - is_favorite = True # bool | Filter by favorite status (optional) - is_motion = True # bool | Filter by motion photo status (optional) - is_not_in_album = True # bool | Filter assets not in any album (optional) - is_offline = True # bool | Filter by offline status (optional) - lens_model = 'lens_model_example' # str | Filter by lens model (optional) - library_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Library ID to filter by (optional) - make = 'make_example' # str | Filter by camera make (optional) - min_file_size = 56 # int | Minimum file size in bytes (optional) - model = 'model_example' # str | Filter by camera model (optional) - ocr = 'ocr_example' # str | Filter by OCR text content (optional) - person_ids = None # List[UUID] | Filter by person IDs (optional) - rating = 56 # int | Filter by rating [1-5], or null for unrated (optional) - size = 56 # int | Number of results to return (optional) - state = 'state_example' # str | Filter by state/province name (optional) - tag_ids = None # List[UUID] | Filter by tag IDs (optional) - taken_after = '2024-01-01T00:00Z' # datetime | Filter by taken date (after) (optional) - taken_before = '2024-01-01T00:00Z' # datetime | Filter by taken date (before) (optional) - trashed_after = '2024-01-01T00:00Z' # datetime | Filter by trash date (after) (optional) - trashed_before = '2024-01-01T00:00Z' # datetime | Filter by trash date (before) (optional) - type = generated.immich.openapi_client.AssetTypeEnum() # AssetTypeEnum | (optional) - updated_after = '2024-01-01T00:00Z' # datetime | Filter by update date (after) (optional) - updated_before = '2024-01-01T00:00Z' # datetime | Filter by update date (before) (optional) - visibility = generated.immich.openapi_client.AssetVisibility() # AssetVisibility | (optional) - with_deleted = True # bool | Include deleted assets (optional) - with_exif = True # bool | Include EXIF data in response (optional) - - try: - # Search large assets - api_response = api_instance.search_large_assets(album_ids=album_ids, city=city, country=country, created_after=created_after, created_before=created_before, is_encoded=is_encoded, is_favorite=is_favorite, is_motion=is_motion, is_not_in_album=is_not_in_album, is_offline=is_offline, lens_model=lens_model, library_id=library_id, make=make, min_file_size=min_file_size, model=model, ocr=ocr, person_ids=person_ids, rating=rating, size=size, state=state, tag_ids=tag_ids, taken_after=taken_after, taken_before=taken_before, trashed_after=trashed_after, trashed_before=trashed_before, type=type, updated_after=updated_after, updated_before=updated_before, visibility=visibility, with_deleted=with_deleted, with_exif=with_exif) - print("The response of SearchApi->search_large_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_large_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **album_ids** | [**List[UUID]**](UUID.md)| Filter by album IDs | [optional] - **city** | **str**| Filter by city name | [optional] - **country** | **str**| Filter by country name | [optional] - **created_after** | **datetime**| Filter by creation date (after) | [optional] - **created_before** | **datetime**| Filter by creation date (before) | [optional] - **is_encoded** | **bool**| Filter by encoded status | [optional] - **is_favorite** | **bool**| Filter by favorite status | [optional] - **is_motion** | **bool**| Filter by motion photo status | [optional] - **is_not_in_album** | **bool**| Filter assets not in any album | [optional] - **is_offline** | **bool**| Filter by offline status | [optional] - **lens_model** | **str**| Filter by lens model | [optional] - **library_id** | **UUID**| Library ID to filter by | [optional] - **make** | **str**| Filter by camera make | [optional] - **min_file_size** | **int**| Minimum file size in bytes | [optional] - **model** | **str**| Filter by camera model | [optional] - **ocr** | **str**| Filter by OCR text content | [optional] - **person_ids** | [**List[UUID]**](UUID.md)| Filter by person IDs | [optional] - **rating** | **int**| Filter by rating [1-5], or null for unrated | [optional] - **size** | **int**| Number of results to return | [optional] - **state** | **str**| Filter by state/province name | [optional] - **tag_ids** | [**List[UUID]**](UUID.md)| Filter by tag IDs | [optional] - **taken_after** | **datetime**| Filter by taken date (after) | [optional] - **taken_before** | **datetime**| Filter by taken date (before) | [optional] - **trashed_after** | **datetime**| Filter by trash date (after) | [optional] - **trashed_before** | **datetime**| Filter by trash date (before) | [optional] - **type** | [**AssetTypeEnum**](.md)| | [optional] - **updated_after** | **datetime**| Filter by update date (after) | [optional] - **updated_before** | **datetime**| Filter by update date (before) | [optional] - **visibility** | [**AssetVisibility**](.md)| | [optional] - **with_deleted** | **bool**| Include deleted assets | [optional] - **with_exif** | **bool**| Include EXIF data in response | [optional] - -### Return type - -[**List[AssetResponseDto]**](AssetResponseDto.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) - -# **search_person** -> List[PersonResponseDto] search_person(name, with_hidden=with_hidden) - -Search people - -Search for people by name. - -### 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.person_response_dto import PersonResponseDto -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.SearchApi(api_client) - name = 'name_example' # str | Person name to search for - with_hidden = True # bool | Include hidden people (optional) - - try: - # Search people - api_response = api_instance.search_person(name, with_hidden=with_hidden) - print("The response of SearchApi->search_person:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_person: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Person name to search for | - **with_hidden** | **bool**| Include hidden people | [optional] - -### Return type - -[**List[PersonResponseDto]**](PersonResponseDto.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) - -# **search_places** -> List[PlacesResponseDto] search_places(name) - -Search places - -Search for places by name. - -### 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.places_response_dto import PlacesResponseDto -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.SearchApi(api_client) - name = 'name_example' # str | Place name to search for - - try: - # Search places - api_response = api_instance.search_places(name) - print("The response of SearchApi->search_places:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_places: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Place name to search for | - -### Return type - -[**List[PlacesResponseDto]**](PlacesResponseDto.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) - -# **search_random** -> List[AssetResponseDto] search_random(random_search_dto) - -Search random assets - -Retrieve a random selection of assets based on the provided criteria. - -### 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.asset_response_dto import AssetResponseDto -from generated.immich.openapi_client.models.random_search_dto import RandomSearchDto -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.SearchApi(api_client) - random_search_dto = generated.immich.openapi_client.RandomSearchDto() # RandomSearchDto | - - try: - # Search random assets - api_response = api_instance.search_random(random_search_dto) - print("The response of SearchApi->search_random:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_random: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **random_search_dto** | [**RandomSearchDto**](RandomSearchDto.md)| | - -### Return type - -[**List[AssetResponseDto]**](AssetResponseDto.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) - -# **search_smart** -> SearchResponseDto search_smart(smart_search_dto) - -Smart asset search - -Perform a smart search for assets by using machine learning vectors to determine relevance. - -### 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.search_response_dto import SearchResponseDto -from generated.immich.openapi_client.models.smart_search_dto import SmartSearchDto -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.SearchApi(api_client) - smart_search_dto = generated.immich.openapi_client.SmartSearchDto() # SmartSearchDto | - - try: - # Smart asset search - api_response = api_instance.search_smart(smart_search_dto) - print("The response of SearchApi->search_smart:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchApi->search_smart: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **smart_search_dto** | [**SmartSearchDto**](SmartSearchDto.md)| | - -### Return type - -[**SearchResponseDto**](SearchResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/SearchAssetResponseDto.md b/generated/immich/openapi_client/docs/SearchAssetResponseDto.md deleted file mode 100644 index a80d1b4..0000000 --- a/generated/immich/openapi_client/docs/SearchAssetResponseDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# SearchAssetResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | Number of assets in this page | -**facets** | [**List[SearchFacetResponseDto]**](SearchFacetResponseDto.md) | | -**items** | [**List[AssetResponseDto]**](AssetResponseDto.md) | | -**next_page** | **str** | Next page token | -**total** | **int** | Total number of matching assets | - -## Example - -```python -from generated.immich.openapi_client.models.search_asset_response_dto import SearchAssetResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchAssetResponseDto from a JSON string -search_asset_response_dto_instance = SearchAssetResponseDto.from_json(json) -# print the JSON string representation of the object -print(SearchAssetResponseDto.to_json()) - -# convert the object into a dict -search_asset_response_dto_dict = search_asset_response_dto_instance.to_dict() -# create an instance of SearchAssetResponseDto from a dict -search_asset_response_dto_from_dict = SearchAssetResponseDto.from_dict(search_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) - - diff --git a/generated/immich/openapi_client/docs/SearchExploreItem.md b/generated/immich/openapi_client/docs/SearchExploreItem.md deleted file mode 100644 index 2bb219e..0000000 --- a/generated/immich/openapi_client/docs/SearchExploreItem.md +++ /dev/null @@ -1,30 +0,0 @@ -# SearchExploreItem - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**AssetResponseDto**](AssetResponseDto.md) | | -**value** | **str** | Explore value | - -## Example - -```python -from generated.immich.openapi_client.models.search_explore_item import SearchExploreItem - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchExploreItem from a JSON string -search_explore_item_instance = SearchExploreItem.from_json(json) -# print the JSON string representation of the object -print(SearchExploreItem.to_json()) - -# convert the object into a dict -search_explore_item_dict = search_explore_item_instance.to_dict() -# create an instance of SearchExploreItem from a dict -search_explore_item_from_dict = SearchExploreItem.from_dict(search_explore_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) - - diff --git a/generated/immich/openapi_client/docs/SearchExploreResponseDto.md b/generated/immich/openapi_client/docs/SearchExploreResponseDto.md deleted file mode 100644 index 0e01a8a..0000000 --- a/generated/immich/openapi_client/docs/SearchExploreResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SearchExploreResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field_name** | **str** | Explore field name | -**items** | [**List[SearchExploreItem]**](SearchExploreItem.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.search_explore_response_dto import SearchExploreResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchExploreResponseDto from a JSON string -search_explore_response_dto_instance = SearchExploreResponseDto.from_json(json) -# print the JSON string representation of the object -print(SearchExploreResponseDto.to_json()) - -# convert the object into a dict -search_explore_response_dto_dict = search_explore_response_dto_instance.to_dict() -# create an instance of SearchExploreResponseDto from a dict -search_explore_response_dto_from_dict = SearchExploreResponseDto.from_dict(search_explore_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) - - diff --git a/generated/immich/openapi_client/docs/SearchFacetCountResponseDto.md b/generated/immich/openapi_client/docs/SearchFacetCountResponseDto.md deleted file mode 100644 index deab6b0..0000000 --- a/generated/immich/openapi_client/docs/SearchFacetCountResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SearchFacetCountResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | Number of assets with this facet value | -**value** | **str** | Facet value | - -## Example - -```python -from generated.immich.openapi_client.models.search_facet_count_response_dto import SearchFacetCountResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchFacetCountResponseDto from a JSON string -search_facet_count_response_dto_instance = SearchFacetCountResponseDto.from_json(json) -# print the JSON string representation of the object -print(SearchFacetCountResponseDto.to_json()) - -# convert the object into a dict -search_facet_count_response_dto_dict = search_facet_count_response_dto_instance.to_dict() -# create an instance of SearchFacetCountResponseDto from a dict -search_facet_count_response_dto_from_dict = SearchFacetCountResponseDto.from_dict(search_facet_count_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) - - diff --git a/generated/immich/openapi_client/docs/SearchFacetResponseDto.md b/generated/immich/openapi_client/docs/SearchFacetResponseDto.md deleted file mode 100644 index 28df571..0000000 --- a/generated/immich/openapi_client/docs/SearchFacetResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SearchFacetResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**counts** | [**List[SearchFacetCountResponseDto]**](SearchFacetCountResponseDto.md) | | -**field_name** | **str** | Facet field name | - -## Example - -```python -from generated.immich.openapi_client.models.search_facet_response_dto import SearchFacetResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchFacetResponseDto from a JSON string -search_facet_response_dto_instance = SearchFacetResponseDto.from_json(json) -# print the JSON string representation of the object -print(SearchFacetResponseDto.to_json()) - -# convert the object into a dict -search_facet_response_dto_dict = search_facet_response_dto_instance.to_dict() -# create an instance of SearchFacetResponseDto from a dict -search_facet_response_dto_from_dict = SearchFacetResponseDto.from_dict(search_facet_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) - - diff --git a/generated/immich/openapi_client/docs/SearchResponseDto.md b/generated/immich/openapi_client/docs/SearchResponseDto.md deleted file mode 100644 index 58a79b7..0000000 --- a/generated/immich/openapi_client/docs/SearchResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SearchResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**albums** | [**SearchAlbumResponseDto**](SearchAlbumResponseDto.md) | | -**assets** | [**SearchAssetResponseDto**](SearchAssetResponseDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.search_response_dto import SearchResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SearchResponseDto from a JSON string -search_response_dto_instance = SearchResponseDto.from_json(json) -# print the JSON string representation of the object -print(SearchResponseDto.to_json()) - -# convert the object into a dict -search_response_dto_dict = search_response_dto_instance.to_dict() -# create an instance of SearchResponseDto from a dict -search_response_dto_from_dict = SearchResponseDto.from_dict(search_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) - - diff --git a/generated/immich/openapi_client/docs/SearchSuggestionType.md b/generated/immich/openapi_client/docs/SearchSuggestionType.md deleted file mode 100644 index da9b6cc..0000000 --- a/generated/immich/openapi_client/docs/SearchSuggestionType.md +++ /dev/null @@ -1,21 +0,0 @@ -# SearchSuggestionType - -Suggestion type - -## Enum - -* `COUNTRY` (value: `'country'`) - -* `STATE` (value: `'state'`) - -* `CITY` (value: `'city'`) - -* `CAMERA_MINUS_MAKE` (value: `'camera-make'`) - -* `CAMERA_MINUS_MODEL` (value: `'camera-model'`) - -* `CAMERA_MINUS_LENS_MINUS_MODEL` (value: `'camera-lens-model'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/ServerAboutResponseDto.md b/generated/immich/openapi_client/docs/ServerAboutResponseDto.md deleted file mode 100644 index 48c8168..0000000 --- a/generated/immich/openapi_client/docs/ServerAboutResponseDto.md +++ /dev/null @@ -1,49 +0,0 @@ -# ServerAboutResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**build** | **str** | Build identifier | [optional] -**build_image** | **str** | Build image name | [optional] -**build_image_url** | **str** | Build image URL | [optional] -**build_url** | **str** | Build URL | [optional] -**exiftool** | **str** | ExifTool version | [optional] -**ffmpeg** | **str** | FFmpeg version | [optional] -**imagemagick** | **str** | ImageMagick version | [optional] -**libvips** | **str** | libvips version | [optional] -**licensed** | **bool** | Whether the server is licensed | -**nodejs** | **str** | Node.js version | [optional] -**repository** | **str** | Repository name | [optional] -**repository_url** | **str** | Repository URL | [optional] -**source_commit** | **str** | Source commit hash | [optional] -**source_ref** | **str** | Source reference (branch/tag) | [optional] -**source_url** | **str** | Source URL | [optional] -**third_party_bug_feature_url** | **str** | Third-party bug/feature URL | [optional] -**third_party_documentation_url** | **str** | Third-party documentation URL | [optional] -**third_party_source_url** | **str** | Third-party source URL | [optional] -**third_party_support_url** | **str** | Third-party support URL | [optional] -**version** | **str** | Server version | -**version_url** | **str** | URL to version information | - -## Example - -```python -from generated.immich.openapi_client.models.server_about_response_dto import ServerAboutResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerAboutResponseDto from a JSON string -server_about_response_dto_instance = ServerAboutResponseDto.from_json(json) -# print the JSON string representation of the object -print(ServerAboutResponseDto.to_json()) - -# convert the object into a dict -server_about_response_dto_dict = server_about_response_dto_instance.to_dict() -# create an instance of ServerAboutResponseDto from a dict -server_about_response_dto_from_dict = ServerAboutResponseDto.from_dict(server_about_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) - - diff --git a/generated/immich/openapi_client/docs/ServerApi.md b/generated/immich/openapi_client/docs/ServerApi.md deleted file mode 100644 index 16090c5..0000000 --- a/generated/immich/openapi_client/docs/ServerApi.md +++ /dev/null @@ -1,1113 +0,0 @@ -# generated.immich.openapi_client.ServerApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_server_license**](ServerApi.md#delete_server_license) | **DELETE** /server/license | Delete server product key -[**get_about_info**](ServerApi.md#get_about_info) | **GET** /server/about | Get server information -[**get_apk_links**](ServerApi.md#get_apk_links) | **GET** /server/apk-links | Get APK links -[**get_server_config**](ServerApi.md#get_server_config) | **GET** /server/config | Get config -[**get_server_features**](ServerApi.md#get_server_features) | **GET** /server/features | Get features -[**get_server_license**](ServerApi.md#get_server_license) | **GET** /server/license | Get product key -[**get_server_statistics**](ServerApi.md#get_server_statistics) | **GET** /server/statistics | Get statistics -[**get_server_version**](ServerApi.md#get_server_version) | **GET** /server/version | Get server version -[**get_storage**](ServerApi.md#get_storage) | **GET** /server/storage | Get storage -[**get_supported_media_types**](ServerApi.md#get_supported_media_types) | **GET** /server/media-types | Get supported media types -[**get_version_check**](ServerApi.md#get_version_check) | **GET** /server/version-check | Get version check status -[**get_version_history**](ServerApi.md#get_version_history) | **GET** /server/version-history | Get version history -[**ping_server**](ServerApi.md#ping_server) | **GET** /server/ping | Ping -[**set_server_license**](ServerApi.md#set_server_license) | **PUT** /server/license | Set server product key - - -# **delete_server_license** -> delete_server_license() - -Delete server product key - -Delete the currently set server product 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.ServerApi(api_client) - - try: - # Delete server product key - api_instance.delete_server_license() - except Exception as e: - print("Exception when calling ServerApi->delete_server_license: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### 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_about_info** -> ServerAboutResponseDto get_about_info() - -Get server information - -Retrieve a list of information about the server. - -### 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.server_about_response_dto import ServerAboutResponseDto -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.ServerApi(api_client) - - try: - # Get server information - api_response = api_instance.get_about_info() - print("The response of ServerApi->get_about_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_about_info: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerAboutResponseDto**](ServerAboutResponseDto.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_apk_links** -> ServerApkLinksDto get_apk_links() - -Get APK links - -Retrieve links to the APKs for the current server version. - -### 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.server_apk_links_dto import ServerApkLinksDto -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.ServerApi(api_client) - - try: - # Get APK links - api_response = api_instance.get_apk_links() - print("The response of ServerApi->get_apk_links:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_apk_links: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerApkLinksDto**](ServerApkLinksDto.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_server_config** -> ServerConfigDto get_server_config() - -Get config - -Retrieve the current server configuration. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto -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" -) - - -# 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.ServerApi(api_client) - - try: - # Get config - api_response = api_instance.get_server_config() - print("The response of ServerApi->get_server_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_server_config: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerConfigDto**](ServerConfigDto.md) - -### Authorization - -No authorization required - -### 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_server_features** -> ServerFeaturesDto get_server_features() - -Get features - -Retrieve available features supported by this server. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto -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" -) - - -# 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.ServerApi(api_client) - - try: - # Get features - api_response = api_instance.get_server_features() - print("The response of ServerApi->get_server_features:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_server_features: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerFeaturesDto**](ServerFeaturesDto.md) - -### Authorization - -No authorization required - -### 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_server_license** -> UserLicense get_server_license() - -Get product key - -Retrieve information about whether the server currently has a product key registered. - -### 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.user_license import UserLicense -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.ServerApi(api_client) - - try: - # Get product key - api_response = api_instance.get_server_license() - print("The response of ServerApi->get_server_license:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_server_license: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**UserLicense**](UserLicense.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** | | - | -**404** | | - | - -[[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_server_statistics** -> ServerStatsResponseDto get_server_statistics() - -Get statistics - -Retrieve statistics about the entire Immich instance such as asset counts. - -### 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.server_stats_response_dto import ServerStatsResponseDto -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.ServerApi(api_client) - - try: - # Get statistics - api_response = api_instance.get_server_statistics() - print("The response of ServerApi->get_server_statistics:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_server_statistics: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerStatsResponseDto**](ServerStatsResponseDto.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_server_version** -> ServerVersionResponseDto get_server_version() - -Get server version - -Retrieve the current server version in semantic versioning (semver) format. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto -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" -) - - -# 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.ServerApi(api_client) - - try: - # Get server version - api_response = api_instance.get_server_version() - print("The response of ServerApi->get_server_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_server_version: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerVersionResponseDto**](ServerVersionResponseDto.md) - -### Authorization - -No authorization required - -### 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_storage** -> ServerStorageResponseDto get_storage() - -Get storage - -Retrieve the current storage utilization information of the server. - -### 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.server_storage_response_dto import ServerStorageResponseDto -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.ServerApi(api_client) - - try: - # Get storage - api_response = api_instance.get_storage() - print("The response of ServerApi->get_storage:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_storage: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerStorageResponseDto**](ServerStorageResponseDto.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_supported_media_types** -> ServerMediaTypesResponseDto get_supported_media_types() - -Get supported media types - -Retrieve all media types supported by the server. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto -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" -) - - -# 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.ServerApi(api_client) - - try: - # Get supported media types - api_response = api_instance.get_supported_media_types() - print("The response of ServerApi->get_supported_media_types:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_supported_media_types: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerMediaTypesResponseDto**](ServerMediaTypesResponseDto.md) - -### Authorization - -No authorization required - -### 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_version_check** -> VersionCheckStateResponseDto get_version_check() - -Get version check status - -Retrieve information about the last time the version check ran. - -### 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.version_check_state_response_dto import VersionCheckStateResponseDto -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.ServerApi(api_client) - - try: - # Get version check status - api_response = api_instance.get_version_check() - print("The response of ServerApi->get_version_check:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_version_check: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**VersionCheckStateResponseDto**](VersionCheckStateResponseDto.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_version_history** -> List[ServerVersionHistoryResponseDto] get_version_history() - -Get version history - -Retrieve a list of past versions the server has been on. - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto -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" -) - - -# 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.ServerApi(api_client) - - try: - # Get version history - api_response = api_instance.get_version_history() - print("The response of ServerApi->get_version_history:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->get_version_history: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[ServerVersionHistoryResponseDto]**](ServerVersionHistoryResponseDto.md) - -### Authorization - -No authorization required - -### 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) - -# **ping_server** -> ServerPingResponse ping_server() - -Ping - -Pong - -### Example - - -```python -import generated.immich.openapi_client -from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse -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" -) - - -# 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.ServerApi(api_client) - - try: - # Ping - api_response = api_instance.ping_server() - print("The response of ServerApi->ping_server:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->ping_server: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ServerPingResponse**](ServerPingResponse.md) - -### Authorization - -No authorization required - -### 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) - -# **set_server_license** -> UserLicense set_server_license(license_key_dto) - -Set server product key - -Validate and set the server product key if successful. - -### 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.license_key_dto import LicenseKeyDto -from generated.immich.openapi_client.models.user_license import UserLicense -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.ServerApi(api_client) - license_key_dto = generated.immich.openapi_client.LicenseKeyDto() # LicenseKeyDto | - - try: - # Set server product key - api_response = api_instance.set_server_license(license_key_dto) - print("The response of ServerApi->set_server_license:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServerApi->set_server_license: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **license_key_dto** | [**LicenseKeyDto**](LicenseKeyDto.md)| | - -### Return type - -[**UserLicense**](UserLicense.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) - diff --git a/generated/immich/openapi_client/docs/ServerConfigDto.md b/generated/immich/openapi_client/docs/ServerConfigDto.md deleted file mode 100644 index a47926e..0000000 --- a/generated/immich/openapi_client/docs/ServerConfigDto.md +++ /dev/null @@ -1,40 +0,0 @@ -# ServerConfigDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**external_domain** | **str** | External domain URL | -**is_initialized** | **bool** | Whether the server has been initialized | -**is_onboarded** | **bool** | Whether the admin has completed onboarding | -**login_page_message** | **str** | Login page message | -**maintenance_mode** | **bool** | Whether maintenance mode is active | -**map_dark_style_url** | **str** | Map dark style URL | -**map_light_style_url** | **str** | Map light style URL | -**min_faces** | **int** | People min faces server default | -**oauth_button_text** | **str** | OAuth button text | -**public_users** | **bool** | Whether public user registration is enabled | -**trash_days** | **int** | Number of days before trashed assets are permanently deleted | -**user_delete_delay** | **int** | Delay in days before deleted users are permanently removed | - -## Example - -```python -from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerConfigDto from a JSON string -server_config_dto_instance = ServerConfigDto.from_json(json) -# print the JSON string representation of the object -print(ServerConfigDto.to_json()) - -# convert the object into a dict -server_config_dto_dict = server_config_dto_instance.to_dict() -# create an instance of ServerConfigDto from a dict -server_config_dto_from_dict = ServerConfigDto.from_dict(server_config_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) - - diff --git a/generated/immich/openapi_client/docs/ServerFeaturesDto.md b/generated/immich/openapi_client/docs/ServerFeaturesDto.md deleted file mode 100644 index 4cac96c..0000000 --- a/generated/immich/openapi_client/docs/ServerFeaturesDto.md +++ /dev/null @@ -1,44 +0,0 @@ -# ServerFeaturesDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config_file** | **bool** | Whether config file is available | -**duplicate_detection** | **bool** | Whether duplicate detection is enabled | -**email** | **bool** | Whether email notifications are enabled | -**facial_recognition** | **bool** | Whether facial recognition is enabled | -**import_faces** | **bool** | Whether face import is enabled | -**map** | **bool** | Whether map feature is enabled | -**oauth** | **bool** | Whether OAuth is enabled | -**oauth_auto_launch** | **bool** | Whether OAuth auto-launch is enabled | -**ocr** | **bool** | Whether OCR is enabled | -**password_login** | **bool** | Whether password login is enabled | -**realtime_transcoding** | **bool** | Whether real-time transcoding is enabled | -**reverse_geocoding** | **bool** | Whether reverse geocoding is enabled | -**search** | **bool** | Whether search is enabled | -**sidecar** | **bool** | Whether sidecar files are supported | -**smart_search** | **bool** | Whether smart search is enabled | -**trash** | **bool** | Whether trash feature is enabled | - -## Example - -```python -from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerFeaturesDto from a JSON string -server_features_dto_instance = ServerFeaturesDto.from_json(json) -# print the JSON string representation of the object -print(ServerFeaturesDto.to_json()) - -# convert the object into a dict -server_features_dto_dict = server_features_dto_instance.to_dict() -# create an instance of ServerFeaturesDto from a dict -server_features_dto_from_dict = ServerFeaturesDto.from_dict(server_features_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) - - diff --git a/generated/immich/openapi_client/docs/ServerMediaTypesResponseDto.md b/generated/immich/openapi_client/docs/ServerMediaTypesResponseDto.md deleted file mode 100644 index 8cec90c..0000000 --- a/generated/immich/openapi_client/docs/ServerMediaTypesResponseDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# ServerMediaTypesResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | **List[str]** | Supported image MIME types | -**sidecar** | **List[str]** | Supported sidecar MIME types | -**video** | **List[str]** | Supported video MIME types | - -## Example - -```python -from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerMediaTypesResponseDto from a JSON string -server_media_types_response_dto_instance = ServerMediaTypesResponseDto.from_json(json) -# print the JSON string representation of the object -print(ServerMediaTypesResponseDto.to_json()) - -# convert the object into a dict -server_media_types_response_dto_dict = server_media_types_response_dto_instance.to_dict() -# create an instance of ServerMediaTypesResponseDto from a dict -server_media_types_response_dto_from_dict = ServerMediaTypesResponseDto.from_dict(server_media_types_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) - - diff --git a/generated/immich/openapi_client/docs/ServerPingResponse.md b/generated/immich/openapi_client/docs/ServerPingResponse.md deleted file mode 100644 index 4a998d2..0000000 --- a/generated/immich/openapi_client/docs/ServerPingResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# ServerPingResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**res** | **str** | | - -## Example - -```python -from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerPingResponse from a JSON string -server_ping_response_instance = ServerPingResponse.from_json(json) -# print the JSON string representation of the object -print(ServerPingResponse.to_json()) - -# convert the object into a dict -server_ping_response_dict = server_ping_response_instance.to_dict() -# create an instance of ServerPingResponse from a dict -server_ping_response_from_dict = ServerPingResponse.from_dict(server_ping_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) - - diff --git a/generated/immich/openapi_client/docs/ServerStatsResponseDto.md b/generated/immich/openapi_client/docs/ServerStatsResponseDto.md deleted file mode 100644 index c8f4614..0000000 --- a/generated/immich/openapi_client/docs/ServerStatsResponseDto.md +++ /dev/null @@ -1,34 +0,0 @@ -# ServerStatsResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**photos** | **int** | Total number of photos | -**usage** | **int** | Total storage usage in bytes | -**usage_by_user** | [**List[UsageByUserDto]**](UsageByUserDto.md) | Array of usage for each user | -**usage_photos** | **int** | Storage usage for photos in bytes | -**usage_videos** | **int** | Storage usage for videos in bytes | -**videos** | **int** | Total number of videos | - -## Example - -```python -from generated.immich.openapi_client.models.server_stats_response_dto import ServerStatsResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerStatsResponseDto from a JSON string -server_stats_response_dto_instance = ServerStatsResponseDto.from_json(json) -# print the JSON string representation of the object -print(ServerStatsResponseDto.to_json()) - -# convert the object into a dict -server_stats_response_dto_dict = server_stats_response_dto_instance.to_dict() -# create an instance of ServerStatsResponseDto from a dict -server_stats_response_dto_from_dict = ServerStatsResponseDto.from_dict(server_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) - - diff --git a/generated/immich/openapi_client/docs/ServerStorageResponseDto.md b/generated/immich/openapi_client/docs/ServerStorageResponseDto.md deleted file mode 100644 index 17078c4..0000000 --- a/generated/immich/openapi_client/docs/ServerStorageResponseDto.md +++ /dev/null @@ -1,35 +0,0 @@ -# ServerStorageResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**disk_available** | **str** | Available disk space (human-readable format) | -**disk_available_raw** | **int** | Available disk space in bytes | -**disk_size** | **str** | Total disk size (human-readable format) | -**disk_size_raw** | **int** | Total disk size in bytes | -**disk_usage_percentage** | **float** | Disk usage percentage (0-100) | -**disk_use** | **str** | Used disk space (human-readable format) | -**disk_use_raw** | **int** | Used disk space in bytes | - -## Example - -```python -from generated.immich.openapi_client.models.server_storage_response_dto import ServerStorageResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerStorageResponseDto from a JSON string -server_storage_response_dto_instance = ServerStorageResponseDto.from_json(json) -# print the JSON string representation of the object -print(ServerStorageResponseDto.to_json()) - -# convert the object into a dict -server_storage_response_dto_dict = server_storage_response_dto_instance.to_dict() -# create an instance of ServerStorageResponseDto from a dict -server_storage_response_dto_from_dict = ServerStorageResponseDto.from_dict(server_storage_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) - - diff --git a/generated/immich/openapi_client/docs/ServerVersionHistoryResponseDto.md b/generated/immich/openapi_client/docs/ServerVersionHistoryResponseDto.md deleted file mode 100644 index 235b53e..0000000 --- a/generated/immich/openapi_client/docs/ServerVersionHistoryResponseDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# ServerVersionHistoryResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created_at** | **datetime** | When this version was first seen | -**id** | **UUID** | Version history entry ID | -**version** | **str** | Version string | - -## Example - -```python -from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerVersionHistoryResponseDto from a JSON string -server_version_history_response_dto_instance = ServerVersionHistoryResponseDto.from_json(json) -# print the JSON string representation of the object -print(ServerVersionHistoryResponseDto.to_json()) - -# convert the object into a dict -server_version_history_response_dto_dict = server_version_history_response_dto_instance.to_dict() -# create an instance of ServerVersionHistoryResponseDto from a dict -server_version_history_response_dto_from_dict = ServerVersionHistoryResponseDto.from_dict(server_version_history_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) - - diff --git a/generated/immich/openapi_client/docs/ServerVersionResponseDto.md b/generated/immich/openapi_client/docs/ServerVersionResponseDto.md deleted file mode 100644 index 2ae754c..0000000 --- a/generated/immich/openapi_client/docs/ServerVersionResponseDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# ServerVersionResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**major** | **int** | Major version number | -**minor** | **int** | Minor version number | -**patch** | **int** | Patch version number | -**prerelease** | **int** | Pre-release version number | - -## Example - -```python -from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ServerVersionResponseDto from a JSON string -server_version_response_dto_instance = ServerVersionResponseDto.from_json(json) -# print the JSON string representation of the object -print(ServerVersionResponseDto.to_json()) - -# convert the object into a dict -server_version_response_dto_dict = server_version_response_dto_instance.to_dict() -# create an instance of ServerVersionResponseDto from a dict -server_version_response_dto_from_dict = ServerVersionResponseDto.from_dict(server_version_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) - - diff --git a/generated/immich/openapi_client/docs/SessionResponseDto.md b/generated/immich/openapi_client/docs/SessionResponseDto.md deleted file mode 100644 index cbe0bd7..0000000 --- a/generated/immich/openapi_client/docs/SessionResponseDto.md +++ /dev/null @@ -1,37 +0,0 @@ -# SessionResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**app_version** | **str** | App version | -**created_at** | **str** | Creation date | -**current** | **bool** | Is current session | -**device_os** | **str** | Device OS | -**device_type** | **str** | Device type | -**expires_at** | **str** | Expiration date | [optional] -**id** | **UUID** | Session ID | -**is_pending_sync_reset** | **bool** | Is pending sync reset | -**updated_at** | **str** | Last update date | - -## Example - -```python -from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SessionResponseDto from a JSON string -session_response_dto_instance = SessionResponseDto.from_json(json) -# print the JSON string representation of the object -print(SessionResponseDto.to_json()) - -# convert the object into a dict -session_response_dto_dict = session_response_dto_instance.to_dict() -# create an instance of SessionResponseDto from a dict -session_response_dto_from_dict = SessionResponseDto.from_dict(session_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) - - diff --git a/generated/immich/openapi_client/docs/SessionsApi.md b/generated/immich/openapi_client/docs/SessionsApi.md deleted file mode 100644 index 26709e4..0000000 --- a/generated/immich/openapi_client/docs/SessionsApi.md +++ /dev/null @@ -1,553 +0,0 @@ -# generated.immich.openapi_client.SessionsApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_session**](SessionsApi.md#create_session) | **POST** /sessions | Create a session -[**delete_all_sessions**](SessionsApi.md#delete_all_sessions) | **DELETE** /sessions | Delete all sessions -[**delete_session**](SessionsApi.md#delete_session) | **DELETE** /sessions/{id} | Delete a session -[**get_sessions**](SessionsApi.md#get_sessions) | **GET** /sessions | Retrieve sessions -[**lock_session**](SessionsApi.md#lock_session) | **POST** /sessions/{id}/lock | Lock a session -[**update_session**](SessionsApi.md#update_session) | **PUT** /sessions/{id} | Update a session - - -# **create_session** -> SessionCreateResponseDto create_session(session_create_dto) - -Create a session - -Create a session as a child to the current session. This endpoint is used for casting. - -### 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.session_create_dto import SessionCreateDto -from generated.immich.openapi_client.models.session_create_response_dto import SessionCreateResponseDto -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.SessionsApi(api_client) - session_create_dto = generated.immich.openapi_client.SessionCreateDto() # SessionCreateDto | - - try: - # Create a session - api_response = api_instance.create_session(session_create_dto) - print("The response of SessionsApi->create_session:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SessionsApi->create_session: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **session_create_dto** | [**SessionCreateDto**](SessionCreateDto.md)| | - -### Return type - -[**SessionCreateResponseDto**](SessionCreateResponseDto.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_all_sessions** -> delete_all_sessions() - -Delete all sessions - -Delete all sessions for the user. This will not delete the current session. - -### 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.SessionsApi(api_client) - - try: - # Delete all sessions - api_instance.delete_all_sessions() - except Exception as e: - print("Exception when calling SessionsApi->delete_all_sessions: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### 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_session** -> delete_session(id) - -Delete a session - -Delete a specific session by id. - -### 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.SessionsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a session - api_instance.delete_session(id) - except Exception as e: - print("Exception when calling SessionsApi->delete_session: %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_sessions** -> List[SessionResponseDto] get_sessions() - -Retrieve sessions - -Retrieve a list of sessions for the 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.session_response_dto import SessionResponseDto -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.SessionsApi(api_client) - - try: - # Retrieve sessions - api_response = api_instance.get_sessions() - print("The response of SessionsApi->get_sessions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SessionsApi->get_sessions: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[SessionResponseDto]**](SessionResponseDto.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) - -# **lock_session** -> lock_session(id) - -Lock a session - -Lock a specific session by id. - -### 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.SessionsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Lock a session - api_instance.lock_session(id) - except Exception as e: - print("Exception when calling SessionsApi->lock_session: %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) - -# **update_session** -> SessionResponseDto update_session(id, session_update_dto) - -Update a session - -Update a specific session identified by id. - -### 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.session_response_dto import SessionResponseDto -from generated.immich.openapi_client.models.session_update_dto import SessionUpdateDto -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.SessionsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - session_update_dto = generated.immich.openapi_client.SessionUpdateDto() # SessionUpdateDto | - - try: - # Update a session - api_response = api_instance.update_session(id, session_update_dto) - print("The response of SessionsApi->update_session:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SessionsApi->update_session: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **session_update_dto** | [**SessionUpdateDto**](SessionUpdateDto.md)| | - -### Return type - -[**SessionResponseDto**](SessionResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/SharedLinkCreateDto.md b/generated/immich/openapi_client/docs/SharedLinkCreateDto.md deleted file mode 100644 index 97d18bb..0000000 --- a/generated/immich/openapi_client/docs/SharedLinkCreateDto.md +++ /dev/null @@ -1,38 +0,0 @@ -# SharedLinkCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album_id** | **UUID** | Album ID (for album sharing) | [optional] -**allow_download** | **bool** | Allow downloads | [optional] [default to True] -**allow_upload** | **bool** | Allow uploads | [optional] -**asset_ids** | **List[UUID]** | Asset IDs (for individual assets) | [optional] -**description** | **str** | Link description | [optional] -**expires_at** | **datetime** | Expiration date | [optional] -**password** | **str** | Link password | [optional] -**show_metadata** | **bool** | Show metadata | [optional] [default to True] -**slug** | **str** | Custom URL slug | [optional] -**type** | [**SharedLinkType**](SharedLinkType.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.shared_link_create_dto import SharedLinkCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SharedLinkCreateDto from a JSON string -shared_link_create_dto_instance = SharedLinkCreateDto.from_json(json) -# print the JSON string representation of the object -print(SharedLinkCreateDto.to_json()) - -# convert the object into a dict -shared_link_create_dto_dict = shared_link_create_dto_instance.to_dict() -# create an instance of SharedLinkCreateDto from a dict -shared_link_create_dto_from_dict = SharedLinkCreateDto.from_dict(shared_link_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) - - diff --git a/generated/immich/openapi_client/docs/SharedLinkEditDto.md b/generated/immich/openapi_client/docs/SharedLinkEditDto.md deleted file mode 100644 index 45a26c6..0000000 --- a/generated/immich/openapi_client/docs/SharedLinkEditDto.md +++ /dev/null @@ -1,35 +0,0 @@ -# SharedLinkEditDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allow_download** | **bool** | Allow downloads | [optional] -**allow_upload** | **bool** | Allow uploads | [optional] -**description** | **str** | Link description | [optional] -**expires_at** | **datetime** | Expiration date | [optional] -**password** | **str** | Link password | [optional] -**show_metadata** | **bool** | Show metadata | [optional] -**slug** | **str** | Custom URL slug | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.shared_link_edit_dto import SharedLinkEditDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SharedLinkEditDto from a JSON string -shared_link_edit_dto_instance = SharedLinkEditDto.from_json(json) -# print the JSON string representation of the object -print(SharedLinkEditDto.to_json()) - -# convert the object into a dict -shared_link_edit_dto_dict = shared_link_edit_dto_instance.to_dict() -# create an instance of SharedLinkEditDto from a dict -shared_link_edit_dto_from_dict = SharedLinkEditDto.from_dict(shared_link_edit_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) - - diff --git a/generated/immich/openapi_client/docs/SharedLinkResponseDto.md b/generated/immich/openapi_client/docs/SharedLinkResponseDto.md deleted file mode 100644 index d428ed0..0000000 --- a/generated/immich/openapi_client/docs/SharedLinkResponseDto.md +++ /dev/null @@ -1,43 +0,0 @@ -# SharedLinkResponseDto - -Shared link response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album** | [**AlbumResponseDto**](AlbumResponseDto.md) | | [optional] -**allow_download** | **bool** | Allow downloads | -**allow_upload** | **bool** | Allow uploads | -**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | | -**created_at** | **datetime** | Creation date | -**description** | **str** | Link description | -**expires_at** | **datetime** | Expiration date | -**id** | **UUID** | Shared link ID | -**key** | **str** | Encryption key (base64url) | -**password** | **str** | Has password | -**show_metadata** | **bool** | Show metadata | -**slug** | **str** | Custom URL slug | -**type** | [**SharedLinkType**](SharedLinkType.md) | | -**user_id** | **UUID** | Owner user ID | - -## Example - -```python -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SharedLinkResponseDto from a JSON string -shared_link_response_dto_instance = SharedLinkResponseDto.from_json(json) -# print the JSON string representation of the object -print(SharedLinkResponseDto.to_json()) - -# convert the object into a dict -shared_link_response_dto_dict = shared_link_response_dto_instance.to_dict() -# create an instance of SharedLinkResponseDto from a dict -shared_link_response_dto_from_dict = SharedLinkResponseDto.from_dict(shared_link_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) - - diff --git a/generated/immich/openapi_client/docs/SharedLinkType.md b/generated/immich/openapi_client/docs/SharedLinkType.md deleted file mode 100644 index 0ebaae6..0000000 --- a/generated/immich/openapi_client/docs/SharedLinkType.md +++ /dev/null @@ -1,13 +0,0 @@ -# SharedLinkType - -Shared link type - -## Enum - -* `ALBUM` (value: `'ALBUM'`) - -* `INDIVIDUAL` (value: `'INDIVIDUAL'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/SharedLinksApi.md b/generated/immich/openapi_client/docs/SharedLinksApi.md deleted file mode 100644 index 4f72b8a..0000000 --- a/generated/immich/openapi_client/docs/SharedLinksApi.md +++ /dev/null @@ -1,861 +0,0 @@ -# generated.immich.openapi_client.SharedLinksApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_shared_link_assets**](SharedLinksApi.md#add_shared_link_assets) | **PUT** /shared-links/{id}/assets | Add assets to a shared link -[**create_shared_link**](SharedLinksApi.md#create_shared_link) | **POST** /shared-links | Create a shared link -[**get_all_shared_links**](SharedLinksApi.md#get_all_shared_links) | **GET** /shared-links | Retrieve all shared links -[**get_my_shared_link**](SharedLinksApi.md#get_my_shared_link) | **GET** /shared-links/me | Retrieve current shared link -[**get_shared_link_by_id**](SharedLinksApi.md#get_shared_link_by_id) | **GET** /shared-links/{id} | Retrieve a shared link -[**remove_shared_link**](SharedLinksApi.md#remove_shared_link) | **DELETE** /shared-links/{id} | Delete a shared link -[**remove_shared_link_assets**](SharedLinksApi.md#remove_shared_link_assets) | **DELETE** /shared-links/{id}/assets | Remove assets from a shared link -[**shared_link_login**](SharedLinksApi.md#shared_link_login) | **POST** /shared-links/login | Shared link login -[**update_shared_link**](SharedLinksApi.md#update_shared_link) | **PATCH** /shared-links/{id} | Update a shared link - - -# **add_shared_link_assets** -> List[AssetIdsResponseDto] add_shared_link_assets(id, asset_ids_dto) - -Add assets to a shared link - -Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - -### 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.asset_ids_dto import AssetIdsDto -from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto -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.SharedLinksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - asset_ids_dto = generated.immich.openapi_client.AssetIdsDto() # AssetIdsDto | - - try: - # Add assets to a shared link - api_response = api_instance.add_shared_link_assets(id, asset_ids_dto) - print("The response of SharedLinksApi->add_shared_link_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->add_shared_link_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **asset_ids_dto** | [**AssetIdsDto**](AssetIdsDto.md)| | - -### Return type - -[**List[AssetIdsResponseDto]**](AssetIdsResponseDto.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) - -# **create_shared_link** -> SharedLinkResponseDto create_shared_link(shared_link_create_dto) - -Create a shared link - -Create a new shared link. - -### 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.shared_link_create_dto import SharedLinkCreateDto -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto -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.SharedLinksApi(api_client) - shared_link_create_dto = generated.immich.openapi_client.SharedLinkCreateDto() # SharedLinkCreateDto | - - try: - # Create a shared link - api_response = api_instance.create_shared_link(shared_link_create_dto) - print("The response of SharedLinksApi->create_shared_link:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->create_shared_link: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shared_link_create_dto** | [**SharedLinkCreateDto**](SharedLinkCreateDto.md)| | - -### Return type - -[**SharedLinkResponseDto**](SharedLinkResponseDto.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) - -# **get_all_shared_links** -> List[SharedLinkResponseDto] get_all_shared_links(album_id=album_id, id=id) - -Retrieve all shared links - -Retrieve a list of all shared links. - -### 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.shared_link_response_dto import SharedLinkResponseDto -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.SharedLinksApi(api_client) - album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by album ID (optional) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by shared link ID (optional) - - try: - # Retrieve all shared links - api_response = api_instance.get_all_shared_links(album_id=album_id, id=id) - print("The response of SharedLinksApi->get_all_shared_links:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->get_all_shared_links: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **album_id** | **UUID**| Filter by album ID | [optional] - **id** | **UUID**| Filter by shared link ID | [optional] - -### Return type - -[**List[SharedLinkResponseDto]**](SharedLinkResponseDto.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_shared_link** -> SharedLinkResponseDto get_my_shared_link(key=key, slug=slug) - -Retrieve current shared link - -Retrieve the current shared link associated with authentication method. - -### 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.shared_link_response_dto import SharedLinkResponseDto -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.SharedLinksApi(api_client) - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Retrieve current shared link - api_response = api_instance.get_my_shared_link(key=key, slug=slug) - print("The response of SharedLinksApi->get_my_shared_link:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->get_my_shared_link: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### Return type - -[**SharedLinkResponseDto**](SharedLinkResponseDto.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_shared_link_by_id** -> SharedLinkResponseDto get_shared_link_by_id(id) - -Retrieve a shared link - -Retrieve a specific shared link by its ID. - -### 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.shared_link_response_dto import SharedLinkResponseDto -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.SharedLinksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a shared link - api_response = api_instance.get_shared_link_by_id(id) - print("The response of SharedLinksApi->get_shared_link_by_id:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->get_shared_link_by_id: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**SharedLinkResponseDto**](SharedLinkResponseDto.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) - -# **remove_shared_link** -> remove_shared_link(id) - -Delete a shared link - -Delete a specific shared link by its ID. - -### 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.SharedLinksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a shared link - api_instance.remove_shared_link(id) - except Exception as e: - print("Exception when calling SharedLinksApi->remove_shared_link: %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) - -# **remove_shared_link_assets** -> List[AssetIdsResponseDto] remove_shared_link_assets(id, asset_ids_dto) - -Remove assets from a shared link - -Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. - -### 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.asset_ids_dto import AssetIdsDto -from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto -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.SharedLinksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - asset_ids_dto = generated.immich.openapi_client.AssetIdsDto() # AssetIdsDto | - - try: - # Remove assets from a shared link - api_response = api_instance.remove_shared_link_assets(id, asset_ids_dto) - print("The response of SharedLinksApi->remove_shared_link_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->remove_shared_link_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **asset_ids_dto** | [**AssetIdsDto**](AssetIdsDto.md)| | - -### Return type - -[**List[AssetIdsResponseDto]**](AssetIdsResponseDto.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) - -# **shared_link_login** -> SharedLinkResponseDto shared_link_login(shared_link_login_dto, key=key, slug=slug) - -Shared link login - -Login to a password protected shared link - -### 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.shared_link_login_dto import SharedLinkLoginDto -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto -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.SharedLinksApi(api_client) - shared_link_login_dto = generated.immich.openapi_client.SharedLinkLoginDto() # SharedLinkLoginDto | - key = 'key_example' # str | (optional) - slug = 'slug_example' # str | (optional) - - try: - # Shared link login - api_response = api_instance.shared_link_login(shared_link_login_dto, key=key, slug=slug) - print("The response of SharedLinksApi->shared_link_login:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->shared_link_login: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **shared_link_login_dto** | [**SharedLinkLoginDto**](SharedLinkLoginDto.md)| | - **key** | **str**| | [optional] - **slug** | **str**| | [optional] - -### Return type - -[**SharedLinkResponseDto**](SharedLinkResponseDto.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) - -# **update_shared_link** -> SharedLinkResponseDto update_shared_link(id, shared_link_edit_dto) - -Update a shared link - -Update an existing shared link by its ID. - -### 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.shared_link_edit_dto import SharedLinkEditDto -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto -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.SharedLinksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - shared_link_edit_dto = generated.immich.openapi_client.SharedLinkEditDto() # SharedLinkEditDto | - - try: - # Update a shared link - api_response = api_instance.update_shared_link(id, shared_link_edit_dto) - print("The response of SharedLinksApi->update_shared_link:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SharedLinksApi->update_shared_link: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **shared_link_edit_dto** | [**SharedLinkEditDto**](SharedLinkEditDto.md)| | - -### Return type - -[**SharedLinkResponseDto**](SharedLinkResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/SharedLinksResponse.md b/generated/immich/openapi_client/docs/SharedLinksResponse.md deleted file mode 100644 index 5c1a59d..0000000 --- a/generated/immich/openapi_client/docs/SharedLinksResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# SharedLinksResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether shared links are enabled | -**sidebar_web** | **bool** | Whether shared links appear in web sidebar | - -## Example - -```python -from generated.immich.openapi_client.models.shared_links_response import SharedLinksResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of SharedLinksResponse from a JSON string -shared_links_response_instance = SharedLinksResponse.from_json(json) -# print the JSON string representation of the object -print(SharedLinksResponse.to_json()) - -# convert the object into a dict -shared_links_response_dict = shared_links_response_instance.to_dict() -# create an instance of SharedLinksResponse from a dict -shared_links_response_from_dict = SharedLinksResponse.from_dict(shared_links_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) - - diff --git a/generated/immich/openapi_client/docs/SharedLinksUpdate.md b/generated/immich/openapi_client/docs/SharedLinksUpdate.md deleted file mode 100644 index 0f89ac1..0000000 --- a/generated/immich/openapi_client/docs/SharedLinksUpdate.md +++ /dev/null @@ -1,30 +0,0 @@ -# SharedLinksUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether shared links are enabled | [optional] -**sidebar_web** | **bool** | Whether shared links appear in web sidebar | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.shared_links_update import SharedLinksUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of SharedLinksUpdate from a JSON string -shared_links_update_instance = SharedLinksUpdate.from_json(json) -# print the JSON string representation of the object -print(SharedLinksUpdate.to_json()) - -# convert the object into a dict -shared_links_update_dict = shared_links_update_instance.to_dict() -# create an instance of SharedLinksUpdate from a dict -shared_links_update_from_dict = SharedLinksUpdate.from_dict(shared_links_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) - - diff --git a/generated/immich/openapi_client/docs/SignUpDto.md b/generated/immich/openapi_client/docs/SignUpDto.md deleted file mode 100644 index 4684519..0000000 --- a/generated/immich/openapi_client/docs/SignUpDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# SignUpDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | User email | -**name** | **str** | User name | -**password** | **str** | User password | - -## Example - -```python -from generated.immich.openapi_client.models.sign_up_dto import SignUpDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SignUpDto from a JSON string -sign_up_dto_instance = SignUpDto.from_json(json) -# print the JSON string representation of the object -print(SignUpDto.to_json()) - -# convert the object into a dict -sign_up_dto_dict = sign_up_dto_instance.to_dict() -# create an instance of SignUpDto from a dict -sign_up_dto_from_dict = SignUpDto.from_dict(sign_up_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) - - diff --git a/generated/immich/openapi_client/docs/SmartSearchDto.md b/generated/immich/openapi_client/docs/SmartSearchDto.md deleted file mode 100644 index 1e7414b..0000000 --- a/generated/immich/openapi_client/docs/SmartSearchDto.md +++ /dev/null @@ -1,62 +0,0 @@ -# SmartSearchDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album_ids** | **List[UUID]** | Filter by album IDs | [optional] -**city** | **str** | Filter by city name | [optional] -**country** | **str** | Filter by country name | [optional] -**created_after** | **datetime** | Filter by creation date (after) | [optional] -**created_before** | **datetime** | Filter by creation date (before) | [optional] -**is_encoded** | **bool** | Filter by encoded status | [optional] -**is_favorite** | **bool** | Filter by favorite status | [optional] -**is_motion** | **bool** | Filter by motion photo status | [optional] -**is_not_in_album** | **bool** | Filter assets not in any album | [optional] -**is_offline** | **bool** | Filter by offline status | [optional] -**language** | **str** | Search language code | [optional] -**lens_model** | **str** | Filter by lens model | [optional] -**library_id** | **UUID** | Library ID to filter by | [optional] -**make** | **str** | Filter by camera make | [optional] -**model** | **str** | Filter by camera model | [optional] -**ocr** | **str** | Filter by OCR text content | [optional] -**page** | **int** | Page number | [optional] -**person_ids** | **List[UUID]** | Filter by person IDs | [optional] -**query** | **str** | Natural language search query | [optional] -**query_asset_id** | **UUID** | Asset ID to use as search reference | [optional] -**rating** | **int** | Filter by rating [1-5], or null for unrated | [optional] -**size** | **int** | Number of results to return | [optional] -**state** | **str** | Filter by state/province name | [optional] -**tag_ids** | **List[UUID]** | Filter by tag IDs | [optional] -**taken_after** | **datetime** | Filter by taken date (after) | [optional] -**taken_before** | **datetime** | Filter by taken date (before) | [optional] -**trashed_after** | **datetime** | Filter by trash date (after) | [optional] -**trashed_before** | **datetime** | Filter by trash date (before) | [optional] -**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | [optional] -**updated_after** | **datetime** | Filter by update date (after) | [optional] -**updated_before** | **datetime** | Filter by update date (before) | [optional] -**visibility** | [**AssetVisibility**](AssetVisibility.md) | | [optional] -**with_deleted** | **bool** | Include deleted assets | [optional] -**with_exif** | **bool** | Include EXIF data in response | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.smart_search_dto import SmartSearchDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SmartSearchDto from a JSON string -smart_search_dto_instance = SmartSearchDto.from_json(json) -# print the JSON string representation of the object -print(SmartSearchDto.to_json()) - -# convert the object into a dict -smart_search_dto_dict = smart_search_dto_instance.to_dict() -# create an instance of SmartSearchDto from a dict -smart_search_dto_from_dict = SmartSearchDto.from_dict(smart_search_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) - - diff --git a/generated/immich/openapi_client/docs/SourceType.md b/generated/immich/openapi_client/docs/SourceType.md deleted file mode 100644 index 04efe36..0000000 --- a/generated/immich/openapi_client/docs/SourceType.md +++ /dev/null @@ -1,15 +0,0 @@ -# SourceType - -Face detection source type - -## Enum - -* `MACHINE_MINUS_LEARNING` (value: `'machine-learning'`) - -* `EXIF` (value: `'exif'`) - -* `MANUAL` (value: `'manual'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/StackCreateDto.md b/generated/immich/openapi_client/docs/StackCreateDto.md deleted file mode 100644 index ee16fca..0000000 --- a/generated/immich/openapi_client/docs/StackCreateDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# StackCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**asset_ids** | **List[UUID]** | Asset IDs (first becomes primary, min 2) | - -## Example - -```python -from generated.immich.openapi_client.models.stack_create_dto import StackCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of StackCreateDto from a JSON string -stack_create_dto_instance = StackCreateDto.from_json(json) -# print the JSON string representation of the object -print(StackCreateDto.to_json()) - -# convert the object into a dict -stack_create_dto_dict = stack_create_dto_instance.to_dict() -# create an instance of StackCreateDto from a dict -stack_create_dto_from_dict = StackCreateDto.from_dict(stack_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) - - diff --git a/generated/immich/openapi_client/docs/StackResponseDto.md b/generated/immich/openapi_client/docs/StackResponseDto.md deleted file mode 100644 index c16a919..0000000 --- a/generated/immich/openapi_client/docs/StackResponseDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# StackResponseDto - -Stack response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | | -**id** | **UUID** | Stack ID | -**primary_asset_id** | **UUID** | Primary asset ID | - -## Example - -```python -from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of StackResponseDto from a JSON string -stack_response_dto_instance = StackResponseDto.from_json(json) -# print the JSON string representation of the object -print(StackResponseDto.to_json()) - -# convert the object into a dict -stack_response_dto_dict = stack_response_dto_instance.to_dict() -# create an instance of StackResponseDto from a dict -stack_response_dto_from_dict = StackResponseDto.from_dict(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) - - diff --git a/generated/immich/openapi_client/docs/StackUpdateDto.md b/generated/immich/openapi_client/docs/StackUpdateDto.md deleted file mode 100644 index 1034815..0000000 --- a/generated/immich/openapi_client/docs/StackUpdateDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# StackUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**primary_asset_id** | **UUID** | Primary asset ID | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of StackUpdateDto from a JSON string -stack_update_dto_instance = StackUpdateDto.from_json(json) -# print the JSON string representation of the object -print(StackUpdateDto.to_json()) - -# convert the object into a dict -stack_update_dto_dict = stack_update_dto_instance.to_dict() -# create an instance of StackUpdateDto from a dict -stack_update_dto_from_dict = StackUpdateDto.from_dict(stack_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) - - diff --git a/generated/immich/openapi_client/docs/StacksApi.md b/generated/immich/openapi_client/docs/StacksApi.md deleted file mode 100644 index 4396030..0000000 --- a/generated/immich/openapi_client/docs/StacksApi.md +++ /dev/null @@ -1,657 +0,0 @@ -# generated.immich.openapi_client.StacksApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_stack**](StacksApi.md#create_stack) | **POST** /stacks | Create a stack -[**delete_stack**](StacksApi.md#delete_stack) | **DELETE** /stacks/{id} | Delete a stack -[**delete_stacks**](StacksApi.md#delete_stacks) | **DELETE** /stacks | Delete stacks -[**get_stack**](StacksApi.md#get_stack) | **GET** /stacks/{id} | Retrieve a stack -[**remove_asset_from_stack**](StacksApi.md#remove_asset_from_stack) | **DELETE** /stacks/{id}/assets/{assetId} | Remove an asset from a stack -[**search_stacks**](StacksApi.md#search_stacks) | **GET** /stacks | Retrieve stacks -[**update_stack**](StacksApi.md#update_stack) | **PUT** /stacks/{id} | Update a stack - - -# **create_stack** -> StackResponseDto create_stack(stack_create_dto) - -Create a stack - -Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack. - -### 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.stack_create_dto import StackCreateDto -from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto -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.StacksApi(api_client) - stack_create_dto = generated.immich.openapi_client.StackCreateDto() # StackCreateDto | - - try: - # Create a stack - api_response = api_instance.create_stack(stack_create_dto) - print("The response of StacksApi->create_stack:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling StacksApi->create_stack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stack_create_dto** | [**StackCreateDto**](StackCreateDto.md)| | - -### Return type - -[**StackResponseDto**](StackResponseDto.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_stack** -> delete_stack(id) - -Delete a stack - -Delete a specific stack by its ID. - -### 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.StacksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a stack - api_instance.delete_stack(id) - except Exception as e: - print("Exception when calling StacksApi->delete_stack: %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_stacks** -> delete_stacks(bulk_ids_dto) - -Delete stacks - -Delete multiple stacks by providing a list of stack 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.StacksApi(api_client) - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Delete stacks - api_instance.delete_stacks(bulk_ids_dto) - except Exception as e: - print("Exception when calling StacksApi->delete_stacks: %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_stack** -> StackResponseDto get_stack(id) - -Retrieve a stack - -Retrieve a specific stack by its ID. - -### 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.stack_response_dto import StackResponseDto -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.StacksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a stack - api_response = api_instance.get_stack(id) - print("The response of StacksApi->get_stack:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling StacksApi->get_stack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**StackResponseDto**](StackResponseDto.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) - -# **remove_asset_from_stack** -> remove_asset_from_stack(asset_id, id) - -Remove an asset from a stack - -Remove a specific asset from a stack by providing the stack ID and asset ID. - -### 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.StacksApi(api_client) - asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Remove an asset from a stack - api_instance.remove_asset_from_stack(asset_id, id) - except Exception as e: - print("Exception when calling StacksApi->remove_asset_from_stack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset_id** | **UUID**| | - **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) - -# **search_stacks** -> List[StackResponseDto] search_stacks(primary_asset_id=primary_asset_id) - -Retrieve stacks - -Retrieve a list of stacks. - -### 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.stack_response_dto import StackResponseDto -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.StacksApi(api_client) - primary_asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by primary asset ID (optional) - - try: - # Retrieve stacks - api_response = api_instance.search_stacks(primary_asset_id=primary_asset_id) - print("The response of StacksApi->search_stacks:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling StacksApi->search_stacks: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **primary_asset_id** | **UUID**| Filter by primary asset ID | [optional] - -### Return type - -[**List[StackResponseDto]**](StackResponseDto.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_stack** -> StackResponseDto update_stack(id, stack_update_dto) - -Update a stack - -Update an existing stack by its ID. - -### 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.stack_response_dto import StackResponseDto -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto -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.StacksApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - stack_update_dto = generated.immich.openapi_client.StackUpdateDto() # StackUpdateDto | - - try: - # Update a stack - api_response = api_instance.update_stack(id, stack_update_dto) - print("The response of StacksApi->update_stack:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling StacksApi->update_stack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **stack_update_dto** | [**StackUpdateDto**](StackUpdateDto.md)| | - -### Return type - -[**StackResponseDto**](StackResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/SyncAckDeleteDto.md b/generated/immich/openapi_client/docs/SyncAckDeleteDto.md deleted file mode 100644 index 9898851..0000000 --- a/generated/immich/openapi_client/docs/SyncAckDeleteDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SyncAckDeleteDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**types** | [**List[SyncEntityType]**](SyncEntityType.md) | Sync entity types to delete acks for | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.sync_ack_delete_dto import SyncAckDeleteDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncAckDeleteDto from a JSON string -sync_ack_delete_dto_instance = SyncAckDeleteDto.from_json(json) -# print the JSON string representation of the object -print(SyncAckDeleteDto.to_json()) - -# convert the object into a dict -sync_ack_delete_dto_dict = sync_ack_delete_dto_instance.to_dict() -# create an instance of SyncAckDeleteDto from a dict -sync_ack_delete_dto_from_dict = SyncAckDeleteDto.from_dict(sync_ack_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) - - diff --git a/generated/immich/openapi_client/docs/SyncAckDto.md b/generated/immich/openapi_client/docs/SyncAckDto.md deleted file mode 100644 index 5130b0c..0000000 --- a/generated/immich/openapi_client/docs/SyncAckDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SyncAckDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ack** | **str** | Acknowledgment ID | -**type** | [**SyncEntityType**](SyncEntityType.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.sync_ack_dto import SyncAckDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncAckDto from a JSON string -sync_ack_dto_instance = SyncAckDto.from_json(json) -# print the JSON string representation of the object -print(SyncAckDto.to_json()) - -# convert the object into a dict -sync_ack_dto_dict = sync_ack_dto_instance.to_dict() -# create an instance of SyncAckDto from a dict -sync_ack_dto_from_dict = SyncAckDto.from_dict(sync_ack_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) - - diff --git a/generated/immich/openapi_client/docs/SyncAckSetDto.md b/generated/immich/openapi_client/docs/SyncAckSetDto.md deleted file mode 100644 index 29604f0..0000000 --- a/generated/immich/openapi_client/docs/SyncAckSetDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SyncAckSetDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**acks** | **List[str]** | Acknowledgment IDs (max 1000) | - -## Example - -```python -from generated.immich.openapi_client.models.sync_ack_set_dto import SyncAckSetDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncAckSetDto from a JSON string -sync_ack_set_dto_instance = SyncAckSetDto.from_json(json) -# print the JSON string representation of the object -print(SyncAckSetDto.to_json()) - -# convert the object into a dict -sync_ack_set_dto_dict = sync_ack_set_dto_instance.to_dict() -# create an instance of SyncAckSetDto from a dict -sync_ack_set_dto_from_dict = SyncAckSetDto.from_dict(sync_ack_set_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) - - diff --git a/generated/immich/openapi_client/docs/SyncApi.md b/generated/immich/openapi_client/docs/SyncApi.md deleted file mode 100644 index 49abd01..0000000 --- a/generated/immich/openapi_client/docs/SyncApi.md +++ /dev/null @@ -1,370 +0,0 @@ -# generated.immich.openapi_client.SyncApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_sync_ack**](SyncApi.md#delete_sync_ack) | **DELETE** /sync/ack | Delete acknowledgements -[**get_sync_ack**](SyncApi.md#get_sync_ack) | **GET** /sync/ack | Retrieve acknowledgements -[**get_sync_stream**](SyncApi.md#get_sync_stream) | **POST** /sync/stream | Stream sync changes -[**send_sync_ack**](SyncApi.md#send_sync_ack) | **POST** /sync/ack | Acknowledge changes - - -# **delete_sync_ack** -> delete_sync_ack(sync_ack_delete_dto) - -Delete acknowledgements - -Delete specific synchronization acknowledgments. - -### 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.sync_ack_delete_dto import SyncAckDeleteDto -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.SyncApi(api_client) - sync_ack_delete_dto = generated.immich.openapi_client.SyncAckDeleteDto() # SyncAckDeleteDto | - - try: - # Delete acknowledgements - api_instance.delete_sync_ack(sync_ack_delete_dto) - except Exception as e: - print("Exception when calling SyncApi->delete_sync_ack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **sync_ack_delete_dto** | [**SyncAckDeleteDto**](SyncAckDeleteDto.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_sync_ack** -> List[SyncAckDto] get_sync_ack() - -Retrieve acknowledgements - -Retrieve the synchronization acknowledgments for the current session. - -### 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.sync_ack_dto import SyncAckDto -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.SyncApi(api_client) - - try: - # Retrieve acknowledgements - api_response = api_instance.get_sync_ack() - print("The response of SyncApi->get_sync_ack:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SyncApi->get_sync_ack: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[SyncAckDto]**](SyncAckDto.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_sync_stream** -> get_sync_stream(sync_stream_dto) - -Stream sync changes - -Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes. - -### 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.sync_stream_dto import SyncStreamDto -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.SyncApi(api_client) - sync_stream_dto = generated.immich.openapi_client.SyncStreamDto() # SyncStreamDto | - - try: - # Stream sync changes - api_instance.get_sync_stream(sync_stream_dto) - except Exception as e: - print("Exception when calling SyncApi->get_sync_stream: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **sync_stream_dto** | [**SyncStreamDto**](SyncStreamDto.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 | -|-------------|-------------|------------------| -**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) - -# **send_sync_ack** -> send_sync_ack(sync_ack_set_dto) - -Acknowledge changes - -Send a list of synchronization acknowledgements to confirm that the latest changes have been received. - -### 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.sync_ack_set_dto import SyncAckSetDto -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.SyncApi(api_client) - sync_ack_set_dto = generated.immich.openapi_client.SyncAckSetDto() # SyncAckSetDto | - - try: - # Acknowledge changes - api_instance.send_sync_ack(sync_ack_set_dto) - except Exception as e: - print("Exception when calling SyncApi->send_sync_ack: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **sync_ack_set_dto** | [**SyncAckSetDto**](SyncAckSetDto.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) - diff --git a/generated/immich/openapi_client/docs/SyncAssetDeleteV1.md b/generated/immich/openapi_client/docs/SyncAssetDeleteV1.md deleted file mode 100644 index 959e4b8..0000000 --- a/generated/immich/openapi_client/docs/SyncAssetDeleteV1.md +++ /dev/null @@ -1,29 +0,0 @@ -# SyncAssetDeleteV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**asset_id** | **UUID** | Asset ID | - -## Example - -```python -from generated.immich.openapi_client.models.sync_asset_delete_v1 import SyncAssetDeleteV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncAssetDeleteV1 from a JSON string -sync_asset_delete_v1_instance = SyncAssetDeleteV1.from_json(json) -# print the JSON string representation of the object -print(SyncAssetDeleteV1.to_json()) - -# convert the object into a dict -sync_asset_delete_v1_dict = sync_asset_delete_v1_instance.to_dict() -# create an instance of SyncAssetDeleteV1 from a dict -sync_asset_delete_v1_from_dict = SyncAssetDeleteV1.from_dict(sync_asset_delete_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SyncAssetExifV1.md b/generated/immich/openapi_client/docs/SyncAssetExifV1.md deleted file mode 100644 index 596c10a..0000000 --- a/generated/immich/openapi_client/docs/SyncAssetExifV1.md +++ /dev/null @@ -1,53 +0,0 @@ -# SyncAssetExifV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**asset_id** | **UUID** | Asset ID | -**city** | **str** | City | -**country** | **str** | Country | -**date_time_original** | **datetime** | Date time original | -**description** | **str** | Description | -**exif_image_height** | **int** | Exif image height | -**exif_image_width** | **int** | Exif image width | -**exposure_time** | **str** | Exposure time | -**f_number** | **float** | F number | -**file_size_in_byte** | **int** | File size in byte | -**focal_length** | **float** | Focal length | -**fps** | **float** | FPS | -**iso** | **int** | ISO | -**latitude** | **float** | Latitude | -**lens_model** | **str** | Lens model | -**longitude** | **float** | Longitude | -**make** | **str** | Make | -**model** | **str** | Model | -**modify_date** | **datetime** | Modify date | -**orientation** | **str** | Orientation | -**profile_description** | **str** | Profile description | -**projection_type** | **str** | Projection type | -**rating** | **int** | Rating | -**state** | **str** | State | -**time_zone** | **str** | Time zone | - -## Example - -```python -from generated.immich.openapi_client.models.sync_asset_exif_v1 import SyncAssetExifV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncAssetExifV1 from a JSON string -sync_asset_exif_v1_instance = SyncAssetExifV1.from_json(json) -# print the JSON string representation of the object -print(SyncAssetExifV1.to_json()) - -# convert the object into a dict -sync_asset_exif_v1_dict = sync_asset_exif_v1_instance.to_dict() -# create an instance of SyncAssetExifV1 from a dict -sync_asset_exif_v1_from_dict = SyncAssetExifV1.from_dict(sync_asset_exif_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SyncAssetV1.md b/generated/immich/openapi_client/docs/SyncAssetV1.md deleted file mode 100644 index 735f232..0000000 --- a/generated/immich/openapi_client/docs/SyncAssetV1.md +++ /dev/null @@ -1,48 +0,0 @@ -# SyncAssetV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**checksum** | **str** | Checksum | -**created_at** | **datetime** | Uploaded to Immich at | -**deleted_at** | **datetime** | Deleted at | -**duration** | **str** | Duration | -**file_created_at** | **datetime** | File created at | -**file_modified_at** | **datetime** | File modified at | -**height** | **int** | Asset height | -**id** | **UUID** | Asset ID | -**is_edited** | **bool** | Is edited | -**is_favorite** | **bool** | Is favorite | -**library_id** | **str** | Library ID | -**live_photo_video_id** | **str** | Live photo video ID | -**local_date_time** | **datetime** | Local date time | -**original_file_name** | **str** | Original file name | -**owner_id** | **UUID** | Owner ID | -**stack_id** | **str** | Stack ID | -**thumbhash** | **str** | Thumbhash | -**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | -**visibility** | [**AssetVisibility**](AssetVisibility.md) | | -**width** | **int** | Asset width | - -## Example - -```python -from generated.immich.openapi_client.models.sync_asset_v1 import SyncAssetV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncAssetV1 from a JSON string -sync_asset_v1_instance = SyncAssetV1.from_json(json) -# print the JSON string representation of the object -print(SyncAssetV1.to_json()) - -# convert the object into a dict -sync_asset_v1_dict = sync_asset_v1_instance.to_dict() -# create an instance of SyncAssetV1 from a dict -sync_asset_v1_from_dict = SyncAssetV1.from_dict(sync_asset_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SyncEntityType.md b/generated/immich/openapi_client/docs/SyncEntityType.md deleted file mode 100644 index 0d42f2e..0000000 --- a/generated/immich/openapi_client/docs/SyncEntityType.md +++ /dev/null @@ -1,127 +0,0 @@ -# SyncEntityType - -Sync entity type - -## Enum - -* `AUTHUSERV1` (value: `'AuthUserV1'`) - -* `USERV1` (value: `'UserV1'`) - -* `USERDELETEV1` (value: `'UserDeleteV1'`) - -* `ASSETV1` (value: `'AssetV1'`) - -* `ASSETV2` (value: `'AssetV2'`) - -* `ASSETDELETEV1` (value: `'AssetDeleteV1'`) - -* `ASSETEXIFV1` (value: `'AssetExifV1'`) - -* `ASSETEDITV1` (value: `'AssetEditV1'`) - -* `ASSETEDITDELETEV1` (value: `'AssetEditDeleteV1'`) - -* `ASSETMETADATAV1` (value: `'AssetMetadataV1'`) - -* `ASSETMETADATADELETEV1` (value: `'AssetMetadataDeleteV1'`) - -* `ASSETOCRV1` (value: `'AssetOcrV1'`) - -* `ASSETOCRDELETEV1` (value: `'AssetOcrDeleteV1'`) - -* `PARTNERV1` (value: `'PartnerV1'`) - -* `PARTNERDELETEV1` (value: `'PartnerDeleteV1'`) - -* `PARTNERASSETV1` (value: `'PartnerAssetV1'`) - -* `PARTNERASSETV2` (value: `'PartnerAssetV2'`) - -* `PARTNERASSETBACKFILLV1` (value: `'PartnerAssetBackfillV1'`) - -* `PARTNERASSETBACKFILLV2` (value: `'PartnerAssetBackfillV2'`) - -* `PARTNERASSETDELETEV1` (value: `'PartnerAssetDeleteV1'`) - -* `PARTNERASSETEXIFV1` (value: `'PartnerAssetExifV1'`) - -* `PARTNERASSETEXIFBACKFILLV1` (value: `'PartnerAssetExifBackfillV1'`) - -* `PARTNERSTACKBACKFILLV1` (value: `'PartnerStackBackfillV1'`) - -* `PARTNERSTACKDELETEV1` (value: `'PartnerStackDeleteV1'`) - -* `PARTNERSTACKV1` (value: `'PartnerStackV1'`) - -* `ALBUMV1` (value: `'AlbumV1'`) - -* `ALBUMV2` (value: `'AlbumV2'`) - -* `ALBUMDELETEV1` (value: `'AlbumDeleteV1'`) - -* `ALBUMUSERV1` (value: `'AlbumUserV1'`) - -* `ALBUMUSERBACKFILLV1` (value: `'AlbumUserBackfillV1'`) - -* `ALBUMUSERDELETEV1` (value: `'AlbumUserDeleteV1'`) - -* `ALBUMASSETCREATEV1` (value: `'AlbumAssetCreateV1'`) - -* `ALBUMASSETCREATEV2` (value: `'AlbumAssetCreateV2'`) - -* `ALBUMASSETUPDATEV1` (value: `'AlbumAssetUpdateV1'`) - -* `ALBUMASSETUPDATEV2` (value: `'AlbumAssetUpdateV2'`) - -* `ALBUMASSETBACKFILLV1` (value: `'AlbumAssetBackfillV1'`) - -* `ALBUMASSETBACKFILLV2` (value: `'AlbumAssetBackfillV2'`) - -* `ALBUMASSETEXIFCREATEV1` (value: `'AlbumAssetExifCreateV1'`) - -* `ALBUMASSETEXIFUPDATEV1` (value: `'AlbumAssetExifUpdateV1'`) - -* `ALBUMASSETEXIFBACKFILLV1` (value: `'AlbumAssetExifBackfillV1'`) - -* `ALBUMTOASSETV1` (value: `'AlbumToAssetV1'`) - -* `ALBUMTOASSETDELETEV1` (value: `'AlbumToAssetDeleteV1'`) - -* `ALBUMTOASSETBACKFILLV1` (value: `'AlbumToAssetBackfillV1'`) - -* `MEMORYV1` (value: `'MemoryV1'`) - -* `MEMORYDELETEV1` (value: `'MemoryDeleteV1'`) - -* `MEMORYTOASSETV1` (value: `'MemoryToAssetV1'`) - -* `MEMORYTOASSETDELETEV1` (value: `'MemoryToAssetDeleteV1'`) - -* `STACKV1` (value: `'StackV1'`) - -* `STACKDELETEV1` (value: `'StackDeleteV1'`) - -* `PERSONV1` (value: `'PersonV1'`) - -* `PERSONDELETEV1` (value: `'PersonDeleteV1'`) - -* `ASSETFACEV1` (value: `'AssetFaceV1'`) - -* `ASSETFACEV2` (value: `'AssetFaceV2'`) - -* `ASSETFACEDELETEV1` (value: `'AssetFaceDeleteV1'`) - -* `USERMETADATAV1` (value: `'UserMetadataV1'`) - -* `USERMETADATADELETEV1` (value: `'UserMetadataDeleteV1'`) - -* `SYNCACKV1` (value: `'SyncAckV1'`) - -* `SYNCRESETV1` (value: `'SyncResetV1'`) - -* `SYNCCOMPLETEV1` (value: `'SyncCompleteV1'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/SyncPartnerDeleteV1.md b/generated/immich/openapi_client/docs/SyncPartnerDeleteV1.md deleted file mode 100644 index 5f76f2a..0000000 --- a/generated/immich/openapi_client/docs/SyncPartnerDeleteV1.md +++ /dev/null @@ -1,30 +0,0 @@ -# SyncPartnerDeleteV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**shared_by_id** | **UUID** | Shared by ID | -**shared_with_id** | **UUID** | Shared with ID | - -## Example - -```python -from generated.immich.openapi_client.models.sync_partner_delete_v1 import SyncPartnerDeleteV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncPartnerDeleteV1 from a JSON string -sync_partner_delete_v1_instance = SyncPartnerDeleteV1.from_json(json) -# print the JSON string representation of the object -print(SyncPartnerDeleteV1.to_json()) - -# convert the object into a dict -sync_partner_delete_v1_dict = sync_partner_delete_v1_instance.to_dict() -# create an instance of SyncPartnerDeleteV1 from a dict -sync_partner_delete_v1_from_dict = SyncPartnerDeleteV1.from_dict(sync_partner_delete_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SyncPartnerV1.md b/generated/immich/openapi_client/docs/SyncPartnerV1.md deleted file mode 100644 index abc1fd5..0000000 --- a/generated/immich/openapi_client/docs/SyncPartnerV1.md +++ /dev/null @@ -1,31 +0,0 @@ -# SyncPartnerV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**in_timeline** | **bool** | In timeline | -**shared_by_id** | **UUID** | Shared by ID | -**shared_with_id** | **UUID** | Shared with ID | - -## Example - -```python -from generated.immich.openapi_client.models.sync_partner_v1 import SyncPartnerV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncPartnerV1 from a JSON string -sync_partner_v1_instance = SyncPartnerV1.from_json(json) -# print the JSON string representation of the object -print(SyncPartnerV1.to_json()) - -# convert the object into a dict -sync_partner_v1_dict = sync_partner_v1_instance.to_dict() -# create an instance of SyncPartnerV1 from a dict -sync_partner_v1_from_dict = SyncPartnerV1.from_dict(sync_partner_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SyncRequestType.md b/generated/immich/openapi_client/docs/SyncRequestType.md deleted file mode 100644 index fa0b23b..0000000 --- a/generated/immich/openapi_client/docs/SyncRequestType.md +++ /dev/null @@ -1,63 +0,0 @@ -# SyncRequestType - -Sync request type - -## Enum - -* `ALBUMSV1` (value: `'AlbumsV1'`) - -* `ALBUMSV2` (value: `'AlbumsV2'`) - -* `ALBUMUSERSV1` (value: `'AlbumUsersV1'`) - -* `ALBUMTOASSETSV1` (value: `'AlbumToAssetsV1'`) - -* `ALBUMASSETSV1` (value: `'AlbumAssetsV1'`) - -* `ALBUMASSETSV2` (value: `'AlbumAssetsV2'`) - -* `ALBUMASSETEXIFSV1` (value: `'AlbumAssetExifsV1'`) - -* `ASSETSV1` (value: `'AssetsV1'`) - -* `ASSETSV2` (value: `'AssetsV2'`) - -* `ASSETEXIFSV1` (value: `'AssetExifsV1'`) - -* `ASSETEDITSV1` (value: `'AssetEditsV1'`) - -* `ASSETMETADATAV1` (value: `'AssetMetadataV1'`) - -* `ASSETOCRV1` (value: `'AssetOcrV1'`) - -* `AUTHUSERSV1` (value: `'AuthUsersV1'`) - -* `MEMORIESV1` (value: `'MemoriesV1'`) - -* `MEMORYTOASSETSV1` (value: `'MemoryToAssetsV1'`) - -* `PARTNERSV1` (value: `'PartnersV1'`) - -* `PARTNERASSETSV1` (value: `'PartnerAssetsV1'`) - -* `PARTNERASSETSV2` (value: `'PartnerAssetsV2'`) - -* `PARTNERASSETEXIFSV1` (value: `'PartnerAssetExifsV1'`) - -* `PARTNERSTACKSV1` (value: `'PartnerStacksV1'`) - -* `STACKSV1` (value: `'StacksV1'`) - -* `USERSV1` (value: `'UsersV1'`) - -* `PEOPLEV1` (value: `'PeopleV1'`) - -* `ASSETFACESV1` (value: `'AssetFacesV1'`) - -* `ASSETFACESV2` (value: `'AssetFacesV2'`) - -* `USERMETADATAV1` (value: `'UserMetadataV1'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/SyncStreamDto.md b/generated/immich/openapi_client/docs/SyncStreamDto.md deleted file mode 100644 index e42abac..0000000 --- a/generated/immich/openapi_client/docs/SyncStreamDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SyncStreamDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reset** | **bool** | Reset sync state | [optional] -**types** | [**List[SyncRequestType]**](SyncRequestType.md) | Sync request types | - -## Example - -```python -from generated.immich.openapi_client.models.sync_stream_dto import SyncStreamDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncStreamDto from a JSON string -sync_stream_dto_instance = SyncStreamDto.from_json(json) -# print the JSON string representation of the object -print(SyncStreamDto.to_json()) - -# convert the object into a dict -sync_stream_dto_dict = sync_stream_dto_instance.to_dict() -# create an instance of SyncStreamDto from a dict -sync_stream_dto_from_dict = SyncStreamDto.from_dict(sync_stream_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) - - diff --git a/generated/immich/openapi_client/docs/SyncUserDeleteV1.md b/generated/immich/openapi_client/docs/SyncUserDeleteV1.md deleted file mode 100644 index 30c16df..0000000 --- a/generated/immich/openapi_client/docs/SyncUserDeleteV1.md +++ /dev/null @@ -1,29 +0,0 @@ -# SyncUserDeleteV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user_id** | **UUID** | User ID | - -## Example - -```python -from generated.immich.openapi_client.models.sync_user_delete_v1 import SyncUserDeleteV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncUserDeleteV1 from a JSON string -sync_user_delete_v1_instance = SyncUserDeleteV1.from_json(json) -# print the JSON string representation of the object -print(SyncUserDeleteV1.to_json()) - -# convert the object into a dict -sync_user_delete_v1_dict = sync_user_delete_v1_instance.to_dict() -# create an instance of SyncUserDeleteV1 from a dict -sync_user_delete_v1_from_dict = SyncUserDeleteV1.from_dict(sync_user_delete_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SyncUserV1.md b/generated/immich/openapi_client/docs/SyncUserV1.md deleted file mode 100644 index ccf98f8..0000000 --- a/generated/immich/openapi_client/docs/SyncUserV1.md +++ /dev/null @@ -1,35 +0,0 @@ -# SyncUserV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | [optional] -**deleted_at** | **datetime** | User deleted at | -**email** | **str** | User email | -**has_profile_image** | **bool** | User has profile image | -**id** | **UUID** | User ID | -**name** | **str** | User name | -**profile_changed_at** | **datetime** | User profile changed at | - -## Example - -```python -from generated.immich.openapi_client.models.sync_user_v1 import SyncUserV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of SyncUserV1 from a JSON string -sync_user_v1_instance = SyncUserV1.from_json(json) -# print the JSON string representation of the object -print(SyncUserV1.to_json()) - -# convert the object into a dict -sync_user_v1_dict = sync_user_v1_instance.to_dict() -# create an instance of SyncUserV1 from a dict -sync_user_v1_from_dict = SyncUserV1.from_dict(sync_user_v1_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigApi.md b/generated/immich/openapi_client/docs/SystemConfigApi.md deleted file mode 100644 index a08c856..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigApi.md +++ /dev/null @@ -1,368 +0,0 @@ -# generated.immich.openapi_client.SystemConfigApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_config**](SystemConfigApi.md#get_config) | **GET** /system-config | Get system configuration -[**get_config_defaults**](SystemConfigApi.md#get_config_defaults) | **GET** /system-config/defaults | Get system configuration defaults -[**get_storage_template_options**](SystemConfigApi.md#get_storage_template_options) | **GET** /system-config/storage-template-options | Get storage template options -[**update_config**](SystemConfigApi.md#update_config) | **PUT** /system-config | Update system configuration - - -# **get_config** -> SystemConfigDto get_config() - -Get system configuration - -Retrieve the current system configuration. - -### 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.system_config_dto import SystemConfigDto -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.SystemConfigApi(api_client) - - try: - # Get system configuration - api_response = api_instance.get_config() - print("The response of SystemConfigApi->get_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemConfigApi->get_config: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**SystemConfigDto**](SystemConfigDto.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_config_defaults** -> SystemConfigDto get_config_defaults() - -Get system configuration defaults - -Retrieve the default values for the system configuration. - -### 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.system_config_dto import SystemConfigDto -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.SystemConfigApi(api_client) - - try: - # Get system configuration defaults - api_response = api_instance.get_config_defaults() - print("The response of SystemConfigApi->get_config_defaults:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemConfigApi->get_config_defaults: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**SystemConfigDto**](SystemConfigDto.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_storage_template_options** -> SystemConfigTemplateStorageOptionDto get_storage_template_options() - -Get storage template options - -Retrieve exemplary storage template options. - -### 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.system_config_template_storage_option_dto import SystemConfigTemplateStorageOptionDto -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.SystemConfigApi(api_client) - - try: - # Get storage template options - api_response = api_instance.get_storage_template_options() - print("The response of SystemConfigApi->get_storage_template_options:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemConfigApi->get_storage_template_options: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**SystemConfigTemplateStorageOptionDto**](SystemConfigTemplateStorageOptionDto.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_config** -> SystemConfigDto update_config(system_config_dto) - -Update system configuration - -Update the system configuration with a new system configuration. - -### 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.system_config_dto import SystemConfigDto -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.SystemConfigApi(api_client) - system_config_dto = generated.immich.openapi_client.SystemConfigDto() # SystemConfigDto | - - try: - # Update system configuration - api_response = api_instance.update_config(system_config_dto) - print("The response of SystemConfigApi->update_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemConfigApi->update_config: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **system_config_dto** | [**SystemConfigDto**](SystemConfigDto.md)| | - -### Return type - -[**SystemConfigDto**](SystemConfigDto.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) - diff --git a/generated/immich/openapi_client/docs/SystemConfigBackupsDto.md b/generated/immich/openapi_client/docs/SystemConfigBackupsDto.md deleted file mode 100644 index ff2d534..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigBackupsDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigBackupsDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**database** | [**DatabaseBackupConfig**](DatabaseBackupConfig.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_backups_dto import SystemConfigBackupsDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigBackupsDto from a JSON string -system_config_backups_dto_instance = SystemConfigBackupsDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigBackupsDto.to_json()) - -# convert the object into a dict -system_config_backups_dto_dict = system_config_backups_dto_instance.to_dict() -# create an instance of SystemConfigBackupsDto from a dict -system_config_backups_dto_from_dict = SystemConfigBackupsDto.from_dict(system_config_backups_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigDto.md b/generated/immich/openapi_client/docs/SystemConfigDto.md deleted file mode 100644 index 9e5bc63..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigDto.md +++ /dev/null @@ -1,51 +0,0 @@ -# SystemConfigDto - -System configuration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backup** | [**SystemConfigBackupsDto**](SystemConfigBackupsDto.md) | | -**ffmpeg** | [**SystemConfigFFmpegDto**](SystemConfigFFmpegDto.md) | | -**image** | [**SystemConfigImageDto**](SystemConfigImageDto.md) | | -**integrity_checks** | [**SystemConfigIntegrityChecks**](SystemConfigIntegrityChecks.md) | | -**job** | [**SystemConfigJobDto**](SystemConfigJobDto.md) | | -**library** | [**SystemConfigLibraryDto**](SystemConfigLibraryDto.md) | | -**logging** | [**SystemConfigLoggingDto**](SystemConfigLoggingDto.md) | | -**machine_learning** | [**SystemConfigMachineLearningDto**](SystemConfigMachineLearningDto.md) | | -**map** | [**SystemConfigMapDto**](SystemConfigMapDto.md) | | -**metadata** | [**SystemConfigMetadataDto**](SystemConfigMetadataDto.md) | | -**new_version_check** | [**SystemConfigNewVersionCheckDto**](SystemConfigNewVersionCheckDto.md) | | -**nightly_tasks** | [**SystemConfigNightlyTasksDto**](SystemConfigNightlyTasksDto.md) | | -**notifications** | [**SystemConfigNotificationsDto**](SystemConfigNotificationsDto.md) | | -**oauth** | [**SystemConfigOAuthDto**](SystemConfigOAuthDto.md) | | -**password_login** | [**SystemConfigPasswordLoginDto**](SystemConfigPasswordLoginDto.md) | | -**reverse_geocoding** | [**SystemConfigReverseGeocodingDto**](SystemConfigReverseGeocodingDto.md) | | -**server** | [**SystemConfigServerDto**](SystemConfigServerDto.md) | | -**storage_template** | [**SystemConfigStorageTemplateDto**](SystemConfigStorageTemplateDto.md) | | -**templates** | [**SystemConfigTemplatesDto**](SystemConfigTemplatesDto.md) | | -**theme** | [**SystemConfigThemeDto**](SystemConfigThemeDto.md) | | -**trash** | [**SystemConfigTrashDto**](SystemConfigTrashDto.md) | | -**user** | [**SystemConfigUserDto**](SystemConfigUserDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_dto import SystemConfigDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigDto from a JSON string -system_config_dto_instance = SystemConfigDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigDto.to_json()) - -# convert the object into a dict -system_config_dto_dict = system_config_dto_instance.to_dict() -# create an instance of SystemConfigDto from a dict -system_config_dto_from_dict = SystemConfigDto.from_dict(system_config_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigFFmpegDto.md b/generated/immich/openapi_client/docs/SystemConfigFFmpegDto.md deleted file mode 100644 index 2810504..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigFFmpegDto.md +++ /dev/null @@ -1,50 +0,0 @@ -# SystemConfigFFmpegDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accel** | [**TranscodeHWAccel**](TranscodeHWAccel.md) | | -**accel_decode** | **bool** | Accelerated decode | -**accepted_audio_codecs** | [**List[AudioCodec]**](AudioCodec.md) | Accepted audio codecs | -**accepted_containers** | [**List[VideoContainer]**](VideoContainer.md) | Accepted containers | -**accepted_video_codecs** | [**List[VideoCodec]**](VideoCodec.md) | Accepted video codecs | -**bframes** | **int** | B-frames | -**cq_mode** | [**CQMode**](CQMode.md) | | -**crf** | **int** | CRF | -**gop_size** | **int** | GOP size | -**max_bitrate** | **str** | Max bitrate | -**preferred_hw_device** | **str** | Preferred hardware device | -**preset** | **str** | Preset | -**realtime** | [**SystemConfigFFmpegRealtimeDto**](SystemConfigFFmpegRealtimeDto.md) | | -**refs** | **int** | References | -**target_audio_codec** | [**AudioCodec**](AudioCodec.md) | | -**target_resolution** | **str** | Target resolution | -**target_video_codec** | [**VideoCodec**](VideoCodec.md) | | -**temporal_aq** | **bool** | Temporal AQ | -**threads** | **int** | Threads | -**tonemap** | [**ToneMapping**](ToneMapping.md) | | -**transcode** | [**TranscodePolicy**](TranscodePolicy.md) | | -**two_pass** | **bool** | Two pass | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_f_fmpeg_dto import SystemConfigFFmpegDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigFFmpegDto from a JSON string -system_config_f_fmpeg_dto_instance = SystemConfigFFmpegDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigFFmpegDto.to_json()) - -# convert the object into a dict -system_config_f_fmpeg_dto_dict = system_config_f_fmpeg_dto_instance.to_dict() -# create an instance of SystemConfigFFmpegDto from a dict -system_config_f_fmpeg_dto_from_dict = SystemConfigFFmpegDto.from_dict(system_config_f_fmpeg_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigFacesDto.md b/generated/immich/openapi_client/docs/SystemConfigFacesDto.md deleted file mode 100644 index 139b5ef..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigFacesDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigFacesDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**var_import** | **bool** | Import | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_faces_dto import SystemConfigFacesDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigFacesDto from a JSON string -system_config_faces_dto_instance = SystemConfigFacesDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigFacesDto.to_json()) - -# convert the object into a dict -system_config_faces_dto_dict = system_config_faces_dto_instance.to_dict() -# create an instance of SystemConfigFacesDto from a dict -system_config_faces_dto_from_dict = SystemConfigFacesDto.from_dict(system_config_faces_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigGeneratedFullsizeImageDto.md b/generated/immich/openapi_client/docs/SystemConfigGeneratedFullsizeImageDto.md deleted file mode 100644 index 3cfca9d..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigGeneratedFullsizeImageDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# SystemConfigGeneratedFullsizeImageDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Enabled | -**format** | [**ImageFormat**](ImageFormat.md) | | -**progressive** | **bool** | Progressive | [optional] -**quality** | **int** | Quality | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto import SystemConfigGeneratedFullsizeImageDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigGeneratedFullsizeImageDto from a JSON string -system_config_generated_fullsize_image_dto_instance = SystemConfigGeneratedFullsizeImageDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigGeneratedFullsizeImageDto.to_json()) - -# convert the object into a dict -system_config_generated_fullsize_image_dto_dict = system_config_generated_fullsize_image_dto_instance.to_dict() -# create an instance of SystemConfigGeneratedFullsizeImageDto from a dict -system_config_generated_fullsize_image_dto_from_dict = SystemConfigGeneratedFullsizeImageDto.from_dict(system_config_generated_fullsize_image_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigGeneratedImageDto.md b/generated/immich/openapi_client/docs/SystemConfigGeneratedImageDto.md deleted file mode 100644 index ee7fc7e..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigGeneratedImageDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# SystemConfigGeneratedImageDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** | [**ImageFormat**](ImageFormat.md) | | -**progressive** | **bool** | Progressive | [optional] -**quality** | **int** | Quality | -**size** | **int** | Size | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_generated_image_dto import SystemConfigGeneratedImageDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigGeneratedImageDto from a JSON string -system_config_generated_image_dto_instance = SystemConfigGeneratedImageDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigGeneratedImageDto.to_json()) - -# convert the object into a dict -system_config_generated_image_dto_dict = system_config_generated_image_dto_instance.to_dict() -# create an instance of SystemConfigGeneratedImageDto from a dict -system_config_generated_image_dto_from_dict = SystemConfigGeneratedImageDto.from_dict(system_config_generated_image_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigImageDto.md b/generated/immich/openapi_client/docs/SystemConfigImageDto.md deleted file mode 100644 index 5576370..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigImageDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# SystemConfigImageDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**colorspace** | [**Colorspace**](Colorspace.md) | | -**extract_embedded** | **bool** | Extract embedded | -**fullsize** | [**SystemConfigGeneratedFullsizeImageDto**](SystemConfigGeneratedFullsizeImageDto.md) | | -**preview** | [**SystemConfigGeneratedImageDto**](SystemConfigGeneratedImageDto.md) | | -**thumbnail** | [**SystemConfigGeneratedImageDto**](SystemConfigGeneratedImageDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_image_dto import SystemConfigImageDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigImageDto from a JSON string -system_config_image_dto_instance = SystemConfigImageDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigImageDto.to_json()) - -# convert the object into a dict -system_config_image_dto_dict = system_config_image_dto_instance.to_dict() -# create an instance of SystemConfigImageDto from a dict -system_config_image_dto_from_dict = SystemConfigImageDto.from_dict(system_config_image_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigJobDto.md b/generated/immich/openapi_client/docs/SystemConfigJobDto.md deleted file mode 100644 index 424eeb6..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigJobDto.md +++ /dev/null @@ -1,43 +0,0 @@ -# SystemConfigJobDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**background_task** | [**JobSettingsDto**](JobSettingsDto.md) | | -**editor** | [**JobSettingsDto**](JobSettingsDto.md) | | -**face_detection** | [**JobSettingsDto**](JobSettingsDto.md) | | -**integrity_check** | [**JobSettingsDto**](JobSettingsDto.md) | | -**library** | [**JobSettingsDto**](JobSettingsDto.md) | | -**metadata_extraction** | [**JobSettingsDto**](JobSettingsDto.md) | | -**migration** | [**JobSettingsDto**](JobSettingsDto.md) | | -**notifications** | [**JobSettingsDto**](JobSettingsDto.md) | | -**ocr** | [**JobSettingsDto**](JobSettingsDto.md) | | -**search** | [**JobSettingsDto**](JobSettingsDto.md) | | -**sidecar** | [**JobSettingsDto**](JobSettingsDto.md) | | -**smart_search** | [**JobSettingsDto**](JobSettingsDto.md) | | -**thumbnail_generation** | [**JobSettingsDto**](JobSettingsDto.md) | | -**video_conversion** | [**JobSettingsDto**](JobSettingsDto.md) | | -**workflow** | [**JobSettingsDto**](JobSettingsDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_job_dto import SystemConfigJobDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigJobDto from a JSON string -system_config_job_dto_instance = SystemConfigJobDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigJobDto.to_json()) - -# convert the object into a dict -system_config_job_dto_dict = system_config_job_dto_instance.to_dict() -# create an instance of SystemConfigJobDto from a dict -system_config_job_dto_from_dict = SystemConfigJobDto.from_dict(system_config_job_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigLibraryDto.md b/generated/immich/openapi_client/docs/SystemConfigLibraryDto.md deleted file mode 100644 index 45d0922..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigLibraryDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SystemConfigLibraryDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scan** | [**SystemConfigLibraryScanDto**](SystemConfigLibraryScanDto.md) | | -**watch** | [**SystemConfigLibraryWatchDto**](SystemConfigLibraryWatchDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_library_dto import SystemConfigLibraryDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigLibraryDto from a JSON string -system_config_library_dto_instance = SystemConfigLibraryDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigLibraryDto.to_json()) - -# convert the object into a dict -system_config_library_dto_dict = system_config_library_dto_instance.to_dict() -# create an instance of SystemConfigLibraryDto from a dict -system_config_library_dto_from_dict = SystemConfigLibraryDto.from_dict(system_config_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigLibraryScanDto.md b/generated/immich/openapi_client/docs/SystemConfigLibraryScanDto.md deleted file mode 100644 index f447215..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigLibraryScanDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SystemConfigLibraryScanDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cron_expression** | **str** | Cron expression | -**enabled** | **bool** | Enabled | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_library_scan_dto import SystemConfigLibraryScanDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigLibraryScanDto from a JSON string -system_config_library_scan_dto_instance = SystemConfigLibraryScanDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigLibraryScanDto.to_json()) - -# convert the object into a dict -system_config_library_scan_dto_dict = system_config_library_scan_dto_instance.to_dict() -# create an instance of SystemConfigLibraryScanDto from a dict -system_config_library_scan_dto_from_dict = SystemConfigLibraryScanDto.from_dict(system_config_library_scan_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigLibraryWatchDto.md b/generated/immich/openapi_client/docs/SystemConfigLibraryWatchDto.md deleted file mode 100644 index f071ae2..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigLibraryWatchDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigLibraryWatchDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Enabled | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_library_watch_dto import SystemConfigLibraryWatchDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigLibraryWatchDto from a JSON string -system_config_library_watch_dto_instance = SystemConfigLibraryWatchDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigLibraryWatchDto.to_json()) - -# convert the object into a dict -system_config_library_watch_dto_dict = system_config_library_watch_dto_instance.to_dict() -# create an instance of SystemConfigLibraryWatchDto from a dict -system_config_library_watch_dto_from_dict = SystemConfigLibraryWatchDto.from_dict(system_config_library_watch_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigLoggingDto.md b/generated/immich/openapi_client/docs/SystemConfigLoggingDto.md deleted file mode 100644 index b5dd625..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigLoggingDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SystemConfigLoggingDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Enabled | -**level** | [**LogLevel**](LogLevel.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_logging_dto import SystemConfigLoggingDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigLoggingDto from a JSON string -system_config_logging_dto_instance = SystemConfigLoggingDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigLoggingDto.to_json()) - -# convert the object into a dict -system_config_logging_dto_dict = system_config_logging_dto_instance.to_dict() -# create an instance of SystemConfigLoggingDto from a dict -system_config_logging_dto_from_dict = SystemConfigLoggingDto.from_dict(system_config_logging_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigMachineLearningDto.md b/generated/immich/openapi_client/docs/SystemConfigMachineLearningDto.md deleted file mode 100644 index a69c505..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigMachineLearningDto.md +++ /dev/null @@ -1,35 +0,0 @@ -# SystemConfigMachineLearningDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**availability_checks** | [**MachineLearningAvailabilityChecksDto**](MachineLearningAvailabilityChecksDto.md) | | -**clip** | [**CLIPConfig**](CLIPConfig.md) | | -**duplicate_detection** | [**DuplicateDetectionConfig**](DuplicateDetectionConfig.md) | | -**enabled** | **bool** | Enabled | -**facial_recognition** | [**FacialRecognitionConfig**](FacialRecognitionConfig.md) | | -**ocr** | [**OcrConfig**](OcrConfig.md) | | -**urls** | **List[str]** | ML service URLs | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_machine_learning_dto import SystemConfigMachineLearningDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigMachineLearningDto from a JSON string -system_config_machine_learning_dto_instance = SystemConfigMachineLearningDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigMachineLearningDto.to_json()) - -# convert the object into a dict -system_config_machine_learning_dto_dict = system_config_machine_learning_dto_instance.to_dict() -# create an instance of SystemConfigMachineLearningDto from a dict -system_config_machine_learning_dto_from_dict = SystemConfigMachineLearningDto.from_dict(system_config_machine_learning_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigMapDto.md b/generated/immich/openapi_client/docs/SystemConfigMapDto.md deleted file mode 100644 index 8f7025e..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigMapDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# SystemConfigMapDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dark_style** | **str** | Dark map style URL | -**enabled** | **bool** | Enabled | -**light_style** | **str** | Light map style URL | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_map_dto import SystemConfigMapDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigMapDto from a JSON string -system_config_map_dto_instance = SystemConfigMapDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigMapDto.to_json()) - -# convert the object into a dict -system_config_map_dto_dict = system_config_map_dto_instance.to_dict() -# create an instance of SystemConfigMapDto from a dict -system_config_map_dto_from_dict = SystemConfigMapDto.from_dict(system_config_map_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigMetadataDto.md b/generated/immich/openapi_client/docs/SystemConfigMetadataDto.md deleted file mode 100644 index 81c8843..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigMetadataDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigMetadataDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**faces** | [**SystemConfigFacesDto**](SystemConfigFacesDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_metadata_dto import SystemConfigMetadataDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigMetadataDto from a JSON string -system_config_metadata_dto_instance = SystemConfigMetadataDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigMetadataDto.to_json()) - -# convert the object into a dict -system_config_metadata_dto_dict = system_config_metadata_dto_instance.to_dict() -# create an instance of SystemConfigMetadataDto from a dict -system_config_metadata_dto_from_dict = SystemConfigMetadataDto.from_dict(system_config_metadata_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigNewVersionCheckDto.md b/generated/immich/openapi_client/docs/SystemConfigNewVersionCheckDto.md deleted file mode 100644 index d5c9c75..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigNewVersionCheckDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SystemConfigNewVersionCheckDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | [**ReleaseChannel**](ReleaseChannel.md) | | -**enabled** | **bool** | Enabled | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_new_version_check_dto import SystemConfigNewVersionCheckDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigNewVersionCheckDto from a JSON string -system_config_new_version_check_dto_instance = SystemConfigNewVersionCheckDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigNewVersionCheckDto.to_json()) - -# convert the object into a dict -system_config_new_version_check_dto_dict = system_config_new_version_check_dto_instance.to_dict() -# create an instance of SystemConfigNewVersionCheckDto from a dict -system_config_new_version_check_dto_from_dict = SystemConfigNewVersionCheckDto.from_dict(system_config_new_version_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigNotificationsDto.md b/generated/immich/openapi_client/docs/SystemConfigNotificationsDto.md deleted file mode 100644 index 210e9b9..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigNotificationsDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigNotificationsDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**smtp** | [**SystemConfigSmtpDto**](SystemConfigSmtpDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_notifications_dto import SystemConfigNotificationsDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigNotificationsDto from a JSON string -system_config_notifications_dto_instance = SystemConfigNotificationsDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigNotificationsDto.to_json()) - -# convert the object into a dict -system_config_notifications_dto_dict = system_config_notifications_dto_instance.to_dict() -# create an instance of SystemConfigNotificationsDto from a dict -system_config_notifications_dto_from_dict = SystemConfigNotificationsDto.from_dict(system_config_notifications_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigOAuthDto.md b/generated/immich/openapi_client/docs/SystemConfigOAuthDto.md deleted file mode 100644 index 99e1195..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigOAuthDto.md +++ /dev/null @@ -1,49 +0,0 @@ -# SystemConfigOAuthDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allow_insecure_requests** | **bool** | Allow insecure requests | -**auto_launch** | **bool** | Auto launch | -**auto_register** | **bool** | Auto register | -**button_text** | **str** | Button text | -**client_id** | **str** | Client ID | -**client_secret** | **str** | Client secret | -**default_storage_quota** | **int** | Default storage quota | -**enabled** | **bool** | Enabled | -**end_session_endpoint** | **str** | End session endpoint | -**issuer_url** | **str** | Issuer URL | -**mobile_override_enabled** | **bool** | Mobile override enabled | -**mobile_redirect_uri** | **str** | Mobile redirect URI (set to empty string to disable) | -**profile_signing_algorithm** | **str** | Profile signing algorithm | -**prompt** | **str** | OAuth prompt parameter (e.g. select_account, login, consent) | -**role_claim** | **str** | Role claim | -**scope** | **str** | Scope | -**signing_algorithm** | **str** | Signing algorithm | -**storage_label_claim** | **str** | Storage label claim | -**storage_quota_claim** | **str** | Storage quota claim | -**timeout** | **int** | Timeout | -**token_endpoint_auth_method** | [**OAuthTokenEndpointAuthMethod**](OAuthTokenEndpointAuthMethod.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_o_auth_dto import SystemConfigOAuthDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigOAuthDto from a JSON string -system_config_o_auth_dto_instance = SystemConfigOAuthDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigOAuthDto.to_json()) - -# convert the object into a dict -system_config_o_auth_dto_dict = system_config_o_auth_dto_instance.to_dict() -# create an instance of SystemConfigOAuthDto from a dict -system_config_o_auth_dto_from_dict = SystemConfigOAuthDto.from_dict(system_config_o_auth_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigPasswordLoginDto.md b/generated/immich/openapi_client/docs/SystemConfigPasswordLoginDto.md deleted file mode 100644 index 224e905..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigPasswordLoginDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigPasswordLoginDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Enabled | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_password_login_dto import SystemConfigPasswordLoginDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigPasswordLoginDto from a JSON string -system_config_password_login_dto_instance = SystemConfigPasswordLoginDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigPasswordLoginDto.to_json()) - -# convert the object into a dict -system_config_password_login_dto_dict = system_config_password_login_dto_instance.to_dict() -# create an instance of SystemConfigPasswordLoginDto from a dict -system_config_password_login_dto_from_dict = SystemConfigPasswordLoginDto.from_dict(system_config_password_login_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigReverseGeocodingDto.md b/generated/immich/openapi_client/docs/SystemConfigReverseGeocodingDto.md deleted file mode 100644 index c84737a..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigReverseGeocodingDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigReverseGeocodingDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Enabled | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_reverse_geocoding_dto import SystemConfigReverseGeocodingDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigReverseGeocodingDto from a JSON string -system_config_reverse_geocoding_dto_instance = SystemConfigReverseGeocodingDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigReverseGeocodingDto.to_json()) - -# convert the object into a dict -system_config_reverse_geocoding_dto_dict = system_config_reverse_geocoding_dto_instance.to_dict() -# create an instance of SystemConfigReverseGeocodingDto from a dict -system_config_reverse_geocoding_dto_from_dict = SystemConfigReverseGeocodingDto.from_dict(system_config_reverse_geocoding_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigServerDto.md b/generated/immich/openapi_client/docs/SystemConfigServerDto.md deleted file mode 100644 index b087a96..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigServerDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# SystemConfigServerDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**external_domain** | **str** | External domain | -**login_page_message** | **str** | Login page message | -**public_users** | **bool** | Public users | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_server_dto import SystemConfigServerDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigServerDto from a JSON string -system_config_server_dto_instance = SystemConfigServerDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigServerDto.to_json()) - -# convert the object into a dict -system_config_server_dto_dict = system_config_server_dto_instance.to_dict() -# create an instance of SystemConfigServerDto from a dict -system_config_server_dto_from_dict = SystemConfigServerDto.from_dict(system_config_server_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigSmtpDto.md b/generated/immich/openapi_client/docs/SystemConfigSmtpDto.md deleted file mode 100644 index 49844b5..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigSmtpDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# SystemConfigSmtpDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether SMTP email notifications are enabled | -**var_from** | **str** | Email address to send from | -**reply_to** | **str** | Email address for replies | -**transport** | [**SystemConfigSmtpTransportDto**](SystemConfigSmtpTransportDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_smtp_dto import SystemConfigSmtpDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigSmtpDto from a JSON string -system_config_smtp_dto_instance = SystemConfigSmtpDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigSmtpDto.to_json()) - -# convert the object into a dict -system_config_smtp_dto_dict = system_config_smtp_dto_instance.to_dict() -# create an instance of SystemConfigSmtpDto from a dict -system_config_smtp_dto_from_dict = SystemConfigSmtpDto.from_dict(system_config_smtp_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigSmtpTransportDto.md b/generated/immich/openapi_client/docs/SystemConfigSmtpTransportDto.md deleted file mode 100644 index f4cd185..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigSmtpTransportDto.md +++ /dev/null @@ -1,34 +0,0 @@ -# SystemConfigSmtpTransportDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**host** | **str** | SMTP server hostname | -**ignore_cert** | **bool** | Whether to ignore SSL certificate errors | -**password** | **str** | SMTP password | -**port** | **int** | SMTP server port | -**secure** | **bool** | Whether to use secure connection (TLS/SSL) | -**username** | **str** | SMTP username | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_smtp_transport_dto import SystemConfigSmtpTransportDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigSmtpTransportDto from a JSON string -system_config_smtp_transport_dto_instance = SystemConfigSmtpTransportDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigSmtpTransportDto.to_json()) - -# convert the object into a dict -system_config_smtp_transport_dto_dict = system_config_smtp_transport_dto_instance.to_dict() -# create an instance of SystemConfigSmtpTransportDto from a dict -system_config_smtp_transport_dto_from_dict = SystemConfigSmtpTransportDto.from_dict(system_config_smtp_transport_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigStorageTemplateDto.md b/generated/immich/openapi_client/docs/SystemConfigStorageTemplateDto.md deleted file mode 100644 index f6dbf07..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigStorageTemplateDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# SystemConfigStorageTemplateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Enabled | -**hash_verification_enabled** | **bool** | Hash verification enabled | -**template** | **str** | Template | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_storage_template_dto import SystemConfigStorageTemplateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigStorageTemplateDto from a JSON string -system_config_storage_template_dto_instance = SystemConfigStorageTemplateDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigStorageTemplateDto.to_json()) - -# convert the object into a dict -system_config_storage_template_dto_dict = system_config_storage_template_dto_instance.to_dict() -# create an instance of SystemConfigStorageTemplateDto from a dict -system_config_storage_template_dto_from_dict = SystemConfigStorageTemplateDto.from_dict(system_config_storage_template_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigTemplateEmailsDto.md b/generated/immich/openapi_client/docs/SystemConfigTemplateEmailsDto.md deleted file mode 100644 index bebc001..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigTemplateEmailsDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# SystemConfigTemplateEmailsDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album_invite_template** | **str** | Album invite template | -**album_update_template** | **str** | Album update template | -**welcome_template** | **str** | Welcome template | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_template_emails_dto import SystemConfigTemplateEmailsDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigTemplateEmailsDto from a JSON string -system_config_template_emails_dto_instance = SystemConfigTemplateEmailsDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigTemplateEmailsDto.to_json()) - -# convert the object into a dict -system_config_template_emails_dto_dict = system_config_template_emails_dto_instance.to_dict() -# create an instance of SystemConfigTemplateEmailsDto from a dict -system_config_template_emails_dto_from_dict = SystemConfigTemplateEmailsDto.from_dict(system_config_template_emails_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigTemplateStorageOptionDto.md b/generated/immich/openapi_client/docs/SystemConfigTemplateStorageOptionDto.md deleted file mode 100644 index 36828f5..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigTemplateStorageOptionDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# SystemConfigTemplateStorageOptionDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**day_options** | **List[str]** | Available day format options for storage template | -**hour_options** | **List[str]** | Available hour format options for storage template | -**minute_options** | **List[str]** | Available minute format options for storage template | -**month_options** | **List[str]** | Available month format options for storage template | -**preset_options** | **List[str]** | Available preset template options | -**second_options** | **List[str]** | Available second format options for storage template | -**week_options** | **List[str]** | Available week format options for storage template | -**year_options** | **List[str]** | Available year format options for storage template | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_template_storage_option_dto import SystemConfigTemplateStorageOptionDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigTemplateStorageOptionDto from a JSON string -system_config_template_storage_option_dto_instance = SystemConfigTemplateStorageOptionDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigTemplateStorageOptionDto.to_json()) - -# convert the object into a dict -system_config_template_storage_option_dto_dict = system_config_template_storage_option_dto_instance.to_dict() -# create an instance of SystemConfigTemplateStorageOptionDto from a dict -system_config_template_storage_option_dto_from_dict = SystemConfigTemplateStorageOptionDto.from_dict(system_config_template_storage_option_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigTemplatesDto.md b/generated/immich/openapi_client/docs/SystemConfigTemplatesDto.md deleted file mode 100644 index f0f6888..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigTemplatesDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigTemplatesDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | [**SystemConfigTemplateEmailsDto**](SystemConfigTemplateEmailsDto.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_templates_dto import SystemConfigTemplatesDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigTemplatesDto from a JSON string -system_config_templates_dto_instance = SystemConfigTemplatesDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigTemplatesDto.to_json()) - -# convert the object into a dict -system_config_templates_dto_dict = system_config_templates_dto_instance.to_dict() -# create an instance of SystemConfigTemplatesDto from a dict -system_config_templates_dto_from_dict = SystemConfigTemplatesDto.from_dict(system_config_templates_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigThemeDto.md b/generated/immich/openapi_client/docs/SystemConfigThemeDto.md deleted file mode 100644 index 7c829b5..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigThemeDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigThemeDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_css** | **str** | Custom CSS for theming | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_theme_dto import SystemConfigThemeDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigThemeDto from a JSON string -system_config_theme_dto_instance = SystemConfigThemeDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigThemeDto.to_json()) - -# convert the object into a dict -system_config_theme_dto_dict = system_config_theme_dto_instance.to_dict() -# create an instance of SystemConfigThemeDto from a dict -system_config_theme_dto_from_dict = SystemConfigThemeDto.from_dict(system_config_theme_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigTrashDto.md b/generated/immich/openapi_client/docs/SystemConfigTrashDto.md deleted file mode 100644 index d5551d1..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigTrashDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# SystemConfigTrashDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**days** | **int** | Days | -**enabled** | **bool** | Enabled | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_trash_dto import SystemConfigTrashDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigTrashDto from a JSON string -system_config_trash_dto_instance = SystemConfigTrashDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigTrashDto.to_json()) - -# convert the object into a dict -system_config_trash_dto_dict = system_config_trash_dto_instance.to_dict() -# create an instance of SystemConfigTrashDto from a dict -system_config_trash_dto_from_dict = SystemConfigTrashDto.from_dict(system_config_trash_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) - - diff --git a/generated/immich/openapi_client/docs/SystemConfigUserDto.md b/generated/immich/openapi_client/docs/SystemConfigUserDto.md deleted file mode 100644 index 701949e..0000000 --- a/generated/immich/openapi_client/docs/SystemConfigUserDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# SystemConfigUserDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**delete_delay** | **int** | Delete delay | - -## Example - -```python -from generated.immich.openapi_client.models.system_config_user_dto import SystemConfigUserDto - -# TODO update the JSON string below -json = "{}" -# create an instance of SystemConfigUserDto from a JSON string -system_config_user_dto_instance = SystemConfigUserDto.from_json(json) -# print the JSON string representation of the object -print(SystemConfigUserDto.to_json()) - -# convert the object into a dict -system_config_user_dto_dict = system_config_user_dto_instance.to_dict() -# create an instance of SystemConfigUserDto from a dict -system_config_user_dto_from_dict = SystemConfigUserDto.from_dict(system_config_user_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) - - diff --git a/generated/immich/openapi_client/docs/SystemMetadataApi.md b/generated/immich/openapi_client/docs/SystemMetadataApi.md deleted file mode 100644 index 924c45b..0000000 --- a/generated/immich/openapi_client/docs/SystemMetadataApi.md +++ /dev/null @@ -1,366 +0,0 @@ -# generated.immich.openapi_client.SystemMetadataApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_admin_onboarding**](SystemMetadataApi.md#get_admin_onboarding) | **GET** /system-metadata/admin-onboarding | Retrieve admin onboarding -[**get_reverse_geocoding_state**](SystemMetadataApi.md#get_reverse_geocoding_state) | **GET** /system-metadata/reverse-geocoding-state | Retrieve reverse geocoding state -[**get_version_check_state**](SystemMetadataApi.md#get_version_check_state) | **GET** /system-metadata/version-check-state | Retrieve version check state -[**update_admin_onboarding**](SystemMetadataApi.md#update_admin_onboarding) | **POST** /system-metadata/admin-onboarding | Update admin onboarding - - -# **get_admin_onboarding** -> AdminOnboardingUpdateDto get_admin_onboarding() - -Retrieve admin onboarding - -Retrieve the current admin onboarding status. - -### 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.admin_onboarding_update_dto import AdminOnboardingUpdateDto -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.SystemMetadataApi(api_client) - - try: - # Retrieve admin onboarding - api_response = api_instance.get_admin_onboarding() - print("The response of SystemMetadataApi->get_admin_onboarding:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemMetadataApi->get_admin_onboarding: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**AdminOnboardingUpdateDto**](AdminOnboardingUpdateDto.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_reverse_geocoding_state** -> ReverseGeocodingStateResponseDto get_reverse_geocoding_state() - -Retrieve reverse geocoding state - -Retrieve the current state of the reverse geocoding import. - -### 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.reverse_geocoding_state_response_dto import ReverseGeocodingStateResponseDto -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.SystemMetadataApi(api_client) - - try: - # Retrieve reverse geocoding state - api_response = api_instance.get_reverse_geocoding_state() - print("The response of SystemMetadataApi->get_reverse_geocoding_state:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemMetadataApi->get_reverse_geocoding_state: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ReverseGeocodingStateResponseDto**](ReverseGeocodingStateResponseDto.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_version_check_state** -> VersionCheckStateResponseDto get_version_check_state() - -Retrieve version check state - -Retrieve the current state of the version check process. - -### 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.version_check_state_response_dto import VersionCheckStateResponseDto -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.SystemMetadataApi(api_client) - - try: - # Retrieve version check state - api_response = api_instance.get_version_check_state() - print("The response of SystemMetadataApi->get_version_check_state:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SystemMetadataApi->get_version_check_state: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**VersionCheckStateResponseDto**](VersionCheckStateResponseDto.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_admin_onboarding** -> update_admin_onboarding(admin_onboarding_update_dto) - -Update admin onboarding - -Update the admin onboarding status. - -### 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.admin_onboarding_update_dto import AdminOnboardingUpdateDto -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.SystemMetadataApi(api_client) - admin_onboarding_update_dto = generated.immich.openapi_client.AdminOnboardingUpdateDto() # AdminOnboardingUpdateDto | - - try: - # Update admin onboarding - api_instance.update_admin_onboarding(admin_onboarding_update_dto) - except Exception as e: - print("Exception when calling SystemMetadataApi->update_admin_onboarding: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **admin_onboarding_update_dto** | [**AdminOnboardingUpdateDto**](AdminOnboardingUpdateDto.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) - diff --git a/generated/immich/openapi_client/docs/TagBulkAssetsDto.md b/generated/immich/openapi_client/docs/TagBulkAssetsDto.md deleted file mode 100644 index b1ab8d7..0000000 --- a/generated/immich/openapi_client/docs/TagBulkAssetsDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# TagBulkAssetsDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**asset_ids** | **List[UUID]** | Asset IDs | -**tag_ids** | **List[UUID]** | Tag IDs | - -## Example - -```python -from generated.immich.openapi_client.models.tag_bulk_assets_dto import TagBulkAssetsDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TagBulkAssetsDto from a JSON string -tag_bulk_assets_dto_instance = TagBulkAssetsDto.from_json(json) -# print the JSON string representation of the object -print(TagBulkAssetsDto.to_json()) - -# convert the object into a dict -tag_bulk_assets_dto_dict = tag_bulk_assets_dto_instance.to_dict() -# create an instance of TagBulkAssetsDto from a dict -tag_bulk_assets_dto_from_dict = TagBulkAssetsDto.from_dict(tag_bulk_assets_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) - - diff --git a/generated/immich/openapi_client/docs/TagBulkAssetsResponseDto.md b/generated/immich/openapi_client/docs/TagBulkAssetsResponseDto.md deleted file mode 100644 index e4629be..0000000 --- a/generated/immich/openapi_client/docs/TagBulkAssetsResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# TagBulkAssetsResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | Number of assets tagged | - -## Example - -```python -from generated.immich.openapi_client.models.tag_bulk_assets_response_dto import TagBulkAssetsResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TagBulkAssetsResponseDto from a JSON string -tag_bulk_assets_response_dto_instance = TagBulkAssetsResponseDto.from_json(json) -# print the JSON string representation of the object -print(TagBulkAssetsResponseDto.to_json()) - -# convert the object into a dict -tag_bulk_assets_response_dto_dict = tag_bulk_assets_response_dto_instance.to_dict() -# create an instance of TagBulkAssetsResponseDto from a dict -tag_bulk_assets_response_dto_from_dict = TagBulkAssetsResponseDto.from_dict(tag_bulk_assets_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) - - diff --git a/generated/immich/openapi_client/docs/TagCreateDto.md b/generated/immich/openapi_client/docs/TagCreateDto.md deleted file mode 100644 index 73c1993..0000000 --- a/generated/immich/openapi_client/docs/TagCreateDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# TagCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**color** | **str** | Tag color (hex) | [optional] -**name** | **str** | Tag name | -**parent_id** | **UUID** | Parent tag ID | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.tag_create_dto import TagCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TagCreateDto from a JSON string -tag_create_dto_instance = TagCreateDto.from_json(json) -# print the JSON string representation of the object -print(TagCreateDto.to_json()) - -# convert the object into a dict -tag_create_dto_dict = tag_create_dto_instance.to_dict() -# create an instance of TagCreateDto from a dict -tag_create_dto_from_dict = TagCreateDto.from_dict(tag_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) - - diff --git a/generated/immich/openapi_client/docs/TagResponseDto.md b/generated/immich/openapi_client/docs/TagResponseDto.md deleted file mode 100644 index 75eaedb..0000000 --- a/generated/immich/openapi_client/docs/TagResponseDto.md +++ /dev/null @@ -1,35 +0,0 @@ -# TagResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**color** | **str** | Tag color (hex) | [optional] -**created_at** | **datetime** | Creation date | -**id** | **UUID** | Tag ID | -**name** | **str** | Tag name | -**parent_id** | **str** | Parent tag ID | [optional] -**updated_at** | **datetime** | Last update date | -**value** | **str** | Tag value (full path) | - -## Example - -```python -from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TagResponseDto from a JSON string -tag_response_dto_instance = TagResponseDto.from_json(json) -# print the JSON string representation of the object -print(TagResponseDto.to_json()) - -# convert the object into a dict -tag_response_dto_dict = tag_response_dto_instance.to_dict() -# create an instance of TagResponseDto from a dict -tag_response_dto_from_dict = TagResponseDto.from_dict(tag_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) - - diff --git a/generated/immich/openapi_client/docs/TagUpdateDto.md b/generated/immich/openapi_client/docs/TagUpdateDto.md deleted file mode 100644 index a18fa38..0000000 --- a/generated/immich/openapi_client/docs/TagUpdateDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# TagUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**color** | **str** | Tag color (hex) | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TagUpdateDto from a JSON string -tag_update_dto_instance = TagUpdateDto.from_json(json) -# print the JSON string representation of the object -print(TagUpdateDto.to_json()) - -# convert the object into a dict -tag_update_dto_dict = tag_update_dto_instance.to_dict() -# create an instance of TagUpdateDto from a dict -tag_update_dto_from_dict = TagUpdateDto.from_dict(tag_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) - - diff --git a/generated/immich/openapi_client/docs/TagUpsertDto.md b/generated/immich/openapi_client/docs/TagUpsertDto.md deleted file mode 100644 index db9de12..0000000 --- a/generated/immich/openapi_client/docs/TagUpsertDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# TagUpsertDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | **List[str]** | Tag names to upsert | - -## Example - -```python -from generated.immich.openapi_client.models.tag_upsert_dto import TagUpsertDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TagUpsertDto from a JSON string -tag_upsert_dto_instance = TagUpsertDto.from_json(json) -# print the JSON string representation of the object -print(TagUpsertDto.to_json()) - -# convert the object into a dict -tag_upsert_dto_dict = tag_upsert_dto_instance.to_dict() -# create an instance of TagUpsertDto from a dict -tag_upsert_dto_from_dict = TagUpsertDto.from_dict(tag_upsert_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) - - diff --git a/generated/immich/openapi_client/docs/TagsApi.md b/generated/immich/openapi_client/docs/TagsApi.md deleted file mode 100644 index 0554701..0000000 --- a/generated/immich/openapi_client/docs/TagsApi.md +++ /dev/null @@ -1,850 +0,0 @@ -# generated.immich.openapi_client.TagsApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**bulk_tag_assets**](TagsApi.md#bulk_tag_assets) | **PUT** /tags/assets | Tag assets -[**create_tag**](TagsApi.md#create_tag) | **POST** /tags | Create a tag -[**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /tags/{id} | Delete a tag -[**get_all_tags**](TagsApi.md#get_all_tags) | **GET** /tags | Retrieve tags -[**get_tag_by_id**](TagsApi.md#get_tag_by_id) | **GET** /tags/{id} | Retrieve a tag -[**tag_assets**](TagsApi.md#tag_assets) | **PUT** /tags/{id}/assets | Tag assets -[**untag_assets**](TagsApi.md#untag_assets) | **DELETE** /tags/{id}/assets | Untag assets -[**update_tag**](TagsApi.md#update_tag) | **PUT** /tags/{id} | Update a tag -[**upsert_tags**](TagsApi.md#upsert_tags) | **PUT** /tags | Upsert tags - - -# **bulk_tag_assets** -> TagBulkAssetsResponseDto bulk_tag_assets(tag_bulk_assets_dto) - -Tag assets - -Add multiple tags to multiple assets in a single request. - -### 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.tag_bulk_assets_dto import TagBulkAssetsDto -from generated.immich.openapi_client.models.tag_bulk_assets_response_dto import TagBulkAssetsResponseDto -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.TagsApi(api_client) - tag_bulk_assets_dto = generated.immich.openapi_client.TagBulkAssetsDto() # TagBulkAssetsDto | - - try: - # Tag assets - api_response = api_instance.bulk_tag_assets(tag_bulk_assets_dto) - print("The response of TagsApi->bulk_tag_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->bulk_tag_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tag_bulk_assets_dto** | [**TagBulkAssetsDto**](TagBulkAssetsDto.md)| | - -### Return type - -[**TagBulkAssetsResponseDto**](TagBulkAssetsResponseDto.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) - -# **create_tag** -> TagResponseDto create_tag(tag_create_dto) - -Create a tag - -Create a new tag by providing a name and optional color. - -### 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.tag_create_dto import TagCreateDto -from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto -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.TagsApi(api_client) - tag_create_dto = generated.immich.openapi_client.TagCreateDto() # TagCreateDto | - - try: - # Create a tag - api_response = api_instance.create_tag(tag_create_dto) - print("The response of TagsApi->create_tag:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->create_tag: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tag_create_dto** | [**TagCreateDto**](TagCreateDto.md)| | - -### Return type - -[**TagResponseDto**](TagResponseDto.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_tag** -> delete_tag(id) - -Delete a tag - -Delete a specific tag by its ID. - -### 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.TagsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Delete a tag - api_instance.delete_tag(id) - except Exception as e: - print("Exception when calling TagsApi->delete_tag: %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_all_tags** -> List[TagResponseDto] get_all_tags() - -Retrieve tags - -Retrieve a list of all tags. - -### 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.tag_response_dto import TagResponseDto -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.TagsApi(api_client) - - try: - # Retrieve tags - api_response = api_instance.get_all_tags() - print("The response of TagsApi->get_all_tags:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->get_all_tags: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[TagResponseDto]**](TagResponseDto.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_tag_by_id** -> TagResponseDto get_tag_by_id(id) - -Retrieve a tag - -Retrieve a specific tag by its ID. - -### 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.tag_response_dto import TagResponseDto -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.TagsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a tag - api_response = api_instance.get_tag_by_id(id) - print("The response of TagsApi->get_tag_by_id:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**TagResponseDto**](TagResponseDto.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) - -# **tag_assets** -> List[BulkIdResponseDto] tag_assets(id, bulk_ids_dto) - -Tag assets - -Add a tag to all the specified assets. - -### 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.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.TagsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Tag assets - api_response = api_instance.tag_assets(id, bulk_ids_dto) - print("The response of TagsApi->tag_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->tag_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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) - -# **untag_assets** -> List[BulkIdResponseDto] untag_assets(id, bulk_ids_dto) - -Untag assets - -Remove a tag from all the specified assets. - -### 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.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.TagsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Untag assets - api_response = api_instance.untag_assets(id, bulk_ids_dto) - print("The response of TagsApi->untag_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->untag_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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) - -# **update_tag** -> TagResponseDto update_tag(id, tag_update_dto) - -Update a tag - -Update an existing tag identified by its ID. - -### 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.tag_response_dto import TagResponseDto -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto -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.TagsApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - tag_update_dto = generated.immich.openapi_client.TagUpdateDto() # TagUpdateDto | - - try: - # Update a tag - api_response = api_instance.update_tag(id, tag_update_dto) - print("The response of TagsApi->update_tag:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->update_tag: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **tag_update_dto** | [**TagUpdateDto**](TagUpdateDto.md)| | - -### Return type - -[**TagResponseDto**](TagResponseDto.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) - -# **upsert_tags** -> List[TagResponseDto] upsert_tags(tag_upsert_dto) - -Upsert tags - -Create or update multiple tags in a single request. - -### 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.tag_response_dto import TagResponseDto -from generated.immich.openapi_client.models.tag_upsert_dto import TagUpsertDto -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.TagsApi(api_client) - tag_upsert_dto = generated.immich.openapi_client.TagUpsertDto() # TagUpsertDto | - - try: - # Upsert tags - api_response = api_instance.upsert_tags(tag_upsert_dto) - print("The response of TagsApi->upsert_tags:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->upsert_tags: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tag_upsert_dto** | [**TagUpsertDto**](TagUpsertDto.md)| | - -### Return type - -[**List[TagResponseDto]**](TagResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/TagsResponse.md b/generated/immich/openapi_client/docs/TagsResponse.md deleted file mode 100644 index 6b98a7b..0000000 --- a/generated/immich/openapi_client/docs/TagsResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# TagsResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether tags are enabled | -**sidebar_web** | **bool** | Whether tags appear in web sidebar | - -## Example - -```python -from generated.immich.openapi_client.models.tags_response import TagsResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of TagsResponse from a JSON string -tags_response_instance = TagsResponse.from_json(json) -# print the JSON string representation of the object -print(TagsResponse.to_json()) - -# convert the object into a dict -tags_response_dict = tags_response_instance.to_dict() -# create an instance of TagsResponse from a dict -tags_response_from_dict = TagsResponse.from_dict(tags_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) - - diff --git a/generated/immich/openapi_client/docs/TagsUpdate.md b/generated/immich/openapi_client/docs/TagsUpdate.md deleted file mode 100644 index 4790d50..0000000 --- a/generated/immich/openapi_client/docs/TagsUpdate.md +++ /dev/null @@ -1,30 +0,0 @@ -# TagsUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether tags are enabled | [optional] -**sidebar_web** | **bool** | Whether tags appear in web sidebar | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.tags_update import TagsUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of TagsUpdate from a JSON string -tags_update_instance = TagsUpdate.from_json(json) -# print the JSON string representation of the object -print(TagsUpdate.to_json()) - -# convert the object into a dict -tags_update_dict = tags_update_instance.to_dict() -# create an instance of TagsUpdate from a dict -tags_update_from_dict = TagsUpdate.from_dict(tags_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) - - diff --git a/generated/immich/openapi_client/docs/TemplateDto.md b/generated/immich/openapi_client/docs/TemplateDto.md deleted file mode 100644 index 33e6ff0..0000000 --- a/generated/immich/openapi_client/docs/TemplateDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# TemplateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template** | **str** | Template name | - -## Example - -```python -from generated.immich.openapi_client.models.template_dto import TemplateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TemplateDto from a JSON string -template_dto_instance = TemplateDto.from_json(json) -# print the JSON string representation of the object -print(TemplateDto.to_json()) - -# convert the object into a dict -template_dto_dict = template_dto_instance.to_dict() -# create an instance of TemplateDto from a dict -template_dto_from_dict = TemplateDto.from_dict(template_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) - - diff --git a/generated/immich/openapi_client/docs/TemplateResponseDto.md b/generated/immich/openapi_client/docs/TemplateResponseDto.md deleted file mode 100644 index 85c0960..0000000 --- a/generated/immich/openapi_client/docs/TemplateResponseDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# TemplateResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**html** | **str** | Template HTML content | -**name** | **str** | Template name | - -## Example - -```python -from generated.immich.openapi_client.models.template_response_dto import TemplateResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TemplateResponseDto from a JSON string -template_response_dto_instance = TemplateResponseDto.from_json(json) -# print the JSON string representation of the object -print(TemplateResponseDto.to_json()) - -# convert the object into a dict -template_response_dto_dict = template_response_dto_instance.to_dict() -# create an instance of TemplateResponseDto from a dict -template_response_dto_from_dict = TemplateResponseDto.from_dict(template_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) - - diff --git a/generated/immich/openapi_client/docs/TestEmailResponseDto.md b/generated/immich/openapi_client/docs/TestEmailResponseDto.md deleted file mode 100644 index ef56d62..0000000 --- a/generated/immich/openapi_client/docs/TestEmailResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# TestEmailResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message_id** | **str** | Email message ID | - -## Example - -```python -from generated.immich.openapi_client.models.test_email_response_dto import TestEmailResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TestEmailResponseDto from a JSON string -test_email_response_dto_instance = TestEmailResponseDto.from_json(json) -# print the JSON string representation of the object -print(TestEmailResponseDto.to_json()) - -# convert the object into a dict -test_email_response_dto_dict = test_email_response_dto_instance.to_dict() -# create an instance of TestEmailResponseDto from a dict -test_email_response_dto_from_dict = TestEmailResponseDto.from_dict(test_email_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) - - diff --git a/generated/immich/openapi_client/docs/TimelineApi.md b/generated/immich/openapi_client/docs/TimelineApi.md deleted file mode 100644 index 318c342..0000000 --- a/generated/immich/openapi_client/docs/TimelineApi.md +++ /dev/null @@ -1,258 +0,0 @@ -# generated.immich.openapi_client.TimelineApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_time_bucket**](TimelineApi.md#get_time_bucket) | **GET** /timeline/bucket | Get time bucket -[**get_time_buckets**](TimelineApi.md#get_time_buckets) | **GET** /timeline/buckets | Get time buckets - - -# **get_time_bucket** -> TimeBucketAssetResponseDto get_time_bucket(time_bucket, album_id=album_id, bbox=bbox, is_favorite=is_favorite, is_trashed=is_trashed, key=key, order=order, order_by=order_by, person_id=person_id, slug=slug, tag_id=tag_id, user_id=user_id, visibility=visibility, with_coordinates=with_coordinates, with_partners=with_partners, with_stacked=with_stacked) - -Get time bucket - -Retrieve a string of all asset ids in a given time bucket. - -### 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.asset_order import AssetOrder -from generated.immich.openapi_client.models.asset_order_by import AssetOrderBy -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -from generated.immich.openapi_client.models.time_bucket_asset_response_dto import TimeBucketAssetResponseDto -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.TimelineApi(api_client) - time_bucket = '2024-01-01' # str | Time bucket identifier in YYYY-MM-DD format - album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets belonging to a specific album (optional) - bbox = '11.075683,49.416711,11.117589,49.454875' # str | Bounding box coordinates as west,south,east,north (WGS84) (optional) - is_favorite = True # bool | Filter by favorite status (true for favorites only, false for non-favorites only) (optional) - is_trashed = True # bool | Filter by trash status (true for trashed assets only, false for non-trashed only) (optional) - key = 'key_example' # str | (optional) - order = generated.immich.openapi_client.AssetOrder() # AssetOrder | Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) (optional) - order_by = generated.immich.openapi_client.AssetOrderBy() # AssetOrderBy | Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) (optional) - person_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets containing a specific person (face recognition) (optional) - slug = 'slug_example' # str | (optional) - tag_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets with a specific tag (optional) - user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets by specific user ID (optional) - visibility = generated.immich.openapi_client.AssetVisibility() # AssetVisibility | Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) (optional) - with_coordinates = True # bool | Include location data in the response (optional) - with_partners = True # bool | Include assets shared by partners (optional) - with_stacked = True # bool | Include stacked assets in the response. When true, only primary assets from stacks are returned. (optional) - - try: - # Get time bucket - api_response = api_instance.get_time_bucket(time_bucket, album_id=album_id, bbox=bbox, is_favorite=is_favorite, is_trashed=is_trashed, key=key, order=order, order_by=order_by, person_id=person_id, slug=slug, tag_id=tag_id, user_id=user_id, visibility=visibility, with_coordinates=with_coordinates, with_partners=with_partners, with_stacked=with_stacked) - print("The response of TimelineApi->get_time_bucket:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TimelineApi->get_time_bucket: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **time_bucket** | **str**| Time bucket identifier in YYYY-MM-DD format | - **album_id** | **UUID**| Filter assets belonging to a specific album | [optional] - **bbox** | **str**| Bounding box coordinates as west,south,east,north (WGS84) | [optional] - **is_favorite** | **bool**| Filter by favorite status (true for favorites only, false for non-favorites only) | [optional] - **is_trashed** | **bool**| Filter by trash status (true for trashed assets only, false for non-trashed only) | [optional] - **key** | **str**| | [optional] - **order** | [**AssetOrder**](.md)| Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) | [optional] - **order_by** | [**AssetOrderBy**](.md)| Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) | [optional] - **person_id** | **UUID**| Filter assets containing a specific person (face recognition) | [optional] - **slug** | **str**| | [optional] - **tag_id** | **UUID**| Filter assets with a specific tag | [optional] - **user_id** | **UUID**| Filter assets by specific user ID | [optional] - **visibility** | [**AssetVisibility**](.md)| Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) | [optional] - **with_coordinates** | **bool**| Include location data in the response | [optional] - **with_partners** | **bool**| Include assets shared by partners | [optional] - **with_stacked** | **bool**| Include stacked assets in the response. When true, only primary assets from stacks are returned. | [optional] - -### Return type - -[**TimeBucketAssetResponseDto**](TimeBucketAssetResponseDto.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_time_buckets** -> List[TimeBucketsResponseDto] get_time_buckets(album_id=album_id, bbox=bbox, is_favorite=is_favorite, is_trashed=is_trashed, key=key, order=order, order_by=order_by, person_id=person_id, slug=slug, tag_id=tag_id, user_id=user_id, visibility=visibility, with_coordinates=with_coordinates, with_partners=with_partners, with_stacked=with_stacked) - -Get time buckets - -Retrieve a list of all minimal time buckets. - -### 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.asset_order import AssetOrder -from generated.immich.openapi_client.models.asset_order_by import AssetOrderBy -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -from generated.immich.openapi_client.models.time_buckets_response_dto import TimeBucketsResponseDto -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.TimelineApi(api_client) - album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets belonging to a specific album (optional) - bbox = '11.075683,49.416711,11.117589,49.454875' # str | Bounding box coordinates as west,south,east,north (WGS84) (optional) - is_favorite = True # bool | Filter by favorite status (true for favorites only, false for non-favorites only) (optional) - is_trashed = True # bool | Filter by trash status (true for trashed assets only, false for non-trashed only) (optional) - key = 'key_example' # str | (optional) - order = generated.immich.openapi_client.AssetOrder() # AssetOrder | Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) (optional) - order_by = generated.immich.openapi_client.AssetOrderBy() # AssetOrderBy | Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) (optional) - person_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets containing a specific person (face recognition) (optional) - slug = 'slug_example' # str | (optional) - tag_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets with a specific tag (optional) - user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter assets by specific user ID (optional) - visibility = generated.immich.openapi_client.AssetVisibility() # AssetVisibility | Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) (optional) - with_coordinates = True # bool | Include location data in the response (optional) - with_partners = True # bool | Include assets shared by partners (optional) - with_stacked = True # bool | Include stacked assets in the response. When true, only primary assets from stacks are returned. (optional) - - try: - # Get time buckets - api_response = api_instance.get_time_buckets(album_id=album_id, bbox=bbox, is_favorite=is_favorite, is_trashed=is_trashed, key=key, order=order, order_by=order_by, person_id=person_id, slug=slug, tag_id=tag_id, user_id=user_id, visibility=visibility, with_coordinates=with_coordinates, with_partners=with_partners, with_stacked=with_stacked) - print("The response of TimelineApi->get_time_buckets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TimelineApi->get_time_buckets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **album_id** | **UUID**| Filter assets belonging to a specific album | [optional] - **bbox** | **str**| Bounding box coordinates as west,south,east,north (WGS84) | [optional] - **is_favorite** | **bool**| Filter by favorite status (true for favorites only, false for non-favorites only) | [optional] - **is_trashed** | **bool**| Filter by trash status (true for trashed assets only, false for non-trashed only) | [optional] - **key** | **str**| | [optional] - **order** | [**AssetOrder**](.md)| Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) | [optional] - **order_by** | [**AssetOrderBy**](.md)| Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) | [optional] - **person_id** | **UUID**| Filter assets containing a specific person (face recognition) | [optional] - **slug** | **str**| | [optional] - **tag_id** | **UUID**| Filter assets with a specific tag | [optional] - **user_id** | **UUID**| Filter assets by specific user ID | [optional] - **visibility** | [**AssetVisibility**](.md)| Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) | [optional] - **with_coordinates** | **bool**| Include location data in the response | [optional] - **with_partners** | **bool**| Include assets shared by partners | [optional] - **with_stacked** | **bool**| Include stacked assets in the response. When true, only primary assets from stacks are returned. | [optional] - -### Return type - -[**List[TimeBucketsResponseDto]**](TimeBucketsResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/ToneMapping.md b/generated/immich/openapi_client/docs/ToneMapping.md deleted file mode 100644 index f19c198..0000000 --- a/generated/immich/openapi_client/docs/ToneMapping.md +++ /dev/null @@ -1,17 +0,0 @@ -# ToneMapping - -Tone mapping - -## Enum - -* `HABLE` (value: `'hable'`) - -* `MOBIUS` (value: `'mobius'`) - -* `REINHARD` (value: `'reinhard'`) - -* `DISABLED` (value: `'disabled'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/TranscodeHWAccel.md b/generated/immich/openapi_client/docs/TranscodeHWAccel.md deleted file mode 100644 index 52ed904..0000000 --- a/generated/immich/openapi_client/docs/TranscodeHWAccel.md +++ /dev/null @@ -1,19 +0,0 @@ -# TranscodeHWAccel - -Transcode hardware acceleration - -## Enum - -* `NVENC` (value: `'nvenc'`) - -* `QSV` (value: `'qsv'`) - -* `VAAPI` (value: `'vaapi'`) - -* `RKMPP` (value: `'rkmpp'`) - -* `DISABLED` (value: `'disabled'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/TranscodePolicy.md b/generated/immich/openapi_client/docs/TranscodePolicy.md deleted file mode 100644 index 44f720e..0000000 --- a/generated/immich/openapi_client/docs/TranscodePolicy.md +++ /dev/null @@ -1,19 +0,0 @@ -# TranscodePolicy - -Transcode policy - -## Enum - -* `ALL` (value: `'all'`) - -* `OPTIMAL` (value: `'optimal'`) - -* `BITRATE` (value: `'bitrate'`) - -* `REQUIRED` (value: `'required'`) - -* `DISABLED` (value: `'disabled'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/TrashApi.md b/generated/immich/openapi_client/docs/TrashApi.md deleted file mode 100644 index d018a76..0000000 --- a/generated/immich/openapi_client/docs/TrashApi.md +++ /dev/null @@ -1,280 +0,0 @@ -# generated.immich.openapi_client.TrashApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**empty_trash**](TrashApi.md#empty_trash) | **POST** /trash/empty | Empty trash -[**restore_assets**](TrashApi.md#restore_assets) | **POST** /trash/restore/assets | Restore assets -[**restore_trash**](TrashApi.md#restore_trash) | **POST** /trash/restore | Restore trash - - -# **empty_trash** -> TrashResponseDto empty_trash() - -Empty trash - -Permanently delete all items in the trash. - -### 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.trash_response_dto import TrashResponseDto -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.TrashApi(api_client) - - try: - # Empty trash - api_response = api_instance.empty_trash() - print("The response of TrashApi->empty_trash:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TrashApi->empty_trash: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**TrashResponseDto**](TrashResponseDto.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) - -# **restore_assets** -> TrashResponseDto restore_assets(bulk_ids_dto) - -Restore assets - -Restore specific assets from the trash. - -### 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.models.trash_response_dto import TrashResponseDto -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.TrashApi(api_client) - bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | - - try: - # Restore assets - api_response = api_instance.restore_assets(bulk_ids_dto) - print("The response of TrashApi->restore_assets:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TrashApi->restore_assets: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.md)| | - -### Return type - -[**TrashResponseDto**](TrashResponseDto.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) - -# **restore_trash** -> TrashResponseDto restore_trash() - -Restore trash - -Restore all items in the trash. - -### 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.trash_response_dto import TrashResponseDto -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.TrashApi(api_client) - - try: - # Restore trash - api_response = api_instance.restore_trash() - print("The response of TrashApi->restore_trash:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TrashApi->restore_trash: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**TrashResponseDto**](TrashResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/TrashResponseDto.md b/generated/immich/openapi_client/docs/TrashResponseDto.md deleted file mode 100644 index fb4290a..0000000 --- a/generated/immich/openapi_client/docs/TrashResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# TrashResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | Number of items in trash | - -## Example - -```python -from generated.immich.openapi_client.models.trash_response_dto import TrashResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of TrashResponseDto from a JSON string -trash_response_dto_instance = TrashResponseDto.from_json(json) -# print the JSON string representation of the object -print(TrashResponseDto.to_json()) - -# convert the object into a dict -trash_response_dto_dict = trash_response_dto_instance.to_dict() -# create an instance of TrashResponseDto from a dict -trash_response_dto_from_dict = TrashResponseDto.from_dict(trash_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) - - diff --git a/generated/immich/openapi_client/docs/UpdateAlbumDto.md b/generated/immich/openapi_client/docs/UpdateAlbumDto.md deleted file mode 100644 index ee78009..0000000 --- a/generated/immich/openapi_client/docs/UpdateAlbumDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# UpdateAlbumDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**album_name** | **str** | Album name | [optional] -**album_thumbnail_asset_id** | **UUID** | Album thumbnail asset ID | [optional] -**description** | **str** | Album description | [optional] -**is_activity_enabled** | **bool** | Enable activity feed | [optional] -**order** | [**AssetOrder**](AssetOrder.md) | | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.update_album_dto import UpdateAlbumDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateAlbumDto from a JSON string -update_album_dto_instance = UpdateAlbumDto.from_json(json) -# print the JSON string representation of the object -print(UpdateAlbumDto.to_json()) - -# convert the object into a dict -update_album_dto_dict = update_album_dto_instance.to_dict() -# create an instance of UpdateAlbumDto from a dict -update_album_dto_from_dict = UpdateAlbumDto.from_dict(update_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) - - diff --git a/generated/immich/openapi_client/docs/UpdateAlbumUserDto.md b/generated/immich/openapi_client/docs/UpdateAlbumUserDto.md deleted file mode 100644 index 6c18283..0000000 --- a/generated/immich/openapi_client/docs/UpdateAlbumUserDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# UpdateAlbumUserDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**role** | [**AlbumUserRole**](AlbumUserRole.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.update_album_user_dto import UpdateAlbumUserDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateAlbumUserDto from a JSON string -update_album_user_dto_instance = UpdateAlbumUserDto.from_json(json) -# print the JSON string representation of the object -print(UpdateAlbumUserDto.to_json()) - -# convert the object into a dict -update_album_user_dto_dict = update_album_user_dto_instance.to_dict() -# create an instance of UpdateAlbumUserDto from a dict -update_album_user_dto_from_dict = UpdateAlbumUserDto.from_dict(update_album_user_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) - - diff --git a/generated/immich/openapi_client/docs/UpdateAssetDto.md b/generated/immich/openapi_client/docs/UpdateAssetDto.md deleted file mode 100644 index f27046c..0000000 --- a/generated/immich/openapi_client/docs/UpdateAssetDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# UpdateAssetDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**date_time_original** | **str** | Original date and time | [optional] -**description** | **str** | Asset description | [optional] -**is_favorite** | **bool** | Mark as favorite | [optional] -**latitude** | **float** | Latitude coordinate | [optional] -**live_photo_video_id** | **UUID** | Live photo video ID | [optional] -**longitude** | **float** | Longitude coordinate | [optional] -**rating** | **int** | Rating in range [1-5] (starred), -1 (rejected), or null (unrated) | [optional] -**visibility** | [**AssetVisibility**](AssetVisibility.md) | | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateAssetDto from a JSON string -update_asset_dto_instance = UpdateAssetDto.from_json(json) -# print the JSON string representation of the object -print(UpdateAssetDto.to_json()) - -# convert the object into a dict -update_asset_dto_dict = update_asset_dto_instance.to_dict() -# create an instance of UpdateAssetDto from a dict -update_asset_dto_from_dict = UpdateAssetDto.from_dict(update_asset_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) - - diff --git a/generated/immich/openapi_client/docs/UpdateLibraryDto.md b/generated/immich/openapi_client/docs/UpdateLibraryDto.md deleted file mode 100644 index 520af4b..0000000 --- a/generated/immich/openapi_client/docs/UpdateLibraryDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# UpdateLibraryDto - - -## 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] - -## Example - -```python -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateLibraryDto from a JSON string -update_library_dto_instance = UpdateLibraryDto.from_json(json) -# print the JSON string representation of the object -print(UpdateLibraryDto.to_json()) - -# convert the object into a dict -update_library_dto_dict = update_library_dto_instance.to_dict() -# create an instance of UpdateLibraryDto from a dict -update_library_dto_from_dict = UpdateLibraryDto.from_dict(update_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) - - diff --git a/generated/immich/openapi_client/docs/UsageByUserDto.md b/generated/immich/openapi_client/docs/UsageByUserDto.md deleted file mode 100644 index 63e3f1c..0000000 --- a/generated/immich/openapi_client/docs/UsageByUserDto.md +++ /dev/null @@ -1,36 +0,0 @@ -# UsageByUserDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**photos** | **int** | Number of photos | -**quota_size_in_bytes** | **int** | User quota size in bytes (null if unlimited) | -**usage** | **int** | Total storage usage in bytes | -**usage_photos** | **int** | Storage usage for photos in bytes | -**usage_videos** | **int** | Storage usage for videos in bytes | -**user_id** | **UUID** | User ID | -**user_name** | **str** | User name | -**videos** | **int** | Number of videos | - -## Example - -```python -from generated.immich.openapi_client.models.usage_by_user_dto import UsageByUserDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UsageByUserDto from a JSON string -usage_by_user_dto_instance = UsageByUserDto.from_json(json) -# print the JSON string representation of the object -print(UsageByUserDto.to_json()) - -# convert the object into a dict -usage_by_user_dto_dict = usage_by_user_dto_instance.to_dict() -# create an instance of UsageByUserDto from a dict -usage_by_user_dto_from_dict = UsageByUserDto.from_dict(usage_by_user_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) - - diff --git a/generated/immich/openapi_client/docs/UserAdminCreateDto.md b/generated/immich/openapi_client/docs/UserAdminCreateDto.md deleted file mode 100644 index 5cb9e63..0000000 --- a/generated/immich/openapi_client/docs/UserAdminCreateDto.md +++ /dev/null @@ -1,38 +0,0 @@ -# UserAdminCreateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | [optional] -**email** | **str** | User email | -**is_admin** | **bool** | Grant admin privileges | [optional] -**name** | **str** | User name | -**notify** | **bool** | Send notification email | [optional] -**password** | **str** | User password | -**pin_code** | **str** | PIN code | [optional] -**quota_size_in_bytes** | **int** | Storage quota in bytes | [optional] -**should_change_password** | **bool** | Require password change on next login | [optional] -**storage_label** | **str** | Storage label | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.user_admin_create_dto import UserAdminCreateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserAdminCreateDto from a JSON string -user_admin_create_dto_instance = UserAdminCreateDto.from_json(json) -# print the JSON string representation of the object -print(UserAdminCreateDto.to_json()) - -# convert the object into a dict -user_admin_create_dto_dict = user_admin_create_dto_instance.to_dict() -# create an instance of UserAdminCreateDto from a dict -user_admin_create_dto_from_dict = UserAdminCreateDto.from_dict(user_admin_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) - - diff --git a/generated/immich/openapi_client/docs/UserAdminDeleteDto.md b/generated/immich/openapi_client/docs/UserAdminDeleteDto.md deleted file mode 100644 index e055f77..0000000 --- a/generated/immich/openapi_client/docs/UserAdminDeleteDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# UserAdminDeleteDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | Force delete even if user has assets | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.user_admin_delete_dto import UserAdminDeleteDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserAdminDeleteDto from a JSON string -user_admin_delete_dto_instance = UserAdminDeleteDto.from_json(json) -# print the JSON string representation of the object -print(UserAdminDeleteDto.to_json()) - -# convert the object into a dict -user_admin_delete_dto_dict = user_admin_delete_dto_instance.to_dict() -# create an instance of UserAdminDeleteDto from a dict -user_admin_delete_dto_from_dict = UserAdminDeleteDto.from_dict(user_admin_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) - - diff --git a/generated/immich/openapi_client/docs/UserAdminResponseDto.md b/generated/immich/openapi_client/docs/UserAdminResponseDto.md deleted file mode 100644 index 9209d61..0000000 --- a/generated/immich/openapi_client/docs/UserAdminResponseDto.md +++ /dev/null @@ -1,45 +0,0 @@ -# UserAdminResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | -**created_at** | **datetime** | Creation date | -**deleted_at** | **datetime** | Deletion date | -**email** | **str** | User email | -**id** | **UUID** | User ID | -**is_admin** | **bool** | Is admin user | -**license** | [**UserLicense**](UserLicense.md) | | -**name** | **str** | User name | -**oauth_id** | **str** | OAuth ID | -**profile_changed_at** | **datetime** | Profile change date | -**profile_image_path** | **str** | Profile image path | -**quota_size_in_bytes** | **int** | Storage quota in bytes | -**quota_usage_in_bytes** | **int** | Storage usage in bytes | -**should_change_password** | **bool** | Require password change on next login | -**status** | [**UserStatus**](UserStatus.md) | | -**storage_label** | **str** | Storage label | -**updated_at** | **datetime** | Last update date | - -## Example - -```python -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserAdminResponseDto from a JSON string -user_admin_response_dto_instance = UserAdminResponseDto.from_json(json) -# print the JSON string representation of the object -print(UserAdminResponseDto.to_json()) - -# convert the object into a dict -user_admin_response_dto_dict = user_admin_response_dto_instance.to_dict() -# create an instance of UserAdminResponseDto from a dict -user_admin_response_dto_from_dict = UserAdminResponseDto.from_dict(user_admin_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) - - diff --git a/generated/immich/openapi_client/docs/UserAdminUpdateDto.md b/generated/immich/openapi_client/docs/UserAdminUpdateDto.md deleted file mode 100644 index 2f988e9..0000000 --- a/generated/immich/openapi_client/docs/UserAdminUpdateDto.md +++ /dev/null @@ -1,37 +0,0 @@ -# UserAdminUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | [optional] -**email** | **str** | User email | [optional] -**is_admin** | **bool** | Grant admin privileges | [optional] -**name** | **str** | User name | [optional] -**password** | **str** | User password | [optional] -**pin_code** | **str** | PIN code | [optional] -**quota_size_in_bytes** | **int** | Storage quota in bytes | [optional] -**should_change_password** | **bool** | Require password change on next login | [optional] -**storage_label** | **str** | Storage label | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserAdminUpdateDto from a JSON string -user_admin_update_dto_instance = UserAdminUpdateDto.from_json(json) -# print the JSON string representation of the object -print(UserAdminUpdateDto.to_json()) - -# convert the object into a dict -user_admin_update_dto_dict = user_admin_update_dto_instance.to_dict() -# create an instance of UserAdminUpdateDto from a dict -user_admin_update_dto_from_dict = UserAdminUpdateDto.from_dict(user_admin_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) - - diff --git a/generated/immich/openapi_client/docs/UserAvatarColor.md b/generated/immich/openapi_client/docs/UserAvatarColor.md deleted file mode 100644 index 81d3192..0000000 --- a/generated/immich/openapi_client/docs/UserAvatarColor.md +++ /dev/null @@ -1,29 +0,0 @@ -# UserAvatarColor - -User avatar color - -## Enum - -* `PRIMARY` (value: `'primary'`) - -* `PINK` (value: `'pink'`) - -* `RED` (value: `'red'`) - -* `YELLOW` (value: `'yellow'`) - -* `BLUE` (value: `'blue'`) - -* `GREEN` (value: `'green'`) - -* `PURPLE` (value: `'purple'`) - -* `ORANGE` (value: `'orange'`) - -* `GRAY` (value: `'gray'`) - -* `AMBER` (value: `'amber'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/UserLicense.md b/generated/immich/openapi_client/docs/UserLicense.md deleted file mode 100644 index 490930a..0000000 --- a/generated/immich/openapi_client/docs/UserLicense.md +++ /dev/null @@ -1,31 +0,0 @@ -# UserLicense - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**activated_at** | **datetime** | Activation date | -**activation_key** | **str** | Activation key | -**license_key** | **str** | License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) | - -## Example - -```python -from generated.immich.openapi_client.models.user_license import UserLicense - -# TODO update the JSON string below -json = "{}" -# create an instance of UserLicense from a JSON string -user_license_instance = UserLicense.from_json(json) -# print the JSON string representation of the object -print(UserLicense.to_json()) - -# convert the object into a dict -user_license_dict = user_license_instance.to_dict() -# create an instance of UserLicense from a dict -user_license_from_dict = UserLicense.from_dict(user_license_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) - - diff --git a/generated/immich/openapi_client/docs/UserPreferencesResponseDto.md b/generated/immich/openapi_client/docs/UserPreferencesResponseDto.md deleted file mode 100644 index 1034294..0000000 --- a/generated/immich/openapi_client/docs/UserPreferencesResponseDto.md +++ /dev/null @@ -1,40 +0,0 @@ -# UserPreferencesResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**albums** | [**AlbumsResponse**](AlbumsResponse.md) | | -**cast** | [**CastResponse**](CastResponse.md) | | -**download** | [**DownloadResponse**](DownloadResponse.md) | | -**email_notifications** | [**EmailNotificationsResponse**](EmailNotificationsResponse.md) | | -**folders** | [**FoldersResponse**](FoldersResponse.md) | | -**memories** | [**MemoriesResponse**](MemoriesResponse.md) | | -**people** | [**PeopleResponse**](PeopleResponse.md) | | -**purchase** | [**PurchaseResponse**](PurchaseResponse.md) | | -**ratings** | [**RatingsResponse**](RatingsResponse.md) | | -**recently_added** | [**RecentlyAddedResponse**](RecentlyAddedResponse.md) | | -**shared_links** | [**SharedLinksResponse**](SharedLinksResponse.md) | | -**tags** | [**TagsResponse**](TagsResponse.md) | | - -## Example - -```python -from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserPreferencesResponseDto from a JSON string -user_preferences_response_dto_instance = UserPreferencesResponseDto.from_json(json) -# print the JSON string representation of the object -print(UserPreferencesResponseDto.to_json()) - -# convert the object into a dict -user_preferences_response_dto_dict = user_preferences_response_dto_instance.to_dict() -# create an instance of UserPreferencesResponseDto from a dict -user_preferences_response_dto_from_dict = UserPreferencesResponseDto.from_dict(user_preferences_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) - - diff --git a/generated/immich/openapi_client/docs/UserPreferencesUpdateDto.md b/generated/immich/openapi_client/docs/UserPreferencesUpdateDto.md deleted file mode 100644 index cbf1db4..0000000 --- a/generated/immich/openapi_client/docs/UserPreferencesUpdateDto.md +++ /dev/null @@ -1,41 +0,0 @@ -# UserPreferencesUpdateDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**albums** | [**AlbumsUpdate**](AlbumsUpdate.md) | | [optional] -**avatar** | [**AvatarUpdate**](AvatarUpdate.md) | | [optional] -**cast** | [**CastUpdate**](CastUpdate.md) | | [optional] -**download** | [**DownloadUpdate**](DownloadUpdate.md) | | [optional] -**email_notifications** | [**EmailNotificationsUpdate**](EmailNotificationsUpdate.md) | | [optional] -**folders** | [**FoldersUpdate**](FoldersUpdate.md) | | [optional] -**memories** | [**MemoriesUpdate**](MemoriesUpdate.md) | | [optional] -**people** | [**PeopleUpdate**](PeopleUpdate.md) | | [optional] -**purchase** | [**PurchaseUpdate**](PurchaseUpdate.md) | | [optional] -**ratings** | [**RatingsUpdate**](RatingsUpdate.md) | | [optional] -**recently_added** | [**RecentlyAddedUpdate**](RecentlyAddedUpdate.md) | | [optional] -**shared_links** | [**SharedLinksUpdate**](SharedLinksUpdate.md) | | [optional] -**tags** | [**TagsUpdate**](TagsUpdate.md) | | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserPreferencesUpdateDto from a JSON string -user_preferences_update_dto_instance = UserPreferencesUpdateDto.from_json(json) -# print the JSON string representation of the object -print(UserPreferencesUpdateDto.to_json()) - -# convert the object into a dict -user_preferences_update_dto_dict = user_preferences_update_dto_instance.to_dict() -# create an instance of UserPreferencesUpdateDto from a dict -user_preferences_update_dto_from_dict = UserPreferencesUpdateDto.from_dict(user_preferences_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) - - diff --git a/generated/immich/openapi_client/docs/UserResponseDto.md b/generated/immich/openapi_client/docs/UserResponseDto.md deleted file mode 100644 index fc39a0c..0000000 --- a/generated/immich/openapi_client/docs/UserResponseDto.md +++ /dev/null @@ -1,34 +0,0 @@ -# UserResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | -**email** | **str** | User email | -**id** | **UUID** | User ID | -**name** | **str** | User name | -**profile_changed_at** | **datetime** | Profile change date | -**profile_image_path** | **str** | Profile image path | - -## Example - -```python -from generated.immich.openapi_client.models.user_response_dto import UserResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserResponseDto from a JSON string -user_response_dto_instance = UserResponseDto.from_json(json) -# print the JSON string representation of the object -print(UserResponseDto.to_json()) - -# convert the object into a dict -user_response_dto_dict = user_response_dto_instance.to_dict() -# create an instance of UserResponseDto from a dict -user_response_dto_from_dict = UserResponseDto.from_dict(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) - - diff --git a/generated/immich/openapi_client/docs/UserStatus.md b/generated/immich/openapi_client/docs/UserStatus.md deleted file mode 100644 index 3558c70..0000000 --- a/generated/immich/openapi_client/docs/UserStatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# UserStatus - -User status - -## Enum - -* `ACTIVE` (value: `'active'`) - -* `REMOVING` (value: `'removing'`) - -* `DELETED` (value: `'deleted'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/UserUpdateMeDto.md b/generated/immich/openapi_client/docs/UserUpdateMeDto.md deleted file mode 100644 index 13c7e43..0000000 --- a/generated/immich/openapi_client/docs/UserUpdateMeDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# UserUpdateMeDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avatar_color** | [**UserAvatarColor**](UserAvatarColor.md) | | [optional] -**email** | **str** | User email | [optional] -**name** | **str** | User name | [optional] -**password** | **str** | User password (deprecated, use change password endpoint) | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto - -# TODO update the JSON string below -json = "{}" -# create an instance of UserUpdateMeDto from a JSON string -user_update_me_dto_instance = UserUpdateMeDto.from_json(json) -# print the JSON string representation of the object -print(UserUpdateMeDto.to_json()) - -# convert the object into a dict -user_update_me_dto_dict = user_update_me_dto_instance.to_dict() -# create an instance of UserUpdateMeDto from a dict -user_update_me_dto_from_dict = UserUpdateMeDto.from_dict(user_update_me_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) - - diff --git a/generated/immich/openapi_client/docs/UsersAdminApi.md b/generated/immich/openapi_client/docs/UsersAdminApi.md deleted file mode 100644 index 2359262..0000000 --- a/generated/immich/openapi_client/docs/UsersAdminApi.md +++ /dev/null @@ -1,1057 +0,0 @@ -# generated.immich.openapi_client.UsersAdminApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_user_admin**](UsersAdminApi.md#create_user_admin) | **POST** /admin/users | Create a user -[**delete_user_admin**](UsersAdminApi.md#delete_user_admin) | **DELETE** /admin/users/{id} | Delete a user -[**get_user_admin**](UsersAdminApi.md#get_user_admin) | **GET** /admin/users/{id} | Retrieve a user -[**get_user_calendar_heatmap_admin**](UsersAdminApi.md#get_user_calendar_heatmap_admin) | **GET** /admin/users/{id}/calendar-heatmap | Retrieve calendar heatmap activity -[**get_user_preferences_admin**](UsersAdminApi.md#get_user_preferences_admin) | **GET** /admin/users/{id}/preferences | Retrieve user preferences -[**get_user_sessions_admin**](UsersAdminApi.md#get_user_sessions_admin) | **GET** /admin/users/{id}/sessions | Retrieve user sessions -[**get_user_statistics_admin**](UsersAdminApi.md#get_user_statistics_admin) | **GET** /admin/users/{id}/statistics | Retrieve user statistics -[**restore_user_admin**](UsersAdminApi.md#restore_user_admin) | **POST** /admin/users/{id}/restore | Restore a deleted user -[**search_users_admin**](UsersAdminApi.md#search_users_admin) | **GET** /admin/users | Search users -[**update_user_admin**](UsersAdminApi.md#update_user_admin) | **PUT** /admin/users/{id} | Update a user -[**update_user_preferences_admin**](UsersAdminApi.md#update_user_preferences_admin) | **PUT** /admin/users/{id}/preferences | Update user preferences - - -# **create_user_admin** -> UserAdminResponseDto create_user_admin(user_admin_create_dto) - -Create a user - -Create a new 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.user_admin_create_dto import UserAdminCreateDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -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.UsersAdminApi(api_client) - user_admin_create_dto = generated.immich.openapi_client.UserAdminCreateDto() # UserAdminCreateDto | - - try: - # Create a user - api_response = api_instance.create_user_admin(user_admin_create_dto) - print("The response of UsersAdminApi->create_user_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->create_user_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_admin_create_dto** | [**UserAdminCreateDto**](UserAdminCreateDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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_user_admin** -> UserAdminResponseDto delete_user_admin(id, user_admin_delete_dto) - -Delete a user - -Delete a 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.user_admin_delete_dto import UserAdminDeleteDto -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_admin_delete_dto = generated.immich.openapi_client.UserAdminDeleteDto() # UserAdminDeleteDto | - - try: - # Delete a user - api_response = api_instance.delete_user_admin(id, user_admin_delete_dto) - print("The response of UsersAdminApi->delete_user_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->delete_user_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_admin_delete_dto** | [**UserAdminDeleteDto**](UserAdminDeleteDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **get_user_admin** -> UserAdminResponseDto get_user_admin(id) - -Retrieve a user - -Retrieve a specific user by their ID. - -### 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.user_admin_response_dto import UserAdminResponseDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a user - api_response = api_instance.get_user_admin(id) - print("The response of UsersAdminApi->get_user_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->get_user_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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_user_calendar_heatmap_admin** -> CalendarHeatmapResponseDto get_user_calendar_heatmap_admin(id, var_from=var_from, to=to, type=type) - -Retrieve calendar heatmap activity - -Retrieve activity counts for a specified period, in a calendar heatmap format. - -### 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.calendar_heatmap_response_dto import CalendarHeatmapResponseDto -from generated.immich.openapi_client.models.calendar_heatmap_type import CalendarHeatmapType -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - var_from = 'Mon Jan 01 00:00:00 UTC 2024' # date | Start date in UTC (optional) - to = 'Mon Jan 01 00:00:00 UTC 2024' # date | End date in UTC (optional) - type = generated.immich.openapi_client.CalendarHeatmapType() # CalendarHeatmapType | (optional) - - try: - # Retrieve calendar heatmap activity - api_response = api_instance.get_user_calendar_heatmap_admin(id, var_from=var_from, to=to, type=type) - print("The response of UsersAdminApi->get_user_calendar_heatmap_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->get_user_calendar_heatmap_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **var_from** | **date**| Start date in UTC | [optional] - **to** | **date**| End date in UTC | [optional] - **type** | [**CalendarHeatmapType**](.md)| | [optional] - -### Return type - -[**CalendarHeatmapResponseDto**](CalendarHeatmapResponseDto.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_user_preferences_admin** -> UserPreferencesResponseDto get_user_preferences_admin(id) - -Retrieve user preferences - -Retrieve the preferences of a specific 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.user_preferences_response_dto import UserPreferencesResponseDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve user preferences - api_response = api_instance.get_user_preferences_admin(id) - print("The response of UsersAdminApi->get_user_preferences_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->get_user_preferences_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**UserPreferencesResponseDto**](UserPreferencesResponseDto.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_user_sessions_admin** -> List[SessionResponseDto] get_user_sessions_admin(id) - -Retrieve user sessions - -Retrieve all sessions for a specific 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.session_response_dto import SessionResponseDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve user sessions - api_response = api_instance.get_user_sessions_admin(id) - print("The response of UsersAdminApi->get_user_sessions_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->get_user_sessions_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**List[SessionResponseDto]**](SessionResponseDto.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_user_statistics_admin** -> AssetStatsResponseDto get_user_statistics_admin(id, is_favorite=is_favorite, is_trashed=is_trashed, visibility=visibility) - -Retrieve user statistics - -Retrieve asset statistics for a specific 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.asset_stats_response_dto import AssetStatsResponseDto -from generated.immich.openapi_client.models.asset_visibility import AssetVisibility -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - is_favorite = True # bool | Filter by favorite status (optional) - is_trashed = True # bool | Filter by trash status (optional) - visibility = generated.immich.openapi_client.AssetVisibility() # AssetVisibility | (optional) - - try: - # Retrieve user statistics - api_response = api_instance.get_user_statistics_admin(id, is_favorite=is_favorite, is_trashed=is_trashed, visibility=visibility) - print("The response of UsersAdminApi->get_user_statistics_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->get_user_statistics_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **is_favorite** | **bool**| Filter by favorite status | [optional] - **is_trashed** | **bool**| Filter by trash status | [optional] - **visibility** | [**AssetVisibility**](.md)| | [optional] - -### Return type - -[**AssetStatsResponseDto**](AssetStatsResponseDto.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) - -# **restore_user_admin** -> UserAdminResponseDto restore_user_admin(id) - -Restore a deleted user - -Restore a previously deleted 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.user_admin_response_dto import UserAdminResponseDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Restore a deleted user - api_response = api_instance.restore_user_admin(id) - print("The response of UsersAdminApi->restore_user_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->restore_user_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **search_users_admin** -> List[UserAdminResponseDto] search_users_admin(id=id, with_deleted=with_deleted) - -Search users - -Search for users. - -### 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.user_admin_response_dto import UserAdminResponseDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | User ID filter (optional) - with_deleted = True # bool | Include deleted users (optional) - - try: - # Search users - api_response = api_instance.search_users_admin(id=id, with_deleted=with_deleted) - print("The response of UsersAdminApi->search_users_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->search_users_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| User ID filter | [optional] - **with_deleted** | **bool**| Include deleted users | [optional] - -### Return type - -[**List[UserAdminResponseDto]**](UserAdminResponseDto.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_user_admin** -> UserAdminResponseDto update_user_admin(id, user_admin_update_dto) - -Update a user - -Update an existing 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.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_admin_update_dto = generated.immich.openapi_client.UserAdminUpdateDto() # UserAdminUpdateDto | - - try: - # Update a user - api_response = api_instance.update_user_admin(id, user_admin_update_dto) - print("The response of UsersAdminApi->update_user_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->update_user_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_admin_update_dto** | [**UserAdminUpdateDto**](UserAdminUpdateDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - -# **update_user_preferences_admin** -> UserPreferencesResponseDto update_user_preferences_admin(id, user_preferences_update_dto) - -Update user preferences - -Update the preferences of a specific 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.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto -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.UsersAdminApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - user_preferences_update_dto = generated.immich.openapi_client.UserPreferencesUpdateDto() # UserPreferencesUpdateDto | - - try: - # Update user preferences - api_response = api_instance.update_user_preferences_admin(id, user_preferences_update_dto) - print("The response of UsersAdminApi->update_user_preferences_admin:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersAdminApi->update_user_preferences_admin: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - **user_preferences_update_dto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | - -### Return type - -[**UserPreferencesResponseDto**](UserPreferencesResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/UsersApi.md b/generated/immich/openapi_client/docs/UsersApi.md deleted file mode 100644 index 17e20de..0000000 --- a/generated/immich/openapi_client/docs/UsersApi.md +++ /dev/null @@ -1,1463 +0,0 @@ -# generated.immich.openapi_client.UsersApi - -All URIs are relative to *https://github.com/api* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_profile_image**](UsersApi.md#create_profile_image) | **POST** /users/profile-image | Create user profile image -[**delete_profile_image**](UsersApi.md#delete_profile_image) | **DELETE** /users/profile-image | Delete user profile image -[**delete_user_license**](UsersApi.md#delete_user_license) | **DELETE** /users/me/license | Delete user product key -[**delete_user_onboarding**](UsersApi.md#delete_user_onboarding) | **DELETE** /users/me/onboarding | Delete user onboarding -[**get_my_calendar_heatmap**](UsersApi.md#get_my_calendar_heatmap) | **GET** /users/me/calendar-heatmap | Retrieve calendar heatmap activity -[**get_my_preferences**](UsersApi.md#get_my_preferences) | **GET** /users/me/preferences | Get my preferences -[**get_my_user**](UsersApi.md#get_my_user) | **GET** /users/me | Get current user -[**get_profile_image**](UsersApi.md#get_profile_image) | **GET** /users/{id}/profile-image | Retrieve user profile image -[**get_user**](UsersApi.md#get_user) | **GET** /users/{id} | Retrieve a user -[**get_user_license**](UsersApi.md#get_user_license) | **GET** /users/me/license | Retrieve user product key -[**get_user_onboarding**](UsersApi.md#get_user_onboarding) | **GET** /users/me/onboarding | Retrieve user onboarding -[**search_users**](UsersApi.md#search_users) | **GET** /users | Get all users -[**set_user_license**](UsersApi.md#set_user_license) | **PUT** /users/me/license | Set user product key -[**set_user_onboarding**](UsersApi.md#set_user_onboarding) | **PUT** /users/me/onboarding | Update user onboarding -[**update_my_preferences**](UsersApi.md#update_my_preferences) | **PUT** /users/me/preferences | Update my preferences -[**update_my_user**](UsersApi.md#update_my_user) | **PUT** /users/me | Update current user - - -# **create_profile_image** -> CreateProfileImageResponseDto create_profile_image(file) - -Create user profile image - -Upload and set a new profile image for 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.create_profile_image_response_dto import CreateProfileImageResponseDto -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.UsersApi(api_client) - file = None # bytearray | Profile image file - - try: - # Create user profile image - api_response = api_instance.create_profile_image(file) - print("The response of UsersApi->create_profile_image:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->create_profile_image: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **bytearray**| Profile image file | - -### Return type - -[**CreateProfileImageResponseDto**](CreateProfileImageResponseDto.md) - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **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_profile_image** -> delete_profile_image() - -Delete user profile image - -Delete the profile image 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.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.UsersApi(api_client) - - try: - # Delete user profile image - api_instance.delete_profile_image() - except Exception as e: - print("Exception when calling UsersApi->delete_profile_image: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### 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_user_license** -> delete_user_license() - -Delete user product key - -Delete the registered product key for 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.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.UsersApi(api_client) - - try: - # Delete user product key - api_instance.delete_user_license() - except Exception as e: - print("Exception when calling UsersApi->delete_user_license: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### 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_user_onboarding** -> delete_user_onboarding() - -Delete user onboarding - -Delete the onboarding status 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.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.UsersApi(api_client) - - try: - # Delete user onboarding - api_instance.delete_user_onboarding() - except Exception as e: - print("Exception when calling UsersApi->delete_user_onboarding: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### 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_my_calendar_heatmap** -> CalendarHeatmapResponseDto get_my_calendar_heatmap(var_from=var_from, to=to, type=type) - -Retrieve calendar heatmap activity - -Retrieve activity counts for a specified period, in a calendar heatmap format. - -### 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.calendar_heatmap_response_dto import CalendarHeatmapResponseDto -from generated.immich.openapi_client.models.calendar_heatmap_type import CalendarHeatmapType -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.UsersApi(api_client) - var_from = 'Mon Jan 01 00:00:00 UTC 2024' # date | Start date in UTC (optional) - to = 'Mon Jan 01 00:00:00 UTC 2024' # date | End date in UTC (optional) - type = generated.immich.openapi_client.CalendarHeatmapType() # CalendarHeatmapType | (optional) - - try: - # Retrieve calendar heatmap activity - api_response = api_instance.get_my_calendar_heatmap(var_from=var_from, to=to, type=type) - print("The response of UsersApi->get_my_calendar_heatmap:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_my_calendar_heatmap: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **var_from** | **date**| Start date in UTC | [optional] - **to** | **date**| End date in UTC | [optional] - **type** | [**CalendarHeatmapType**](.md)| | [optional] - -### Return type - -[**CalendarHeatmapResponseDto**](CalendarHeatmapResponseDto.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_preferences** -> UserPreferencesResponseDto get_my_preferences() - -Get my preferences - -Retrieve the preferences for 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.user_preferences_response_dto import UserPreferencesResponseDto -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.UsersApi(api_client) - - try: - # Get my preferences - api_response = api_instance.get_my_preferences() - print("The response of UsersApi->get_my_preferences:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_my_preferences: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**UserPreferencesResponseDto**](UserPreferencesResponseDto.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_user** -> UserAdminResponseDto get_my_user() - -Get current user - -Retrieve information about the user making the API request. - -### 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.user_admin_response_dto import UserAdminResponseDto -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.UsersApi(api_client) - - try: - # Get current user - api_response = api_instance.get_my_user() - print("The response of UsersApi->get_my_user:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_my_user: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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_profile_image** -> bytearray get_profile_image(id) - -Retrieve user profile image - -Retrieve the profile image file for a 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.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.UsersApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve user profile image - api_response = api_instance.get_profile_image(id) - print("The response of UsersApi->get_profile_image:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_profile_image: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -**bytearray** - -### Authorization - -[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **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_user** -> UserResponseDto get_user(id) - -Retrieve a user - -Retrieve a specific user by their ID. - -### 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.user_response_dto import UserResponseDto -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.UsersApi(api_client) - id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | - - try: - # Retrieve a user - api_response = api_instance.get_user(id) - print("The response of UsersApi->get_user:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_user: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **UUID**| | - -### Return type - -[**UserResponseDto**](UserResponseDto.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_user_license** -> UserLicense get_user_license() - -Retrieve user product key - -Retrieve information about whether the current user has a registered product 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.user_license import UserLicense -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.UsersApi(api_client) - - try: - # Retrieve user product key - api_response = api_instance.get_user_license() - print("The response of UsersApi->get_user_license:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_user_license: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**UserLicense**](UserLicense.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_user_onboarding** -> OnboardingResponseDto get_user_onboarding() - -Retrieve user onboarding - -Retrieve the onboarding status 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.onboarding_response_dto import OnboardingResponseDto -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.UsersApi(api_client) - - try: - # Retrieve user onboarding - api_response = api_instance.get_user_onboarding() - print("The response of UsersApi->get_user_onboarding:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->get_user_onboarding: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**OnboardingResponseDto**](OnboardingResponseDto.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) - -# **search_users** -> List[UserResponseDto] search_users() - -Get all users - -Retrieve a list of all users on the server. - -### 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.user_response_dto import UserResponseDto -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.UsersApi(api_client) - - try: - # Get all users - api_response = api_instance.search_users() - print("The response of UsersApi->search_users:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->search_users: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[UserResponseDto]**](UserResponseDto.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) - -# **set_user_license** -> UserLicense set_user_license(license_key_dto) - -Set user product key - -Register a product key for 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.license_key_dto import LicenseKeyDto -from generated.immich.openapi_client.models.user_license import UserLicense -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.UsersApi(api_client) - license_key_dto = generated.immich.openapi_client.LicenseKeyDto() # LicenseKeyDto | - - try: - # Set user product key - api_response = api_instance.set_user_license(license_key_dto) - print("The response of UsersApi->set_user_license:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->set_user_license: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **license_key_dto** | [**LicenseKeyDto**](LicenseKeyDto.md)| | - -### Return type - -[**UserLicense**](UserLicense.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) - -# **set_user_onboarding** -> OnboardingResponseDto set_user_onboarding(onboarding_dto) - -Update user onboarding - -Update the onboarding status 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.onboarding_dto import OnboardingDto -from generated.immich.openapi_client.models.onboarding_response_dto import OnboardingResponseDto -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.UsersApi(api_client) - onboarding_dto = generated.immich.openapi_client.OnboardingDto() # OnboardingDto | - - try: - # Update user onboarding - api_response = api_instance.set_user_onboarding(onboarding_dto) - print("The response of UsersApi->set_user_onboarding:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->set_user_onboarding: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **onboarding_dto** | [**OnboardingDto**](OnboardingDto.md)| | - -### Return type - -[**OnboardingResponseDto**](OnboardingResponseDto.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) - -# **update_my_preferences** -> UserPreferencesResponseDto update_my_preferences(user_preferences_update_dto) - -Update my preferences - -Update the preferences 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.user_preferences_response_dto import UserPreferencesResponseDto -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto -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.UsersApi(api_client) - user_preferences_update_dto = generated.immich.openapi_client.UserPreferencesUpdateDto() # UserPreferencesUpdateDto | - - try: - # Update my preferences - api_response = api_instance.update_my_preferences(user_preferences_update_dto) - print("The response of UsersApi->update_my_preferences:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->update_my_preferences: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_preferences_update_dto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | - -### Return type - -[**UserPreferencesResponseDto**](UserPreferencesResponseDto.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) - -# **update_my_user** -> UserAdminResponseDto update_my_user(user_update_me_dto) - -Update current user - -Update the current user making the API request. - -### 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.user_admin_response_dto import UserAdminResponseDto -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto -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.UsersApi(api_client) - user_update_me_dto = generated.immich.openapi_client.UserUpdateMeDto() # UserUpdateMeDto | - - try: - # Update current user - api_response = api_instance.update_my_user(user_update_me_dto) - print("The response of UsersApi->update_my_user:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UsersApi->update_my_user: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_update_me_dto** | [**UserUpdateMeDto**](UserUpdateMeDto.md)| | - -### Return type - -[**UserAdminResponseDto**](UserAdminResponseDto.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) - diff --git a/generated/immich/openapi_client/docs/ValidateAccessTokenResponseDto.md b/generated/immich/openapi_client/docs/ValidateAccessTokenResponseDto.md deleted file mode 100644 index df95fff..0000000 --- a/generated/immich/openapi_client/docs/ValidateAccessTokenResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# ValidateAccessTokenResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**auth_status** | **bool** | Authentication status | - -## Example - -```python -from generated.immich.openapi_client.models.validate_access_token_response_dto import ValidateAccessTokenResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ValidateAccessTokenResponseDto from a JSON string -validate_access_token_response_dto_instance = ValidateAccessTokenResponseDto.from_json(json) -# print the JSON string representation of the object -print(ValidateAccessTokenResponseDto.to_json()) - -# convert the object into a dict -validate_access_token_response_dto_dict = validate_access_token_response_dto_instance.to_dict() -# create an instance of ValidateAccessTokenResponseDto from a dict -validate_access_token_response_dto_from_dict = ValidateAccessTokenResponseDto.from_dict(validate_access_token_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) - - diff --git a/generated/immich/openapi_client/docs/ValidateLibraryDto.md b/generated/immich/openapi_client/docs/ValidateLibraryDto.md deleted file mode 100644 index 5c6438a..0000000 --- a/generated/immich/openapi_client/docs/ValidateLibraryDto.md +++ /dev/null @@ -1,30 +0,0 @@ -# ValidateLibraryDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**exclusion_patterns** | **List[str]** | Exclusion patterns (max 128) | [optional] -**import_paths** | **List[str]** | Import paths to validate (max 128) | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.validate_library_dto import ValidateLibraryDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ValidateLibraryDto from a JSON string -validate_library_dto_instance = ValidateLibraryDto.from_json(json) -# print the JSON string representation of the object -print(ValidateLibraryDto.to_json()) - -# convert the object into a dict -validate_library_dto_dict = validate_library_dto_instance.to_dict() -# create an instance of ValidateLibraryDto from a dict -validate_library_dto_from_dict = ValidateLibraryDto.from_dict(validate_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) - - diff --git a/generated/immich/openapi_client/docs/ValidateLibraryImportPathResponseDto.md b/generated/immich/openapi_client/docs/ValidateLibraryImportPathResponseDto.md deleted file mode 100644 index 75b332b..0000000 --- a/generated/immich/openapi_client/docs/ValidateLibraryImportPathResponseDto.md +++ /dev/null @@ -1,31 +0,0 @@ -# ValidateLibraryImportPathResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**import_path** | **str** | Import path | -**is_valid** | **bool** | Is valid | -**message** | **str** | Validation message | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.validate_library_import_path_response_dto import ValidateLibraryImportPathResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ValidateLibraryImportPathResponseDto from a JSON string -validate_library_import_path_response_dto_instance = ValidateLibraryImportPathResponseDto.from_json(json) -# print the JSON string representation of the object -print(ValidateLibraryImportPathResponseDto.to_json()) - -# convert the object into a dict -validate_library_import_path_response_dto_dict = validate_library_import_path_response_dto_instance.to_dict() -# create an instance of ValidateLibraryImportPathResponseDto from a dict -validate_library_import_path_response_dto_from_dict = ValidateLibraryImportPathResponseDto.from_dict(validate_library_import_path_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) - - diff --git a/generated/immich/openapi_client/docs/ValidateLibraryResponseDto.md b/generated/immich/openapi_client/docs/ValidateLibraryResponseDto.md deleted file mode 100644 index e029783..0000000 --- a/generated/immich/openapi_client/docs/ValidateLibraryResponseDto.md +++ /dev/null @@ -1,29 +0,0 @@ -# ValidateLibraryResponseDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**import_paths** | [**List[ValidateLibraryImportPathResponseDto]**](ValidateLibraryImportPathResponseDto.md) | Validation results for import paths | [optional] - -## Example - -```python -from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto - -# TODO update the JSON string below -json = "{}" -# create an instance of ValidateLibraryResponseDto from a JSON string -validate_library_response_dto_instance = ValidateLibraryResponseDto.from_json(json) -# print the JSON string representation of the object -print(ValidateLibraryResponseDto.to_json()) - -# convert the object into a dict -validate_library_response_dto_dict = validate_library_response_dto_instance.to_dict() -# create an instance of ValidateLibraryResponseDto from a dict -validate_library_response_dto_from_dict = ValidateLibraryResponseDto.from_dict(validate_library_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) - - diff --git a/generated/immich/openapi_client/docs/VideoCodec.md b/generated/immich/openapi_client/docs/VideoCodec.md deleted file mode 100644 index 1003951..0000000 --- a/generated/immich/openapi_client/docs/VideoCodec.md +++ /dev/null @@ -1,17 +0,0 @@ -# VideoCodec - -Target video codec - -## Enum - -* `H264` (value: `'h264'`) - -* `HEVC` (value: `'hevc'`) - -* `VP9` (value: `'vp9'`) - -* `AV1` (value: `'av1'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/docs/VideoContainer.md b/generated/immich/openapi_client/docs/VideoContainer.md deleted file mode 100644 index 74371fc..0000000 --- a/generated/immich/openapi_client/docs/VideoContainer.md +++ /dev/null @@ -1,17 +0,0 @@ -# VideoContainer - -Accepted video containers - -## Enum - -* `MOV` (value: `'mov'`) - -* `MP4` (value: `'mp4'`) - -* `OGG` (value: `'ogg'`) - -* `WEBM` (value: `'webm'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/generated/immich/openapi_client/exceptions.py b/generated/immich/openapi_client/exceptions.py index ea6c122..88c1a61 100644 --- a/generated/immich/openapi_client/exceptions.py +++ b/generated/immich/openapi_client/exceptions.py @@ -128,7 +128,7 @@ class ApiException(OpenApiException): self.body = http_resp.data.decode('utf-8') except Exception: pass - self.headers = http_resp.headers + self.headers = http_resp.getheaders() @classmethod def from_response( @@ -150,13 +150,6 @@ class ApiException(OpenApiException): if http_resp.status == 404: raise NotFoundException(http_resp=http_resp, body=body, data=data) - # Added new conditions for 409 and 422 - if http_resp.status == 409: - raise ConflictException(http_resp=http_resp, body=body, data=data) - - if http_resp.status == 422: - raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data) - if 500 <= http_resp.status <= 599: raise ServiceException(http_resp=http_resp, body=body, data=data) raise ApiException(http_resp=http_resp, body=body, data=data) @@ -169,11 +162,8 @@ class ApiException(OpenApiException): error_message += "HTTP response headers: {0}\n".format( self.headers) - if self.body: - error_message += "HTTP response body: {0}\n".format(self.body) - - if self.data: - error_message += "HTTP response data: {0}\n".format(self.data) + if self.data or self.body: + error_message += "HTTP response body: {0}\n".format(self.data or self.body) return error_message @@ -198,16 +188,6 @@ class ServiceException(ApiException): pass -class ConflictException(ApiException): - """Exception for HTTP 409 Conflict.""" - pass - - -class UnprocessableEntityException(ApiException): - """Exception for HTTP 422 Unprocessable Entity.""" - pass - - def render_path(path_to_item): """Returns a string representation of a path""" result = "" diff --git a/generated/immich/openapi_client/models/__init__.py b/generated/immich/openapi_client/models/__init__.py index a44a0b5..ffc701b 100644 --- a/generated/immich/openapi_client/models/__init__.py +++ b/generated/immich/openapi_client/models/__init__.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + # import models into model package from generated.immich.openapi_client.models.activity_create_dto import ActivityCreateDto from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto @@ -383,4 +384,3 @@ from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrig from generated.immich.openapi_client.models.workflow_trigger_response_dto import WorkflowTriggerResponseDto from generated.immich.openapi_client.models.workflow_type import WorkflowType from generated.immich.openapi_client.models.workflow_update_dto import WorkflowUpdateDto - diff --git a/generated/immich/openapi_client/models/activity_create_dto.py b/generated/immich/openapi_client/models/activity_create_dto.py index b989836..a5ff3c6 100644 --- a/generated/immich/openapi_client/models/activity_create_dto.py +++ b/generated/immich/openapi_client/models/activity_create_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.reaction_type import ReactionType from typing import Optional, Set from typing_extensions import Self @@ -28,8 +28,8 @@ class ActivityCreateDto(BaseModel): """ Activity create """ # noqa: E501 - album_id: UUID = Field(description="Album ID", alias="albumId") - asset_id: Optional[UUID] = Field(default=None, description="Asset ID (if activity is for an asset)", alias="assetId") + album_id: Annotated[str, Field(strict=True)] = Field(description="Album ID", alias="albumId") + asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Asset ID (if activity is for an asset)", alias="assetId") comment: Optional[StrictStr] = Field(default=None, description="Comment text (required if type is comment)") type: ReactionType __properties: ClassVar[List[str]] = ["albumId", "assetId", "comment", "type"] diff --git a/generated/immich/openapi_client/models/activity_response_dto.py b/generated/immich/openapi_client/models/activity_response_dto.py index 55a9072..c8ddf74 100644 --- a/generated/immich/openapi_client/models/activity_response_dto.py +++ b/generated/immich/openapi_client/models/activity_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.reaction_type import ReactionType from generated.immich.openapi_client.models.user_response_dto import UserResponseDto from typing import Optional, Set @@ -30,10 +30,10 @@ class ActivityResponseDto(BaseModel): """ ActivityResponseDto """ # noqa: E501 - asset_id: Optional[UUID] = Field(description="Asset ID (if activity is for an asset)", alias="assetId") + asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(description="Asset ID (if activity is for an asset)", alias="assetId") comment: Optional[StrictStr] = Field(default=None, description="Comment text (for comment activities)") created_at: datetime = Field(description="Creation date", alias="createdAt") - id: UUID = Field(description="Activity ID") + id: Annotated[str, Field(strict=True)] = Field(description="Activity ID") type: ReactionType user: UserResponseDto __properties: ClassVar[List[str]] = ["assetId", "comment", "createdAt", "id", "type", "user"] diff --git a/generated/immich/openapi_client/models/album_response_dto.py b/generated/immich/openapi_client/models/album_response_dto.py index 236a82a..df3449e 100644 --- a/generated/immich/openapi_client/models/album_response_dto.py +++ b/generated/immich/openapi_client/models/album_response_dto.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.album_user_response_dto import AlbumUserResponseDto from generated.immich.openapi_client.models.asset_order import AssetOrder from generated.immich.openapi_client.models.contributor_count_response_dto import ContributorCountResponseDto @@ -33,7 +32,7 @@ class AlbumResponseDto(BaseModel): AlbumResponseDto """ # noqa: E501 album_name: StrictStr = Field(description="Album name", alias="albumName") - album_thumbnail_asset_id: Optional[UUID] = Field(description="Thumbnail asset ID", alias="albumThumbnailAssetId") + album_thumbnail_asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(description="Thumbnail asset ID", alias="albumThumbnailAssetId") album_users: Annotated[List[AlbumUserResponseDto], Field(min_length=1)] = Field(description="First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically.", alias="albumUsers") asset_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Number of assets", alias="assetCount") contributor_counts: Optional[List[ContributorCountResponseDto]] = Field(default=None, alias="contributorCounts") @@ -41,7 +40,7 @@ class AlbumResponseDto(BaseModel): description: StrictStr = Field(description="Album description") end_date: Optional[datetime] = Field(default=None, description="End date (latest asset)", alias="endDate") has_shared_link: StrictBool = Field(description="Has shared link", alias="hasSharedLink") - id: UUID = Field(description="Album ID") + id: Annotated[str, Field(strict=True)] = Field(description="Album ID") is_activity_enabled: StrictBool = Field(description="Activity feed enabled", alias="isActivityEnabled") last_modified_asset_timestamp: Optional[datetime] = Field(default=None, description="Last modified asset timestamp", alias="lastModifiedAssetTimestamp") order: Optional[AssetOrder] = None diff --git a/generated/immich/openapi_client/models/album_user_add_dto.py b/generated/immich/openapi_client/models/album_user_add_dto.py index 544a827..7585f72 100644 --- a/generated/immich/openapi_client/models/album_user_add_dto.py +++ b/generated/immich/openapi_client/models/album_user_add_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.album_user_role import AlbumUserRole from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,7 @@ class AlbumUserAddDto(BaseModel): AlbumUserAddDto """ # noqa: E501 role: Optional[AlbumUserRole] = None - user_id: UUID = Field(description="User ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") __properties: ClassVar[List[str]] = ["role", "userId"] @field_validator('user_id') diff --git a/generated/immich/openapi_client/models/album_user_create_dto.py b/generated/immich/openapi_client/models/album_user_create_dto.py index a73794b..abc6e5e 100644 --- a/generated/immich/openapi_client/models/album_user_create_dto.py +++ b/generated/immich/openapi_client/models/album_user_create_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.album_user_role import AlbumUserRole from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,7 @@ class AlbumUserCreateDto(BaseModel): AlbumUserCreateDto """ # noqa: E501 role: AlbumUserRole - user_id: UUID = Field(description="User ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") __properties: ClassVar[List[str]] = ["role", "userId"] @field_validator('user_id') diff --git a/generated/immich/openapi_client/models/albums_add_assets_dto.py b/generated/immich/openapi_client/models/albums_add_assets_dto.py new file mode 100644 index 0000000..b1de0ad --- /dev/null +++ b/generated/immich/openapi_client/models/albums_add_assets_dto.py @@ -0,0 +1,91 @@ + +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from uuid import UUID +from typing import Optional, Set +from typing_extensions import Self + +class AlbumsAddAssetsDto(BaseModel): + """ + AlbumsAddAssetsDto + """ # noqa: E501 + album_ids: List[UUID] = Field(description="Album IDs", alias="albumIds") + asset_ids: List[UUID] = Field(description="Asset IDs", alias="assetIds") + __properties: ClassVar[List[str]] = ["albumIds", "assetIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlbumsAddAssetsDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlbumsAddAssetsDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumIds": obj.get("albumIds"), + "assetIds": obj.get("assetIds") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/albums_add_assets_response_dto.py b/generated/immich/openapi_client/models/albums_add_assets_response_dto.py new file mode 100644 index 0000000..84e3cc7 --- /dev/null +++ b/generated/immich/openapi_client/models/albums_add_assets_response_dto.py @@ -0,0 +1,90 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.bulk_id_error_reason import BulkIdErrorReason +from typing import Optional, Set +from typing_extensions import Self + +class AlbumsAddAssetsResponseDto(BaseModel): + """ + AlbumsAddAssetsResponseDto + """ # noqa: E501 + error: Optional[BulkIdErrorReason] = None + success: StrictBool = Field(description="Operation success") + __properties: ClassVar[List[str]] = ["error", "success"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlbumsAddAssetsResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlbumsAddAssetsResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "error": obj.get("error"), + "success": obj.get("success") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/albums_response.py b/generated/immich/openapi_client/models/albums_response.py new file mode 100644 index 0000000..dfeca68 --- /dev/null +++ b/generated/immich/openapi_client/models/albums_response.py @@ -0,0 +1,88 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.asset_order import AssetOrder +from typing import Optional, Set +from typing_extensions import Self + +class AlbumsResponse(BaseModel): + """ + AlbumsResponse + """ # noqa: E501 + default_asset_order: AssetOrder = Field(alias="defaultAssetOrder") + __properties: ClassVar[List[str]] = ["defaultAssetOrder"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlbumsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlbumsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "defaultAssetOrder": obj.get("defaultAssetOrder") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/albums_update.py b/generated/immich/openapi_client/models/albums_update.py new file mode 100644 index 0000000..7a126de --- /dev/null +++ b/generated/immich/openapi_client/models/albums_update.py @@ -0,0 +1,88 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.asset_order import AssetOrder +from typing import Optional, Set +from typing_extensions import Self + +class AlbumsUpdate(BaseModel): + """ + Album preferences + """ # noqa: E501 + default_asset_order: Optional[AssetOrder] = Field(default=None, alias="defaultAssetOrder") + __properties: ClassVar[List[str]] = ["defaultAssetOrder"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AlbumsUpdate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AlbumsUpdate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "defaultAssetOrder": obj.get("defaultAssetOrder") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/api_key_response_dto.py b/generated/immich/openapi_client/models/api_key_response_dto.py index 33c30db..37db3aa 100644 --- a/generated/immich/openapi_client/models/api_key_response_dto.py +++ b/generated/immich/openapi_client/models/api_key_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.permission import Permission from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,7 @@ class ApiKeyResponseDto(BaseModel): ApiKeyResponseDto """ # noqa: E501 created_at: datetime = Field(description="Creation date", alias="createdAt") - id: UUID = Field(description="API key ID") + id: Annotated[str, Field(strict=True)] = Field(description="API key ID") name: StrictStr = Field(description="API key name") permissions: List[Permission] = Field(description="List of permissions") updated_at: datetime = Field(description="Last update date", alias="updatedAt") diff --git a/generated/immich/openapi_client/models/asset_bulk_delete_dto.py b/generated/immich/openapi_client/models/asset_bulk_delete_dto.py index b825aa1..cd9742e 100644 --- a/generated/immich/openapi_client/models/asset_bulk_delete_dto.py +++ b/generated/immich/openapi_client/models/asset_bulk_delete_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -28,7 +28,7 @@ class AssetBulkDeleteDto(BaseModel): AssetBulkDeleteDto """ # noqa: E501 force: Optional[StrictBool] = Field(default=None, description="Force delete even if in use") - ids: List[UUID] = Field(description="IDs to process") + ids: List[Annotated[str, Field(strict=True)]] = Field(description="IDs to process") __properties: ClassVar[List[str]] = ["force", "ids"] model_config = ConfigDict( diff --git a/generated/immich/openapi_client/models/asset_bulk_update_dto.py b/generated/immich/openapi_client/models/asset_bulk_update_dto.py index 890c2bc..8ea5228 100644 --- a/generated/immich/openapi_client/models/asset_bulk_update_dto.py +++ b/generated/immich/openapi_client/models/asset_bulk_update_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_visibility import AssetVisibility from typing import Optional, Set from typing_extensions import Self @@ -33,7 +32,7 @@ class AssetBulkUpdateDto(BaseModel): date_time_relative: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]] = Field(default=None, description="Relative time offset in minutes", alias="dateTimeRelative") description: Optional[StrictStr] = Field(default=None, description="Asset description") duplicate_id: Optional[StrictStr] = Field(default=None, description="Duplicate ID", alias="duplicateId") - ids: List[UUID] = Field(description="Asset IDs to update") + ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs to update") is_favorite: Optional[StrictBool] = Field(default=None, description="Mark as favorite", alias="isFavorite") latitude: Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]] = Field(default=None, description="Latitude coordinate") longitude: Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]] = Field(default=None, description="Longitude coordinate") diff --git a/generated/immich/openapi_client/models/asset_bulk_upload_check_result.py b/generated/immich/openapi_client/models/asset_bulk_upload_check_result.py index 656eb79..61aa26c 100644 --- a/generated/immich/openapi_client/models/asset_bulk_upload_check_result.py +++ b/generated/immich/openapi_client/models/asset_bulk_upload_check_result.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_reject_reason import AssetRejectReason from generated.immich.openapi_client.models.asset_upload_action import AssetUploadAction from typing import Optional, Set @@ -30,7 +30,7 @@ class AssetBulkUploadCheckResult(BaseModel): AssetBulkUploadCheckResult """ # noqa: E501 action: AssetUploadAction - asset_id: Optional[UUID] = Field(default=None, description="Existing asset ID if duplicate", alias="assetId") + asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Existing asset ID if duplicate", alias="assetId") id: StrictStr = Field(description="Client-side identifier echoed from the request to match results to inputs") is_trashed: Optional[StrictBool] = Field(default=None, description="Whether existing asset is trashed", alias="isTrashed") reason: Optional[AssetRejectReason] = None diff --git a/generated/immich/openapi_client/models/asset_copy_dto.py b/generated/immich/openapi_client/models/asset_copy_dto.py new file mode 100644 index 0000000..73da053 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_copy_dto.py @@ -0,0 +1,114 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AssetCopyDto(BaseModel): + """ + AssetCopyDto + """ # noqa: E501 + albums: Optional[StrictBool] = Field(default=True, description="Copy album associations") + favorite: Optional[StrictBool] = Field(default=True, description="Copy favorite status") + shared_links: Optional[StrictBool] = Field(default=True, description="Copy shared links", alias="sharedLinks") + sidecar: Optional[StrictBool] = Field(default=True, description="Copy sidecar file") + source_id: Annotated[str, Field(strict=True)] = Field(description="Source asset ID", alias="sourceId") + stack: Optional[StrictBool] = Field(default=True, description="Copy stack association") + target_id: Annotated[str, Field(strict=True)] = Field(description="Target asset ID", alias="targetId") + __properties: ClassVar[List[str]] = ["albums", "favorite", "sharedLinks", "sidecar", "sourceId", "stack", "targetId"] + + @field_validator('source_id') + def source_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('target_id') + def target_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetCopyDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetCopyDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albums": obj.get("albums") if obj.get("albums") is not None else True, + "favorite": obj.get("favorite") if obj.get("favorite") is not None else True, + "sharedLinks": obj.get("sharedLinks") if obj.get("sharedLinks") is not None else True, + "sidecar": obj.get("sidecar") if obj.get("sidecar") is not None else True, + "sourceId": obj.get("sourceId"), + "stack": obj.get("stack") if obj.get("stack") is not None else True, + "targetId": obj.get("targetId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_edit_action.py b/generated/immich/openapi_client/models/asset_edit_action.py new file mode 100644 index 0000000..c217f2c --- /dev/null +++ b/generated/immich/openapi_client/models/asset_edit_action.py @@ -0,0 +1,38 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AssetEditAction(str, Enum): + """ + Type of edit action to perform + """ + + """ + allowed enum values + """ + CROP = 'crop' + ROTATE = 'rotate' + MIRROR = 'mirror' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AssetEditAction from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/asset_edit_action_item_dto.py b/generated/immich/openapi_client/models/asset_edit_action_item_dto.py new file mode 100644 index 0000000..cb6fe96 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_edit_action_item_dto.py @@ -0,0 +1,94 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.asset_edit_action import AssetEditAction +from generated.immich.openapi_client.models.asset_edit_action_item_dto_parameters import AssetEditActionItemDtoParameters +from typing import Optional, Set +from typing_extensions import Self + +class AssetEditActionItemDto(BaseModel): + """ + AssetEditActionItemDto + """ # noqa: E501 + action: AssetEditAction + parameters: AssetEditActionItemDtoParameters + __properties: ClassVar[List[str]] = ["action", "parameters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetEditActionItemDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of parameters + if self.parameters: + _dict['parameters'] = self.parameters.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetEditActionItemDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "action": obj.get("action"), + "parameters": AssetEditActionItemDtoParameters.from_dict(obj["parameters"]) if obj.get("parameters") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_edit_action_item_dto_parameters.py b/generated/immich/openapi_client/models/asset_edit_action_item_dto_parameters.py new file mode 100644 index 0000000..9b6c686 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_edit_action_item_dto_parameters.py @@ -0,0 +1,149 @@ +# 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 + + +from __future__ import annotations +from inspect import getfullargspec +import json +import pprint +import re # noqa: F401 +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Optional +from generated.immich.openapi_client.models.crop_parameters import CropParameters +from generated.immich.openapi_client.models.mirror_parameters import MirrorParameters +from generated.immich.openapi_client.models.rotate_parameters import RotateParameters +from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict +from typing_extensions import Literal, Self +from pydantic import Field + +ASSETEDITACTIONITEMDTOPARAMETERS_ANY_OF_SCHEMAS = ["CropParameters", "MirrorParameters", "RotateParameters"] + +class AssetEditActionItemDtoParameters(BaseModel): + """ + List of edit actions to apply (crop, rotate, or mirror) + """ + + # data type: CropParameters + anyof_schema_1_validator: Optional[CropParameters] = None + # data type: RotateParameters + anyof_schema_2_validator: Optional[RotateParameters] = None + # data type: MirrorParameters + anyof_schema_3_validator: Optional[MirrorParameters] = None + if TYPE_CHECKING: + actual_instance: Optional[Union[CropParameters, MirrorParameters, RotateParameters]] = None + else: + actual_instance: Any = None + any_of_schemas: Set[str] = { "CropParameters", "MirrorParameters", "RotateParameters" } + + model_config = { + "validate_assignment": True, + "protected_namespaces": (), + } + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_anyof(cls, v): + instance = AssetEditActionItemDtoParameters.model_construct() + error_messages = [] + # validate data type: CropParameters + if not isinstance(v, CropParameters): + error_messages.append(f"Error! Input type `{type(v)}` is not `CropParameters`") + else: + return v + + # validate data type: RotateParameters + if not isinstance(v, RotateParameters): + error_messages.append(f"Error! Input type `{type(v)}` is not `RotateParameters`") + else: + return v + + # validate data type: MirrorParameters + if not isinstance(v, MirrorParameters): + error_messages.append(f"Error! Input type `{type(v)}` is not `MirrorParameters`") + else: + return v + + if error_messages: + # no match + raise ValueError("No match found when setting the actual_instance in AssetEditActionItemDtoParameters with anyOf schemas: CropParameters, MirrorParameters, RotateParameters. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Dict[str, Any]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + # anyof_schema_1_validator: Optional[CropParameters] = None + try: + instance.actual_instance = CropParameters.from_json(json_str) + return instance + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # anyof_schema_2_validator: Optional[RotateParameters] = None + try: + instance.actual_instance = RotateParameters.from_json(json_str) + return instance + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # anyof_schema_3_validator: Optional[MirrorParameters] = None + try: + instance.actual_instance = MirrorParameters.from_json(json_str) + return instance + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if error_messages: + # no match + raise ValueError("No match found when deserializing the JSON string into AssetEditActionItemDtoParameters with anyOf schemas: CropParameters, MirrorParameters, RotateParameters. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], CropParameters, MirrorParameters, RotateParameters]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/generated/immich/openapi_client/models/asset_edit_action_item_response_dto.py b/generated/immich/openapi_client/models/asset_edit_action_item_response_dto.py new file mode 100644 index 0000000..3423d2c --- /dev/null +++ b/generated/immich/openapi_client/models/asset_edit_action_item_response_dto.py @@ -0,0 +1,104 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_edit_action import AssetEditAction +from generated.immich.openapi_client.models.asset_edit_action_item_dto_parameters import AssetEditActionItemDtoParameters +from typing import Optional, Set +from typing_extensions import Self + +class AssetEditActionItemResponseDto(BaseModel): + """ + AssetEditActionItemResponseDto + """ # noqa: E501 + action: AssetEditAction + id: Annotated[str, Field(strict=True)] = Field(description="Asset edit ID") + parameters: AssetEditActionItemDtoParameters + __properties: ClassVar[List[str]] = ["action", "id", "parameters"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetEditActionItemResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of parameters + if self.parameters: + _dict['parameters'] = self.parameters.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetEditActionItemResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "action": obj.get("action"), + "id": obj.get("id"), + "parameters": AssetEditActionItemDtoParameters.from_dict(obj["parameters"]) if obj.get("parameters") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_edits_create_dto.py b/generated/immich/openapi_client/models/asset_edits_create_dto.py new file mode 100644 index 0000000..d01277a --- /dev/null +++ b/generated/immich/openapi_client/models/asset_edits_create_dto.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_edit_action_item_dto import AssetEditActionItemDto +from typing import Optional, Set +from typing_extensions import Self + +class AssetEditsCreateDto(BaseModel): + """ + AssetEditsCreateDto + """ # noqa: E501 + edits: Annotated[List[AssetEditActionItemDto], Field(min_length=1)] = Field(description="List of edit actions to apply (crop, rotate, or mirror)") + __properties: ClassVar[List[str]] = ["edits"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetEditsCreateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in edits (list) + _items = [] + if self.edits: + for _item_edits in self.edits: + if _item_edits: + _items.append(_item_edits.to_dict()) + _dict['edits'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetEditsCreateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "edits": [AssetEditActionItemDto.from_dict(_item) for _item in obj["edits"]] if obj.get("edits") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_edits_response_dto.py b/generated/immich/openapi_client/models/asset_edits_response_dto.py new file mode 100644 index 0000000..f4f61f2 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_edits_response_dto.py @@ -0,0 +1,105 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_edit_action_item_response_dto import AssetEditActionItemResponseDto +from typing import Optional, Set +from typing_extensions import Self + +class AssetEditsResponseDto(BaseModel): + """ + AssetEditsResponseDto + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID these edits belong to", alias="assetId") + edits: List[AssetEditActionItemResponseDto] = Field(description="List of edit actions applied to the asset") + __properties: ClassVar[List[str]] = ["assetId", "edits"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetEditsResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in edits (list) + _items = [] + if self.edits: + for _item_edits in self.edits: + if _item_edits: + _items.append(_item_edits.to_dict()) + _dict['edits'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetEditsResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "edits": [AssetEditActionItemResponseDto.from_dict(_item) for _item in obj["edits"]] if obj.get("edits") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_face_create_dto.py b/generated/immich/openapi_client/models/asset_face_create_dto.py index 57d9a06..97d0db3 100644 --- a/generated/immich/openapi_client/models/asset_face_create_dto.py +++ b/generated/immich/openapi_client/models/asset_face_create_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -28,11 +27,11 @@ class AssetFaceCreateDto(BaseModel): """ AssetFaceCreateDto """ # noqa: E501 - asset_id: UUID = Field(description="Asset ID", alias="assetId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") height: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Face bounding box height") image_height: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Image height in pixels", alias="imageHeight") image_width: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Image width in pixels", alias="imageWidth") - person_id: UUID = Field(description="Person ID", alias="personId") + person_id: Annotated[str, Field(strict=True)] = Field(description="Person ID", alias="personId") width: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Face bounding box width") x: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Face bounding box X coordinate") y: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Face bounding box Y coordinate") diff --git a/generated/immich/openapi_client/models/asset_face_response_dto.py b/generated/immich/openapi_client/models/asset_face_response_dto.py index 51170c0..14f2d5f 100644 --- a/generated/immich/openapi_client/models/asset_face_response_dto.py +++ b/generated/immich/openapi_client/models/asset_face_response_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto from generated.immich.openapi_client.models.source_type import SourceType from typing import Optional, Set @@ -34,7 +33,7 @@ class AssetFaceResponseDto(BaseModel): bounding_box_x2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box X2 coordinate", alias="boundingBoxX2") bounding_box_y1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box Y1 coordinate", alias="boundingBoxY1") bounding_box_y2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box Y2 coordinate", alias="boundingBoxY2") - id: UUID = Field(description="Face ID") + id: Annotated[str, Field(strict=True)] = Field(description="Face ID") image_height: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Image height in pixels", alias="imageHeight") image_width: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Image width in pixels", alias="imageWidth") person: Optional[PersonResponseDto] diff --git a/generated/immich/openapi_client/models/asset_face_update_item.py b/generated/immich/openapi_client/models/asset_face_update_item.py index 99e19d6..3693072 100644 --- a/generated/immich/openapi_client/models/asset_face_update_item.py +++ b/generated/immich/openapi_client/models/asset_face_update_item.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,8 +27,8 @@ class AssetFaceUpdateItem(BaseModel): """ AssetFaceUpdateItem """ # noqa: E501 - asset_id: UUID = Field(description="Asset ID", alias="assetId") - person_id: UUID = Field(description="Person ID", alias="personId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + person_id: Annotated[str, Field(strict=True)] = Field(description="Person ID", alias="personId") __properties: ClassVar[List[str]] = ["assetId", "personId"] @field_validator('asset_id') diff --git a/generated/immich/openapi_client/models/asset_id_error_reason.py b/generated/immich/openapi_client/models/asset_id_error_reason.py new file mode 100644 index 0000000..cc4165c --- /dev/null +++ b/generated/immich/openapi_client/models/asset_id_error_reason.py @@ -0,0 +1,38 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AssetIdErrorReason(str, Enum): + """ + Error reason if failed + """ + + """ + allowed enum values + """ + DUPLICATE = 'duplicate' + NO_PERMISSION = 'no_permission' + NOT_FOUND = 'not_found' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AssetIdErrorReason from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/asset_ids_dto.py b/generated/immich/openapi_client/models/asset_ids_dto.py index 36af9cd..4ad0263 100644 --- a/generated/immich/openapi_client/models/asset_ids_dto.py +++ b/generated/immich/openapi_client/models/asset_ids_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class AssetIdsDto(BaseModel): """ AssetIdsDto """ # noqa: E501 - asset_ids: List[UUID] = Field(description="Asset IDs", alias="assetIds") + asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs", alias="assetIds") __properties: ClassVar[List[str]] = ["assetIds"] model_config = ConfigDict( diff --git a/generated/immich/openapi_client/models/asset_ids_response_dto.py b/generated/immich/openapi_client/models/asset_ids_response_dto.py index aa8f465..3f197a3 100644 --- a/generated/immich/openapi_client/models/asset_ids_response_dto.py +++ b/generated/immich/openapi_client/models/asset_ids_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_id_error_reason import AssetIdErrorReason from typing import Optional, Set from typing_extensions import Self @@ -28,7 +28,7 @@ class AssetIdsResponseDto(BaseModel): """ AssetIdsResponseDto """ # noqa: E501 - asset_id: UUID = Field(description="Asset ID", alias="assetId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") error: Optional[AssetIdErrorReason] = None success: StrictBool = Field(description="Whether operation succeeded") __properties: ClassVar[List[str]] = ["assetId", "error", "success"] diff --git a/generated/immich/openapi_client/models/asset_jobs_dto.py b/generated/immich/openapi_client/models/asset_jobs_dto.py index 06ac5f0..71bd734 100644 --- a/generated/immich/openapi_client/models/asset_jobs_dto.py +++ b/generated/immich/openapi_client/models/asset_jobs_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_job_name import AssetJobName from typing import Optional, Set from typing_extensions import Self @@ -28,7 +28,7 @@ class AssetJobsDto(BaseModel): """ AssetJobsDto """ # noqa: E501 - asset_ids: List[UUID] = Field(description="Asset IDs", alias="assetIds") + asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs", alias="assetIds") name: AssetJobName __properties: ClassVar[List[str]] = ["assetIds", "name"] diff --git a/generated/immich/openapi_client/models/asset_media_response_dto.py b/generated/immich/openapi_client/models/asset_media_response_dto.py index d3c416a..7612683 100644 --- a/generated/immich/openapi_client/models/asset_media_response_dto.py +++ b/generated/immich/openapi_client/models/asset_media_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_media_status import AssetMediaStatus from typing import Optional, Set from typing_extensions import Self @@ -28,7 +28,7 @@ class AssetMediaResponseDto(BaseModel): """ AssetMediaResponseDto """ # noqa: E501 - id: UUID = Field(description="Asset media ID") + id: Annotated[str, Field(strict=True)] = Field(description="Asset media ID") status: AssetMediaStatus __properties: ClassVar[List[str]] = ["id", "status"] diff --git a/generated/immich/openapi_client/models/asset_metadata_bulk_delete_dto.py b/generated/immich/openapi_client/models/asset_metadata_bulk_delete_dto.py new file mode 100644 index 0000000..7125c9b --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_bulk_delete_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.asset_metadata_bulk_delete_item_dto import AssetMetadataBulkDeleteItemDto +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataBulkDeleteDto(BaseModel): + """ + AssetMetadataBulkDeleteDto + """ # noqa: E501 + items: List[AssetMetadataBulkDeleteItemDto] = Field(description="Metadata items to delete") + __properties: ClassVar[List[str]] = ["items"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataBulkDeleteDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataBulkDeleteDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [AssetMetadataBulkDeleteItemDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_bulk_delete_item_dto.py b/generated/immich/openapi_client/models/asset_metadata_bulk_delete_item_dto.py new file mode 100644 index 0000000..a154f05 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_bulk_delete_item_dto.py @@ -0,0 +1,97 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataBulkDeleteItemDto(BaseModel): + """ + AssetMetadataBulkDeleteItemDto + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + key: StrictStr = Field(description="Metadata key") + __properties: ClassVar[List[str]] = ["assetId", "key"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataBulkDeleteItemDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataBulkDeleteItemDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "key": obj.get("key") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_bulk_response_dto.py b/generated/immich/openapi_client/models/asset_metadata_bulk_response_dto.py new file mode 100644 index 0000000..f078274 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_bulk_response_dto.py @@ -0,0 +1,109 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataBulkResponseDto(BaseModel): + """ + AssetMetadataBulkResponseDto + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + key: StrictStr = Field(description="Metadata key") + updated_at: datetime = Field(description="Last update date", alias="updatedAt") + value: Dict[str, Any] = Field(description="Metadata value (object)") + __properties: ClassVar[List[str]] = ["assetId", "key", "updatedAt", "value"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataBulkResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataBulkResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "key": obj.get("key"), + "updatedAt": obj.get("updatedAt"), + "value": obj.get("value") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_bulk_upsert_dto.py b/generated/immich/openapi_client/models/asset_metadata_bulk_upsert_dto.py new file mode 100644 index 0000000..31463cc --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_bulk_upsert_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.asset_metadata_bulk_upsert_item_dto import AssetMetadataBulkUpsertItemDto +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataBulkUpsertDto(BaseModel): + """ + AssetMetadataBulkUpsertDto + """ # noqa: E501 + items: List[AssetMetadataBulkUpsertItemDto] = Field(description="Metadata items to upsert") + __properties: ClassVar[List[str]] = ["items"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataBulkUpsertDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataBulkUpsertDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [AssetMetadataBulkUpsertItemDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_bulk_upsert_item_dto.py b/generated/immich/openapi_client/models/asset_metadata_bulk_upsert_item_dto.py new file mode 100644 index 0000000..820968b --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_bulk_upsert_item_dto.py @@ -0,0 +1,99 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataBulkUpsertItemDto(BaseModel): + """ + AssetMetadataBulkUpsertItemDto + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + key: StrictStr = Field(description="Metadata key") + value: Dict[str, Any] = Field(description="Metadata value (object)") + __properties: ClassVar[List[str]] = ["assetId", "key", "value"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataBulkUpsertItemDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataBulkUpsertItemDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "key": obj.get("key"), + "value": obj.get("value") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_response_dto.py b/generated/immich/openapi_client/models/asset_metadata_response_dto.py new file mode 100644 index 0000000..b9591a5 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_response_dto.py @@ -0,0 +1,99 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataResponseDto(BaseModel): + """ + AssetMetadataResponseDto + """ # noqa: E501 + key: StrictStr = Field(description="Metadata key") + updated_at: datetime = Field(description="Last update date", alias="updatedAt") + value: Dict[str, Any] = Field(description="Metadata value (object)") + __properties: ClassVar[List[str]] = ["key", "updatedAt", "value"] + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "updatedAt": obj.get("updatedAt"), + "value": obj.get("value") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_upsert_dto.py b/generated/immich/openapi_client/models/asset_metadata_upsert_dto.py new file mode 100644 index 0000000..c96eb9f --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_upsert_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.asset_metadata_upsert_item_dto import AssetMetadataUpsertItemDto +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataUpsertDto(BaseModel): + """ + AssetMetadataUpsertDto + """ # noqa: E501 + items: List[AssetMetadataUpsertItemDto] = Field(description="Metadata items to upsert") + __properties: ClassVar[List[str]] = ["items"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataUpsertDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataUpsertDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [AssetMetadataUpsertItemDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_metadata_upsert_item_dto.py b/generated/immich/openapi_client/models/asset_metadata_upsert_item_dto.py new file mode 100644 index 0000000..368a8fc --- /dev/null +++ b/generated/immich/openapi_client/models/asset_metadata_upsert_item_dto.py @@ -0,0 +1,89 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AssetMetadataUpsertItemDto(BaseModel): + """ + AssetMetadataUpsertItemDto + """ # noqa: E501 + key: StrictStr = Field(description="Metadata key") + value: Dict[str, Any] = Field(description="Metadata value (object)") + __properties: ClassVar[List[str]] = ["key", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetMetadataUpsertItemDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetMetadataUpsertItemDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "value": obj.get("value") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_ocr_response_dto.py b/generated/immich/openapi_client/models/asset_ocr_response_dto.py new file mode 100644 index 0000000..08ea419 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_ocr_response_dto.py @@ -0,0 +1,126 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AssetOcrResponseDto(BaseModel): + """ + AssetOcrResponseDto + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(alias="assetId") + box_score: Union[StrictFloat, StrictInt] = Field(description="Confidence score for text detection box", alias="boxScore") + id: Annotated[str, Field(strict=True)] + text: StrictStr = Field(description="Recognized text") + text_score: Union[StrictFloat, StrictInt] = Field(description="Confidence score for text recognition", alias="textScore") + x1: Union[StrictFloat, StrictInt] = Field(description="Normalized x coordinate of box corner 1 (0-1)") + x2: Union[StrictFloat, StrictInt] = Field(description="Normalized x coordinate of box corner 2 (0-1)") + x3: Union[StrictFloat, StrictInt] = Field(description="Normalized x coordinate of box corner 3 (0-1)") + x4: Union[StrictFloat, StrictInt] = Field(description="Normalized x coordinate of box corner 4 (0-1)") + y1: Union[StrictFloat, StrictInt] = Field(description="Normalized y coordinate of box corner 1 (0-1)") + y2: Union[StrictFloat, StrictInt] = Field(description="Normalized y coordinate of box corner 2 (0-1)") + y3: Union[StrictFloat, StrictInt] = Field(description="Normalized y coordinate of box corner 3 (0-1)") + y4: Union[StrictFloat, StrictInt] = Field(description="Normalized y coordinate of box corner 4 (0-1)") + __properties: ClassVar[List[str]] = ["assetId", "boxScore", "id", "text", "textScore", "x1", "x2", "x3", "x4", "y1", "y2", "y3", "y4"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AssetOcrResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AssetOcrResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "boxScore": obj.get("boxScore"), + "id": obj.get("id"), + "text": obj.get("text"), + "textScore": obj.get("textScore"), + "x1": obj.get("x1"), + "x2": obj.get("x2"), + "x3": obj.get("x3"), + "x4": obj.get("x4"), + "y1": obj.get("y1"), + "y2": obj.get("y2"), + "y3": obj.get("y3"), + "y4": obj.get("y4") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/asset_order_by.py b/generated/immich/openapi_client/models/asset_order_by.py new file mode 100644 index 0000000..d8b7392 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_order_by.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AssetOrderBy(str, Enum): + """ + Asset sorting property + """ + + """ + allowed enum values + """ + TAKENAT = 'takenAt' + CREATEDAT = 'createdAt' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AssetOrderBy from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/asset_reject_reason.py b/generated/immich/openapi_client/models/asset_reject_reason.py new file mode 100644 index 0000000..a651331 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_reject_reason.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AssetRejectReason(str, Enum): + """ + Rejection reason if rejected + """ + + """ + allowed enum values + """ + DUPLICATE = 'duplicate' + UNSUPPORTED_MINUS_FORMAT = 'unsupported-format' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AssetRejectReason from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/asset_response_dto.py b/generated/immich/openapi_client/models/asset_response_dto.py index d58847d..8d4abfb 100644 --- a/generated/immich/openapi_client/models/asset_response_dto.py +++ b/generated/immich/openapi_client/models/asset_response_dto.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_stack_response_dto import AssetStackResponseDto from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum from generated.immich.openapi_client.models.asset_visibility import AssetVisibility @@ -38,27 +37,27 @@ class AssetResponseDto(BaseModel): """ # noqa: E501 checksum: StrictStr = Field(description="Base64 encoded SHA1 hash") created_at: datetime = Field(description="The UTC timestamp when the asset was originally uploaded to Immich.", alias="createdAt") - duplicate_id: Optional[UUID] = Field(default=None, description="Duplicate group ID", alias="duplicateId") + duplicate_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Duplicate group ID", alias="duplicateId") duration: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = Field(description="Video/gif duration in milliseconds (null for static images)") exif_info: Optional[ExifResponseDto] = Field(default=None, alias="exifInfo") file_created_at: datetime = Field(description="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.", alias="fileCreatedAt") file_modified_at: datetime = Field(description="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.", alias="fileModifiedAt") has_metadata: StrictBool = Field(description="Whether asset has metadata", alias="hasMetadata") height: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]] = Field(description="Asset height") - id: UUID = Field(description="Asset ID") + id: Annotated[str, Field(strict=True)] = Field(description="Asset ID") is_archived: StrictBool = Field(description="Is archived", alias="isArchived") is_edited: StrictBool = Field(description="Is edited", alias="isEdited") is_favorite: StrictBool = Field(description="Is favorite", alias="isFavorite") is_offline: StrictBool = Field(description="Is offline", alias="isOffline") is_trashed: StrictBool = Field(description="Is trashed", alias="isTrashed") - library_id: Optional[UUID] = Field(default=None, description="Library ID", alias="libraryId") + library_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Library ID", alias="libraryId") live_photo_video_id: Optional[StrictStr] = Field(default=None, description="Live photo video ID", alias="livePhotoVideoId") local_date_time: datetime = Field(description="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.", alias="localDateTime") original_file_name: StrictStr = Field(description="Original file name", alias="originalFileName") original_mime_type: Optional[StrictStr] = Field(default=None, description="Original MIME type", alias="originalMimeType") original_path: StrictStr = Field(description="Original file path", alias="originalPath") owner: Optional[UserResponseDto] = None - owner_id: UUID = Field(description="Owner user ID", alias="ownerId") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner user ID", alias="ownerId") people: Optional[List[PersonResponseDto]] = None resized: Optional[StrictBool] = Field(default=None, description="Is resized") stack: Optional[AssetStackResponseDto] = None diff --git a/generated/immich/openapi_client/models/asset_stack_response_dto.py b/generated/immich/openapi_client/models/asset_stack_response_dto.py index d12c673..3177d51 100644 --- a/generated/immich/openapi_client/models/asset_stack_response_dto.py +++ b/generated/immich/openapi_client/models/asset_stack_response_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -29,8 +28,8 @@ class AssetStackResponseDto(BaseModel): AssetStackResponseDto """ # noqa: E501 asset_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Number of assets in stack", alias="assetCount") - id: UUID = Field(description="Stack ID") - primary_asset_id: UUID = Field(description="Primary asset ID", alias="primaryAssetId") + id: Annotated[str, Field(strict=True)] = Field(description="Stack ID") + primary_asset_id: Annotated[str, Field(strict=True)] = Field(description="Primary asset ID", alias="primaryAssetId") __properties: ClassVar[List[str]] = ["assetCount", "id", "primaryAssetId"] @field_validator('id') diff --git a/generated/immich/openapi_client/models/asset_upload_action.py b/generated/immich/openapi_client/models/asset_upload_action.py new file mode 100644 index 0000000..905cb69 --- /dev/null +++ b/generated/immich/openapi_client/models/asset_upload_action.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AssetUploadAction(str, Enum): + """ + Upload action + """ + + """ + allowed enum values + """ + ACCEPT = 'accept' + REJECT = 'reject' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AssetUploadAction from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/asset_visibility.py b/generated/immich/openapi_client/models/asset_visibility.py new file mode 100644 index 0000000..6b7ca2d --- /dev/null +++ b/generated/immich/openapi_client/models/asset_visibility.py @@ -0,0 +1,39 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AssetVisibility(str, Enum): + """ + Asset visibility + """ + + """ + allowed enum values + """ + ARCHIVE = 'archive' + TIMELINE = 'timeline' + HIDDEN = 'hidden' + LOCKED = 'locked' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AssetVisibility from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/auth_status_response_dto.py b/generated/immich/openapi_client/models/auth_status_response_dto.py new file mode 100644 index 0000000..273032c --- /dev/null +++ b/generated/immich/openapi_client/models/auth_status_response_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AuthStatusResponseDto(BaseModel): + """ + AuthStatusResponseDto + """ # noqa: E501 + expires_at: Optional[StrictStr] = Field(default=None, description="Session expiration date", alias="expiresAt") + is_elevated: StrictBool = Field(description="Is elevated session", alias="isElevated") + password: StrictBool = Field(description="Has password set") + pin_code: StrictBool = Field(description="Has PIN code set", alias="pinCode") + pin_expires_at: Optional[StrictStr] = Field(default=None, description="PIN expiration date", alias="pinExpiresAt") + __properties: ClassVar[List[str]] = ["expiresAt", "isElevated", "password", "pinCode", "pinExpiresAt"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AuthStatusResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AuthStatusResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "expiresAt": obj.get("expiresAt"), + "isElevated": obj.get("isElevated"), + "password": obj.get("password"), + "pinCode": obj.get("pinCode"), + "pinExpiresAt": obj.get("pinExpiresAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/bulk_id_error_reason.py b/generated/immich/openapi_client/models/bulk_id_error_reason.py new file mode 100644 index 0000000..6c199dd --- /dev/null +++ b/generated/immich/openapi_client/models/bulk_id_error_reason.py @@ -0,0 +1,40 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class BulkIdErrorReason(str, Enum): + """ + Error reason + """ + + """ + allowed enum values + """ + DUPLICATE = 'duplicate' + NO_PERMISSION = 'no_permission' + NOT_FOUND = 'not_found' + UNKNOWN = 'unknown' + VALIDATION = 'validation' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of BulkIdErrorReason from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/bulk_id_response_dto.py b/generated/immich/openapi_client/models/bulk_id_response_dto.py index 8c2d661..dcd176e 100644 --- a/generated/immich/openapi_client/models/bulk_id_response_dto.py +++ b/generated/immich/openapi_client/models/bulk_id_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.bulk_id_error_reason import BulkIdErrorReason from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,7 @@ class BulkIdResponseDto(BaseModel): """ # noqa: E501 error: Optional[BulkIdErrorReason] = None error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage") - id: UUID = Field(description="ID") + id: Annotated[str, Field(strict=True)] = Field(description="ID") success: StrictBool = Field(description="Whether operation succeeded") __properties: ClassVar[List[str]] = ["error", "errorMessage", "id", "success"] diff --git a/generated/immich/openapi_client/models/bulk_ids_dto.py b/generated/immich/openapi_client/models/bulk_ids_dto.py index 411a43e..d7712b1 100644 --- a/generated/immich/openapi_client/models/bulk_ids_dto.py +++ b/generated/immich/openapi_client/models/bulk_ids_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class BulkIdsDto(BaseModel): """ BulkIdsDto """ # noqa: E501 - ids: List[UUID] = Field(description="IDs to process") + ids: List[Annotated[str, Field(strict=True)]] = Field(description="IDs to process") __properties: ClassVar[List[str]] = ["ids"] model_config = ConfigDict( diff --git a/generated/immich/openapi_client/models/calendar_heatmap_response_dto.py b/generated/immich/openapi_client/models/calendar_heatmap_response_dto.py new file mode 100644 index 0000000..8470614 --- /dev/null +++ b/generated/immich/openapi_client/models/calendar_heatmap_response_dto.py @@ -0,0 +1,102 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.calendar_heatmap_response_dto_series_inner import CalendarHeatmapResponseDtoSeriesInner +from typing import Optional, Set +from typing_extensions import Self + +class CalendarHeatmapResponseDto(BaseModel): + """ + CalendarHeatmapResponseDto + """ # noqa: E501 + var_from: StrictStr = Field(description="Start date in UTC", alias="from") + series: List[CalendarHeatmapResponseDtoSeriesInner] + to: StrictStr = Field(description="End date in UTC") + total_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Total activity count over the period", alias="totalCount") + __properties: ClassVar[List[str]] = ["from", "series", "to", "totalCount"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CalendarHeatmapResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in series (list) + _items = [] + if self.series: + for _item_series in self.series: + if _item_series: + _items.append(_item_series.to_dict()) + _dict['series'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CalendarHeatmapResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "from": obj.get("from"), + "series": [CalendarHeatmapResponseDtoSeriesInner.from_dict(_item) for _item in obj["series"]] if obj.get("series") is not None else None, + "to": obj.get("to"), + "totalCount": obj.get("totalCount") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/calendar_heatmap_response_dto_series_inner.py b/generated/immich/openapi_client/models/calendar_heatmap_response_dto_series_inner.py new file mode 100644 index 0000000..120bd3f --- /dev/null +++ b/generated/immich/openapi_client/models/calendar_heatmap_response_dto_series_inner.py @@ -0,0 +1,90 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class CalendarHeatmapResponseDtoSeriesInner(BaseModel): + """ + CalendarHeatmapResponseDtoSeriesInner + """ # noqa: E501 + count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Activity count") + var_date: StrictStr = Field(description="Date in UTC", alias="date") + __properties: ClassVar[List[str]] = ["count", "date"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CalendarHeatmapResponseDtoSeriesInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CalendarHeatmapResponseDtoSeriesInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "date": obj.get("date") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/calendar_heatmap_type.py b/generated/immich/openapi_client/models/calendar_heatmap_type.py new file mode 100644 index 0000000..e95cf48 --- /dev/null +++ b/generated/immich/openapi_client/models/calendar_heatmap_type.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class CalendarHeatmapType(str, Enum): + """ + Type of calendar heatmap + """ + + """ + allowed enum values + """ + UPLOAD = 'Upload' + TAKEN = 'Taken' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of CalendarHeatmapType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/cast_response.py b/generated/immich/openapi_client/models/cast_response.py new file mode 100644 index 0000000..bc1f668 --- /dev/null +++ b/generated/immich/openapi_client/models/cast_response.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CastResponse(BaseModel): + """ + CastResponse + """ # noqa: E501 + g_cast_enabled: StrictBool = Field(description="Whether Google Cast is enabled", alias="gCastEnabled") + __properties: ClassVar[List[str]] = ["gCastEnabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CastResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CastResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "gCastEnabled": obj.get("gCastEnabled") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/cast_update.py b/generated/immich/openapi_client/models/cast_update.py new file mode 100644 index 0000000..a62a8bb --- /dev/null +++ b/generated/immich/openapi_client/models/cast_update.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class CastUpdate(BaseModel): + """ + CastUpdate + """ # noqa: E501 + g_cast_enabled: Optional[StrictBool] = Field(default=None, description="Whether Google Cast is enabled", alias="gCastEnabled") + __properties: ClassVar[List[str]] = ["gCastEnabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CastUpdate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CastUpdate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "gCastEnabled": obj.get("gCastEnabled") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/contributor_count_response_dto.py b/generated/immich/openapi_client/models/contributor_count_response_dto.py new file mode 100644 index 0000000..474347b --- /dev/null +++ b/generated/immich/openapi_client/models/contributor_count_response_dto.py @@ -0,0 +1,97 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ContributorCountResponseDto(BaseModel): + """ + ContributorCountResponseDto + """ # noqa: E501 + asset_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Number of assets contributed", alias="assetCount") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") + __properties: ClassVar[List[str]] = ["assetCount", "userId"] + + @field_validator('user_id') + def user_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ContributorCountResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ContributorCountResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetCount": obj.get("assetCount"), + "userId": obj.get("userId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/create_album_dto.py b/generated/immich/openapi_client/models/create_album_dto.py index 73c50e0..4d458a9 100644 --- a/generated/immich/openapi_client/models/create_album_dto.py +++ b/generated/immich/openapi_client/models/create_album_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.album_user_create_dto import AlbumUserCreateDto from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,7 @@ class CreateAlbumDto(BaseModel): """ # noqa: E501 album_name: StrictStr = Field(description="Album name", alias="albumName") album_users: Optional[List[AlbumUserCreateDto]] = Field(default=None, description="Album users", alias="albumUsers") - asset_ids: Optional[List[UUID]] = Field(default=None, description="Initial asset IDs", alias="assetIds") + asset_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Initial asset IDs", alias="assetIds") description: Optional[StrictStr] = Field(default=None, description="Album description") __properties: ClassVar[List[str]] = ["albumName", "albumUsers", "assetIds", "description"] diff --git a/generated/immich/openapi_client/models/create_library_dto.py b/generated/immich/openapi_client/models/create_library_dto.py index f2535ad..f322b79 100644 --- a/generated/immich/openapi_client/models/create_library_dto.py +++ b/generated/immich/openapi_client/models/create_library_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -31,7 +30,7 @@ class CreateLibraryDto(BaseModel): exclusion_patterns: Optional[Annotated[List[StrictStr], Field(max_length=128)]] = Field(default=None, description="Exclusion patterns (max 128)", alias="exclusionPatterns") import_paths: Optional[Annotated[List[StrictStr], Field(max_length=128)]] = Field(default=None, description="Import paths (max 128)", alias="importPaths") name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Library name") - owner_id: UUID = Field(description="Owner user ID", alias="ownerId") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner user ID", alias="ownerId") __properties: ClassVar[List[str]] = ["exclusionPatterns", "importPaths", "name", "ownerId"] @field_validator('owner_id') diff --git a/generated/immich/openapi_client/models/create_profile_image_response_dto.py b/generated/immich/openapi_client/models/create_profile_image_response_dto.py index b77f091..af6b2e2 100644 --- a/generated/immich/openapi_client/models/create_profile_image_response_dto.py +++ b/generated/immich/openapi_client/models/create_profile_image_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,7 @@ class CreateProfileImageResponseDto(BaseModel): """ # noqa: E501 profile_changed_at: datetime = Field(description="Profile image change date", alias="profileChangedAt") profile_image_path: StrictStr = Field(description="Profile image file path", alias="profileImagePath") - user_id: UUID = Field(description="User ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") __properties: ClassVar[List[str]] = ["profileChangedAt", "profileImagePath", "userId"] @field_validator('profile_changed_at') diff --git a/generated/immich/openapi_client/models/crop_parameters.py b/generated/immich/openapi_client/models/crop_parameters.py new file mode 100644 index 0000000..45d2bb7 --- /dev/null +++ b/generated/immich/openapi_client/models/crop_parameters.py @@ -0,0 +1,94 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class CropParameters(BaseModel): + """ + CropParameters + """ # noqa: E501 + height: Annotated[int, Field(le=9007199254740991, strict=True, ge=1)] = Field(description="Height of the crop") + width: Annotated[int, Field(le=9007199254740991, strict=True, ge=1)] = Field(description="Width of the crop") + x: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Top-Left X coordinate of crop") + y: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Top-Left Y coordinate of crop") + __properties: ClassVar[List[str]] = ["height", "width", "x", "y"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CropParameters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CropParameters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "height": obj.get("height"), + "width": obj.get("width"), + "x": obj.get("x"), + "y": obj.get("y") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/database_backup_delete_dto.py b/generated/immich/openapi_client/models/database_backup_delete_dto.py new file mode 100644 index 0000000..5f7faf4 --- /dev/null +++ b/generated/immich/openapi_client/models/database_backup_delete_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DatabaseBackupDeleteDto(BaseModel): + """ + DatabaseBackupDeleteDto + """ # noqa: E501 + backups: List[StrictStr] = Field(description="Backup filenames to delete") + __properties: ClassVar[List[str]] = ["backups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DatabaseBackupDeleteDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DatabaseBackupDeleteDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "backups": obj.get("backups") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/database_backup_dto.py b/generated/immich/openapi_client/models/database_backup_dto.py new file mode 100644 index 0000000..1490b82 --- /dev/null +++ b/generated/immich/openapi_client/models/database_backup_dto.py @@ -0,0 +1,92 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DatabaseBackupDto(BaseModel): + """ + DatabaseBackupDto + """ # noqa: E501 + filename: StrictStr = Field(description="Backup filename") + filesize: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Backup file size") + timezone: StrictStr = Field(description="Backup timezone") + __properties: ClassVar[List[str]] = ["filename", "filesize", "timezone"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DatabaseBackupDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DatabaseBackupDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filename": obj.get("filename"), + "filesize": obj.get("filesize"), + "timezone": obj.get("timezone") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/database_backup_list_response_dto.py b/generated/immich/openapi_client/models/database_backup_list_response_dto.py new file mode 100644 index 0000000..0345c91 --- /dev/null +++ b/generated/immich/openapi_client/models/database_backup_list_response_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.database_backup_dto import DatabaseBackupDto +from typing import Optional, Set +from typing_extensions import Self + +class DatabaseBackupListResponseDto(BaseModel): + """ + DatabaseBackupListResponseDto + """ # noqa: E501 + backups: List[DatabaseBackupDto] = Field(description="List of backups") + __properties: ClassVar[List[str]] = ["backups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DatabaseBackupListResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in backups (list) + _items = [] + if self.backups: + for _item_backups in self.backups: + if _item_backups: + _items.append(_item_backups.to_dict()) + _dict['backups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DatabaseBackupListResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "backups": [DatabaseBackupDto.from_dict(_item) for _item in obj["backups"]] if obj.get("backups") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/download_archive_dto.py b/generated/immich/openapi_client/models/download_archive_dto.py new file mode 100644 index 0000000..d2a6d39 --- /dev/null +++ b/generated/immich/openapi_client/models/download_archive_dto.py @@ -0,0 +1,90 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DownloadArchiveDto(BaseModel): + """ + DownloadArchiveDto + """ # noqa: E501 + asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs", alias="assetIds") + edited: Optional[StrictBool] = Field(default=None, description="Download edited asset if available") + __properties: ClassVar[List[str]] = ["assetIds", "edited"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DownloadArchiveDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DownloadArchiveDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetIds": obj.get("assetIds"), + "edited": obj.get("edited") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/download_archive_info.py b/generated/immich/openapi_client/models/download_archive_info.py index 6175c7a..2675dcf 100644 --- a/generated/immich/openapi_client/models/download_archive_info.py +++ b/generated/immich/openapi_client/models/download_archive_info.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -28,7 +27,7 @@ class DownloadArchiveInfo(BaseModel): """ DownloadArchiveInfo """ # noqa: E501 - asset_ids: List[UUID] = Field(description="Asset IDs in this archive", alias="assetIds") + asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs in this archive", alias="assetIds") size: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Archive size in bytes") __properties: ClassVar[List[str]] = ["assetIds", "size"] diff --git a/generated/immich/openapi_client/models/download_info_dto.py b/generated/immich/openapi_client/models/download_info_dto.py index d604782..43b6417 100644 --- a/generated/immich/openapi_client/models/download_info_dto.py +++ b/generated/immich/openapi_client/models/download_info_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -28,10 +27,10 @@ class DownloadInfoDto(BaseModel): """ DownloadInfoDto """ # noqa: E501 - album_id: Optional[UUID] = Field(default=None, description="Album ID to download", alias="albumId") + album_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Album ID to download", alias="albumId") archive_size: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]] = Field(default=None, description="Archive size limit in bytes", alias="archiveSize") - asset_ids: Optional[List[UUID]] = Field(default=None, description="Asset IDs to download", alias="assetIds") - user_id: Optional[UUID] = Field(default=None, description="User ID to download assets from", alias="userId") + asset_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Asset IDs to download", alias="assetIds") + user_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="User ID to download assets from", alias="userId") __properties: ClassVar[List[str]] = ["albumId", "archiveSize", "assetIds", "userId"] @field_validator('album_id') diff --git a/generated/immich/openapi_client/models/duplicate_resolve_dto.py b/generated/immich/openapi_client/models/duplicate_resolve_dto.py new file mode 100644 index 0000000..33cb496 --- /dev/null +++ b/generated/immich/openapi_client/models/duplicate_resolve_dto.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.duplicate_resolve_group_dto import DuplicateResolveGroupDto +from typing import Optional, Set +from typing_extensions import Self + +class DuplicateResolveDto(BaseModel): + """ + DuplicateResolveDto + """ # noqa: E501 + groups: Annotated[List[DuplicateResolveGroupDto], Field(min_length=1)] = Field(description="List of duplicate groups to resolve") + __properties: ClassVar[List[str]] = ["groups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DuplicateResolveDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in groups (list) + _items = [] + if self.groups: + for _item_groups in self.groups: + if _item_groups: + _items.append(_item_groups.to_dict()) + _dict['groups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DuplicateResolveDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "groups": [DuplicateResolveGroupDto.from_dict(_item) for _item in obj["groups"]] if obj.get("groups") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/duplicate_resolve_group_dto.py b/generated/immich/openapi_client/models/duplicate_resolve_group_dto.py new file mode 100644 index 0000000..ada2fb3 --- /dev/null +++ b/generated/immich/openapi_client/models/duplicate_resolve_group_dto.py @@ -0,0 +1,99 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class DuplicateResolveGroupDto(BaseModel): + """ + DuplicateResolveGroupDto + """ # noqa: E501 + duplicate_id: Annotated[str, Field(strict=True)] = Field(alias="duplicateId") + keep_asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs to keep", alias="keepAssetIds") + trash_asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs to trash or delete", alias="trashAssetIds") + __properties: ClassVar[List[str]] = ["duplicateId", "keepAssetIds", "trashAssetIds"] + + @field_validator('duplicate_id') + def duplicate_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DuplicateResolveGroupDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DuplicateResolveGroupDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "duplicateId": obj.get("duplicateId"), + "keepAssetIds": obj.get("keepAssetIds"), + "trashAssetIds": obj.get("trashAssetIds") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/duplicate_response_dto.py b/generated/immich/openapi_client/models/duplicate_response_dto.py index 259236c..f8aca91 100644 --- a/generated/immich/openapi_client/models/duplicate_response_dto.py +++ b/generated/immich/openapi_client/models/duplicate_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto from typing import Optional, Set from typing_extensions import Self @@ -29,8 +29,8 @@ class DuplicateResponseDto(BaseModel): DuplicateResponseDto """ # noqa: E501 assets: List[AssetResponseDto] = Field(description="Duplicate assets") - duplicate_id: UUID = Field(description="Duplicate group ID", alias="duplicateId") - suggested_keep_asset_ids: List[UUID] = Field(description="Suggested asset IDs to keep based on file size and EXIF data", alias="suggestedKeepAssetIds") + duplicate_id: Annotated[str, Field(strict=True)] = Field(description="Duplicate group ID", alias="duplicateId") + suggested_keep_asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Suggested asset IDs to keep based on file size and EXIF data", alias="suggestedKeepAssetIds") __properties: ClassVar[List[str]] = ["assets", "duplicateId", "suggestedKeepAssetIds"] @field_validator('duplicate_id') diff --git a/generated/immich/openapi_client/models/face_dto.py b/generated/immich/openapi_client/models/face_dto.py index 3381d92..c7fd4db 100644 --- a/generated/immich/openapi_client/models/face_dto.py +++ b/generated/immich/openapi_client/models/face_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class FaceDto(BaseModel): """ FaceDto """ # noqa: E501 - id: UUID = Field(description="Face ID") + id: Annotated[str, Field(strict=True)] = Field(description="Face ID") __properties: ClassVar[List[str]] = ["id"] @field_validator('id') diff --git a/generated/immich/openapi_client/models/integrity_report.py b/generated/immich/openapi_client/models/integrity_report.py new file mode 100644 index 0000000..837062b --- /dev/null +++ b/generated/immich/openapi_client/models/integrity_report.py @@ -0,0 +1,38 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class IntegrityReport(str, Enum): + """ + Integrity report type + """ + + """ + allowed enum values + """ + UNTRACKED_FILE = 'untracked_file' + MISSING_FILE = 'missing_file' + CHECKSUM_MISMATCH = 'checksum_mismatch' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of IntegrityReport from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/integrity_report_response_dto.py b/generated/immich/openapi_client/models/integrity_report_response_dto.py new file mode 100644 index 0000000..28572a6 --- /dev/null +++ b/generated/immich/openapi_client/models/integrity_report_response_dto.py @@ -0,0 +1,97 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.integrity_report_response_dto_items_inner import IntegrityReportResponseDtoItemsInner +from typing import Optional, Set +from typing_extensions import Self + +class IntegrityReportResponseDto(BaseModel): + """ + IntegrityReportResponseDto + """ # noqa: E501 + items: List[IntegrityReportResponseDtoItemsInner] + next_cursor: Optional[StrictStr] = Field(default=None, alias="nextCursor") + __properties: ClassVar[List[str]] = ["items", "nextCursor"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IntegrityReportResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IntegrityReportResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [IntegrityReportResponseDtoItemsInner.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "nextCursor": obj.get("nextCursor") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/integrity_report_response_dto_items_inner.py b/generated/immich/openapi_client/models/integrity_report_response_dto_items_inner.py new file mode 100644 index 0000000..0df7600 --- /dev/null +++ b/generated/immich/openapi_client/models/integrity_report_response_dto_items_inner.py @@ -0,0 +1,100 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.integrity_report import IntegrityReport +from typing import Optional, Set +from typing_extensions import Self + +class IntegrityReportResponseDtoItemsInner(BaseModel): + """ + IntegrityReportResponseDtoItemsInner + """ # noqa: E501 + id: Annotated[str, Field(strict=True)] = Field(description="Integrity report item id") + path: StrictStr = Field(description="Integrity report item path") + type: IntegrityReport + __properties: ClassVar[List[str]] = ["id", "path", "type"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IntegrityReportResponseDtoItemsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IntegrityReportResponseDtoItemsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "path": obj.get("path"), + "type": obj.get("type") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/integrity_report_summary_response_dto.py b/generated/immich/openapi_client/models/integrity_report_summary_response_dto.py new file mode 100644 index 0000000..cc550eb --- /dev/null +++ b/generated/immich/openapi_client/models/integrity_report_summary_response_dto.py @@ -0,0 +1,92 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class IntegrityReportSummaryResponseDto(BaseModel): + """ + IntegrityReportSummaryResponseDto + """ # noqa: E501 + checksum_mismatch: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] + missing_file: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] + untracked_file: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] + __properties: ClassVar[List[str]] = ["checksum_mismatch", "missing_file", "untracked_file"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IntegrityReportSummaryResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IntegrityReportSummaryResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "checksum_mismatch": obj.get("checksum_mismatch"), + "missing_file": obj.get("missing_file"), + "untracked_file": obj.get("untracked_file") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/library_response_dto.py b/generated/immich/openapi_client/models/library_response_dto.py index e6fa128..898bfba 100644 --- a/generated/immich/openapi_client/models/library_response_dto.py +++ b/generated/immich/openapi_client/models/library_response_dto.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -32,10 +31,10 @@ class LibraryResponseDto(BaseModel): asset_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of assets", alias="assetCount") created_at: datetime = Field(description="Creation date", alias="createdAt") exclusion_patterns: List[StrictStr] = Field(description="Exclusion patterns", alias="exclusionPatterns") - id: UUID = Field(description="Library ID") + id: Annotated[str, Field(strict=True)] = Field(description="Library ID") import_paths: List[StrictStr] = Field(description="Import paths", alias="importPaths") name: StrictStr = Field(description="Library name") - owner_id: UUID = Field(description="Owner user ID", alias="ownerId") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner user ID", alias="ownerId") refreshed_at: Optional[datetime] = Field(description="Last refresh date", alias="refreshedAt") updated_at: datetime = Field(description="Last update date", alias="updatedAt") __properties: ClassVar[List[str]] = ["assetCount", "createdAt", "exclusionPatterns", "id", "importPaths", "name", "ownerId", "refreshedAt", "updatedAt"] diff --git a/generated/immich/openapi_client/models/login_response_dto.py b/generated/immich/openapi_client/models/login_response_dto.py index 113763f..8739b2a 100644 --- a/generated/immich/openapi_client/models/login_response_dto.py +++ b/generated/immich/openapi_client/models/login_response_dto.py @@ -20,7 +20,6 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -35,7 +34,7 @@ class LoginResponseDto(BaseModel): profile_image_path: StrictStr = Field(description="Profile image path", alias="profileImagePath") should_change_password: StrictBool = Field(description="Should change password", alias="shouldChangePassword") user_email: Annotated[str, Field(strict=True)] = Field(description="User email", alias="userEmail") - user_id: UUID = Field(description="User ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") __properties: ClassVar[List[str]] = ["accessToken", "isAdmin", "isOnboarded", "name", "profileImagePath", "shouldChangePassword", "userEmail", "userId"] @field_validator('user_email') diff --git a/generated/immich/openapi_client/models/machine_learning_availability_checks_dto.py b/generated/immich/openapi_client/models/machine_learning_availability_checks_dto.py new file mode 100644 index 0000000..c524539 --- /dev/null +++ b/generated/immich/openapi_client/models/machine_learning_availability_checks_dto.py @@ -0,0 +1,92 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class MachineLearningAvailabilityChecksDto(BaseModel): + """ + MachineLearningAvailabilityChecksDto + """ # noqa: E501 + enabled: StrictBool = Field(description="Enabled") + interval: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] + timeout: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] + __properties: ClassVar[List[str]] = ["enabled", "interval", "timeout"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MachineLearningAvailabilityChecksDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MachineLearningAvailabilityChecksDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "enabled": obj.get("enabled"), + "interval": obj.get("interval"), + "timeout": obj.get("timeout") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/maintenance_action.py b/generated/immich/openapi_client/models/maintenance_action.py new file mode 100644 index 0000000..f6c4c97 --- /dev/null +++ b/generated/immich/openapi_client/models/maintenance_action.py @@ -0,0 +1,39 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class MaintenanceAction(str, Enum): + """ + Maintenance action + """ + + """ + allowed enum values + """ + START = 'start' + END = 'end' + SELECT_DATABASE_RESTORE = 'select_database_restore' + RESTORE_DATABASE = 'restore_database' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of MaintenanceAction from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/maintenance_auth_dto.py b/generated/immich/openapi_client/models/maintenance_auth_dto.py new file mode 100644 index 0000000..bf2eb85 --- /dev/null +++ b/generated/immich/openapi_client/models/maintenance_auth_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class MaintenanceAuthDto(BaseModel): + """ + MaintenanceAuthDto + """ # noqa: E501 + username: StrictStr = Field(description="Maintenance username") + __properties: ClassVar[List[str]] = ["username"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MaintenanceAuthDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MaintenanceAuthDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "username": obj.get("username") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/maintenance_detect_install_response_dto.py b/generated/immich/openapi_client/models/maintenance_detect_install_response_dto.py new file mode 100644 index 0000000..651dfa5 --- /dev/null +++ b/generated/immich/openapi_client/models/maintenance_detect_install_response_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.maintenance_detect_install_storage_folder_dto import MaintenanceDetectInstallStorageFolderDto +from typing import Optional, Set +from typing_extensions import Self + +class MaintenanceDetectInstallResponseDto(BaseModel): + """ + MaintenanceDetectInstallResponseDto + """ # noqa: E501 + storage: List[MaintenanceDetectInstallStorageFolderDto] + __properties: ClassVar[List[str]] = ["storage"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MaintenanceDetectInstallResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in storage (list) + _items = [] + if self.storage: + for _item_storage in self.storage: + if _item_storage: + _items.append(_item_storage.to_dict()) + _dict['storage'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MaintenanceDetectInstallResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "storage": [MaintenanceDetectInstallStorageFolderDto.from_dict(_item) for _item in obj["storage"]] if obj.get("storage") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/maintenance_detect_install_storage_folder_dto.py b/generated/immich/openapi_client/models/maintenance_detect_install_storage_folder_dto.py new file mode 100644 index 0000000..2673e3d --- /dev/null +++ b/generated/immich/openapi_client/models/maintenance_detect_install_storage_folder_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.storage_folder import StorageFolder +from typing import Optional, Set +from typing_extensions import Self + +class MaintenanceDetectInstallStorageFolderDto(BaseModel): + """ + MaintenanceDetectInstallStorageFolderDto + """ # noqa: E501 + files: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of files in the folder") + folder: StorageFolder + readable: StrictBool = Field(description="Whether the folder is readable") + writable: StrictBool = Field(description="Whether the folder is writable") + __properties: ClassVar[List[str]] = ["files", "folder", "readable", "writable"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MaintenanceDetectInstallStorageFolderDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MaintenanceDetectInstallStorageFolderDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "files": obj.get("files"), + "folder": obj.get("folder"), + "readable": obj.get("readable"), + "writable": obj.get("writable") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/maintenance_login_dto.py b/generated/immich/openapi_client/models/maintenance_login_dto.py new file mode 100644 index 0000000..5b2e912 --- /dev/null +++ b/generated/immich/openapi_client/models/maintenance_login_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class MaintenanceLoginDto(BaseModel): + """ + MaintenanceLoginDto + """ # noqa: E501 + token: Optional[StrictStr] = Field(default=None, description="Maintenance token") + __properties: ClassVar[List[str]] = ["token"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MaintenanceLoginDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MaintenanceLoginDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "token": obj.get("token") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/maintenance_status_response_dto.py b/generated/immich/openapi_client/models/maintenance_status_response_dto.py new file mode 100644 index 0000000..29db7cf --- /dev/null +++ b/generated/immich/openapi_client/models/maintenance_status_response_dto.py @@ -0,0 +1,97 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.maintenance_action import MaintenanceAction +from typing import Optional, Set +from typing_extensions import Self + +class MaintenanceStatusResponseDto(BaseModel): + """ + MaintenanceStatusResponseDto + """ # noqa: E501 + action: MaintenanceAction + active: StrictBool + error: Optional[StrictStr] = None + progress: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]] = None + task: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["action", "active", "error", "progress", "task"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MaintenanceStatusResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MaintenanceStatusResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "action": obj.get("action"), + "active": obj.get("active"), + "error": obj.get("error"), + "progress": obj.get("progress"), + "task": obj.get("task") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/map_marker_response_dto.py b/generated/immich/openapi_client/models/map_marker_response_dto.py index 7ff3880..c88ed0c 100644 --- a/generated/immich/openapi_client/models/map_marker_response_dto.py +++ b/generated/immich/openapi_client/models/map_marker_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,7 @@ class MapMarkerResponseDto(BaseModel): """ # noqa: E501 city: Optional[StrictStr] = Field(description="City name") country: Optional[StrictStr] = Field(description="Country name") - id: UUID = Field(description="Asset ID") + id: Annotated[str, Field(strict=True)] = Field(description="Asset ID") lat: Union[StrictFloat, StrictInt] = Field(description="Latitude") lon: Union[StrictFloat, StrictInt] = Field(description="Longitude") state: Optional[StrictStr] = Field(description="State/Province name") diff --git a/generated/immich/openapi_client/models/memory_create_dto.py b/generated/immich/openapi_client/models/memory_create_dto.py index 50bebc7..de104bd 100644 --- a/generated/immich/openapi_client/models/memory_create_dto.py +++ b/generated/immich/openapi_client/models/memory_create_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.memory_type import MemoryType from generated.immich.openapi_client.models.on_this_day_dto import OnThisDayDto from typing import Optional, Set @@ -30,7 +30,7 @@ class MemoryCreateDto(BaseModel): """ MemoryCreateDto """ # noqa: E501 - asset_ids: Optional[List[UUID]] = Field(default=None, description="Asset IDs to associate with memory", alias="assetIds") + asset_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Asset IDs to associate with memory", alias="assetIds") data: OnThisDayDto hide_at: Optional[datetime] = Field(default=None, description="Date when memory should be hidden", alias="hideAt") is_saved: Optional[StrictBool] = Field(default=None, description="Is memory saved", alias="isSaved") diff --git a/generated/immich/openapi_client/models/memory_response_dto.py b/generated/immich/openapi_client/models/memory_response_dto.py index f8d873d..994bdff 100644 --- a/generated/immich/openapi_client/models/memory_response_dto.py +++ b/generated/immich/openapi_client/models/memory_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto from generated.immich.openapi_client.models.memory_type import MemoryType from generated.immich.openapi_client.models.on_this_day_dto import OnThisDayDto @@ -36,10 +36,10 @@ class MemoryResponseDto(BaseModel): data: OnThisDayDto deleted_at: Optional[datetime] = Field(default=None, description="Deletion date", alias="deletedAt") hide_at: Optional[datetime] = Field(default=None, description="Date when memory should be hidden", alias="hideAt") - id: UUID = Field(description="Memory ID") + id: Annotated[str, Field(strict=True)] = Field(description="Memory ID") is_saved: StrictBool = Field(description="Is memory saved", alias="isSaved") memory_at: datetime = Field(description="Memory date", alias="memoryAt") - owner_id: UUID = Field(description="Owner user ID", alias="ownerId") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner user ID", alias="ownerId") seen_at: Optional[datetime] = Field(default=None, description="Date when memory was seen", alias="seenAt") show_at: Optional[datetime] = Field(default=None, description="Date when memory should be shown", alias="showAt") type: MemoryType diff --git a/generated/immich/openapi_client/models/memory_search_order.py b/generated/immich/openapi_client/models/memory_search_order.py new file mode 100644 index 0000000..074ccd2 --- /dev/null +++ b/generated/immich/openapi_client/models/memory_search_order.py @@ -0,0 +1,38 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class MemorySearchOrder(str, Enum): + """ + Sort order + """ + + """ + allowed enum values + """ + ASC = 'asc' + DESC = 'desc' + RANDOM = 'random' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of MemorySearchOrder from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/memory_statistics_response_dto.py b/generated/immich/openapi_client/models/memory_statistics_response_dto.py new file mode 100644 index 0000000..0e38d9a --- /dev/null +++ b/generated/immich/openapi_client/models/memory_statistics_response_dto.py @@ -0,0 +1,88 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class MemoryStatisticsResponseDto(BaseModel): + """ + MemoryStatisticsResponseDto + """ # noqa: E501 + total: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Total number of memories") + __properties: ClassVar[List[str]] = ["total"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MemoryStatisticsResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MemoryStatisticsResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "total": obj.get("total") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/memory_update_dto.py b/generated/immich/openapi_client/models/memory_update_dto.py index a049cd7..12a0cd1 100644 --- a/generated/immich/openapi_client/models/memory_update_dto.py +++ b/generated/immich/openapi_client/models/memory_update_dto.py @@ -18,7 +18,7 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self diff --git a/generated/immich/openapi_client/models/merge_person_dto.py b/generated/immich/openapi_client/models/merge_person_dto.py index 5902096..35e5ebe 100644 --- a/generated/immich/openapi_client/models/merge_person_dto.py +++ b/generated/immich/openapi_client/models/merge_person_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class MergePersonDto(BaseModel): """ MergePersonDto """ # noqa: E501 - ids: List[UUID] = Field(description="Person IDs to merge") + ids: List[Annotated[str, Field(strict=True)]] = Field(description="Person IDs to merge") __properties: ClassVar[List[str]] = ["ids"] model_config = ConfigDict( diff --git a/generated/immich/openapi_client/models/metadata_search_dto.py b/generated/immich/openapi_client/models/metadata_search_dto.py index ee742e5..7231f22 100644 --- a/generated/immich/openapi_client/models/metadata_search_dto.py +++ b/generated/immich/openapi_client/models/metadata_search_dto.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_order import AssetOrder from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum from generated.immich.openapi_client.models.asset_visibility import AssetVisibility @@ -32,7 +31,7 @@ class MetadataSearchDto(BaseModel): """ MetadataSearchDto """ # noqa: E501 - album_ids: Optional[List[UUID]] = Field(default=None, description="Filter by album IDs", alias="albumIds") + album_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by album IDs", alias="albumIds") checksum: Optional[StrictStr] = Field(default=None, description="Filter by file checksum") city: Optional[StrictStr] = Field(default=None, description="Filter by city name") country: Optional[StrictStr] = Field(default=None, description="Filter by country name") @@ -40,14 +39,14 @@ class MetadataSearchDto(BaseModel): created_before: Optional[datetime] = Field(default=None, description="Filter by creation date (before)", alias="createdBefore") description: Optional[StrictStr] = Field(default=None, description="Filter by description text") encoded_video_path: Optional[StrictStr] = Field(default=None, description="Filter by encoded video file path", alias="encodedVideoPath") - id: Optional[UUID] = Field(default=None, description="Filter by asset ID") + id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Filter by asset ID") is_encoded: Optional[StrictBool] = Field(default=None, description="Filter by encoded status", alias="isEncoded") is_favorite: Optional[StrictBool] = Field(default=None, description="Filter by favorite status", alias="isFavorite") is_motion: Optional[StrictBool] = Field(default=None, description="Filter by motion photo status", alias="isMotion") is_not_in_album: Optional[StrictBool] = Field(default=None, description="Filter assets not in any album", alias="isNotInAlbum") is_offline: Optional[StrictBool] = Field(default=None, description="Filter by offline status", alias="isOffline") lens_model: Optional[StrictStr] = Field(default=None, description="Filter by lens model", alias="lensModel") - library_id: Optional[UUID] = Field(default=None, description="Library ID to filter by", alias="libraryId") + library_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Library ID to filter by", alias="libraryId") make: Optional[StrictStr] = Field(default=None, description="Filter by camera make") model: Optional[StrictStr] = Field(default=None, description="Filter by camera model") ocr: Optional[StrictStr] = Field(default=None, description="Filter by OCR text content") @@ -55,12 +54,12 @@ class MetadataSearchDto(BaseModel): original_file_name: Optional[StrictStr] = Field(default=None, description="Filter by original file name", alias="originalFileName") original_path: Optional[StrictStr] = Field(default=None, description="Filter by original file path", alias="originalPath") page: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]] = Field(default=None, description="Page number") - person_ids: Optional[List[UUID]] = Field(default=None, description="Filter by person IDs", alias="personIds") + person_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by person IDs", alias="personIds") preview_path: Optional[StrictStr] = Field(default=None, description="Filter by preview file path", alias="previewPath") rating: Optional[Annotated[int, Field(le=5, strict=True, ge=1)]] = Field(default=None, description="Filter by rating [1-5], or null for unrated") size: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]] = Field(default=None, description="Number of results to return") state: Optional[StrictStr] = Field(default=None, description="Filter by state/province name") - tag_ids: Optional[List[UUID]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") + tag_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") taken_after: Optional[datetime] = Field(default=None, description="Filter by taken date (after)", alias="takenAfter") taken_before: Optional[datetime] = Field(default=None, description="Filter by taken date (before)", alias="takenBefore") thumbnail_path: Optional[StrictStr] = Field(default=None, description="Filter by thumbnail file path", alias="thumbnailPath") diff --git a/generated/immich/openapi_client/models/mirror_axis.py b/generated/immich/openapi_client/models/mirror_axis.py new file mode 100644 index 0000000..58a4455 --- /dev/null +++ b/generated/immich/openapi_client/models/mirror_axis.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class MirrorAxis(str, Enum): + """ + Axis to mirror along + """ + + """ + allowed enum values + """ + HORIZONTAL = 'horizontal' + VERTICAL = 'vertical' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of MirrorAxis from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/mirror_parameters.py b/generated/immich/openapi_client/models/mirror_parameters.py new file mode 100644 index 0000000..9746695 --- /dev/null +++ b/generated/immich/openapi_client/models/mirror_parameters.py @@ -0,0 +1,88 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.mirror_axis import MirrorAxis +from typing import Optional, Set +from typing_extensions import Self + +class MirrorParameters(BaseModel): + """ + MirrorParameters + """ # noqa: E501 + axis: MirrorAxis + __properties: ClassVar[List[str]] = ["axis"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MirrorParameters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MirrorParameters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "axis": obj.get("axis") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/notification_create_dto.py b/generated/immich/openapi_client/models/notification_create_dto.py new file mode 100644 index 0000000..e1eb2c2 --- /dev/null +++ b/generated/immich/openapi_client/models/notification_create_dto.py @@ -0,0 +1,130 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.notification_level import NotificationLevel +from generated.immich.openapi_client.models.notification_type import NotificationType +from typing import Optional, Set +from typing_extensions import Self + +class NotificationCreateDto(BaseModel): + """ + NotificationCreateDto + """ # noqa: E501 + data: Optional[Dict[str, Any]] = Field(default=None, description="Additional notification data") + description: Optional[StrictStr] = Field(default=None, description="Notification description") + level: Optional[NotificationLevel] = None + read_at: Optional[datetime] = Field(default=None, description="Date when notification was read", alias="readAt") + title: StrictStr = Field(description="Notification title") + type: Optional[NotificationType] = None + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID to send notification to", alias="userId") + __properties: ClassVar[List[str]] = ["data", "description", "level", "readAt", "title", "type", "userId"] + + @field_validator('read_at') + def read_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('user_id') + def user_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationCreateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if read_at (nullable) is None + # and model_fields_set contains the field + if self.read_at is None and "read_at" in self.model_fields_set: + _dict['readAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationCreateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": obj.get("data"), + "description": obj.get("description"), + "level": obj.get("level"), + "readAt": obj.get("readAt"), + "title": obj.get("title"), + "type": obj.get("type"), + "userId": obj.get("userId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/notification_delete_all_dto.py b/generated/immich/openapi_client/models/notification_delete_all_dto.py new file mode 100644 index 0000000..dd3a27c --- /dev/null +++ b/generated/immich/openapi_client/models/notification_delete_all_dto.py @@ -0,0 +1,88 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class NotificationDeleteAllDto(BaseModel): + """ + NotificationDeleteAllDto + """ # noqa: E501 + ids: Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)] = Field(description="Notification IDs to delete") + __properties: ClassVar[List[str]] = ["ids"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationDeleteAllDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationDeleteAllDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ids": obj.get("ids") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/notification_dto.py b/generated/immich/openapi_client/models/notification_dto.py new file mode 100644 index 0000000..95f9c25 --- /dev/null +++ b/generated/immich/openapi_client/models/notification_dto.py @@ -0,0 +1,129 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.notification_level import NotificationLevel +from generated.immich.openapi_client.models.notification_type import NotificationType +from typing import Optional, Set +from typing_extensions import Self + +class NotificationDto(BaseModel): + """ + NotificationDto + """ # noqa: E501 + created_at: datetime = Field(description="Creation date", alias="createdAt") + data: Optional[Dict[str, Any]] = Field(default=None, description="Additional notification data") + description: Optional[StrictStr] = Field(default=None, description="Notification description") + id: Annotated[str, Field(strict=True)] = Field(description="Notification ID") + level: NotificationLevel + read_at: Optional[datetime] = Field(default=None, description="Date when notification was read", alias="readAt") + title: StrictStr = Field(description="Notification title") + type: NotificationType + __properties: ClassVar[List[str]] = ["createdAt", "data", "description", "id", "level", "readAt", "title", "type"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('read_at') + def read_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "data": obj.get("data"), + "description": obj.get("description"), + "id": obj.get("id"), + "level": obj.get("level"), + "readAt": obj.get("readAt"), + "title": obj.get("title"), + "type": obj.get("type") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/notification_level.py b/generated/immich/openapi_client/models/notification_level.py new file mode 100644 index 0000000..123ea23 --- /dev/null +++ b/generated/immich/openapi_client/models/notification_level.py @@ -0,0 +1,39 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class NotificationLevel(str, Enum): + """ + Notification level + """ + + """ + allowed enum values + """ + SUCCESS = 'success' + ERROR = 'error' + WARNING = 'warning' + INFO = 'info' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of NotificationLevel from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/notification_type.py b/generated/immich/openapi_client/models/notification_type.py new file mode 100644 index 0000000..dc7fd2f --- /dev/null +++ b/generated/immich/openapi_client/models/notification_type.py @@ -0,0 +1,41 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class NotificationType(str, Enum): + """ + Notification type + """ + + """ + allowed enum values + """ + JOBFAILED = 'JobFailed' + BACKUPFAILED = 'BackupFailed' + SYSTEMMESSAGE = 'SystemMessage' + ALBUMINVITE = 'AlbumInvite' + ALBUMUPDATE = 'AlbumUpdate' + CUSTOM = 'Custom' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of NotificationType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/notification_update_all_dto.py b/generated/immich/openapi_client/models/notification_update_all_dto.py new file mode 100644 index 0000000..5f1488d --- /dev/null +++ b/generated/immich/openapi_client/models/notification_update_all_dto.py @@ -0,0 +1,106 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class NotificationUpdateAllDto(BaseModel): + """ + NotificationUpdateAllDto + """ # noqa: E501 + ids: Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)] = Field(description="Notification IDs to update") + read_at: Optional[datetime] = Field(default=None, description="Date when notifications were read", alias="readAt") + __properties: ClassVar[List[str]] = ["ids", "readAt"] + + @field_validator('read_at') + def read_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationUpdateAllDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if read_at (nullable) is None + # and model_fields_set contains the field + if self.read_at is None and "read_at" in self.model_fields_set: + _dict['readAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationUpdateAllDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ids": obj.get("ids"), + "readAt": obj.get("readAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/notification_update_dto.py b/generated/immich/openapi_client/models/notification_update_dto.py new file mode 100644 index 0000000..6253d33 --- /dev/null +++ b/generated/immich/openapi_client/models/notification_update_dto.py @@ -0,0 +1,103 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class NotificationUpdateDto(BaseModel): + """ + NotificationUpdateDto + """ # noqa: E501 + read_at: Optional[datetime] = Field(default=None, description="Date when notification was read", alias="readAt") + __properties: ClassVar[List[str]] = ["readAt"] + + @field_validator('read_at') + def read_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationUpdateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if read_at (nullable) is None + # and model_fields_set contains the field + if self.read_at is None and "read_at" in self.model_fields_set: + _dict['readAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationUpdateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "readAt": obj.get("readAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/o_auth_token_endpoint_auth_method.py b/generated/immich/openapi_client/models/o_auth_token_endpoint_auth_method.py new file mode 100644 index 0000000..8c112fc --- /dev/null +++ b/generated/immich/openapi_client/models/o_auth_token_endpoint_auth_method.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class OAuthTokenEndpointAuthMethod(str, Enum): + """ + OAuth token endpoint auth method + """ + + """ + allowed enum values + """ + CLIENT_SECRET_POST = 'client_secret_post' + CLIENT_SECRET_BASIC = 'client_secret_basic' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of OAuthTokenEndpointAuthMethod from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/ocr_config.py b/generated/immich/openapi_client/models/ocr_config.py new file mode 100644 index 0000000..ae0930c --- /dev/null +++ b/generated/immich/openapi_client/models/ocr_config.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class OcrConfig(BaseModel): + """ + OcrConfig + """ # noqa: E501 + enabled: StrictBool = Field(description="Whether the task is enabled") + max_resolution: Annotated[int, Field(le=9007199254740991, strict=True, ge=1)] = Field(description="Maximum resolution for OCR processing", alias="maxResolution") + min_detection_score: Union[Annotated[float, Field(le=1, strict=True, ge=0.1)], Annotated[int, Field(le=1, strict=True, ge=1)]] = Field(description="Minimum confidence score for text detection", alias="minDetectionScore") + min_recognition_score: Union[Annotated[float, Field(le=1, strict=True, ge=0.1)], Annotated[int, Field(le=1, strict=True, ge=1)]] = Field(description="Minimum confidence score for text recognition", alias="minRecognitionScore") + model_name: StrictStr = Field(description="Name of the model to use", alias="modelName") + __properties: ClassVar[List[str]] = ["enabled", "maxResolution", "minDetectionScore", "minRecognitionScore", "modelName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OcrConfig from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OcrConfig from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "enabled": obj.get("enabled"), + "maxResolution": obj.get("maxResolution"), + "minDetectionScore": obj.get("minDetectionScore"), + "minRecognitionScore": obj.get("minRecognitionScore"), + "modelName": obj.get("modelName") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/onboarding_dto.py b/generated/immich/openapi_client/models/onboarding_dto.py new file mode 100644 index 0000000..9e98909 --- /dev/null +++ b/generated/immich/openapi_client/models/onboarding_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class OnboardingDto(BaseModel): + """ + OnboardingDto + """ # noqa: E501 + is_onboarded: StrictBool = Field(description="Is user onboarded", alias="isOnboarded") + __properties: ClassVar[List[str]] = ["isOnboarded"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OnboardingDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OnboardingDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isOnboarded": obj.get("isOnboarded") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/onboarding_response_dto.py b/generated/immich/openapi_client/models/onboarding_response_dto.py new file mode 100644 index 0000000..ed75e86 --- /dev/null +++ b/generated/immich/openapi_client/models/onboarding_response_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class OnboardingResponseDto(BaseModel): + """ + OnboardingResponseDto + """ # noqa: E501 + is_onboarded: StrictBool = Field(description="Is user onboarded", alias="isOnboarded") + __properties: ClassVar[List[str]] = ["isOnboarded"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OnboardingResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OnboardingResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isOnboarded": obj.get("isOnboarded") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/partner_create_dto.py b/generated/immich/openapi_client/models/partner_create_dto.py new file mode 100644 index 0000000..4c84cee --- /dev/null +++ b/generated/immich/openapi_client/models/partner_create_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class PartnerCreateDto(BaseModel): + """ + PartnerCreateDto + """ # noqa: E501 + shared_with_id: Annotated[str, Field(strict=True)] = Field(description="User ID to share with", alias="sharedWithId") + __properties: ClassVar[List[str]] = ["sharedWithId"] + + @field_validator('shared_with_id') + def shared_with_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PartnerCreateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PartnerCreateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sharedWithId": obj.get("sharedWithId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/partner_response_dto.py b/generated/immich/openapi_client/models/partner_response_dto.py index 8f209c2..1b8f206 100644 --- a/generated/immich/openapi_client/models/partner_response_dto.py +++ b/generated/immich/openapi_client/models/partner_response_dto.py @@ -21,7 +21,6 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor from typing import Optional, Set from typing_extensions import Self @@ -32,7 +31,7 @@ class PartnerResponseDto(BaseModel): """ # noqa: E501 avatar_color: UserAvatarColor = Field(alias="avatarColor") email: Annotated[str, Field(strict=True)] = Field(description="User email") - id: UUID = Field(description="User ID") + id: Annotated[str, Field(strict=True)] = Field(description="User ID") in_timeline: Optional[StrictBool] = Field(default=None, description="Show in timeline", alias="inTimeline") name: StrictStr = Field(description="User name") profile_changed_at: datetime = Field(description="Profile change date", alias="profileChangedAt") diff --git a/generated/immich/openapi_client/models/partner_update_dto.py b/generated/immich/openapi_client/models/partner_update_dto.py new file mode 100644 index 0000000..0a2abbe --- /dev/null +++ b/generated/immich/openapi_client/models/partner_update_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class PartnerUpdateDto(BaseModel): + """ + PartnerUpdateDto + """ # noqa: E501 + in_timeline: StrictBool = Field(description="Show partner assets in timeline", alias="inTimeline") + __properties: ClassVar[List[str]] = ["inTimeline"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PartnerUpdateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PartnerUpdateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "inTimeline": obj.get("inTimeline") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/people_update_item.py b/generated/immich/openapi_client/models/people_update_item.py index 97c5482..4934e10 100644 --- a/generated/immich/openapi_client/models/people_update_item.py +++ b/generated/immich/openapi_client/models/people_update_item.py @@ -21,7 +21,6 @@ from datetime import date from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -31,8 +30,8 @@ class PeopleUpdateItem(BaseModel): """ # noqa: E501 birth_date: Optional[date] = Field(default=None, description="Person date of birth", alias="birthDate") color: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Person color (hex)") - feature_face_asset_id: Optional[UUID] = Field(default=None, description="Asset ID used for feature face thumbnail", alias="featureFaceAssetId") - id: UUID = Field(description="Person ID") + feature_face_asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Asset ID used for feature face thumbnail", alias="featureFaceAssetId") + id: Annotated[str, Field(strict=True)] = Field(description="Person ID") is_favorite: Optional[StrictBool] = Field(default=None, description="Mark as favorite", alias="isFavorite") is_hidden: Optional[StrictBool] = Field(default=None, description="Person visibility (hidden)", alias="isHidden") name: Optional[StrictStr] = Field(default=None, description="Person name") diff --git a/generated/immich/openapi_client/models/person_response_dto.py b/generated/immich/openapi_client/models/person_response_dto.py index e182d7e..ecb66bd 100644 --- a/generated/immich/openapi_client/models/person_response_dto.py +++ b/generated/immich/openapi_client/models/person_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import date, datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,7 @@ class PersonResponseDto(BaseModel): """ # noqa: E501 birth_date: Optional[date] = Field(description="Person date of birth", alias="birthDate") color: Optional[StrictStr] = Field(default=None, description="Person color (hex)") - id: UUID = Field(description="Person ID") + id: Annotated[str, Field(strict=True)] = Field(description="Person ID") is_favorite: Optional[StrictBool] = Field(default=None, description="Is favorite", alias="isFavorite") is_hidden: StrictBool = Field(description="Is hidden", alias="isHidden") name: StrictStr = Field(description="Person name") diff --git a/generated/immich/openapi_client/models/person_update_dto.py b/generated/immich/openapi_client/models/person_update_dto.py index db9b76a..d6980ed 100644 --- a/generated/immich/openapi_client/models/person_update_dto.py +++ b/generated/immich/openapi_client/models/person_update_dto.py @@ -21,7 +21,6 @@ from datetime import date from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -31,7 +30,7 @@ class PersonUpdateDto(BaseModel): """ # noqa: E501 birth_date: Optional[date] = Field(default=None, description="Person date of birth", alias="birthDate") color: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Person color (hex)") - feature_face_asset_id: Optional[UUID] = Field(default=None, description="Asset ID used for feature face thumbnail", alias="featureFaceAssetId") + feature_face_asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Asset ID used for feature face thumbnail", alias="featureFaceAssetId") is_favorite: Optional[StrictBool] = Field(default=None, description="Mark as favorite", alias="isFavorite") is_hidden: Optional[StrictBool] = Field(default=None, description="Person visibility (hidden)", alias="isHidden") name: Optional[StrictStr] = Field(default=None, description="Person name") diff --git a/generated/immich/openapi_client/models/pin_code_change_dto.py b/generated/immich/openapi_client/models/pin_code_change_dto.py new file mode 100644 index 0000000..6c1c42a --- /dev/null +++ b/generated/immich/openapi_client/models/pin_code_change_dto.py @@ -0,0 +1,109 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class PinCodeChangeDto(BaseModel): + """ + PinCodeChangeDto + """ # noqa: E501 + new_pin_code: Annotated[str, Field(strict=True)] = Field(description="New PIN code (4-6 digits)", alias="newPinCode") + password: Optional[StrictStr] = Field(default=None, description="User password (required if PIN code is not provided)") + pin_code: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="New PIN code (4-6 digits)", alias="pinCode") + __properties: ClassVar[List[str]] = ["newPinCode", "password", "pinCode"] + + @field_validator('new_pin_code') + def new_pin_code_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^\d{6}$", value): + raise ValueError(r"must validate the regular expression /^\d{6}$/") + return value + + @field_validator('pin_code') + def pin_code_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^\d{6}$", value): + raise ValueError(r"must validate the regular expression /^\d{6}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PinCodeChangeDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PinCodeChangeDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "newPinCode": obj.get("newPinCode"), + "password": obj.get("password"), + "pinCode": obj.get("pinCode") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/pin_code_reset_dto.py b/generated/immich/openapi_client/models/pin_code_reset_dto.py new file mode 100644 index 0000000..416023c --- /dev/null +++ b/generated/immich/openapi_client/models/pin_code_reset_dto.py @@ -0,0 +1,100 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class PinCodeResetDto(BaseModel): + """ + PinCodeResetDto + """ # noqa: E501 + password: Optional[StrictStr] = Field(default=None, description="User password (required if PIN code is not provided)") + pin_code: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="New PIN code (4-6 digits)", alias="pinCode") + __properties: ClassVar[List[str]] = ["password", "pinCode"] + + @field_validator('pin_code') + def pin_code_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^\d{6}$", value): + raise ValueError(r"must validate the regular expression /^\d{6}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PinCodeResetDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PinCodeResetDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "password": obj.get("password"), + "pinCode": obj.get("pinCode") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/pin_code_setup_dto.py b/generated/immich/openapi_client/models/pin_code_setup_dto.py new file mode 100644 index 0000000..110b67e --- /dev/null +++ b/generated/immich/openapi_client/models/pin_code_setup_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class PinCodeSetupDto(BaseModel): + """ + PinCodeSetupDto + """ # noqa: E501 + pin_code: Annotated[str, Field(strict=True)] = Field(description="PIN code (4-6 digits)", alias="pinCode") + __properties: ClassVar[List[str]] = ["pinCode"] + + @field_validator('pin_code') + def pin_code_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^\d{6}$", value): + raise ValueError(r"must validate the regular expression /^\d{6}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PinCodeSetupDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PinCodeSetupDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pinCode": obj.get("pinCode") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/plugin_method_response_dto.py b/generated/immich/openapi_client/models/plugin_method_response_dto.py new file mode 100644 index 0000000..1e99eba --- /dev/null +++ b/generated/immich/openapi_client/models/plugin_method_response_dto.py @@ -0,0 +1,102 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.workflow_type import WorkflowType +from typing import Optional, Set +from typing_extensions import Self + +class PluginMethodResponseDto(BaseModel): + """ + PluginMethodResponseDto + """ # noqa: E501 + description: StrictStr = Field(description="Description") + host_functions: StrictBool = Field(alias="hostFunctions") + key: StrictStr = Field(description="Key") + name: StrictStr = Field(description="Name") + var_schema: Optional[Dict[str, Any]] = Field(default=None, alias="schema") + title: StrictStr = Field(description="Title") + types: List[WorkflowType] = Field(description="Workflow types") + ui_hints: List[StrictStr] = Field(description="Ui hints", alias="uiHints") + __properties: ClassVar[List[str]] = ["description", "hostFunctions", "key", "name", "schema", "title", "types", "uiHints"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PluginMethodResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PluginMethodResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "hostFunctions": obj.get("hostFunctions"), + "key": obj.get("key"), + "name": obj.get("name"), + "schema": obj.get("schema"), + "title": obj.get("title"), + "types": obj.get("types"), + "uiHints": obj.get("uiHints") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/plugin_response_dto.py b/generated/immich/openapi_client/models/plugin_response_dto.py new file mode 100644 index 0000000..06fba3f --- /dev/null +++ b/generated/immich/openapi_client/models/plugin_response_dto.py @@ -0,0 +1,119 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.plugin_method_response_dto import PluginMethodResponseDto +from typing import Optional, Set +from typing_extensions import Self + +class PluginResponseDto(BaseModel): + """ + PluginResponseDto + """ # noqa: E501 + author: StrictStr = Field(description="Plugin author") + created_at: StrictStr = Field(description="Creation date", alias="createdAt") + description: StrictStr = Field(description="Plugin description") + id: Annotated[str, Field(strict=True)] = Field(description="Plugin ID") + methods: List[PluginMethodResponseDto] = Field(description="Plugin methods") + name: StrictStr = Field(description="Plugin name") + title: StrictStr = Field(description="Plugin title") + updated_at: StrictStr = Field(description="Last update date", alias="updatedAt") + version: StrictStr = Field(description="Plugin version") + __properties: ClassVar[List[str]] = ["author", "createdAt", "description", "id", "methods", "name", "title", "updatedAt", "version"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PluginResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in methods (list) + _items = [] + if self.methods: + for _item_methods in self.methods: + if _item_methods: + _items.append(_item_methods.to_dict()) + _dict['methods'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PluginResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "author": obj.get("author"), + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "id": obj.get("id"), + "methods": [PluginMethodResponseDto.from_dict(_item) for _item in obj["methods"]] if obj.get("methods") is not None else None, + "name": obj.get("name"), + "title": obj.get("title"), + "updatedAt": obj.get("updatedAt"), + "version": obj.get("version") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/plugin_template_response_dto.py b/generated/immich/openapi_client/models/plugin_template_response_dto.py new file mode 100644 index 0000000..f18439e --- /dev/null +++ b/generated/immich/openapi_client/models/plugin_template_response_dto.py @@ -0,0 +1,106 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.plugin_template_step_response_dto import PluginTemplateStepResponseDto +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from typing import Optional, Set +from typing_extensions import Self + +class PluginTemplateResponseDto(BaseModel): + """ + PluginTemplateResponseDto + """ # noqa: E501 + description: StrictStr = Field(description="Template description") + key: StrictStr = Field(description="Template key (unique across all templates)") + steps: List[PluginTemplateStepResponseDto] = Field(description="Workflow steps") + title: StrictStr = Field(description="Template title") + trigger: WorkflowTrigger + ui_hints: List[StrictStr] = Field(description="Ui hints, for example \"smart-album\"", alias="uiHints") + __properties: ClassVar[List[str]] = ["description", "key", "steps", "title", "trigger", "uiHints"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PluginTemplateResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in steps (list) + _items = [] + if self.steps: + for _item_steps in self.steps: + if _item_steps: + _items.append(_item_steps.to_dict()) + _dict['steps'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PluginTemplateResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "key": obj.get("key"), + "steps": [PluginTemplateStepResponseDto.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None, + "title": obj.get("title"), + "trigger": obj.get("trigger"), + "uiHints": obj.get("uiHints") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/plugin_template_step_response_dto.py b/generated/immich/openapi_client/models/plugin_template_step_response_dto.py new file mode 100644 index 0000000..784ad8b --- /dev/null +++ b/generated/immich/openapi_client/models/plugin_template_step_response_dto.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PluginTemplateStepResponseDto(BaseModel): + """ + PluginTemplateStepResponseDto + """ # noqa: E501 + config: Optional[Dict[str, Any]] = Field(description="Step configuration") + enabled: Optional[StrictBool] = Field(default=None, description="Whether the step is enabled") + method: StrictStr = Field(description="Step plugin method") + __properties: ClassVar[List[str]] = ["config", "enabled", "method"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PluginTemplateStepResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if config (nullable) is None + # and model_fields_set contains the field + if self.config is None and "config" in self.model_fields_set: + _dict['config'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PluginTemplateStepResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": obj.get("config"), + "enabled": obj.get("enabled"), + "method": obj.get("method") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_command.py b/generated/immich/openapi_client/models/queue_command.py new file mode 100644 index 0000000..48eb49e --- /dev/null +++ b/generated/immich/openapi_client/models/queue_command.py @@ -0,0 +1,40 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueueCommand(str, Enum): + """ + Queue command to execute + """ + + """ + allowed enum values + """ + START = 'start' + PAUSE = 'pause' + RESUME = 'resume' + EMPTY = 'empty' + CLEAR_MINUS_FAILED = 'clear-failed' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueueCommand from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/queue_command_dto.py b/generated/immich/openapi_client/models/queue_command_dto.py new file mode 100644 index 0000000..6c93871 --- /dev/null +++ b/generated/immich/openapi_client/models/queue_command_dto.py @@ -0,0 +1,90 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.queue_command import QueueCommand +from typing import Optional, Set +from typing_extensions import Self + +class QueueCommandDto(BaseModel): + """ + QueueCommandDto + """ # noqa: E501 + command: QueueCommand + force: Optional[StrictBool] = Field(default=None, description="Force the command execution (if applicable)") + __properties: ClassVar[List[str]] = ["command", "force"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueCommandDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueCommandDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "command": obj.get("command"), + "force": obj.get("force") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_delete_dto.py b/generated/immich/openapi_client/models/queue_delete_dto.py new file mode 100644 index 0000000..1a8dc5a --- /dev/null +++ b/generated/immich/openapi_client/models/queue_delete_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class QueueDeleteDto(BaseModel): + """ + QueueDeleteDto + """ # noqa: E501 + failed: Optional[StrictBool] = Field(default=None, description="If true, will also remove failed jobs from the queue.") + __properties: ClassVar[List[str]] = ["failed"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueDeleteDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueDeleteDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "failed": obj.get("failed") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_job_response_dto.py b/generated/immich/openapi_client/models/queue_job_response_dto.py new file mode 100644 index 0000000..6ddd944 --- /dev/null +++ b/generated/immich/openapi_client/models/queue_job_response_dto.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.job_name import JobName +from typing import Optional, Set +from typing_extensions import Self + +class QueueJobResponseDto(BaseModel): + """ + QueueJobResponseDto + """ # noqa: E501 + data: Dict[str, Any] = Field(description="Job data payload") + id: Optional[StrictStr] = Field(default=None, description="Job ID") + name: JobName + timestamp: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Job creation timestamp") + __properties: ClassVar[List[str]] = ["data", "id", "name", "timestamp"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueJobResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueJobResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": obj.get("data"), + "id": obj.get("id"), + "name": obj.get("name"), + "timestamp": obj.get("timestamp") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_job_status.py b/generated/immich/openapi_client/models/queue_job_status.py new file mode 100644 index 0000000..561a967 --- /dev/null +++ b/generated/immich/openapi_client/models/queue_job_status.py @@ -0,0 +1,41 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueueJobStatus(str, Enum): + """ + Queue job status + """ + + """ + allowed enum values + """ + ACTIVE = 'active' + FAILED = 'failed' + COMPLETED = 'completed' + DELAYED = 'delayed' + WAITING = 'waiting' + PAUSED = 'paused' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueueJobStatus from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/queue_name.py b/generated/immich/openapi_client/models/queue_name.py new file mode 100644 index 0000000..ab58f20 --- /dev/null +++ b/generated/immich/openapi_client/models/queue_name.py @@ -0,0 +1,54 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueueName(str, Enum): + """ + Queue name + """ + + """ + allowed enum values + """ + THUMBNAILGENERATION = 'thumbnailGeneration' + METADATAEXTRACTION = 'metadataExtraction' + VIDEOCONVERSION = 'videoConversion' + FACEDETECTION = 'faceDetection' + FACIALRECOGNITION = 'facialRecognition' + SMARTSEARCH = 'smartSearch' + DUPLICATEDETECTION = 'duplicateDetection' + BACKGROUNDTASK = 'backgroundTask' + STORAGETEMPLATEMIGRATION = 'storageTemplateMigration' + MIGRATION = 'migration' + SEARCH = 'search' + SIDECAR = 'sidecar' + LIBRARY = 'library' + NOTIFICATIONS = 'notifications' + BACKUPDATABASE = 'backupDatabase' + OCR = 'ocr' + WORKFLOW = 'workflow' + INTEGRITYCHECK = 'integrityCheck' + EDITOR = 'editor' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueueName from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/queue_response_dto.py b/generated/immich/openapi_client/models/queue_response_dto.py new file mode 100644 index 0000000..19bb5c0 --- /dev/null +++ b/generated/immich/openapi_client/models/queue_response_dto.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.queue_name import QueueName +from generated.immich.openapi_client.models.queue_statistics_dto import QueueStatisticsDto +from typing import Optional, Set +from typing_extensions import Self + +class QueueResponseDto(BaseModel): + """ + QueueResponseDto + """ # noqa: E501 + is_paused: StrictBool = Field(description="Whether the queue is paused", alias="isPaused") + name: QueueName + statistics: QueueStatisticsDto + __properties: ClassVar[List[str]] = ["isPaused", "name", "statistics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of statistics + if self.statistics: + _dict['statistics'] = self.statistics.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isPaused": obj.get("isPaused"), + "name": obj.get("name"), + "statistics": QueueStatisticsDto.from_dict(obj["statistics"]) if obj.get("statistics") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_response_legacy_dto.py b/generated/immich/openapi_client/models/queue_response_legacy_dto.py new file mode 100644 index 0000000..e51113b --- /dev/null +++ b/generated/immich/openapi_client/models/queue_response_legacy_dto.py @@ -0,0 +1,97 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.queue_statistics_dto import QueueStatisticsDto +from generated.immich.openapi_client.models.queue_status_legacy_dto import QueueStatusLegacyDto +from typing import Optional, Set +from typing_extensions import Self + +class QueueResponseLegacyDto(BaseModel): + """ + QueueResponseLegacyDto + """ # noqa: E501 + job_counts: QueueStatisticsDto = Field(alias="jobCounts") + queue_status: QueueStatusLegacyDto = Field(alias="queueStatus") + __properties: ClassVar[List[str]] = ["jobCounts", "queueStatus"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueResponseLegacyDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of job_counts + if self.job_counts: + _dict['jobCounts'] = self.job_counts.to_dict() + # override the default output from pydantic by calling `to_dict()` of queue_status + if self.queue_status: + _dict['queueStatus'] = self.queue_status.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueResponseLegacyDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobCounts": QueueStatisticsDto.from_dict(obj["jobCounts"]) if obj.get("jobCounts") is not None else None, + "queueStatus": QueueStatusLegacyDto.from_dict(obj["queueStatus"]) if obj.get("queueStatus") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_statistics_dto.py b/generated/immich/openapi_client/models/queue_statistics_dto.py new file mode 100644 index 0000000..6d5467d --- /dev/null +++ b/generated/immich/openapi_client/models/queue_statistics_dto.py @@ -0,0 +1,98 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class QueueStatisticsDto(BaseModel): + """ + QueueStatisticsDto + """ # noqa: E501 + active: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of active jobs") + completed: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of completed jobs") + delayed: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of delayed jobs") + failed: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of failed jobs") + paused: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of paused jobs") + waiting: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of waiting jobs") + __properties: ClassVar[List[str]] = ["active", "completed", "delayed", "failed", "paused", "waiting"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueStatisticsDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueStatisticsDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "active": obj.get("active"), + "completed": obj.get("completed"), + "delayed": obj.get("delayed"), + "failed": obj.get("failed"), + "paused": obj.get("paused"), + "waiting": obj.get("waiting") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_status_legacy_dto.py b/generated/immich/openapi_client/models/queue_status_legacy_dto.py new file mode 100644 index 0000000..4dbf5ea --- /dev/null +++ b/generated/immich/openapi_client/models/queue_status_legacy_dto.py @@ -0,0 +1,89 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class QueueStatusLegacyDto(BaseModel): + """ + QueueStatusLegacyDto + """ # noqa: E501 + is_active: StrictBool = Field(description="Whether the queue is currently active (has running jobs)", alias="isActive") + is_paused: StrictBool = Field(description="Whether the queue is paused", alias="isPaused") + __properties: ClassVar[List[str]] = ["isActive", "isPaused"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueStatusLegacyDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueStatusLegacyDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isActive": obj.get("isActive"), + "isPaused": obj.get("isPaused") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queue_update_dto.py b/generated/immich/openapi_client/models/queue_update_dto.py new file mode 100644 index 0000000..0784ff3 --- /dev/null +++ b/generated/immich/openapi_client/models/queue_update_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class QueueUpdateDto(BaseModel): + """ + QueueUpdateDto + """ # noqa: E501 + is_paused: Optional[StrictBool] = Field(default=None, description="Whether to pause the queue", alias="isPaused") + __properties: ClassVar[List[str]] = ["isPaused"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueueUpdateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueueUpdateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isPaused": obj.get("isPaused") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/queues_response_legacy_dto.py b/generated/immich/openapi_client/models/queues_response_legacy_dto.py new file mode 100644 index 0000000..9753644 --- /dev/null +++ b/generated/immich/openapi_client/models/queues_response_legacy_dto.py @@ -0,0 +1,181 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto +from typing import Optional, Set +from typing_extensions import Self + +class QueuesResponseLegacyDto(BaseModel): + """ + QueuesResponseLegacyDto + """ # noqa: E501 + background_task: QueueResponseLegacyDto = Field(alias="backgroundTask") + backup_database: QueueResponseLegacyDto = Field(alias="backupDatabase") + duplicate_detection: QueueResponseLegacyDto = Field(alias="duplicateDetection") + editor: QueueResponseLegacyDto + face_detection: QueueResponseLegacyDto = Field(alias="faceDetection") + facial_recognition: QueueResponseLegacyDto = Field(alias="facialRecognition") + integrity_check: QueueResponseLegacyDto = Field(alias="integrityCheck") + library: QueueResponseLegacyDto + metadata_extraction: QueueResponseLegacyDto = Field(alias="metadataExtraction") + migration: QueueResponseLegacyDto + notifications: QueueResponseLegacyDto + ocr: QueueResponseLegacyDto + search: QueueResponseLegacyDto + sidecar: QueueResponseLegacyDto + smart_search: QueueResponseLegacyDto = Field(alias="smartSearch") + storage_template_migration: QueueResponseLegacyDto = Field(alias="storageTemplateMigration") + thumbnail_generation: QueueResponseLegacyDto = Field(alias="thumbnailGeneration") + video_conversion: QueueResponseLegacyDto = Field(alias="videoConversion") + workflow: QueueResponseLegacyDto + __properties: ClassVar[List[str]] = ["backgroundTask", "backupDatabase", "duplicateDetection", "editor", "faceDetection", "facialRecognition", "integrityCheck", "library", "metadataExtraction", "migration", "notifications", "ocr", "search", "sidecar", "smartSearch", "storageTemplateMigration", "thumbnailGeneration", "videoConversion", "workflow"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueuesResponseLegacyDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of background_task + if self.background_task: + _dict['backgroundTask'] = self.background_task.to_dict() + # override the default output from pydantic by calling `to_dict()` of backup_database + if self.backup_database: + _dict['backupDatabase'] = self.backup_database.to_dict() + # override the default output from pydantic by calling `to_dict()` of duplicate_detection + if self.duplicate_detection: + _dict['duplicateDetection'] = self.duplicate_detection.to_dict() + # override the default output from pydantic by calling `to_dict()` of editor + if self.editor: + _dict['editor'] = self.editor.to_dict() + # override the default output from pydantic by calling `to_dict()` of face_detection + if self.face_detection: + _dict['faceDetection'] = self.face_detection.to_dict() + # override the default output from pydantic by calling `to_dict()` of facial_recognition + if self.facial_recognition: + _dict['facialRecognition'] = self.facial_recognition.to_dict() + # override the default output from pydantic by calling `to_dict()` of integrity_check + if self.integrity_check: + _dict['integrityCheck'] = self.integrity_check.to_dict() + # override the default output from pydantic by calling `to_dict()` of library + if self.library: + _dict['library'] = self.library.to_dict() + # override the default output from pydantic by calling `to_dict()` of metadata_extraction + if self.metadata_extraction: + _dict['metadataExtraction'] = self.metadata_extraction.to_dict() + # override the default output from pydantic by calling `to_dict()` of migration + if self.migration: + _dict['migration'] = self.migration.to_dict() + # override the default output from pydantic by calling `to_dict()` of notifications + if self.notifications: + _dict['notifications'] = self.notifications.to_dict() + # override the default output from pydantic by calling `to_dict()` of ocr + if self.ocr: + _dict['ocr'] = self.ocr.to_dict() + # override the default output from pydantic by calling `to_dict()` of search + if self.search: + _dict['search'] = self.search.to_dict() + # override the default output from pydantic by calling `to_dict()` of sidecar + if self.sidecar: + _dict['sidecar'] = self.sidecar.to_dict() + # override the default output from pydantic by calling `to_dict()` of smart_search + if self.smart_search: + _dict['smartSearch'] = self.smart_search.to_dict() + # override the default output from pydantic by calling `to_dict()` of storage_template_migration + if self.storage_template_migration: + _dict['storageTemplateMigration'] = self.storage_template_migration.to_dict() + # override the default output from pydantic by calling `to_dict()` of thumbnail_generation + if self.thumbnail_generation: + _dict['thumbnailGeneration'] = self.thumbnail_generation.to_dict() + # override the default output from pydantic by calling `to_dict()` of video_conversion + if self.video_conversion: + _dict['videoConversion'] = self.video_conversion.to_dict() + # override the default output from pydantic by calling `to_dict()` of workflow + if self.workflow: + _dict['workflow'] = self.workflow.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueuesResponseLegacyDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "backgroundTask": QueueResponseLegacyDto.from_dict(obj["backgroundTask"]) if obj.get("backgroundTask") is not None else None, + "backupDatabase": QueueResponseLegacyDto.from_dict(obj["backupDatabase"]) if obj.get("backupDatabase") is not None else None, + "duplicateDetection": QueueResponseLegacyDto.from_dict(obj["duplicateDetection"]) if obj.get("duplicateDetection") is not None else None, + "editor": QueueResponseLegacyDto.from_dict(obj["editor"]) if obj.get("editor") is not None else None, + "faceDetection": QueueResponseLegacyDto.from_dict(obj["faceDetection"]) if obj.get("faceDetection") is not None else None, + "facialRecognition": QueueResponseLegacyDto.from_dict(obj["facialRecognition"]) if obj.get("facialRecognition") is not None else None, + "integrityCheck": QueueResponseLegacyDto.from_dict(obj["integrityCheck"]) if obj.get("integrityCheck") is not None else None, + "library": QueueResponseLegacyDto.from_dict(obj["library"]) if obj.get("library") is not None else None, + "metadataExtraction": QueueResponseLegacyDto.from_dict(obj["metadataExtraction"]) if obj.get("metadataExtraction") is not None else None, + "migration": QueueResponseLegacyDto.from_dict(obj["migration"]) if obj.get("migration") is not None else None, + "notifications": QueueResponseLegacyDto.from_dict(obj["notifications"]) if obj.get("notifications") is not None else None, + "ocr": QueueResponseLegacyDto.from_dict(obj["ocr"]) if obj.get("ocr") is not None else None, + "search": QueueResponseLegacyDto.from_dict(obj["search"]) if obj.get("search") is not None else None, + "sidecar": QueueResponseLegacyDto.from_dict(obj["sidecar"]) if obj.get("sidecar") is not None else None, + "smartSearch": QueueResponseLegacyDto.from_dict(obj["smartSearch"]) if obj.get("smartSearch") is not None else None, + "storageTemplateMigration": QueueResponseLegacyDto.from_dict(obj["storageTemplateMigration"]) if obj.get("storageTemplateMigration") is not None else None, + "thumbnailGeneration": QueueResponseLegacyDto.from_dict(obj["thumbnailGeneration"]) if obj.get("thumbnailGeneration") is not None else None, + "videoConversion": QueueResponseLegacyDto.from_dict(obj["videoConversion"]) if obj.get("videoConversion") is not None else None, + "workflow": QueueResponseLegacyDto.from_dict(obj["workflow"]) if obj.get("workflow") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/random_search_dto.py b/generated/immich/openapi_client/models/random_search_dto.py index adaea94..70920c2 100644 --- a/generated/immich/openapi_client/models/random_search_dto.py +++ b/generated/immich/openapi_client/models/random_search_dto.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum from generated.immich.openapi_client.models.asset_visibility import AssetVisibility from typing import Optional, Set @@ -31,7 +30,7 @@ class RandomSearchDto(BaseModel): """ RandomSearchDto """ # noqa: E501 - album_ids: Optional[List[UUID]] = Field(default=None, description="Filter by album IDs", alias="albumIds") + album_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by album IDs", alias="albumIds") city: Optional[StrictStr] = Field(default=None, description="Filter by city name") country: Optional[StrictStr] = Field(default=None, description="Filter by country name") created_after: Optional[datetime] = Field(default=None, description="Filter by creation date (after)", alias="createdAfter") @@ -42,15 +41,15 @@ class RandomSearchDto(BaseModel): is_not_in_album: Optional[StrictBool] = Field(default=None, description="Filter assets not in any album", alias="isNotInAlbum") is_offline: Optional[StrictBool] = Field(default=None, description="Filter by offline status", alias="isOffline") lens_model: Optional[StrictStr] = Field(default=None, description="Filter by lens model", alias="lensModel") - library_id: Optional[UUID] = Field(default=None, description="Library ID to filter by", alias="libraryId") + library_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Library ID to filter by", alias="libraryId") make: Optional[StrictStr] = Field(default=None, description="Filter by camera make") model: Optional[StrictStr] = Field(default=None, description="Filter by camera model") ocr: Optional[StrictStr] = Field(default=None, description="Filter by OCR text content") - person_ids: Optional[List[UUID]] = Field(default=None, description="Filter by person IDs", alias="personIds") + person_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by person IDs", alias="personIds") rating: Optional[Annotated[int, Field(le=5, strict=True, ge=1)]] = Field(default=None, description="Filter by rating [1-5], or null for unrated") size: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]] = Field(default=None, description="Number of results to return") state: Optional[StrictStr] = Field(default=None, description="Filter by state/province name") - tag_ids: Optional[List[UUID]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") + tag_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") taken_after: Optional[datetime] = Field(default=None, description="Filter by taken date (after)", alias="takenAfter") taken_before: Optional[datetime] = Field(default=None, description="Filter by taken date (before)", alias="takenBefore") trashed_after: Optional[datetime] = Field(default=None, description="Filter by trash date (after)", alias="trashedAfter") diff --git a/generated/immich/openapi_client/models/recently_added_response.py b/generated/immich/openapi_client/models/recently_added_response.py new file mode 100644 index 0000000..63fc158 --- /dev/null +++ b/generated/immich/openapi_client/models/recently_added_response.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RecentlyAddedResponse(BaseModel): + """ + RecentlyAddedResponse + """ # noqa: E501 + sidebar_web: StrictBool = Field(description="Whether the recently added page appears in the web sidebar", alias="sidebarWeb") + __properties: ClassVar[List[str]] = ["sidebarWeb"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RecentlyAddedResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RecentlyAddedResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sidebarWeb": obj.get("sidebarWeb") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/recently_added_update.py b/generated/immich/openapi_client/models/recently_added_update.py new file mode 100644 index 0000000..eeb1cb0 --- /dev/null +++ b/generated/immich/openapi_client/models/recently_added_update.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class RecentlyAddedUpdate(BaseModel): + """ + RecentlyAddedUpdate + """ # noqa: E501 + sidebar_web: Optional[StrictBool] = Field(default=None, description="Whether the recently added page appears in the web sidebar", alias="sidebarWeb") + __properties: ClassVar[List[str]] = ["sidebarWeb"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RecentlyAddedUpdate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RecentlyAddedUpdate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sidebarWeb": obj.get("sidebarWeb") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/release_channel.py b/generated/immich/openapi_client/models/release_channel.py new file mode 100644 index 0000000..52f5869 --- /dev/null +++ b/generated/immich/openapi_client/models/release_channel.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ReleaseChannel(str, Enum): + """ + Release channel + """ + + """ + allowed enum values + """ + STABLE = 'stable' + RELEASECANDIDATE = 'releaseCandidate' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ReleaseChannel from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/release_event_v1.py b/generated/immich/openapi_client/models/release_event_v1.py new file mode 100644 index 0000000..b7a068f --- /dev/null +++ b/generated/immich/openapi_client/models/release_event_v1.py @@ -0,0 +1,103 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.release_type import ReleaseType +from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto +from typing import Optional, Set +from typing_extensions import Self + +class ReleaseEventV1(BaseModel): + """ + ReleaseEventV1 + """ # noqa: E501 + checked_at: StrictStr = Field(description="When the server last checked for a latest version. As an ISO timestamp", alias="checkedAt") + is_available: StrictBool = Field(description="Whether a new version is available", alias="isAvailable") + release_version: ServerVersionResponseDto = Field(alias="releaseVersion") + server_version: ServerVersionResponseDto = Field(alias="serverVersion") + type: ReleaseType + __properties: ClassVar[List[str]] = ["checkedAt", "isAvailable", "releaseVersion", "serverVersion", "type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReleaseEventV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of release_version + if self.release_version: + _dict['releaseVersion'] = self.release_version.to_dict() + # override the default output from pydantic by calling `to_dict()` of server_version + if self.server_version: + _dict['serverVersion'] = self.server_version.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReleaseEventV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "checkedAt": obj.get("checkedAt"), + "isAvailable": obj.get("isAvailable"), + "releaseVersion": ServerVersionResponseDto.from_dict(obj["releaseVersion"]) if obj.get("releaseVersion") is not None else None, + "serverVersion": ServerVersionResponseDto.from_dict(obj["serverVersion"]) if obj.get("serverVersion") is not None else None, + "type": obj.get("type") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/release_type.py b/generated/immich/openapi_client/models/release_type.py new file mode 100644 index 0000000..e5a9630 --- /dev/null +++ b/generated/immich/openapi_client/models/release_type.py @@ -0,0 +1,42 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ReleaseType(str, Enum): + """ + ReleaseType + """ + + """ + allowed enum values + """ + MAJOR = 'major' + PREMAJOR = 'premajor' + MINOR = 'minor' + PREMINOR = 'preminor' + PATCH = 'patch' + PREPATCH = 'prepatch' + PRERELEASE = 'prerelease' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ReleaseType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/rotate_parameters.py b/generated/immich/openapi_client/models/rotate_parameters.py new file mode 100644 index 0000000..7aa4e12 --- /dev/null +++ b/generated/immich/openapi_client/models/rotate_parameters.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Union +from typing import Optional, Set +from typing_extensions import Self + +class RotateParameters(BaseModel): + """ + RotateParameters + """ # noqa: E501 + angle: Union[StrictFloat, StrictInt] = Field(description="Rotation angle in degrees") + __properties: ClassVar[List[str]] = ["angle"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RotateParameters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RotateParameters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "angle": obj.get("angle") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/search_statistics_response_dto.py b/generated/immich/openapi_client/models/search_statistics_response_dto.py new file mode 100644 index 0000000..6e4adbf --- /dev/null +++ b/generated/immich/openapi_client/models/search_statistics_response_dto.py @@ -0,0 +1,88 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SearchStatisticsResponseDto(BaseModel): + """ + SearchStatisticsResponseDto + """ # noqa: E501 + total: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Total number of matching assets") + __properties: ClassVar[List[str]] = ["total"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SearchStatisticsResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SearchStatisticsResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "total": obj.get("total") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/server_apk_links_dto.py b/generated/immich/openapi_client/models/server_apk_links_dto.py new file mode 100644 index 0000000..da80441 --- /dev/null +++ b/generated/immich/openapi_client/models/server_apk_links_dto.py @@ -0,0 +1,93 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ServerApkLinksDto(BaseModel): + """ + ServerApkLinksDto + """ # noqa: E501 + arm64v8a: StrictStr = Field(description="APK download link for ARM64 v8a architecture") + armeabiv7a: StrictStr = Field(description="APK download link for ARM EABI v7a architecture") + universal: StrictStr = Field(description="APK download link for universal architecture") + x86_64: StrictStr = Field(description="APK download link for x86_64 architecture") + __properties: ClassVar[List[str]] = ["arm64v8a", "armeabiv7a", "universal", "x86_64"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServerApkLinksDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServerApkLinksDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "arm64v8a": obj.get("arm64v8a"), + "armeabiv7a": obj.get("armeabiv7a"), + "universal": obj.get("universal"), + "x86_64": obj.get("x86_64") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/server_version_history_response_dto.py b/generated/immich/openapi_client/models/server_version_history_response_dto.py index a14b050..190c8f5 100644 --- a/generated/immich/openapi_client/models/server_version_history_response_dto.py +++ b/generated/immich/openapi_client/models/server_version_history_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,7 @@ class ServerVersionHistoryResponseDto(BaseModel): ServerVersionHistoryResponseDto """ # noqa: E501 created_at: datetime = Field(description="When this version was first seen", alias="createdAt") - id: UUID = Field(description="Version history entry ID") + id: Annotated[str, Field(strict=True)] = Field(description="Version history entry ID") version: StrictStr = Field(description="Version string") __properties: ClassVar[List[str]] = ["createdAt", "id", "version"] diff --git a/generated/immich/openapi_client/models/session_create_dto.py b/generated/immich/openapi_client/models/session_create_dto.py new file mode 100644 index 0000000..b3b7072 --- /dev/null +++ b/generated/immich/openapi_client/models/session_create_dto.py @@ -0,0 +1,92 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SessionCreateDto(BaseModel): + """ + SessionCreateDto + """ # noqa: E501 + device_os: Optional[StrictStr] = Field(default=None, description="Device OS", alias="deviceOS") + device_type: Optional[StrictStr] = Field(default=None, description="Device type", alias="deviceType") + duration: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]] = Field(default=None, description="Session duration in seconds") + __properties: ClassVar[List[str]] = ["deviceOS", "deviceType", "duration"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SessionCreateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SessionCreateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "deviceOS": obj.get("deviceOS"), + "deviceType": obj.get("deviceType"), + "duration": obj.get("duration") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/session_create_response_dto.py b/generated/immich/openapi_client/models/session_create_response_dto.py new file mode 100644 index 0000000..0805867 --- /dev/null +++ b/generated/immich/openapi_client/models/session_create_response_dto.py @@ -0,0 +1,118 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SessionCreateResponseDto(BaseModel): + """ + SessionCreateResponseDto + """ # noqa: E501 + app_version: Optional[StrictStr] = Field(description="App version", alias="appVersion") + created_at: StrictStr = Field(description="Creation date", alias="createdAt") + current: StrictBool = Field(description="Is current session") + device_os: StrictStr = Field(description="Device OS", alias="deviceOS") + device_type: StrictStr = Field(description="Device type", alias="deviceType") + expires_at: Optional[StrictStr] = Field(default=None, description="Expiration date", alias="expiresAt") + id: Annotated[str, Field(strict=True)] = Field(description="Session ID") + is_pending_sync_reset: StrictBool = Field(description="Is pending sync reset", alias="isPendingSyncReset") + token: StrictStr = Field(description="Session token") + updated_at: StrictStr = Field(description="Last update date", alias="updatedAt") + __properties: ClassVar[List[str]] = ["appVersion", "createdAt", "current", "deviceOS", "deviceType", "expiresAt", "id", "isPendingSyncReset", "token", "updatedAt"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SessionCreateResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if app_version (nullable) is None + # and model_fields_set contains the field + if self.app_version is None and "app_version" in self.model_fields_set: + _dict['appVersion'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SessionCreateResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appVersion": obj.get("appVersion"), + "createdAt": obj.get("createdAt"), + "current": obj.get("current"), + "deviceOS": obj.get("deviceOS"), + "deviceType": obj.get("deviceType"), + "expiresAt": obj.get("expiresAt"), + "id": obj.get("id"), + "isPendingSyncReset": obj.get("isPendingSyncReset"), + "token": obj.get("token"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/session_response_dto.py b/generated/immich/openapi_client/models/session_response_dto.py index 242e8e5..7e187ca 100644 --- a/generated/immich/openapi_client/models/session_response_dto.py +++ b/generated/immich/openapi_client/models/session_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -33,7 +33,7 @@ class SessionResponseDto(BaseModel): device_os: StrictStr = Field(description="Device OS", alias="deviceOS") device_type: StrictStr = Field(description="Device type", alias="deviceType") expires_at: Optional[StrictStr] = Field(default=None, description="Expiration date", alias="expiresAt") - id: UUID = Field(description="Session ID") + id: Annotated[str, Field(strict=True)] = Field(description="Session ID") is_pending_sync_reset: StrictBool = Field(description="Is pending sync reset", alias="isPendingSyncReset") updated_at: StrictStr = Field(description="Last update date", alias="updatedAt") __properties: ClassVar[List[str]] = ["appVersion", "createdAt", "current", "deviceOS", "deviceType", "expiresAt", "id", "isPendingSyncReset", "updatedAt"] diff --git a/generated/immich/openapi_client/models/session_unlock_dto.py b/generated/immich/openapi_client/models/session_unlock_dto.py new file mode 100644 index 0000000..60d7c9c --- /dev/null +++ b/generated/immich/openapi_client/models/session_unlock_dto.py @@ -0,0 +1,100 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SessionUnlockDto(BaseModel): + """ + SessionUnlockDto + """ # noqa: E501 + password: Optional[StrictStr] = Field(default=None, description="User password (required if PIN code is not provided)") + pin_code: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="New PIN code (4-6 digits)", alias="pinCode") + __properties: ClassVar[List[str]] = ["password", "pinCode"] + + @field_validator('pin_code') + def pin_code_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^\d{6}$", value): + raise ValueError(r"must validate the regular expression /^\d{6}$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SessionUnlockDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SessionUnlockDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "password": obj.get("password"), + "pinCode": obj.get("pinCode") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/session_update_dto.py b/generated/immich/openapi_client/models/session_update_dto.py new file mode 100644 index 0000000..648ba34 --- /dev/null +++ b/generated/immich/openapi_client/models/session_update_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SessionUpdateDto(BaseModel): + """ + SessionUpdateDto + """ # noqa: E501 + is_pending_sync_reset: Optional[StrictBool] = Field(default=None, description="Reset pending sync state", alias="isPendingSyncReset") + __properties: ClassVar[List[str]] = ["isPendingSyncReset"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SessionUpdateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SessionUpdateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isPendingSyncReset": obj.get("isPendingSyncReset") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/set_maintenance_mode_dto.py b/generated/immich/openapi_client/models/set_maintenance_mode_dto.py new file mode 100644 index 0000000..f4f049f --- /dev/null +++ b/generated/immich/openapi_client/models/set_maintenance_mode_dto.py @@ -0,0 +1,90 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.maintenance_action import MaintenanceAction +from typing import Optional, Set +from typing_extensions import Self + +class SetMaintenanceModeDto(BaseModel): + """ + SetMaintenanceModeDto + """ # noqa: E501 + action: MaintenanceAction + restore_backup_filename: Optional[StrictStr] = Field(default=None, description="Restore backup filename", alias="restoreBackupFilename") + __properties: ClassVar[List[str]] = ["action", "restoreBackupFilename"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SetMaintenanceModeDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SetMaintenanceModeDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "action": obj.get("action"), + "restoreBackupFilename": obj.get("restoreBackupFilename") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/shared_link_create_dto.py b/generated/immich/openapi_client/models/shared_link_create_dto.py index 7453dc4..07ba0be 100644 --- a/generated/immich/openapi_client/models/shared_link_create_dto.py +++ b/generated/immich/openapi_client/models/shared_link_create_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.shared_link_type import SharedLinkType from typing import Optional, Set from typing_extensions import Self @@ -29,10 +29,10 @@ class SharedLinkCreateDto(BaseModel): """ SharedLinkCreateDto """ # noqa: E501 - album_id: Optional[UUID] = Field(default=None, description="Album ID (for album sharing)", alias="albumId") + album_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Album ID (for album sharing)", alias="albumId") allow_download: Optional[StrictBool] = Field(default=True, description="Allow downloads", alias="allowDownload") allow_upload: Optional[StrictBool] = Field(default=None, description="Allow uploads", alias="allowUpload") - asset_ids: Optional[List[UUID]] = Field(default=None, description="Asset IDs (for individual assets)", alias="assetIds") + asset_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Asset IDs (for individual assets)", alias="assetIds") description: Optional[StrictStr] = Field(default=None, description="Link description") expires_at: Optional[datetime] = Field(default=None, description="Expiration date", alias="expiresAt") password: Optional[StrictStr] = Field(default=None, description="Link password") diff --git a/generated/immich/openapi_client/models/shared_link_edit_dto.py b/generated/immich/openapi_client/models/shared_link_edit_dto.py index 5183a82..d96f97b 100644 --- a/generated/immich/openapi_client/models/shared_link_edit_dto.py +++ b/generated/immich/openapi_client/models/shared_link_edit_dto.py @@ -18,7 +18,7 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self diff --git a/generated/immich/openapi_client/models/shared_link_login_dto.py b/generated/immich/openapi_client/models/shared_link_login_dto.py new file mode 100644 index 0000000..23b2ac9 --- /dev/null +++ b/generated/immich/openapi_client/models/shared_link_login_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SharedLinkLoginDto(BaseModel): + """ + SharedLinkLoginDto + """ # noqa: E501 + password: StrictStr = Field(description="Shared link password") + __properties: ClassVar[List[str]] = ["password"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SharedLinkLoginDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SharedLinkLoginDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "password": obj.get("password") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/shared_link_response_dto.py b/generated/immich/openapi_client/models/shared_link_response_dto.py index c493c34..a36424f 100644 --- a/generated/immich/openapi_client/models/shared_link_response_dto.py +++ b/generated/immich/openapi_client/models/shared_link_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto from generated.immich.openapi_client.models.shared_link_type import SharedLinkType @@ -38,13 +38,13 @@ class SharedLinkResponseDto(BaseModel): created_at: datetime = Field(description="Creation date", alias="createdAt") description: Optional[StrictStr] = Field(description="Link description") expires_at: Optional[datetime] = Field(description="Expiration date", alias="expiresAt") - id: UUID = Field(description="Shared link ID") + id: Annotated[str, Field(strict=True)] = Field(description="Shared link ID") key: StrictStr = Field(description="Encryption key (base64url)") password: Optional[StrictStr] = Field(description="Has password") show_metadata: StrictBool = Field(description="Show metadata", alias="showMetadata") slug: Optional[StrictStr] = Field(description="Custom URL slug") type: SharedLinkType - user_id: UUID = Field(description="Owner user ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="Owner user ID", alias="userId") __properties: ClassVar[List[str]] = ["album", "allowDownload", "allowUpload", "assets", "createdAt", "description", "expiresAt", "id", "key", "password", "showMetadata", "slug", "type", "userId"] @field_validator('created_at') diff --git a/generated/immich/openapi_client/models/smart_search_dto.py b/generated/immich/openapi_client/models/smart_search_dto.py index 2914303..592c11a 100644 --- a/generated/immich/openapi_client/models/smart_search_dto.py +++ b/generated/immich/openapi_client/models/smart_search_dto.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum from generated.immich.openapi_client.models.asset_visibility import AssetVisibility from typing import Optional, Set @@ -31,7 +30,7 @@ class SmartSearchDto(BaseModel): """ SmartSearchDto """ # noqa: E501 - album_ids: Optional[List[UUID]] = Field(default=None, description="Filter by album IDs", alias="albumIds") + album_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by album IDs", alias="albumIds") city: Optional[StrictStr] = Field(default=None, description="Filter by city name") country: Optional[StrictStr] = Field(default=None, description="Filter by country name") created_after: Optional[datetime] = Field(default=None, description="Filter by creation date (after)", alias="createdAfter") @@ -43,18 +42,18 @@ class SmartSearchDto(BaseModel): is_offline: Optional[StrictBool] = Field(default=None, description="Filter by offline status", alias="isOffline") language: Optional[StrictStr] = Field(default=None, description="Search language code") lens_model: Optional[StrictStr] = Field(default=None, description="Filter by lens model", alias="lensModel") - library_id: Optional[UUID] = Field(default=None, description="Library ID to filter by", alias="libraryId") + library_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Library ID to filter by", alias="libraryId") make: Optional[StrictStr] = Field(default=None, description="Filter by camera make") model: Optional[StrictStr] = Field(default=None, description="Filter by camera model") ocr: Optional[StrictStr] = Field(default=None, description="Filter by OCR text content") page: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=1)]] = Field(default=None, description="Page number") - person_ids: Optional[List[UUID]] = Field(default=None, description="Filter by person IDs", alias="personIds") + person_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by person IDs", alias="personIds") query: Optional[StrictStr] = Field(default=None, description="Natural language search query") - query_asset_id: Optional[UUID] = Field(default=None, description="Asset ID to use as search reference", alias="queryAssetId") + query_asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Asset ID to use as search reference", alias="queryAssetId") rating: Optional[Annotated[int, Field(le=5, strict=True, ge=1)]] = Field(default=None, description="Filter by rating [1-5], or null for unrated") size: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]] = Field(default=None, description="Number of results to return") state: Optional[StrictStr] = Field(default=None, description="Filter by state/province name") - tag_ids: Optional[List[UUID]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") + tag_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") taken_after: Optional[datetime] = Field(default=None, description="Filter by taken date (after)", alias="takenAfter") taken_before: Optional[datetime] = Field(default=None, description="Filter by taken date (before)", alias="takenBefore") trashed_after: Optional[datetime] = Field(default=None, description="Filter by trash date (after)", alias="trashedAfter") diff --git a/generated/immich/openapi_client/models/stack_create_dto.py b/generated/immich/openapi_client/models/stack_create_dto.py index 6e0b88d..e79aa2c 100644 --- a/generated/immich/openapi_client/models/stack_create_dto.py +++ b/generated/immich/openapi_client/models/stack_create_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -28,7 +27,7 @@ class StackCreateDto(BaseModel): """ StackCreateDto """ # noqa: E501 - asset_ids: Annotated[List[UUID], Field(min_length=2)] = Field(description="Asset IDs (first becomes primary, min 2)", alias="assetIds") + asset_ids: Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=2)] = Field(description="Asset IDs (first becomes primary, min 2)", alias="assetIds") __properties: ClassVar[List[str]] = ["assetIds"] model_config = ConfigDict( diff --git a/generated/immich/openapi_client/models/stack_response_dto.py b/generated/immich/openapi_client/models/stack_response_dto.py index 0a64604..beda4e9 100644 --- a/generated/immich/openapi_client/models/stack_response_dto.py +++ b/generated/immich/openapi_client/models/stack_response_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto from typing import Optional, Set from typing_extensions import Self @@ -29,8 +29,8 @@ class StackResponseDto(BaseModel): Stack response """ # noqa: E501 assets: List[AssetResponseDto] - id: UUID = Field(description="Stack ID") - primary_asset_id: UUID = Field(description="Primary asset ID", alias="primaryAssetId") + id: Annotated[str, Field(strict=True)] = Field(description="Stack ID") + primary_asset_id: Annotated[str, Field(strict=True)] = Field(description="Primary asset ID", alias="primaryAssetId") __properties: ClassVar[List[str]] = ["assets", "id", "primaryAssetId"] @field_validator('id') diff --git a/generated/immich/openapi_client/models/stack_update_dto.py b/generated/immich/openapi_client/models/stack_update_dto.py index e3e527d..e84ea75 100644 --- a/generated/immich/openapi_client/models/stack_update_dto.py +++ b/generated/immich/openapi_client/models/stack_update_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class StackUpdateDto(BaseModel): """ StackUpdateDto """ # noqa: E501 - primary_asset_id: Optional[UUID] = Field(default=None, description="Primary asset ID", alias="primaryAssetId") + primary_asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Primary asset ID", alias="primaryAssetId") __properties: ClassVar[List[str]] = ["primaryAssetId"] @field_validator('primary_asset_id') diff --git a/generated/immich/openapi_client/models/statistics_search_dto.py b/generated/immich/openapi_client/models/statistics_search_dto.py new file mode 100644 index 0000000..19745fc --- /dev/null +++ b/generated/immich/openapi_client/models/statistics_search_dto.py @@ -0,0 +1,280 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum +from generated.immich.openapi_client.models.asset_visibility import AssetVisibility +from typing import Optional, Set +from typing_extensions import Self + +class StatisticsSearchDto(BaseModel): + """ + StatisticsSearchDto + """ # noqa: E501 + album_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by album IDs", alias="albumIds") + city: Optional[StrictStr] = Field(default=None, description="Filter by city name") + country: Optional[StrictStr] = Field(default=None, description="Filter by country name") + created_after: Optional[datetime] = Field(default=None, description="Filter by creation date (after)", alias="createdAfter") + created_before: Optional[datetime] = Field(default=None, description="Filter by creation date (before)", alias="createdBefore") + description: Optional[StrictStr] = Field(default=None, description="Filter by description text") + is_encoded: Optional[StrictBool] = Field(default=None, description="Filter by encoded status", alias="isEncoded") + is_favorite: Optional[StrictBool] = Field(default=None, description="Filter by favorite status", alias="isFavorite") + is_motion: Optional[StrictBool] = Field(default=None, description="Filter by motion photo status", alias="isMotion") + is_not_in_album: Optional[StrictBool] = Field(default=None, description="Filter assets not in any album", alias="isNotInAlbum") + is_offline: Optional[StrictBool] = Field(default=None, description="Filter by offline status", alias="isOffline") + lens_model: Optional[StrictStr] = Field(default=None, description="Filter by lens model", alias="lensModel") + library_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Library ID to filter by", alias="libraryId") + make: Optional[StrictStr] = Field(default=None, description="Filter by camera make") + model: Optional[StrictStr] = Field(default=None, description="Filter by camera model") + ocr: Optional[StrictStr] = Field(default=None, description="Filter by OCR text content") + person_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by person IDs", alias="personIds") + rating: Optional[Annotated[int, Field(le=5, strict=True, ge=1)]] = Field(default=None, description="Filter by rating [1-5], or null for unrated") + state: Optional[StrictStr] = Field(default=None, description="Filter by state/province name") + tag_ids: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="Filter by tag IDs", alias="tagIds") + taken_after: Optional[datetime] = Field(default=None, description="Filter by taken date (after)", alias="takenAfter") + taken_before: Optional[datetime] = Field(default=None, description="Filter by taken date (before)", alias="takenBefore") + trashed_after: Optional[datetime] = Field(default=None, description="Filter by trash date (after)", alias="trashedAfter") + trashed_before: Optional[datetime] = Field(default=None, description="Filter by trash date (before)", alias="trashedBefore") + type: Optional[AssetTypeEnum] = None + updated_after: Optional[datetime] = Field(default=None, description="Filter by update date (after)", alias="updatedAfter") + updated_before: Optional[datetime] = Field(default=None, description="Filter by update date (before)", alias="updatedBefore") + visibility: Optional[AssetVisibility] = None + __properties: ClassVar[List[str]] = ["albumIds", "city", "country", "createdAfter", "createdBefore", "description", "isEncoded", "isFavorite", "isMotion", "isNotInAlbum", "isOffline", "lensModel", "libraryId", "make", "model", "ocr", "personIds", "rating", "state", "tagIds", "takenAfter", "takenBefore", "trashedAfter", "trashedBefore", "type", "updatedAfter", "updatedBefore", "visibility"] + + @field_validator('created_after') + def created_after_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('created_before') + def created_before_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('library_id') + def library_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('taken_after') + def taken_after_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('taken_before') + def taken_before_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('trashed_after') + def trashed_after_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('trashed_before') + def trashed_before_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('updated_after') + def updated_after_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('updated_before') + def updated_before_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StatisticsSearchDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if city (nullable) is None + # and model_fields_set contains the field + if self.city is None and "city" in self.model_fields_set: + _dict['city'] = None + + # set to None if country (nullable) is None + # and model_fields_set contains the field + if self.country is None and "country" in self.model_fields_set: + _dict['country'] = None + + # set to None if lens_model (nullable) is None + # and model_fields_set contains the field + if self.lens_model is None and "lens_model" in self.model_fields_set: + _dict['lensModel'] = None + + # set to None if library_id (nullable) is None + # and model_fields_set contains the field + if self.library_id is None and "library_id" in self.model_fields_set: + _dict['libraryId'] = None + + # set to None if make (nullable) is None + # and model_fields_set contains the field + if self.make is None and "make" in self.model_fields_set: + _dict['make'] = None + + # set to None if model (nullable) is None + # and model_fields_set contains the field + if self.model is None and "model" in self.model_fields_set: + _dict['model'] = None + + # set to None if rating (nullable) is None + # and model_fields_set contains the field + if self.rating is None and "rating" in self.model_fields_set: + _dict['rating'] = None + + # set to None if state (nullable) is None + # and model_fields_set contains the field + if self.state is None and "state" in self.model_fields_set: + _dict['state'] = None + + # set to None if tag_ids (nullable) is None + # and model_fields_set contains the field + if self.tag_ids is None and "tag_ids" in self.model_fields_set: + _dict['tagIds'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StatisticsSearchDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumIds": obj.get("albumIds"), + "city": obj.get("city"), + "country": obj.get("country"), + "createdAfter": obj.get("createdAfter"), + "createdBefore": obj.get("createdBefore"), + "description": obj.get("description"), + "isEncoded": obj.get("isEncoded"), + "isFavorite": obj.get("isFavorite"), + "isMotion": obj.get("isMotion"), + "isNotInAlbum": obj.get("isNotInAlbum"), + "isOffline": obj.get("isOffline"), + "lensModel": obj.get("lensModel"), + "libraryId": obj.get("libraryId"), + "make": obj.get("make"), + "model": obj.get("model"), + "ocr": obj.get("ocr"), + "personIds": obj.get("personIds"), + "rating": obj.get("rating"), + "state": obj.get("state"), + "tagIds": obj.get("tagIds"), + "takenAfter": obj.get("takenAfter"), + "takenBefore": obj.get("takenBefore"), + "trashedAfter": obj.get("trashedAfter"), + "trashedBefore": obj.get("trashedBefore"), + "type": obj.get("type"), + "updatedAfter": obj.get("updatedAfter"), + "updatedBefore": obj.get("updatedBefore"), + "visibility": obj.get("visibility") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/storage_folder.py b/generated/immich/openapi_client/models/storage_folder.py new file mode 100644 index 0000000..1146ebe --- /dev/null +++ b/generated/immich/openapi_client/models/storage_folder.py @@ -0,0 +1,41 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class StorageFolder(str, Enum): + """ + Storage folder + """ + + """ + allowed enum values + """ + ENCODED_MINUS_VIDEO = 'encoded-video' + LIBRARY = 'library' + UPLOAD = 'upload' + PROFILE = 'profile' + THUMBS = 'thumbs' + BACKUPS = 'backups' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of StorageFolder from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/sync_album_delete_v1.py b/generated/immich/openapi_client/models/sync_album_delete_v1.py new file mode 100644 index 0000000..d3ca44f --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_delete_v1.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumDeleteV1(BaseModel): + """ + SyncAlbumDeleteV1 + """ # noqa: E501 + album_id: Annotated[str, Field(strict=True)] = Field(description="Album ID", alias="albumId") + __properties: ClassVar[List[str]] = ["albumId"] + + @field_validator('album_id') + def album_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumId": obj.get("albumId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_album_to_asset_delete_v1.py b/generated/immich/openapi_client/models/sync_album_to_asset_delete_v1.py new file mode 100644 index 0000000..9b9d911 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_to_asset_delete_v1.py @@ -0,0 +1,104 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumToAssetDeleteV1(BaseModel): + """ + SyncAlbumToAssetDeleteV1 + """ # noqa: E501 + album_id: Annotated[str, Field(strict=True)] = Field(description="Album ID", alias="albumId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + __properties: ClassVar[List[str]] = ["albumId", "assetId"] + + @field_validator('album_id') + def album_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumToAssetDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumToAssetDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumId": obj.get("albumId"), + "assetId": obj.get("assetId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_album_to_asset_v1.py b/generated/immich/openapi_client/models/sync_album_to_asset_v1.py new file mode 100644 index 0000000..1d9e3f4 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_to_asset_v1.py @@ -0,0 +1,104 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumToAssetV1(BaseModel): + """ + SyncAlbumToAssetV1 + """ # noqa: E501 + album_id: Annotated[str, Field(strict=True)] = Field(description="Album ID", alias="albumId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + __properties: ClassVar[List[str]] = ["albumId", "assetId"] + + @field_validator('album_id') + def album_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumToAssetV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumToAssetV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumId": obj.get("albumId"), + "assetId": obj.get("assetId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_album_user_delete_v1.py b/generated/immich/openapi_client/models/sync_album_user_delete_v1.py new file mode 100644 index 0000000..455d323 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_user_delete_v1.py @@ -0,0 +1,104 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumUserDeleteV1(BaseModel): + """ + SyncAlbumUserDeleteV1 + """ # noqa: E501 + album_id: Annotated[str, Field(strict=True)] = Field(description="Album ID", alias="albumId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") + __properties: ClassVar[List[str]] = ["albumId", "userId"] + + @field_validator('album_id') + def album_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('user_id') + def user_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumUserDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumUserDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumId": obj.get("albumId"), + "userId": obj.get("userId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_album_user_v1.py b/generated/immich/openapi_client/models/sync_album_user_v1.py new file mode 100644 index 0000000..70f039f --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_user_v1.py @@ -0,0 +1,107 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.album_user_role import AlbumUserRole +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumUserV1(BaseModel): + """ + SyncAlbumUserV1 + """ # noqa: E501 + album_id: Annotated[str, Field(strict=True)] = Field(description="Album ID", alias="albumId") + role: AlbumUserRole + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") + __properties: ClassVar[List[str]] = ["albumId", "role", "userId"] + + @field_validator('album_id') + def album_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('user_id') + def user_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumUserV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumUserV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "albumId": obj.get("albumId"), + "role": obj.get("role"), + "userId": obj.get("userId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_album_v1.py b/generated/immich/openapi_client/models/sync_album_v1.py new file mode 100644 index 0000000..17db8e7 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_v1.py @@ -0,0 +1,139 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_order import AssetOrder +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumV1(BaseModel): + """ + SyncAlbumV1 + """ # noqa: E501 + created_at: datetime = Field(description="Created at", alias="createdAt") + description: StrictStr = Field(description="Album description") + id: Annotated[str, Field(strict=True)] = Field(description="Album ID") + is_activity_enabled: StrictBool = Field(description="Is activity enabled", alias="isActivityEnabled") + name: StrictStr = Field(description="Album name") + order: AssetOrder + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner ID", alias="ownerId") + thumbnail_asset_id: Optional[StrictStr] = Field(description="Thumbnail asset ID", alias="thumbnailAssetId") + updated_at: datetime = Field(description="Updated at", alias="updatedAt") + __properties: ClassVar[List[str]] = ["createdAt", "description", "id", "isActivityEnabled", "name", "order", "ownerId", "thumbnailAssetId", "updatedAt"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('owner_id') + def owner_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if thumbnail_asset_id (nullable) is None + # and model_fields_set contains the field + if self.thumbnail_asset_id is None and "thumbnail_asset_id" in self.model_fields_set: + _dict['thumbnailAssetId'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "id": obj.get("id"), + "isActivityEnabled": obj.get("isActivityEnabled"), + "name": obj.get("name"), + "order": obj.get("order"), + "ownerId": obj.get("ownerId"), + "thumbnailAssetId": obj.get("thumbnailAssetId"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_album_v2.py b/generated/immich/openapi_client/models/sync_album_v2.py new file mode 100644 index 0000000..e0e3058 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_album_v2.py @@ -0,0 +1,130 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_order import AssetOrder +from typing import Optional, Set +from typing_extensions import Self + +class SyncAlbumV2(BaseModel): + """ + SyncAlbumV2 + """ # noqa: E501 + created_at: datetime = Field(description="Created at", alias="createdAt") + description: StrictStr = Field(description="Album description") + id: Annotated[str, Field(strict=True)] = Field(description="Album ID") + is_activity_enabled: StrictBool = Field(description="Is activity enabled", alias="isActivityEnabled") + name: StrictStr = Field(description="Album name") + order: AssetOrder + thumbnail_asset_id: Optional[StrictStr] = Field(description="Thumbnail asset ID", alias="thumbnailAssetId") + updated_at: datetime = Field(description="Updated at", alias="updatedAt") + __properties: ClassVar[List[str]] = ["createdAt", "description", "id", "isActivityEnabled", "name", "order", "thumbnailAssetId", "updatedAt"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAlbumV2 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if thumbnail_asset_id (nullable) is None + # and model_fields_set contains the field + if self.thumbnail_asset_id is None and "thumbnail_asset_id" in self.model_fields_set: + _dict['thumbnailAssetId'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAlbumV2 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "id": obj.get("id"), + "isActivityEnabled": obj.get("isActivityEnabled"), + "name": obj.get("name"), + "order": obj.get("order"), + "thumbnailAssetId": obj.get("thumbnailAssetId"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_delete_v1.py b/generated/immich/openapi_client/models/sync_asset_delete_v1.py index 8fd1b46..a76a2c5 100644 --- a/generated/immich/openapi_client/models/sync_asset_delete_v1.py +++ b/generated/immich/openapi_client/models/sync_asset_delete_v1.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class SyncAssetDeleteV1(BaseModel): """ SyncAssetDeleteV1 """ # noqa: E501 - asset_id: UUID = Field(description="Asset ID", alias="assetId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") __properties: ClassVar[List[str]] = ["assetId"] @field_validator('asset_id') diff --git a/generated/immich/openapi_client/models/sync_asset_edit_delete_v1.py b/generated/immich/openapi_client/models/sync_asset_edit_delete_v1.py new file mode 100644 index 0000000..11e7c3d --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_edit_delete_v1.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetEditDeleteV1(BaseModel): + """ + SyncAssetEditDeleteV1 + """ # noqa: E501 + edit_id: Annotated[str, Field(strict=True)] = Field(description="Edit ID", alias="editId") + __properties: ClassVar[List[str]] = ["editId"] + + @field_validator('edit_id') + def edit_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetEditDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetEditDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "editId": obj.get("editId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_edit_v1.py b/generated/immich/openapi_client/models/sync_asset_edit_v1.py new file mode 100644 index 0000000..7022b3f --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_edit_v1.py @@ -0,0 +1,111 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_edit_action import AssetEditAction +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetEditV1(BaseModel): + """ + SyncAssetEditV1 + """ # noqa: E501 + action: AssetEditAction + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + id: Annotated[str, Field(strict=True)] = Field(description="Edit ID") + parameters: Dict[str, Any] = Field(description="Edit parameters") + sequence: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Edit sequence") + __properties: ClassVar[List[str]] = ["action", "assetId", "id", "parameters", "sequence"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetEditV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetEditV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "action": obj.get("action"), + "assetId": obj.get("assetId"), + "id": obj.get("id"), + "parameters": obj.get("parameters"), + "sequence": obj.get("sequence") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_exif_v1.py b/generated/immich/openapi_client/models/sync_asset_exif_v1.py index d4aefa7..aa14725 100644 --- a/generated/immich/openapi_client/models/sync_asset_exif_v1.py +++ b/generated/immich/openapi_client/models/sync_asset_exif_v1.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -29,7 +28,7 @@ class SyncAssetExifV1(BaseModel): """ SyncAssetExifV1 """ # noqa: E501 - asset_id: UUID = Field(description="Asset ID", alias="assetId") + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") city: Optional[StrictStr] = Field(description="City") country: Optional[StrictStr] = Field(description="Country") date_time_original: Optional[datetime] = Field(description="Date time original", alias="dateTimeOriginal") diff --git a/generated/immich/openapi_client/models/sync_asset_face_delete_v1.py b/generated/immich/openapi_client/models/sync_asset_face_delete_v1.py new file mode 100644 index 0000000..ba339cd --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_face_delete_v1.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetFaceDeleteV1(BaseModel): + """ + SyncAssetFaceDeleteV1 + """ # noqa: E501 + asset_face_id: Annotated[str, Field(strict=True)] = Field(description="Asset face ID", alias="assetFaceId") + __properties: ClassVar[List[str]] = ["assetFaceId"] + + @field_validator('asset_face_id') + def asset_face_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetFaceDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetFaceDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetFaceId": obj.get("assetFaceId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_face_v1.py b/generated/immich/openapi_client/models/sync_asset_face_v1.py new file mode 100644 index 0000000..3e5e972 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_face_v1.py @@ -0,0 +1,125 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetFaceV1(BaseModel): + """ + SyncAssetFaceV1 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + bounding_box_x1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box X1", alias="boundingBoxX1") + bounding_box_x2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box X2", alias="boundingBoxX2") + bounding_box_y1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box Y1", alias="boundingBoxY1") + bounding_box_y2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box Y2", alias="boundingBoxY2") + id: Annotated[str, Field(strict=True)] = Field(description="Asset face ID") + image_height: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Image height", alias="imageHeight") + image_width: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Image width", alias="imageWidth") + person_id: Optional[StrictStr] = Field(description="Person ID", alias="personId") + source_type: StrictStr = Field(description="Source type", alias="sourceType") + __properties: ClassVar[List[str]] = ["assetId", "boundingBoxX1", "boundingBoxX2", "boundingBoxY1", "boundingBoxY2", "id", "imageHeight", "imageWidth", "personId", "sourceType"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetFaceV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if person_id (nullable) is None + # and model_fields_set contains the field + if self.person_id is None and "person_id" in self.model_fields_set: + _dict['personId'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetFaceV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "boundingBoxX1": obj.get("boundingBoxX1"), + "boundingBoxX2": obj.get("boundingBoxX2"), + "boundingBoxY1": obj.get("boundingBoxY1"), + "boundingBoxY2": obj.get("boundingBoxY2"), + "id": obj.get("id"), + "imageHeight": obj.get("imageHeight"), + "imageWidth": obj.get("imageWidth"), + "personId": obj.get("personId"), + "sourceType": obj.get("sourceType") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_face_v2.py b/generated/immich/openapi_client/models/sync_asset_face_v2.py new file mode 100644 index 0000000..a14fbcf --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_face_v2.py @@ -0,0 +1,145 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetFaceV2(BaseModel): + """ + SyncAssetFaceV2 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + bounding_box_x1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box X1", alias="boundingBoxX1") + bounding_box_x2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box X2", alias="boundingBoxX2") + bounding_box_y1: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box Y1", alias="boundingBoxY1") + bounding_box_y2: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Bounding box Y2", alias="boundingBoxY2") + deleted_at: Optional[datetime] = Field(description="Face deleted at", alias="deletedAt") + id: Annotated[str, Field(strict=True)] = Field(description="Asset face ID") + image_height: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Image height", alias="imageHeight") + image_width: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Image width", alias="imageWidth") + is_visible: StrictBool = Field(description="Is the face visible in the asset", alias="isVisible") + person_id: Optional[StrictStr] = Field(description="Person ID", alias="personId") + source_type: StrictStr = Field(description="Source type", alias="sourceType") + __properties: ClassVar[List[str]] = ["assetId", "boundingBoxX1", "boundingBoxX2", "boundingBoxY1", "boundingBoxY2", "deletedAt", "id", "imageHeight", "imageWidth", "isVisible", "personId", "sourceType"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('deleted_at') + def deleted_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetFaceV2 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if deleted_at (nullable) is None + # and model_fields_set contains the field + if self.deleted_at is None and "deleted_at" in self.model_fields_set: + _dict['deletedAt'] = None + + # set to None if person_id (nullable) is None + # and model_fields_set contains the field + if self.person_id is None and "person_id" in self.model_fields_set: + _dict['personId'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetFaceV2 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "boundingBoxX1": obj.get("boundingBoxX1"), + "boundingBoxX2": obj.get("boundingBoxX2"), + "boundingBoxY1": obj.get("boundingBoxY1"), + "boundingBoxY2": obj.get("boundingBoxY2"), + "deletedAt": obj.get("deletedAt"), + "id": obj.get("id"), + "imageHeight": obj.get("imageHeight"), + "imageWidth": obj.get("imageWidth"), + "isVisible": obj.get("isVisible"), + "personId": obj.get("personId"), + "sourceType": obj.get("sourceType") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_metadata_delete_v1.py b/generated/immich/openapi_client/models/sync_asset_metadata_delete_v1.py new file mode 100644 index 0000000..886412f --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_metadata_delete_v1.py @@ -0,0 +1,97 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetMetadataDeleteV1(BaseModel): + """ + SyncAssetMetadataDeleteV1 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + key: StrictStr = Field(description="Key") + __properties: ClassVar[List[str]] = ["assetId", "key"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetMetadataDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetMetadataDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "key": obj.get("key") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_metadata_v1.py b/generated/immich/openapi_client/models/sync_asset_metadata_v1.py new file mode 100644 index 0000000..8567c69 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_metadata_v1.py @@ -0,0 +1,99 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetMetadataV1(BaseModel): + """ + SyncAssetMetadataV1 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + key: StrictStr = Field(description="Key") + value: Dict[str, Any] = Field(description="Value") + __properties: ClassVar[List[str]] = ["assetId", "key", "value"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetMetadataV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetMetadataV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "key": obj.get("key"), + "value": obj.get("value") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_ocr_delete_v1.py b/generated/immich/openapi_client/models/sync_asset_ocr_delete_v1.py new file mode 100644 index 0000000..f15cd3c --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_ocr_delete_v1.py @@ -0,0 +1,99 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetOcrDeleteV1(BaseModel): + """ + SyncAssetOcrDeleteV1 + """ # noqa: E501 + asset_id: StrictStr = Field(description="Original asset ID of the deleted OCR entry", alias="assetId") + deleted_at: datetime = Field(description="Timestamp when the OCR entry was deleted", alias="deletedAt") + id: StrictStr = Field(description="Audit row ID of the deleted OCR entry") + __properties: ClassVar[List[str]] = ["assetId", "deletedAt", "id"] + + @field_validator('deleted_at') + def deleted_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetOcrDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetOcrDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "deletedAt": obj.get("deletedAt"), + "id": obj.get("id") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_ocr_v1.py b/generated/immich/openapi_client/models/sync_asset_ocr_v1.py new file mode 100644 index 0000000..4eeaeac --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_ocr_v1.py @@ -0,0 +1,128 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetOcrV1(BaseModel): + """ + SyncAssetOcrV1 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + box_score: Union[StrictFloat, StrictInt] = Field(description="Confidence score of the bounding box", alias="boxScore") + id: Annotated[str, Field(strict=True)] = Field(description="OCR entry ID") + is_visible: StrictBool = Field(description="Whether the OCR entry is visible", alias="isVisible") + text: StrictStr = Field(description="Recognized text content") + text_score: Union[StrictFloat, StrictInt] = Field(description="Confidence score of the recognized text", alias="textScore") + x1: Union[StrictFloat, StrictInt] = Field(description="Top-left X coordinate (normalized 0–1)") + x2: Union[StrictFloat, StrictInt] = Field(description="Top-right X coordinate (normalized 0–1)") + x3: Union[StrictFloat, StrictInt] = Field(description="Bottom-right X coordinate (normalized 0–1)") + x4: Union[StrictFloat, StrictInt] = Field(description="Bottom-left X coordinate (normalized 0–1)") + y1: Union[StrictFloat, StrictInt] = Field(description="Top-left Y coordinate (normalized 0–1)") + y2: Union[StrictFloat, StrictInt] = Field(description="Top-right Y coordinate (normalized 0–1)") + y3: Union[StrictFloat, StrictInt] = Field(description="Bottom-right Y coordinate (normalized 0–1)") + y4: Union[StrictFloat, StrictInt] = Field(description="Bottom-left Y coordinate (normalized 0–1)") + __properties: ClassVar[List[str]] = ["assetId", "boxScore", "id", "isVisible", "text", "textScore", "x1", "x2", "x3", "x4", "y1", "y2", "y3", "y4"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetOcrV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetOcrV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "boxScore": obj.get("boxScore"), + "id": obj.get("id"), + "isVisible": obj.get("isVisible"), + "text": obj.get("text"), + "textScore": obj.get("textScore"), + "x1": obj.get("x1"), + "x2": obj.get("x2"), + "x3": obj.get("x3"), + "x4": obj.get("x4"), + "y1": obj.get("y1"), + "y2": obj.get("y2"), + "y3": obj.get("y3"), + "y4": obj.get("y4") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_asset_v1.py b/generated/immich/openapi_client/models/sync_asset_v1.py index 9861793..c0f962d 100644 --- a/generated/immich/openapi_client/models/sync_asset_v1.py +++ b/generated/immich/openapi_client/models/sync_asset_v1.py @@ -18,10 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum from generated.immich.openapi_client.models.asset_visibility import AssetVisibility from typing import Optional, Set @@ -38,14 +37,14 @@ class SyncAssetV1(BaseModel): file_created_at: Optional[datetime] = Field(description="File created at", alias="fileCreatedAt") file_modified_at: Optional[datetime] = Field(description="File modified at", alias="fileModifiedAt") height: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]] = Field(description="Asset height") - id: UUID = Field(description="Asset ID") + id: Annotated[str, Field(strict=True)] = Field(description="Asset ID") is_edited: StrictBool = Field(description="Is edited", alias="isEdited") is_favorite: StrictBool = Field(description="Is favorite", alias="isFavorite") library_id: Optional[StrictStr] = Field(description="Library ID", alias="libraryId") live_photo_video_id: Optional[StrictStr] = Field(description="Live photo video ID", alias="livePhotoVideoId") local_date_time: Optional[datetime] = Field(description="Local date time", alias="localDateTime") original_file_name: StrictStr = Field(description="Original file name", alias="originalFileName") - owner_id: UUID = Field(description="Owner ID", alias="ownerId") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner ID", alias="ownerId") stack_id: Optional[StrictStr] = Field(description="Stack ID", alias="stackId") thumbhash: Optional[StrictStr] = Field(description="Thumbhash") type: AssetTypeEnum diff --git a/generated/immich/openapi_client/models/sync_asset_v2.py b/generated/immich/openapi_client/models/sync_asset_v2.py new file mode 100644 index 0000000..ada954e --- /dev/null +++ b/generated/immich/openapi_client/models/sync_asset_v2.py @@ -0,0 +1,253 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum +from generated.immich.openapi_client.models.asset_visibility import AssetVisibility +from typing import Optional, Set +from typing_extensions import Self + +class SyncAssetV2(BaseModel): + """ + SyncAssetV2 + """ # noqa: E501 + checksum: StrictStr = Field(description="Checksum") + created_at: Optional[datetime] = Field(description="Uploaded to Immich at", alias="createdAt") + deleted_at: Optional[datetime] = Field(description="Deleted at", alias="deletedAt") + duration: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = Field(description="Duration") + file_created_at: Optional[datetime] = Field(description="File created at", alias="fileCreatedAt") + file_modified_at: Optional[datetime] = Field(description="File modified at", alias="fileModifiedAt") + height: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]] = Field(description="Asset height") + id: Annotated[str, Field(strict=True)] = Field(description="Asset ID") + is_edited: StrictBool = Field(description="Is edited", alias="isEdited") + is_favorite: StrictBool = Field(description="Is favorite", alias="isFavorite") + library_id: Optional[StrictStr] = Field(description="Library ID", alias="libraryId") + live_photo_video_id: Optional[StrictStr] = Field(description="Live photo video ID", alias="livePhotoVideoId") + local_date_time: Optional[datetime] = Field(description="Local date time", alias="localDateTime") + original_file_name: StrictStr = Field(description="Original file name", alias="originalFileName") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner ID", alias="ownerId") + stack_id: Optional[StrictStr] = Field(description="Stack ID", alias="stackId") + thumbhash: Optional[StrictStr] = Field(description="Thumbhash") + type: AssetTypeEnum + visibility: AssetVisibility + width: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]] = Field(description="Asset width") + __properties: ClassVar[List[str]] = ["checksum", "createdAt", "deletedAt", "duration", "fileCreatedAt", "fileModifiedAt", "height", "id", "isEdited", "isFavorite", "libraryId", "livePhotoVideoId", "localDateTime", "originalFileName", "ownerId", "stackId", "thumbhash", "type", "visibility", "width"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('deleted_at') + def deleted_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('file_created_at') + def file_created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('file_modified_at') + def file_modified_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('local_date_time') + def local_date_time_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('owner_id') + def owner_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAssetV2 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + # set to None if deleted_at (nullable) is None + # and model_fields_set contains the field + if self.deleted_at is None and "deleted_at" in self.model_fields_set: + _dict['deletedAt'] = None + + # set to None if duration (nullable) is None + # and model_fields_set contains the field + if self.duration is None and "duration" in self.model_fields_set: + _dict['duration'] = None + + # set to None if file_created_at (nullable) is None + # and model_fields_set contains the field + if self.file_created_at is None and "file_created_at" in self.model_fields_set: + _dict['fileCreatedAt'] = None + + # set to None if file_modified_at (nullable) is None + # and model_fields_set contains the field + if self.file_modified_at is None and "file_modified_at" in self.model_fields_set: + _dict['fileModifiedAt'] = None + + # set to None if height (nullable) is None + # and model_fields_set contains the field + if self.height is None and "height" in self.model_fields_set: + _dict['height'] = None + + # set to None if library_id (nullable) is None + # and model_fields_set contains the field + if self.library_id is None and "library_id" in self.model_fields_set: + _dict['libraryId'] = None + + # set to None if live_photo_video_id (nullable) is None + # and model_fields_set contains the field + if self.live_photo_video_id is None and "live_photo_video_id" in self.model_fields_set: + _dict['livePhotoVideoId'] = None + + # set to None if local_date_time (nullable) is None + # and model_fields_set contains the field + if self.local_date_time is None and "local_date_time" in self.model_fields_set: + _dict['localDateTime'] = None + + # set to None if stack_id (nullable) is None + # and model_fields_set contains the field + if self.stack_id is None and "stack_id" in self.model_fields_set: + _dict['stackId'] = None + + # set to None if thumbhash (nullable) is None + # and model_fields_set contains the field + if self.thumbhash is None and "thumbhash" in self.model_fields_set: + _dict['thumbhash'] = None + + # set to None if width (nullable) is None + # and model_fields_set contains the field + if self.width is None and "width" in self.model_fields_set: + _dict['width'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAssetV2 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "checksum": obj.get("checksum"), + "createdAt": obj.get("createdAt"), + "deletedAt": obj.get("deletedAt"), + "duration": obj.get("duration"), + "fileCreatedAt": obj.get("fileCreatedAt"), + "fileModifiedAt": obj.get("fileModifiedAt"), + "height": obj.get("height"), + "id": obj.get("id"), + "isEdited": obj.get("isEdited"), + "isFavorite": obj.get("isFavorite"), + "libraryId": obj.get("libraryId"), + "livePhotoVideoId": obj.get("livePhotoVideoId"), + "localDateTime": obj.get("localDateTime"), + "originalFileName": obj.get("originalFileName"), + "ownerId": obj.get("ownerId"), + "stackId": obj.get("stackId"), + "thumbhash": obj.get("thumbhash"), + "type": obj.get("type"), + "visibility": obj.get("visibility"), + "width": obj.get("width") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_auth_user_v1.py b/generated/immich/openapi_client/models/sync_auth_user_v1.py new file mode 100644 index 0000000..eefcf31 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_auth_user_v1.py @@ -0,0 +1,163 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor +from typing import Optional, Set +from typing_extensions import Self + +class SyncAuthUserV1(BaseModel): + """ + SyncAuthUserV1 + """ # noqa: E501 + avatar_color: Optional[UserAvatarColor] = Field(default=None, alias="avatarColor") + deleted_at: Optional[datetime] = Field(description="User deleted at", alias="deletedAt") + email: StrictStr = Field(description="User email") + has_profile_image: StrictBool = Field(description="User has profile image", alias="hasProfileImage") + id: Annotated[str, Field(strict=True)] = Field(description="User ID") + is_admin: StrictBool = Field(description="User is admin", alias="isAdmin") + name: StrictStr = Field(description="User name") + oauth_id: StrictStr = Field(description="User OAuth ID", alias="oauthId") + pin_code: Optional[StrictStr] = Field(description="User pin code", alias="pinCode") + profile_changed_at: datetime = Field(description="User profile changed at", alias="profileChangedAt") + quota_size_in_bytes: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]] = Field(description="Quota size in bytes", alias="quotaSizeInBytes") + quota_usage_in_bytes: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Quota usage in bytes", alias="quotaUsageInBytes") + storage_label: Optional[StrictStr] = Field(description="User storage label", alias="storageLabel") + __properties: ClassVar[List[str]] = ["avatarColor", "deletedAt", "email", "hasProfileImage", "id", "isAdmin", "name", "oauthId", "pinCode", "profileChangedAt", "quotaSizeInBytes", "quotaUsageInBytes", "storageLabel"] + + @field_validator('deleted_at') + def deleted_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('profile_changed_at') + def profile_changed_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncAuthUserV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if avatar_color (nullable) is None + # and model_fields_set contains the field + if self.avatar_color is None and "avatar_color" in self.model_fields_set: + _dict['avatarColor'] = None + + # set to None if deleted_at (nullable) is None + # and model_fields_set contains the field + if self.deleted_at is None and "deleted_at" in self.model_fields_set: + _dict['deletedAt'] = None + + # set to None if pin_code (nullable) is None + # and model_fields_set contains the field + if self.pin_code is None and "pin_code" in self.model_fields_set: + _dict['pinCode'] = None + + # set to None if quota_size_in_bytes (nullable) is None + # and model_fields_set contains the field + if self.quota_size_in_bytes is None and "quota_size_in_bytes" in self.model_fields_set: + _dict['quotaSizeInBytes'] = None + + # set to None if storage_label (nullable) is None + # and model_fields_set contains the field + if self.storage_label is None and "storage_label" in self.model_fields_set: + _dict['storageLabel'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncAuthUserV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "avatarColor": obj.get("avatarColor"), + "deletedAt": obj.get("deletedAt"), + "email": obj.get("email"), + "hasProfileImage": obj.get("hasProfileImage"), + "id": obj.get("id"), + "isAdmin": obj.get("isAdmin"), + "name": obj.get("name"), + "oauthId": obj.get("oauthId"), + "pinCode": obj.get("pinCode"), + "profileChangedAt": obj.get("profileChangedAt"), + "quotaSizeInBytes": obj.get("quotaSizeInBytes"), + "quotaUsageInBytes": obj.get("quotaUsageInBytes"), + "storageLabel": obj.get("storageLabel") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_memory_asset_delete_v1.py b/generated/immich/openapi_client/models/sync_memory_asset_delete_v1.py new file mode 100644 index 0000000..fe6af46 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_memory_asset_delete_v1.py @@ -0,0 +1,104 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncMemoryAssetDeleteV1(BaseModel): + """ + SyncMemoryAssetDeleteV1 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + memory_id: Annotated[str, Field(strict=True)] = Field(description="Memory ID", alias="memoryId") + __properties: ClassVar[List[str]] = ["assetId", "memoryId"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('memory_id') + def memory_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncMemoryAssetDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncMemoryAssetDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "memoryId": obj.get("memoryId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_memory_asset_v1.py b/generated/immich/openapi_client/models/sync_memory_asset_v1.py new file mode 100644 index 0000000..95b1b99 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_memory_asset_v1.py @@ -0,0 +1,104 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncMemoryAssetV1(BaseModel): + """ + SyncMemoryAssetV1 + """ # noqa: E501 + asset_id: Annotated[str, Field(strict=True)] = Field(description="Asset ID", alias="assetId") + memory_id: Annotated[str, Field(strict=True)] = Field(description="Memory ID", alias="memoryId") + __properties: ClassVar[List[str]] = ["assetId", "memoryId"] + + @field_validator('asset_id') + def asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('memory_id') + def memory_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncMemoryAssetV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncMemoryAssetV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assetId": obj.get("assetId"), + "memoryId": obj.get("memoryId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_memory_delete_v1.py b/generated/immich/openapi_client/models/sync_memory_delete_v1.py new file mode 100644 index 0000000..44001b1 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_memory_delete_v1.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncMemoryDeleteV1(BaseModel): + """ + SyncMemoryDeleteV1 + """ # noqa: E501 + memory_id: Annotated[str, Field(strict=True)] = Field(description="Memory ID", alias="memoryId") + __properties: ClassVar[List[str]] = ["memoryId"] + + @field_validator('memory_id') + def memory_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncMemoryDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncMemoryDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memoryId": obj.get("memoryId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_memory_v1.py b/generated/immich/openapi_client/models/sync_memory_v1.py new file mode 100644 index 0000000..af95eff --- /dev/null +++ b/generated/immich/openapi_client/models/sync_memory_v1.py @@ -0,0 +1,207 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.memory_type import MemoryType +from typing import Optional, Set +from typing_extensions import Self + +class SyncMemoryV1(BaseModel): + """ + SyncMemoryV1 + """ # noqa: E501 + created_at: datetime = Field(description="Created at", alias="createdAt") + data: Dict[str, Any] = Field(description="Data") + deleted_at: Optional[datetime] = Field(description="Deleted at", alias="deletedAt") + hide_at: Optional[datetime] = Field(description="Hide at", alias="hideAt") + id: Annotated[str, Field(strict=True)] = Field(description="Memory ID") + is_saved: StrictBool = Field(description="Is saved", alias="isSaved") + memory_at: datetime = Field(description="Memory at", alias="memoryAt") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner ID", alias="ownerId") + seen_at: Optional[datetime] = Field(description="Seen at", alias="seenAt") + show_at: Optional[datetime] = Field(description="Show at", alias="showAt") + type: MemoryType + updated_at: datetime = Field(description="Updated at", alias="updatedAt") + __properties: ClassVar[List[str]] = ["createdAt", "data", "deletedAt", "hideAt", "id", "isSaved", "memoryAt", "ownerId", "seenAt", "showAt", "type", "updatedAt"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('deleted_at') + def deleted_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('hide_at') + def hide_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('memory_at') + def memory_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('owner_id') + def owner_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('seen_at') + def seen_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('show_at') + def show_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncMemoryV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if deleted_at (nullable) is None + # and model_fields_set contains the field + if self.deleted_at is None and "deleted_at" in self.model_fields_set: + _dict['deletedAt'] = None + + # set to None if hide_at (nullable) is None + # and model_fields_set contains the field + if self.hide_at is None and "hide_at" in self.model_fields_set: + _dict['hideAt'] = None + + # set to None if seen_at (nullable) is None + # and model_fields_set contains the field + if self.seen_at is None and "seen_at" in self.model_fields_set: + _dict['seenAt'] = None + + # set to None if show_at (nullable) is None + # and model_fields_set contains the field + if self.show_at is None and "show_at" in self.model_fields_set: + _dict['showAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncMemoryV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "data": obj.get("data"), + "deletedAt": obj.get("deletedAt"), + "hideAt": obj.get("hideAt"), + "id": obj.get("id"), + "isSaved": obj.get("isSaved"), + "memoryAt": obj.get("memoryAt"), + "ownerId": obj.get("ownerId"), + "seenAt": obj.get("seenAt"), + "showAt": obj.get("showAt"), + "type": obj.get("type"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_partner_delete_v1.py b/generated/immich/openapi_client/models/sync_partner_delete_v1.py index 55b8d0f..5b4805c 100644 --- a/generated/immich/openapi_client/models/sync_partner_delete_v1.py +++ b/generated/immich/openapi_client/models/sync_partner_delete_v1.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,8 +27,8 @@ class SyncPartnerDeleteV1(BaseModel): """ SyncPartnerDeleteV1 """ # noqa: E501 - shared_by_id: UUID = Field(description="Shared by ID", alias="sharedById") - shared_with_id: UUID = Field(description="Shared with ID", alias="sharedWithId") + shared_by_id: Annotated[str, Field(strict=True)] = Field(description="Shared by ID", alias="sharedById") + shared_with_id: Annotated[str, Field(strict=True)] = Field(description="Shared with ID", alias="sharedWithId") __properties: ClassVar[List[str]] = ["sharedById", "sharedWithId"] @field_validator('shared_by_id') diff --git a/generated/immich/openapi_client/models/sync_partner_v1.py b/generated/immich/openapi_client/models/sync_partner_v1.py index 5108df0..d7694dc 100644 --- a/generated/immich/openapi_client/models/sync_partner_v1.py +++ b/generated/immich/openapi_client/models/sync_partner_v1.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -28,8 +28,8 @@ class SyncPartnerV1(BaseModel): SyncPartnerV1 """ # noqa: E501 in_timeline: StrictBool = Field(description="In timeline", alias="inTimeline") - shared_by_id: UUID = Field(description="Shared by ID", alias="sharedById") - shared_with_id: UUID = Field(description="Shared with ID", alias="sharedWithId") + shared_by_id: Annotated[str, Field(strict=True)] = Field(description="Shared by ID", alias="sharedById") + shared_with_id: Annotated[str, Field(strict=True)] = Field(description="Shared with ID", alias="sharedWithId") __properties: ClassVar[List[str]] = ["inTimeline", "sharedById", "sharedWithId"] @field_validator('shared_by_id') diff --git a/generated/immich/openapi_client/models/sync_person_delete_v1.py b/generated/immich/openapi_client/models/sync_person_delete_v1.py new file mode 100644 index 0000000..8312557 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_person_delete_v1.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncPersonDeleteV1(BaseModel): + """ + SyncPersonDeleteV1 + """ # noqa: E501 + person_id: Annotated[str, Field(strict=True)] = Field(description="Person ID", alias="personId") + __properties: ClassVar[List[str]] = ["personId"] + + @field_validator('person_id') + def person_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncPersonDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncPersonDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "personId": obj.get("personId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_person_v1.py b/generated/immich/openapi_client/models/sync_person_v1.py new file mode 100644 index 0000000..4777cc0 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_person_v1.py @@ -0,0 +1,160 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncPersonV1(BaseModel): + """ + SyncPersonV1 + """ # noqa: E501 + birth_date: Optional[datetime] = Field(description="Birth date", alias="birthDate") + color: Optional[StrictStr] = Field(description="Color") + created_at: datetime = Field(description="Created at", alias="createdAt") + face_asset_id: Optional[StrictStr] = Field(description="Face asset ID", alias="faceAssetId") + id: Annotated[str, Field(strict=True)] = Field(description="Person ID") + is_favorite: StrictBool = Field(description="Is favorite", alias="isFavorite") + is_hidden: StrictBool = Field(description="Is hidden", alias="isHidden") + name: StrictStr = Field(description="Person name") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner ID", alias="ownerId") + updated_at: datetime = Field(description="Updated at", alias="updatedAt") + __properties: ClassVar[List[str]] = ["birthDate", "color", "createdAt", "faceAssetId", "id", "isFavorite", "isHidden", "name", "ownerId", "updatedAt"] + + @field_validator('birth_date') + def birth_date_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('owner_id') + def owner_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncPersonV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if birth_date (nullable) is None + # and model_fields_set contains the field + if self.birth_date is None and "birth_date" in self.model_fields_set: + _dict['birthDate'] = None + + # set to None if color (nullable) is None + # and model_fields_set contains the field + if self.color is None and "color" in self.model_fields_set: + _dict['color'] = None + + # set to None if face_asset_id (nullable) is None + # and model_fields_set contains the field + if self.face_asset_id is None and "face_asset_id" in self.model_fields_set: + _dict['faceAssetId'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncPersonV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "birthDate": obj.get("birthDate"), + "color": obj.get("color"), + "createdAt": obj.get("createdAt"), + "faceAssetId": obj.get("faceAssetId"), + "id": obj.get("id"), + "isFavorite": obj.get("isFavorite"), + "isHidden": obj.get("isHidden"), + "name": obj.get("name"), + "ownerId": obj.get("ownerId"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_stack_delete_v1.py b/generated/immich/openapi_client/models/sync_stack_delete_v1.py new file mode 100644 index 0000000..6c430e2 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_stack_delete_v1.py @@ -0,0 +1,95 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncStackDeleteV1(BaseModel): + """ + SyncStackDeleteV1 + """ # noqa: E501 + stack_id: Annotated[str, Field(strict=True)] = Field(description="Stack ID", alias="stackId") + __properties: ClassVar[List[str]] = ["stackId"] + + @field_validator('stack_id') + def stack_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncStackDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncStackDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "stackId": obj.get("stackId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_stack_v1.py b/generated/immich/openapi_client/models/sync_stack_v1.py new file mode 100644 index 0000000..6a4c79f --- /dev/null +++ b/generated/immich/openapi_client/models/sync_stack_v1.py @@ -0,0 +1,132 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SyncStackV1(BaseModel): + """ + SyncStackV1 + """ # noqa: E501 + created_at: datetime = Field(description="Created at", alias="createdAt") + id: Annotated[str, Field(strict=True)] = Field(description="Stack ID") + owner_id: Annotated[str, Field(strict=True)] = Field(description="Owner ID", alias="ownerId") + primary_asset_id: Annotated[str, Field(strict=True)] = Field(description="Primary asset ID", alias="primaryAssetId") + updated_at: datetime = Field(description="Updated at", alias="updatedAt") + __properties: ClassVar[List[str]] = ["createdAt", "id", "ownerId", "primaryAssetId", "updatedAt"] + + @field_validator('created_at') + def created_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('owner_id') + def owner_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('primary_asset_id') + def primary_asset_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + @field_validator('updated_at') + def updated_at_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$", value): + raise ValueError(r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncStackV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncStackV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "id": obj.get("id"), + "ownerId": obj.get("ownerId"), + "primaryAssetId": obj.get("primaryAssetId"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_user_delete_v1.py b/generated/immich/openapi_client/models/sync_user_delete_v1.py index a347c7f..3928e90 100644 --- a/generated/immich/openapi_client/models/sync_user_delete_v1.py +++ b/generated/immich/openapi_client/models/sync_user_delete_v1.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,7 +27,7 @@ class SyncUserDeleteV1(BaseModel): """ SyncUserDeleteV1 """ # noqa: E501 - user_id: UUID = Field(description="User ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") __properties: ClassVar[List[str]] = ["userId"] @field_validator('user_id') diff --git a/generated/immich/openapi_client/models/sync_user_metadata_delete_v1.py b/generated/immich/openapi_client/models/sync_user_metadata_delete_v1.py new file mode 100644 index 0000000..8bf38d2 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_user_metadata_delete_v1.py @@ -0,0 +1,98 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.user_metadata_key import UserMetadataKey +from typing import Optional, Set +from typing_extensions import Self + +class SyncUserMetadataDeleteV1(BaseModel): + """ + SyncUserMetadataDeleteV1 + """ # noqa: E501 + key: UserMetadataKey + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") + __properties: ClassVar[List[str]] = ["key", "userId"] + + @field_validator('user_id') + def user_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncUserMetadataDeleteV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncUserMetadataDeleteV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "userId": obj.get("userId") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_user_metadata_v1.py b/generated/immich/openapi_client/models/sync_user_metadata_v1.py new file mode 100644 index 0000000..fa04f74 --- /dev/null +++ b/generated/immich/openapi_client/models/sync_user_metadata_v1.py @@ -0,0 +1,100 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from generated.immich.openapi_client.models.user_metadata_key import UserMetadataKey +from typing import Optional, Set +from typing_extensions import Self + +class SyncUserMetadataV1(BaseModel): + """ + SyncUserMetadataV1 + """ # noqa: E501 + key: UserMetadataKey + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") + value: Dict[str, Any] = Field(description="User metadata value") + __properties: ClassVar[List[str]] = ["key", "userId", "value"] + + @field_validator('user_id') + def user_id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyncUserMetadataV1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyncUserMetadataV1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "userId": obj.get("userId"), + "value": obj.get("value") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/sync_user_v1.py b/generated/immich/openapi_client/models/sync_user_v1.py index 6abe4bc..71e1648 100644 --- a/generated/immich/openapi_client/models/sync_user_v1.py +++ b/generated/immich/openapi_client/models/sync_user_v1.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor from typing import Optional, Set from typing_extensions import Self @@ -33,7 +33,7 @@ class SyncUserV1(BaseModel): deleted_at: Optional[datetime] = Field(description="User deleted at", alias="deletedAt") email: StrictStr = Field(description="User email") has_profile_image: StrictBool = Field(description="User has profile image", alias="hasProfileImage") - id: UUID = Field(description="User ID") + id: Annotated[str, Field(strict=True)] = Field(description="User ID") name: StrictStr = Field(description="User name") profile_changed_at: datetime = Field(description="User profile changed at", alias="profileChangedAt") __properties: ClassVar[List[str]] = ["avatarColor", "deletedAt", "email", "hasProfileImage", "id", "name", "profileChangedAt"] diff --git a/generated/immich/openapi_client/models/system_config_f_fmpeg_realtime_dto.py b/generated/immich/openapi_client/models/system_config_f_fmpeg_realtime_dto.py new file mode 100644 index 0000000..da990ef --- /dev/null +++ b/generated/immich/openapi_client/models/system_config_f_fmpeg_realtime_dto.py @@ -0,0 +1,87 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SystemConfigFFmpegRealtimeDto(BaseModel): + """ + SystemConfigFFmpegRealtimeDto + """ # noqa: E501 + enabled: StrictBool = Field(description="Enable real-time HLS transcoding (alpha)") + __properties: ClassVar[List[str]] = ["enabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemConfigFFmpegRealtimeDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemConfigFFmpegRealtimeDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "enabled": obj.get("enabled") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/system_config_integrity_checks.py b/generated/immich/openapi_client/models/system_config_integrity_checks.py new file mode 100644 index 0000000..e3a19ea --- /dev/null +++ b/generated/immich/openapi_client/models/system_config_integrity_checks.py @@ -0,0 +1,102 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.system_config_integrity_checksum_job import SystemConfigIntegrityChecksumJob +from generated.immich.openapi_client.models.system_config_integrity_job import SystemConfigIntegrityJob +from typing import Optional, Set +from typing_extensions import Self + +class SystemConfigIntegrityChecks(BaseModel): + """ + Integrity checks config + """ # noqa: E501 + checksum_files: SystemConfigIntegrityChecksumJob = Field(alias="checksumFiles") + missing_files: SystemConfigIntegrityJob = Field(alias="missingFiles") + untracked_files: SystemConfigIntegrityJob = Field(alias="untrackedFiles") + __properties: ClassVar[List[str]] = ["checksumFiles", "missingFiles", "untrackedFiles"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemConfigIntegrityChecks from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of checksum_files + if self.checksum_files: + _dict['checksumFiles'] = self.checksum_files.to_dict() + # override the default output from pydantic by calling `to_dict()` of missing_files + if self.missing_files: + _dict['missingFiles'] = self.missing_files.to_dict() + # override the default output from pydantic by calling `to_dict()` of untracked_files + if self.untracked_files: + _dict['untrackedFiles'] = self.untracked_files.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemConfigIntegrityChecks from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "checksumFiles": SystemConfigIntegrityChecksumJob.from_dict(obj["checksumFiles"]) if obj.get("checksumFiles") is not None else None, + "missingFiles": SystemConfigIntegrityJob.from_dict(obj["missingFiles"]) if obj.get("missingFiles") is not None else None, + "untrackedFiles": SystemConfigIntegrityJob.from_dict(obj["untrackedFiles"]) if obj.get("untrackedFiles") is not None else None + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/system_config_integrity_checksum_job.py b/generated/immich/openapi_client/models/system_config_integrity_checksum_job.py new file mode 100644 index 0000000..8166279 --- /dev/null +++ b/generated/immich/openapi_client/models/system_config_integrity_checksum_job.py @@ -0,0 +1,94 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SystemConfigIntegrityChecksumJob(BaseModel): + """ + Integrity checksum job config + """ # noqa: E501 + cron_expression: StrictStr = Field(description="Cron expression for when the integrity check should run", alias="cronExpression") + enabled: StrictBool = Field(description="Enabled") + percentage_limit: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="Percentage limit of the integrity checksum job", alias="percentageLimit") + time_limit: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)] = Field(description="How long the integrity checksum job may run for", alias="timeLimit") + __properties: ClassVar[List[str]] = ["cronExpression", "enabled", "percentageLimit", "timeLimit"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemConfigIntegrityChecksumJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemConfigIntegrityChecksumJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cronExpression": obj.get("cronExpression"), + "enabled": obj.get("enabled"), + "percentageLimit": obj.get("percentageLimit"), + "timeLimit": obj.get("timeLimit") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/system_config_integrity_job.py b/generated/immich/openapi_client/models/system_config_integrity_job.py new file mode 100644 index 0000000..b0ad0ba --- /dev/null +++ b/generated/immich/openapi_client/models/system_config_integrity_job.py @@ -0,0 +1,89 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SystemConfigIntegrityJob(BaseModel): + """ + Integrity job config + """ # noqa: E501 + cron_expression: StrictStr = Field(description="Cron expression for when the integrity check should run", alias="cronExpression") + enabled: StrictBool = Field(description="Enabled") + __properties: ClassVar[List[str]] = ["cronExpression", "enabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemConfigIntegrityJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemConfigIntegrityJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cronExpression": obj.get("cronExpression"), + "enabled": obj.get("enabled") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/system_config_nightly_tasks_dto.py b/generated/immich/openapi_client/models/system_config_nightly_tasks_dto.py new file mode 100644 index 0000000..5e52880 --- /dev/null +++ b/generated/immich/openapi_client/models/system_config_nightly_tasks_dto.py @@ -0,0 +1,105 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SystemConfigNightlyTasksDto(BaseModel): + """ + SystemConfigNightlyTasksDto + """ # noqa: E501 + cluster_new_faces: StrictBool = Field(description="Cluster new faces", alias="clusterNewFaces") + database_cleanup: StrictBool = Field(description="Database cleanup", alias="databaseCleanup") + generate_memories: StrictBool = Field(description="Generate memories", alias="generateMemories") + missing_thumbnails: StrictBool = Field(description="Missing thumbnails", alias="missingThumbnails") + start_time: Annotated[str, Field(strict=True)] = Field(description="Start time (HH:MM)", alias="startTime") + sync_quota_usage: StrictBool = Field(description="Sync quota usage", alias="syncQuotaUsage") + __properties: ClassVar[List[str]] = ["clusterNewFaces", "databaseCleanup", "generateMemories", "missingThumbnails", "startTime", "syncQuotaUsage"] + + @field_validator('start_time') + def start_time_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^(?:[01]\d|2[0-3]):[0-5]\d$", value): + raise ValueError(r"must validate the regular expression /^(?:[01]\d|2[0-3]):[0-5]\d$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemConfigNightlyTasksDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemConfigNightlyTasksDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "clusterNewFaces": obj.get("clusterNewFaces"), + "databaseCleanup": obj.get("databaseCleanup"), + "generateMemories": obj.get("generateMemories"), + "missingThumbnails": obj.get("missingThumbnails"), + "startTime": obj.get("startTime"), + "syncQuotaUsage": obj.get("syncQuotaUsage") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/tag_bulk_assets_dto.py b/generated/immich/openapi_client/models/tag_bulk_assets_dto.py index 020f3f8..71f4f18 100644 --- a/generated/immich/openapi_client/models/tag_bulk_assets_dto.py +++ b/generated/immich/openapi_client/models/tag_bulk_assets_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, field_validator from typing import Any, ClassVar, Dict, List -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -27,8 +27,8 @@ class TagBulkAssetsDto(BaseModel): """ TagBulkAssetsDto """ # noqa: E501 - asset_ids: List[UUID] = Field(description="Asset IDs", alias="assetIds") - tag_ids: List[UUID] = Field(description="Tag IDs", alias="tagIds") + asset_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Asset IDs", alias="assetIds") + tag_ids: List[Annotated[str, Field(strict=True)]] = Field(description="Tag IDs", alias="tagIds") __properties: ClassVar[List[str]] = ["assetIds", "tagIds"] model_config = ConfigDict( diff --git a/generated/immich/openapi_client/models/tag_create_dto.py b/generated/immich/openapi_client/models/tag_create_dto.py index f64b99a..1c107d2 100644 --- a/generated/immich/openapi_client/models/tag_create_dto.py +++ b/generated/immich/openapi_client/models/tag_create_dto.py @@ -20,7 +20,6 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -30,7 +29,7 @@ class TagCreateDto(BaseModel): """ # noqa: E501 color: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Tag color (hex)") name: StrictStr = Field(description="Tag name") - parent_id: Optional[UUID] = Field(default=None, description="Parent tag ID", alias="parentId") + parent_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Parent tag ID", alias="parentId") __properties: ClassVar[List[str]] = ["color", "name", "parentId"] @field_validator('color') diff --git a/generated/immich/openapi_client/models/tag_response_dto.py b/generated/immich/openapi_client/models/tag_response_dto.py index fc10f04..b7541a2 100644 --- a/generated/immich/openapi_client/models/tag_response_dto.py +++ b/generated/immich/openapi_client/models/tag_response_dto.py @@ -18,9 +18,9 @@ import re # noqa: F401 import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,7 @@ class TagResponseDto(BaseModel): """ # noqa: E501 color: Optional[StrictStr] = Field(default=None, description="Tag color (hex)") created_at: datetime = Field(description="Creation date", alias="createdAt") - id: UUID = Field(description="Tag ID") + id: Annotated[str, Field(strict=True)] = Field(description="Tag ID") name: StrictStr = Field(description="Tag name") parent_id: Optional[StrictStr] = Field(default=None, description="Parent tag ID", alias="parentId") updated_at: datetime = Field(description="Last update date", alias="updatedAt") diff --git a/generated/immich/openapi_client/models/time_bucket_asset_response_dto.py b/generated/immich/openapi_client/models/time_bucket_asset_response_dto.py new file mode 100644 index 0000000..b1ae48c --- /dev/null +++ b/generated/immich/openapi_client/models/time_bucket_asset_response_dto.py @@ -0,0 +1,125 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from generated.immich.openapi_client.models.asset_visibility import AssetVisibility +from typing import Optional, Set +from typing_extensions import Self + +class TimeBucketAssetResponseDto(BaseModel): + """ + TimeBucketAssetResponseDto + """ # noqa: E501 + city: Optional[List[Optional[StrictStr]]] = Field(default=None, description="Array of city names extracted from EXIF GPS data") + country: Optional[List[Optional[StrictStr]]] = Field(default=None, description="Array of country names extracted from EXIF GPS data") + created_at: List[StrictStr] = Field(description="Array of UTC timestamps when each asset was originally uploaded to Immich", alias="createdAt") + duration: List[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]]] = Field(description="Array of video/gif durations in milliseconds (null for static images)") + file_created_at: List[StrictStr] = Field(description="Array of file creation timestamps in UTC", alias="fileCreatedAt") + id: List[StrictStr] = Field(description="Array of asset IDs in the time bucket") + is_favorite: List[StrictBool] = Field(description="Array indicating whether each asset is favorited", alias="isFavorite") + is_image: List[StrictBool] = Field(description="Array indicating whether each asset is an image (false for videos)", alias="isImage") + is_trashed: List[StrictBool] = Field(description="Array indicating whether each asset is in the trash", alias="isTrashed") + latitude: Optional[List[Optional[Union[StrictFloat, StrictInt]]]] = Field(default=None, description="Array of latitude coordinates extracted from EXIF GPS data") + live_photo_video_id: List[Optional[StrictStr]] = Field(description="Array of live photo video asset IDs (null for non-live photos)", alias="livePhotoVideoId") + local_offset_hours: List[Union[StrictFloat, StrictInt]] = Field(description="Array of UTC offset hours at the time each photo was taken. Positive values are east of UTC, negative values are west of UTC. Values may be fractional (e.g., 5.5 for +05:30, -9.75 for -09:45). Applying this offset to 'fileCreatedAt' will give you the time the photo was taken from the photographer's perspective.", alias="localOffsetHours") + longitude: Optional[List[Optional[Union[StrictFloat, StrictInt]]]] = Field(default=None, description="Array of longitude coordinates extracted from EXIF GPS data") + owner_id: List[StrictStr] = Field(description="Array of owner IDs for each asset", alias="ownerId") + projection_type: List[Optional[StrictStr]] = Field(description="Array of projection types for 360° content (e.g., \"EQUIRECTANGULAR\", \"CUBEFACE\", \"CYLINDRICAL\")", alias="projectionType") + ratio: List[Union[StrictFloat, StrictInt]] = Field(description="Array of aspect ratios (width/height) for each asset") + stack: Optional[List[Optional[Annotated[List[StrictStr], Field(min_length=2, max_length=2)]]]] = Field(default=None, description="Array of stack information as [stackId, assetCount] tuples (null for non-stacked assets)") + thumbhash: List[Optional[StrictStr]] = Field(description="Array of BlurHash strings for generating asset previews (base64 encoded)") + visibility: List[AssetVisibility] = Field(description="Array of visibility statuses for each asset (e.g., ARCHIVE, TIMELINE, HIDDEN, LOCKED)") + __properties: ClassVar[List[str]] = ["city", "country", "createdAt", "duration", "fileCreatedAt", "id", "isFavorite", "isImage", "isTrashed", "latitude", "livePhotoVideoId", "localOffsetHours", "longitude", "ownerId", "projectionType", "ratio", "stack", "thumbhash", "visibility"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TimeBucketAssetResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TimeBucketAssetResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "city": obj.get("city"), + "country": obj.get("country"), + "createdAt": obj.get("createdAt"), + "duration": obj.get("duration"), + "fileCreatedAt": obj.get("fileCreatedAt"), + "id": obj.get("id"), + "isFavorite": obj.get("isFavorite"), + "isImage": obj.get("isImage"), + "isTrashed": obj.get("isTrashed"), + "latitude": obj.get("latitude"), + "livePhotoVideoId": obj.get("livePhotoVideoId"), + "localOffsetHours": obj.get("localOffsetHours"), + "longitude": obj.get("longitude"), + "ownerId": obj.get("ownerId"), + "projectionType": obj.get("projectionType"), + "ratio": obj.get("ratio"), + "stack": obj.get("stack"), + "thumbhash": obj.get("thumbhash"), + "visibility": obj.get("visibility") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/time_buckets_response_dto.py b/generated/immich/openapi_client/models/time_buckets_response_dto.py new file mode 100644 index 0000000..20b1dbb --- /dev/null +++ b/generated/immich/openapi_client/models/time_buckets_response_dto.py @@ -0,0 +1,90 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class TimeBucketsResponseDto(BaseModel): + """ + TimeBucketsResponseDto + """ # noqa: E501 + count: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of assets in this time bucket") + time_bucket: StrictStr = Field(description="Time bucket identifier in YYYY-MM-DD format representing the start of the time period", alias="timeBucket") + __properties: ClassVar[List[str]] = ["count", "timeBucket"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TimeBucketsResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TimeBucketsResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "timeBucket": obj.get("timeBucket") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/update_album_dto.py b/generated/immich/openapi_client/models/update_album_dto.py index 0c1a998..a9f85dc 100644 --- a/generated/immich/openapi_client/models/update_album_dto.py +++ b/generated/immich/openapi_client/models/update_album_dto.py @@ -17,9 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from uuid import UUID +from typing_extensions import Annotated from generated.immich.openapi_client.models.asset_order import AssetOrder from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,7 @@ class UpdateAlbumDto(BaseModel): UpdateAlbumDto """ # noqa: E501 album_name: Optional[StrictStr] = Field(default=None, description="Album name", alias="albumName") - album_thumbnail_asset_id: Optional[UUID] = Field(default=None, description="Album thumbnail asset ID", alias="albumThumbnailAssetId") + album_thumbnail_asset_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Album thumbnail asset ID", alias="albumThumbnailAssetId") description: Optional[StrictStr] = Field(default=None, description="Album description") is_activity_enabled: Optional[StrictBool] = Field(default=None, description="Enable activity feed", alias="isActivityEnabled") order: Optional[AssetOrder] = None diff --git a/generated/immich/openapi_client/models/update_asset_dto.py b/generated/immich/openapi_client/models/update_asset_dto.py index 20dd4cb..9658270 100644 --- a/generated/immich/openapi_client/models/update_asset_dto.py +++ b/generated/immich/openapi_client/models/update_asset_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.asset_visibility import AssetVisibility from typing import Optional, Set from typing_extensions import Self @@ -33,7 +32,7 @@ class UpdateAssetDto(BaseModel): description: Optional[StrictStr] = Field(default=None, description="Asset description") is_favorite: Optional[StrictBool] = Field(default=None, description="Mark as favorite", alias="isFavorite") latitude: Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]] = Field(default=None, description="Latitude coordinate") - live_photo_video_id: Optional[UUID] = Field(default=None, description="Live photo video ID", alias="livePhotoVideoId") + live_photo_video_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="Live photo video ID", alias="livePhotoVideoId") longitude: Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]] = Field(default=None, description="Longitude coordinate") rating: Optional[Annotated[int, Field(le=5, strict=True, ge=-1)]] = Field(default=None, description="Rating in range [1-5] (starred), -1 (rejected), or null (unrated)") visibility: Optional[AssetVisibility] = None diff --git a/generated/immich/openapi_client/models/usage_by_user_dto.py b/generated/immich/openapi_client/models/usage_by_user_dto.py index f759390..aa8696b 100644 --- a/generated/immich/openapi_client/models/usage_by_user_dto.py +++ b/generated/immich/openapi_client/models/usage_by_user_dto.py @@ -17,10 +17,9 @@ import pprint import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from typing import Optional, Set from typing_extensions import Self @@ -33,7 +32,7 @@ class UsageByUserDto(BaseModel): usage: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Total storage usage in bytes") usage_photos: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Storage usage for photos in bytes", alias="usagePhotos") usage_videos: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Storage usage for videos in bytes", alias="usageVideos") - user_id: UUID = Field(description="User ID", alias="userId") + user_id: Annotated[str, Field(strict=True)] = Field(description="User ID", alias="userId") user_name: StrictStr = Field(description="User name", alias="userName") videos: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)] = Field(description="Number of videos") __properties: ClassVar[List[str]] = ["photos", "quotaSizeInBytes", "usage", "usagePhotos", "usageVideos", "userId", "userName", "videos"] diff --git a/generated/immich/openapi_client/models/user_admin_response_dto.py b/generated/immich/openapi_client/models/user_admin_response_dto.py index fbd79c2..3e1eaed 100644 --- a/generated/immich/openapi_client/models/user_admin_response_dto.py +++ b/generated/immich/openapi_client/models/user_admin_response_dto.py @@ -21,7 +21,6 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor from generated.immich.openapi_client.models.user_license import UserLicense from generated.immich.openapi_client.models.user_status import UserStatus @@ -36,7 +35,7 @@ class UserAdminResponseDto(BaseModel): created_at: datetime = Field(description="Creation date", alias="createdAt") deleted_at: Optional[datetime] = Field(description="Deletion date", alias="deletedAt") email: Annotated[str, Field(strict=True)] = Field(description="User email") - id: UUID = Field(description="User ID") + id: Annotated[str, Field(strict=True)] = Field(description="User ID") is_admin: StrictBool = Field(description="Is admin user", alias="isAdmin") license: Optional[UserLicense] name: StrictStr = Field(description="User name") diff --git a/generated/immich/openapi_client/models/user_metadata_key.py b/generated/immich/openapi_client/models/user_metadata_key.py new file mode 100644 index 0000000..e2830b4 --- /dev/null +++ b/generated/immich/openapi_client/models/user_metadata_key.py @@ -0,0 +1,38 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class UserMetadataKey(str, Enum): + """ + User metadata key + """ + + """ + allowed enum values + """ + PREFERENCES = 'preferences' + LICENSE = 'license' + ONBOARDING = 'onboarding' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of UserMetadataKey from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/user_response_dto.py b/generated/immich/openapi_client/models/user_response_dto.py index 099e30d..2c9e7f2 100644 --- a/generated/immich/openapi_client/models/user_response_dto.py +++ b/generated/immich/openapi_client/models/user_response_dto.py @@ -21,7 +21,6 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List from typing_extensions import Annotated -from uuid import UUID from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor from typing import Optional, Set from typing_extensions import Self @@ -32,7 +31,7 @@ class UserResponseDto(BaseModel): """ # noqa: E501 avatar_color: UserAvatarColor = Field(alias="avatarColor") email: Annotated[str, Field(strict=True)] = Field(description="User email") - id: UUID = Field(description="User ID") + id: Annotated[str, Field(strict=True)] = Field(description="User ID") name: StrictStr = Field(description="User name") profile_changed_at: datetime = Field(description="Profile change date", alias="profileChangedAt") profile_image_path: StrictStr = Field(description="Profile image path", alias="profileImagePath") diff --git a/generated/immich/openapi_client/models/version_check_state_response_dto.py b/generated/immich/openapi_client/models/version_check_state_response_dto.py new file mode 100644 index 0000000..0a55bf7 --- /dev/null +++ b/generated/immich/openapi_client/models/version_check_state_response_dto.py @@ -0,0 +1,99 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class VersionCheckStateResponseDto(BaseModel): + """ + VersionCheckStateResponseDto + """ # noqa: E501 + checked_at: Optional[StrictStr] = Field(description="Last check timestamp", alias="checkedAt") + release_version: Optional[StrictStr] = Field(description="Release version", alias="releaseVersion") + __properties: ClassVar[List[str]] = ["checkedAt", "releaseVersion"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of VersionCheckStateResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if checked_at (nullable) is None + # and model_fields_set contains the field + if self.checked_at is None and "checked_at" in self.model_fields_set: + _dict['checkedAt'] = None + + # set to None if release_version (nullable) is None + # and model_fields_set contains the field + if self.release_version is None and "release_version" in self.model_fields_set: + _dict['releaseVersion'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of VersionCheckStateResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "checkedAt": obj.get("checkedAt"), + "releaseVersion": obj.get("releaseVersion") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_create_dto.py b/generated/immich/openapi_client/models/workflow_create_dto.py new file mode 100644 index 0000000..a852e9e --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_create_dto.py @@ -0,0 +1,114 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.workflow_step_dto import WorkflowStepDto +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowCreateDto(BaseModel): + """ + WorkflowCreateDto + """ # noqa: E501 + description: Optional[StrictStr] = Field(default=None, description="Workflow description") + enabled: Optional[StrictBool] = Field(default=None, description="Workflow enabled") + name: Optional[StrictStr] = Field(default=None, description="Workflow name") + steps: Optional[List[WorkflowStepDto]] = None + trigger: WorkflowTrigger + __properties: ClassVar[List[str]] = ["description", "enabled", "name", "steps", "trigger"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowCreateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in steps (list) + _items = [] + if self.steps: + for _item_steps in self.steps: + if _item_steps: + _items.append(_item_steps.to_dict()) + _dict['steps'] = _items + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowCreateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "enabled": obj.get("enabled"), + "name": obj.get("name"), + "steps": [WorkflowStepDto.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None, + "trigger": obj.get("trigger") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_response_dto.py b/generated/immich/openapi_client/models/workflow_response_dto.py new file mode 100644 index 0000000..7274693 --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_response_dto.py @@ -0,0 +1,128 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from generated.immich.openapi_client.models.workflow_step_dto import WorkflowStepDto +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowResponseDto(BaseModel): + """ + WorkflowResponseDto + """ # noqa: E501 + created_at: StrictStr = Field(description="Creation date", alias="createdAt") + description: Optional[StrictStr] = Field(description="Workflow description") + enabled: StrictBool = Field(description="Workflow enabled") + id: Annotated[str, Field(strict=True)] = Field(description="Workflow ID") + name: Optional[StrictStr] = Field(description="Workflow name") + steps: List[WorkflowStepDto] = Field(description="Workflow steps") + trigger: WorkflowTrigger + updated_at: StrictStr = Field(description="Update date", alias="updatedAt") + __properties: ClassVar[List[str]] = ["createdAt", "description", "enabled", "id", "name", "steps", "trigger", "updatedAt"] + + @field_validator('id') + def id_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", value): + raise ValueError(r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in steps (list) + _items = [] + if self.steps: + for _item_steps in self.steps: + if _item_steps: + _items.append(_item_steps.to_dict()) + _dict['steps'] = _items + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "createdAt": obj.get("createdAt"), + "description": obj.get("description"), + "enabled": obj.get("enabled"), + "id": obj.get("id"), + "name": obj.get("name"), + "steps": [WorkflowStepDto.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None, + "trigger": obj.get("trigger"), + "updatedAt": obj.get("updatedAt") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_share_response_dto.py b/generated/immich/openapi_client/models/workflow_share_response_dto.py new file mode 100644 index 0000000..8ffc7db --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_share_response_dto.py @@ -0,0 +1,112 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.workflow_share_step_dto import WorkflowShareStepDto +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowShareResponseDto(BaseModel): + """ + WorkflowShareResponseDto + """ # noqa: E501 + description: Optional[StrictStr] = Field(description="Workflow description") + name: Optional[StrictStr] = Field(description="Workflow name") + steps: List[WorkflowShareStepDto] = Field(description="Workflow steps") + trigger: WorkflowTrigger + __properties: ClassVar[List[str]] = ["description", "name", "steps", "trigger"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowShareResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in steps (list) + _items = [] + if self.steps: + for _item_steps in self.steps: + if _item_steps: + _items.append(_item_steps.to_dict()) + _dict['steps'] = _items + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowShareResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "name": obj.get("name"), + "steps": [WorkflowShareStepDto.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None, + "trigger": obj.get("trigger") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_share_step_dto.py b/generated/immich/openapi_client/models/workflow_share_step_dto.py new file mode 100644 index 0000000..6601305 --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_share_step_dto.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowShareStepDto(BaseModel): + """ + WorkflowShareStepDto + """ # noqa: E501 + config: Optional[Dict[str, Any]] = Field(description="Step configuration") + enabled: Optional[StrictBool] = Field(default=None, description="Step is enabled") + method: StrictStr = Field(description="Step plugin method") + __properties: ClassVar[List[str]] = ["config", "enabled", "method"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowShareStepDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if config (nullable) is None + # and model_fields_set contains the field + if self.config is None and "config" in self.model_fields_set: + _dict['config'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowShareStepDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": obj.get("config"), + "enabled": obj.get("enabled"), + "method": obj.get("method") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_step_dto.py b/generated/immich/openapi_client/models/workflow_step_dto.py new file mode 100644 index 0000000..7b99c77 --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_step_dto.py @@ -0,0 +1,96 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowStepDto(BaseModel): + """ + WorkflowStepDto + """ # noqa: E501 + config: Optional[Dict[str, Any]] = Field(description="Step configuration") + enabled: Optional[StrictBool] = Field(default=None, description="Step is enabled") + method: StrictStr = Field(description="Step plugin method") + __properties: ClassVar[List[str]] = ["config", "enabled", "method"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowStepDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if config (nullable) is None + # and model_fields_set contains the field + if self.config is None and "config" in self.model_fields_set: + _dict['config'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowStepDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": obj.get("config"), + "enabled": obj.get("enabled"), + "method": obj.get("method") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_trigger.py b/generated/immich/openapi_client/models/workflow_trigger.py new file mode 100644 index 0000000..da53fa0 --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_trigger.py @@ -0,0 +1,37 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class WorkflowTrigger(str, Enum): + """ + Plugin trigger type + """ + + """ + allowed enum values + """ + ASSETCREATE = 'AssetCreate' + ASSETMETADATAEXTRACTION = 'AssetMetadataExtraction' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WorkflowTrigger from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/workflow_trigger_response_dto.py b/generated/immich/openapi_client/models/workflow_trigger_response_dto.py new file mode 100644 index 0000000..6ea3c73 --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_trigger_response_dto.py @@ -0,0 +1,91 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from generated.immich.openapi_client.models.workflow_type import WorkflowType +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowTriggerResponseDto(BaseModel): + """ + WorkflowTriggerResponseDto + """ # noqa: E501 + trigger: WorkflowTrigger + types: List[WorkflowType] = Field(description="Workflow types") + __properties: ClassVar[List[str]] = ["trigger", "types"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowTriggerResponseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowTriggerResponseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "trigger": obj.get("trigger"), + "types": obj.get("types") + }) + return _obj + + diff --git a/generated/immich/openapi_client/models/workflow_type.py b/generated/immich/openapi_client/models/workflow_type.py new file mode 100644 index 0000000..203109e --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_type.py @@ -0,0 +1,36 @@ +# 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 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class WorkflowType(str, Enum): + """ + Workflow type + """ + + """ + allowed enum values + """ + ASSETV1 = 'AssetV1' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WorkflowType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/generated/immich/openapi_client/models/workflow_update_dto.py b/generated/immich/openapi_client/models/workflow_update_dto.py new file mode 100644 index 0000000..3b65205 --- /dev/null +++ b/generated/immich/openapi_client/models/workflow_update_dto.py @@ -0,0 +1,114 @@ +# 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 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from generated.immich.openapi_client.models.workflow_step_dto import WorkflowStepDto +from generated.immich.openapi_client.models.workflow_trigger import WorkflowTrigger +from typing import Optional, Set +from typing_extensions import Self + +class WorkflowUpdateDto(BaseModel): + """ + WorkflowUpdateDto + """ # noqa: E501 + description: Optional[StrictStr] = Field(default=None, description="Workflow description") + enabled: Optional[StrictBool] = Field(default=None, description="Workflow enabled") + name: Optional[StrictStr] = Field(default=None, description="Workflow name") + steps: Optional[List[WorkflowStepDto]] = None + trigger: Optional[WorkflowTrigger] = None + __properties: ClassVar[List[str]] = ["description", "enabled", "name", "steps", "trigger"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of WorkflowUpdateDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in steps (list) + _items = [] + if self.steps: + for _item_steps in self.steps: + if _item_steps: + _items.append(_item_steps.to_dict()) + _dict['steps'] = _items + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of WorkflowUpdateDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "description": obj.get("description"), + "enabled": obj.get("enabled"), + "name": obj.get("name"), + "steps": [WorkflowStepDto.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None, + "trigger": obj.get("trigger") + }) + return _obj + + diff --git a/generated/immich/openapi_client/rest.py b/generated/immich/openapi_client/rest.py index 971bb53..ae214a3 100644 --- a/generated/immich/openapi_client/rest.py +++ b/generated/immich/openapi_client/rest.py @@ -48,17 +48,12 @@ class RESTResponse(io.IOBase): self.data = self.response.data return self.data - @property - def headers(self): - """Returns a dictionary of response headers.""" - return self.response.headers - def getheaders(self): - """Returns a dictionary of the response headers; use ``headers`` instead.""" + """Returns a dictionary of the response headers.""" return self.response.headers def getheader(self, name, default=None): - """Returns a given response header; use ``headers.get()`` instead.""" + """Returns a given response header.""" return self.response.headers.get(name, default) @@ -81,7 +76,6 @@ class RESTClientObject: "ca_certs": configuration.ssl_ca_cert, "cert_file": configuration.cert_file, "key_file": configuration.key_file, - "ca_cert_data": configuration.ca_cert_data, } if configuration.assert_hostname is not None: pool_args['assert_hostname'] = ( diff --git a/generated/immich/openapi_client/test/__init__.py b/generated/immich/openapi_client/test/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/generated/immich/openapi_client/test/test_activities_api.py b/generated/immich/openapi_client/test/test_activities_api.py deleted file mode 100644 index b3d0a34..0000000 --- a/generated/immich/openapi_client/test/test_activities_api.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.api.activities_api import ActivitiesApi - - -class TestActivitiesApi(unittest.TestCase): - """ActivitiesApi unit test stubs""" - - def setUp(self) -> None: - self.api = ActivitiesApi() - - def tearDown(self) -> None: - pass - - def test_create_activity(self) -> None: - """Test case for create_activity - - Create an activity - """ - pass - - def test_delete_activity(self) -> None: - """Test case for delete_activity - - Delete an activity - """ - pass - - def test_get_activities(self) -> None: - """Test case for get_activities - - List all activities - """ - pass - - def test_get_activity_statistics(self) -> None: - """Test case for get_activity_statistics - - Retrieve activity statistics - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_activity_create_dto.py b/generated/immich/openapi_client/test/test_activity_create_dto.py deleted file mode 100644 index 9ed64b2..0000000 --- a/generated/immich/openapi_client/test/test_activity_create_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.activity_create_dto import ActivityCreateDto - -class TestActivityCreateDto(unittest.TestCase): - """ActivityCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ActivityCreateDto: - """Test ActivityCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ActivityCreateDto` - """ - model = ActivityCreateDto() - if include_optional: - return ActivityCreateDto( - album_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - comment = '', - type = 'comment' - ) - else: - return ActivityCreateDto( - album_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - type = 'comment', - ) - """ - - def testActivityCreateDto(self): - """Test ActivityCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_activity_response_dto.py b/generated/immich/openapi_client/test/test_activity_response_dto.py deleted file mode 100644 index b79253e..0000000 --- a/generated/immich/openapi_client/test/test_activity_response_dto.py +++ /dev/null @@ -1,73 +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 unittest - -from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto - -class TestActivityResponseDto(unittest.TestCase): - """ActivityResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ActivityResponseDto: - """Test ActivityResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ActivityResponseDto` - """ - model = ActivityResponseDto() - if include_optional: - return ActivityResponseDto( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - comment = '', - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - type = 'comment', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ) - ) - else: - return ActivityResponseDto( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - type = 'comment', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - ) - """ - - def testActivityResponseDto(self): - """Test ActivityResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_activity_statistics_response_dto.py b/generated/immich/openapi_client/test/test_activity_statistics_response_dto.py deleted file mode 100644 index 3e5d74f..0000000 --- a/generated/immich/openapi_client/test/test_activity_statistics_response_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.activity_statistics_response_dto import ActivityStatisticsResponseDto - -class TestActivityStatisticsResponseDto(unittest.TestCase): - """ActivityStatisticsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ActivityStatisticsResponseDto: - """Test ActivityStatisticsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ActivityStatisticsResponseDto` - """ - model = ActivityStatisticsResponseDto() - if include_optional: - return ActivityStatisticsResponseDto( - comments = 0, - likes = 0 - ) - else: - return ActivityStatisticsResponseDto( - comments = 0, - likes = 0, - ) - """ - - def testActivityStatisticsResponseDto(self): - """Test ActivityStatisticsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_add_users_dto.py b/generated/immich/openapi_client/test/test_add_users_dto.py deleted file mode 100644 index 065c318..0000000 --- a/generated/immich/openapi_client/test/test_add_users_dto.py +++ /dev/null @@ -1,60 +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 unittest - -from generated.immich.openapi_client.models.add_users_dto import AddUsersDto - -class TestAddUsersDto(unittest.TestCase): - """AddUsersDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AddUsersDto: - """Test AddUsersDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AddUsersDto` - """ - model = AddUsersDto() - if include_optional: - return AddUsersDto( - album_users = [ - generated.immich.openapi_client.models.album_user_add_dto.AlbumUserAddDto( - role = 'editor', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ] - ) - else: - return AddUsersDto( - album_users = [ - generated.immich.openapi_client.models.album_user_add_dto.AlbumUserAddDto( - role = 'editor', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - ) - """ - - def testAddUsersDto(self): - """Test AddUsersDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_admin_onboarding_update_dto.py b/generated/immich/openapi_client/test/test_admin_onboarding_update_dto.py deleted file mode 100644 index 0641aea..0000000 --- a/generated/immich/openapi_client/test/test_admin_onboarding_update_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.admin_onboarding_update_dto import AdminOnboardingUpdateDto - -class TestAdminOnboardingUpdateDto(unittest.TestCase): - """AdminOnboardingUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AdminOnboardingUpdateDto: - """Test AdminOnboardingUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AdminOnboardingUpdateDto` - """ - model = AdminOnboardingUpdateDto() - if include_optional: - return AdminOnboardingUpdateDto( - is_onboarded = True - ) - else: - return AdminOnboardingUpdateDto( - is_onboarded = True, - ) - """ - - def testAdminOnboardingUpdateDto(self): - """Test AdminOnboardingUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_album_response_dto.py b/generated/immich/openapi_client/test/test_album_response_dto.py deleted file mode 100644 index d057c75..0000000 --- a/generated/immich/openapi_client/test/test_album_response_dto.py +++ /dev/null @@ -1,101 +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 unittest - -from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto - -class TestAlbumResponseDto(unittest.TestCase): - """AlbumResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AlbumResponseDto: - """Test AlbumResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AlbumResponseDto` - """ - model = AlbumResponseDto() - if include_optional: - return AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - contributor_counts = [ - generated.immich.openapi_client.models.contributor_count_response_dto.ContributorCountResponseDto( - asset_count = 0, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - last_modified_asset_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - order = 'asc', - shared = True, - start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') - ) - else: - return AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - shared = True, - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - ) - """ - - def testAlbumResponseDto(self): - """Test AlbumResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_album_statistics_response_dto.py b/generated/immich/openapi_client/test/test_album_statistics_response_dto.py deleted file mode 100644 index ffd5adb..0000000 --- a/generated/immich/openapi_client/test/test_album_statistics_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.album_statistics_response_dto import AlbumStatisticsResponseDto - -class TestAlbumStatisticsResponseDto(unittest.TestCase): - """AlbumStatisticsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AlbumStatisticsResponseDto: - """Test AlbumStatisticsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AlbumStatisticsResponseDto` - """ - model = AlbumStatisticsResponseDto() - if include_optional: - return AlbumStatisticsResponseDto( - not_shared = 0, - owned = 0, - shared = 0 - ) - else: - return AlbumStatisticsResponseDto( - not_shared = 0, - owned = 0, - shared = 0, - ) - """ - - def testAlbumStatisticsResponseDto(self): - """Test AlbumStatisticsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_album_user_add_dto.py b/generated/immich/openapi_client/test/test_album_user_add_dto.py deleted file mode 100644 index cd9563d..0000000 --- a/generated/immich/openapi_client/test/test_album_user_add_dto.py +++ /dev/null @@ -1,53 +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 unittest - -from generated.immich.openapi_client.models.album_user_add_dto import AlbumUserAddDto - -class TestAlbumUserAddDto(unittest.TestCase): - """AlbumUserAddDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AlbumUserAddDto: - """Test AlbumUserAddDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AlbumUserAddDto` - """ - model = AlbumUserAddDto() - if include_optional: - return AlbumUserAddDto( - role = 'editor', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return AlbumUserAddDto( - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testAlbumUserAddDto(self): - """Test AlbumUserAddDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_album_user_create_dto.py b/generated/immich/openapi_client/test/test_album_user_create_dto.py deleted file mode 100644 index 304608b..0000000 --- a/generated/immich/openapi_client/test/test_album_user_create_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.album_user_create_dto import AlbumUserCreateDto - -class TestAlbumUserCreateDto(unittest.TestCase): - """AlbumUserCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AlbumUserCreateDto: - """Test AlbumUserCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AlbumUserCreateDto` - """ - model = AlbumUserCreateDto() - if include_optional: - return AlbumUserCreateDto( - role = 'editor', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return AlbumUserCreateDto( - role = 'editor', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testAlbumUserCreateDto(self): - """Test AlbumUserCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_album_user_response_dto.py b/generated/immich/openapi_client/test/test_album_user_response_dto.py deleted file mode 100644 index 256f365..0000000 --- a/generated/immich/openapi_client/test/test_album_user_response_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.album_user_response_dto import AlbumUserResponseDto - -class TestAlbumUserResponseDto(unittest.TestCase): - """AlbumUserResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AlbumUserResponseDto: - """Test AlbumUserResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AlbumUserResponseDto` - """ - model = AlbumUserResponseDto() - if include_optional: - return AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ) - ) - else: - return AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - ) - """ - - def testAlbumUserResponseDto(self): - """Test AlbumUserResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_album_user_role.py b/generated/immich/openapi_client/test/test_album_user_role.py deleted file mode 100644 index 63aeb6d..0000000 --- a/generated/immich/openapi_client/test/test_album_user_role.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.album_user_role import AlbumUserRole - -class TestAlbumUserRole(unittest.TestCase): - """AlbumUserRole unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAlbumUserRole(self): - """Test AlbumUserRole""" - # inst = AlbumUserRole() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_albums_api.py b/generated/immich/openapi_client/test/test_albums_api.py deleted file mode 100644 index 6f6d4bd..0000000 --- a/generated/immich/openapi_client/test/test_albums_api.py +++ /dev/null @@ -1,122 +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 unittest - -from generated.immich.openapi_client.api.albums_api import AlbumsApi - - -class TestAlbumsApi(unittest.TestCase): - """AlbumsApi unit test stubs""" - - def setUp(self) -> None: - self.api = AlbumsApi() - - def tearDown(self) -> None: - pass - - def test_add_assets_to_album(self) -> None: - """Test case for add_assets_to_album - - Add assets to an album - """ - pass - - def test_add_assets_to_albums(self) -> None: - """Test case for add_assets_to_albums - - Add assets to albums - """ - pass - - def test_add_users_to_album(self) -> None: - """Test case for add_users_to_album - - Share album with users - """ - pass - - def test_create_album(self) -> None: - """Test case for create_album - - Create an album - """ - pass - - def test_delete_album(self) -> None: - """Test case for delete_album - - Delete an album - """ - pass - - def test_get_album_info(self) -> None: - """Test case for get_album_info - - Retrieve an album - """ - pass - - def test_get_album_map_markers(self) -> None: - """Test case for get_album_map_markers - - Retrieve album map markers - """ - pass - - def test_get_album_statistics(self) -> None: - """Test case for get_album_statistics - - Retrieve album statistics - """ - pass - - def test_get_all_albums(self) -> None: - """Test case for get_all_albums - - List all albums - """ - pass - - def test_remove_asset_from_album(self) -> None: - """Test case for remove_asset_from_album - - Remove assets from an album - """ - pass - - def test_remove_user_from_album(self) -> None: - """Test case for remove_user_from_album - - Remove user from album - """ - pass - - def test_update_album_info(self) -> None: - """Test case for update_album_info - - Update an album - """ - pass - - def test_update_album_user(self) -> None: - """Test case for update_album_user - - Update user role - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_api_key_create_dto.py b/generated/immich/openapi_client/test/test_api_key_create_dto.py deleted file mode 100644 index f933b6d..0000000 --- a/generated/immich/openapi_client/test/test_api_key_create_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.api_key_create_dto import ApiKeyCreateDto - -class TestApiKeyCreateDto(unittest.TestCase): - """ApiKeyCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ApiKeyCreateDto: - """Test ApiKeyCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ApiKeyCreateDto` - """ - model = ApiKeyCreateDto() - if include_optional: - return ApiKeyCreateDto( - name = '', - permissions = [ - 'all' - ] - ) - else: - return ApiKeyCreateDto( - permissions = [ - 'all' - ], - ) - """ - - def testApiKeyCreateDto(self): - """Test ApiKeyCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_api_key_create_response_dto.py b/generated/immich/openapi_client/test/test_api_key_create_response_dto.py deleted file mode 100644 index dcd36ee..0000000 --- a/generated/immich/openapi_client/test/test_api_key_create_response_dto.py +++ /dev/null @@ -1,68 +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 unittest - -from generated.immich.openapi_client.models.api_key_create_response_dto import ApiKeyCreateResponseDto - -class TestApiKeyCreateResponseDto(unittest.TestCase): - """ApiKeyCreateResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ApiKeyCreateResponseDto: - """Test ApiKeyCreateResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ApiKeyCreateResponseDto` - """ - model = ApiKeyCreateResponseDto() - if include_optional: - return ApiKeyCreateResponseDto( - api_key = generated.immich.openapi_client.models.api_key_response_dto.ApiKeyResponseDto( - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - permissions = [ - 'all' - ], - updated_at = '2024-01-01T00:00Z', ), - secret = '' - ) - else: - return ApiKeyCreateResponseDto( - api_key = generated.immich.openapi_client.models.api_key_response_dto.ApiKeyResponseDto( - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - permissions = [ - 'all' - ], - updated_at = '2024-01-01T00:00Z', ), - secret = '', - ) - """ - - def testApiKeyCreateResponseDto(self): - """Test ApiKeyCreateResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_api_key_response_dto.py b/generated/immich/openapi_client/test/test_api_key_response_dto.py deleted file mode 100644 index b454a66..0000000 --- a/generated/immich/openapi_client/test/test_api_key_response_dto.py +++ /dev/null @@ -1,64 +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 unittest - -from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto - -class TestApiKeyResponseDto(unittest.TestCase): - """ApiKeyResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ApiKeyResponseDto: - """Test ApiKeyResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ApiKeyResponseDto` - """ - model = ApiKeyResponseDto() - if include_optional: - return ApiKeyResponseDto( - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - permissions = [ - 'all' - ], - updated_at = '2024-01-01T00:00Z' - ) - else: - return ApiKeyResponseDto( - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - permissions = [ - 'all' - ], - updated_at = '2024-01-01T00:00Z', - ) - """ - - def testApiKeyResponseDto(self): - """Test ApiKeyResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_api_key_update_dto.py b/generated/immich/openapi_client/test/test_api_key_update_dto.py deleted file mode 100644 index b090b8d..0000000 --- a/generated/immich/openapi_client/test/test_api_key_update_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto - -class TestApiKeyUpdateDto(unittest.TestCase): - """ApiKeyUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ApiKeyUpdateDto: - """Test ApiKeyUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ApiKeyUpdateDto` - """ - model = ApiKeyUpdateDto() - if include_optional: - return ApiKeyUpdateDto( - name = '', - permissions = [ - 'all' - ] - ) - else: - return ApiKeyUpdateDto( - ) - """ - - def testApiKeyUpdateDto(self): - """Test ApiKeyUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_api_keys_api.py b/generated/immich/openapi_client/test/test_api_keys_api.py deleted file mode 100644 index cfe05a1..0000000 --- a/generated/immich/openapi_client/test/test_api_keys_api.py +++ /dev/null @@ -1,73 +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 unittest - -from generated.immich.openapi_client.api.api_keys_api import APIKeysApi - - -class TestAPIKeysApi(unittest.TestCase): - """APIKeysApi unit test stubs""" - - def setUp(self) -> None: - self.api = APIKeysApi() - - def tearDown(self) -> None: - pass - - def test_create_api_key(self) -> None: - """Test case for create_api_key - - Create an API key - """ - pass - - def test_delete_api_key(self) -> None: - """Test case for delete_api_key - - Delete an API key - """ - pass - - def test_get_api_key(self) -> None: - """Test case for get_api_key - - Retrieve an API key - """ - pass - - def test_get_api_keys(self) -> None: - """Test case for get_api_keys - - List all API keys - """ - pass - - def test_get_my_api_key(self) -> None: - """Test case for get_my_api_key - - Retrieve the current API key - """ - pass - - def test_update_api_key(self) -> None: - """Test case for update_api_key - - Update an API key - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_bulk_delete_dto.py b/generated/immich/openapi_client/test/test_asset_bulk_delete_dto.py deleted file mode 100644 index a77f4e7..0000000 --- a/generated/immich/openapi_client/test/test_asset_bulk_delete_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.asset_bulk_delete_dto import AssetBulkDeleteDto - -class TestAssetBulkDeleteDto(unittest.TestCase): - """AssetBulkDeleteDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetBulkDeleteDto: - """Test AssetBulkDeleteDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetBulkDeleteDto` - """ - model = AssetBulkDeleteDto() - if include_optional: - return AssetBulkDeleteDto( - force = True, - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return AssetBulkDeleteDto( - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testAssetBulkDeleteDto(self): - """Test AssetBulkDeleteDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_bulk_update_dto.py b/generated/immich/openapi_client/test/test_asset_bulk_update_dto.py deleted file mode 100644 index e027036..0000000 --- a/generated/immich/openapi_client/test/test_asset_bulk_update_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto - -class TestAssetBulkUpdateDto(unittest.TestCase): - """AssetBulkUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetBulkUpdateDto: - """Test AssetBulkUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetBulkUpdateDto` - """ - model = AssetBulkUpdateDto() - if include_optional: - return AssetBulkUpdateDto( - date_time_original = '', - date_time_relative = -9007199254740991, - description = '', - duplicate_id = '', - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - is_favorite = True, - latitude = -90, - longitude = -180, - rating = -1, - time_zone = '', - visibility = 'archive' - ) - else: - return AssetBulkUpdateDto( - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testAssetBulkUpdateDto(self): - """Test AssetBulkUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_dto.py b/generated/immich/openapi_client/test/test_asset_bulk_upload_check_dto.py deleted file mode 100644 index f6608f4..0000000 --- a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_dto.py +++ /dev/null @@ -1,60 +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 unittest - -from generated.immich.openapi_client.models.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto - -class TestAssetBulkUploadCheckDto(unittest.TestCase): - """AssetBulkUploadCheckDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetBulkUploadCheckDto: - """Test AssetBulkUploadCheckDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetBulkUploadCheckDto` - """ - model = AssetBulkUploadCheckDto() - if include_optional: - return AssetBulkUploadCheckDto( - assets = [ - generated.immich.openapi_client.models.asset_bulk_upload_check_item.AssetBulkUploadCheckItem( - checksum = '', - id = '', ) - ] - ) - else: - return AssetBulkUploadCheckDto( - assets = [ - generated.immich.openapi_client.models.asset_bulk_upload_check_item.AssetBulkUploadCheckItem( - checksum = '', - id = '', ) - ], - ) - """ - - def testAssetBulkUploadCheckDto(self): - """Test AssetBulkUploadCheckDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_item.py b/generated/immich/openapi_client/test/test_asset_bulk_upload_check_item.py deleted file mode 100644 index 3be618d..0000000 --- a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_item.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.asset_bulk_upload_check_item import AssetBulkUploadCheckItem - -class TestAssetBulkUploadCheckItem(unittest.TestCase): - """AssetBulkUploadCheckItem unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetBulkUploadCheckItem: - """Test AssetBulkUploadCheckItem - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetBulkUploadCheckItem` - """ - model = AssetBulkUploadCheckItem() - if include_optional: - return AssetBulkUploadCheckItem( - checksum = '', - id = '' - ) - else: - return AssetBulkUploadCheckItem( - checksum = '', - id = '', - ) - """ - - def testAssetBulkUploadCheckItem(self): - """Test AssetBulkUploadCheckItem""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_response_dto.py b/generated/immich/openapi_client/test/test_asset_bulk_upload_check_response_dto.py deleted file mode 100644 index e84708e..0000000 --- a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_response_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.asset_bulk_upload_check_response_dto import AssetBulkUploadCheckResponseDto - -class TestAssetBulkUploadCheckResponseDto(unittest.TestCase): - """AssetBulkUploadCheckResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetBulkUploadCheckResponseDto: - """Test AssetBulkUploadCheckResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetBulkUploadCheckResponseDto` - """ - model = AssetBulkUploadCheckResponseDto() - if include_optional: - return AssetBulkUploadCheckResponseDto( - results = [ - generated.immich.openapi_client.models.asset_bulk_upload_check_result.AssetBulkUploadCheckResult( - action = 'accept', - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - id = '', - is_trashed = True, - reason = 'duplicate', ) - ] - ) - else: - return AssetBulkUploadCheckResponseDto( - results = [ - generated.immich.openapi_client.models.asset_bulk_upload_check_result.AssetBulkUploadCheckResult( - action = 'accept', - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - id = '', - is_trashed = True, - reason = 'duplicate', ) - ], - ) - """ - - def testAssetBulkUploadCheckResponseDto(self): - """Test AssetBulkUploadCheckResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_result.py b/generated/immich/openapi_client/test/test_asset_bulk_upload_check_result.py deleted file mode 100644 index 7b8d9bc..0000000 --- a/generated/immich/openapi_client/test/test_asset_bulk_upload_check_result.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.asset_bulk_upload_check_result import AssetBulkUploadCheckResult - -class TestAssetBulkUploadCheckResult(unittest.TestCase): - """AssetBulkUploadCheckResult unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetBulkUploadCheckResult: - """Test AssetBulkUploadCheckResult - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetBulkUploadCheckResult` - """ - model = AssetBulkUploadCheckResult() - if include_optional: - return AssetBulkUploadCheckResult( - action = 'accept', - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - id = '', - is_trashed = True, - reason = 'duplicate' - ) - else: - return AssetBulkUploadCheckResult( - action = 'accept', - id = '', - ) - """ - - def testAssetBulkUploadCheckResult(self): - """Test AssetBulkUploadCheckResult""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_face_create_dto.py b/generated/immich/openapi_client/test/test_asset_face_create_dto.py deleted file mode 100644 index ae72c9e..0000000 --- a/generated/immich/openapi_client/test/test_asset_face_create_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto - -class TestAssetFaceCreateDto(unittest.TestCase): - """AssetFaceCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetFaceCreateDto: - """Test AssetFaceCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetFaceCreateDto` - """ - model = AssetFaceCreateDto() - if include_optional: - return AssetFaceCreateDto( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - height = -9007199254740991, - image_height = -9007199254740991, - image_width = -9007199254740991, - person_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - width = -9007199254740991, - x = -9007199254740991, - y = -9007199254740991 - ) - else: - return AssetFaceCreateDto( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - height = -9007199254740991, - image_height = -9007199254740991, - image_width = -9007199254740991, - person_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - width = -9007199254740991, - x = -9007199254740991, - y = -9007199254740991, - ) - """ - - def testAssetFaceCreateDto(self): - """Test AssetFaceCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_face_delete_dto.py b/generated/immich/openapi_client/test/test_asset_face_delete_dto.py deleted file mode 100644 index ad1def2..0000000 --- a/generated/immich/openapi_client/test/test_asset_face_delete_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto - -class TestAssetFaceDeleteDto(unittest.TestCase): - """AssetFaceDeleteDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetFaceDeleteDto: - """Test AssetFaceDeleteDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetFaceDeleteDto` - """ - model = AssetFaceDeleteDto() - if include_optional: - return AssetFaceDeleteDto( - force = True - ) - else: - return AssetFaceDeleteDto( - force = True, - ) - """ - - def testAssetFaceDeleteDto(self): - """Test AssetFaceDeleteDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_face_response_dto.py b/generated/immich/openapi_client/test/test_asset_face_response_dto.py deleted file mode 100644 index f350aa9..0000000 --- a/generated/immich/openapi_client/test/test_asset_face_response_dto.py +++ /dev/null @@ -1,83 +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 unittest - -from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto - -class TestAssetFaceResponseDto(unittest.TestCase): - """AssetFaceResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetFaceResponseDto: - """Test AssetFaceResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetFaceResponseDto` - """ - model = AssetFaceResponseDto() - if include_optional: - return AssetFaceResponseDto( - bounding_box_x1 = -9007199254740991, - bounding_box_x2 = -9007199254740991, - bounding_box_y1 = -9007199254740991, - bounding_box_y2 = -9007199254740991, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - image_height = 0, - image_width = 0, - person = generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), - source_type = 'machine-learning' - ) - else: - return AssetFaceResponseDto( - bounding_box_x1 = -9007199254740991, - bounding_box_x2 = -9007199254740991, - bounding_box_y1 = -9007199254740991, - bounding_box_y2 = -9007199254740991, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - image_height = 0, - image_width = 0, - person = generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), - ) - """ - - def testAssetFaceResponseDto(self): - """Test AssetFaceResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_face_update_dto.py b/generated/immich/openapi_client/test/test_asset_face_update_dto.py deleted file mode 100644 index b840909..0000000 --- a/generated/immich/openapi_client/test/test_asset_face_update_dto.py +++ /dev/null @@ -1,60 +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 unittest - -from generated.immich.openapi_client.models.asset_face_update_dto import AssetFaceUpdateDto - -class TestAssetFaceUpdateDto(unittest.TestCase): - """AssetFaceUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetFaceUpdateDto: - """Test AssetFaceUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetFaceUpdateDto` - """ - model = AssetFaceUpdateDto() - if include_optional: - return AssetFaceUpdateDto( - data = [ - generated.immich.openapi_client.models.asset_face_update_item.AssetFaceUpdateItem( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - person_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ] - ) - else: - return AssetFaceUpdateDto( - data = [ - generated.immich.openapi_client.models.asset_face_update_item.AssetFaceUpdateItem( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - person_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - ) - """ - - def testAssetFaceUpdateDto(self): - """Test AssetFaceUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_face_update_item.py b/generated/immich/openapi_client/test/test_asset_face_update_item.py deleted file mode 100644 index cb85cf4..0000000 --- a/generated/immich/openapi_client/test/test_asset_face_update_item.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.asset_face_update_item import AssetFaceUpdateItem - -class TestAssetFaceUpdateItem(unittest.TestCase): - """AssetFaceUpdateItem unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetFaceUpdateItem: - """Test AssetFaceUpdateItem - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetFaceUpdateItem` - """ - model = AssetFaceUpdateItem() - if include_optional: - return AssetFaceUpdateItem( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - person_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return AssetFaceUpdateItem( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - person_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testAssetFaceUpdateItem(self): - """Test AssetFaceUpdateItem""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_ids_dto.py b/generated/immich/openapi_client/test/test_asset_ids_dto.py deleted file mode 100644 index 8392b7c..0000000 --- a/generated/immich/openapi_client/test/test_asset_ids_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto - -class TestAssetIdsDto(unittest.TestCase): - """AssetIdsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetIdsDto: - """Test AssetIdsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetIdsDto` - """ - model = AssetIdsDto() - if include_optional: - return AssetIdsDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return AssetIdsDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testAssetIdsDto(self): - """Test AssetIdsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_ids_response_dto.py b/generated/immich/openapi_client/test/test_asset_ids_response_dto.py deleted file mode 100644 index 2df5db6..0000000 --- a/generated/immich/openapi_client/test/test_asset_ids_response_dto.py +++ /dev/null @@ -1,55 +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 unittest - -from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto - -class TestAssetIdsResponseDto(unittest.TestCase): - """AssetIdsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetIdsResponseDto: - """Test AssetIdsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetIdsResponseDto` - """ - model = AssetIdsResponseDto() - if include_optional: - return AssetIdsResponseDto( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - error = 'duplicate', - success = True - ) - else: - return AssetIdsResponseDto( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - success = True, - ) - """ - - def testAssetIdsResponseDto(self): - """Test AssetIdsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_job_name.py b/generated/immich/openapi_client/test/test_asset_job_name.py deleted file mode 100644 index c835787..0000000 --- a/generated/immich/openapi_client/test/test_asset_job_name.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.asset_job_name import AssetJobName - -class TestAssetJobName(unittest.TestCase): - """AssetJobName unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAssetJobName(self): - """Test AssetJobName""" - # inst = AssetJobName() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_jobs_dto.py b/generated/immich/openapi_client/test/test_asset_jobs_dto.py deleted file mode 100644 index 7d2eabd..0000000 --- a/generated/immich/openapi_client/test/test_asset_jobs_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.asset_jobs_dto import AssetJobsDto - -class TestAssetJobsDto(unittest.TestCase): - """AssetJobsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetJobsDto: - """Test AssetJobsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetJobsDto` - """ - model = AssetJobsDto() - if include_optional: - return AssetJobsDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - name = 'refresh-faces' - ) - else: - return AssetJobsDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - name = 'refresh-faces', - ) - """ - - def testAssetJobsDto(self): - """Test AssetJobsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_media_response_dto.py b/generated/immich/openapi_client/test/test_asset_media_response_dto.py deleted file mode 100644 index 0e9ac80..0000000 --- a/generated/immich/openapi_client/test/test_asset_media_response_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.asset_media_response_dto import AssetMediaResponseDto - -class TestAssetMediaResponseDto(unittest.TestCase): - """AssetMediaResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetMediaResponseDto: - """Test AssetMediaResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetMediaResponseDto` - """ - model = AssetMediaResponseDto() - if include_optional: - return AssetMediaResponseDto( - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - status = 'created' - ) - else: - return AssetMediaResponseDto( - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - status = 'created', - ) - """ - - def testAssetMediaResponseDto(self): - """Test AssetMediaResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_media_size.py b/generated/immich/openapi_client/test/test_asset_media_size.py deleted file mode 100644 index 9d053ba..0000000 --- a/generated/immich/openapi_client/test/test_asset_media_size.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.asset_media_size import AssetMediaSize - -class TestAssetMediaSize(unittest.TestCase): - """AssetMediaSize unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAssetMediaSize(self): - """Test AssetMediaSize""" - # inst = AssetMediaSize() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_media_status.py b/generated/immich/openapi_client/test/test_asset_media_status.py deleted file mode 100644 index 4baffce..0000000 --- a/generated/immich/openapi_client/test/test_asset_media_status.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.asset_media_status import AssetMediaStatus - -class TestAssetMediaStatus(unittest.TestCase): - """AssetMediaStatus unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAssetMediaStatus(self): - """Test AssetMediaStatus""" - # inst = AssetMediaStatus() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_order.py b/generated/immich/openapi_client/test/test_asset_order.py deleted file mode 100644 index 28988d9..0000000 --- a/generated/immich/openapi_client/test/test_asset_order.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.asset_order import AssetOrder - -class TestAssetOrder(unittest.TestCase): - """AssetOrder unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAssetOrder(self): - """Test AssetOrder""" - # inst = AssetOrder() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_response_dto.py b/generated/immich/openapi_client/test/test_asset_response_dto.py deleted file mode 100644 index 4d0f21e..0000000 --- a/generated/immich/openapi_client/test/test_asset_response_dto.py +++ /dev/null @@ -1,154 +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 unittest - -from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto - -class TestAssetResponseDto(unittest.TestCase): - """AssetResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetResponseDto: - """Test AssetResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetResponseDto` - """ - model = AssetResponseDto() - if include_optional: - return AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = generated.immich.openapi_client.models.asset_stack_response_dto.AssetStackResponseDto( - asset_count = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - primary_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ), - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0 - ) - else: - return AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duration = 0, - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_path = '', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, - ) - """ - - def testAssetResponseDto(self): - """Test AssetResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_stack_response_dto.py b/generated/immich/openapi_client/test/test_asset_stack_response_dto.py deleted file mode 100644 index 210c6cc..0000000 --- a/generated/immich/openapi_client/test/test_asset_stack_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.asset_stack_response_dto import AssetStackResponseDto - -class TestAssetStackResponseDto(unittest.TestCase): - """AssetStackResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetStackResponseDto: - """Test AssetStackResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetStackResponseDto` - """ - model = AssetStackResponseDto() - if include_optional: - return AssetStackResponseDto( - asset_count = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - primary_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return AssetStackResponseDto( - asset_count = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - primary_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testAssetStackResponseDto(self): - """Test AssetStackResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_stats_response_dto.py b/generated/immich/openapi_client/test/test_asset_stats_response_dto.py deleted file mode 100644 index 5ba0508..0000000 --- a/generated/immich/openapi_client/test/test_asset_stats_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.asset_stats_response_dto import AssetStatsResponseDto - -class TestAssetStatsResponseDto(unittest.TestCase): - """AssetStatsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AssetStatsResponseDto: - """Test AssetStatsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AssetStatsResponseDto` - """ - model = AssetStatsResponseDto() - if include_optional: - return AssetStatsResponseDto( - images = -9007199254740991, - total = -9007199254740991, - videos = -9007199254740991 - ) - else: - return AssetStatsResponseDto( - images = -9007199254740991, - total = -9007199254740991, - videos = -9007199254740991, - ) - """ - - def testAssetStatsResponseDto(self): - """Test AssetStatsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_asset_type_enum.py b/generated/immich/openapi_client/test/test_asset_type_enum.py deleted file mode 100644 index 405285e..0000000 --- a/generated/immich/openapi_client/test/test_asset_type_enum.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum - -class TestAssetTypeEnum(unittest.TestCase): - """AssetTypeEnum unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAssetTypeEnum(self): - """Test AssetTypeEnum""" - # inst = AssetTypeEnum() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_assets_api.py b/generated/immich/openapi_client/test/test_assets_api.py deleted file mode 100644 index 7c99207..0000000 --- a/generated/immich/openapi_client/test/test_assets_api.py +++ /dev/null @@ -1,213 +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 unittest - -from generated.immich.openapi_client.api.assets_api import AssetsApi - - -class TestAssetsApi(unittest.TestCase): - """AssetsApi unit test stubs""" - - def setUp(self) -> None: - self.api = AssetsApi() - - def tearDown(self) -> None: - pass - - def test_check_bulk_upload(self) -> None: - """Test case for check_bulk_upload - - Check bulk upload - """ - pass - - def test_copy_asset(self) -> None: - """Test case for copy_asset - - Copy asset - """ - pass - - def test_delete_asset_metadata(self) -> None: - """Test case for delete_asset_metadata - - Delete asset metadata by key - """ - pass - - def test_delete_assets(self) -> None: - """Test case for delete_assets - - Delete assets - """ - pass - - def test_delete_bulk_asset_metadata(self) -> None: - """Test case for delete_bulk_asset_metadata - - Delete asset metadata - """ - pass - - def test_download_asset(self) -> None: - """Test case for download_asset - - Download original asset - """ - pass - - def test_edit_asset(self) -> None: - """Test case for edit_asset - - Apply edits to an existing asset - """ - pass - - def test_end_session(self) -> None: - """Test case for end_session - - End HLS streaming session - """ - pass - - def test_get_asset_edits(self) -> None: - """Test case for get_asset_edits - - Retrieve edits for an existing asset - """ - pass - - def test_get_asset_info(self) -> None: - """Test case for get_asset_info - - Retrieve an asset - """ - pass - - def test_get_asset_metadata(self) -> None: - """Test case for get_asset_metadata - - Get asset metadata - """ - pass - - def test_get_asset_metadata_by_key(self) -> None: - """Test case for get_asset_metadata_by_key - - Retrieve asset metadata by key - """ - pass - - def test_get_asset_ocr(self) -> None: - """Test case for get_asset_ocr - - Retrieve asset OCR data - """ - pass - - def test_get_asset_statistics(self) -> None: - """Test case for get_asset_statistics - - Get asset statistics - """ - pass - - def test_get_main_playlist(self) -> None: - """Test case for get_main_playlist - - Get HLS main playlist - """ - pass - - def test_get_media_playlist(self) -> None: - """Test case for get_media_playlist - - Get HLS media playlist - """ - pass - - def test_get_segment(self) -> None: - """Test case for get_segment - - Get HLS segment or init file - """ - pass - - def test_play_asset_video(self) -> None: - """Test case for play_asset_video - - Play asset video - """ - pass - - def test_remove_asset_edits(self) -> None: - """Test case for remove_asset_edits - - Remove edits from an existing asset - """ - pass - - def test_run_asset_jobs(self) -> None: - """Test case for run_asset_jobs - - Run an asset job - """ - pass - - def test_update_asset(self) -> None: - """Test case for update_asset - - Update an asset - """ - pass - - def test_update_asset_metadata(self) -> None: - """Test case for update_asset_metadata - - Update asset metadata - """ - pass - - def test_update_assets(self) -> None: - """Test case for update_assets - - Update assets - """ - pass - - def test_update_bulk_asset_metadata(self) -> None: - """Test case for update_bulk_asset_metadata - - Upsert asset metadata - """ - pass - - def test_upload_asset(self) -> None: - """Test case for upload_asset - - Upload asset - """ - pass - - def test_view_asset(self) -> None: - """Test case for view_asset - - View asset thumbnail - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_audio_codec.py b/generated/immich/openapi_client/test/test_audio_codec.py deleted file mode 100644 index 2764423..0000000 --- a/generated/immich/openapi_client/test/test_audio_codec.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.audio_codec import AudioCodec - -class TestAudioCodec(unittest.TestCase): - """AudioCodec unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAudioCodec(self): - """Test AudioCodec""" - # inst = AudioCodec() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_authentication_api.py b/generated/immich/openapi_client/test/test_authentication_api.py deleted file mode 100644 index adc3006..0000000 --- a/generated/immich/openapi_client/test/test_authentication_api.py +++ /dev/null @@ -1,150 +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 unittest - -from generated.immich.openapi_client.api.authentication_api import AuthenticationApi - - -class TestAuthenticationApi(unittest.TestCase): - """AuthenticationApi unit test stubs""" - - def setUp(self) -> None: - self.api = AuthenticationApi() - - def tearDown(self) -> None: - pass - - def test_change_password(self) -> None: - """Test case for change_password - - Change password - """ - pass - - def test_change_pin_code(self) -> None: - """Test case for change_pin_code - - Change pin code - """ - pass - - def test_finish_o_auth(self) -> None: - """Test case for finish_o_auth - - Finish OAuth - """ - pass - - def test_get_auth_status(self) -> None: - """Test case for get_auth_status - - Retrieve auth status - """ - pass - - def test_link_o_auth_account(self) -> None: - """Test case for link_o_auth_account - - Link OAuth account - """ - pass - - def test_lock_auth_session(self) -> None: - """Test case for lock_auth_session - - Lock auth session - """ - pass - - def test_login(self) -> None: - """Test case for login - - Login - """ - pass - - def test_logout(self) -> None: - """Test case for logout - - Logout - """ - pass - - def test_logout_o_auth(self) -> None: - """Test case for logout_o_auth - - Backchannel OAuth logout - """ - pass - - def test_redirect_o_auth_to_mobile(self) -> None: - """Test case for redirect_o_auth_to_mobile - - Redirect OAuth to mobile - """ - pass - - def test_reset_pin_code(self) -> None: - """Test case for reset_pin_code - - Reset pin code - """ - pass - - def test_setup_pin_code(self) -> None: - """Test case for setup_pin_code - - Setup pin code - """ - pass - - def test_sign_up_admin(self) -> None: - """Test case for sign_up_admin - - Register admin - """ - pass - - def test_start_o_auth(self) -> None: - """Test case for start_o_auth - - Start OAuth - """ - pass - - def test_unlink_o_auth_account(self) -> None: - """Test case for unlink_o_auth_account - - Unlink OAuth account - """ - pass - - def test_unlock_auth_session(self) -> None: - """Test case for unlock_auth_session - - Unlock auth session - """ - pass - - def test_validate_access_token(self) -> None: - """Test case for validate_access_token - - Validate access token - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_avatar_update.py b/generated/immich/openapi_client/test/test_avatar_update.py deleted file mode 100644 index a64294d..0000000 --- a/generated/immich/openapi_client/test/test_avatar_update.py +++ /dev/null @@ -1,51 +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 unittest - -from generated.immich.openapi_client.models.avatar_update import AvatarUpdate - -class TestAvatarUpdate(unittest.TestCase): - """AvatarUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> AvatarUpdate: - """Test AvatarUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `AvatarUpdate` - """ - model = AvatarUpdate() - if include_optional: - return AvatarUpdate( - color = 'primary' - ) - else: - return AvatarUpdate( - ) - """ - - def testAvatarUpdate(self): - """Test AvatarUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_bulk_id_response_dto.py b/generated/immich/openapi_client/test/test_bulk_id_response_dto.py deleted file mode 100644 index 19ea911..0000000 --- a/generated/immich/openapi_client/test/test_bulk_id_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto - -class TestBulkIdResponseDto(unittest.TestCase): - """BulkIdResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> BulkIdResponseDto: - """Test BulkIdResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `BulkIdResponseDto` - """ - model = BulkIdResponseDto() - if include_optional: - return BulkIdResponseDto( - error = 'duplicate', - error_message = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - success = True - ) - else: - return BulkIdResponseDto( - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - success = True, - ) - """ - - def testBulkIdResponseDto(self): - """Test BulkIdResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_bulk_ids_dto.py b/generated/immich/openapi_client/test/test_bulk_ids_dto.py deleted file mode 100644 index 6441252..0000000 --- a/generated/immich/openapi_client/test/test_bulk_ids_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto - -class TestBulkIdsDto(unittest.TestCase): - """BulkIdsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> BulkIdsDto: - """Test BulkIdsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `BulkIdsDto` - """ - model = BulkIdsDto() - if include_optional: - return BulkIdsDto( - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return BulkIdsDto( - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testBulkIdsDto(self): - """Test BulkIdsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_change_password_dto.py b/generated/immich/openapi_client/test/test_change_password_dto.py deleted file mode 100644 index 8484441..0000000 --- a/generated/immich/openapi_client/test/test_change_password_dto.py +++ /dev/null @@ -1,55 +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 unittest - -from generated.immich.openapi_client.models.change_password_dto import ChangePasswordDto - -class TestChangePasswordDto(unittest.TestCase): - """ChangePasswordDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ChangePasswordDto: - """Test ChangePasswordDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ChangePasswordDto` - """ - model = ChangePasswordDto() - if include_optional: - return ChangePasswordDto( - invalidate_sessions = True, - new_password = 'password', - password = 'password' - ) - else: - return ChangePasswordDto( - new_password = 'password', - password = 'password', - ) - """ - - def testChangePasswordDto(self): - """Test ChangePasswordDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_clip_config.py b/generated/immich/openapi_client/test/test_clip_config.py deleted file mode 100644 index 54c388f..0000000 --- a/generated/immich/openapi_client/test/test_clip_config.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.clip_config import CLIPConfig - -class TestCLIPConfig(unittest.TestCase): - """CLIPConfig unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> CLIPConfig: - """Test CLIPConfig - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `CLIPConfig` - """ - model = CLIPConfig() - if include_optional: - return CLIPConfig( - enabled = True, - model_name = '' - ) - else: - return CLIPConfig( - enabled = True, - model_name = '', - ) - """ - - def testCLIPConfig(self): - """Test CLIPConfig""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_colorspace.py b/generated/immich/openapi_client/test/test_colorspace.py deleted file mode 100644 index b14532a..0000000 --- a/generated/immich/openapi_client/test/test_colorspace.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.colorspace import Colorspace - -class TestColorspace(unittest.TestCase): - """Colorspace unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testColorspace(self): - """Test Colorspace""" - # inst = Colorspace() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_cq_mode.py b/generated/immich/openapi_client/test/test_cq_mode.py deleted file mode 100644 index aa3db2b..0000000 --- a/generated/immich/openapi_client/test/test_cq_mode.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.cq_mode import CQMode - -class TestCQMode(unittest.TestCase): - """CQMode unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCQMode(self): - """Test CQMode""" - # inst = CQMode() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_create_album_dto.py b/generated/immich/openapi_client/test/test_create_album_dto.py deleted file mode 100644 index 266219a..0000000 --- a/generated/immich/openapi_client/test/test_create_album_dto.py +++ /dev/null @@ -1,61 +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 unittest - -from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto - -class TestCreateAlbumDto(unittest.TestCase): - """CreateAlbumDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> CreateAlbumDto: - """Test CreateAlbumDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `CreateAlbumDto` - """ - model = CreateAlbumDto() - if include_optional: - return CreateAlbumDto( - album_name = '', - album_users = [ - generated.immich.openapi_client.models.album_user_create_dto.AlbumUserCreateDto( - role = 'editor', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - description = '' - ) - else: - return CreateAlbumDto( - album_name = '', - ) - """ - - def testCreateAlbumDto(self): - """Test CreateAlbumDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_create_library_dto.py b/generated/immich/openapi_client/test/test_create_library_dto.py deleted file mode 100644 index 4196d50..0000000 --- a/generated/immich/openapi_client/test/test_create_library_dto.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.models.create_library_dto import CreateLibraryDto - -class TestCreateLibraryDto(unittest.TestCase): - """CreateLibraryDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> CreateLibraryDto: - """Test CreateLibraryDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `CreateLibraryDto` - """ - model = CreateLibraryDto() - if include_optional: - return CreateLibraryDto( - exclusion_patterns = [ - '' - ], - import_paths = [ - '' - ], - name = '0', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return CreateLibraryDto( - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testCreateLibraryDto(self): - """Test CreateLibraryDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_create_profile_image_response_dto.py b/generated/immich/openapi_client/test/test_create_profile_image_response_dto.py deleted file mode 100644 index 1449829..0000000 --- a/generated/immich/openapi_client/test/test_create_profile_image_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.create_profile_image_response_dto import CreateProfileImageResponseDto - -class TestCreateProfileImageResponseDto(unittest.TestCase): - """CreateProfileImageResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> CreateProfileImageResponseDto: - """Test CreateProfileImageResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `CreateProfileImageResponseDto` - """ - model = CreateProfileImageResponseDto() - if include_optional: - return CreateProfileImageResponseDto( - profile_changed_at = '2024-01-01T00:00Z', - profile_image_path = '', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return CreateProfileImageResponseDto( - profile_changed_at = '2024-01-01T00:00Z', - profile_image_path = '', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testCreateProfileImageResponseDto(self): - """Test CreateProfileImageResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_database_backup_config.py b/generated/immich/openapi_client/test/test_database_backup_config.py deleted file mode 100644 index 714eee1..0000000 --- a/generated/immich/openapi_client/test/test_database_backup_config.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.database_backup_config import DatabaseBackupConfig - -class TestDatabaseBackupConfig(unittest.TestCase): - """DatabaseBackupConfig unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DatabaseBackupConfig: - """Test DatabaseBackupConfig - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DatabaseBackupConfig` - """ - model = DatabaseBackupConfig() - if include_optional: - return DatabaseBackupConfig( - cron_expression = '', - enabled = True, - keep_last_amount = 1 - ) - else: - return DatabaseBackupConfig( - cron_expression = '', - enabled = True, - keep_last_amount = 1, - ) - """ - - def testDatabaseBackupConfig(self): - """Test DatabaseBackupConfig""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_deprecated_api.py b/generated/immich/openapi_client/test/test_deprecated_api.py deleted file mode 100644 index 21c9daa..0000000 --- a/generated/immich/openapi_client/test/test_deprecated_api.py +++ /dev/null @@ -1,150 +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 unittest - -from generated.immich.openapi_client.api.deprecated_api import DeprecatedApi - - -class TestDeprecatedApi(unittest.TestCase): - """DeprecatedApi unit test stubs""" - - def setUp(self) -> None: - self.api = DeprecatedApi() - - def tearDown(self) -> None: - pass - - def test_create_partner_deprecated(self) -> None: - """Test case for create_partner_deprecated - - Create a partner - """ - pass - - def test_get_queues_legacy(self) -> None: - """Test case for get_queues_legacy - - Retrieve queue counts and status - """ - pass - - def test_run_queue_command_legacy(self) -> None: - """Test case for run_queue_command_legacy - - Run jobs - """ - pass - - def test_update_api_key(self) -> None: - """Test case for update_api_key - - Update an API key - """ - pass - - def test_update_asset(self) -> None: - """Test case for update_asset - - Update an asset - """ - pass - - def test_update_assets(self) -> None: - """Test case for update_assets - - Update assets - """ - pass - - def test_update_library(self) -> None: - """Test case for update_library - - Update a library - """ - pass - - def test_update_memory(self) -> None: - """Test case for update_memory - - Update a memory - """ - pass - - def test_update_my_preferences(self) -> None: - """Test case for update_my_preferences - - Update my preferences - """ - pass - - def test_update_my_user(self) -> None: - """Test case for update_my_user - - Update current user - """ - pass - - def test_update_person(self) -> None: - """Test case for update_person - - Update person - """ - pass - - def test_update_session(self) -> None: - """Test case for update_session - - Update a session - """ - pass - - def test_update_stack(self) -> None: - """Test case for update_stack - - Update a stack - """ - pass - - def test_update_tag(self) -> None: - """Test case for update_tag - - Update a tag - """ - pass - - def test_update_user_admin(self) -> None: - """Test case for update_user_admin - - Update a user - """ - pass - - def test_update_user_preferences_admin(self) -> None: - """Test case for update_user_preferences_admin - - Update user preferences - """ - pass - - def test_update_workflow(self) -> None: - """Test case for update_workflow - - Update a workflow - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_download_api.py b/generated/immich/openapi_client/test/test_download_api.py deleted file mode 100644 index 3f8d808..0000000 --- a/generated/immich/openapi_client/test/test_download_api.py +++ /dev/null @@ -1,45 +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 unittest - -from generated.immich.openapi_client.api.download_api import DownloadApi - - -class TestDownloadApi(unittest.TestCase): - """DownloadApi unit test stubs""" - - def setUp(self) -> None: - self.api = DownloadApi() - - def tearDown(self) -> None: - pass - - def test_download_archive(self) -> None: - """Test case for download_archive - - Download asset archive - """ - pass - - def test_get_download_info(self) -> None: - """Test case for get_download_info - - Retrieve download information - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_download_archive_info.py b/generated/immich/openapi_client/test/test_download_archive_info.py deleted file mode 100644 index 60cba4e..0000000 --- a/generated/immich/openapi_client/test/test_download_archive_info.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.download_archive_info import DownloadArchiveInfo - -class TestDownloadArchiveInfo(unittest.TestCase): - """DownloadArchiveInfo unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DownloadArchiveInfo: - """Test DownloadArchiveInfo - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DownloadArchiveInfo` - """ - model = DownloadArchiveInfo() - if include_optional: - return DownloadArchiveInfo( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - size = -9007199254740991 - ) - else: - return DownloadArchiveInfo( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - size = -9007199254740991, - ) - """ - - def testDownloadArchiveInfo(self): - """Test DownloadArchiveInfo""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_download_info_dto.py b/generated/immich/openapi_client/test/test_download_info_dto.py deleted file mode 100644 index 66a75de..0000000 --- a/generated/immich/openapi_client/test/test_download_info_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto - -class TestDownloadInfoDto(unittest.TestCase): - """DownloadInfoDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DownloadInfoDto: - """Test DownloadInfoDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DownloadInfoDto` - """ - model = DownloadInfoDto() - if include_optional: - return DownloadInfoDto( - album_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - archive_size = 1, - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return DownloadInfoDto( - ) - """ - - def testDownloadInfoDto(self): - """Test DownloadInfoDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_download_response.py b/generated/immich/openapi_client/test/test_download_response.py deleted file mode 100644 index ad6f31a..0000000 --- a/generated/immich/openapi_client/test/test_download_response.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.download_response import DownloadResponse - -class TestDownloadResponse(unittest.TestCase): - """DownloadResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DownloadResponse: - """Test DownloadResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DownloadResponse` - """ - model = DownloadResponse() - if include_optional: - return DownloadResponse( - archive_size = -9007199254740991, - include_embedded_videos = True - ) - else: - return DownloadResponse( - archive_size = -9007199254740991, - include_embedded_videos = True, - ) - """ - - def testDownloadResponse(self): - """Test DownloadResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_download_response_dto.py b/generated/immich/openapi_client/test/test_download_response_dto.py deleted file mode 100644 index e465665..0000000 --- a/generated/immich/openapi_client/test/test_download_response_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto - -class TestDownloadResponseDto(unittest.TestCase): - """DownloadResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DownloadResponseDto: - """Test DownloadResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DownloadResponseDto` - """ - model = DownloadResponseDto() - if include_optional: - return DownloadResponseDto( - archives = [ - generated.immich.openapi_client.models.download_archive_info.DownloadArchiveInfo( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - size = -9007199254740991, ) - ], - total_size = -9007199254740991 - ) - else: - return DownloadResponseDto( - archives = [ - generated.immich.openapi_client.models.download_archive_info.DownloadArchiveInfo( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - size = -9007199254740991, ) - ], - total_size = -9007199254740991, - ) - """ - - def testDownloadResponseDto(self): - """Test DownloadResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_download_update.py b/generated/immich/openapi_client/test/test_download_update.py deleted file mode 100644 index 6b208b7..0000000 --- a/generated/immich/openapi_client/test/test_download_update.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.download_update import DownloadUpdate - -class TestDownloadUpdate(unittest.TestCase): - """DownloadUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DownloadUpdate: - """Test DownloadUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DownloadUpdate` - """ - model = DownloadUpdate() - if include_optional: - return DownloadUpdate( - archive_size = 1, - include_embedded_videos = True - ) - else: - return DownloadUpdate( - ) - """ - - def testDownloadUpdate(self): - """Test DownloadUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_duplicate_detection_config.py b/generated/immich/openapi_client/test/test_duplicate_detection_config.py deleted file mode 100644 index c927d34..0000000 --- a/generated/immich/openapi_client/test/test_duplicate_detection_config.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.duplicate_detection_config import DuplicateDetectionConfig - -class TestDuplicateDetectionConfig(unittest.TestCase): - """DuplicateDetectionConfig unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DuplicateDetectionConfig: - """Test DuplicateDetectionConfig - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DuplicateDetectionConfig` - """ - model = DuplicateDetectionConfig() - if include_optional: - return DuplicateDetectionConfig( - enabled = True, - max_distance = 0.001 - ) - else: - return DuplicateDetectionConfig( - enabled = True, - max_distance = 0.001, - ) - """ - - def testDuplicateDetectionConfig(self): - """Test DuplicateDetectionConfig""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_duplicate_response_dto.py b/generated/immich/openapi_client/test/test_duplicate_response_dto.py deleted file mode 100644 index 1e8e642..0000000 --- a/generated/immich/openapi_client/test/test_duplicate_response_dto.py +++ /dev/null @@ -1,222 +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 unittest - -from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto - -class TestDuplicateResponseDto(unittest.TestCase): - """DuplicateResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> DuplicateResponseDto: - """Test DuplicateResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `DuplicateResponseDto` - """ - model = DuplicateResponseDto() - if include_optional: - return DuplicateResponseDto( - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - suggested_keep_asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return DuplicateResponseDto( - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - suggested_keep_asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testDuplicateResponseDto(self): - """Test DuplicateResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_duplicates_api.py b/generated/immich/openapi_client/test/test_duplicates_api.py deleted file mode 100644 index 4c4a95e..0000000 --- a/generated/immich/openapi_client/test/test_duplicates_api.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.api.duplicates_api import DuplicatesApi - - -class TestDuplicatesApi(unittest.TestCase): - """DuplicatesApi unit test stubs""" - - def setUp(self) -> None: - self.api = DuplicatesApi() - - def tearDown(self) -> None: - pass - - def test_delete_duplicate(self) -> None: - """Test case for delete_duplicate - - Dismiss a duplicate group - """ - pass - - def test_delete_duplicates(self) -> None: - """Test case for delete_duplicates - - Delete duplicates - """ - pass - - def test_get_asset_duplicates(self) -> None: - """Test case for get_asset_duplicates - - Retrieve duplicates - """ - pass - - def test_resolve_duplicates(self) -> None: - """Test case for resolve_duplicates - - Resolve duplicate groups - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_email_notifications_response.py b/generated/immich/openapi_client/test/test_email_notifications_response.py deleted file mode 100644 index 7610daf..0000000 --- a/generated/immich/openapi_client/test/test_email_notifications_response.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.email_notifications_response import EmailNotificationsResponse - -class TestEmailNotificationsResponse(unittest.TestCase): - """EmailNotificationsResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> EmailNotificationsResponse: - """Test EmailNotificationsResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `EmailNotificationsResponse` - """ - model = EmailNotificationsResponse() - if include_optional: - return EmailNotificationsResponse( - album_invite = True, - album_update = True, - enabled = True - ) - else: - return EmailNotificationsResponse( - album_invite = True, - album_update = True, - enabled = True, - ) - """ - - def testEmailNotificationsResponse(self): - """Test EmailNotificationsResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_email_notifications_update.py b/generated/immich/openapi_client/test/test_email_notifications_update.py deleted file mode 100644 index ff8a569..0000000 --- a/generated/immich/openapi_client/test/test_email_notifications_update.py +++ /dev/null @@ -1,53 +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 unittest - -from generated.immich.openapi_client.models.email_notifications_update import EmailNotificationsUpdate - -class TestEmailNotificationsUpdate(unittest.TestCase): - """EmailNotificationsUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> EmailNotificationsUpdate: - """Test EmailNotificationsUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `EmailNotificationsUpdate` - """ - model = EmailNotificationsUpdate() - if include_optional: - return EmailNotificationsUpdate( - album_invite = True, - album_update = True, - enabled = True - ) - else: - return EmailNotificationsUpdate( - ) - """ - - def testEmailNotificationsUpdate(self): - """Test EmailNotificationsUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_exif_response_dto.py b/generated/immich/openapi_client/test/test_exif_response_dto.py deleted file mode 100644 index a9aca18..0000000 --- a/generated/immich/openapi_client/test/test_exif_response_dto.py +++ /dev/null @@ -1,72 +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 unittest - -from generated.immich.openapi_client.models.exif_response_dto import ExifResponseDto - -class TestExifResponseDto(unittest.TestCase): - """ExifResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ExifResponseDto: - """Test ExifResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ExifResponseDto` - """ - model = ExifResponseDto() - if include_optional: - return ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '' - ) - else: - return ExifResponseDto( - ) - """ - - def testExifResponseDto(self): - """Test ExifResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_face_dto.py b/generated/immich/openapi_client/test/test_face_dto.py deleted file mode 100644 index 7164060..0000000 --- a/generated/immich/openapi_client/test/test_face_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.face_dto import FaceDto - -class TestFaceDto(unittest.TestCase): - """FaceDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> FaceDto: - """Test FaceDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `FaceDto` - """ - model = FaceDto() - if include_optional: - return FaceDto( - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return FaceDto( - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testFaceDto(self): - """Test FaceDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_faces_api.py b/generated/immich/openapi_client/test/test_faces_api.py deleted file mode 100644 index edede7a..0000000 --- a/generated/immich/openapi_client/test/test_faces_api.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.api.faces_api import FacesApi - - -class TestFacesApi(unittest.TestCase): - """FacesApi unit test stubs""" - - def setUp(self) -> None: - self.api = FacesApi() - - def tearDown(self) -> None: - pass - - def test_create_face(self) -> None: - """Test case for create_face - - Create a face - """ - pass - - def test_delete_face(self) -> None: - """Test case for delete_face - - Delete a face - """ - pass - - def test_get_faces(self) -> None: - """Test case for get_faces - - Retrieve faces for asset - """ - pass - - def test_reassign_faces_by_id(self) -> None: - """Test case for reassign_faces_by_id - - Re-assign a face to another person - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_facial_recognition_config.py b/generated/immich/openapi_client/test/test_facial_recognition_config.py deleted file mode 100644 index 0990fb8..0000000 --- a/generated/immich/openapi_client/test/test_facial_recognition_config.py +++ /dev/null @@ -1,60 +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 unittest - -from generated.immich.openapi_client.models.facial_recognition_config import FacialRecognitionConfig - -class TestFacialRecognitionConfig(unittest.TestCase): - """FacialRecognitionConfig unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> FacialRecognitionConfig: - """Test FacialRecognitionConfig - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `FacialRecognitionConfig` - """ - model = FacialRecognitionConfig() - if include_optional: - return FacialRecognitionConfig( - enabled = True, - max_distance = 0.1, - min_faces = 1, - min_score = 0.1, - model_name = '' - ) - else: - return FacialRecognitionConfig( - enabled = True, - max_distance = 0.1, - min_faces = 1, - min_score = 0.1, - model_name = '', - ) - """ - - def testFacialRecognitionConfig(self): - """Test FacialRecognitionConfig""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_folders_response.py b/generated/immich/openapi_client/test/test_folders_response.py deleted file mode 100644 index 63e8c07..0000000 --- a/generated/immich/openapi_client/test/test_folders_response.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.folders_response import FoldersResponse - -class TestFoldersResponse(unittest.TestCase): - """FoldersResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> FoldersResponse: - """Test FoldersResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `FoldersResponse` - """ - model = FoldersResponse() - if include_optional: - return FoldersResponse( - enabled = True, - sidebar_web = True - ) - else: - return FoldersResponse( - enabled = True, - sidebar_web = True, - ) - """ - - def testFoldersResponse(self): - """Test FoldersResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_folders_update.py b/generated/immich/openapi_client/test/test_folders_update.py deleted file mode 100644 index 79cb414..0000000 --- a/generated/immich/openapi_client/test/test_folders_update.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.folders_update import FoldersUpdate - -class TestFoldersUpdate(unittest.TestCase): - """FoldersUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> FoldersUpdate: - """Test FoldersUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `FoldersUpdate` - """ - model = FoldersUpdate() - if include_optional: - return FoldersUpdate( - enabled = True, - sidebar_web = True - ) - else: - return FoldersUpdate( - ) - """ - - def testFoldersUpdate(self): - """Test FoldersUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_image_format.py b/generated/immich/openapi_client/test/test_image_format.py deleted file mode 100644 index 6c01ba9..0000000 --- a/generated/immich/openapi_client/test/test_image_format.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.image_format import ImageFormat - -class TestImageFormat(unittest.TestCase): - """ImageFormat unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testImageFormat(self): - """Test ImageFormat""" - # inst = ImageFormat() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_job_create_dto.py b/generated/immich/openapi_client/test/test_job_create_dto.py deleted file mode 100644 index b55f784..0000000 --- a/generated/immich/openapi_client/test/test_job_create_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.job_create_dto import JobCreateDto - -class TestJobCreateDto(unittest.TestCase): - """JobCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> JobCreateDto: - """Test JobCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `JobCreateDto` - """ - model = JobCreateDto() - if include_optional: - return JobCreateDto( - name = 'person-cleanup' - ) - else: - return JobCreateDto( - name = 'person-cleanup', - ) - """ - - def testJobCreateDto(self): - """Test JobCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_job_name.py b/generated/immich/openapi_client/test/test_job_name.py deleted file mode 100644 index 897a632..0000000 --- a/generated/immich/openapi_client/test/test_job_name.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.job_name import JobName - -class TestJobName(unittest.TestCase): - """JobName unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testJobName(self): - """Test JobName""" - # inst = JobName() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_job_settings_dto.py b/generated/immich/openapi_client/test/test_job_settings_dto.py deleted file mode 100644 index daae0f1..0000000 --- a/generated/immich/openapi_client/test/test_job_settings_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.job_settings_dto import JobSettingsDto - -class TestJobSettingsDto(unittest.TestCase): - """JobSettingsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> JobSettingsDto: - """Test JobSettingsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `JobSettingsDto` - """ - model = JobSettingsDto() - if include_optional: - return JobSettingsDto( - concurrency = 1 - ) - else: - return JobSettingsDto( - concurrency = 1, - ) - """ - - def testJobSettingsDto(self): - """Test JobSettingsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_jobs_api.py b/generated/immich/openapi_client/test/test_jobs_api.py deleted file mode 100644 index 04ea049..0000000 --- a/generated/immich/openapi_client/test/test_jobs_api.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.api.jobs_api import JobsApi - - -class TestJobsApi(unittest.TestCase): - """JobsApi unit test stubs""" - - def setUp(self) -> None: - self.api = JobsApi() - - def tearDown(self) -> None: - pass - - def test_create_job(self) -> None: - """Test case for create_job - - Create a manual job - """ - pass - - def test_get_queues_legacy(self) -> None: - """Test case for get_queues_legacy - - Retrieve queue counts and status - """ - pass - - def test_run_queue_command_legacy(self) -> None: - """Test case for run_queue_command_legacy - - Run jobs - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_libraries_api.py b/generated/immich/openapi_client/test/test_libraries_api.py deleted file mode 100644 index 7b67214..0000000 --- a/generated/immich/openapi_client/test/test_libraries_api.py +++ /dev/null @@ -1,87 +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 unittest - -from generated.immich.openapi_client.api.libraries_api import LibrariesApi - - -class TestLibrariesApi(unittest.TestCase): - """LibrariesApi unit test stubs""" - - def setUp(self) -> None: - self.api = LibrariesApi() - - def tearDown(self) -> None: - pass - - def test_create_library(self) -> None: - """Test case for create_library - - Create a library - """ - pass - - def test_delete_library(self) -> None: - """Test case for delete_library - - Delete a library - """ - pass - - def test_get_all_libraries(self) -> None: - """Test case for get_all_libraries - - Retrieve libraries - """ - pass - - def test_get_library(self) -> None: - """Test case for get_library - - Retrieve a library - """ - pass - - def test_get_library_statistics(self) -> None: - """Test case for get_library_statistics - - Retrieve library statistics - """ - pass - - def test_scan_library(self) -> None: - """Test case for scan_library - - Scan a library - """ - pass - - def test_update_library(self) -> None: - """Test case for update_library - - Update a library - """ - pass - - def test_validate(self) -> None: - """Test case for validate - - Validate library settings - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_library_response_dto.py b/generated/immich/openapi_client/test/test_library_response_dto.py deleted file mode 100644 index 3fea241..0000000 --- a/generated/immich/openapi_client/test/test_library_response_dto.py +++ /dev/null @@ -1,76 +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 unittest - -from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto - -class TestLibraryResponseDto(unittest.TestCase): - """LibraryResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> LibraryResponseDto: - """Test LibraryResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `LibraryResponseDto` - """ - model = LibraryResponseDto() - if include_optional: - return LibraryResponseDto( - asset_count = -9007199254740991, - created_at = '2024-01-01T00:00Z', - exclusion_patterns = [ - '' - ], - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - import_paths = [ - '' - ], - name = '', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - refreshed_at = '2024-01-01T00:00Z', - updated_at = '2024-01-01T00:00Z' - ) - else: - return LibraryResponseDto( - asset_count = -9007199254740991, - created_at = '2024-01-01T00:00Z', - exclusion_patterns = [ - '' - ], - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - import_paths = [ - '' - ], - name = '', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - refreshed_at = '2024-01-01T00:00Z', - updated_at = '2024-01-01T00:00Z', - ) - """ - - def testLibraryResponseDto(self): - """Test LibraryResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_library_stats_response_dto.py b/generated/immich/openapi_client/test/test_library_stats_response_dto.py deleted file mode 100644 index ff615f0..0000000 --- a/generated/immich/openapi_client/test/test_library_stats_response_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.library_stats_response_dto import LibraryStatsResponseDto - -class TestLibraryStatsResponseDto(unittest.TestCase): - """LibraryStatsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> LibraryStatsResponseDto: - """Test LibraryStatsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `LibraryStatsResponseDto` - """ - model = LibraryStatsResponseDto() - if include_optional: - return LibraryStatsResponseDto( - photos = -9007199254740991, - total = -9007199254740991, - usage = -9007199254740991, - videos = -9007199254740991 - ) - else: - return LibraryStatsResponseDto( - photos = -9007199254740991, - total = -9007199254740991, - usage = -9007199254740991, - videos = -9007199254740991, - ) - """ - - def testLibraryStatsResponseDto(self): - """Test LibraryStatsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_license_key_dto.py b/generated/immich/openapi_client/test/test_license_key_dto.py deleted file mode 100644 index 45710d1..0000000 --- a/generated/immich/openapi_client/test/test_license_key_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto - -class TestLicenseKeyDto(unittest.TestCase): - """LicenseKeyDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> LicenseKeyDto: - """Test LicenseKeyDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `LicenseKeyDto` - """ - model = LicenseKeyDto() - if include_optional: - return LicenseKeyDto( - activation_key = '', - license_key = 'IMCL-Cu2L-C4aW-wWL9-Y864-DZta-GRyy-GFZK-kkp4' - ) - else: - return LicenseKeyDto( - activation_key = '', - license_key = 'IMCL-Cu2L-C4aW-wWL9-Y864-DZta-GRyy-GFZK-kkp4', - ) - """ - - def testLicenseKeyDto(self): - """Test LicenseKeyDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_log_level.py b/generated/immich/openapi_client/test/test_log_level.py deleted file mode 100644 index b501224..0000000 --- a/generated/immich/openapi_client/test/test_log_level.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.log_level import LogLevel - -class TestLogLevel(unittest.TestCase): - """LogLevel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testLogLevel(self): - """Test LogLevel""" - # inst = LogLevel() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_login_credential_dto.py b/generated/immich/openapi_client/test/test_login_credential_dto.py deleted file mode 100644 index 3a5e211..0000000 --- a/generated/immich/openapi_client/test/test_login_credential_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto - -class TestLoginCredentialDto(unittest.TestCase): - """LoginCredentialDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> LoginCredentialDto: - """Test LoginCredentialDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `LoginCredentialDto` - """ - model = LoginCredentialDto() - if include_optional: - return LoginCredentialDto( - email = 'testuser@email.com', - password = 'password' - ) - else: - return LoginCredentialDto( - email = 'testuser@email.com', - password = 'password', - ) - """ - - def testLoginCredentialDto(self): - """Test LoginCredentialDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_login_response_dto.py b/generated/immich/openapi_client/test/test_login_response_dto.py deleted file mode 100644 index 495c7ac..0000000 --- a/generated/immich/openapi_client/test/test_login_response_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto - -class TestLoginResponseDto(unittest.TestCase): - """LoginResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> LoginResponseDto: - """Test LoginResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `LoginResponseDto` - """ - model = LoginResponseDto() - if include_optional: - return LoginResponseDto( - access_token = '', - is_admin = True, - is_onboarded = True, - name = '', - profile_image_path = '', - should_change_password = True, - user_email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return LoginResponseDto( - access_token = '', - is_admin = True, - is_onboarded = True, - name = '', - profile_image_path = '', - should_change_password = True, - user_email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testLoginResponseDto(self): - """Test LoginResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_logout_response_dto.py b/generated/immich/openapi_client/test/test_logout_response_dto.py deleted file mode 100644 index 733a242..0000000 --- a/generated/immich/openapi_client/test/test_logout_response_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.logout_response_dto import LogoutResponseDto - -class TestLogoutResponseDto(unittest.TestCase): - """LogoutResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> LogoutResponseDto: - """Test LogoutResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `LogoutResponseDto` - """ - model = LogoutResponseDto() - if include_optional: - return LogoutResponseDto( - redirect_uri = '', - successful = True - ) - else: - return LogoutResponseDto( - redirect_uri = '', - successful = True, - ) - """ - - def testLogoutResponseDto(self): - """Test LogoutResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_manual_job_name.py b/generated/immich/openapi_client/test/test_manual_job_name.py deleted file mode 100644 index 9c8d0d0..0000000 --- a/generated/immich/openapi_client/test/test_manual_job_name.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.manual_job_name import ManualJobName - -class TestManualJobName(unittest.TestCase): - """ManualJobName unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testManualJobName(self): - """Test ManualJobName""" - # inst = ManualJobName() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_map_api.py b/generated/immich/openapi_client/test/test_map_api.py deleted file mode 100644 index d333c3b..0000000 --- a/generated/immich/openapi_client/test/test_map_api.py +++ /dev/null @@ -1,45 +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 unittest - -from generated.immich.openapi_client.api.map_api import MapApi - - -class TestMapApi(unittest.TestCase): - """MapApi unit test stubs""" - - def setUp(self) -> None: - self.api = MapApi() - - def tearDown(self) -> None: - pass - - def test_get_map_markers(self) -> None: - """Test case for get_map_markers - - Retrieve map markers - """ - pass - - def test_reverse_geocode(self) -> None: - """Test case for reverse_geocode - - Reverse geocode coordinates - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_map_marker_response_dto.py b/generated/immich/openapi_client/test/test_map_marker_response_dto.py deleted file mode 100644 index f9e4084..0000000 --- a/generated/immich/openapi_client/test/test_map_marker_response_dto.py +++ /dev/null @@ -1,62 +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 unittest - -from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto - -class TestMapMarkerResponseDto(unittest.TestCase): - """MapMarkerResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MapMarkerResponseDto: - """Test MapMarkerResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MapMarkerResponseDto` - """ - model = MapMarkerResponseDto() - if include_optional: - return MapMarkerResponseDto( - city = '', - country = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - lat = 1.337, - lon = 1.337, - state = '' - ) - else: - return MapMarkerResponseDto( - city = '', - country = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - lat = 1.337, - lon = 1.337, - state = '', - ) - """ - - def testMapMarkerResponseDto(self): - """Test MapMarkerResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_map_reverse_geocode_response_dto.py b/generated/immich/openapi_client/test/test_map_reverse_geocode_response_dto.py deleted file mode 100644 index 384d449..0000000 --- a/generated/immich/openapi_client/test/test_map_reverse_geocode_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto - -class TestMapReverseGeocodeResponseDto(unittest.TestCase): - """MapReverseGeocodeResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MapReverseGeocodeResponseDto: - """Test MapReverseGeocodeResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MapReverseGeocodeResponseDto` - """ - model = MapReverseGeocodeResponseDto() - if include_optional: - return MapReverseGeocodeResponseDto( - city = '', - country = '', - state = '' - ) - else: - return MapReverseGeocodeResponseDto( - city = '', - country = '', - state = '', - ) - """ - - def testMapReverseGeocodeResponseDto(self): - """Test MapReverseGeocodeResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memories_api.py b/generated/immich/openapi_client/test/test_memories_api.py deleted file mode 100644 index e9d7f87..0000000 --- a/generated/immich/openapi_client/test/test_memories_api.py +++ /dev/null @@ -1,87 +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 unittest - -from generated.immich.openapi_client.api.memories_api import MemoriesApi - - -class TestMemoriesApi(unittest.TestCase): - """MemoriesApi unit test stubs""" - - def setUp(self) -> None: - self.api = MemoriesApi() - - def tearDown(self) -> None: - pass - - def test_add_memory_assets(self) -> None: - """Test case for add_memory_assets - - Add assets to a memory - """ - pass - - def test_create_memory(self) -> None: - """Test case for create_memory - - Create a memory - """ - pass - - def test_delete_memory(self) -> None: - """Test case for delete_memory - - Delete a memory - """ - pass - - def test_get_memory(self) -> None: - """Test case for get_memory - - Retrieve a memory - """ - pass - - def test_memories_statistics(self) -> None: - """Test case for memories_statistics - - Retrieve memories statistics - """ - pass - - def test_remove_memory_assets(self) -> None: - """Test case for remove_memory_assets - - Remove assets from a memory - """ - pass - - def test_search_memories(self) -> None: - """Test case for search_memories - - Retrieve memories - """ - pass - - def test_update_memory(self) -> None: - """Test case for update_memory - - Update a memory - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memories_response.py b/generated/immich/openapi_client/test/test_memories_response.py deleted file mode 100644 index 9acf7cb..0000000 --- a/generated/immich/openapi_client/test/test_memories_response.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.memories_response import MemoriesResponse - -class TestMemoriesResponse(unittest.TestCase): - """MemoriesResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MemoriesResponse: - """Test MemoriesResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MemoriesResponse` - """ - model = MemoriesResponse() - if include_optional: - return MemoriesResponse( - duration = -9007199254740991, - enabled = True - ) - else: - return MemoriesResponse( - duration = -9007199254740991, - enabled = True, - ) - """ - - def testMemoriesResponse(self): - """Test MemoriesResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memories_update.py b/generated/immich/openapi_client/test/test_memories_update.py deleted file mode 100644 index aeea13b..0000000 --- a/generated/immich/openapi_client/test/test_memories_update.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.memories_update import MemoriesUpdate - -class TestMemoriesUpdate(unittest.TestCase): - """MemoriesUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MemoriesUpdate: - """Test MemoriesUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MemoriesUpdate` - """ - model = MemoriesUpdate() - if include_optional: - return MemoriesUpdate( - duration = 1, - enabled = True - ) - else: - return MemoriesUpdate( - ) - """ - - def testMemoriesUpdate(self): - """Test MemoriesUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memory_create_dto.py b/generated/immich/openapi_client/test/test_memory_create_dto.py deleted file mode 100644 index 9d5d04d..0000000 --- a/generated/immich/openapi_client/test/test_memory_create_dto.py +++ /dev/null @@ -1,65 +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 unittest - -from generated.immich.openapi_client.models.memory_create_dto import MemoryCreateDto - -class TestMemoryCreateDto(unittest.TestCase): - """MemoryCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MemoryCreateDto: - """Test MemoryCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MemoryCreateDto` - """ - model = MemoryCreateDto() - if include_optional: - return MemoryCreateDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - data = generated.immich.openapi_client.models.on_this_day_dto.OnThisDayDto( - year = 1000, ), - hide_at = '2024-01-01T00:00Z', - is_saved = True, - memory_at = '2024-01-01T00:00Z', - seen_at = '2024-01-01T00:00Z', - show_at = '2024-01-01T00:00Z', - type = 'on_this_day' - ) - else: - return MemoryCreateDto( - data = generated.immich.openapi_client.models.on_this_day_dto.OnThisDayDto( - year = 1000, ), - memory_at = '2024-01-01T00:00Z', - type = 'on_this_day', - ) - """ - - def testMemoryCreateDto(self): - """Test MemoryCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memory_response_dto.py b/generated/immich/openapi_client/test/test_memory_response_dto.py deleted file mode 100644 index ba9c51e..0000000 --- a/generated/immich/openapi_client/test/test_memory_response_dto.py +++ /dev/null @@ -1,236 +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 unittest - -from generated.immich.openapi_client.models.memory_response_dto import MemoryResponseDto - -class TestMemoryResponseDto(unittest.TestCase): - """MemoryResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MemoryResponseDto: - """Test MemoryResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MemoryResponseDto` - """ - model = MemoryResponseDto() - if include_optional: - return MemoryResponseDto( - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - created_at = '2024-01-01T00:00Z', - data = generated.immich.openapi_client.models.on_this_day_dto.OnThisDayDto( - year = 1000, ), - deleted_at = '2024-01-01T00:00Z', - hide_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_saved = True, - memory_at = '2024-01-01T00:00Z', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - seen_at = '2024-01-01T00:00Z', - show_at = '2024-01-01T00:00Z', - type = 'on_this_day', - updated_at = '2024-01-01T00:00Z' - ) - else: - return MemoryResponseDto( - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - created_at = '2024-01-01T00:00Z', - data = generated.immich.openapi_client.models.on_this_day_dto.OnThisDayDto( - year = 1000, ), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_saved = True, - memory_at = '2024-01-01T00:00Z', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - type = 'on_this_day', - updated_at = '2024-01-01T00:00Z', - ) - """ - - def testMemoryResponseDto(self): - """Test MemoryResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memory_type.py b/generated/immich/openapi_client/test/test_memory_type.py deleted file mode 100644 index f53165b..0000000 --- a/generated/immich/openapi_client/test/test_memory_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.memory_type import MemoryType - -class TestMemoryType(unittest.TestCase): - """MemoryType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMemoryType(self): - """Test MemoryType""" - # inst = MemoryType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_memory_update_dto.py b/generated/immich/openapi_client/test/test_memory_update_dto.py deleted file mode 100644 index d38b0bb..0000000 --- a/generated/immich/openapi_client/test/test_memory_update_dto.py +++ /dev/null @@ -1,53 +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 unittest - -from generated.immich.openapi_client.models.memory_update_dto import MemoryUpdateDto - -class TestMemoryUpdateDto(unittest.TestCase): - """MemoryUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MemoryUpdateDto: - """Test MemoryUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MemoryUpdateDto` - """ - model = MemoryUpdateDto() - if include_optional: - return MemoryUpdateDto( - is_saved = True, - memory_at = '2024-01-01T00:00Z', - seen_at = '2024-01-01T00:00Z' - ) - else: - return MemoryUpdateDto( - ) - """ - - def testMemoryUpdateDto(self): - """Test MemoryUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_merge_person_dto.py b/generated/immich/openapi_client/test/test_merge_person_dto.py deleted file mode 100644 index 6292b4c..0000000 --- a/generated/immich/openapi_client/test/test_merge_person_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.merge_person_dto import MergePersonDto - -class TestMergePersonDto(unittest.TestCase): - """MergePersonDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MergePersonDto: - """Test MergePersonDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MergePersonDto` - """ - model = MergePersonDto() - if include_optional: - return MergePersonDto( - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return MergePersonDto( - ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testMergePersonDto(self): - """Test MergePersonDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_metadata_search_dto.py b/generated/immich/openapi_client/test/test_metadata_search_dto.py deleted file mode 100644 index 093e383..0000000 --- a/generated/immich/openapi_client/test/test_metadata_search_dto.py +++ /dev/null @@ -1,98 +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 unittest - -from generated.immich.openapi_client.models.metadata_search_dto import MetadataSearchDto - -class TestMetadataSearchDto(unittest.TestCase): - """MetadataSearchDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> MetadataSearchDto: - """Test MetadataSearchDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `MetadataSearchDto` - """ - model = MetadataSearchDto() - if include_optional: - return MetadataSearchDto( - album_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - checksum = '', - city = '', - country = '', - created_after = '2024-01-01T00:00Z', - created_before = '2024-01-01T00:00Z', - description = '', - encoded_video_path = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_encoded = True, - is_favorite = True, - is_motion = True, - is_not_in_album = True, - is_offline = True, - lens_model = '', - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - make = '', - model = '', - ocr = '', - order = 'asc', - original_file_name = '', - original_path = '', - page = 1, - person_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - preview_path = '', - rating = 1, - size = 1, - state = '', - tag_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - taken_after = '2024-01-01T00:00Z', - taken_before = '2024-01-01T00:00Z', - thumbnail_path = '', - trashed_after = '2024-01-01T00:00Z', - trashed_before = '2024-01-01T00:00Z', - type = 'IMAGE', - updated_after = '2024-01-01T00:00Z', - updated_before = '2024-01-01T00:00Z', - visibility = 'archive', - with_deleted = True, - with_exif = True, - with_people = True, - with_stacked = True - ) - else: - return MetadataSearchDto( - ) - """ - - def testMetadataSearchDto(self): - """Test MetadataSearchDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_notifications_api.py b/generated/immich/openapi_client/test/test_notifications_api.py deleted file mode 100644 index b600efa..0000000 --- a/generated/immich/openapi_client/test/test_notifications_api.py +++ /dev/null @@ -1,73 +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 unittest - -from generated.immich.openapi_client.api.notifications_api import NotificationsApi - - -class TestNotificationsApi(unittest.TestCase): - """NotificationsApi unit test stubs""" - - def setUp(self) -> None: - self.api = NotificationsApi() - - def tearDown(self) -> None: - pass - - def test_delete_notification(self) -> None: - """Test case for delete_notification - - Delete a notification - """ - pass - - def test_delete_notifications(self) -> None: - """Test case for delete_notifications - - Delete notifications - """ - pass - - def test_get_notification(self) -> None: - """Test case for get_notification - - Get a notification - """ - pass - - def test_get_notifications(self) -> None: - """Test case for get_notifications - - Retrieve notifications - """ - pass - - def test_update_notification(self) -> None: - """Test case for update_notification - - Update a notification - """ - pass - - def test_update_notifications(self) -> None: - """Test case for update_notifications - - Update notifications - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_o_auth_authorize_response_dto.py b/generated/immich/openapi_client/test/test_o_auth_authorize_response_dto.py deleted file mode 100644 index e10ec0e..0000000 --- a/generated/immich/openapi_client/test/test_o_auth_authorize_response_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.o_auth_authorize_response_dto import OAuthAuthorizeResponseDto - -class TestOAuthAuthorizeResponseDto(unittest.TestCase): - """OAuthAuthorizeResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> OAuthAuthorizeResponseDto: - """Test OAuthAuthorizeResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `OAuthAuthorizeResponseDto` - """ - model = OAuthAuthorizeResponseDto() - if include_optional: - return OAuthAuthorizeResponseDto( - url = '' - ) - else: - return OAuthAuthorizeResponseDto( - url = '', - ) - """ - - def testOAuthAuthorizeResponseDto(self): - """Test OAuthAuthorizeResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_o_auth_callback_dto.py b/generated/immich/openapi_client/test/test_o_auth_callback_dto.py deleted file mode 100644 index 1ad98d5..0000000 --- a/generated/immich/openapi_client/test/test_o_auth_callback_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.o_auth_callback_dto import OAuthCallbackDto - -class TestOAuthCallbackDto(unittest.TestCase): - """OAuthCallbackDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> OAuthCallbackDto: - """Test OAuthCallbackDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `OAuthCallbackDto` - """ - model = OAuthCallbackDto() - if include_optional: - return OAuthCallbackDto( - code_verifier = '', - state = '', - url = '0' - ) - else: - return OAuthCallbackDto( - url = '0', - ) - """ - - def testOAuthCallbackDto(self): - """Test OAuthCallbackDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_o_auth_config_dto.py b/generated/immich/openapi_client/test/test_o_auth_config_dto.py deleted file mode 100644 index ce8ff6a..0000000 --- a/generated/immich/openapi_client/test/test_o_auth_config_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.o_auth_config_dto import OAuthConfigDto - -class TestOAuthConfigDto(unittest.TestCase): - """OAuthConfigDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> OAuthConfigDto: - """Test OAuthConfigDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `OAuthConfigDto` - """ - model = OAuthConfigDto() - if include_optional: - return OAuthConfigDto( - code_challenge = '', - redirect_uri = '', - state = '' - ) - else: - return OAuthConfigDto( - redirect_uri = '', - ) - """ - - def testOAuthConfigDto(self): - """Test OAuthConfigDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_on_this_day_dto.py b/generated/immich/openapi_client/test/test_on_this_day_dto.py deleted file mode 100644 index ffdea8a..0000000 --- a/generated/immich/openapi_client/test/test_on_this_day_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.on_this_day_dto import OnThisDayDto - -class TestOnThisDayDto(unittest.TestCase): - """OnThisDayDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> OnThisDayDto: - """Test OnThisDayDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `OnThisDayDto` - """ - model = OnThisDayDto() - if include_optional: - return OnThisDayDto( - year = 1000 - ) - else: - return OnThisDayDto( - year = 1000, - ) - """ - - def testOnThisDayDto(self): - """Test OnThisDayDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_partner_direction.py b/generated/immich/openapi_client/test/test_partner_direction.py deleted file mode 100644 index 41e410d..0000000 --- a/generated/immich/openapi_client/test/test_partner_direction.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.partner_direction import PartnerDirection - -class TestPartnerDirection(unittest.TestCase): - """PartnerDirection unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPartnerDirection(self): - """Test PartnerDirection""" - # inst = PartnerDirection() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_partner_response_dto.py b/generated/immich/openapi_client/test/test_partner_response_dto.py deleted file mode 100644 index 240bd1c..0000000 --- a/generated/immich/openapi_client/test/test_partner_response_dto.py +++ /dev/null @@ -1,63 +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 unittest - -from generated.immich.openapi_client.models.partner_response_dto import PartnerResponseDto - -class TestPartnerResponseDto(unittest.TestCase): - """PartnerResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PartnerResponseDto: - """Test PartnerResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PartnerResponseDto` - """ - model = PartnerResponseDto() - if include_optional: - return PartnerResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - in_timeline = True, - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '' - ) - else: - return PartnerResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', - ) - """ - - def testPartnerResponseDto(self): - """Test PartnerResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_partners_api.py b/generated/immich/openapi_client/test/test_partners_api.py deleted file mode 100644 index fcd9267..0000000 --- a/generated/immich/openapi_client/test/test_partners_api.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.api.partners_api import PartnersApi - - -class TestPartnersApi(unittest.TestCase): - """PartnersApi unit test stubs""" - - def setUp(self) -> None: - self.api = PartnersApi() - - def tearDown(self) -> None: - pass - - def test_create_partner(self) -> None: - """Test case for create_partner - - Create a partner - """ - pass - - def test_create_partner_deprecated(self) -> None: - """Test case for create_partner_deprecated - - Create a partner - """ - pass - - def test_get_partners(self) -> None: - """Test case for get_partners - - Retrieve partners - """ - pass - - def test_remove_partner(self) -> None: - """Test case for remove_partner - - Remove a partner - """ - pass - - def test_update_partner(self) -> None: - """Test case for update_partner - - Update a partner - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_people_api.py b/generated/immich/openapi_client/test/test_people_api.py deleted file mode 100644 index 587e39d..0000000 --- a/generated/immich/openapi_client/test/test_people_api.py +++ /dev/null @@ -1,108 +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 unittest - -from generated.immich.openapi_client.api.people_api import PeopleApi - - -class TestPeopleApi(unittest.TestCase): - """PeopleApi unit test stubs""" - - def setUp(self) -> None: - self.api = PeopleApi() - - def tearDown(self) -> None: - pass - - def test_create_person(self) -> None: - """Test case for create_person - - Create a person - """ - pass - - def test_delete_people(self) -> None: - """Test case for delete_people - - Delete people - """ - pass - - def test_delete_person(self) -> None: - """Test case for delete_person - - Delete person - """ - pass - - def test_get_all_people(self) -> None: - """Test case for get_all_people - - Get all people - """ - pass - - def test_get_person(self) -> None: - """Test case for get_person - - Get a person - """ - pass - - def test_get_person_statistics(self) -> None: - """Test case for get_person_statistics - - Get person statistics - """ - pass - - def test_get_person_thumbnail(self) -> None: - """Test case for get_person_thumbnail - - Get person thumbnail - """ - pass - - def test_merge_person(self) -> None: - """Test case for merge_person - - Merge people - """ - pass - - def test_reassign_faces(self) -> None: - """Test case for reassign_faces - - Reassign faces - """ - pass - - def test_update_people(self) -> None: - """Test case for update_people - - Update people - """ - pass - - def test_update_person(self) -> None: - """Test case for update_person - - Update person - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_people_response.py b/generated/immich/openapi_client/test/test_people_response.py deleted file mode 100644 index 2835aa5..0000000 --- a/generated/immich/openapi_client/test/test_people_response.py +++ /dev/null @@ -1,55 +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 unittest - -from generated.immich.openapi_client.models.people_response import PeopleResponse - -class TestPeopleResponse(unittest.TestCase): - """PeopleResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PeopleResponse: - """Test PeopleResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PeopleResponse` - """ - model = PeopleResponse() - if include_optional: - return PeopleResponse( - enabled = True, - minimum_faces = 1, - sidebar_web = True - ) - else: - return PeopleResponse( - enabled = True, - sidebar_web = True, - ) - """ - - def testPeopleResponse(self): - """Test PeopleResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_people_response_dto.py b/generated/immich/openapi_client/test/test_people_response_dto.py deleted file mode 100644 index f0e986f..0000000 --- a/generated/immich/openapi_client/test/test_people_response_dto.py +++ /dev/null @@ -1,77 +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 unittest - -from generated.immich.openapi_client.models.people_response_dto import PeopleResponseDto - -class TestPeopleResponseDto(unittest.TestCase): - """PeopleResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PeopleResponseDto: - """Test PeopleResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PeopleResponseDto` - """ - model = PeopleResponseDto() - if include_optional: - return PeopleResponseDto( - has_next_page = True, - hidden = 0, - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - total = 0 - ) - else: - return PeopleResponseDto( - hidden = 0, - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - total = 0, - ) - """ - - def testPeopleResponseDto(self): - """Test PeopleResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_people_update.py b/generated/immich/openapi_client/test/test_people_update.py deleted file mode 100644 index 350c060..0000000 --- a/generated/immich/openapi_client/test/test_people_update.py +++ /dev/null @@ -1,53 +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 unittest - -from generated.immich.openapi_client.models.people_update import PeopleUpdate - -class TestPeopleUpdate(unittest.TestCase): - """PeopleUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PeopleUpdate: - """Test PeopleUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PeopleUpdate` - """ - model = PeopleUpdate() - if include_optional: - return PeopleUpdate( - enabled = True, - minimum_faces = 1, - sidebar_web = True - ) - else: - return PeopleUpdate( - ) - """ - - def testPeopleUpdate(self): - """Test PeopleUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_people_update_dto.py b/generated/immich/openapi_client/test/test_people_update_dto.py deleted file mode 100644 index f6e290d..0000000 --- a/generated/immich/openapi_client/test/test_people_update_dto.py +++ /dev/null @@ -1,70 +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 unittest - -from generated.immich.openapi_client.models.people_update_dto import PeopleUpdateDto - -class TestPeopleUpdateDto(unittest.TestCase): - """PeopleUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PeopleUpdateDto: - """Test PeopleUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PeopleUpdateDto` - """ - model = PeopleUpdateDto() - if include_optional: - return PeopleUpdateDto( - people = [ - generated.immich.openapi_client.models.people_update_item.PeopleUpdateItem( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '#ECB02084', - feature_face_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', ) - ] - ) - else: - return PeopleUpdateDto( - people = [ - generated.immich.openapi_client.models.people_update_item.PeopleUpdateItem( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '#ECB02084', - feature_face_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', ) - ], - ) - """ - - def testPeopleUpdateDto(self): - """Test PeopleUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_people_update_item.py b/generated/immich/openapi_client/test/test_people_update_item.py deleted file mode 100644 index d2e68c4..0000000 --- a/generated/immich/openapi_client/test/test_people_update_item.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.people_update_item import PeopleUpdateItem - -class TestPeopleUpdateItem(unittest.TestCase): - """PeopleUpdateItem unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PeopleUpdateItem: - """Test PeopleUpdateItem - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PeopleUpdateItem` - """ - model = PeopleUpdateItem() - if include_optional: - return PeopleUpdateItem( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '#ECB02084', - feature_face_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '' - ) - else: - return PeopleUpdateItem( - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testPeopleUpdateItem(self): - """Test PeopleUpdateItem""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_permission.py b/generated/immich/openapi_client/test/test_permission.py deleted file mode 100644 index 0fd55b3..0000000 --- a/generated/immich/openapi_client/test/test_permission.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.permission import Permission - -class TestPermission(unittest.TestCase): - """Permission unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPermission(self): - """Test Permission""" - # inst = Permission() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_person_create_dto.py b/generated/immich/openapi_client/test/test_person_create_dto.py deleted file mode 100644 index eaed706..0000000 --- a/generated/immich/openapi_client/test/test_person_create_dto.py +++ /dev/null @@ -1,55 +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 unittest - -from generated.immich.openapi_client.models.person_create_dto import PersonCreateDto - -class TestPersonCreateDto(unittest.TestCase): - """PersonCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PersonCreateDto: - """Test PersonCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PersonCreateDto` - """ - model = PersonCreateDto() - if include_optional: - return PersonCreateDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '#ECB02084', - is_favorite = True, - is_hidden = True, - name = '' - ) - else: - return PersonCreateDto( - ) - """ - - def testPersonCreateDto(self): - """Test PersonCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_person_response_dto.py b/generated/immich/openapi_client/test/test_person_response_dto.py deleted file mode 100644 index 54de20e..0000000 --- a/generated/immich/openapi_client/test/test_person_response_dto.py +++ /dev/null @@ -1,63 +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 unittest - -from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto - -class TestPersonResponseDto(unittest.TestCase): - """PersonResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PersonResponseDto: - """Test PersonResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PersonResponseDto` - """ - model = PersonResponseDto() - if include_optional: - return PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') - ) - else: - return PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_hidden = True, - name = '', - thumbnail_path = '', - ) - """ - - def testPersonResponseDto(self): - """Test PersonResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_person_statistics_response_dto.py b/generated/immich/openapi_client/test/test_person_statistics_response_dto.py deleted file mode 100644 index 222bcc8..0000000 --- a/generated/immich/openapi_client/test/test_person_statistics_response_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.person_statistics_response_dto import PersonStatisticsResponseDto - -class TestPersonStatisticsResponseDto(unittest.TestCase): - """PersonStatisticsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PersonStatisticsResponseDto: - """Test PersonStatisticsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PersonStatisticsResponseDto` - """ - model = PersonStatisticsResponseDto() - if include_optional: - return PersonStatisticsResponseDto( - assets = -9007199254740991 - ) - else: - return PersonStatisticsResponseDto( - assets = -9007199254740991, - ) - """ - - def testPersonStatisticsResponseDto(self): - """Test PersonStatisticsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_person_update_dto.py b/generated/immich/openapi_client/test/test_person_update_dto.py deleted file mode 100644 index c760812..0000000 --- a/generated/immich/openapi_client/test/test_person_update_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.person_update_dto import PersonUpdateDto - -class TestPersonUpdateDto(unittest.TestCase): - """PersonUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PersonUpdateDto: - """Test PersonUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PersonUpdateDto` - """ - model = PersonUpdateDto() - if include_optional: - return PersonUpdateDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '#ECB02084', - feature_face_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '' - ) - else: - return PersonUpdateDto( - ) - """ - - def testPersonUpdateDto(self): - """Test PersonUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_places_response_dto.py b/generated/immich/openapi_client/test/test_places_response_dto.py deleted file mode 100644 index 5ea5f06..0000000 --- a/generated/immich/openapi_client/test/test_places_response_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.places_response_dto import PlacesResponseDto - -class TestPlacesResponseDto(unittest.TestCase): - """PlacesResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PlacesResponseDto: - """Test PlacesResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PlacesResponseDto` - """ - model = PlacesResponseDto() - if include_optional: - return PlacesResponseDto( - admin1name = '', - admin2name = '', - latitude = 1.337, - longitude = 1.337, - name = '' - ) - else: - return PlacesResponseDto( - latitude = 1.337, - longitude = 1.337, - name = '', - ) - """ - - def testPlacesResponseDto(self): - """Test PlacesResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_purchase_response.py b/generated/immich/openapi_client/test/test_purchase_response.py deleted file mode 100644 index f9390bd..0000000 --- a/generated/immich/openapi_client/test/test_purchase_response.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.purchase_response import PurchaseResponse - -class TestPurchaseResponse(unittest.TestCase): - """PurchaseResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PurchaseResponse: - """Test PurchaseResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PurchaseResponse` - """ - model = PurchaseResponse() - if include_optional: - return PurchaseResponse( - hide_buy_button_until = '', - show_support_badge = True - ) - else: - return PurchaseResponse( - hide_buy_button_until = '', - show_support_badge = True, - ) - """ - - def testPurchaseResponse(self): - """Test PurchaseResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_purchase_update.py b/generated/immich/openapi_client/test/test_purchase_update.py deleted file mode 100644 index 3abfc2a..0000000 --- a/generated/immich/openapi_client/test/test_purchase_update.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.purchase_update import PurchaseUpdate - -class TestPurchaseUpdate(unittest.TestCase): - """PurchaseUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PurchaseUpdate: - """Test PurchaseUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PurchaseUpdate` - """ - model = PurchaseUpdate() - if include_optional: - return PurchaseUpdate( - hide_buy_button_until = '', - show_support_badge = True - ) - else: - return PurchaseUpdate( - ) - """ - - def testPurchaseUpdate(self): - """Test PurchaseUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_random_search_dto.py b/generated/immich/openapi_client/test/test_random_search_dto.py deleted file mode 100644 index 614a22b..0000000 --- a/generated/immich/openapi_client/test/test_random_search_dto.py +++ /dev/null @@ -1,88 +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 unittest - -from generated.immich.openapi_client.models.random_search_dto import RandomSearchDto - -class TestRandomSearchDto(unittest.TestCase): - """RandomSearchDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> RandomSearchDto: - """Test RandomSearchDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `RandomSearchDto` - """ - model = RandomSearchDto() - if include_optional: - return RandomSearchDto( - album_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - city = '', - country = '', - created_after = '2024-01-01T00:00Z', - created_before = '2024-01-01T00:00Z', - is_encoded = True, - is_favorite = True, - is_motion = True, - is_not_in_album = True, - is_offline = True, - lens_model = '', - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - make = '', - model = '', - ocr = '', - person_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - rating = 1, - size = 1, - state = '', - tag_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - taken_after = '2024-01-01T00:00Z', - taken_before = '2024-01-01T00:00Z', - trashed_after = '2024-01-01T00:00Z', - trashed_before = '2024-01-01T00:00Z', - type = 'IMAGE', - updated_after = '2024-01-01T00:00Z', - updated_before = '2024-01-01T00:00Z', - visibility = 'archive', - with_deleted = True, - with_exif = True, - with_people = True, - with_stacked = True - ) - else: - return RandomSearchDto( - ) - """ - - def testRandomSearchDto(self): - """Test RandomSearchDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_ratings_response.py b/generated/immich/openapi_client/test/test_ratings_response.py deleted file mode 100644 index ac59115..0000000 --- a/generated/immich/openapi_client/test/test_ratings_response.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.ratings_response import RatingsResponse - -class TestRatingsResponse(unittest.TestCase): - """RatingsResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> RatingsResponse: - """Test RatingsResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `RatingsResponse` - """ - model = RatingsResponse() - if include_optional: - return RatingsResponse( - enabled = True - ) - else: - return RatingsResponse( - enabled = True, - ) - """ - - def testRatingsResponse(self): - """Test RatingsResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_ratings_update.py b/generated/immich/openapi_client/test/test_ratings_update.py deleted file mode 100644 index 6ccdf60..0000000 --- a/generated/immich/openapi_client/test/test_ratings_update.py +++ /dev/null @@ -1,51 +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 unittest - -from generated.immich.openapi_client.models.ratings_update import RatingsUpdate - -class TestRatingsUpdate(unittest.TestCase): - """RatingsUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> RatingsUpdate: - """Test RatingsUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `RatingsUpdate` - """ - model = RatingsUpdate() - if include_optional: - return RatingsUpdate( - enabled = True - ) - else: - return RatingsUpdate( - ) - """ - - def testRatingsUpdate(self): - """Test RatingsUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_reaction_level.py b/generated/immich/openapi_client/test/test_reaction_level.py deleted file mode 100644 index 4b20ce2..0000000 --- a/generated/immich/openapi_client/test/test_reaction_level.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.reaction_level import ReactionLevel - -class TestReactionLevel(unittest.TestCase): - """ReactionLevel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testReactionLevel(self): - """Test ReactionLevel""" - # inst = ReactionLevel() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_reaction_type.py b/generated/immich/openapi_client/test/test_reaction_type.py deleted file mode 100644 index 53d714c..0000000 --- a/generated/immich/openapi_client/test/test_reaction_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.reaction_type import ReactionType - -class TestReactionType(unittest.TestCase): - """ReactionType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testReactionType(self): - """Test ReactionType""" - # inst = ReactionType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_reverse_geocoding_state_response_dto.py b/generated/immich/openapi_client/test/test_reverse_geocoding_state_response_dto.py deleted file mode 100644 index 56d3cbe..0000000 --- a/generated/immich/openapi_client/test/test_reverse_geocoding_state_response_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.reverse_geocoding_state_response_dto import ReverseGeocodingStateResponseDto - -class TestReverseGeocodingStateResponseDto(unittest.TestCase): - """ReverseGeocodingStateResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ReverseGeocodingStateResponseDto: - """Test ReverseGeocodingStateResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ReverseGeocodingStateResponseDto` - """ - model = ReverseGeocodingStateResponseDto() - if include_optional: - return ReverseGeocodingStateResponseDto( - last_import_file_name = '', - last_update = '' - ) - else: - return ReverseGeocodingStateResponseDto( - last_import_file_name = '', - last_update = '', - ) - """ - - def testReverseGeocodingStateResponseDto(self): - """Test ReverseGeocodingStateResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_album_response_dto.py b/generated/immich/openapi_client/test/test_search_album_response_dto.py deleted file mode 100644 index 4fb7049..0000000 --- a/generated/immich/openapi_client/test/test_search_album_response_dto.py +++ /dev/null @@ -1,138 +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 unittest - -from generated.immich.openapi_client.models.search_album_response_dto import SearchAlbumResponseDto - -class TestSearchAlbumResponseDto(unittest.TestCase): - """SearchAlbumResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchAlbumResponseDto: - """Test SearchAlbumResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchAlbumResponseDto` - """ - model = SearchAlbumResponseDto() - if include_optional: - return SearchAlbumResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.album_response_dto.AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - contributor_counts = [ - generated.immich.openapi_client.models.contributor_count_response_dto.ContributorCountResponseDto( - asset_count = 0, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - last_modified_asset_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - order = 'asc', - shared = True, - start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - total = 0 - ) - else: - return SearchAlbumResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.album_response_dto.AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - contributor_counts = [ - generated.immich.openapi_client.models.contributor_count_response_dto.ContributorCountResponseDto( - asset_count = 0, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - last_modified_asset_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - order = 'asc', - shared = True, - start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - total = 0, - ) - """ - - def testSearchAlbumResponseDto(self): - """Test SearchAlbumResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_api.py b/generated/immich/openapi_client/test/test_search_api.py deleted file mode 100644 index ab9b50e..0000000 --- a/generated/immich/openapi_client/test/test_search_api.py +++ /dev/null @@ -1,101 +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 unittest - -from generated.immich.openapi_client.api.search_api import SearchApi - - -class TestSearchApi(unittest.TestCase): - """SearchApi unit test stubs""" - - def setUp(self) -> None: - self.api = SearchApi() - - def tearDown(self) -> None: - pass - - def test_get_assets_by_city(self) -> None: - """Test case for get_assets_by_city - - Retrieve assets by city - """ - pass - - def test_get_explore_data(self) -> None: - """Test case for get_explore_data - - Retrieve explore data - """ - pass - - def test_get_search_suggestions(self) -> None: - """Test case for get_search_suggestions - - Retrieve search suggestions - """ - pass - - def test_search_asset_statistics(self) -> None: - """Test case for search_asset_statistics - - Search asset statistics - """ - pass - - def test_search_assets(self) -> None: - """Test case for search_assets - - Search assets by metadata - """ - pass - - def test_search_large_assets(self) -> None: - """Test case for search_large_assets - - Search large assets - """ - pass - - def test_search_person(self) -> None: - """Test case for search_person - - Search people - """ - pass - - def test_search_places(self) -> None: - """Test case for search_places - - Search places - """ - pass - - def test_search_random(self) -> None: - """Test case for search_random - - Search random assets - """ - pass - - def test_search_smart(self) -> None: - """Test case for search_smart - - Smart asset search - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_asset_response_dto.py b/generated/immich/openapi_client/test/test_search_asset_response_dto.py deleted file mode 100644 index cfd56b6..0000000 --- a/generated/immich/openapi_client/test/test_search_asset_response_dto.py +++ /dev/null @@ -1,238 +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 unittest - -from generated.immich.openapi_client.models.search_asset_response_dto import SearchAssetResponseDto - -class TestSearchAssetResponseDto(unittest.TestCase): - """SearchAssetResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchAssetResponseDto: - """Test SearchAssetResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchAssetResponseDto` - """ - model = SearchAssetResponseDto() - if include_optional: - return SearchAssetResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - next_page = '', - total = 0 - ) - else: - return SearchAssetResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - next_page = '', - total = 0, - ) - """ - - def testSearchAssetResponseDto(self): - """Test SearchAssetResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_explore_item.py b/generated/immich/openapi_client/test/test_search_explore_item.py deleted file mode 100644 index f3c088a..0000000 --- a/generated/immich/openapi_client/test/test_search_explore_item.py +++ /dev/null @@ -1,212 +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 unittest - -from generated.immich.openapi_client.models.search_explore_item import SearchExploreItem - -class TestSearchExploreItem(unittest.TestCase): - """SearchExploreItem unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchExploreItem: - """Test SearchExploreItem - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchExploreItem` - """ - model = SearchExploreItem() - if include_optional: - return SearchExploreItem( - data = generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ), - value = '' - ) - else: - return SearchExploreItem( - data = generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ), - value = '', - ) - """ - - def testSearchExploreItem(self): - """Test SearchExploreItem""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_explore_response_dto.py b/generated/immich/openapi_client/test/test_search_explore_response_dto.py deleted file mode 100644 index d6c96f9..0000000 --- a/generated/immich/openapi_client/test/test_search_explore_response_dto.py +++ /dev/null @@ -1,220 +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 unittest - -from generated.immich.openapi_client.models.search_explore_response_dto import SearchExploreResponseDto - -class TestSearchExploreResponseDto(unittest.TestCase): - """SearchExploreResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchExploreResponseDto: - """Test SearchExploreResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchExploreResponseDto` - """ - model = SearchExploreResponseDto() - if include_optional: - return SearchExploreResponseDto( - field_name = '', - items = [ - generated.immich.openapi_client.models.search_explore_item.SearchExploreItem( - data = generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ), - value = '', ) - ] - ) - else: - return SearchExploreResponseDto( - field_name = '', - items = [ - generated.immich.openapi_client.models.search_explore_item.SearchExploreItem( - data = generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ), - value = '', ) - ], - ) - """ - - def testSearchExploreResponseDto(self): - """Test SearchExploreResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_facet_count_response_dto.py b/generated/immich/openapi_client/test/test_search_facet_count_response_dto.py deleted file mode 100644 index 8d92574..0000000 --- a/generated/immich/openapi_client/test/test_search_facet_count_response_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.search_facet_count_response_dto import SearchFacetCountResponseDto - -class TestSearchFacetCountResponseDto(unittest.TestCase): - """SearchFacetCountResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchFacetCountResponseDto: - """Test SearchFacetCountResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchFacetCountResponseDto` - """ - model = SearchFacetCountResponseDto() - if include_optional: - return SearchFacetCountResponseDto( - count = 0, - value = '' - ) - else: - return SearchFacetCountResponseDto( - count = 0, - value = '', - ) - """ - - def testSearchFacetCountResponseDto(self): - """Test SearchFacetCountResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_facet_response_dto.py b/generated/immich/openapi_client/test/test_search_facet_response_dto.py deleted file mode 100644 index f733ef7..0000000 --- a/generated/immich/openapi_client/test/test_search_facet_response_dto.py +++ /dev/null @@ -1,62 +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 unittest - -from generated.immich.openapi_client.models.search_facet_response_dto import SearchFacetResponseDto - -class TestSearchFacetResponseDto(unittest.TestCase): - """SearchFacetResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchFacetResponseDto: - """Test SearchFacetResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchFacetResponseDto` - """ - model = SearchFacetResponseDto() - if include_optional: - return SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '' - ) - else: - return SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', - ) - """ - - def testSearchFacetResponseDto(self): - """Test SearchFacetResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_response_dto.py b/generated/immich/openapi_client/test/test_search_response_dto.py deleted file mode 100644 index edffce2..0000000 --- a/generated/immich/openapi_client/test/test_search_response_dto.py +++ /dev/null @@ -1,330 +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 unittest - -from generated.immich.openapi_client.models.search_response_dto import SearchResponseDto - -class TestSearchResponseDto(unittest.TestCase): - """SearchResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SearchResponseDto: - """Test SearchResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SearchResponseDto` - """ - model = SearchResponseDto() - if include_optional: - return SearchResponseDto( - albums = generated.immich.openapi_client.models.search_album_response_dto.SearchAlbumResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.album_response_dto.AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - contributor_counts = [ - generated.immich.openapi_client.models.contributor_count_response_dto.ContributorCountResponseDto( - asset_count = 0, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - last_modified_asset_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - order = 'asc', - shared = True, - start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - total = 0, ), - assets = generated.immich.openapi_client.models.search_asset_response_dto.SearchAssetResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - next_page = '', - total = 0, ) - ) - else: - return SearchResponseDto( - albums = generated.immich.openapi_client.models.search_album_response_dto.SearchAlbumResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.album_response_dto.AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - contributor_counts = [ - generated.immich.openapi_client.models.contributor_count_response_dto.ContributorCountResponseDto( - asset_count = 0, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - last_modified_asset_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - order = 'asc', - shared = True, - start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - total = 0, ), - assets = generated.immich.openapi_client.models.search_asset_response_dto.SearchAssetResponseDto( - count = 0, - facets = [ - generated.immich.openapi_client.models.search_facet_response_dto.SearchFacetResponseDto( - counts = [ - generated.immich.openapi_client.models.search_facet_count_response_dto.SearchFacetCountResponseDto( - count = 0, - value = '', ) - ], - field_name = '', ) - ], - items = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - next_page = '', - total = 0, ), - ) - """ - - def testSearchResponseDto(self): - """Test SearchResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_search_suggestion_type.py b/generated/immich/openapi_client/test/test_search_suggestion_type.py deleted file mode 100644 index 1f6c36a..0000000 --- a/generated/immich/openapi_client/test/test_search_suggestion_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.search_suggestion_type import SearchSuggestionType - -class TestSearchSuggestionType(unittest.TestCase): - """SearchSuggestionType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSearchSuggestionType(self): - """Test SearchSuggestionType""" - # inst = SearchSuggestionType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_about_response_dto.py b/generated/immich/openapi_client/test/test_server_about_response_dto.py deleted file mode 100644 index de2abe5..0000000 --- a/generated/immich/openapi_client/test/test_server_about_response_dto.py +++ /dev/null @@ -1,74 +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 unittest - -from generated.immich.openapi_client.models.server_about_response_dto import ServerAboutResponseDto - -class TestServerAboutResponseDto(unittest.TestCase): - """ServerAboutResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerAboutResponseDto: - """Test ServerAboutResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerAboutResponseDto` - """ - model = ServerAboutResponseDto() - if include_optional: - return ServerAboutResponseDto( - build = '', - build_image = '', - build_image_url = '', - build_url = '', - exiftool = '', - ffmpeg = '', - imagemagick = '', - libvips = '', - licensed = True, - nodejs = '', - repository = '', - repository_url = '', - source_commit = '', - source_ref = '', - source_url = '', - third_party_bug_feature_url = '', - third_party_documentation_url = '', - third_party_source_url = '', - third_party_support_url = '', - version = '', - version_url = '' - ) - else: - return ServerAboutResponseDto( - licensed = True, - version = '', - version_url = '', - ) - """ - - def testServerAboutResponseDto(self): - """Test ServerAboutResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_api.py b/generated/immich/openapi_client/test/test_server_api.py deleted file mode 100644 index de60252..0000000 --- a/generated/immich/openapi_client/test/test_server_api.py +++ /dev/null @@ -1,129 +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 unittest - -from generated.immich.openapi_client.api.server_api import ServerApi - - -class TestServerApi(unittest.TestCase): - """ServerApi unit test stubs""" - - def setUp(self) -> None: - self.api = ServerApi() - - def tearDown(self) -> None: - pass - - def test_delete_server_license(self) -> None: - """Test case for delete_server_license - - Delete server product key - """ - pass - - def test_get_about_info(self) -> None: - """Test case for get_about_info - - Get server information - """ - pass - - def test_get_apk_links(self) -> None: - """Test case for get_apk_links - - Get APK links - """ - pass - - def test_get_server_config(self) -> None: - """Test case for get_server_config - - Get config - """ - pass - - def test_get_server_features(self) -> None: - """Test case for get_server_features - - Get features - """ - pass - - def test_get_server_license(self) -> None: - """Test case for get_server_license - - Get product key - """ - pass - - def test_get_server_statistics(self) -> None: - """Test case for get_server_statistics - - Get statistics - """ - pass - - def test_get_server_version(self) -> None: - """Test case for get_server_version - - Get server version - """ - pass - - def test_get_storage(self) -> None: - """Test case for get_storage - - Get storage - """ - pass - - def test_get_supported_media_types(self) -> None: - """Test case for get_supported_media_types - - Get supported media types - """ - pass - - def test_get_version_check(self) -> None: - """Test case for get_version_check - - Get version check status - """ - pass - - def test_get_version_history(self) -> None: - """Test case for get_version_history - - Get version history - """ - pass - - def test_ping_server(self) -> None: - """Test case for ping_server - - Ping - """ - pass - - def test_set_server_license(self) -> None: - """Test case for set_server_license - - Set server product key - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_config_dto.py b/generated/immich/openapi_client/test/test_server_config_dto.py deleted file mode 100644 index 6e5530c..0000000 --- a/generated/immich/openapi_client/test/test_server_config_dto.py +++ /dev/null @@ -1,74 +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 unittest - -from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto - -class TestServerConfigDto(unittest.TestCase): - """ServerConfigDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerConfigDto: - """Test ServerConfigDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerConfigDto` - """ - model = ServerConfigDto() - if include_optional: - return ServerConfigDto( - external_domain = '', - is_initialized = True, - is_onboarded = True, - login_page_message = '', - maintenance_mode = True, - map_dark_style_url = '', - map_light_style_url = '', - min_faces = -9007199254740991, - oauth_button_text = '', - public_users = True, - trash_days = -9007199254740991, - user_delete_delay = -9007199254740991 - ) - else: - return ServerConfigDto( - external_domain = '', - is_initialized = True, - is_onboarded = True, - login_page_message = '', - maintenance_mode = True, - map_dark_style_url = '', - map_light_style_url = '', - min_faces = -9007199254740991, - oauth_button_text = '', - public_users = True, - trash_days = -9007199254740991, - user_delete_delay = -9007199254740991, - ) - """ - - def testServerConfigDto(self): - """Test ServerConfigDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_features_dto.py b/generated/immich/openapi_client/test/test_server_features_dto.py deleted file mode 100644 index f41f215..0000000 --- a/generated/immich/openapi_client/test/test_server_features_dto.py +++ /dev/null @@ -1,82 +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 unittest - -from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto - -class TestServerFeaturesDto(unittest.TestCase): - """ServerFeaturesDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerFeaturesDto: - """Test ServerFeaturesDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerFeaturesDto` - """ - model = ServerFeaturesDto() - if include_optional: - return ServerFeaturesDto( - config_file = True, - duplicate_detection = True, - email = True, - facial_recognition = True, - import_faces = True, - map = True, - oauth = True, - oauth_auto_launch = True, - ocr = True, - password_login = True, - realtime_transcoding = True, - reverse_geocoding = True, - search = True, - sidecar = True, - smart_search = True, - trash = True - ) - else: - return ServerFeaturesDto( - config_file = True, - duplicate_detection = True, - email = True, - facial_recognition = True, - import_faces = True, - map = True, - oauth = True, - oauth_auto_launch = True, - ocr = True, - password_login = True, - realtime_transcoding = True, - reverse_geocoding = True, - search = True, - sidecar = True, - smart_search = True, - trash = True, - ) - """ - - def testServerFeaturesDto(self): - """Test ServerFeaturesDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_media_types_response_dto.py b/generated/immich/openapi_client/test/test_server_media_types_response_dto.py deleted file mode 100644 index b434266..0000000 --- a/generated/immich/openapi_client/test/test_server_media_types_response_dto.py +++ /dev/null @@ -1,68 +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 unittest - -from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto - -class TestServerMediaTypesResponseDto(unittest.TestCase): - """ServerMediaTypesResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerMediaTypesResponseDto: - """Test ServerMediaTypesResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerMediaTypesResponseDto` - """ - model = ServerMediaTypesResponseDto() - if include_optional: - return ServerMediaTypesResponseDto( - image = [ - '' - ], - sidecar = [ - '' - ], - video = [ - '' - ] - ) - else: - return ServerMediaTypesResponseDto( - image = [ - '' - ], - sidecar = [ - '' - ], - video = [ - '' - ], - ) - """ - - def testServerMediaTypesResponseDto(self): - """Test ServerMediaTypesResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_ping_response.py b/generated/immich/openapi_client/test/test_server_ping_response.py deleted file mode 100644 index 72d9951..0000000 --- a/generated/immich/openapi_client/test/test_server_ping_response.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse - -class TestServerPingResponse(unittest.TestCase): - """ServerPingResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerPingResponse: - """Test ServerPingResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerPingResponse` - """ - model = ServerPingResponse() - if include_optional: - return ServerPingResponse( - res = 'pong' - ) - else: - return ServerPingResponse( - res = 'pong', - ) - """ - - def testServerPingResponse(self): - """Test ServerPingResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_stats_response_dto.py b/generated/immich/openapi_client/test/test_server_stats_response_dto.py deleted file mode 100644 index ddf7a4a..0000000 --- a/generated/immich/openapi_client/test/test_server_stats_response_dto.py +++ /dev/null @@ -1,82 +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 unittest - -from generated.immich.openapi_client.models.server_stats_response_dto import ServerStatsResponseDto - -class TestServerStatsResponseDto(unittest.TestCase): - """ServerStatsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerStatsResponseDto: - """Test ServerStatsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerStatsResponseDto` - """ - model = ServerStatsResponseDto() - if include_optional: - return ServerStatsResponseDto( - photos = -9007199254740991, - usage = -9007199254740991, - usage_by_user = [ - generated.immich.openapi_client.models.usage_by_user_dto.UsageByUserDto( - photos = -9007199254740991, - quota_size_in_bytes = -9007199254740991, - usage = -9007199254740991, - usage_photos = -9007199254740991, - usage_videos = -9007199254740991, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - user_name = '', - videos = -9007199254740991, ) - ], - usage_photos = -9007199254740991, - usage_videos = -9007199254740991, - videos = -9007199254740991 - ) - else: - return ServerStatsResponseDto( - photos = -9007199254740991, - usage = -9007199254740991, - usage_by_user = [ - generated.immich.openapi_client.models.usage_by_user_dto.UsageByUserDto( - photos = -9007199254740991, - quota_size_in_bytes = -9007199254740991, - usage = -9007199254740991, - usage_photos = -9007199254740991, - usage_videos = -9007199254740991, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - user_name = '', - videos = -9007199254740991, ) - ], - usage_photos = -9007199254740991, - usage_videos = -9007199254740991, - videos = -9007199254740991, - ) - """ - - def testServerStatsResponseDto(self): - """Test ServerStatsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_storage_response_dto.py b/generated/immich/openapi_client/test/test_server_storage_response_dto.py deleted file mode 100644 index 5ecc716..0000000 --- a/generated/immich/openapi_client/test/test_server_storage_response_dto.py +++ /dev/null @@ -1,64 +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 unittest - -from generated.immich.openapi_client.models.server_storage_response_dto import ServerStorageResponseDto - -class TestServerStorageResponseDto(unittest.TestCase): - """ServerStorageResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerStorageResponseDto: - """Test ServerStorageResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerStorageResponseDto` - """ - model = ServerStorageResponseDto() - if include_optional: - return ServerStorageResponseDto( - disk_available = '', - disk_available_raw = -9007199254740991, - disk_size = '', - disk_size_raw = -9007199254740991, - disk_usage_percentage = 1.337, - disk_use = '', - disk_use_raw = -9007199254740991 - ) - else: - return ServerStorageResponseDto( - disk_available = '', - disk_available_raw = -9007199254740991, - disk_size = '', - disk_size_raw = -9007199254740991, - disk_usage_percentage = 1.337, - disk_use = '', - disk_use_raw = -9007199254740991, - ) - """ - - def testServerStorageResponseDto(self): - """Test ServerStorageResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_version_history_response_dto.py b/generated/immich/openapi_client/test/test_server_version_history_response_dto.py deleted file mode 100644 index 5804284..0000000 --- a/generated/immich/openapi_client/test/test_server_version_history_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto - -class TestServerVersionHistoryResponseDto(unittest.TestCase): - """ServerVersionHistoryResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerVersionHistoryResponseDto: - """Test ServerVersionHistoryResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerVersionHistoryResponseDto` - """ - model = ServerVersionHistoryResponseDto() - if include_optional: - return ServerVersionHistoryResponseDto( - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - version = '' - ) - else: - return ServerVersionHistoryResponseDto( - created_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - version = '', - ) - """ - - def testServerVersionHistoryResponseDto(self): - """Test ServerVersionHistoryResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_server_version_response_dto.py b/generated/immich/openapi_client/test/test_server_version_response_dto.py deleted file mode 100644 index 7bd9dcd..0000000 --- a/generated/immich/openapi_client/test/test_server_version_response_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto - -class TestServerVersionResponseDto(unittest.TestCase): - """ServerVersionResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ServerVersionResponseDto: - """Test ServerVersionResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ServerVersionResponseDto` - """ - model = ServerVersionResponseDto() - if include_optional: - return ServerVersionResponseDto( - major = 0, - minor = 0, - patch = 0, - prerelease = 0 - ) - else: - return ServerVersionResponseDto( - major = 0, - minor = 0, - patch = 0, - prerelease = 0, - ) - """ - - def testServerVersionResponseDto(self): - """Test ServerVersionResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_session_response_dto.py b/generated/immich/openapi_client/test/test_session_response_dto.py deleted file mode 100644 index 3171a95..0000000 --- a/generated/immich/openapi_client/test/test_session_response_dto.py +++ /dev/null @@ -1,67 +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 unittest - -from generated.immich.openapi_client.models.session_response_dto import SessionResponseDto - -class TestSessionResponseDto(unittest.TestCase): - """SessionResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SessionResponseDto: - """Test SessionResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SessionResponseDto` - """ - model = SessionResponseDto() - if include_optional: - return SessionResponseDto( - app_version = '', - created_at = '', - current = True, - device_os = '', - device_type = '', - expires_at = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_pending_sync_reset = True, - updated_at = '' - ) - else: - return SessionResponseDto( - app_version = '', - created_at = '', - current = True, - device_os = '', - device_type = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_pending_sync_reset = True, - updated_at = '', - ) - """ - - def testSessionResponseDto(self): - """Test SessionResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sessions_api.py b/generated/immich/openapi_client/test/test_sessions_api.py deleted file mode 100644 index 5f736a7..0000000 --- a/generated/immich/openapi_client/test/test_sessions_api.py +++ /dev/null @@ -1,73 +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 unittest - -from generated.immich.openapi_client.api.sessions_api import SessionsApi - - -class TestSessionsApi(unittest.TestCase): - """SessionsApi unit test stubs""" - - def setUp(self) -> None: - self.api = SessionsApi() - - def tearDown(self) -> None: - pass - - def test_create_session(self) -> None: - """Test case for create_session - - Create a session - """ - pass - - def test_delete_all_sessions(self) -> None: - """Test case for delete_all_sessions - - Delete all sessions - """ - pass - - def test_delete_session(self) -> None: - """Test case for delete_session - - Delete a session - """ - pass - - def test_get_sessions(self) -> None: - """Test case for get_sessions - - Retrieve sessions - """ - pass - - def test_lock_session(self) -> None: - """Test case for lock_session - - Lock a session - """ - pass - - def test_update_session(self) -> None: - """Test case for update_session - - Update a session - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_link_create_dto.py b/generated/immich/openapi_client/test/test_shared_link_create_dto.py deleted file mode 100644 index ff2ba7e..0000000 --- a/generated/immich/openapi_client/test/test_shared_link_create_dto.py +++ /dev/null @@ -1,63 +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 unittest - -from generated.immich.openapi_client.models.shared_link_create_dto import SharedLinkCreateDto - -class TestSharedLinkCreateDto(unittest.TestCase): - """SharedLinkCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SharedLinkCreateDto: - """Test SharedLinkCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SharedLinkCreateDto` - """ - model = SharedLinkCreateDto() - if include_optional: - return SharedLinkCreateDto( - album_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - allow_download = True, - allow_upload = True, - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - description = '', - expires_at = '2024-01-01T00:00Z', - password = '', - show_metadata = True, - slug = '', - type = 'ALBUM' - ) - else: - return SharedLinkCreateDto( - type = 'ALBUM', - ) - """ - - def testSharedLinkCreateDto(self): - """Test SharedLinkCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_link_edit_dto.py b/generated/immich/openapi_client/test/test_shared_link_edit_dto.py deleted file mode 100644 index d53e82e..0000000 --- a/generated/immich/openapi_client/test/test_shared_link_edit_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.shared_link_edit_dto import SharedLinkEditDto - -class TestSharedLinkEditDto(unittest.TestCase): - """SharedLinkEditDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SharedLinkEditDto: - """Test SharedLinkEditDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SharedLinkEditDto` - """ - model = SharedLinkEditDto() - if include_optional: - return SharedLinkEditDto( - allow_download = True, - allow_upload = True, - description = '', - expires_at = '2024-01-01T00:00Z', - password = '', - show_metadata = True, - slug = '' - ) - else: - return SharedLinkEditDto( - ) - """ - - def testSharedLinkEditDto(self): - """Test SharedLinkEditDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_link_response_dto.py b/generated/immich/openapi_client/test/test_shared_link_response_dto.py deleted file mode 100644 index b315ca8..0000000 --- a/generated/immich/openapi_client/test/test_shared_link_response_dto.py +++ /dev/null @@ -1,269 +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 unittest - -from generated.immich.openapi_client.models.shared_link_response_dto import SharedLinkResponseDto - -class TestSharedLinkResponseDto(unittest.TestCase): - """SharedLinkResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SharedLinkResponseDto: - """Test SharedLinkResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SharedLinkResponseDto` - """ - model = SharedLinkResponseDto() - if include_optional: - return SharedLinkResponseDto( - album = generated.immich.openapi_client.models.album_response_dto.AlbumResponseDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - album_users = [ - generated.immich.openapi_client.models.album_user_response_dto.AlbumUserResponseDto( - role = 'editor', - user = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), ) - ], - asset_count = 0, - contributor_counts = [ - generated.immich.openapi_client.models.contributor_count_response_dto.ContributorCountResponseDto( - asset_count = 0, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', ) - ], - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_shared_link = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_activity_enabled = True, - last_modified_asset_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - order = 'asc', - shared = True, - start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), - allow_download = True, - allow_upload = True, - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - created_at = '2024-01-01T00:00Z', - description = '', - expires_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - key = '', - password = '', - show_metadata = True, - slug = '', - type = 'ALBUM', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return SharedLinkResponseDto( - allow_download = True, - allow_upload = True, - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - created_at = '2024-01-01T00:00Z', - description = '', - expires_at = '2024-01-01T00:00Z', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - key = '', - password = '', - show_metadata = True, - slug = '', - type = 'ALBUM', - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testSharedLinkResponseDto(self): - """Test SharedLinkResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_link_type.py b/generated/immich/openapi_client/test/test_shared_link_type.py deleted file mode 100644 index faa8238..0000000 --- a/generated/immich/openapi_client/test/test_shared_link_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.shared_link_type import SharedLinkType - -class TestSharedLinkType(unittest.TestCase): - """SharedLinkType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSharedLinkType(self): - """Test SharedLinkType""" - # inst = SharedLinkType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_links_api.py b/generated/immich/openapi_client/test/test_shared_links_api.py deleted file mode 100644 index 8bb18e1..0000000 --- a/generated/immich/openapi_client/test/test_shared_links_api.py +++ /dev/null @@ -1,94 +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 unittest - -from generated.immich.openapi_client.api.shared_links_api import SharedLinksApi - - -class TestSharedLinksApi(unittest.TestCase): - """SharedLinksApi unit test stubs""" - - def setUp(self) -> None: - self.api = SharedLinksApi() - - def tearDown(self) -> None: - pass - - def test_add_shared_link_assets(self) -> None: - """Test case for add_shared_link_assets - - Add assets to a shared link - """ - pass - - def test_create_shared_link(self) -> None: - """Test case for create_shared_link - - Create a shared link - """ - pass - - def test_get_all_shared_links(self) -> None: - """Test case for get_all_shared_links - - Retrieve all shared links - """ - pass - - def test_get_my_shared_link(self) -> None: - """Test case for get_my_shared_link - - Retrieve current shared link - """ - pass - - def test_get_shared_link_by_id(self) -> None: - """Test case for get_shared_link_by_id - - Retrieve a shared link - """ - pass - - def test_remove_shared_link(self) -> None: - """Test case for remove_shared_link - - Delete a shared link - """ - pass - - def test_remove_shared_link_assets(self) -> None: - """Test case for remove_shared_link_assets - - Remove assets from a shared link - """ - pass - - def test_shared_link_login(self) -> None: - """Test case for shared_link_login - - Shared link login - """ - pass - - def test_update_shared_link(self) -> None: - """Test case for update_shared_link - - Update a shared link - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_links_response.py b/generated/immich/openapi_client/test/test_shared_links_response.py deleted file mode 100644 index 8f375f4..0000000 --- a/generated/immich/openapi_client/test/test_shared_links_response.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.shared_links_response import SharedLinksResponse - -class TestSharedLinksResponse(unittest.TestCase): - """SharedLinksResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SharedLinksResponse: - """Test SharedLinksResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SharedLinksResponse` - """ - model = SharedLinksResponse() - if include_optional: - return SharedLinksResponse( - enabled = True, - sidebar_web = True - ) - else: - return SharedLinksResponse( - enabled = True, - sidebar_web = True, - ) - """ - - def testSharedLinksResponse(self): - """Test SharedLinksResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_shared_links_update.py b/generated/immich/openapi_client/test/test_shared_links_update.py deleted file mode 100644 index 3689c27..0000000 --- a/generated/immich/openapi_client/test/test_shared_links_update.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.shared_links_update import SharedLinksUpdate - -class TestSharedLinksUpdate(unittest.TestCase): - """SharedLinksUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SharedLinksUpdate: - """Test SharedLinksUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SharedLinksUpdate` - """ - model = SharedLinksUpdate() - if include_optional: - return SharedLinksUpdate( - enabled = True, - sidebar_web = True - ) - else: - return SharedLinksUpdate( - ) - """ - - def testSharedLinksUpdate(self): - """Test SharedLinksUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sign_up_dto.py b/generated/immich/openapi_client/test/test_sign_up_dto.py deleted file mode 100644 index 070753d..0000000 --- a/generated/immich/openapi_client/test/test_sign_up_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.sign_up_dto import SignUpDto - -class TestSignUpDto(unittest.TestCase): - """SignUpDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SignUpDto: - """Test SignUpDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SignUpDto` - """ - model = SignUpDto() - if include_optional: - return SignUpDto( - email = 'testuser@email.com', - name = 'Admin', - password = 'password' - ) - else: - return SignUpDto( - email = 'testuser@email.com', - name = 'Admin', - password = 'password', - ) - """ - - def testSignUpDto(self): - """Test SignUpDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_smart_search_dto.py b/generated/immich/openapi_client/test/test_smart_search_dto.py deleted file mode 100644 index 3b439d9..0000000 --- a/generated/immich/openapi_client/test/test_smart_search_dto.py +++ /dev/null @@ -1,90 +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 unittest - -from generated.immich.openapi_client.models.smart_search_dto import SmartSearchDto - -class TestSmartSearchDto(unittest.TestCase): - """SmartSearchDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SmartSearchDto: - """Test SmartSearchDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SmartSearchDto` - """ - model = SmartSearchDto() - if include_optional: - return SmartSearchDto( - album_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - city = '', - country = '', - created_after = '2024-01-01T00:00Z', - created_before = '2024-01-01T00:00Z', - is_encoded = True, - is_favorite = True, - is_motion = True, - is_not_in_album = True, - is_offline = True, - language = '', - lens_model = '', - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - make = '', - model = '', - ocr = '', - page = 1, - person_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - query = '', - query_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - rating = 1, - size = 1, - state = '', - tag_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - taken_after = '2024-01-01T00:00Z', - taken_before = '2024-01-01T00:00Z', - trashed_after = '2024-01-01T00:00Z', - trashed_before = '2024-01-01T00:00Z', - type = 'IMAGE', - updated_after = '2024-01-01T00:00Z', - updated_before = '2024-01-01T00:00Z', - visibility = 'archive', - with_deleted = True, - with_exif = True - ) - else: - return SmartSearchDto( - ) - """ - - def testSmartSearchDto(self): - """Test SmartSearchDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_source_type.py b/generated/immich/openapi_client/test/test_source_type.py deleted file mode 100644 index 4b7e39c..0000000 --- a/generated/immich/openapi_client/test/test_source_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.source_type import SourceType - -class TestSourceType(unittest.TestCase): - """SourceType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSourceType(self): - """Test SourceType""" - # inst = SourceType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_stack_create_dto.py b/generated/immich/openapi_client/test/test_stack_create_dto.py deleted file mode 100644 index 4494e69..0000000 --- a/generated/immich/openapi_client/test/test_stack_create_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.stack_create_dto import StackCreateDto - -class TestStackCreateDto(unittest.TestCase): - """StackCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> StackCreateDto: - """Test StackCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `StackCreateDto` - """ - model = StackCreateDto() - if include_optional: - return StackCreateDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return StackCreateDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testStackCreateDto(self): - """Test StackCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_stack_response_dto.py b/generated/immich/openapi_client/test/test_stack_response_dto.py deleted file mode 100644 index fcaf815..0000000 --- a/generated/immich/openapi_client/test/test_stack_response_dto.py +++ /dev/null @@ -1,218 +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 unittest - -from generated.immich.openapi_client.models.stack_response_dto import StackResponseDto - -class TestStackResponseDto(unittest.TestCase): - """StackResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> StackResponseDto: - """Test StackResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `StackResponseDto` - """ - model = StackResponseDto() - if include_optional: - return StackResponseDto( - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - primary_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return StackResponseDto( - assets = [ - generated.immich.openapi_client.models.asset_response_dto.AssetResponseDto( - checksum = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - duplicate_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - duration = 0, - exif_info = generated.immich.openapi_client.models.exif_response_dto.ExifResponseDto( - city = '', - country = '', - date_time_original = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - description = '', - exif_image_height = 0, - exif_image_width = 0, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = 0, - focal_length = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - orientation = '', - projection_type = '', - rating = 1, - state = '', - time_zone = '', ), - file_created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - file_modified_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - has_metadata = True, - height = 0, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_archived = True, - is_edited = True, - is_favorite = True, - is_offline = True, - is_trashed = True, - library_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - live_photo_video_id = '', - local_date_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - original_file_name = '', - original_mime_type = '', - original_path = '', - owner = generated.immich.openapi_client.models.user_response_dto.UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', ), - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - people = [ - generated.immich.openapi_client.models.person_response_dto.PersonResponseDto( - birth_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), - color = '', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_favorite = True, - is_hidden = True, - name = '', - thumbnail_path = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) - ], - resized = True, - stack = null, - tags = [ - generated.immich.openapi_client.models.tag_response_dto.TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', ) - ], - thumbhash = '', - type = 'IMAGE', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - visibility = 'archive', - width = 0, ) - ], - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - primary_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testStackResponseDto(self): - """Test StackResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_stack_update_dto.py b/generated/immich/openapi_client/test/test_stack_update_dto.py deleted file mode 100644 index ad87ba2..0000000 --- a/generated/immich/openapi_client/test/test_stack_update_dto.py +++ /dev/null @@ -1,51 +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 unittest - -from generated.immich.openapi_client.models.stack_update_dto import StackUpdateDto - -class TestStackUpdateDto(unittest.TestCase): - """StackUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> StackUpdateDto: - """Test StackUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `StackUpdateDto` - """ - model = StackUpdateDto() - if include_optional: - return StackUpdateDto( - primary_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return StackUpdateDto( - ) - """ - - def testStackUpdateDto(self): - """Test StackUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_stacks_api.py b/generated/immich/openapi_client/test/test_stacks_api.py deleted file mode 100644 index 31ec53e..0000000 --- a/generated/immich/openapi_client/test/test_stacks_api.py +++ /dev/null @@ -1,80 +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 unittest - -from generated.immich.openapi_client.api.stacks_api import StacksApi - - -class TestStacksApi(unittest.TestCase): - """StacksApi unit test stubs""" - - def setUp(self) -> None: - self.api = StacksApi() - - def tearDown(self) -> None: - pass - - def test_create_stack(self) -> None: - """Test case for create_stack - - Create a stack - """ - pass - - def test_delete_stack(self) -> None: - """Test case for delete_stack - - Delete a stack - """ - pass - - def test_delete_stacks(self) -> None: - """Test case for delete_stacks - - Delete stacks - """ - pass - - def test_get_stack(self) -> None: - """Test case for get_stack - - Retrieve a stack - """ - pass - - def test_remove_asset_from_stack(self) -> None: - """Test case for remove_asset_from_stack - - Remove an asset from a stack - """ - pass - - def test_search_stacks(self) -> None: - """Test case for search_stacks - - Retrieve stacks - """ - pass - - def test_update_stack(self) -> None: - """Test case for update_stack - - Update a stack - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_ack_delete_dto.py b/generated/immich/openapi_client/test/test_sync_ack_delete_dto.py deleted file mode 100644 index a8d27a9..0000000 --- a/generated/immich/openapi_client/test/test_sync_ack_delete_dto.py +++ /dev/null @@ -1,53 +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 unittest - -from generated.immich.openapi_client.models.sync_ack_delete_dto import SyncAckDeleteDto - -class TestSyncAckDeleteDto(unittest.TestCase): - """SyncAckDeleteDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncAckDeleteDto: - """Test SyncAckDeleteDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncAckDeleteDto` - """ - model = SyncAckDeleteDto() - if include_optional: - return SyncAckDeleteDto( - types = [ - 'AuthUserV1' - ] - ) - else: - return SyncAckDeleteDto( - ) - """ - - def testSyncAckDeleteDto(self): - """Test SyncAckDeleteDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_ack_dto.py b/generated/immich/openapi_client/test/test_sync_ack_dto.py deleted file mode 100644 index 65648d4..0000000 --- a/generated/immich/openapi_client/test/test_sync_ack_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.sync_ack_dto import SyncAckDto - -class TestSyncAckDto(unittest.TestCase): - """SyncAckDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncAckDto: - """Test SyncAckDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncAckDto` - """ - model = SyncAckDto() - if include_optional: - return SyncAckDto( - ack = '', - type = 'AuthUserV1' - ) - else: - return SyncAckDto( - ack = '', - type = 'AuthUserV1', - ) - """ - - def testSyncAckDto(self): - """Test SyncAckDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_ack_set_dto.py b/generated/immich/openapi_client/test/test_sync_ack_set_dto.py deleted file mode 100644 index 2adbdc3..0000000 --- a/generated/immich/openapi_client/test/test_sync_ack_set_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.sync_ack_set_dto import SyncAckSetDto - -class TestSyncAckSetDto(unittest.TestCase): - """SyncAckSetDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncAckSetDto: - """Test SyncAckSetDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncAckSetDto` - """ - model = SyncAckSetDto() - if include_optional: - return SyncAckSetDto( - acks = [ - '' - ] - ) - else: - return SyncAckSetDto( - acks = [ - '' - ], - ) - """ - - def testSyncAckSetDto(self): - """Test SyncAckSetDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_api.py b/generated/immich/openapi_client/test/test_sync_api.py deleted file mode 100644 index 837600a..0000000 --- a/generated/immich/openapi_client/test/test_sync_api.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.api.sync_api import SyncApi - - -class TestSyncApi(unittest.TestCase): - """SyncApi unit test stubs""" - - def setUp(self) -> None: - self.api = SyncApi() - - def tearDown(self) -> None: - pass - - def test_delete_sync_ack(self) -> None: - """Test case for delete_sync_ack - - Delete acknowledgements - """ - pass - - def test_get_sync_ack(self) -> None: - """Test case for get_sync_ack - - Retrieve acknowledgements - """ - pass - - def test_get_sync_stream(self) -> None: - """Test case for get_sync_stream - - Stream sync changes - """ - pass - - def test_send_sync_ack(self) -> None: - """Test case for send_sync_ack - - Acknowledge changes - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_asset_delete_v1.py b/generated/immich/openapi_client/test/test_sync_asset_delete_v1.py deleted file mode 100644 index acb0a04..0000000 --- a/generated/immich/openapi_client/test/test_sync_asset_delete_v1.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.sync_asset_delete_v1 import SyncAssetDeleteV1 - -class TestSyncAssetDeleteV1(unittest.TestCase): - """SyncAssetDeleteV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncAssetDeleteV1: - """Test SyncAssetDeleteV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncAssetDeleteV1` - """ - model = SyncAssetDeleteV1() - if include_optional: - return SyncAssetDeleteV1( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return SyncAssetDeleteV1( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testSyncAssetDeleteV1(self): - """Test SyncAssetDeleteV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_asset_exif_v1.py b/generated/immich/openapi_client/test/test_sync_asset_exif_v1.py deleted file mode 100644 index 7b5a426..0000000 --- a/generated/immich/openapi_client/test/test_sync_asset_exif_v1.py +++ /dev/null @@ -1,100 +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 unittest - -from generated.immich.openapi_client.models.sync_asset_exif_v1 import SyncAssetExifV1 - -class TestSyncAssetExifV1(unittest.TestCase): - """SyncAssetExifV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncAssetExifV1: - """Test SyncAssetExifV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncAssetExifV1` - """ - model = SyncAssetExifV1() - if include_optional: - return SyncAssetExifV1( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - city = '', - country = '', - date_time_original = '2024-01-01T00:00Z', - description = '', - exif_image_height = -9007199254740991, - exif_image_width = -9007199254740991, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = -9007199254740991, - focal_length = 1.337, - fps = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = '2024-01-01T00:00Z', - orientation = '', - profile_description = '', - projection_type = '', - rating = -9007199254740991, - state = '', - time_zone = '' - ) - else: - return SyncAssetExifV1( - asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - city = '', - country = '', - date_time_original = '2024-01-01T00:00Z', - description = '', - exif_image_height = -9007199254740991, - exif_image_width = -9007199254740991, - exposure_time = '', - f_number = 1.337, - file_size_in_byte = -9007199254740991, - focal_length = 1.337, - fps = 1.337, - iso = -9007199254740991, - latitude = 1.337, - lens_model = '', - longitude = 1.337, - make = '', - model = '', - modify_date = '2024-01-01T00:00Z', - orientation = '', - profile_description = '', - projection_type = '', - rating = -9007199254740991, - state = '', - time_zone = '', - ) - """ - - def testSyncAssetExifV1(self): - """Test SyncAssetExifV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_asset_v1.py b/generated/immich/openapi_client/test/test_sync_asset_v1.py deleted file mode 100644 index 6492b5f..0000000 --- a/generated/immich/openapi_client/test/test_sync_asset_v1.py +++ /dev/null @@ -1,90 +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 unittest - -from generated.immich.openapi_client.models.sync_asset_v1 import SyncAssetV1 - -class TestSyncAssetV1(unittest.TestCase): - """SyncAssetV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncAssetV1: - """Test SyncAssetV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncAssetV1` - """ - model = SyncAssetV1() - if include_optional: - return SyncAssetV1( - checksum = '', - created_at = '2024-01-01T00:00Z', - deleted_at = '2024-01-01T00:00Z', - duration = '', - file_created_at = '2024-01-01T00:00Z', - file_modified_at = '2024-01-01T00:00Z', - height = -9007199254740991, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_edited = True, - is_favorite = True, - library_id = '', - live_photo_video_id = '', - local_date_time = '2024-01-01T00:00Z', - original_file_name = '', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - stack_id = '', - thumbhash = '', - type = 'IMAGE', - visibility = 'archive', - width = -9007199254740991 - ) - else: - return SyncAssetV1( - checksum = '', - created_at = '2024-01-01T00:00Z', - deleted_at = '2024-01-01T00:00Z', - duration = '', - file_created_at = '2024-01-01T00:00Z', - file_modified_at = '2024-01-01T00:00Z', - height = -9007199254740991, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_edited = True, - is_favorite = True, - library_id = '', - live_photo_video_id = '', - local_date_time = '2024-01-01T00:00Z', - original_file_name = '', - owner_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - stack_id = '', - thumbhash = '', - type = 'IMAGE', - visibility = 'archive', - width = -9007199254740991, - ) - """ - - def testSyncAssetV1(self): - """Test SyncAssetV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_entity_type.py b/generated/immich/openapi_client/test/test_sync_entity_type.py deleted file mode 100644 index 804fb4c..0000000 --- a/generated/immich/openapi_client/test/test_sync_entity_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.sync_entity_type import SyncEntityType - -class TestSyncEntityType(unittest.TestCase): - """SyncEntityType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSyncEntityType(self): - """Test SyncEntityType""" - # inst = SyncEntityType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_partner_delete_v1.py b/generated/immich/openapi_client/test/test_sync_partner_delete_v1.py deleted file mode 100644 index 5876132..0000000 --- a/generated/immich/openapi_client/test/test_sync_partner_delete_v1.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.sync_partner_delete_v1 import SyncPartnerDeleteV1 - -class TestSyncPartnerDeleteV1(unittest.TestCase): - """SyncPartnerDeleteV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncPartnerDeleteV1: - """Test SyncPartnerDeleteV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncPartnerDeleteV1` - """ - model = SyncPartnerDeleteV1() - if include_optional: - return SyncPartnerDeleteV1( - shared_by_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - shared_with_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return SyncPartnerDeleteV1( - shared_by_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - shared_with_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testSyncPartnerDeleteV1(self): - """Test SyncPartnerDeleteV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_partner_v1.py b/generated/immich/openapi_client/test/test_sync_partner_v1.py deleted file mode 100644 index 21a33f3..0000000 --- a/generated/immich/openapi_client/test/test_sync_partner_v1.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.sync_partner_v1 import SyncPartnerV1 - -class TestSyncPartnerV1(unittest.TestCase): - """SyncPartnerV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncPartnerV1: - """Test SyncPartnerV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncPartnerV1` - """ - model = SyncPartnerV1() - if include_optional: - return SyncPartnerV1( - in_timeline = True, - shared_by_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - shared_with_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return SyncPartnerV1( - in_timeline = True, - shared_by_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - shared_with_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testSyncPartnerV1(self): - """Test SyncPartnerV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_request_type.py b/generated/immich/openapi_client/test/test_sync_request_type.py deleted file mode 100644 index 4d22eae..0000000 --- a/generated/immich/openapi_client/test/test_sync_request_type.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.sync_request_type import SyncRequestType - -class TestSyncRequestType(unittest.TestCase): - """SyncRequestType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSyncRequestType(self): - """Test SyncRequestType""" - # inst = SyncRequestType() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_stream_dto.py b/generated/immich/openapi_client/test/test_sync_stream_dto.py deleted file mode 100644 index 797a18d..0000000 --- a/generated/immich/openapi_client/test/test_sync_stream_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.sync_stream_dto import SyncStreamDto - -class TestSyncStreamDto(unittest.TestCase): - """SyncStreamDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncStreamDto: - """Test SyncStreamDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncStreamDto` - """ - model = SyncStreamDto() - if include_optional: - return SyncStreamDto( - reset = True, - types = [ - 'AlbumsV1' - ] - ) - else: - return SyncStreamDto( - types = [ - 'AlbumsV1' - ], - ) - """ - - def testSyncStreamDto(self): - """Test SyncStreamDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_user_delete_v1.py b/generated/immich/openapi_client/test/test_sync_user_delete_v1.py deleted file mode 100644 index 8e816a0..0000000 --- a/generated/immich/openapi_client/test/test_sync_user_delete_v1.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.sync_user_delete_v1 import SyncUserDeleteV1 - -class TestSyncUserDeleteV1(unittest.TestCase): - """SyncUserDeleteV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncUserDeleteV1: - """Test SyncUserDeleteV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncUserDeleteV1` - """ - model = SyncUserDeleteV1() - if include_optional: - return SyncUserDeleteV1( - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return SyncUserDeleteV1( - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - ) - """ - - def testSyncUserDeleteV1(self): - """Test SyncUserDeleteV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_sync_user_v1.py b/generated/immich/openapi_client/test/test_sync_user_v1.py deleted file mode 100644 index 2005ec1..0000000 --- a/generated/immich/openapi_client/test/test_sync_user_v1.py +++ /dev/null @@ -1,63 +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 unittest - -from generated.immich.openapi_client.models.sync_user_v1 import SyncUserV1 - -class TestSyncUserV1(unittest.TestCase): - """SyncUserV1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SyncUserV1: - """Test SyncUserV1 - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SyncUserV1` - """ - model = SyncUserV1() - if include_optional: - return SyncUserV1( - avatar_color = 'primary', - deleted_at = '2024-01-01T00:00Z', - email = '', - has_profile_image = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = '2024-01-01T00:00Z' - ) - else: - return SyncUserV1( - deleted_at = '2024-01-01T00:00Z', - email = '', - has_profile_image = True, - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = '2024-01-01T00:00Z', - ) - """ - - def testSyncUserV1(self): - """Test SyncUserV1""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_api.py b/generated/immich/openapi_client/test/test_system_config_api.py deleted file mode 100644 index eebf78f..0000000 --- a/generated/immich/openapi_client/test/test_system_config_api.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.api.system_config_api import SystemConfigApi - - -class TestSystemConfigApi(unittest.TestCase): - """SystemConfigApi unit test stubs""" - - def setUp(self) -> None: - self.api = SystemConfigApi() - - def tearDown(self) -> None: - pass - - def test_get_config(self) -> None: - """Test case for get_config - - Get system configuration - """ - pass - - def test_get_config_defaults(self) -> None: - """Test case for get_config_defaults - - Get system configuration defaults - """ - pass - - def test_get_storage_template_options(self) -> None: - """Test case for get_storage_template_options - - Get storage template options - """ - pass - - def test_update_config(self) -> None: - """Test case for update_config - - Update system configuration - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_backups_dto.py b/generated/immich/openapi_client/test/test_system_config_backups_dto.py deleted file mode 100644 index c9f31d9..0000000 --- a/generated/immich/openapi_client/test/test_system_config_backups_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.system_config_backups_dto import SystemConfigBackupsDto - -class TestSystemConfigBackupsDto(unittest.TestCase): - """SystemConfigBackupsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigBackupsDto: - """Test SystemConfigBackupsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigBackupsDto` - """ - model = SystemConfigBackupsDto() - if include_optional: - return SystemConfigBackupsDto( - database = generated.immich.openapi_client.models.database_backup_config.DatabaseBackupConfig( - cron_expression = '', - enabled = True, - keep_last_amount = 1, ) - ) - else: - return SystemConfigBackupsDto( - database = generated.immich.openapi_client.models.database_backup_config.DatabaseBackupConfig( - cron_expression = '', - enabled = True, - keep_last_amount = 1, ), - ) - """ - - def testSystemConfigBackupsDto(self): - """Test SystemConfigBackupsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_dto.py b/generated/immich/openapi_client/test/test_system_config_dto.py deleted file mode 100644 index 4da35c1..0000000 --- a/generated/immich/openapi_client/test/test_system_config_dto.py +++ /dev/null @@ -1,438 +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 unittest - -from generated.immich.openapi_client.models.system_config_dto import SystemConfigDto - -class TestSystemConfigDto(unittest.TestCase): - """SystemConfigDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigDto: - """Test SystemConfigDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigDto` - """ - model = SystemConfigDto() - if include_optional: - return SystemConfigDto( - backup = generated.immich.openapi_client.models.system_config_backups_dto.SystemConfigBackupsDto( - database = generated.immich.openapi_client.models.database_backup_config.DatabaseBackupConfig( - cron_expression = '', - enabled = True, - keep_last_amount = 1, ), ), - ffmpeg = generated.immich.openapi_client.models.system_config_f_fmpeg_dto.SystemConfigFFmpegDto( - accel = 'nvenc', - accel_decode = True, - accepted_audio_codecs = [ - 'mp3' - ], - accepted_containers = [ - 'mov' - ], - accepted_video_codecs = [ - 'h264' - ], - bframes = -1, - cq_mode = 'auto', - crf = 0, - gop_size = 0, - max_bitrate = '', - preferred_hw_device = '', - preset = '', - realtime = generated.immich.openapi_client.models.system_config_f_fmpeg_realtime_dto.SystemConfigFFmpegRealtimeDto( - enabled = True, ), - refs = 0, - target_audio_codec = 'mp3', - target_resolution = '', - target_video_codec = 'h264', - temporal_aq = True, - threads = 0, - tonemap = 'hable', - transcode = 'all', - two_pass = True, ), - image = generated.immich.openapi_client.models.system_config_image_dto.SystemConfigImageDto( - colorspace = 'srgb', - extract_embedded = True, - fullsize = generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto.SystemConfigGeneratedFullsizeImageDto( - enabled = True, - format = 'jpeg', - progressive = True, - quality = 1, ), - preview = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1, ), - thumbnail = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = , - progressive = True, - quality = 1, - size = 1, ), ), - integrity_checks = generated.immich.openapi_client.models.system_config_integrity_checks.SystemConfigIntegrityChecks( - checksum_files = generated.immich.openapi_client.models.system_config_integrity_checksum_job.SystemConfigIntegrityChecksumJob( - cron_expression = '', - enabled = True, - percentage_limit = 0, - time_limit = 0, ), - missing_files = generated.immich.openapi_client.models.system_config_integrity_job.SystemConfigIntegrityJob( - cron_expression = '', - enabled = True, ), - untracked_files = generated.immich.openapi_client.models.system_config_integrity_job.SystemConfigIntegrityJob( - cron_expression = '', - enabled = True, ), ), - job = generated.immich.openapi_client.models.system_config_job_dto.SystemConfigJobDto( - background_task = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - editor = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - face_detection = , - integrity_check = , - library = , - metadata_extraction = , - migration = , - notifications = , - ocr = , - search = , - sidecar = , - smart_search = , - thumbnail_generation = , - video_conversion = , - workflow = , ), - library = generated.immich.openapi_client.models.system_config_library_dto.SystemConfigLibraryDto( - scan = generated.immich.openapi_client.models.system_config_library_scan_dto.SystemConfigLibraryScanDto( - cron_expression = '', - enabled = True, ), - watch = generated.immich.openapi_client.models.system_config_library_watch_dto.SystemConfigLibraryWatchDto( - enabled = True, ), ), - logging = generated.immich.openapi_client.models.system_config_logging_dto.SystemConfigLoggingDto( - enabled = True, - level = 'verbose', ), - machine_learning = generated.immich.openapi_client.models.system_config_machine_learning_dto.SystemConfigMachineLearningDto( - availability_checks = generated.immich.openapi_client.models.machine_learning_availability_checks_dto.MachineLearningAvailabilityChecksDto( - enabled = True, - interval = -9007199254740991, - timeout = -9007199254740991, ), - clip = generated.immich.openapi_client.models.clip_config.CLIPConfig( - enabled = True, - model_name = '', ), - duplicate_detection = generated.immich.openapi_client.models.duplicate_detection_config.DuplicateDetectionConfig( - enabled = True, - max_distance = 0.001, ), - enabled = True, - facial_recognition = generated.immich.openapi_client.models.facial_recognition_config.FacialRecognitionConfig( - enabled = True, - max_distance = 0.1, - min_faces = 1, - min_score = 0.1, - model_name = '', ), - ocr = generated.immich.openapi_client.models.ocr_config.OcrConfig( - enabled = True, - max_resolution = 1, - min_detection_score = 0.1, - min_recognition_score = 0.1, - model_name = '', ), - urls = [ - '' - ], ), - map = generated.immich.openapi_client.models.system_config_map_dto.SystemConfigMapDto( - dark_style = '', - enabled = True, - light_style = '', ), - metadata = generated.immich.openapi_client.models.system_config_metadata_dto.SystemConfigMetadataDto( - faces = generated.immich.openapi_client.models.system_config_faces_dto.SystemConfigFacesDto( - import = True, ), ), - new_version_check = generated.immich.openapi_client.models.system_config_new_version_check_dto.SystemConfigNewVersionCheckDto( - channel = 'stable', - enabled = True, ), - nightly_tasks = generated.immich.openapi_client.models.system_config_nightly_tasks_dto.SystemConfigNightlyTasksDto( - cluster_new_faces = True, - database_cleanup = True, - generate_memories = True, - missing_thumbnails = True, - start_time = '23:20', - sync_quota_usage = True, ), - notifications = generated.immich.openapi_client.models.system_config_notifications_dto.SystemConfigNotificationsDto( - smtp = generated.immich.openapi_client.models.system_config_smtp_dto.SystemConfigSmtpDto( - enabled = True, - from = '', - reply_to = '', - transport = generated.immich.openapi_client.models.system_config_smtp_transport_dto.SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', ), ), ), - oauth = generated.immich.openapi_client.models.system_config_o_auth_dto.SystemConfigOAuthDto( - allow_insecure_requests = True, - auto_launch = True, - auto_register = True, - button_text = '', - client_id = '', - client_secret = '', - default_storage_quota = 0, - enabled = True, - end_session_endpoint = '', - issuer_url = '', - mobile_override_enabled = True, - mobile_redirect_uri = '', - profile_signing_algorithm = '', - prompt = '', - role_claim = '', - scope = '', - signing_algorithm = '', - storage_label_claim = '', - storage_quota_claim = '', - timeout = 1, - token_endpoint_auth_method = 'client_secret_post', ), - password_login = generated.immich.openapi_client.models.system_config_password_login_dto.SystemConfigPasswordLoginDto( - enabled = True, ), - reverse_geocoding = generated.immich.openapi_client.models.system_config_reverse_geocoding_dto.SystemConfigReverseGeocodingDto( - enabled = True, ), - server = generated.immich.openapi_client.models.system_config_server_dto.SystemConfigServerDto( - external_domain = '', - login_page_message = '', - public_users = True, ), - storage_template = generated.immich.openapi_client.models.system_config_storage_template_dto.SystemConfigStorageTemplateDto( - enabled = True, - hash_verification_enabled = True, - template = '', ), - templates = generated.immich.openapi_client.models.system_config_templates_dto.SystemConfigTemplatesDto( - email = generated.immich.openapi_client.models.system_config_template_emails_dto.SystemConfigTemplateEmailsDto( - album_invite_template = '', - album_update_template = '', - welcome_template = '', ), ), - theme = generated.immich.openapi_client.models.system_config_theme_dto.SystemConfigThemeDto( - custom_css = '', ), - trash = generated.immich.openapi_client.models.system_config_trash_dto.SystemConfigTrashDto( - days = 0, - enabled = True, ), - user = generated.immich.openapi_client.models.system_config_user_dto.SystemConfigUserDto( - delete_delay = 1, ) - ) - else: - return SystemConfigDto( - backup = generated.immich.openapi_client.models.system_config_backups_dto.SystemConfigBackupsDto( - database = generated.immich.openapi_client.models.database_backup_config.DatabaseBackupConfig( - cron_expression = '', - enabled = True, - keep_last_amount = 1, ), ), - ffmpeg = generated.immich.openapi_client.models.system_config_f_fmpeg_dto.SystemConfigFFmpegDto( - accel = 'nvenc', - accel_decode = True, - accepted_audio_codecs = [ - 'mp3' - ], - accepted_containers = [ - 'mov' - ], - accepted_video_codecs = [ - 'h264' - ], - bframes = -1, - cq_mode = 'auto', - crf = 0, - gop_size = 0, - max_bitrate = '', - preferred_hw_device = '', - preset = '', - realtime = generated.immich.openapi_client.models.system_config_f_fmpeg_realtime_dto.SystemConfigFFmpegRealtimeDto( - enabled = True, ), - refs = 0, - target_audio_codec = 'mp3', - target_resolution = '', - target_video_codec = 'h264', - temporal_aq = True, - threads = 0, - tonemap = 'hable', - transcode = 'all', - two_pass = True, ), - image = generated.immich.openapi_client.models.system_config_image_dto.SystemConfigImageDto( - colorspace = 'srgb', - extract_embedded = True, - fullsize = generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto.SystemConfigGeneratedFullsizeImageDto( - enabled = True, - format = 'jpeg', - progressive = True, - quality = 1, ), - preview = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1, ), - thumbnail = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = , - progressive = True, - quality = 1, - size = 1, ), ), - integrity_checks = generated.immich.openapi_client.models.system_config_integrity_checks.SystemConfigIntegrityChecks( - checksum_files = generated.immich.openapi_client.models.system_config_integrity_checksum_job.SystemConfigIntegrityChecksumJob( - cron_expression = '', - enabled = True, - percentage_limit = 0, - time_limit = 0, ), - missing_files = generated.immich.openapi_client.models.system_config_integrity_job.SystemConfigIntegrityJob( - cron_expression = '', - enabled = True, ), - untracked_files = generated.immich.openapi_client.models.system_config_integrity_job.SystemConfigIntegrityJob( - cron_expression = '', - enabled = True, ), ), - job = generated.immich.openapi_client.models.system_config_job_dto.SystemConfigJobDto( - background_task = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - editor = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - face_detection = , - integrity_check = , - library = , - metadata_extraction = , - migration = , - notifications = , - ocr = , - search = , - sidecar = , - smart_search = , - thumbnail_generation = , - video_conversion = , - workflow = , ), - library = generated.immich.openapi_client.models.system_config_library_dto.SystemConfigLibraryDto( - scan = generated.immich.openapi_client.models.system_config_library_scan_dto.SystemConfigLibraryScanDto( - cron_expression = '', - enabled = True, ), - watch = generated.immich.openapi_client.models.system_config_library_watch_dto.SystemConfigLibraryWatchDto( - enabled = True, ), ), - logging = generated.immich.openapi_client.models.system_config_logging_dto.SystemConfigLoggingDto( - enabled = True, - level = 'verbose', ), - machine_learning = generated.immich.openapi_client.models.system_config_machine_learning_dto.SystemConfigMachineLearningDto( - availability_checks = generated.immich.openapi_client.models.machine_learning_availability_checks_dto.MachineLearningAvailabilityChecksDto( - enabled = True, - interval = -9007199254740991, - timeout = -9007199254740991, ), - clip = generated.immich.openapi_client.models.clip_config.CLIPConfig( - enabled = True, - model_name = '', ), - duplicate_detection = generated.immich.openapi_client.models.duplicate_detection_config.DuplicateDetectionConfig( - enabled = True, - max_distance = 0.001, ), - enabled = True, - facial_recognition = generated.immich.openapi_client.models.facial_recognition_config.FacialRecognitionConfig( - enabled = True, - max_distance = 0.1, - min_faces = 1, - min_score = 0.1, - model_name = '', ), - ocr = generated.immich.openapi_client.models.ocr_config.OcrConfig( - enabled = True, - max_resolution = 1, - min_detection_score = 0.1, - min_recognition_score = 0.1, - model_name = '', ), - urls = [ - '' - ], ), - map = generated.immich.openapi_client.models.system_config_map_dto.SystemConfigMapDto( - dark_style = '', - enabled = True, - light_style = '', ), - metadata = generated.immich.openapi_client.models.system_config_metadata_dto.SystemConfigMetadataDto( - faces = generated.immich.openapi_client.models.system_config_faces_dto.SystemConfigFacesDto( - import = True, ), ), - new_version_check = generated.immich.openapi_client.models.system_config_new_version_check_dto.SystemConfigNewVersionCheckDto( - channel = 'stable', - enabled = True, ), - nightly_tasks = generated.immich.openapi_client.models.system_config_nightly_tasks_dto.SystemConfigNightlyTasksDto( - cluster_new_faces = True, - database_cleanup = True, - generate_memories = True, - missing_thumbnails = True, - start_time = '23:20', - sync_quota_usage = True, ), - notifications = generated.immich.openapi_client.models.system_config_notifications_dto.SystemConfigNotificationsDto( - smtp = generated.immich.openapi_client.models.system_config_smtp_dto.SystemConfigSmtpDto( - enabled = True, - from = '', - reply_to = '', - transport = generated.immich.openapi_client.models.system_config_smtp_transport_dto.SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', ), ), ), - oauth = generated.immich.openapi_client.models.system_config_o_auth_dto.SystemConfigOAuthDto( - allow_insecure_requests = True, - auto_launch = True, - auto_register = True, - button_text = '', - client_id = '', - client_secret = '', - default_storage_quota = 0, - enabled = True, - end_session_endpoint = '', - issuer_url = '', - mobile_override_enabled = True, - mobile_redirect_uri = '', - profile_signing_algorithm = '', - prompt = '', - role_claim = '', - scope = '', - signing_algorithm = '', - storage_label_claim = '', - storage_quota_claim = '', - timeout = 1, - token_endpoint_auth_method = 'client_secret_post', ), - password_login = generated.immich.openapi_client.models.system_config_password_login_dto.SystemConfigPasswordLoginDto( - enabled = True, ), - reverse_geocoding = generated.immich.openapi_client.models.system_config_reverse_geocoding_dto.SystemConfigReverseGeocodingDto( - enabled = True, ), - server = generated.immich.openapi_client.models.system_config_server_dto.SystemConfigServerDto( - external_domain = '', - login_page_message = '', - public_users = True, ), - storage_template = generated.immich.openapi_client.models.system_config_storage_template_dto.SystemConfigStorageTemplateDto( - enabled = True, - hash_verification_enabled = True, - template = '', ), - templates = generated.immich.openapi_client.models.system_config_templates_dto.SystemConfigTemplatesDto( - email = generated.immich.openapi_client.models.system_config_template_emails_dto.SystemConfigTemplateEmailsDto( - album_invite_template = '', - album_update_template = '', - welcome_template = '', ), ), - theme = generated.immich.openapi_client.models.system_config_theme_dto.SystemConfigThemeDto( - custom_css = '', ), - trash = generated.immich.openapi_client.models.system_config_trash_dto.SystemConfigTrashDto( - days = 0, - enabled = True, ), - user = generated.immich.openapi_client.models.system_config_user_dto.SystemConfigUserDto( - delete_delay = 1, ), - ) - """ - - def testSystemConfigDto(self): - """Test SystemConfigDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_f_fmpeg_dto.py b/generated/immich/openapi_client/test/test_system_config_f_fmpeg_dto.py deleted file mode 100644 index d729a66..0000000 --- a/generated/immich/openapi_client/test/test_system_config_f_fmpeg_dto.py +++ /dev/null @@ -1,108 +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 unittest - -from generated.immich.openapi_client.models.system_config_f_fmpeg_dto import SystemConfigFFmpegDto - -class TestSystemConfigFFmpegDto(unittest.TestCase): - """SystemConfigFFmpegDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigFFmpegDto: - """Test SystemConfigFFmpegDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigFFmpegDto` - """ - model = SystemConfigFFmpegDto() - if include_optional: - return SystemConfigFFmpegDto( - accel = 'nvenc', - accel_decode = True, - accepted_audio_codecs = [ - 'mp3' - ], - accepted_containers = [ - 'mov' - ], - accepted_video_codecs = [ - 'h264' - ], - bframes = -1, - cq_mode = 'auto', - crf = 0, - gop_size = 0, - max_bitrate = '', - preferred_hw_device = '', - preset = '', - realtime = generated.immich.openapi_client.models.system_config_f_fmpeg_realtime_dto.SystemConfigFFmpegRealtimeDto( - enabled = True, ), - refs = 0, - target_audio_codec = 'mp3', - target_resolution = '', - target_video_codec = 'h264', - temporal_aq = True, - threads = 0, - tonemap = 'hable', - transcode = 'all', - two_pass = True - ) - else: - return SystemConfigFFmpegDto( - accel = 'nvenc', - accel_decode = True, - accepted_audio_codecs = [ - 'mp3' - ], - accepted_containers = [ - 'mov' - ], - accepted_video_codecs = [ - 'h264' - ], - bframes = -1, - cq_mode = 'auto', - crf = 0, - gop_size = 0, - max_bitrate = '', - preferred_hw_device = '', - preset = '', - realtime = generated.immich.openapi_client.models.system_config_f_fmpeg_realtime_dto.SystemConfigFFmpegRealtimeDto( - enabled = True, ), - refs = 0, - target_audio_codec = 'mp3', - target_resolution = '', - target_video_codec = 'h264', - temporal_aq = True, - threads = 0, - tonemap = 'hable', - transcode = 'all', - two_pass = True, - ) - """ - - def testSystemConfigFFmpegDto(self): - """Test SystemConfigFFmpegDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_faces_dto.py b/generated/immich/openapi_client/test/test_system_config_faces_dto.py deleted file mode 100644 index 4320e02..0000000 --- a/generated/immich/openapi_client/test/test_system_config_faces_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.system_config_faces_dto import SystemConfigFacesDto - -class TestSystemConfigFacesDto(unittest.TestCase): - """SystemConfigFacesDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigFacesDto: - """Test SystemConfigFacesDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigFacesDto` - """ - model = SystemConfigFacesDto() - if include_optional: - return SystemConfigFacesDto( - var_import = True - ) - else: - return SystemConfigFacesDto( - var_import = True, - ) - """ - - def testSystemConfigFacesDto(self): - """Test SystemConfigFacesDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_generated_fullsize_image_dto.py b/generated/immich/openapi_client/test/test_system_config_generated_fullsize_image_dto.py deleted file mode 100644 index 850bc95..0000000 --- a/generated/immich/openapi_client/test/test_system_config_generated_fullsize_image_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto import SystemConfigGeneratedFullsizeImageDto - -class TestSystemConfigGeneratedFullsizeImageDto(unittest.TestCase): - """SystemConfigGeneratedFullsizeImageDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigGeneratedFullsizeImageDto: - """Test SystemConfigGeneratedFullsizeImageDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigGeneratedFullsizeImageDto` - """ - model = SystemConfigGeneratedFullsizeImageDto() - if include_optional: - return SystemConfigGeneratedFullsizeImageDto( - enabled = True, - format = 'jpeg', - progressive = True, - quality = 1 - ) - else: - return SystemConfigGeneratedFullsizeImageDto( - enabled = True, - format = 'jpeg', - quality = 1, - ) - """ - - def testSystemConfigGeneratedFullsizeImageDto(self): - """Test SystemConfigGeneratedFullsizeImageDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_generated_image_dto.py b/generated/immich/openapi_client/test/test_system_config_generated_image_dto.py deleted file mode 100644 index ba4232e..0000000 --- a/generated/immich/openapi_client/test/test_system_config_generated_image_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.system_config_generated_image_dto import SystemConfigGeneratedImageDto - -class TestSystemConfigGeneratedImageDto(unittest.TestCase): - """SystemConfigGeneratedImageDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigGeneratedImageDto: - """Test SystemConfigGeneratedImageDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigGeneratedImageDto` - """ - model = SystemConfigGeneratedImageDto() - if include_optional: - return SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1 - ) - else: - return SystemConfigGeneratedImageDto( - format = 'jpeg', - quality = 1, - size = 1, - ) - """ - - def testSystemConfigGeneratedImageDto(self): - """Test SystemConfigGeneratedImageDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_image_dto.py b/generated/immich/openapi_client/test/test_system_config_image_dto.py deleted file mode 100644 index fa17866..0000000 --- a/generated/immich/openapi_client/test/test_system_config_image_dto.py +++ /dev/null @@ -1,84 +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 unittest - -from generated.immich.openapi_client.models.system_config_image_dto import SystemConfigImageDto - -class TestSystemConfigImageDto(unittest.TestCase): - """SystemConfigImageDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigImageDto: - """Test SystemConfigImageDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigImageDto` - """ - model = SystemConfigImageDto() - if include_optional: - return SystemConfigImageDto( - colorspace = 'srgb', - extract_embedded = True, - fullsize = generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto.SystemConfigGeneratedFullsizeImageDto( - enabled = True, - format = 'jpeg', - progressive = True, - quality = 1, ), - preview = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1, ), - thumbnail = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1, ) - ) - else: - return SystemConfigImageDto( - colorspace = 'srgb', - extract_embedded = True, - fullsize = generated.immich.openapi_client.models.system_config_generated_fullsize_image_dto.SystemConfigGeneratedFullsizeImageDto( - enabled = True, - format = 'jpeg', - progressive = True, - quality = 1, ), - preview = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1, ), - thumbnail = generated.immich.openapi_client.models.system_config_generated_image_dto.SystemConfigGeneratedImageDto( - format = 'jpeg', - progressive = True, - quality = 1, - size = 1, ), - ) - """ - - def testSystemConfigImageDto(self): - """Test SystemConfigImageDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_job_dto.py b/generated/immich/openapi_client/test/test_system_config_job_dto.py deleted file mode 100644 index dacabe1..0000000 --- a/generated/immich/openapi_client/test/test_system_config_job_dto.py +++ /dev/null @@ -1,110 +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 unittest - -from generated.immich.openapi_client.models.system_config_job_dto import SystemConfigJobDto - -class TestSystemConfigJobDto(unittest.TestCase): - """SystemConfigJobDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigJobDto: - """Test SystemConfigJobDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigJobDto` - """ - model = SystemConfigJobDto() - if include_optional: - return SystemConfigJobDto( - background_task = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - editor = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - face_detection = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - integrity_check = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - library = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - metadata_extraction = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - migration = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - notifications = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - ocr = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - search = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - sidecar = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - smart_search = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - thumbnail_generation = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - video_conversion = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - workflow = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ) - ) - else: - return SystemConfigJobDto( - background_task = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - editor = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - face_detection = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - integrity_check = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - library = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - metadata_extraction = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - migration = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - notifications = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - ocr = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - search = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - sidecar = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - smart_search = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - thumbnail_generation = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - video_conversion = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - workflow = generated.immich.openapi_client.models.job_settings_dto.JobSettingsDto( - concurrency = 1, ), - ) - """ - - def testSystemConfigJobDto(self): - """Test SystemConfigJobDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_library_dto.py b/generated/immich/openapi_client/test/test_system_config_library_dto.py deleted file mode 100644 index c160a2b..0000000 --- a/generated/immich/openapi_client/test/test_system_config_library_dto.py +++ /dev/null @@ -1,60 +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 unittest - -from generated.immich.openapi_client.models.system_config_library_dto import SystemConfigLibraryDto - -class TestSystemConfigLibraryDto(unittest.TestCase): - """SystemConfigLibraryDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigLibraryDto: - """Test SystemConfigLibraryDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigLibraryDto` - """ - model = SystemConfigLibraryDto() - if include_optional: - return SystemConfigLibraryDto( - scan = generated.immich.openapi_client.models.system_config_library_scan_dto.SystemConfigLibraryScanDto( - cron_expression = '', - enabled = True, ), - watch = generated.immich.openapi_client.models.system_config_library_watch_dto.SystemConfigLibraryWatchDto( - enabled = True, ) - ) - else: - return SystemConfigLibraryDto( - scan = generated.immich.openapi_client.models.system_config_library_scan_dto.SystemConfigLibraryScanDto( - cron_expression = '', - enabled = True, ), - watch = generated.immich.openapi_client.models.system_config_library_watch_dto.SystemConfigLibraryWatchDto( - enabled = True, ), - ) - """ - - def testSystemConfigLibraryDto(self): - """Test SystemConfigLibraryDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_library_scan_dto.py b/generated/immich/openapi_client/test/test_system_config_library_scan_dto.py deleted file mode 100644 index 370ed5a..0000000 --- a/generated/immich/openapi_client/test/test_system_config_library_scan_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.system_config_library_scan_dto import SystemConfigLibraryScanDto - -class TestSystemConfigLibraryScanDto(unittest.TestCase): - """SystemConfigLibraryScanDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigLibraryScanDto: - """Test SystemConfigLibraryScanDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigLibraryScanDto` - """ - model = SystemConfigLibraryScanDto() - if include_optional: - return SystemConfigLibraryScanDto( - cron_expression = '', - enabled = True - ) - else: - return SystemConfigLibraryScanDto( - cron_expression = '', - enabled = True, - ) - """ - - def testSystemConfigLibraryScanDto(self): - """Test SystemConfigLibraryScanDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_library_watch_dto.py b/generated/immich/openapi_client/test/test_system_config_library_watch_dto.py deleted file mode 100644 index 97e5905..0000000 --- a/generated/immich/openapi_client/test/test_system_config_library_watch_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.system_config_library_watch_dto import SystemConfigLibraryWatchDto - -class TestSystemConfigLibraryWatchDto(unittest.TestCase): - """SystemConfigLibraryWatchDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigLibraryWatchDto: - """Test SystemConfigLibraryWatchDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigLibraryWatchDto` - """ - model = SystemConfigLibraryWatchDto() - if include_optional: - return SystemConfigLibraryWatchDto( - enabled = True - ) - else: - return SystemConfigLibraryWatchDto( - enabled = True, - ) - """ - - def testSystemConfigLibraryWatchDto(self): - """Test SystemConfigLibraryWatchDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_logging_dto.py b/generated/immich/openapi_client/test/test_system_config_logging_dto.py deleted file mode 100644 index d47f5f9..0000000 --- a/generated/immich/openapi_client/test/test_system_config_logging_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.system_config_logging_dto import SystemConfigLoggingDto - -class TestSystemConfigLoggingDto(unittest.TestCase): - """SystemConfigLoggingDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigLoggingDto: - """Test SystemConfigLoggingDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigLoggingDto` - """ - model = SystemConfigLoggingDto() - if include_optional: - return SystemConfigLoggingDto( - enabled = True, - level = 'verbose' - ) - else: - return SystemConfigLoggingDto( - enabled = True, - level = 'verbose', - ) - """ - - def testSystemConfigLoggingDto(self): - """Test SystemConfigLoggingDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_machine_learning_dto.py b/generated/immich/openapi_client/test/test_system_config_machine_learning_dto.py deleted file mode 100644 index cbe2ed4..0000000 --- a/generated/immich/openapi_client/test/test_system_config_machine_learning_dto.py +++ /dev/null @@ -1,102 +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 unittest - -from generated.immich.openapi_client.models.system_config_machine_learning_dto import SystemConfigMachineLearningDto - -class TestSystemConfigMachineLearningDto(unittest.TestCase): - """SystemConfigMachineLearningDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigMachineLearningDto: - """Test SystemConfigMachineLearningDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigMachineLearningDto` - """ - model = SystemConfigMachineLearningDto() - if include_optional: - return SystemConfigMachineLearningDto( - availability_checks = generated.immich.openapi_client.models.machine_learning_availability_checks_dto.MachineLearningAvailabilityChecksDto( - enabled = True, - interval = -9007199254740991, - timeout = -9007199254740991, ), - clip = generated.immich.openapi_client.models.clip_config.CLIPConfig( - enabled = True, - model_name = '', ), - duplicate_detection = generated.immich.openapi_client.models.duplicate_detection_config.DuplicateDetectionConfig( - enabled = True, - max_distance = 0.001, ), - enabled = True, - facial_recognition = generated.immich.openapi_client.models.facial_recognition_config.FacialRecognitionConfig( - enabled = True, - max_distance = 0.1, - min_faces = 1, - min_score = 0.1, - model_name = '', ), - ocr = generated.immich.openapi_client.models.ocr_config.OcrConfig( - enabled = True, - max_resolution = 1, - min_detection_score = 0.1, - min_recognition_score = 0.1, - model_name = '', ), - urls = [ - '' - ] - ) - else: - return SystemConfigMachineLearningDto( - availability_checks = generated.immich.openapi_client.models.machine_learning_availability_checks_dto.MachineLearningAvailabilityChecksDto( - enabled = True, - interval = -9007199254740991, - timeout = -9007199254740991, ), - clip = generated.immich.openapi_client.models.clip_config.CLIPConfig( - enabled = True, - model_name = '', ), - duplicate_detection = generated.immich.openapi_client.models.duplicate_detection_config.DuplicateDetectionConfig( - enabled = True, - max_distance = 0.001, ), - enabled = True, - facial_recognition = generated.immich.openapi_client.models.facial_recognition_config.FacialRecognitionConfig( - enabled = True, - max_distance = 0.1, - min_faces = 1, - min_score = 0.1, - model_name = '', ), - ocr = generated.immich.openapi_client.models.ocr_config.OcrConfig( - enabled = True, - max_resolution = 1, - min_detection_score = 0.1, - min_recognition_score = 0.1, - model_name = '', ), - urls = [ - '' - ], - ) - """ - - def testSystemConfigMachineLearningDto(self): - """Test SystemConfigMachineLearningDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_map_dto.py b/generated/immich/openapi_client/test/test_system_config_map_dto.py deleted file mode 100644 index af955fe..0000000 --- a/generated/immich/openapi_client/test/test_system_config_map_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.system_config_map_dto import SystemConfigMapDto - -class TestSystemConfigMapDto(unittest.TestCase): - """SystemConfigMapDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigMapDto: - """Test SystemConfigMapDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigMapDto` - """ - model = SystemConfigMapDto() - if include_optional: - return SystemConfigMapDto( - dark_style = '', - enabled = True, - light_style = '' - ) - else: - return SystemConfigMapDto( - dark_style = '', - enabled = True, - light_style = '', - ) - """ - - def testSystemConfigMapDto(self): - """Test SystemConfigMapDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_metadata_dto.py b/generated/immich/openapi_client/test/test_system_config_metadata_dto.py deleted file mode 100644 index 1592f92..0000000 --- a/generated/immich/openapi_client/test/test_system_config_metadata_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.system_config_metadata_dto import SystemConfigMetadataDto - -class TestSystemConfigMetadataDto(unittest.TestCase): - """SystemConfigMetadataDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigMetadataDto: - """Test SystemConfigMetadataDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigMetadataDto` - """ - model = SystemConfigMetadataDto() - if include_optional: - return SystemConfigMetadataDto( - faces = generated.immich.openapi_client.models.system_config_faces_dto.SystemConfigFacesDto( - import = True, ) - ) - else: - return SystemConfigMetadataDto( - faces = generated.immich.openapi_client.models.system_config_faces_dto.SystemConfigFacesDto( - import = True, ), - ) - """ - - def testSystemConfigMetadataDto(self): - """Test SystemConfigMetadataDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_new_version_check_dto.py b/generated/immich/openapi_client/test/test_system_config_new_version_check_dto.py deleted file mode 100644 index 1e9518d..0000000 --- a/generated/immich/openapi_client/test/test_system_config_new_version_check_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.system_config_new_version_check_dto import SystemConfigNewVersionCheckDto - -class TestSystemConfigNewVersionCheckDto(unittest.TestCase): - """SystemConfigNewVersionCheckDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigNewVersionCheckDto: - """Test SystemConfigNewVersionCheckDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigNewVersionCheckDto` - """ - model = SystemConfigNewVersionCheckDto() - if include_optional: - return SystemConfigNewVersionCheckDto( - channel = 'stable', - enabled = True - ) - else: - return SystemConfigNewVersionCheckDto( - channel = 'stable', - enabled = True, - ) - """ - - def testSystemConfigNewVersionCheckDto(self): - """Test SystemConfigNewVersionCheckDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_notifications_dto.py b/generated/immich/openapi_client/test/test_system_config_notifications_dto.py deleted file mode 100644 index 8d0e2f0..0000000 --- a/generated/immich/openapi_client/test/test_system_config_notifications_dto.py +++ /dev/null @@ -1,72 +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 unittest - -from generated.immich.openapi_client.models.system_config_notifications_dto import SystemConfigNotificationsDto - -class TestSystemConfigNotificationsDto(unittest.TestCase): - """SystemConfigNotificationsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigNotificationsDto: - """Test SystemConfigNotificationsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigNotificationsDto` - """ - model = SystemConfigNotificationsDto() - if include_optional: - return SystemConfigNotificationsDto( - smtp = generated.immich.openapi_client.models.system_config_smtp_dto.SystemConfigSmtpDto( - enabled = True, - from = '', - reply_to = '', - transport = generated.immich.openapi_client.models.system_config_smtp_transport_dto.SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', ), ) - ) - else: - return SystemConfigNotificationsDto( - smtp = generated.immich.openapi_client.models.system_config_smtp_dto.SystemConfigSmtpDto( - enabled = True, - from = '', - reply_to = '', - transport = generated.immich.openapi_client.models.system_config_smtp_transport_dto.SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', ), ), - ) - """ - - def testSystemConfigNotificationsDto(self): - """Test SystemConfigNotificationsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_o_auth_dto.py b/generated/immich/openapi_client/test/test_system_config_o_auth_dto.py deleted file mode 100644 index c0dea0a..0000000 --- a/generated/immich/openapi_client/test/test_system_config_o_auth_dto.py +++ /dev/null @@ -1,92 +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 unittest - -from generated.immich.openapi_client.models.system_config_o_auth_dto import SystemConfigOAuthDto - -class TestSystemConfigOAuthDto(unittest.TestCase): - """SystemConfigOAuthDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigOAuthDto: - """Test SystemConfigOAuthDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigOAuthDto` - """ - model = SystemConfigOAuthDto() - if include_optional: - return SystemConfigOAuthDto( - allow_insecure_requests = True, - auto_launch = True, - auto_register = True, - button_text = '', - client_id = '', - client_secret = '', - default_storage_quota = 0, - enabled = True, - end_session_endpoint = '', - issuer_url = '', - mobile_override_enabled = True, - mobile_redirect_uri = '', - profile_signing_algorithm = '', - prompt = '', - role_claim = '', - scope = '', - signing_algorithm = '', - storage_label_claim = '', - storage_quota_claim = '', - timeout = 1, - token_endpoint_auth_method = 'client_secret_post' - ) - else: - return SystemConfigOAuthDto( - allow_insecure_requests = True, - auto_launch = True, - auto_register = True, - button_text = '', - client_id = '', - client_secret = '', - default_storage_quota = 0, - enabled = True, - end_session_endpoint = '', - issuer_url = '', - mobile_override_enabled = True, - mobile_redirect_uri = '', - profile_signing_algorithm = '', - prompt = '', - role_claim = '', - scope = '', - signing_algorithm = '', - storage_label_claim = '', - storage_quota_claim = '', - timeout = 1, - token_endpoint_auth_method = 'client_secret_post', - ) - """ - - def testSystemConfigOAuthDto(self): - """Test SystemConfigOAuthDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_password_login_dto.py b/generated/immich/openapi_client/test/test_system_config_password_login_dto.py deleted file mode 100644 index ca038ea..0000000 --- a/generated/immich/openapi_client/test/test_system_config_password_login_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.system_config_password_login_dto import SystemConfigPasswordLoginDto - -class TestSystemConfigPasswordLoginDto(unittest.TestCase): - """SystemConfigPasswordLoginDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigPasswordLoginDto: - """Test SystemConfigPasswordLoginDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigPasswordLoginDto` - """ - model = SystemConfigPasswordLoginDto() - if include_optional: - return SystemConfigPasswordLoginDto( - enabled = True - ) - else: - return SystemConfigPasswordLoginDto( - enabled = True, - ) - """ - - def testSystemConfigPasswordLoginDto(self): - """Test SystemConfigPasswordLoginDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_reverse_geocoding_dto.py b/generated/immich/openapi_client/test/test_system_config_reverse_geocoding_dto.py deleted file mode 100644 index 19d38e6..0000000 --- a/generated/immich/openapi_client/test/test_system_config_reverse_geocoding_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.system_config_reverse_geocoding_dto import SystemConfigReverseGeocodingDto - -class TestSystemConfigReverseGeocodingDto(unittest.TestCase): - """SystemConfigReverseGeocodingDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigReverseGeocodingDto: - """Test SystemConfigReverseGeocodingDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigReverseGeocodingDto` - """ - model = SystemConfigReverseGeocodingDto() - if include_optional: - return SystemConfigReverseGeocodingDto( - enabled = True - ) - else: - return SystemConfigReverseGeocodingDto( - enabled = True, - ) - """ - - def testSystemConfigReverseGeocodingDto(self): - """Test SystemConfigReverseGeocodingDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_server_dto.py b/generated/immich/openapi_client/test/test_system_config_server_dto.py deleted file mode 100644 index 2874ec6..0000000 --- a/generated/immich/openapi_client/test/test_system_config_server_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.system_config_server_dto import SystemConfigServerDto - -class TestSystemConfigServerDto(unittest.TestCase): - """SystemConfigServerDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigServerDto: - """Test SystemConfigServerDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigServerDto` - """ - model = SystemConfigServerDto() - if include_optional: - return SystemConfigServerDto( - external_domain = '', - login_page_message = '', - public_users = True - ) - else: - return SystemConfigServerDto( - external_domain = '', - login_page_message = '', - public_users = True, - ) - """ - - def testSystemConfigServerDto(self): - """Test SystemConfigServerDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_smtp_dto.py b/generated/immich/openapi_client/test/test_system_config_smtp_dto.py deleted file mode 100644 index afcc008..0000000 --- a/generated/immich/openapi_client/test/test_system_config_smtp_dto.py +++ /dev/null @@ -1,70 +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 unittest - -from generated.immich.openapi_client.models.system_config_smtp_dto import SystemConfigSmtpDto - -class TestSystemConfigSmtpDto(unittest.TestCase): - """SystemConfigSmtpDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigSmtpDto: - """Test SystemConfigSmtpDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigSmtpDto` - """ - model = SystemConfigSmtpDto() - if include_optional: - return SystemConfigSmtpDto( - enabled = True, - var_from = '', - reply_to = '', - transport = generated.immich.openapi_client.models.system_config_smtp_transport_dto.SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', ) - ) - else: - return SystemConfigSmtpDto( - enabled = True, - var_from = '', - reply_to = '', - transport = generated.immich.openapi_client.models.system_config_smtp_transport_dto.SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', ), - ) - """ - - def testSystemConfigSmtpDto(self): - """Test SystemConfigSmtpDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_smtp_transport_dto.py b/generated/immich/openapi_client/test/test_system_config_smtp_transport_dto.py deleted file mode 100644 index 213021f..0000000 --- a/generated/immich/openapi_client/test/test_system_config_smtp_transport_dto.py +++ /dev/null @@ -1,62 +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 unittest - -from generated.immich.openapi_client.models.system_config_smtp_transport_dto import SystemConfigSmtpTransportDto - -class TestSystemConfigSmtpTransportDto(unittest.TestCase): - """SystemConfigSmtpTransportDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigSmtpTransportDto: - """Test SystemConfigSmtpTransportDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigSmtpTransportDto` - """ - model = SystemConfigSmtpTransportDto() - if include_optional: - return SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '' - ) - else: - return SystemConfigSmtpTransportDto( - host = '', - ignore_cert = True, - password = '', - port = 0, - secure = True, - username = '', - ) - """ - - def testSystemConfigSmtpTransportDto(self): - """Test SystemConfigSmtpTransportDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_storage_template_dto.py b/generated/immich/openapi_client/test/test_system_config_storage_template_dto.py deleted file mode 100644 index 47b9f32..0000000 --- a/generated/immich/openapi_client/test/test_system_config_storage_template_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.system_config_storage_template_dto import SystemConfigStorageTemplateDto - -class TestSystemConfigStorageTemplateDto(unittest.TestCase): - """SystemConfigStorageTemplateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigStorageTemplateDto: - """Test SystemConfigStorageTemplateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigStorageTemplateDto` - """ - model = SystemConfigStorageTemplateDto() - if include_optional: - return SystemConfigStorageTemplateDto( - enabled = True, - hash_verification_enabled = True, - template = '' - ) - else: - return SystemConfigStorageTemplateDto( - enabled = True, - hash_verification_enabled = True, - template = '', - ) - """ - - def testSystemConfigStorageTemplateDto(self): - """Test SystemConfigStorageTemplateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_template_emails_dto.py b/generated/immich/openapi_client/test/test_system_config_template_emails_dto.py deleted file mode 100644 index 3d6e725..0000000 --- a/generated/immich/openapi_client/test/test_system_config_template_emails_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.system_config_template_emails_dto import SystemConfigTemplateEmailsDto - -class TestSystemConfigTemplateEmailsDto(unittest.TestCase): - """SystemConfigTemplateEmailsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigTemplateEmailsDto: - """Test SystemConfigTemplateEmailsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigTemplateEmailsDto` - """ - model = SystemConfigTemplateEmailsDto() - if include_optional: - return SystemConfigTemplateEmailsDto( - album_invite_template = '', - album_update_template = '', - welcome_template = '' - ) - else: - return SystemConfigTemplateEmailsDto( - album_invite_template = '', - album_update_template = '', - welcome_template = '', - ) - """ - - def testSystemConfigTemplateEmailsDto(self): - """Test SystemConfigTemplateEmailsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_template_storage_option_dto.py b/generated/immich/openapi_client/test/test_system_config_template_storage_option_dto.py deleted file mode 100644 index 4738395..0000000 --- a/generated/immich/openapi_client/test/test_system_config_template_storage_option_dto.py +++ /dev/null @@ -1,98 +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 unittest - -from generated.immich.openapi_client.models.system_config_template_storage_option_dto import SystemConfigTemplateStorageOptionDto - -class TestSystemConfigTemplateStorageOptionDto(unittest.TestCase): - """SystemConfigTemplateStorageOptionDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigTemplateStorageOptionDto: - """Test SystemConfigTemplateStorageOptionDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigTemplateStorageOptionDto` - """ - model = SystemConfigTemplateStorageOptionDto() - if include_optional: - return SystemConfigTemplateStorageOptionDto( - day_options = [ - '' - ], - hour_options = [ - '' - ], - minute_options = [ - '' - ], - month_options = [ - '' - ], - preset_options = [ - '' - ], - second_options = [ - '' - ], - week_options = [ - '' - ], - year_options = [ - '' - ] - ) - else: - return SystemConfigTemplateStorageOptionDto( - day_options = [ - '' - ], - hour_options = [ - '' - ], - minute_options = [ - '' - ], - month_options = [ - '' - ], - preset_options = [ - '' - ], - second_options = [ - '' - ], - week_options = [ - '' - ], - year_options = [ - '' - ], - ) - """ - - def testSystemConfigTemplateStorageOptionDto(self): - """Test SystemConfigTemplateStorageOptionDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_templates_dto.py b/generated/immich/openapi_client/test/test_system_config_templates_dto.py deleted file mode 100644 index fec2976..0000000 --- a/generated/immich/openapi_client/test/test_system_config_templates_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.system_config_templates_dto import SystemConfigTemplatesDto - -class TestSystemConfigTemplatesDto(unittest.TestCase): - """SystemConfigTemplatesDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigTemplatesDto: - """Test SystemConfigTemplatesDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigTemplatesDto` - """ - model = SystemConfigTemplatesDto() - if include_optional: - return SystemConfigTemplatesDto( - email = generated.immich.openapi_client.models.system_config_template_emails_dto.SystemConfigTemplateEmailsDto( - album_invite_template = '', - album_update_template = '', - welcome_template = '', ) - ) - else: - return SystemConfigTemplatesDto( - email = generated.immich.openapi_client.models.system_config_template_emails_dto.SystemConfigTemplateEmailsDto( - album_invite_template = '', - album_update_template = '', - welcome_template = '', ), - ) - """ - - def testSystemConfigTemplatesDto(self): - """Test SystemConfigTemplatesDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_theme_dto.py b/generated/immich/openapi_client/test/test_system_config_theme_dto.py deleted file mode 100644 index 14df39a..0000000 --- a/generated/immich/openapi_client/test/test_system_config_theme_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.system_config_theme_dto import SystemConfigThemeDto - -class TestSystemConfigThemeDto(unittest.TestCase): - """SystemConfigThemeDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigThemeDto: - """Test SystemConfigThemeDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigThemeDto` - """ - model = SystemConfigThemeDto() - if include_optional: - return SystemConfigThemeDto( - custom_css = '' - ) - else: - return SystemConfigThemeDto( - custom_css = '', - ) - """ - - def testSystemConfigThemeDto(self): - """Test SystemConfigThemeDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_trash_dto.py b/generated/immich/openapi_client/test/test_system_config_trash_dto.py deleted file mode 100644 index dc1f09d..0000000 --- a/generated/immich/openapi_client/test/test_system_config_trash_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.system_config_trash_dto import SystemConfigTrashDto - -class TestSystemConfigTrashDto(unittest.TestCase): - """SystemConfigTrashDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigTrashDto: - """Test SystemConfigTrashDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigTrashDto` - """ - model = SystemConfigTrashDto() - if include_optional: - return SystemConfigTrashDto( - days = 0, - enabled = True - ) - else: - return SystemConfigTrashDto( - days = 0, - enabled = True, - ) - """ - - def testSystemConfigTrashDto(self): - """Test SystemConfigTrashDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_config_user_dto.py b/generated/immich/openapi_client/test/test_system_config_user_dto.py deleted file mode 100644 index 056bb3a..0000000 --- a/generated/immich/openapi_client/test/test_system_config_user_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.system_config_user_dto import SystemConfigUserDto - -class TestSystemConfigUserDto(unittest.TestCase): - """SystemConfigUserDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> SystemConfigUserDto: - """Test SystemConfigUserDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `SystemConfigUserDto` - """ - model = SystemConfigUserDto() - if include_optional: - return SystemConfigUserDto( - delete_delay = 1 - ) - else: - return SystemConfigUserDto( - delete_delay = 1, - ) - """ - - def testSystemConfigUserDto(self): - """Test SystemConfigUserDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_system_metadata_api.py b/generated/immich/openapi_client/test/test_system_metadata_api.py deleted file mode 100644 index b253af3..0000000 --- a/generated/immich/openapi_client/test/test_system_metadata_api.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.api.system_metadata_api import SystemMetadataApi - - -class TestSystemMetadataApi(unittest.TestCase): - """SystemMetadataApi unit test stubs""" - - def setUp(self) -> None: - self.api = SystemMetadataApi() - - def tearDown(self) -> None: - pass - - def test_get_admin_onboarding(self) -> None: - """Test case for get_admin_onboarding - - Retrieve admin onboarding - """ - pass - - def test_get_reverse_geocoding_state(self) -> None: - """Test case for get_reverse_geocoding_state - - Retrieve reverse geocoding state - """ - pass - - def test_get_version_check_state(self) -> None: - """Test case for get_version_check_state - - Retrieve version check state - """ - pass - - def test_update_admin_onboarding(self) -> None: - """Test case for update_admin_onboarding - - Update admin onboarding - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tag_bulk_assets_dto.py b/generated/immich/openapi_client/test/test_tag_bulk_assets_dto.py deleted file mode 100644 index fcff65d..0000000 --- a/generated/immich/openapi_client/test/test_tag_bulk_assets_dto.py +++ /dev/null @@ -1,62 +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 unittest - -from generated.immich.openapi_client.models.tag_bulk_assets_dto import TagBulkAssetsDto - -class TestTagBulkAssetsDto(unittest.TestCase): - """TagBulkAssetsDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagBulkAssetsDto: - """Test TagBulkAssetsDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagBulkAssetsDto` - """ - model = TagBulkAssetsDto() - if include_optional: - return TagBulkAssetsDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - tag_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ] - ) - else: - return TagBulkAssetsDto( - asset_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - tag_ids = [ - '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ], - ) - """ - - def testTagBulkAssetsDto(self): - """Test TagBulkAssetsDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tag_bulk_assets_response_dto.py b/generated/immich/openapi_client/test/test_tag_bulk_assets_response_dto.py deleted file mode 100644 index 6ed85aa..0000000 --- a/generated/immich/openapi_client/test/test_tag_bulk_assets_response_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.tag_bulk_assets_response_dto import TagBulkAssetsResponseDto - -class TestTagBulkAssetsResponseDto(unittest.TestCase): - """TagBulkAssetsResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagBulkAssetsResponseDto: - """Test TagBulkAssetsResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagBulkAssetsResponseDto` - """ - model = TagBulkAssetsResponseDto() - if include_optional: - return TagBulkAssetsResponseDto( - count = -9007199254740991 - ) - else: - return TagBulkAssetsResponseDto( - count = -9007199254740991, - ) - """ - - def testTagBulkAssetsResponseDto(self): - """Test TagBulkAssetsResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tag_create_dto.py b/generated/immich/openapi_client/test/test_tag_create_dto.py deleted file mode 100644 index d51cdbf..0000000 --- a/generated/immich/openapi_client/test/test_tag_create_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.tag_create_dto import TagCreateDto - -class TestTagCreateDto(unittest.TestCase): - """TagCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagCreateDto: - """Test TagCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagCreateDto` - """ - model = TagCreateDto() - if include_optional: - return TagCreateDto( - color = '#ECB02084', - name = '', - parent_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC' - ) - else: - return TagCreateDto( - name = '', - ) - """ - - def testTagCreateDto(self): - """Test TagCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tag_response_dto.py b/generated/immich/openapi_client/test/test_tag_response_dto.py deleted file mode 100644 index 5720edb..0000000 --- a/generated/immich/openapi_client/test/test_tag_response_dto.py +++ /dev/null @@ -1,62 +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 unittest - -from generated.immich.openapi_client.models.tag_response_dto import TagResponseDto - -class TestTagResponseDto(unittest.TestCase): - """TagResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagResponseDto: - """Test TagResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagResponseDto` - """ - model = TagResponseDto() - if include_optional: - return TagResponseDto( - color = '', - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - parent_id = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '' - ) - else: - return TagResponseDto( - created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - value = '', - ) - """ - - def testTagResponseDto(self): - """Test TagResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tag_update_dto.py b/generated/immich/openapi_client/test/test_tag_update_dto.py deleted file mode 100644 index f9d1327..0000000 --- a/generated/immich/openapi_client/test/test_tag_update_dto.py +++ /dev/null @@ -1,51 +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 unittest - -from generated.immich.openapi_client.models.tag_update_dto import TagUpdateDto - -class TestTagUpdateDto(unittest.TestCase): - """TagUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagUpdateDto: - """Test TagUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagUpdateDto` - """ - model = TagUpdateDto() - if include_optional: - return TagUpdateDto( - color = '#ECB02084' - ) - else: - return TagUpdateDto( - ) - """ - - def testTagUpdateDto(self): - """Test TagUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tag_upsert_dto.py b/generated/immich/openapi_client/test/test_tag_upsert_dto.py deleted file mode 100644 index 72cf926..0000000 --- a/generated/immich/openapi_client/test/test_tag_upsert_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.tag_upsert_dto import TagUpsertDto - -class TestTagUpsertDto(unittest.TestCase): - """TagUpsertDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagUpsertDto: - """Test TagUpsertDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagUpsertDto` - """ - model = TagUpsertDto() - if include_optional: - return TagUpsertDto( - tags = [ - '' - ] - ) - else: - return TagUpsertDto( - tags = [ - '' - ], - ) - """ - - def testTagUpsertDto(self): - """Test TagUpsertDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tags_api.py b/generated/immich/openapi_client/test/test_tags_api.py deleted file mode 100644 index f065d2d..0000000 --- a/generated/immich/openapi_client/test/test_tags_api.py +++ /dev/null @@ -1,94 +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 unittest - -from generated.immich.openapi_client.api.tags_api import TagsApi - - -class TestTagsApi(unittest.TestCase): - """TagsApi unit test stubs""" - - def setUp(self) -> None: - self.api = TagsApi() - - def tearDown(self) -> None: - pass - - def test_bulk_tag_assets(self) -> None: - """Test case for bulk_tag_assets - - Tag assets - """ - pass - - def test_create_tag(self) -> None: - """Test case for create_tag - - Create a tag - """ - pass - - def test_delete_tag(self) -> None: - """Test case for delete_tag - - Delete a tag - """ - pass - - def test_get_all_tags(self) -> None: - """Test case for get_all_tags - - Retrieve tags - """ - pass - - def test_get_tag_by_id(self) -> None: - """Test case for get_tag_by_id - - Retrieve a tag - """ - pass - - def test_tag_assets(self) -> None: - """Test case for tag_assets - - Tag assets - """ - pass - - def test_untag_assets(self) -> None: - """Test case for untag_assets - - Untag assets - """ - pass - - def test_update_tag(self) -> None: - """Test case for update_tag - - Update a tag - """ - pass - - def test_upsert_tags(self) -> None: - """Test case for upsert_tags - - Upsert tags - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tags_response.py b/generated/immich/openapi_client/test/test_tags_response.py deleted file mode 100644 index f2bb01d..0000000 --- a/generated/immich/openapi_client/test/test_tags_response.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.tags_response import TagsResponse - -class TestTagsResponse(unittest.TestCase): - """TagsResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagsResponse: - """Test TagsResponse - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagsResponse` - """ - model = TagsResponse() - if include_optional: - return TagsResponse( - enabled = True, - sidebar_web = True - ) - else: - return TagsResponse( - enabled = True, - sidebar_web = True, - ) - """ - - def testTagsResponse(self): - """Test TagsResponse""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tags_update.py b/generated/immich/openapi_client/test/test_tags_update.py deleted file mode 100644 index a822a3d..0000000 --- a/generated/immich/openapi_client/test/test_tags_update.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.tags_update import TagsUpdate - -class TestTagsUpdate(unittest.TestCase): - """TagsUpdate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TagsUpdate: - """Test TagsUpdate - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TagsUpdate` - """ - model = TagsUpdate() - if include_optional: - return TagsUpdate( - enabled = True, - sidebar_web = True - ) - else: - return TagsUpdate( - ) - """ - - def testTagsUpdate(self): - """Test TagsUpdate""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_template_dto.py b/generated/immich/openapi_client/test/test_template_dto.py deleted file mode 100644 index 85ce585..0000000 --- a/generated/immich/openapi_client/test/test_template_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.template_dto import TemplateDto - -class TestTemplateDto(unittest.TestCase): - """TemplateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TemplateDto: - """Test TemplateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TemplateDto` - """ - model = TemplateDto() - if include_optional: - return TemplateDto( - template = '' - ) - else: - return TemplateDto( - template = '', - ) - """ - - def testTemplateDto(self): - """Test TemplateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_template_response_dto.py b/generated/immich/openapi_client/test/test_template_response_dto.py deleted file mode 100644 index e164192..0000000 --- a/generated/immich/openapi_client/test/test_template_response_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.template_response_dto import TemplateResponseDto - -class TestTemplateResponseDto(unittest.TestCase): - """TemplateResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TemplateResponseDto: - """Test TemplateResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TemplateResponseDto` - """ - model = TemplateResponseDto() - if include_optional: - return TemplateResponseDto( - html = '', - name = '' - ) - else: - return TemplateResponseDto( - html = '', - name = '', - ) - """ - - def testTemplateResponseDto(self): - """Test TemplateResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_test_email_response_dto.py b/generated/immich/openapi_client/test/test_test_email_response_dto.py deleted file mode 100644 index 2d26dea..0000000 --- a/generated/immich/openapi_client/test/test_test_email_response_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.test_email_response_dto import TestEmailResponseDto - -class TestTestEmailResponseDto(unittest.TestCase): - """TestEmailResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TestEmailResponseDto: - """Test TestEmailResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TestEmailResponseDto` - """ - model = TestEmailResponseDto() - if include_optional: - return TestEmailResponseDto( - message_id = '' - ) - else: - return TestEmailResponseDto( - message_id = '', - ) - """ - - def testTestEmailResponseDto(self): - """Test TestEmailResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_timeline_api.py b/generated/immich/openapi_client/test/test_timeline_api.py deleted file mode 100644 index dd5abe8..0000000 --- a/generated/immich/openapi_client/test/test_timeline_api.py +++ /dev/null @@ -1,45 +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 unittest - -from generated.immich.openapi_client.api.timeline_api import TimelineApi - - -class TestTimelineApi(unittest.TestCase): - """TimelineApi unit test stubs""" - - def setUp(self) -> None: - self.api = TimelineApi() - - def tearDown(self) -> None: - pass - - def test_get_time_bucket(self) -> None: - """Test case for get_time_bucket - - Get time bucket - """ - pass - - def test_get_time_buckets(self) -> None: - """Test case for get_time_buckets - - Get time buckets - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_tone_mapping.py b/generated/immich/openapi_client/test/test_tone_mapping.py deleted file mode 100644 index d491604..0000000 --- a/generated/immich/openapi_client/test/test_tone_mapping.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.tone_mapping import ToneMapping - -class TestToneMapping(unittest.TestCase): - """ToneMapping unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testToneMapping(self): - """Test ToneMapping""" - # inst = ToneMapping() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_transcode_hw_accel.py b/generated/immich/openapi_client/test/test_transcode_hw_accel.py deleted file mode 100644 index 73fb8ff..0000000 --- a/generated/immich/openapi_client/test/test_transcode_hw_accel.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.transcode_hw_accel import TranscodeHWAccel - -class TestTranscodeHWAccel(unittest.TestCase): - """TranscodeHWAccel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTranscodeHWAccel(self): - """Test TranscodeHWAccel""" - # inst = TranscodeHWAccel() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_transcode_policy.py b/generated/immich/openapi_client/test/test_transcode_policy.py deleted file mode 100644 index 1eadbe9..0000000 --- a/generated/immich/openapi_client/test/test_transcode_policy.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.transcode_policy import TranscodePolicy - -class TestTranscodePolicy(unittest.TestCase): - """TranscodePolicy unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTranscodePolicy(self): - """Test TranscodePolicy""" - # inst = TranscodePolicy() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_trash_api.py b/generated/immich/openapi_client/test/test_trash_api.py deleted file mode 100644 index 5a97e27..0000000 --- a/generated/immich/openapi_client/test/test_trash_api.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.api.trash_api import TrashApi - - -class TestTrashApi(unittest.TestCase): - """TrashApi unit test stubs""" - - def setUp(self) -> None: - self.api = TrashApi() - - def tearDown(self) -> None: - pass - - def test_empty_trash(self) -> None: - """Test case for empty_trash - - Empty trash - """ - pass - - def test_restore_assets(self) -> None: - """Test case for restore_assets - - Restore assets - """ - pass - - def test_restore_trash(self) -> None: - """Test case for restore_trash - - Restore trash - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_trash_response_dto.py b/generated/immich/openapi_client/test/test_trash_response_dto.py deleted file mode 100644 index 2903c2d..0000000 --- a/generated/immich/openapi_client/test/test_trash_response_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.trash_response_dto import TrashResponseDto - -class TestTrashResponseDto(unittest.TestCase): - """TrashResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> TrashResponseDto: - """Test TrashResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `TrashResponseDto` - """ - model = TrashResponseDto() - if include_optional: - return TrashResponseDto( - count = -9007199254740991 - ) - else: - return TrashResponseDto( - count = -9007199254740991, - ) - """ - - def testTrashResponseDto(self): - """Test TrashResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_update_album_dto.py b/generated/immich/openapi_client/test/test_update_album_dto.py deleted file mode 100644 index 3d45caa..0000000 --- a/generated/immich/openapi_client/test/test_update_album_dto.py +++ /dev/null @@ -1,55 +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 unittest - -from generated.immich.openapi_client.models.update_album_dto import UpdateAlbumDto - -class TestUpdateAlbumDto(unittest.TestCase): - """UpdateAlbumDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UpdateAlbumDto: - """Test UpdateAlbumDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UpdateAlbumDto` - """ - model = UpdateAlbumDto() - if include_optional: - return UpdateAlbumDto( - album_name = '', - album_thumbnail_asset_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - description = '', - is_activity_enabled = True, - order = 'asc' - ) - else: - return UpdateAlbumDto( - ) - """ - - def testUpdateAlbumDto(self): - """Test UpdateAlbumDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_update_album_user_dto.py b/generated/immich/openapi_client/test/test_update_album_user_dto.py deleted file mode 100644 index 1955f4b..0000000 --- a/generated/immich/openapi_client/test/test_update_album_user_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.update_album_user_dto import UpdateAlbumUserDto - -class TestUpdateAlbumUserDto(unittest.TestCase): - """UpdateAlbumUserDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UpdateAlbumUserDto: - """Test UpdateAlbumUserDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UpdateAlbumUserDto` - """ - model = UpdateAlbumUserDto() - if include_optional: - return UpdateAlbumUserDto( - role = 'editor' - ) - else: - return UpdateAlbumUserDto( - role = 'editor', - ) - """ - - def testUpdateAlbumUserDto(self): - """Test UpdateAlbumUserDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_update_asset_dto.py b/generated/immich/openapi_client/test/test_update_asset_dto.py deleted file mode 100644 index 8f6130f..0000000 --- a/generated/immich/openapi_client/test/test_update_asset_dto.py +++ /dev/null @@ -1,58 +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 unittest - -from generated.immich.openapi_client.models.update_asset_dto import UpdateAssetDto - -class TestUpdateAssetDto(unittest.TestCase): - """UpdateAssetDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UpdateAssetDto: - """Test UpdateAssetDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UpdateAssetDto` - """ - model = UpdateAssetDto() - if include_optional: - return UpdateAssetDto( - date_time_original = '', - description = '', - is_favorite = True, - latitude = -90, - live_photo_video_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - longitude = -180, - rating = -1, - visibility = 'archive' - ) - else: - return UpdateAssetDto( - ) - """ - - def testUpdateAssetDto(self): - """Test UpdateAssetDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_update_library_dto.py b/generated/immich/openapi_client/test/test_update_library_dto.py deleted file mode 100644 index a4ee51d..0000000 --- a/generated/immich/openapi_client/test/test_update_library_dto.py +++ /dev/null @@ -1,57 +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 unittest - -from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto - -class TestUpdateLibraryDto(unittest.TestCase): - """UpdateLibraryDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UpdateLibraryDto: - """Test UpdateLibraryDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UpdateLibraryDto` - """ - model = UpdateLibraryDto() - if include_optional: - return UpdateLibraryDto( - exclusion_patterns = [ - '' - ], - import_paths = [ - '' - ], - name = '0' - ) - else: - return UpdateLibraryDto( - ) - """ - - def testUpdateLibraryDto(self): - """Test UpdateLibraryDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_usage_by_user_dto.py b/generated/immich/openapi_client/test/test_usage_by_user_dto.py deleted file mode 100644 index f195445..0000000 --- a/generated/immich/openapi_client/test/test_usage_by_user_dto.py +++ /dev/null @@ -1,66 +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 unittest - -from generated.immich.openapi_client.models.usage_by_user_dto import UsageByUserDto - -class TestUsageByUserDto(unittest.TestCase): - """UsageByUserDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UsageByUserDto: - """Test UsageByUserDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UsageByUserDto` - """ - model = UsageByUserDto() - if include_optional: - return UsageByUserDto( - photos = -9007199254740991, - quota_size_in_bytes = -9007199254740991, - usage = -9007199254740991, - usage_photos = -9007199254740991, - usage_videos = -9007199254740991, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - user_name = '', - videos = -9007199254740991 - ) - else: - return UsageByUserDto( - photos = -9007199254740991, - quota_size_in_bytes = -9007199254740991, - usage = -9007199254740991, - usage_photos = -9007199254740991, - usage_videos = -9007199254740991, - user_id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - user_name = '', - videos = -9007199254740991, - ) - """ - - def testUsageByUserDto(self): - """Test UsageByUserDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_admin_create_dto.py b/generated/immich/openapi_client/test/test_user_admin_create_dto.py deleted file mode 100644 index a242123..0000000 --- a/generated/immich/openapi_client/test/test_user_admin_create_dto.py +++ /dev/null @@ -1,63 +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 unittest - -from generated.immich.openapi_client.models.user_admin_create_dto import UserAdminCreateDto - -class TestUserAdminCreateDto(unittest.TestCase): - """UserAdminCreateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserAdminCreateDto: - """Test UserAdminCreateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserAdminCreateDto` - """ - model = UserAdminCreateDto() - if include_optional: - return UserAdminCreateDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - is_admin = True, - name = '', - notify = True, - password = '', - pin_code = '123456', - quota_size_in_bytes = 0, - should_change_password = True, - storage_label = '' - ) - else: - return UserAdminCreateDto( - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - name = '', - password = '', - ) - """ - - def testUserAdminCreateDto(self): - """Test UserAdminCreateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_admin_delete_dto.py b/generated/immich/openapi_client/test/test_user_admin_delete_dto.py deleted file mode 100644 index 5629420..0000000 --- a/generated/immich/openapi_client/test/test_user_admin_delete_dto.py +++ /dev/null @@ -1,51 +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 unittest - -from generated.immich.openapi_client.models.user_admin_delete_dto import UserAdminDeleteDto - -class TestUserAdminDeleteDto(unittest.TestCase): - """UserAdminDeleteDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserAdminDeleteDto: - """Test UserAdminDeleteDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserAdminDeleteDto` - """ - model = UserAdminDeleteDto() - if include_optional: - return UserAdminDeleteDto( - force = True - ) - else: - return UserAdminDeleteDto( - ) - """ - - def testUserAdminDeleteDto(self): - """Test UserAdminDeleteDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_admin_response_dto.py b/generated/immich/openapi_client/test/test_user_admin_response_dto.py deleted file mode 100644 index c174694..0000000 --- a/generated/immich/openapi_client/test/test_user_admin_response_dto.py +++ /dev/null @@ -1,90 +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 unittest - -from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto - -class TestUserAdminResponseDto(unittest.TestCase): - """UserAdminResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserAdminResponseDto: - """Test UserAdminResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserAdminResponseDto` - """ - model = UserAdminResponseDto() - if include_optional: - return UserAdminResponseDto( - avatar_color = 'primary', - created_at = '2024-01-01T00:00Z', - deleted_at = '2024-01-01T00:00Z', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_admin = True, - license = generated.immich.openapi_client.models.user_license.UserLicense( - activated_at = '2024-01-01T00:00Z', - activation_key = '', - license_key = 'IMCL-Cu2L-C4aW-wWL9-Y864-DZta-GRyy-GFZK-kkp4', ), - name = '', - oauth_id = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', - quota_size_in_bytes = 0, - quota_usage_in_bytes = 0, - should_change_password = True, - status = 'active', - storage_label = '', - updated_at = '2024-01-01T00:00Z' - ) - else: - return UserAdminResponseDto( - avatar_color = 'primary', - created_at = '2024-01-01T00:00Z', - deleted_at = '2024-01-01T00:00Z', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - is_admin = True, - license = generated.immich.openapi_client.models.user_license.UserLicense( - activated_at = '2024-01-01T00:00Z', - activation_key = '', - license_key = 'IMCL-Cu2L-C4aW-wWL9-Y864-DZta-GRyy-GFZK-kkp4', ), - name = '', - oauth_id = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', - quota_size_in_bytes = 0, - quota_usage_in_bytes = 0, - should_change_password = True, - status = 'active', - storage_label = '', - updated_at = '2024-01-01T00:00Z', - ) - """ - - def testUserAdminResponseDto(self): - """Test UserAdminResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_admin_update_dto.py b/generated/immich/openapi_client/test/test_user_admin_update_dto.py deleted file mode 100644 index 75db4d5..0000000 --- a/generated/immich/openapi_client/test/test_user_admin_update_dto.py +++ /dev/null @@ -1,59 +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 unittest - -from generated.immich.openapi_client.models.user_admin_update_dto import UserAdminUpdateDto - -class TestUserAdminUpdateDto(unittest.TestCase): - """UserAdminUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserAdminUpdateDto: - """Test UserAdminUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserAdminUpdateDto` - """ - model = UserAdminUpdateDto() - if include_optional: - return UserAdminUpdateDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - is_admin = True, - name = '', - password = '', - pin_code = '123456', - quota_size_in_bytes = 0, - should_change_password = True, - storage_label = '' - ) - else: - return UserAdminUpdateDto( - ) - """ - - def testUserAdminUpdateDto(self): - """Test UserAdminUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_avatar_color.py b/generated/immich/openapi_client/test/test_user_avatar_color.py deleted file mode 100644 index 1e2b131..0000000 --- a/generated/immich/openapi_client/test/test_user_avatar_color.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.user_avatar_color import UserAvatarColor - -class TestUserAvatarColor(unittest.TestCase): - """UserAvatarColor unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserAvatarColor(self): - """Test UserAvatarColor""" - # inst = UserAvatarColor() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_license.py b/generated/immich/openapi_client/test/test_user_license.py deleted file mode 100644 index 195208e..0000000 --- a/generated/immich/openapi_client/test/test_user_license.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.user_license import UserLicense - -class TestUserLicense(unittest.TestCase): - """UserLicense unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserLicense: - """Test UserLicense - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserLicense` - """ - model = UserLicense() - if include_optional: - return UserLicense( - activated_at = '2024-01-01T00:00Z', - activation_key = '', - license_key = 'IMCL-Cu2L-C4aW-wWL9-Y864-DZta-GRyy-GFZK-kkp4' - ) - else: - return UserLicense( - activated_at = '2024-01-01T00:00Z', - activation_key = '', - license_key = 'IMCL-Cu2L-C4aW-wWL9-Y864-DZta-GRyy-GFZK-kkp4', - ) - """ - - def testUserLicense(self): - """Test UserLicense""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_preferences_response_dto.py b/generated/immich/openapi_client/test/test_user_preferences_response_dto.py deleted file mode 100644 index 823672c..0000000 --- a/generated/immich/openapi_client/test/test_user_preferences_response_dto.py +++ /dev/null @@ -1,118 +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 unittest - -from generated.immich.openapi_client.models.user_preferences_response_dto import UserPreferencesResponseDto - -class TestUserPreferencesResponseDto(unittest.TestCase): - """UserPreferencesResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserPreferencesResponseDto: - """Test UserPreferencesResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserPreferencesResponseDto` - """ - model = UserPreferencesResponseDto() - if include_optional: - return UserPreferencesResponseDto( - albums = generated.immich.openapi_client.models.albums_response.AlbumsResponse( - default_asset_order = 'asc', ), - cast = generated.immich.openapi_client.models.cast_response.CastResponse( - g_cast_enabled = True, ), - download = generated.immich.openapi_client.models.download_response.DownloadResponse( - archive_size = -9007199254740991, - include_embedded_videos = True, ), - email_notifications = generated.immich.openapi_client.models.email_notifications_response.EmailNotificationsResponse( - album_invite = True, - album_update = True, - enabled = True, ), - folders = generated.immich.openapi_client.models.folders_response.FoldersResponse( - enabled = True, - sidebar_web = True, ), - memories = generated.immich.openapi_client.models.memories_response.MemoriesResponse( - duration = -9007199254740991, - enabled = True, ), - people = generated.immich.openapi_client.models.people_response.PeopleResponse( - enabled = True, - minimum_faces = 1, - sidebar_web = True, ), - purchase = generated.immich.openapi_client.models.purchase_response.PurchaseResponse( - hide_buy_button_until = '', - show_support_badge = True, ), - ratings = generated.immich.openapi_client.models.ratings_response.RatingsResponse( - enabled = True, ), - recently_added = generated.immich.openapi_client.models.recently_added_response.RecentlyAddedResponse( - sidebar_web = True, ), - shared_links = generated.immich.openapi_client.models.shared_links_response.SharedLinksResponse( - enabled = True, - sidebar_web = True, ), - tags = generated.immich.openapi_client.models.tags_response.TagsResponse( - enabled = True, - sidebar_web = True, ) - ) - else: - return UserPreferencesResponseDto( - albums = generated.immich.openapi_client.models.albums_response.AlbumsResponse( - default_asset_order = 'asc', ), - cast = generated.immich.openapi_client.models.cast_response.CastResponse( - g_cast_enabled = True, ), - download = generated.immich.openapi_client.models.download_response.DownloadResponse( - archive_size = -9007199254740991, - include_embedded_videos = True, ), - email_notifications = generated.immich.openapi_client.models.email_notifications_response.EmailNotificationsResponse( - album_invite = True, - album_update = True, - enabled = True, ), - folders = generated.immich.openapi_client.models.folders_response.FoldersResponse( - enabled = True, - sidebar_web = True, ), - memories = generated.immich.openapi_client.models.memories_response.MemoriesResponse( - duration = -9007199254740991, - enabled = True, ), - people = generated.immich.openapi_client.models.people_response.PeopleResponse( - enabled = True, - minimum_faces = 1, - sidebar_web = True, ), - purchase = generated.immich.openapi_client.models.purchase_response.PurchaseResponse( - hide_buy_button_until = '', - show_support_badge = True, ), - ratings = generated.immich.openapi_client.models.ratings_response.RatingsResponse( - enabled = True, ), - recently_added = generated.immich.openapi_client.models.recently_added_response.RecentlyAddedResponse( - sidebar_web = True, ), - shared_links = generated.immich.openapi_client.models.shared_links_response.SharedLinksResponse( - enabled = True, - sidebar_web = True, ), - tags = generated.immich.openapi_client.models.tags_response.TagsResponse( - enabled = True, - sidebar_web = True, ), - ) - """ - - def testUserPreferencesResponseDto(self): - """Test UserPreferencesResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_preferences_update_dto.py b/generated/immich/openapi_client/test/test_user_preferences_update_dto.py deleted file mode 100644 index 7d6ccf1..0000000 --- a/generated/immich/openapi_client/test/test_user_preferences_update_dto.py +++ /dev/null @@ -1,86 +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 unittest - -from generated.immich.openapi_client.models.user_preferences_update_dto import UserPreferencesUpdateDto - -class TestUserPreferencesUpdateDto(unittest.TestCase): - """UserPreferencesUpdateDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserPreferencesUpdateDto: - """Test UserPreferencesUpdateDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserPreferencesUpdateDto` - """ - model = UserPreferencesUpdateDto() - if include_optional: - return UserPreferencesUpdateDto( - albums = generated.immich.openapi_client.models.albums_update.AlbumsUpdate( - default_asset_order = 'asc', ), - avatar = generated.immich.openapi_client.models.avatar_update.AvatarUpdate( - color = 'primary', ), - cast = generated.immich.openapi_client.models.cast_update.CastUpdate( - g_cast_enabled = True, ), - download = generated.immich.openapi_client.models.download_update.DownloadUpdate( - archive_size = 1, - include_embedded_videos = True, ), - email_notifications = generated.immich.openapi_client.models.email_notifications_update.EmailNotificationsUpdate( - album_invite = True, - album_update = True, - enabled = True, ), - folders = generated.immich.openapi_client.models.folders_update.FoldersUpdate( - enabled = True, - sidebar_web = True, ), - memories = generated.immich.openapi_client.models.memories_update.MemoriesUpdate( - duration = 1, - enabled = True, ), - people = generated.immich.openapi_client.models.people_update.PeopleUpdate( - enabled = True, - minimum_faces = 1, - sidebar_web = True, ), - purchase = generated.immich.openapi_client.models.purchase_update.PurchaseUpdate( - hide_buy_button_until = '', - show_support_badge = True, ), - ratings = generated.immich.openapi_client.models.ratings_update.RatingsUpdate( - enabled = True, ), - recently_added = generated.immich.openapi_client.models.recently_added_update.RecentlyAddedUpdate( - sidebar_web = True, ), - shared_links = generated.immich.openapi_client.models.shared_links_update.SharedLinksUpdate( - enabled = True, - sidebar_web = True, ), - tags = generated.immich.openapi_client.models.tags_update.TagsUpdate( - enabled = True, - sidebar_web = True, ) - ) - else: - return UserPreferencesUpdateDto( - ) - """ - - def testUserPreferencesUpdateDto(self): - """Test UserPreferencesUpdateDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_response_dto.py b/generated/immich/openapi_client/test/test_user_response_dto.py deleted file mode 100644 index 2c64d26..0000000 --- a/generated/immich/openapi_client/test/test_user_response_dto.py +++ /dev/null @@ -1,62 +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 unittest - -from generated.immich.openapi_client.models.user_response_dto import UserResponseDto - -class TestUserResponseDto(unittest.TestCase): - """UserResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserResponseDto: - """Test UserResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserResponseDto` - """ - model = UserResponseDto() - if include_optional: - return UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '' - ) - else: - return UserResponseDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - id = '62ECB020-8429-430c-a01F-FCCfeEe150AC', - name = '', - profile_changed_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - profile_image_path = '', - ) - """ - - def testUserResponseDto(self): - """Test UserResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_status.py b/generated/immich/openapi_client/test/test_user_status.py deleted file mode 100644 index 53d1664..0000000 --- a/generated/immich/openapi_client/test/test_user_status.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.user_status import UserStatus - -class TestUserStatus(unittest.TestCase): - """UserStatus unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserStatus(self): - """Test UserStatus""" - # inst = UserStatus() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_user_update_me_dto.py b/generated/immich/openapi_client/test/test_user_update_me_dto.py deleted file mode 100644 index bb46400..0000000 --- a/generated/immich/openapi_client/test/test_user_update_me_dto.py +++ /dev/null @@ -1,54 +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 unittest - -from generated.immich.openapi_client.models.user_update_me_dto import UserUpdateMeDto - -class TestUserUpdateMeDto(unittest.TestCase): - """UserUpdateMeDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UserUpdateMeDto: - """Test UserUpdateMeDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `UserUpdateMeDto` - """ - model = UserUpdateMeDto() - if include_optional: - return UserUpdateMeDto( - avatar_color = 'primary', - email = 'o@u.C.aZuufUOHOEhA8IcFQXnuaZcdyyvKX7HzKpul80FcVjSkp5IHYCm6w-v0dZfF.7.MRjsmInY9s-EmMH6kw8gsnXv2Z7jRPK542XGp8ZohE.q-ziKqEde8fXg9wdpfxa2-zRiT.EU4NCUavTrirUe4ba7JnjrgEdBCJE-ArE6U3CZ-Vnrj9RmauZ.J.mRsCjOv6MeuvKGSDRGKUIQ8yNXhf.VbZpGptfI46.5.z.6-kwy.icMEEkIauY.eNaDi5ackLH.3.z-zmvqRnM-dar09VaHCQz0Tl8.D.rml4PJXMbVMO8G0e5q9Z4WMWovY63Gk6ixTd5NxRU25mQYd6VBLRK.Q.6-FH2v5iUaMQ6iIJ-7auxDSR-lIIfhhw9bP3XhsKpT6YkX2ymMVYtu.F.DOyxaBZ75cAidDZ6lvrLQxekRdyiJFjhCbEZunVXTqV3VP-DPQpzY-cV.d.Y649MeAEDz67NG9dihNlL1YPO1GvRUDnbsR0-SswaNzc7s9ONPZw-HNPR.5.JnotMPK4Aqhv7VjToBNn1oLFWRpSx-dyd2clYhZAGiUmDTPP', - name = '', - password = '' - ) - else: - return UserUpdateMeDto( - ) - """ - - def testUserUpdateMeDto(self): - """Test UserUpdateMeDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_users_admin_api.py b/generated/immich/openapi_client/test/test_users_admin_api.py deleted file mode 100644 index 7ab8ce2..0000000 --- a/generated/immich/openapi_client/test/test_users_admin_api.py +++ /dev/null @@ -1,108 +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 unittest - -from generated.immich.openapi_client.api.users_admin_api import UsersAdminApi - - -class TestUsersAdminApi(unittest.TestCase): - """UsersAdminApi unit test stubs""" - - def setUp(self) -> None: - self.api = UsersAdminApi() - - def tearDown(self) -> None: - pass - - def test_create_user_admin(self) -> None: - """Test case for create_user_admin - - Create a user - """ - pass - - def test_delete_user_admin(self) -> None: - """Test case for delete_user_admin - - Delete a user - """ - pass - - def test_get_user_admin(self) -> None: - """Test case for get_user_admin - - Retrieve a user - """ - pass - - def test_get_user_calendar_heatmap_admin(self) -> None: - """Test case for get_user_calendar_heatmap_admin - - Retrieve calendar heatmap activity - """ - pass - - def test_get_user_preferences_admin(self) -> None: - """Test case for get_user_preferences_admin - - Retrieve user preferences - """ - pass - - def test_get_user_sessions_admin(self) -> None: - """Test case for get_user_sessions_admin - - Retrieve user sessions - """ - pass - - def test_get_user_statistics_admin(self) -> None: - """Test case for get_user_statistics_admin - - Retrieve user statistics - """ - pass - - def test_restore_user_admin(self) -> None: - """Test case for restore_user_admin - - Restore a deleted user - """ - pass - - def test_search_users_admin(self) -> None: - """Test case for search_users_admin - - Search users - """ - pass - - def test_update_user_admin(self) -> None: - """Test case for update_user_admin - - Update a user - """ - pass - - def test_update_user_preferences_admin(self) -> None: - """Test case for update_user_preferences_admin - - Update user preferences - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_users_api.py b/generated/immich/openapi_client/test/test_users_api.py deleted file mode 100644 index 4b962a7..0000000 --- a/generated/immich/openapi_client/test/test_users_api.py +++ /dev/null @@ -1,143 +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 unittest - -from generated.immich.openapi_client.api.users_api import UsersApi - - -class TestUsersApi(unittest.TestCase): - """UsersApi unit test stubs""" - - def setUp(self) -> None: - self.api = UsersApi() - - def tearDown(self) -> None: - pass - - def test_create_profile_image(self) -> None: - """Test case for create_profile_image - - Create user profile image - """ - pass - - def test_delete_profile_image(self) -> None: - """Test case for delete_profile_image - - Delete user profile image - """ - pass - - def test_delete_user_license(self) -> None: - """Test case for delete_user_license - - Delete user product key - """ - pass - - def test_delete_user_onboarding(self) -> None: - """Test case for delete_user_onboarding - - Delete user onboarding - """ - pass - - def test_get_my_calendar_heatmap(self) -> None: - """Test case for get_my_calendar_heatmap - - Retrieve calendar heatmap activity - """ - pass - - def test_get_my_preferences(self) -> None: - """Test case for get_my_preferences - - Get my preferences - """ - pass - - def test_get_my_user(self) -> None: - """Test case for get_my_user - - Get current user - """ - pass - - def test_get_profile_image(self) -> None: - """Test case for get_profile_image - - Retrieve user profile image - """ - pass - - def test_get_user(self) -> None: - """Test case for get_user - - Retrieve a user - """ - pass - - def test_get_user_license(self) -> None: - """Test case for get_user_license - - Retrieve user product key - """ - pass - - def test_get_user_onboarding(self) -> None: - """Test case for get_user_onboarding - - Retrieve user onboarding - """ - pass - - def test_search_users(self) -> None: - """Test case for search_users - - Get all users - """ - pass - - def test_set_user_license(self) -> None: - """Test case for set_user_license - - Set user product key - """ - pass - - def test_set_user_onboarding(self) -> None: - """Test case for set_user_onboarding - - Update user onboarding - """ - pass - - def test_update_my_preferences(self) -> None: - """Test case for update_my_preferences - - Update my preferences - """ - pass - - def test_update_my_user(self) -> None: - """Test case for update_my_user - - Update current user - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_validate_access_token_response_dto.py b/generated/immich/openapi_client/test/test_validate_access_token_response_dto.py deleted file mode 100644 index 3a12bcb..0000000 --- a/generated/immich/openapi_client/test/test_validate_access_token_response_dto.py +++ /dev/null @@ -1,52 +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 unittest - -from generated.immich.openapi_client.models.validate_access_token_response_dto import ValidateAccessTokenResponseDto - -class TestValidateAccessTokenResponseDto(unittest.TestCase): - """ValidateAccessTokenResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ValidateAccessTokenResponseDto: - """Test ValidateAccessTokenResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ValidateAccessTokenResponseDto` - """ - model = ValidateAccessTokenResponseDto() - if include_optional: - return ValidateAccessTokenResponseDto( - auth_status = True - ) - else: - return ValidateAccessTokenResponseDto( - auth_status = True, - ) - """ - - def testValidateAccessTokenResponseDto(self): - """Test ValidateAccessTokenResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_validate_library_dto.py b/generated/immich/openapi_client/test/test_validate_library_dto.py deleted file mode 100644 index 53f3f05..0000000 --- a/generated/immich/openapi_client/test/test_validate_library_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.validate_library_dto import ValidateLibraryDto - -class TestValidateLibraryDto(unittest.TestCase): - """ValidateLibraryDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ValidateLibraryDto: - """Test ValidateLibraryDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ValidateLibraryDto` - """ - model = ValidateLibraryDto() - if include_optional: - return ValidateLibraryDto( - exclusion_patterns = [ - '' - ], - import_paths = [ - '' - ] - ) - else: - return ValidateLibraryDto( - ) - """ - - def testValidateLibraryDto(self): - """Test ValidateLibraryDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_validate_library_import_path_response_dto.py b/generated/immich/openapi_client/test/test_validate_library_import_path_response_dto.py deleted file mode 100644 index 847e67b..0000000 --- a/generated/immich/openapi_client/test/test_validate_library_import_path_response_dto.py +++ /dev/null @@ -1,55 +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 unittest - -from generated.immich.openapi_client.models.validate_library_import_path_response_dto import ValidateLibraryImportPathResponseDto - -class TestValidateLibraryImportPathResponseDto(unittest.TestCase): - """ValidateLibraryImportPathResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ValidateLibraryImportPathResponseDto: - """Test ValidateLibraryImportPathResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ValidateLibraryImportPathResponseDto` - """ - model = ValidateLibraryImportPathResponseDto() - if include_optional: - return ValidateLibraryImportPathResponseDto( - import_path = '', - is_valid = True, - message = '' - ) - else: - return ValidateLibraryImportPathResponseDto( - import_path = '', - is_valid = True, - ) - """ - - def testValidateLibraryImportPathResponseDto(self): - """Test ValidateLibraryImportPathResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_validate_library_response_dto.py b/generated/immich/openapi_client/test/test_validate_library_response_dto.py deleted file mode 100644 index cc962f9..0000000 --- a/generated/immich/openapi_client/test/test_validate_library_response_dto.py +++ /dev/null @@ -1,56 +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 unittest - -from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto - -class TestValidateLibraryResponseDto(unittest.TestCase): - """ValidateLibraryResponseDto unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ValidateLibraryResponseDto: - """Test ValidateLibraryResponseDto - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ValidateLibraryResponseDto` - """ - model = ValidateLibraryResponseDto() - if include_optional: - return ValidateLibraryResponseDto( - import_paths = [ - generated.immich.openapi_client.models.validate_library_import_path_response_dto.ValidateLibraryImportPathResponseDto( - import_path = '', - is_valid = True, - message = '', ) - ] - ) - else: - return ValidateLibraryResponseDto( - ) - """ - - def testValidateLibraryResponseDto(self): - """Test ValidateLibraryResponseDto""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_video_codec.py b/generated/immich/openapi_client/test/test_video_codec.py deleted file mode 100644 index fb34ec1..0000000 --- a/generated/immich/openapi_client/test/test_video_codec.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.video_codec import VideoCodec - -class TestVideoCodec(unittest.TestCase): - """VideoCodec unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testVideoCodec(self): - """Test VideoCodec""" - # inst = VideoCodec() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client/test/test_video_container.py b/generated/immich/openapi_client/test/test_video_container.py deleted file mode 100644 index f02ac04..0000000 --- a/generated/immich/openapi_client/test/test_video_container.py +++ /dev/null @@ -1,33 +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 unittest - -from generated.immich.openapi_client.models.video_container import VideoContainer - -class TestVideoContainer(unittest.TestCase): - """VideoContainer unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testVideoContainer(self): - """Test VideoContainer""" - # inst = VideoContainer() - -if __name__ == '__main__': - unittest.main() diff --git a/generated/immich/openapi_client_README.md b/generated/immich/openapi_client_README.md index 5f4adfe..1532c57 100644 --- a/generated/immich/openapi_client_README.md +++ b/generated/immich/openapi_client_README.md @@ -5,12 +5,12 @@ The `generated.immich.openapi_client` package is automatically generated by the - API version: 3.0.1 - Package version: 1.0.0 -- Generator version: 7.18.0-SNAPSHOT +- Generator version: 7.9.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. -Python 3.9+ +Python 3.7+ ## Installation & Usage @@ -18,7 +18,7 @@ This python library package is generated without supporting files like setup.py To be able to use it, you will need these dependencies in your own package that uses this library: -* urllib3 >= 2.1.0, < 3.0.0 +* urllib3 >= 1.25.3, < 3.0.0 * python-dateutil >= 2.8.2 * pydantic >= 2 * typing-extensions >= 4.7.1 @@ -66,16 +66,17 @@ configuration = generated.immich.openapi_client.Configuration( # 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 | + api_instance = generated.immich.openapi_client.AlbumsApi(api_client) + id = 'id_example' # str | + bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto | 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") + # Add assets to an album + api_response = api_instance.add_assets_to_album(id, bulk_ids_dto) + print("The response of AlbumsApi->add_assets_to_album:\n") pprint(api_response) except ApiException as e: - print("Exception when calling APIKeysApi->create_api_key: %s\n" % e) + print("Exception when calling AlbumsApi->add_assets_to_album: %s\n" % e) ``` @@ -85,16 +86,6 @@ All URIs are relative to *https://github.com/api* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*APIKeysApi* | [**create_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#create_api_key) | **POST** /api-keys | Create an API key -*APIKeysApi* | [**delete_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#delete_api_key) | **DELETE** /api-keys/{id} | Delete an API key -*APIKeysApi* | [**get_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#get_api_key) | **GET** /api-keys/{id} | Retrieve an API key -*APIKeysApi* | [**get_api_keys**](generated/immich/openapi_client/docs/APIKeysApi.md#get_api_keys) | **GET** /api-keys | List all API keys -*APIKeysApi* | [**get_my_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#get_my_api_key) | **GET** /api-keys/me | Retrieve the current API key -*APIKeysApi* | [**update_api_key**](generated/immich/openapi_client/docs/APIKeysApi.md#update_api_key) | **PUT** /api-keys/{id} | Update an API key -*ActivitiesApi* | [**create_activity**](generated/immich/openapi_client/docs/ActivitiesApi.md#create_activity) | **POST** /activities | Create an activity -*ActivitiesApi* | [**delete_activity**](generated/immich/openapi_client/docs/ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} | Delete an activity -*ActivitiesApi* | [**get_activities**](generated/immich/openapi_client/docs/ActivitiesApi.md#get_activities) | **GET** /activities | List all activities -*ActivitiesApi* | [**get_activity_statistics**](generated/immich/openapi_client/docs/ActivitiesApi.md#get_activity_statistics) | **GET** /activities/statistics | Retrieve activity statistics *AlbumsApi* | [**add_assets_to_album**](generated/immich/openapi_client/docs/AlbumsApi.md#add_assets_to_album) | **PUT** /albums/{id}/assets | Add assets to an album *AlbumsApi* | [**add_assets_to_albums**](generated/immich/openapi_client/docs/AlbumsApi.md#add_assets_to_albums) | **PUT** /albums/assets | Add assets to albums *AlbumsApi* | [**add_users_to_album**](generated/immich/openapi_client/docs/AlbumsApi.md#add_users_to_album) | **PUT** /albums/{id}/users | Share album with users @@ -134,120 +125,6 @@ Class | Method | HTTP request | Description *AssetsApi* | [**update_bulk_asset_metadata**](generated/immich/openapi_client/docs/AssetsApi.md#update_bulk_asset_metadata) | **PUT** /assets/metadata | Upsert asset metadata *AssetsApi* | [**upload_asset**](generated/immich/openapi_client/docs/AssetsApi.md#upload_asset) | **POST** /assets | Upload asset *AssetsApi* | [**view_asset**](generated/immich/openapi_client/docs/AssetsApi.md#view_asset) | **GET** /assets/{id}/thumbnail | View asset thumbnail -*AuthenticationApi* | [**change_password**](generated/immich/openapi_client/docs/AuthenticationApi.md#change_password) | **POST** /auth/change-password | Change password -*AuthenticationApi* | [**change_pin_code**](generated/immich/openapi_client/docs/AuthenticationApi.md#change_pin_code) | **PUT** /auth/pin-code | Change pin code -*AuthenticationApi* | [**finish_o_auth**](generated/immich/openapi_client/docs/AuthenticationApi.md#finish_o_auth) | **POST** /oauth/callback | Finish OAuth -*AuthenticationApi* | [**get_auth_status**](generated/immich/openapi_client/docs/AuthenticationApi.md#get_auth_status) | **GET** /auth/status | Retrieve auth status -*AuthenticationApi* | [**link_o_auth_account**](generated/immich/openapi_client/docs/AuthenticationApi.md#link_o_auth_account) | **POST** /oauth/link | Link OAuth account -*AuthenticationApi* | [**lock_auth_session**](generated/immich/openapi_client/docs/AuthenticationApi.md#lock_auth_session) | **POST** /auth/session/lock | Lock auth session -*AuthenticationApi* | [**login**](generated/immich/openapi_client/docs/AuthenticationApi.md#login) | **POST** /auth/login | Login -*AuthenticationApi* | [**logout**](generated/immich/openapi_client/docs/AuthenticationApi.md#logout) | **POST** /auth/logout | Logout -*AuthenticationApi* | [**logout_o_auth**](generated/immich/openapi_client/docs/AuthenticationApi.md#logout_o_auth) | **POST** /oauth/backchannel-logout | Backchannel OAuth logout -*AuthenticationApi* | [**redirect_o_auth_to_mobile**](generated/immich/openapi_client/docs/AuthenticationApi.md#redirect_o_auth_to_mobile) | **GET** /oauth/mobile-redirect | Redirect OAuth to mobile -*AuthenticationApi* | [**reset_pin_code**](generated/immich/openapi_client/docs/AuthenticationApi.md#reset_pin_code) | **DELETE** /auth/pin-code | Reset pin code -*AuthenticationApi* | [**setup_pin_code**](generated/immich/openapi_client/docs/AuthenticationApi.md#setup_pin_code) | **POST** /auth/pin-code | Setup pin code -*AuthenticationApi* | [**sign_up_admin**](generated/immich/openapi_client/docs/AuthenticationApi.md#sign_up_admin) | **POST** /auth/admin-sign-up | Register admin -*AuthenticationApi* | [**start_o_auth**](generated/immich/openapi_client/docs/AuthenticationApi.md#start_o_auth) | **POST** /oauth/authorize | Start OAuth -*AuthenticationApi* | [**unlink_o_auth_account**](generated/immich/openapi_client/docs/AuthenticationApi.md#unlink_o_auth_account) | **POST** /oauth/unlink | Unlink OAuth account -*AuthenticationApi* | [**unlock_auth_session**](generated/immich/openapi_client/docs/AuthenticationApi.md#unlock_auth_session) | **POST** /auth/session/unlock | Unlock auth session -*AuthenticationApi* | [**validate_access_token**](generated/immich/openapi_client/docs/AuthenticationApi.md#validate_access_token) | **POST** /auth/validateToken | Validate access token -*AuthenticationAdminApi* | [**unlink_all_o_auth_accounts_admin**](generated/immich/openapi_client/docs/AuthenticationAdminApi.md#unlink_all_o_auth_accounts_admin) | **POST** /admin/auth/unlink-all | Unlink all OAuth accounts -*DatabaseBackupsAdminApi* | [**delete_database_backup**](generated/immich/openapi_client/docs/DatabaseBackupsAdminApi.md#delete_database_backup) | **DELETE** /admin/database-backups | Delete database backup -*DatabaseBackupsAdminApi* | [**download_database_backup**](generated/immich/openapi_client/docs/DatabaseBackupsAdminApi.md#download_database_backup) | **GET** /admin/database-backups/{filename} | Download database backup -*DatabaseBackupsAdminApi* | [**list_database_backups**](generated/immich/openapi_client/docs/DatabaseBackupsAdminApi.md#list_database_backups) | **GET** /admin/database-backups | List database backups -*DatabaseBackupsAdminApi* | [**start_database_restore_flow**](generated/immich/openapi_client/docs/DatabaseBackupsAdminApi.md#start_database_restore_flow) | **POST** /admin/database-backups/start-restore | Start database backup restore flow -*DatabaseBackupsAdminApi* | [**upload_database_backup**](generated/immich/openapi_client/docs/DatabaseBackupsAdminApi.md#upload_database_backup) | **POST** /admin/database-backups/upload | Upload database backup -*DeprecatedApi* | [**create_partner_deprecated**](generated/immich/openapi_client/docs/DeprecatedApi.md#create_partner_deprecated) | **POST** /partners/{id} | Create a partner -*DeprecatedApi* | [**get_queues_legacy**](generated/immich/openapi_client/docs/DeprecatedApi.md#get_queues_legacy) | **GET** /jobs | Retrieve queue counts and status -*DeprecatedApi* | [**run_queue_command_legacy**](generated/immich/openapi_client/docs/DeprecatedApi.md#run_queue_command_legacy) | **PUT** /jobs/{name} | Run jobs -*DeprecatedApi* | [**update_api_key**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_api_key) | **PUT** /api-keys/{id} | Update an API key -*DeprecatedApi* | [**update_asset**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_asset) | **PUT** /assets/{id} | Update an asset -*DeprecatedApi* | [**update_assets**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_assets) | **PUT** /assets | Update assets -*DeprecatedApi* | [**update_library**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_library) | **PUT** /libraries/{id} | Update a library -*DeprecatedApi* | [**update_memory**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_memory) | **PUT** /memories/{id} | Update a memory -*DeprecatedApi* | [**update_my_preferences**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_my_preferences) | **PUT** /users/me/preferences | Update my preferences -*DeprecatedApi* | [**update_my_user**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_my_user) | **PUT** /users/me | Update current user -*DeprecatedApi* | [**update_person**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_person) | **PUT** /people/{id} | Update person -*DeprecatedApi* | [**update_session**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_session) | **PUT** /sessions/{id} | Update a session -*DeprecatedApi* | [**update_stack**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_stack) | **PUT** /stacks/{id} | Update a stack -*DeprecatedApi* | [**update_tag**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_tag) | **PUT** /tags/{id} | Update a tag -*DeprecatedApi* | [**update_user_admin**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_user_admin) | **PUT** /admin/users/{id} | Update a user -*DeprecatedApi* | [**update_user_preferences_admin**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_user_preferences_admin) | **PUT** /admin/users/{id}/preferences | Update user preferences -*DeprecatedApi* | [**update_workflow**](generated/immich/openapi_client/docs/DeprecatedApi.md#update_workflow) | **PUT** /workflows/{id} | Update a workflow -*DownloadApi* | [**download_archive**](generated/immich/openapi_client/docs/DownloadApi.md#download_archive) | **POST** /download/archive | Download asset archive -*DownloadApi* | [**get_download_info**](generated/immich/openapi_client/docs/DownloadApi.md#get_download_info) | **POST** /download/info | Retrieve download information -*DuplicatesApi* | [**delete_duplicate**](generated/immich/openapi_client/docs/DuplicatesApi.md#delete_duplicate) | **DELETE** /duplicates/{id} | Dismiss a duplicate group -*DuplicatesApi* | [**delete_duplicates**](generated/immich/openapi_client/docs/DuplicatesApi.md#delete_duplicates) | **DELETE** /duplicates | Delete duplicates -*DuplicatesApi* | [**get_asset_duplicates**](generated/immich/openapi_client/docs/DuplicatesApi.md#get_asset_duplicates) | **GET** /duplicates | Retrieve duplicates -*DuplicatesApi* | [**resolve_duplicates**](generated/immich/openapi_client/docs/DuplicatesApi.md#resolve_duplicates) | **POST** /duplicates/resolve | Resolve duplicate groups -*FacesApi* | [**create_face**](generated/immich/openapi_client/docs/FacesApi.md#create_face) | **POST** /faces | Create a face -*FacesApi* | [**delete_face**](generated/immich/openapi_client/docs/FacesApi.md#delete_face) | **DELETE** /faces/{id} | Delete a face -*FacesApi* | [**get_faces**](generated/immich/openapi_client/docs/FacesApi.md#get_faces) | **GET** /faces | Retrieve faces for asset -*FacesApi* | [**reassign_faces_by_id**](generated/immich/openapi_client/docs/FacesApi.md#reassign_faces_by_id) | **PUT** /faces/{id} | Re-assign a face to another person -*JobsApi* | [**create_job**](generated/immich/openapi_client/docs/JobsApi.md#create_job) | **POST** /jobs | Create a manual job -*JobsApi* | [**get_queues_legacy**](generated/immich/openapi_client/docs/JobsApi.md#get_queues_legacy) | **GET** /jobs | Retrieve queue counts and status -*JobsApi* | [**run_queue_command_legacy**](generated/immich/openapi_client/docs/JobsApi.md#run_queue_command_legacy) | **PUT** /jobs/{name} | Run jobs -*LibrariesApi* | [**create_library**](generated/immich/openapi_client/docs/LibrariesApi.md#create_library) | **POST** /libraries | Create a library -*LibrariesApi* | [**delete_library**](generated/immich/openapi_client/docs/LibrariesApi.md#delete_library) | **DELETE** /libraries/{id} | Delete a library -*LibrariesApi* | [**get_all_libraries**](generated/immich/openapi_client/docs/LibrariesApi.md#get_all_libraries) | **GET** /libraries | Retrieve libraries -*LibrariesApi* | [**get_library**](generated/immich/openapi_client/docs/LibrariesApi.md#get_library) | **GET** /libraries/{id} | Retrieve a library -*LibrariesApi* | [**get_library_statistics**](generated/immich/openapi_client/docs/LibrariesApi.md#get_library_statistics) | **GET** /libraries/{id}/statistics | Retrieve library statistics -*LibrariesApi* | [**scan_library**](generated/immich/openapi_client/docs/LibrariesApi.md#scan_library) | **POST** /libraries/{id}/scan | Scan a library -*LibrariesApi* | [**update_library**](generated/immich/openapi_client/docs/LibrariesApi.md#update_library) | **PUT** /libraries/{id} | Update a library -*LibrariesApi* | [**validate**](generated/immich/openapi_client/docs/LibrariesApi.md#validate) | **POST** /libraries/{id}/validate | Validate library settings -*MaintenanceAdminApi* | [**delete_integrity_report**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#delete_integrity_report) | **DELETE** /admin/integrity/report/{id} | Delete integrity report item -*MaintenanceAdminApi* | [**detect_prior_install**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#detect_prior_install) | **GET** /admin/maintenance/detect-install | Detect existing install -*MaintenanceAdminApi* | [**get_integrity_report**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#get_integrity_report) | **GET** /admin/integrity/report | Get integrity report by type -*MaintenanceAdminApi* | [**get_integrity_report_csv**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#get_integrity_report_csv) | **GET** /admin/integrity/report/{type}/csv | Export integrity report by type as CSV -*MaintenanceAdminApi* | [**get_integrity_report_file**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#get_integrity_report_file) | **GET** /admin/integrity/report/{id}/file | Download flagged file -*MaintenanceAdminApi* | [**get_integrity_report_summary**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#get_integrity_report_summary) | **GET** /admin/integrity/summary | Get integrity report summary -*MaintenanceAdminApi* | [**get_maintenance_status**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#get_maintenance_status) | **GET** /admin/maintenance/status | Get maintenance mode status -*MaintenanceAdminApi* | [**maintenance_login**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#maintenance_login) | **POST** /admin/maintenance/login | Log into maintenance mode -*MaintenanceAdminApi* | [**set_maintenance_mode**](generated/immich/openapi_client/docs/MaintenanceAdminApi.md#set_maintenance_mode) | **POST** /admin/maintenance | Set maintenance mode -*MapApi* | [**get_map_markers**](generated/immich/openapi_client/docs/MapApi.md#get_map_markers) | **GET** /map/markers | Retrieve map markers -*MapApi* | [**reverse_geocode**](generated/immich/openapi_client/docs/MapApi.md#reverse_geocode) | **GET** /map/reverse-geocode | Reverse geocode coordinates -*MemoriesApi* | [**add_memory_assets**](generated/immich/openapi_client/docs/MemoriesApi.md#add_memory_assets) | **PUT** /memories/{id}/assets | Add assets to a memory -*MemoriesApi* | [**create_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#create_memory) | **POST** /memories | Create a memory -*MemoriesApi* | [**delete_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#delete_memory) | **DELETE** /memories/{id} | Delete a memory -*MemoriesApi* | [**get_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#get_memory) | **GET** /memories/{id} | Retrieve a memory -*MemoriesApi* | [**memories_statistics**](generated/immich/openapi_client/docs/MemoriesApi.md#memories_statistics) | **GET** /memories/statistics | Retrieve memories statistics -*MemoriesApi* | [**remove_memory_assets**](generated/immich/openapi_client/docs/MemoriesApi.md#remove_memory_assets) | **DELETE** /memories/{id}/assets | Remove assets from a memory -*MemoriesApi* | [**search_memories**](generated/immich/openapi_client/docs/MemoriesApi.md#search_memories) | **GET** /memories | Retrieve memories -*MemoriesApi* | [**update_memory**](generated/immich/openapi_client/docs/MemoriesApi.md#update_memory) | **PUT** /memories/{id} | Update a memory -*NotificationsApi* | [**delete_notification**](generated/immich/openapi_client/docs/NotificationsApi.md#delete_notification) | **DELETE** /notifications/{id} | Delete a notification -*NotificationsApi* | [**delete_notifications**](generated/immich/openapi_client/docs/NotificationsApi.md#delete_notifications) | **DELETE** /notifications | Delete notifications -*NotificationsApi* | [**get_notification**](generated/immich/openapi_client/docs/NotificationsApi.md#get_notification) | **GET** /notifications/{id} | Get a notification -*NotificationsApi* | [**get_notifications**](generated/immich/openapi_client/docs/NotificationsApi.md#get_notifications) | **GET** /notifications | Retrieve notifications -*NotificationsApi* | [**update_notification**](generated/immich/openapi_client/docs/NotificationsApi.md#update_notification) | **PUT** /notifications/{id} | Update a notification -*NotificationsApi* | [**update_notifications**](generated/immich/openapi_client/docs/NotificationsApi.md#update_notifications) | **PUT** /notifications | Update notifications -*NotificationsAdminApi* | [**create_notification**](generated/immich/openapi_client/docs/NotificationsAdminApi.md#create_notification) | **POST** /admin/notifications | Create a notification -*NotificationsAdminApi* | [**get_notification_template_admin**](generated/immich/openapi_client/docs/NotificationsAdminApi.md#get_notification_template_admin) | **POST** /admin/notifications/templates/{name} | Render email template -*NotificationsAdminApi* | [**send_test_email_admin**](generated/immich/openapi_client/docs/NotificationsAdminApi.md#send_test_email_admin) | **POST** /admin/notifications/test-email | Send test email -*PartnersApi* | [**create_partner**](generated/immich/openapi_client/docs/PartnersApi.md#create_partner) | **POST** /partners | Create a partner -*PartnersApi* | [**create_partner_deprecated**](generated/immich/openapi_client/docs/PartnersApi.md#create_partner_deprecated) | **POST** /partners/{id} | Create a partner -*PartnersApi* | [**get_partners**](generated/immich/openapi_client/docs/PartnersApi.md#get_partners) | **GET** /partners | Retrieve partners -*PartnersApi* | [**remove_partner**](generated/immich/openapi_client/docs/PartnersApi.md#remove_partner) | **DELETE** /partners/{id} | Remove a partner -*PartnersApi* | [**update_partner**](generated/immich/openapi_client/docs/PartnersApi.md#update_partner) | **PUT** /partners/{id} | Update a partner -*PeopleApi* | [**create_person**](generated/immich/openapi_client/docs/PeopleApi.md#create_person) | **POST** /people | Create a person -*PeopleApi* | [**delete_people**](generated/immich/openapi_client/docs/PeopleApi.md#delete_people) | **DELETE** /people | Delete people -*PeopleApi* | [**delete_person**](generated/immich/openapi_client/docs/PeopleApi.md#delete_person) | **DELETE** /people/{id} | Delete person -*PeopleApi* | [**get_all_people**](generated/immich/openapi_client/docs/PeopleApi.md#get_all_people) | **GET** /people | Get all people -*PeopleApi* | [**get_person**](generated/immich/openapi_client/docs/PeopleApi.md#get_person) | **GET** /people/{id} | Get a person -*PeopleApi* | [**get_person_statistics**](generated/immich/openapi_client/docs/PeopleApi.md#get_person_statistics) | **GET** /people/{id}/statistics | Get person statistics -*PeopleApi* | [**get_person_thumbnail**](generated/immich/openapi_client/docs/PeopleApi.md#get_person_thumbnail) | **GET** /people/{id}/thumbnail | Get person thumbnail -*PeopleApi* | [**merge_person**](generated/immich/openapi_client/docs/PeopleApi.md#merge_person) | **POST** /people/{id}/merge | Merge people -*PeopleApi* | [**reassign_faces**](generated/immich/openapi_client/docs/PeopleApi.md#reassign_faces) | **PUT** /people/{id}/reassign | Reassign faces -*PeopleApi* | [**update_people**](generated/immich/openapi_client/docs/PeopleApi.md#update_people) | **PUT** /people | Update people -*PeopleApi* | [**update_person**](generated/immich/openapi_client/docs/PeopleApi.md#update_person) | **PUT** /people/{id} | Update person -*PluginsApi* | [**get_plugin**](generated/immich/openapi_client/docs/PluginsApi.md#get_plugin) | **GET** /plugins/{id} | Retrieve a plugin -*PluginsApi* | [**search_plugin_methods**](generated/immich/openapi_client/docs/PluginsApi.md#search_plugin_methods) | **GET** /plugins/methods | Retrieve plugin methods -*PluginsApi* | [**search_plugin_templates**](generated/immich/openapi_client/docs/PluginsApi.md#search_plugin_templates) | **GET** /plugins/templates | Retrieve workflow templates -*PluginsApi* | [**search_plugins**](generated/immich/openapi_client/docs/PluginsApi.md#search_plugins) | **GET** /plugins | List all plugins -*QueuesApi* | [**empty_queue**](generated/immich/openapi_client/docs/QueuesApi.md#empty_queue) | **DELETE** /queues/{name}/jobs | Empty a queue -*QueuesApi* | [**get_queue**](generated/immich/openapi_client/docs/QueuesApi.md#get_queue) | **GET** /queues/{name} | Retrieve a queue -*QueuesApi* | [**get_queue_jobs**](generated/immich/openapi_client/docs/QueuesApi.md#get_queue_jobs) | **GET** /queues/{name}/jobs | Retrieve queue jobs -*QueuesApi* | [**get_queues**](generated/immich/openapi_client/docs/QueuesApi.md#get_queues) | **GET** /queues | List all queues -*QueuesApi* | [**update_queue**](generated/immich/openapi_client/docs/QueuesApi.md#update_queue) | **PUT** /queues/{name} | Update a queue *SearchApi* | [**get_assets_by_city**](generated/immich/openapi_client/docs/SearchApi.md#get_assets_by_city) | **GET** /search/cities | Retrieve assets by city *SearchApi* | [**get_explore_data**](generated/immich/openapi_client/docs/SearchApi.md#get_explore_data) | **GET** /search/explore | Retrieve explore data *SearchApi* | [**get_search_suggestions**](generated/immich/openapi_client/docs/SearchApi.md#get_search_suggestions) | **GET** /search/suggestions | Retrieve search suggestions @@ -258,104 +135,6 @@ Class | Method | HTTP request | Description *SearchApi* | [**search_places**](generated/immich/openapi_client/docs/SearchApi.md#search_places) | **GET** /search/places | Search places *SearchApi* | [**search_random**](generated/immich/openapi_client/docs/SearchApi.md#search_random) | **POST** /search/random | Search random assets *SearchApi* | [**search_smart**](generated/immich/openapi_client/docs/SearchApi.md#search_smart) | **POST** /search/smart | Smart asset search -*ServerApi* | [**delete_server_license**](generated/immich/openapi_client/docs/ServerApi.md#delete_server_license) | **DELETE** /server/license | Delete server product key -*ServerApi* | [**get_about_info**](generated/immich/openapi_client/docs/ServerApi.md#get_about_info) | **GET** /server/about | Get server information -*ServerApi* | [**get_apk_links**](generated/immich/openapi_client/docs/ServerApi.md#get_apk_links) | **GET** /server/apk-links | Get APK links -*ServerApi* | [**get_server_config**](generated/immich/openapi_client/docs/ServerApi.md#get_server_config) | **GET** /server/config | Get config -*ServerApi* | [**get_server_features**](generated/immich/openapi_client/docs/ServerApi.md#get_server_features) | **GET** /server/features | Get features -*ServerApi* | [**get_server_license**](generated/immich/openapi_client/docs/ServerApi.md#get_server_license) | **GET** /server/license | Get product key -*ServerApi* | [**get_server_statistics**](generated/immich/openapi_client/docs/ServerApi.md#get_server_statistics) | **GET** /server/statistics | Get statistics -*ServerApi* | [**get_server_version**](generated/immich/openapi_client/docs/ServerApi.md#get_server_version) | **GET** /server/version | Get server version -*ServerApi* | [**get_storage**](generated/immich/openapi_client/docs/ServerApi.md#get_storage) | **GET** /server/storage | Get storage -*ServerApi* | [**get_supported_media_types**](generated/immich/openapi_client/docs/ServerApi.md#get_supported_media_types) | **GET** /server/media-types | Get supported media types -*ServerApi* | [**get_version_check**](generated/immich/openapi_client/docs/ServerApi.md#get_version_check) | **GET** /server/version-check | Get version check status -*ServerApi* | [**get_version_history**](generated/immich/openapi_client/docs/ServerApi.md#get_version_history) | **GET** /server/version-history | Get version history -*ServerApi* | [**ping_server**](generated/immich/openapi_client/docs/ServerApi.md#ping_server) | **GET** /server/ping | Ping -*ServerApi* | [**set_server_license**](generated/immich/openapi_client/docs/ServerApi.md#set_server_license) | **PUT** /server/license | Set server product key -*SessionsApi* | [**create_session**](generated/immich/openapi_client/docs/SessionsApi.md#create_session) | **POST** /sessions | Create a session -*SessionsApi* | [**delete_all_sessions**](generated/immich/openapi_client/docs/SessionsApi.md#delete_all_sessions) | **DELETE** /sessions | Delete all sessions -*SessionsApi* | [**delete_session**](generated/immich/openapi_client/docs/SessionsApi.md#delete_session) | **DELETE** /sessions/{id} | Delete a session -*SessionsApi* | [**get_sessions**](generated/immich/openapi_client/docs/SessionsApi.md#get_sessions) | **GET** /sessions | Retrieve sessions -*SessionsApi* | [**lock_session**](generated/immich/openapi_client/docs/SessionsApi.md#lock_session) | **POST** /sessions/{id}/lock | Lock a session -*SessionsApi* | [**update_session**](generated/immich/openapi_client/docs/SessionsApi.md#update_session) | **PUT** /sessions/{id} | Update a session -*SharedLinksApi* | [**add_shared_link_assets**](generated/immich/openapi_client/docs/SharedLinksApi.md#add_shared_link_assets) | **PUT** /shared-links/{id}/assets | Add assets to a shared link -*SharedLinksApi* | [**create_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#create_shared_link) | **POST** /shared-links | Create a shared link -*SharedLinksApi* | [**get_all_shared_links**](generated/immich/openapi_client/docs/SharedLinksApi.md#get_all_shared_links) | **GET** /shared-links | Retrieve all shared links -*SharedLinksApi* | [**get_my_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#get_my_shared_link) | **GET** /shared-links/me | Retrieve current shared link -*SharedLinksApi* | [**get_shared_link_by_id**](generated/immich/openapi_client/docs/SharedLinksApi.md#get_shared_link_by_id) | **GET** /shared-links/{id} | Retrieve a shared link -*SharedLinksApi* | [**remove_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#remove_shared_link) | **DELETE** /shared-links/{id} | Delete a shared link -*SharedLinksApi* | [**remove_shared_link_assets**](generated/immich/openapi_client/docs/SharedLinksApi.md#remove_shared_link_assets) | **DELETE** /shared-links/{id}/assets | Remove assets from a shared link -*SharedLinksApi* | [**shared_link_login**](generated/immich/openapi_client/docs/SharedLinksApi.md#shared_link_login) | **POST** /shared-links/login | Shared link login -*SharedLinksApi* | [**update_shared_link**](generated/immich/openapi_client/docs/SharedLinksApi.md#update_shared_link) | **PATCH** /shared-links/{id} | Update a shared link -*StacksApi* | [**create_stack**](generated/immich/openapi_client/docs/StacksApi.md#create_stack) | **POST** /stacks | Create a stack -*StacksApi* | [**delete_stack**](generated/immich/openapi_client/docs/StacksApi.md#delete_stack) | **DELETE** /stacks/{id} | Delete a stack -*StacksApi* | [**delete_stacks**](generated/immich/openapi_client/docs/StacksApi.md#delete_stacks) | **DELETE** /stacks | Delete stacks -*StacksApi* | [**get_stack**](generated/immich/openapi_client/docs/StacksApi.md#get_stack) | **GET** /stacks/{id} | Retrieve a stack -*StacksApi* | [**remove_asset_from_stack**](generated/immich/openapi_client/docs/StacksApi.md#remove_asset_from_stack) | **DELETE** /stacks/{id}/assets/{assetId} | Remove an asset from a stack -*StacksApi* | [**search_stacks**](generated/immich/openapi_client/docs/StacksApi.md#search_stacks) | **GET** /stacks | Retrieve stacks -*StacksApi* | [**update_stack**](generated/immich/openapi_client/docs/StacksApi.md#update_stack) | **PUT** /stacks/{id} | Update a stack -*SyncApi* | [**delete_sync_ack**](generated/immich/openapi_client/docs/SyncApi.md#delete_sync_ack) | **DELETE** /sync/ack | Delete acknowledgements -*SyncApi* | [**get_sync_ack**](generated/immich/openapi_client/docs/SyncApi.md#get_sync_ack) | **GET** /sync/ack | Retrieve acknowledgements -*SyncApi* | [**get_sync_stream**](generated/immich/openapi_client/docs/SyncApi.md#get_sync_stream) | **POST** /sync/stream | Stream sync changes -*SyncApi* | [**send_sync_ack**](generated/immich/openapi_client/docs/SyncApi.md#send_sync_ack) | **POST** /sync/ack | Acknowledge changes -*SystemConfigApi* | [**get_config**](generated/immich/openapi_client/docs/SystemConfigApi.md#get_config) | **GET** /system-config | Get system configuration -*SystemConfigApi* | [**get_config_defaults**](generated/immich/openapi_client/docs/SystemConfigApi.md#get_config_defaults) | **GET** /system-config/defaults | Get system configuration defaults -*SystemConfigApi* | [**get_storage_template_options**](generated/immich/openapi_client/docs/SystemConfigApi.md#get_storage_template_options) | **GET** /system-config/storage-template-options | Get storage template options -*SystemConfigApi* | [**update_config**](generated/immich/openapi_client/docs/SystemConfigApi.md#update_config) | **PUT** /system-config | Update system configuration -*SystemMetadataApi* | [**get_admin_onboarding**](generated/immich/openapi_client/docs/SystemMetadataApi.md#get_admin_onboarding) | **GET** /system-metadata/admin-onboarding | Retrieve admin onboarding -*SystemMetadataApi* | [**get_reverse_geocoding_state**](generated/immich/openapi_client/docs/SystemMetadataApi.md#get_reverse_geocoding_state) | **GET** /system-metadata/reverse-geocoding-state | Retrieve reverse geocoding state -*SystemMetadataApi* | [**get_version_check_state**](generated/immich/openapi_client/docs/SystemMetadataApi.md#get_version_check_state) | **GET** /system-metadata/version-check-state | Retrieve version check state -*SystemMetadataApi* | [**update_admin_onboarding**](generated/immich/openapi_client/docs/SystemMetadataApi.md#update_admin_onboarding) | **POST** /system-metadata/admin-onboarding | Update admin onboarding -*TagsApi* | [**bulk_tag_assets**](generated/immich/openapi_client/docs/TagsApi.md#bulk_tag_assets) | **PUT** /tags/assets | Tag assets -*TagsApi* | [**create_tag**](generated/immich/openapi_client/docs/TagsApi.md#create_tag) | **POST** /tags | Create a tag -*TagsApi* | [**delete_tag**](generated/immich/openapi_client/docs/TagsApi.md#delete_tag) | **DELETE** /tags/{id} | Delete a tag -*TagsApi* | [**get_all_tags**](generated/immich/openapi_client/docs/TagsApi.md#get_all_tags) | **GET** /tags | Retrieve tags -*TagsApi* | [**get_tag_by_id**](generated/immich/openapi_client/docs/TagsApi.md#get_tag_by_id) | **GET** /tags/{id} | Retrieve a tag -*TagsApi* | [**tag_assets**](generated/immich/openapi_client/docs/TagsApi.md#tag_assets) | **PUT** /tags/{id}/assets | Tag assets -*TagsApi* | [**untag_assets**](generated/immich/openapi_client/docs/TagsApi.md#untag_assets) | **DELETE** /tags/{id}/assets | Untag assets -*TagsApi* | [**update_tag**](generated/immich/openapi_client/docs/TagsApi.md#update_tag) | **PUT** /tags/{id} | Update a tag -*TagsApi* | [**upsert_tags**](generated/immich/openapi_client/docs/TagsApi.md#upsert_tags) | **PUT** /tags | Upsert tags -*TimelineApi* | [**get_time_bucket**](generated/immich/openapi_client/docs/TimelineApi.md#get_time_bucket) | **GET** /timeline/bucket | Get time bucket -*TimelineApi* | [**get_time_buckets**](generated/immich/openapi_client/docs/TimelineApi.md#get_time_buckets) | **GET** /timeline/buckets | Get time buckets -*TrashApi* | [**empty_trash**](generated/immich/openapi_client/docs/TrashApi.md#empty_trash) | **POST** /trash/empty | Empty trash -*TrashApi* | [**restore_assets**](generated/immich/openapi_client/docs/TrashApi.md#restore_assets) | **POST** /trash/restore/assets | Restore assets -*TrashApi* | [**restore_trash**](generated/immich/openapi_client/docs/TrashApi.md#restore_trash) | **POST** /trash/restore | Restore trash -*UsersApi* | [**create_profile_image**](generated/immich/openapi_client/docs/UsersApi.md#create_profile_image) | **POST** /users/profile-image | Create user profile image -*UsersApi* | [**delete_profile_image**](generated/immich/openapi_client/docs/UsersApi.md#delete_profile_image) | **DELETE** /users/profile-image | Delete user profile image -*UsersApi* | [**delete_user_license**](generated/immich/openapi_client/docs/UsersApi.md#delete_user_license) | **DELETE** /users/me/license | Delete user product key -*UsersApi* | [**delete_user_onboarding**](generated/immich/openapi_client/docs/UsersApi.md#delete_user_onboarding) | **DELETE** /users/me/onboarding | Delete user onboarding -*UsersApi* | [**get_my_calendar_heatmap**](generated/immich/openapi_client/docs/UsersApi.md#get_my_calendar_heatmap) | **GET** /users/me/calendar-heatmap | Retrieve calendar heatmap activity -*UsersApi* | [**get_my_preferences**](generated/immich/openapi_client/docs/UsersApi.md#get_my_preferences) | **GET** /users/me/preferences | Get my preferences -*UsersApi* | [**get_my_user**](generated/immich/openapi_client/docs/UsersApi.md#get_my_user) | **GET** /users/me | Get current user -*UsersApi* | [**get_profile_image**](generated/immich/openapi_client/docs/UsersApi.md#get_profile_image) | **GET** /users/{id}/profile-image | Retrieve user profile image -*UsersApi* | [**get_user**](generated/immich/openapi_client/docs/UsersApi.md#get_user) | **GET** /users/{id} | Retrieve a user -*UsersApi* | [**get_user_license**](generated/immich/openapi_client/docs/UsersApi.md#get_user_license) | **GET** /users/me/license | Retrieve user product key -*UsersApi* | [**get_user_onboarding**](generated/immich/openapi_client/docs/UsersApi.md#get_user_onboarding) | **GET** /users/me/onboarding | Retrieve user onboarding -*UsersApi* | [**search_users**](generated/immich/openapi_client/docs/UsersApi.md#search_users) | **GET** /users | Get all users -*UsersApi* | [**set_user_license**](generated/immich/openapi_client/docs/UsersApi.md#set_user_license) | **PUT** /users/me/license | Set user product key -*UsersApi* | [**set_user_onboarding**](generated/immich/openapi_client/docs/UsersApi.md#set_user_onboarding) | **PUT** /users/me/onboarding | Update user onboarding -*UsersApi* | [**update_my_preferences**](generated/immich/openapi_client/docs/UsersApi.md#update_my_preferences) | **PUT** /users/me/preferences | Update my preferences -*UsersApi* | [**update_my_user**](generated/immich/openapi_client/docs/UsersApi.md#update_my_user) | **PUT** /users/me | Update current user -*UsersAdminApi* | [**create_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#create_user_admin) | **POST** /admin/users | Create a user -*UsersAdminApi* | [**delete_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#delete_user_admin) | **DELETE** /admin/users/{id} | Delete a user -*UsersAdminApi* | [**get_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_admin) | **GET** /admin/users/{id} | Retrieve a user -*UsersAdminApi* | [**get_user_calendar_heatmap_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_calendar_heatmap_admin) | **GET** /admin/users/{id}/calendar-heatmap | Retrieve calendar heatmap activity -*UsersAdminApi* | [**get_user_preferences_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_preferences_admin) | **GET** /admin/users/{id}/preferences | Retrieve user preferences -*UsersAdminApi* | [**get_user_sessions_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_sessions_admin) | **GET** /admin/users/{id}/sessions | Retrieve user sessions -*UsersAdminApi* | [**get_user_statistics_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#get_user_statistics_admin) | **GET** /admin/users/{id}/statistics | Retrieve user statistics -*UsersAdminApi* | [**restore_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#restore_user_admin) | **POST** /admin/users/{id}/restore | Restore a deleted user -*UsersAdminApi* | [**search_users_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#search_users_admin) | **GET** /admin/users | Search users -*UsersAdminApi* | [**update_user_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#update_user_admin) | **PUT** /admin/users/{id} | Update a user -*UsersAdminApi* | [**update_user_preferences_admin**](generated/immich/openapi_client/docs/UsersAdminApi.md#update_user_preferences_admin) | **PUT** /admin/users/{id}/preferences | Update user preferences -*ViewsApi* | [**get_assets_by_original_path**](generated/immich/openapi_client/docs/ViewsApi.md#get_assets_by_original_path) | **GET** /view/folder | Retrieve assets by original path -*ViewsApi* | [**get_unique_original_paths**](generated/immich/openapi_client/docs/ViewsApi.md#get_unique_original_paths) | **GET** /view/folder/unique-paths | Retrieve unique paths -*WorkflowsApi* | [**create_workflow**](generated/immich/openapi_client/docs/WorkflowsApi.md#create_workflow) | **POST** /workflows | Create a workflow -*WorkflowsApi* | [**delete_workflow**](generated/immich/openapi_client/docs/WorkflowsApi.md#delete_workflow) | **DELETE** /workflows/{id} | Delete a workflow -*WorkflowsApi* | [**get_workflow**](generated/immich/openapi_client/docs/WorkflowsApi.md#get_workflow) | **GET** /workflows/{id} | Retrieve a workflow -*WorkflowsApi* | [**get_workflow_for_share**](generated/immich/openapi_client/docs/WorkflowsApi.md#get_workflow_for_share) | **GET** /workflows/{id}/share | Retrieve a workflow -*WorkflowsApi* | [**get_workflow_triggers**](generated/immich/openapi_client/docs/WorkflowsApi.md#get_workflow_triggers) | **GET** /workflows/triggers | List all workflow triggers -*WorkflowsApi* | [**search_workflows**](generated/immich/openapi_client/docs/WorkflowsApi.md#search_workflows) | **GET** /workflows | List all workflows -*WorkflowsApi* | [**update_workflow**](generated/immich/openapi_client/docs/WorkflowsApi.md#update_workflow) | **PUT** /workflows/{id} | Update a workflow ## Documentation For Models