immich 1.2.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (387) hide show
  1. immich/.openapi-generator/FILES +372 -0
  2. immich/.openapi-generator/VERSION +1 -0
  3. immich/.openapi-generator-ignore +48 -0
  4. immich/__init__.py +3 -0
  5. immich/client/__init__.py +1162 -0
  6. immich/client/api/__init__.py +39 -0
  7. immich/client/api/activities_api.py +1092 -0
  8. immich/client/api/albums_api.py +3228 -0
  9. immich/client/api/api_keys_api.py +1484 -0
  10. immich/client/api/assets_api.py +5834 -0
  11. immich/client/api/authentication_admin_api.py +254 -0
  12. immich/client/api/authentication_api.py +3881 -0
  13. immich/client/api/deprecated_api.py +2199 -0
  14. immich/client/api/download_api.py +603 -0
  15. immich/client/api/duplicates_api.py +743 -0
  16. immich/client/api/faces_api.py +1053 -0
  17. immich/client/api/jobs_api.py +783 -0
  18. immich/client/api/libraries_api.py +2004 -0
  19. immich/client/api/maintenance_admin_api.py +533 -0
  20. immich/client/api/map_api.py +640 -0
  21. immich/client/api/memories_api.py +2250 -0
  22. immich/client/api/notifications_admin_api.py +808 -0
  23. immich/client/api/notifications_api.py +1564 -0
  24. immich/client/api/partners_api.py +1278 -0
  25. immich/client/api/people_api.py +2905 -0
  26. immich/client/api/plugins_api.py +730 -0
  27. immich/client/api/queues_api.py +1292 -0
  28. immich/client/api/search_api.py +3198 -0
  29. immich/client/api/server_api.py +3466 -0
  30. immich/client/api/sessions_api.py +1472 -0
  31. immich/client/api/shared_links_api.py +2177 -0
  32. immich/client/api/stacks_api.py +1769 -0
  33. immich/client/api/sync_api.py +1512 -0
  34. immich/client/api/system_config_api.py +967 -0
  35. immich/client/api/system_metadata_api.py +964 -0
  36. immich/client/api/tags_api.py +2296 -0
  37. immich/client/api/timeline_api.py +1193 -0
  38. immich/client/api/trash_api.py +739 -0
  39. immich/client/api/users_admin_api.py +2607 -0
  40. immich/client/api/users_api.py +3577 -0
  41. immich/client/api/views_api.py +503 -0
  42. immich/client/api/workflows_api.py +1257 -0
  43. immich/client/api_client.py +756 -0
  44. immich/client/api_response.py +20 -0
  45. immich/client/configuration.py +638 -0
  46. immich/client/exceptions.py +222 -0
  47. immich/client/models/__init__.py +424 -0
  48. immich/client/models/activity_create_dto.py +94 -0
  49. immich/client/models/activity_response_dto.py +121 -0
  50. immich/client/models/activity_statistics_response_dto.py +85 -0
  51. immich/client/models/add_users_dto.py +101 -0
  52. immich/client/models/admin_onboarding_update_dto.py +82 -0
  53. immich/client/models/album_response_dto.py +199 -0
  54. immich/client/models/album_statistics_response_dto.py +90 -0
  55. immich/client/models/album_user_add_dto.py +87 -0
  56. immich/client/models/album_user_create_dto.py +87 -0
  57. immich/client/models/album_user_response_dto.py +95 -0
  58. immich/client/models/album_user_role.py +34 -0
  59. immich/client/models/albums_add_assets_dto.py +86 -0
  60. immich/client/models/albums_add_assets_response_dto.py +86 -0
  61. immich/client/models/albums_response.py +83 -0
  62. immich/client/models/albums_update.py +85 -0
  63. immich/client/models/api_key_create_dto.py +87 -0
  64. immich/client/models/api_key_create_response_dto.py +94 -0
  65. immich/client/models/api_key_response_dto.py +102 -0
  66. immich/client/models/api_key_update_dto.py +87 -0
  67. immich/client/models/asset_bulk_delete_dto.py +84 -0
  68. immich/client/models/asset_bulk_update_dto.py +143 -0
  69. immich/client/models/asset_bulk_upload_check_dto.py +98 -0
  70. immich/client/models/asset_bulk_upload_check_item.py +85 -0
  71. immich/client/models/asset_bulk_upload_check_response_dto.py +101 -0
  72. immich/client/models/asset_bulk_upload_check_result.py +126 -0
  73. immich/client/models/asset_copy_dto.py +113 -0
  74. immich/client/models/asset_delta_sync_dto.py +87 -0
  75. immich/client/models/asset_delta_sync_response_dto.py +102 -0
  76. immich/client/models/asset_face_create_dto.py +110 -0
  77. immich/client/models/asset_face_delete_dto.py +82 -0
  78. immich/client/models/asset_face_response_dto.py +125 -0
  79. immich/client/models/asset_face_update_dto.py +96 -0
  80. immich/client/models/asset_face_update_item.py +86 -0
  81. immich/client/models/asset_face_without_person_response_dto.py +111 -0
  82. immich/client/models/asset_full_sync_dto.py +95 -0
  83. immich/client/models/asset_ids_dto.py +83 -0
  84. immich/client/models/asset_ids_response_dto.py +109 -0
  85. immich/client/models/asset_job_name.py +36 -0
  86. immich/client/models/asset_jobs_dto.py +87 -0
  87. immich/client/models/asset_media_response_dto.py +84 -0
  88. immich/client/models/asset_media_size.py +35 -0
  89. immich/client/models/asset_media_status.py +35 -0
  90. immich/client/models/asset_metadata_key.py +33 -0
  91. immich/client/models/asset_metadata_response_dto.py +92 -0
  92. immich/client/models/asset_metadata_upsert_dto.py +101 -0
  93. immich/client/models/asset_metadata_upsert_item_dto.py +84 -0
  94. immich/client/models/asset_ocr_response_dto.py +145 -0
  95. immich/client/models/asset_order.py +34 -0
  96. immich/client/models/asset_response_dto.py +291 -0
  97. immich/client/models/asset_stack_response_dto.py +90 -0
  98. immich/client/models/asset_stats_response_dto.py +90 -0
  99. immich/client/models/asset_type_enum.py +36 -0
  100. immich/client/models/asset_visibility.py +36 -0
  101. immich/client/models/audio_codec.py +36 -0
  102. immich/client/models/auth_status_response_dto.py +100 -0
  103. immich/client/models/avatar_update.py +83 -0
  104. immich/client/models/bulk_id_error_reason.py +36 -0
  105. immich/client/models/bulk_id_response_dto.py +102 -0
  106. immich/client/models/bulk_ids_dto.py +83 -0
  107. immich/client/models/cast_response.py +88 -0
  108. immich/client/models/cast_update.py +82 -0
  109. immich/client/models/change_password_dto.py +101 -0
  110. immich/client/models/check_existing_assets_dto.py +91 -0
  111. immich/client/models/check_existing_assets_response_dto.py +82 -0
  112. immich/client/models/clip_config.py +85 -0
  113. immich/client/models/colorspace.py +34 -0
  114. immich/client/models/contributor_count_response_dto.py +85 -0
  115. immich/client/models/cq_mode.py +35 -0
  116. immich/client/models/create_album_dto.py +112 -0
  117. immich/client/models/create_library_dto.py +103 -0
  118. immich/client/models/create_profile_image_response_dto.py +95 -0
  119. immich/client/models/database_backup_config.py +94 -0
  120. immich/client/models/download_archive_info.py +85 -0
  121. immich/client/models/download_info_dto.py +96 -0
  122. immich/client/models/download_response.py +90 -0
  123. immich/client/models/download_response_dto.py +100 -0
  124. immich/client/models/download_update.py +93 -0
  125. immich/client/models/duplicate_detection_config.py +89 -0
  126. immich/client/models/duplicate_response_dto.py +98 -0
  127. immich/client/models/email_notifications_response.py +90 -0
  128. immich/client/models/email_notifications_update.py +90 -0
  129. immich/client/models/exif_response_dto.py +284 -0
  130. immich/client/models/face_dto.py +83 -0
  131. immich/client/models/facial_recognition_config.py +107 -0
  132. immich/client/models/folders_response.py +92 -0
  133. immich/client/models/folders_update.py +85 -0
  134. immich/client/models/image_format.py +34 -0
  135. immich/client/models/job_create_dto.py +83 -0
  136. immich/client/models/job_name.py +87 -0
  137. immich/client/models/job_settings_dto.py +83 -0
  138. immich/client/models/library_response_dto.py +118 -0
  139. immich/client/models/library_stats_response_dto.py +92 -0
  140. immich/client/models/license_key_dto.py +98 -0
  141. immich/client/models/license_response_dto.py +101 -0
  142. immich/client/models/log_level.py +38 -0
  143. immich/client/models/login_credential_dto.py +85 -0
  144. immich/client/models/login_response_dto.py +109 -0
  145. immich/client/models/logout_response_dto.py +85 -0
  146. immich/client/models/machine_learning_availability_checks_dto.py +90 -0
  147. immich/client/models/maintenance_action.py +34 -0
  148. immich/client/models/maintenance_auth_dto.py +82 -0
  149. immich/client/models/maintenance_login_dto.py +82 -0
  150. immich/client/models/manual_job_name.py +38 -0
  151. immich/client/models/map_marker_response_dto.py +111 -0
  152. immich/client/models/map_reverse_geocode_response_dto.py +105 -0
  153. immich/client/models/memories_response.py +92 -0
  154. immich/client/models/memories_update.py +86 -0
  155. immich/client/models/memory_create_dto.py +112 -0
  156. immich/client/models/memory_response_dto.py +142 -0
  157. immich/client/models/memory_search_order.py +35 -0
  158. immich/client/models/memory_statistics_response_dto.py +82 -0
  159. immich/client/models/memory_type.py +33 -0
  160. immich/client/models/memory_update_dto.py +91 -0
  161. immich/client/models/merge_person_dto.py +83 -0
  162. immich/client/models/metadata_search_dto.py +277 -0
  163. immich/client/models/notification_create_dto.py +120 -0
  164. immich/client/models/notification_delete_all_dto.py +83 -0
  165. immich/client/models/notification_dto.py +112 -0
  166. immich/client/models/notification_level.py +36 -0
  167. immich/client/models/notification_type.py +38 -0
  168. immich/client/models/notification_update_all_dto.py +90 -0
  169. immich/client/models/notification_update_dto.py +88 -0
  170. immich/client/models/o_auth_authorize_response_dto.py +82 -0
  171. immich/client/models/o_auth_callback_dto.py +90 -0
  172. immich/client/models/o_auth_config_dto.py +90 -0
  173. immich/client/models/o_auth_token_endpoint_auth_method.py +34 -0
  174. immich/client/models/ocr_config.py +109 -0
  175. immich/client/models/on_this_day_dto.py +86 -0
  176. immich/client/models/onboarding_dto.py +82 -0
  177. immich/client/models/onboarding_response_dto.py +82 -0
  178. immich/client/models/partner_create_dto.py +83 -0
  179. immich/client/models/partner_direction.py +34 -0
  180. immich/client/models/partner_response_dto.py +108 -0
  181. immich/client/models/partner_update_dto.py +82 -0
  182. immich/client/models/people_response.py +92 -0
  183. immich/client/models/people_response_dto.py +104 -0
  184. immich/client/models/people_update.py +85 -0
  185. immich/client/models/people_update_dto.py +96 -0
  186. immich/client/models/people_update_item.py +128 -0
  187. immich/client/models/permission.py +177 -0
  188. immich/client/models/person_create_dto.py +117 -0
  189. immich/client/models/person_response_dto.py +115 -0
  190. immich/client/models/person_statistics_response_dto.py +82 -0
  191. immich/client/models/person_update_dto.py +125 -0
  192. immich/client/models/person_with_faces_response_dto.py +133 -0
  193. immich/client/models/pin_code_change_dto.py +90 -0
  194. immich/client/models/pin_code_reset_dto.py +85 -0
  195. immich/client/models/pin_code_setup_dto.py +82 -0
  196. immich/client/models/places_response_dto.py +100 -0
  197. immich/client/models/plugin_action_response_dto.py +112 -0
  198. immich/client/models/plugin_context_type.py +35 -0
  199. immich/client/models/plugin_filter_response_dto.py +112 -0
  200. immich/client/models/plugin_response_dto.py +139 -0
  201. immich/client/models/plugin_trigger_response_dto.py +87 -0
  202. immich/client/models/plugin_trigger_type.py +34 -0
  203. immich/client/models/purchase_response.py +88 -0
  204. immich/client/models/purchase_update.py +92 -0
  205. immich/client/models/queue_command.py +37 -0
  206. immich/client/models/queue_command_dto.py +86 -0
  207. immich/client/models/queue_delete_dto.py +85 -0
  208. immich/client/models/queue_job_response_dto.py +93 -0
  209. immich/client/models/queue_job_status.py +38 -0
  210. immich/client/models/queue_name.py +49 -0
  211. immich/client/models/queue_response_dto.py +97 -0
  212. immich/client/models/queue_response_legacy_dto.py +100 -0
  213. immich/client/models/queue_statistics_dto.py +103 -0
  214. immich/client/models/queue_status_legacy_dto.py +85 -0
  215. immich/client/models/queue_update_dto.py +82 -0
  216. immich/client/models/queues_response_legacy_dto.py +242 -0
  217. immich/client/models/random_search_dto.py +234 -0
  218. immich/client/models/ratings_response.py +84 -0
  219. immich/client/models/ratings_update.py +82 -0
  220. immich/client/models/reaction_level.py +34 -0
  221. immich/client/models/reaction_type.py +34 -0
  222. immich/client/models/reverse_geocoding_state_response_dto.py +101 -0
  223. immich/client/models/search_album_response_dto.py +114 -0
  224. immich/client/models/search_asset_response_dto.py +127 -0
  225. immich/client/models/search_explore_item.py +94 -0
  226. immich/client/models/search_explore_response_dto.py +98 -0
  227. immich/client/models/search_facet_count_response_dto.py +85 -0
  228. immich/client/models/search_facet_response_dto.py +103 -0
  229. immich/client/models/search_response_dto.py +100 -0
  230. immich/client/models/search_statistics_response_dto.py +82 -0
  231. immich/client/models/search_suggestion_type.py +38 -0
  232. immich/client/models/server_about_response_dto.py +156 -0
  233. immich/client/models/server_apk_links_dto.py +97 -0
  234. immich/client/models/server_config_dto.py +118 -0
  235. immich/client/models/server_features_dto.py +130 -0
  236. immich/client/models/server_media_types_response_dto.py +90 -0
  237. immich/client/models/server_ping_response.py +87 -0
  238. immich/client/models/server_stats_response_dto.py +119 -0
  239. immich/client/models/server_storage_response_dto.py +108 -0
  240. immich/client/models/server_theme_dto.py +82 -0
  241. immich/client/models/server_version_history_response_dto.py +91 -0
  242. immich/client/models/server_version_response_dto.py +90 -0
  243. immich/client/models/session_create_dto.py +96 -0
  244. immich/client/models/session_create_response_dto.py +120 -0
  245. immich/client/models/session_response_dto.py +117 -0
  246. immich/client/models/session_unlock_dto.py +85 -0
  247. immich/client/models/session_update_dto.py +84 -0
  248. immich/client/models/set_maintenance_mode_dto.py +83 -0
  249. immich/client/models/shared_link_create_dto.py +142 -0
  250. immich/client/models/shared_link_edit_dto.py +134 -0
  251. immich/client/models/shared_link_response_dto.py +173 -0
  252. immich/client/models/shared_link_type.py +34 -0
  253. immich/client/models/shared_links_response.py +92 -0
  254. immich/client/models/shared_links_update.py +85 -0
  255. immich/client/models/sign_up_dto.py +90 -0
  256. immich/client/models/smart_search_dto.py +245 -0
  257. immich/client/models/source_type.py +35 -0
  258. immich/client/models/stack_create_dto.py +86 -0
  259. immich/client/models/stack_response_dto.py +100 -0
  260. immich/client/models/stack_update_dto.py +83 -0
  261. immich/client/models/statistics_search_dto.py +217 -0
  262. immich/client/models/sync_ack_delete_dto.py +83 -0
  263. immich/client/models/sync_ack_dto.py +84 -0
  264. immich/client/models/sync_ack_set_dto.py +83 -0
  265. immich/client/models/sync_album_delete_v1.py +82 -0
  266. immich/client/models/sync_album_to_asset_delete_v1.py +85 -0
  267. immich/client/models/sync_album_to_asset_v1.py +85 -0
  268. immich/client/models/sync_album_user_delete_v1.py +85 -0
  269. immich/client/models/sync_album_user_v1.py +91 -0
  270. immich/client/models/sync_album_v1.py +122 -0
  271. immich/client/models/sync_asset_delete_v1.py +82 -0
  272. immich/client/models/sync_asset_exif_v1.py +296 -0
  273. immich/client/models/sync_asset_face_delete_v1.py +82 -0
  274. immich/client/models/sync_asset_face_v1.py +120 -0
  275. immich/client/models/sync_asset_metadata_delete_v1.py +86 -0
  276. immich/client/models/sync_asset_metadata_v1.py +91 -0
  277. immich/client/models/sync_asset_v1.py +187 -0
  278. immich/client/models/sync_auth_user_v1.py +154 -0
  279. immich/client/models/sync_entity_type.py +79 -0
  280. immich/client/models/sync_memory_asset_delete_v1.py +85 -0
  281. immich/client/models/sync_memory_asset_v1.py +85 -0
  282. immich/client/models/sync_memory_delete_v1.py +82 -0
  283. immich/client/models/sync_memory_v1.py +143 -0
  284. immich/client/models/sync_partner_delete_v1.py +88 -0
  285. immich/client/models/sync_partner_v1.py +90 -0
  286. immich/client/models/sync_person_delete_v1.py +82 -0
  287. immich/client/models/sync_person_v1.py +131 -0
  288. immich/client/models/sync_request_type.py +52 -0
  289. immich/client/models/sync_stack_delete_v1.py +82 -0
  290. immich/client/models/sync_stack_v1.py +101 -0
  291. immich/client/models/sync_stream_dto.py +86 -0
  292. immich/client/models/sync_user_delete_v1.py +82 -0
  293. immich/client/models/sync_user_metadata_delete_v1.py +84 -0
  294. immich/client/models/sync_user_metadata_v1.py +91 -0
  295. immich/client/models/sync_user_v1.py +118 -0
  296. immich/client/models/system_config_backups_dto.py +92 -0
  297. immich/client/models/system_config_dto.py +302 -0
  298. immich/client/models/system_config_f_fmpeg_dto.py +156 -0
  299. immich/client/models/system_config_faces_dto.py +82 -0
  300. immich/client/models/system_config_generated_fullsize_image_dto.py +92 -0
  301. immich/client/models/system_config_generated_image_dto.py +92 -0
  302. immich/client/models/system_config_image_dto.py +124 -0
  303. immich/client/models/system_config_job_dto.py +194 -0
  304. immich/client/models/system_config_library_dto.py +104 -0
  305. immich/client/models/system_config_library_scan_dto.py +85 -0
  306. immich/client/models/system_config_library_watch_dto.py +82 -0
  307. immich/client/models/system_config_logging_dto.py +86 -0
  308. immich/client/models/system_config_machine_learning_dto.py +147 -0
  309. immich/client/models/system_config_map_dto.py +90 -0
  310. immich/client/models/system_config_metadata_dto.py +92 -0
  311. immich/client/models/system_config_new_version_check_dto.py +82 -0
  312. immich/client/models/system_config_nightly_tasks_dto.py +103 -0
  313. immich/client/models/system_config_notifications_dto.py +92 -0
  314. immich/client/models/system_config_o_auth_dto.py +155 -0
  315. immich/client/models/system_config_password_login_dto.py +82 -0
  316. immich/client/models/system_config_reverse_geocoding_dto.py +82 -0
  317. immich/client/models/system_config_server_dto.py +94 -0
  318. immich/client/models/system_config_smtp_dto.py +100 -0
  319. immich/client/models/system_config_smtp_transport_dto.py +107 -0
  320. immich/client/models/system_config_storage_template_dto.py +94 -0
  321. immich/client/models/system_config_template_emails_dto.py +94 -0
  322. immich/client/models/system_config_template_storage_option_dto.py +109 -0
  323. immich/client/models/system_config_templates_dto.py +94 -0
  324. immich/client/models/system_config_theme_dto.py +82 -0
  325. immich/client/models/system_config_trash_dto.py +86 -0
  326. immich/client/models/system_config_user_dto.py +83 -0
  327. immich/client/models/tag_bulk_assets_dto.py +86 -0
  328. immich/client/models/tag_bulk_assets_response_dto.py +82 -0
  329. immich/client/models/tag_create_dto.py +111 -0
  330. immich/client/models/tag_response_dto.py +107 -0
  331. immich/client/models/tag_update_dto.py +87 -0
  332. immich/client/models/tag_upsert_dto.py +82 -0
  333. immich/client/models/tags_response.py +92 -0
  334. immich/client/models/tags_update.py +85 -0
  335. immich/client/models/template_dto.py +82 -0
  336. immich/client/models/template_response_dto.py +83 -0
  337. immich/client/models/test_email_response_dto.py +82 -0
  338. immich/client/models/time_bucket_asset_response_dto.py +195 -0
  339. immich/client/models/time_buckets_response_dto.py +88 -0
  340. immich/client/models/tone_mapping.py +36 -0
  341. immich/client/models/transcode_hw_accel.py +37 -0
  342. immich/client/models/transcode_policy.py +37 -0
  343. immich/client/models/trash_response_dto.py +82 -0
  344. immich/client/models/update_album_dto.py +106 -0
  345. immich/client/models/update_album_user_dto.py +83 -0
  346. immich/client/models/update_asset_dto.py +135 -0
  347. immich/client/models/update_library_dto.py +95 -0
  348. immich/client/models/usage_by_user_dto.py +117 -0
  349. immich/client/models/user_admin_create_dto.py +136 -0
  350. immich/client/models/user_admin_delete_dto.py +82 -0
  351. immich/client/models/user_admin_response_dto.py +176 -0
  352. immich/client/models/user_admin_update_dto.py +141 -0
  353. immich/client/models/user_avatar_color.py +42 -0
  354. immich/client/models/user_license.py +91 -0
  355. immich/client/models/user_metadata_key.py +35 -0
  356. immich/client/models/user_preferences_response_dto.py +186 -0
  357. immich/client/models/user_preferences_update_dto.py +197 -0
  358. immich/client/models/user_response_dto.py +105 -0
  359. immich/client/models/user_status.py +35 -0
  360. immich/client/models/user_update_me_dto.py +98 -0
  361. immich/client/models/validate_access_token_response_dto.py +82 -0
  362. immich/client/models/validate_library_dto.py +93 -0
  363. immich/client/models/validate_library_import_path_response_dto.py +92 -0
  364. immich/client/models/validate_library_response_dto.py +103 -0
  365. immich/client/models/version_check_state_response_dto.py +98 -0
  366. immich/client/models/video_codec.py +36 -0
  367. immich/client/models/video_container.py +36 -0
  368. immich/client/models/workflow_action_item_dto.py +89 -0
  369. immich/client/models/workflow_action_response_dto.py +105 -0
  370. immich/client/models/workflow_create_dto.py +128 -0
  371. immich/client/models/workflow_filter_item_dto.py +89 -0
  372. immich/client/models/workflow_filter_response_dto.py +105 -0
  373. immich/client/models/workflow_response_dto.py +144 -0
  374. immich/client/models/workflow_update_dto.py +128 -0
  375. immich/client/py.typed +0 -0
  376. immich/client/rest.py +199 -0
  377. immich/client_wrapper/__init__.py +15 -0
  378. immich/client_wrapper/assets_api_wrapped.py +87 -0
  379. immich/client_wrapper/download_api_wrapped.py +111 -0
  380. immich/client_wrapper/users_api_wrapped.py +41 -0
  381. immich/py.typed +0 -0
  382. immich/sdk.py +365 -0
  383. immich/utils.py +100 -0
  384. immich-1.2.1.dist-info/METADATA +166 -0
  385. immich-1.2.1.dist-info/RECORD +387 -0
  386. immich-1.2.1.dist-info/WHEEL +4 -0
  387. immich-1.2.1.dist-info/licenses/LICENSE +9 -0
@@ -0,0 +1,964 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Immich
5
+
6
+ Immich API
7
+
8
+ The version of the OpenAPI document: 2.4.1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
15
+ from typing import Any, Dict, List, Optional, Tuple, Union
16
+ from typing_extensions import Annotated
17
+
18
+ from immich.client.models.admin_onboarding_update_dto import AdminOnboardingUpdateDto
19
+ from immich.client.models.reverse_geocoding_state_response_dto import (
20
+ ReverseGeocodingStateResponseDto,
21
+ )
22
+ from immich.client.models.version_check_state_response_dto import (
23
+ VersionCheckStateResponseDto,
24
+ )
25
+
26
+ from immich.client.api_client import ApiClient, RequestSerialized
27
+ from immich.client.api_response import ApiResponse
28
+ from immich.client.rest import RESTResponseType
29
+
30
+
31
+ class SystemMetadataApi:
32
+ """NOTE: This class is auto generated by OpenAPI Generator
33
+ Ref: https://openapi-generator.tech
34
+
35
+ Do not edit the class manually.
36
+ """
37
+
38
+ def __init__(self, api_client=None) -> None:
39
+ if api_client is None:
40
+ api_client = ApiClient.get_default()
41
+ self.api_client = api_client
42
+
43
+ @validate_call
44
+ async def get_admin_onboarding(
45
+ self,
46
+ _request_timeout: Union[
47
+ None,
48
+ Annotated[StrictFloat, Field(gt=0)],
49
+ Tuple[
50
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
51
+ ],
52
+ ] = None,
53
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
54
+ _content_type: Optional[StrictStr] = None,
55
+ _headers: Optional[Dict[StrictStr, Any]] = None,
56
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
57
+ ) -> AdminOnboardingUpdateDto:
58
+ """Retrieve admin onboarding
59
+
60
+ Retrieve the current admin onboarding status.
61
+
62
+ :param _request_timeout: timeout setting for this request. If one
63
+ number provided, it will be total request
64
+ timeout. It can also be a pair (tuple) of
65
+ (connection, read) timeouts.
66
+ :type _request_timeout: int, tuple(int, int), optional
67
+ :param _request_auth: set to override the auth_settings for an a single
68
+ request; this effectively ignores the
69
+ authentication in the spec for a single request.
70
+ :type _request_auth: dict, optional
71
+ :param _content_type: force content-type for the request.
72
+ :type _content_type: str, Optional
73
+ :param _headers: set to override the headers for a single
74
+ request; this effectively ignores the headers
75
+ in the spec for a single request.
76
+ :type _headers: dict, optional
77
+ :param _host_index: set to override the host_index for a single
78
+ request; this effectively ignores the host_index
79
+ in the spec for a single request.
80
+ :type _host_index: int, optional
81
+ :return: Returns the result object.
82
+ """ # noqa: E501
83
+
84
+ _param = self._get_admin_onboarding_serialize(
85
+ _request_auth=_request_auth,
86
+ _content_type=_content_type,
87
+ _headers=_headers,
88
+ _host_index=_host_index,
89
+ )
90
+
91
+ _response_types_map: Dict[str, Optional[str]] = {
92
+ "200": "AdminOnboardingUpdateDto",
93
+ }
94
+ response_data = await self.api_client.call_api(
95
+ *_param, _request_timeout=_request_timeout
96
+ )
97
+ await response_data.read()
98
+ return self.api_client.response_deserialize(
99
+ response_data=response_data,
100
+ response_types_map=_response_types_map,
101
+ ).data
102
+
103
+ @validate_call
104
+ async def get_admin_onboarding_with_http_info(
105
+ self,
106
+ _request_timeout: Union[
107
+ None,
108
+ Annotated[StrictFloat, Field(gt=0)],
109
+ Tuple[
110
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
111
+ ],
112
+ ] = None,
113
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
114
+ _content_type: Optional[StrictStr] = None,
115
+ _headers: Optional[Dict[StrictStr, Any]] = None,
116
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
117
+ ) -> ApiResponse[AdminOnboardingUpdateDto]:
118
+ """Retrieve admin onboarding
119
+
120
+ Retrieve the current admin onboarding status.
121
+
122
+ :param _request_timeout: timeout setting for this request. If one
123
+ number provided, it will be total request
124
+ timeout. It can also be a pair (tuple) of
125
+ (connection, read) timeouts.
126
+ :type _request_timeout: int, tuple(int, int), optional
127
+ :param _request_auth: set to override the auth_settings for an a single
128
+ request; this effectively ignores the
129
+ authentication in the spec for a single request.
130
+ :type _request_auth: dict, optional
131
+ :param _content_type: force content-type for the request.
132
+ :type _content_type: str, Optional
133
+ :param _headers: set to override the headers for a single
134
+ request; this effectively ignores the headers
135
+ in the spec for a single request.
136
+ :type _headers: dict, optional
137
+ :param _host_index: set to override the host_index for a single
138
+ request; this effectively ignores the host_index
139
+ in the spec for a single request.
140
+ :type _host_index: int, optional
141
+ :return: Returns the result object.
142
+ """ # noqa: E501
143
+
144
+ _param = self._get_admin_onboarding_serialize(
145
+ _request_auth=_request_auth,
146
+ _content_type=_content_type,
147
+ _headers=_headers,
148
+ _host_index=_host_index,
149
+ )
150
+
151
+ _response_types_map: Dict[str, Optional[str]] = {
152
+ "200": "AdminOnboardingUpdateDto",
153
+ }
154
+ response_data = await self.api_client.call_api(
155
+ *_param, _request_timeout=_request_timeout
156
+ )
157
+ await response_data.read()
158
+ return self.api_client.response_deserialize(
159
+ response_data=response_data,
160
+ response_types_map=_response_types_map,
161
+ )
162
+
163
+ @validate_call
164
+ async def get_admin_onboarding_without_preload_content(
165
+ self,
166
+ _request_timeout: Union[
167
+ None,
168
+ Annotated[StrictFloat, Field(gt=0)],
169
+ Tuple[
170
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
171
+ ],
172
+ ] = None,
173
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
174
+ _content_type: Optional[StrictStr] = None,
175
+ _headers: Optional[Dict[StrictStr, Any]] = None,
176
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
177
+ ) -> RESTResponseType:
178
+ """Retrieve admin onboarding
179
+
180
+ Retrieve the current admin onboarding status.
181
+
182
+ :param _request_timeout: timeout setting for this request. If one
183
+ number provided, it will be total request
184
+ timeout. It can also be a pair (tuple) of
185
+ (connection, read) timeouts.
186
+ :type _request_timeout: int, tuple(int, int), optional
187
+ :param _request_auth: set to override the auth_settings for an a single
188
+ request; this effectively ignores the
189
+ authentication in the spec for a single request.
190
+ :type _request_auth: dict, optional
191
+ :param _content_type: force content-type for the request.
192
+ :type _content_type: str, Optional
193
+ :param _headers: set to override the headers for a single
194
+ request; this effectively ignores the headers
195
+ in the spec for a single request.
196
+ :type _headers: dict, optional
197
+ :param _host_index: set to override the host_index for a single
198
+ request; this effectively ignores the host_index
199
+ in the spec for a single request.
200
+ :type _host_index: int, optional
201
+ :return: Returns the result object.
202
+ """ # noqa: E501
203
+
204
+ _param = self._get_admin_onboarding_serialize(
205
+ _request_auth=_request_auth,
206
+ _content_type=_content_type,
207
+ _headers=_headers,
208
+ _host_index=_host_index,
209
+ )
210
+
211
+ _response_types_map: Dict[str, Optional[str]] = {
212
+ "200": "AdminOnboardingUpdateDto",
213
+ }
214
+ response_data = await self.api_client.call_api(
215
+ *_param, _request_timeout=_request_timeout
216
+ )
217
+ return response_data.response
218
+
219
+ def _get_admin_onboarding_serialize(
220
+ self,
221
+ _request_auth,
222
+ _content_type,
223
+ _headers,
224
+ _host_index,
225
+ ) -> RequestSerialized:
226
+ _host = None
227
+
228
+ _collection_formats: Dict[str, str] = {}
229
+
230
+ _path_params: Dict[str, str] = {}
231
+ _query_params: List[Tuple[str, str]] = []
232
+ _header_params: Dict[str, Optional[str]] = _headers or {}
233
+ _form_params: List[Tuple[str, str]] = []
234
+ _files: Dict[
235
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
236
+ ] = {}
237
+ _body_params: Optional[bytes] = None
238
+
239
+ # process the path parameters
240
+ # process the query parameters
241
+ # process the header parameters
242
+ # process the form parameters
243
+ # process the body parameter
244
+
245
+ # set the HTTP header `Accept`
246
+ if "Accept" not in _header_params:
247
+ _header_params["Accept"] = self.api_client.select_header_accept(
248
+ ["application/json"]
249
+ )
250
+
251
+ # authentication setting
252
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
253
+
254
+ return self.api_client.param_serialize(
255
+ method="GET",
256
+ resource_path="/system-metadata/admin-onboarding",
257
+ path_params=_path_params,
258
+ query_params=_query_params,
259
+ header_params=_header_params,
260
+ body=_body_params,
261
+ post_params=_form_params,
262
+ files=_files,
263
+ auth_settings=_auth_settings,
264
+ collection_formats=_collection_formats,
265
+ _host=_host,
266
+ _request_auth=_request_auth,
267
+ )
268
+
269
+ @validate_call
270
+ async def get_reverse_geocoding_state(
271
+ self,
272
+ _request_timeout: Union[
273
+ None,
274
+ Annotated[StrictFloat, Field(gt=0)],
275
+ Tuple[
276
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
277
+ ],
278
+ ] = None,
279
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
280
+ _content_type: Optional[StrictStr] = None,
281
+ _headers: Optional[Dict[StrictStr, Any]] = None,
282
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
283
+ ) -> ReverseGeocodingStateResponseDto:
284
+ """Retrieve reverse geocoding state
285
+
286
+ Retrieve the current state of the reverse geocoding import.
287
+
288
+ :param _request_timeout: timeout setting for this request. If one
289
+ number provided, it will be total request
290
+ timeout. It can also be a pair (tuple) of
291
+ (connection, read) timeouts.
292
+ :type _request_timeout: int, tuple(int, int), optional
293
+ :param _request_auth: set to override the auth_settings for an a single
294
+ request; this effectively ignores the
295
+ authentication in the spec for a single request.
296
+ :type _request_auth: dict, optional
297
+ :param _content_type: force content-type for the request.
298
+ :type _content_type: str, Optional
299
+ :param _headers: set to override the headers for a single
300
+ request; this effectively ignores the headers
301
+ in the spec for a single request.
302
+ :type _headers: dict, optional
303
+ :param _host_index: set to override the host_index for a single
304
+ request; this effectively ignores the host_index
305
+ in the spec for a single request.
306
+ :type _host_index: int, optional
307
+ :return: Returns the result object.
308
+ """ # noqa: E501
309
+
310
+ _param = self._get_reverse_geocoding_state_serialize(
311
+ _request_auth=_request_auth,
312
+ _content_type=_content_type,
313
+ _headers=_headers,
314
+ _host_index=_host_index,
315
+ )
316
+
317
+ _response_types_map: Dict[str, Optional[str]] = {
318
+ "200": "ReverseGeocodingStateResponseDto",
319
+ }
320
+ response_data = await self.api_client.call_api(
321
+ *_param, _request_timeout=_request_timeout
322
+ )
323
+ await response_data.read()
324
+ return self.api_client.response_deserialize(
325
+ response_data=response_data,
326
+ response_types_map=_response_types_map,
327
+ ).data
328
+
329
+ @validate_call
330
+ async def get_reverse_geocoding_state_with_http_info(
331
+ self,
332
+ _request_timeout: Union[
333
+ None,
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Tuple[
336
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
337
+ ],
338
+ ] = None,
339
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
340
+ _content_type: Optional[StrictStr] = None,
341
+ _headers: Optional[Dict[StrictStr, Any]] = None,
342
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
343
+ ) -> ApiResponse[ReverseGeocodingStateResponseDto]:
344
+ """Retrieve reverse geocoding state
345
+
346
+ Retrieve the current state of the reverse geocoding import.
347
+
348
+ :param _request_timeout: timeout setting for this request. If one
349
+ number provided, it will be total request
350
+ timeout. It can also be a pair (tuple) of
351
+ (connection, read) timeouts.
352
+ :type _request_timeout: int, tuple(int, int), optional
353
+ :param _request_auth: set to override the auth_settings for an a single
354
+ request; this effectively ignores the
355
+ authentication in the spec for a single request.
356
+ :type _request_auth: dict, optional
357
+ :param _content_type: force content-type for the request.
358
+ :type _content_type: str, Optional
359
+ :param _headers: set to override the headers for a single
360
+ request; this effectively ignores the headers
361
+ in the spec for a single request.
362
+ :type _headers: dict, optional
363
+ :param _host_index: set to override the host_index for a single
364
+ request; this effectively ignores the host_index
365
+ in the spec for a single request.
366
+ :type _host_index: int, optional
367
+ :return: Returns the result object.
368
+ """ # noqa: E501
369
+
370
+ _param = self._get_reverse_geocoding_state_serialize(
371
+ _request_auth=_request_auth,
372
+ _content_type=_content_type,
373
+ _headers=_headers,
374
+ _host_index=_host_index,
375
+ )
376
+
377
+ _response_types_map: Dict[str, Optional[str]] = {
378
+ "200": "ReverseGeocodingStateResponseDto",
379
+ }
380
+ response_data = await self.api_client.call_api(
381
+ *_param, _request_timeout=_request_timeout
382
+ )
383
+ await response_data.read()
384
+ return self.api_client.response_deserialize(
385
+ response_data=response_data,
386
+ response_types_map=_response_types_map,
387
+ )
388
+
389
+ @validate_call
390
+ async def get_reverse_geocoding_state_without_preload_content(
391
+ self,
392
+ _request_timeout: Union[
393
+ None,
394
+ Annotated[StrictFloat, Field(gt=0)],
395
+ Tuple[
396
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
397
+ ],
398
+ ] = None,
399
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
400
+ _content_type: Optional[StrictStr] = None,
401
+ _headers: Optional[Dict[StrictStr, Any]] = None,
402
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
403
+ ) -> RESTResponseType:
404
+ """Retrieve reverse geocoding state
405
+
406
+ Retrieve the current state of the reverse geocoding import.
407
+
408
+ :param _request_timeout: timeout setting for this request. If one
409
+ number provided, it will be total request
410
+ timeout. It can also be a pair (tuple) of
411
+ (connection, read) timeouts.
412
+ :type _request_timeout: int, tuple(int, int), optional
413
+ :param _request_auth: set to override the auth_settings for an a single
414
+ request; this effectively ignores the
415
+ authentication in the spec for a single request.
416
+ :type _request_auth: dict, optional
417
+ :param _content_type: force content-type for the request.
418
+ :type _content_type: str, Optional
419
+ :param _headers: set to override the headers for a single
420
+ request; this effectively ignores the headers
421
+ in the spec for a single request.
422
+ :type _headers: dict, optional
423
+ :param _host_index: set to override the host_index for a single
424
+ request; this effectively ignores the host_index
425
+ in the spec for a single request.
426
+ :type _host_index: int, optional
427
+ :return: Returns the result object.
428
+ """ # noqa: E501
429
+
430
+ _param = self._get_reverse_geocoding_state_serialize(
431
+ _request_auth=_request_auth,
432
+ _content_type=_content_type,
433
+ _headers=_headers,
434
+ _host_index=_host_index,
435
+ )
436
+
437
+ _response_types_map: Dict[str, Optional[str]] = {
438
+ "200": "ReverseGeocodingStateResponseDto",
439
+ }
440
+ response_data = await self.api_client.call_api(
441
+ *_param, _request_timeout=_request_timeout
442
+ )
443
+ return response_data.response
444
+
445
+ def _get_reverse_geocoding_state_serialize(
446
+ self,
447
+ _request_auth,
448
+ _content_type,
449
+ _headers,
450
+ _host_index,
451
+ ) -> RequestSerialized:
452
+ _host = None
453
+
454
+ _collection_formats: Dict[str, str] = {}
455
+
456
+ _path_params: Dict[str, str] = {}
457
+ _query_params: List[Tuple[str, str]] = []
458
+ _header_params: Dict[str, Optional[str]] = _headers or {}
459
+ _form_params: List[Tuple[str, str]] = []
460
+ _files: Dict[
461
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
462
+ ] = {}
463
+ _body_params: Optional[bytes] = None
464
+
465
+ # process the path parameters
466
+ # process the query parameters
467
+ # process the header parameters
468
+ # process the form parameters
469
+ # process the body parameter
470
+
471
+ # set the HTTP header `Accept`
472
+ if "Accept" not in _header_params:
473
+ _header_params["Accept"] = self.api_client.select_header_accept(
474
+ ["application/json"]
475
+ )
476
+
477
+ # authentication setting
478
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
479
+
480
+ return self.api_client.param_serialize(
481
+ method="GET",
482
+ resource_path="/system-metadata/reverse-geocoding-state",
483
+ path_params=_path_params,
484
+ query_params=_query_params,
485
+ header_params=_header_params,
486
+ body=_body_params,
487
+ post_params=_form_params,
488
+ files=_files,
489
+ auth_settings=_auth_settings,
490
+ collection_formats=_collection_formats,
491
+ _host=_host,
492
+ _request_auth=_request_auth,
493
+ )
494
+
495
+ @validate_call
496
+ async def get_version_check_state(
497
+ self,
498
+ _request_timeout: Union[
499
+ None,
500
+ Annotated[StrictFloat, Field(gt=0)],
501
+ Tuple[
502
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
503
+ ],
504
+ ] = None,
505
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
506
+ _content_type: Optional[StrictStr] = None,
507
+ _headers: Optional[Dict[StrictStr, Any]] = None,
508
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
509
+ ) -> VersionCheckStateResponseDto:
510
+ """Retrieve version check state
511
+
512
+ Retrieve the current state of the version check process.
513
+
514
+ :param _request_timeout: timeout setting for this request. If one
515
+ number provided, it will be total request
516
+ timeout. It can also be a pair (tuple) of
517
+ (connection, read) timeouts.
518
+ :type _request_timeout: int, tuple(int, int), optional
519
+ :param _request_auth: set to override the auth_settings for an a single
520
+ request; this effectively ignores the
521
+ authentication in the spec for a single request.
522
+ :type _request_auth: dict, optional
523
+ :param _content_type: force content-type for the request.
524
+ :type _content_type: str, Optional
525
+ :param _headers: set to override the headers for a single
526
+ request; this effectively ignores the headers
527
+ in the spec for a single request.
528
+ :type _headers: dict, optional
529
+ :param _host_index: set to override the host_index for a single
530
+ request; this effectively ignores the host_index
531
+ in the spec for a single request.
532
+ :type _host_index: int, optional
533
+ :return: Returns the result object.
534
+ """ # noqa: E501
535
+
536
+ _param = self._get_version_check_state_serialize(
537
+ _request_auth=_request_auth,
538
+ _content_type=_content_type,
539
+ _headers=_headers,
540
+ _host_index=_host_index,
541
+ )
542
+
543
+ _response_types_map: Dict[str, Optional[str]] = {
544
+ "200": "VersionCheckStateResponseDto",
545
+ }
546
+ response_data = await self.api_client.call_api(
547
+ *_param, _request_timeout=_request_timeout
548
+ )
549
+ await response_data.read()
550
+ return self.api_client.response_deserialize(
551
+ response_data=response_data,
552
+ response_types_map=_response_types_map,
553
+ ).data
554
+
555
+ @validate_call
556
+ async def get_version_check_state_with_http_info(
557
+ self,
558
+ _request_timeout: Union[
559
+ None,
560
+ Annotated[StrictFloat, Field(gt=0)],
561
+ Tuple[
562
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
563
+ ],
564
+ ] = None,
565
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
566
+ _content_type: Optional[StrictStr] = None,
567
+ _headers: Optional[Dict[StrictStr, Any]] = None,
568
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
569
+ ) -> ApiResponse[VersionCheckStateResponseDto]:
570
+ """Retrieve version check state
571
+
572
+ Retrieve the current state of the version check process.
573
+
574
+ :param _request_timeout: timeout setting for this request. If one
575
+ number provided, it will be total request
576
+ timeout. It can also be a pair (tuple) of
577
+ (connection, read) timeouts.
578
+ :type _request_timeout: int, tuple(int, int), optional
579
+ :param _request_auth: set to override the auth_settings for an a single
580
+ request; this effectively ignores the
581
+ authentication in the spec for a single request.
582
+ :type _request_auth: dict, optional
583
+ :param _content_type: force content-type for the request.
584
+ :type _content_type: str, Optional
585
+ :param _headers: set to override the headers for a single
586
+ request; this effectively ignores the headers
587
+ in the spec for a single request.
588
+ :type _headers: dict, optional
589
+ :param _host_index: set to override the host_index for a single
590
+ request; this effectively ignores the host_index
591
+ in the spec for a single request.
592
+ :type _host_index: int, optional
593
+ :return: Returns the result object.
594
+ """ # noqa: E501
595
+
596
+ _param = self._get_version_check_state_serialize(
597
+ _request_auth=_request_auth,
598
+ _content_type=_content_type,
599
+ _headers=_headers,
600
+ _host_index=_host_index,
601
+ )
602
+
603
+ _response_types_map: Dict[str, Optional[str]] = {
604
+ "200": "VersionCheckStateResponseDto",
605
+ }
606
+ response_data = await self.api_client.call_api(
607
+ *_param, _request_timeout=_request_timeout
608
+ )
609
+ await response_data.read()
610
+ return self.api_client.response_deserialize(
611
+ response_data=response_data,
612
+ response_types_map=_response_types_map,
613
+ )
614
+
615
+ @validate_call
616
+ async def get_version_check_state_without_preload_content(
617
+ self,
618
+ _request_timeout: Union[
619
+ None,
620
+ Annotated[StrictFloat, Field(gt=0)],
621
+ Tuple[
622
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
623
+ ],
624
+ ] = None,
625
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
626
+ _content_type: Optional[StrictStr] = None,
627
+ _headers: Optional[Dict[StrictStr, Any]] = None,
628
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
629
+ ) -> RESTResponseType:
630
+ """Retrieve version check state
631
+
632
+ Retrieve the current state of the version check process.
633
+
634
+ :param _request_timeout: timeout setting for this request. If one
635
+ number provided, it will be total request
636
+ timeout. It can also be a pair (tuple) of
637
+ (connection, read) timeouts.
638
+ :type _request_timeout: int, tuple(int, int), optional
639
+ :param _request_auth: set to override the auth_settings for an a single
640
+ request; this effectively ignores the
641
+ authentication in the spec for a single request.
642
+ :type _request_auth: dict, optional
643
+ :param _content_type: force content-type for the request.
644
+ :type _content_type: str, Optional
645
+ :param _headers: set to override the headers for a single
646
+ request; this effectively ignores the headers
647
+ in the spec for a single request.
648
+ :type _headers: dict, optional
649
+ :param _host_index: set to override the host_index for a single
650
+ request; this effectively ignores the host_index
651
+ in the spec for a single request.
652
+ :type _host_index: int, optional
653
+ :return: Returns the result object.
654
+ """ # noqa: E501
655
+
656
+ _param = self._get_version_check_state_serialize(
657
+ _request_auth=_request_auth,
658
+ _content_type=_content_type,
659
+ _headers=_headers,
660
+ _host_index=_host_index,
661
+ )
662
+
663
+ _response_types_map: Dict[str, Optional[str]] = {
664
+ "200": "VersionCheckStateResponseDto",
665
+ }
666
+ response_data = await self.api_client.call_api(
667
+ *_param, _request_timeout=_request_timeout
668
+ )
669
+ return response_data.response
670
+
671
+ def _get_version_check_state_serialize(
672
+ self,
673
+ _request_auth,
674
+ _content_type,
675
+ _headers,
676
+ _host_index,
677
+ ) -> RequestSerialized:
678
+ _host = None
679
+
680
+ _collection_formats: Dict[str, str] = {}
681
+
682
+ _path_params: Dict[str, str] = {}
683
+ _query_params: List[Tuple[str, str]] = []
684
+ _header_params: Dict[str, Optional[str]] = _headers or {}
685
+ _form_params: List[Tuple[str, str]] = []
686
+ _files: Dict[
687
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
688
+ ] = {}
689
+ _body_params: Optional[bytes] = None
690
+
691
+ # process the path parameters
692
+ # process the query parameters
693
+ # process the header parameters
694
+ # process the form parameters
695
+ # process the body parameter
696
+
697
+ # set the HTTP header `Accept`
698
+ if "Accept" not in _header_params:
699
+ _header_params["Accept"] = self.api_client.select_header_accept(
700
+ ["application/json"]
701
+ )
702
+
703
+ # authentication setting
704
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
705
+
706
+ return self.api_client.param_serialize(
707
+ method="GET",
708
+ resource_path="/system-metadata/version-check-state",
709
+ path_params=_path_params,
710
+ query_params=_query_params,
711
+ header_params=_header_params,
712
+ body=_body_params,
713
+ post_params=_form_params,
714
+ files=_files,
715
+ auth_settings=_auth_settings,
716
+ collection_formats=_collection_formats,
717
+ _host=_host,
718
+ _request_auth=_request_auth,
719
+ )
720
+
721
+ @validate_call
722
+ async def update_admin_onboarding(
723
+ self,
724
+ admin_onboarding_update_dto: AdminOnboardingUpdateDto,
725
+ _request_timeout: Union[
726
+ None,
727
+ Annotated[StrictFloat, Field(gt=0)],
728
+ Tuple[
729
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
730
+ ],
731
+ ] = None,
732
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
733
+ _content_type: Optional[StrictStr] = None,
734
+ _headers: Optional[Dict[StrictStr, Any]] = None,
735
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
736
+ ) -> None:
737
+ """Update admin onboarding
738
+
739
+ Update the admin onboarding status.
740
+
741
+ :param admin_onboarding_update_dto: (required)
742
+ :type admin_onboarding_update_dto: AdminOnboardingUpdateDto
743
+ :param _request_timeout: timeout setting for this request. If one
744
+ number provided, it will be total request
745
+ timeout. It can also be a pair (tuple) of
746
+ (connection, read) timeouts.
747
+ :type _request_timeout: int, tuple(int, int), optional
748
+ :param _request_auth: set to override the auth_settings for an a single
749
+ request; this effectively ignores the
750
+ authentication in the spec for a single request.
751
+ :type _request_auth: dict, optional
752
+ :param _content_type: force content-type for the request.
753
+ :type _content_type: str, Optional
754
+ :param _headers: set to override the headers for a single
755
+ request; this effectively ignores the headers
756
+ in the spec for a single request.
757
+ :type _headers: dict, optional
758
+ :param _host_index: set to override the host_index for a single
759
+ request; this effectively ignores the host_index
760
+ in the spec for a single request.
761
+ :type _host_index: int, optional
762
+ :return: Returns the result object.
763
+ """ # noqa: E501
764
+
765
+ _param = self._update_admin_onboarding_serialize(
766
+ admin_onboarding_update_dto=admin_onboarding_update_dto,
767
+ _request_auth=_request_auth,
768
+ _content_type=_content_type,
769
+ _headers=_headers,
770
+ _host_index=_host_index,
771
+ )
772
+
773
+ _response_types_map: Dict[str, Optional[str]] = {
774
+ "204": None,
775
+ }
776
+ response_data = await self.api_client.call_api(
777
+ *_param, _request_timeout=_request_timeout
778
+ )
779
+ await response_data.read()
780
+ return self.api_client.response_deserialize(
781
+ response_data=response_data,
782
+ response_types_map=_response_types_map,
783
+ ).data
784
+
785
+ @validate_call
786
+ async def update_admin_onboarding_with_http_info(
787
+ self,
788
+ admin_onboarding_update_dto: AdminOnboardingUpdateDto,
789
+ _request_timeout: Union[
790
+ None,
791
+ Annotated[StrictFloat, Field(gt=0)],
792
+ Tuple[
793
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
794
+ ],
795
+ ] = None,
796
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
797
+ _content_type: Optional[StrictStr] = None,
798
+ _headers: Optional[Dict[StrictStr, Any]] = None,
799
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
800
+ ) -> ApiResponse[None]:
801
+ """Update admin onboarding
802
+
803
+ Update the admin onboarding status.
804
+
805
+ :param admin_onboarding_update_dto: (required)
806
+ :type admin_onboarding_update_dto: AdminOnboardingUpdateDto
807
+ :param _request_timeout: timeout setting for this request. If one
808
+ number provided, it will be total request
809
+ timeout. It can also be a pair (tuple) of
810
+ (connection, read) timeouts.
811
+ :type _request_timeout: int, tuple(int, int), optional
812
+ :param _request_auth: set to override the auth_settings for an a single
813
+ request; this effectively ignores the
814
+ authentication in the spec for a single request.
815
+ :type _request_auth: dict, optional
816
+ :param _content_type: force content-type for the request.
817
+ :type _content_type: str, Optional
818
+ :param _headers: set to override the headers for a single
819
+ request; this effectively ignores the headers
820
+ in the spec for a single request.
821
+ :type _headers: dict, optional
822
+ :param _host_index: set to override the host_index for a single
823
+ request; this effectively ignores the host_index
824
+ in the spec for a single request.
825
+ :type _host_index: int, optional
826
+ :return: Returns the result object.
827
+ """ # noqa: E501
828
+
829
+ _param = self._update_admin_onboarding_serialize(
830
+ admin_onboarding_update_dto=admin_onboarding_update_dto,
831
+ _request_auth=_request_auth,
832
+ _content_type=_content_type,
833
+ _headers=_headers,
834
+ _host_index=_host_index,
835
+ )
836
+
837
+ _response_types_map: Dict[str, Optional[str]] = {
838
+ "204": None,
839
+ }
840
+ response_data = await self.api_client.call_api(
841
+ *_param, _request_timeout=_request_timeout
842
+ )
843
+ await response_data.read()
844
+ return self.api_client.response_deserialize(
845
+ response_data=response_data,
846
+ response_types_map=_response_types_map,
847
+ )
848
+
849
+ @validate_call
850
+ async def update_admin_onboarding_without_preload_content(
851
+ self,
852
+ admin_onboarding_update_dto: AdminOnboardingUpdateDto,
853
+ _request_timeout: Union[
854
+ None,
855
+ Annotated[StrictFloat, Field(gt=0)],
856
+ Tuple[
857
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
858
+ ],
859
+ ] = None,
860
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
861
+ _content_type: Optional[StrictStr] = None,
862
+ _headers: Optional[Dict[StrictStr, Any]] = None,
863
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
864
+ ) -> RESTResponseType:
865
+ """Update admin onboarding
866
+
867
+ Update the admin onboarding status.
868
+
869
+ :param admin_onboarding_update_dto: (required)
870
+ :type admin_onboarding_update_dto: AdminOnboardingUpdateDto
871
+ :param _request_timeout: timeout setting for this request. If one
872
+ number provided, it will be total request
873
+ timeout. It can also be a pair (tuple) of
874
+ (connection, read) timeouts.
875
+ :type _request_timeout: int, tuple(int, int), optional
876
+ :param _request_auth: set to override the auth_settings for an a single
877
+ request; this effectively ignores the
878
+ authentication in the spec for a single request.
879
+ :type _request_auth: dict, optional
880
+ :param _content_type: force content-type for the request.
881
+ :type _content_type: str, Optional
882
+ :param _headers: set to override the headers for a single
883
+ request; this effectively ignores the headers
884
+ in the spec for a single request.
885
+ :type _headers: dict, optional
886
+ :param _host_index: set to override the host_index for a single
887
+ request; this effectively ignores the host_index
888
+ in the spec for a single request.
889
+ :type _host_index: int, optional
890
+ :return: Returns the result object.
891
+ """ # noqa: E501
892
+
893
+ _param = self._update_admin_onboarding_serialize(
894
+ admin_onboarding_update_dto=admin_onboarding_update_dto,
895
+ _request_auth=_request_auth,
896
+ _content_type=_content_type,
897
+ _headers=_headers,
898
+ _host_index=_host_index,
899
+ )
900
+
901
+ _response_types_map: Dict[str, Optional[str]] = {
902
+ "204": None,
903
+ }
904
+ response_data = await self.api_client.call_api(
905
+ *_param, _request_timeout=_request_timeout
906
+ )
907
+ return response_data.response
908
+
909
+ def _update_admin_onboarding_serialize(
910
+ self,
911
+ admin_onboarding_update_dto,
912
+ _request_auth,
913
+ _content_type,
914
+ _headers,
915
+ _host_index,
916
+ ) -> RequestSerialized:
917
+ _host = None
918
+
919
+ _collection_formats: Dict[str, str] = {}
920
+
921
+ _path_params: Dict[str, str] = {}
922
+ _query_params: List[Tuple[str, str]] = []
923
+ _header_params: Dict[str, Optional[str]] = _headers or {}
924
+ _form_params: List[Tuple[str, str]] = []
925
+ _files: Dict[
926
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
927
+ ] = {}
928
+ _body_params: Optional[bytes] = None
929
+
930
+ # process the path parameters
931
+ # process the query parameters
932
+ # process the header parameters
933
+ # process the form parameters
934
+ # process the body parameter
935
+ if admin_onboarding_update_dto is not None:
936
+ _body_params = admin_onboarding_update_dto
937
+
938
+ # set the HTTP header `Content-Type`
939
+ if _content_type:
940
+ _header_params["Content-Type"] = _content_type
941
+ else:
942
+ _default_content_type = self.api_client.select_header_content_type(
943
+ ["application/json"]
944
+ )
945
+ if _default_content_type is not None:
946
+ _header_params["Content-Type"] = _default_content_type
947
+
948
+ # authentication setting
949
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
950
+
951
+ return self.api_client.param_serialize(
952
+ method="POST",
953
+ resource_path="/system-metadata/admin-onboarding",
954
+ path_params=_path_params,
955
+ query_params=_query_params,
956
+ header_params=_header_params,
957
+ body=_body_params,
958
+ post_params=_form_params,
959
+ files=_files,
960
+ auth_settings=_auth_settings,
961
+ collection_formats=_collection_formats,
962
+ _host=_host,
963
+ _request_auth=_request_auth,
964
+ )