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,3466 @@
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.license_key_dto import LicenseKeyDto
19
+ from immich.client.models.license_response_dto import LicenseResponseDto
20
+ from immich.client.models.server_about_response_dto import ServerAboutResponseDto
21
+ from immich.client.models.server_apk_links_dto import ServerApkLinksDto
22
+ from immich.client.models.server_config_dto import ServerConfigDto
23
+ from immich.client.models.server_features_dto import ServerFeaturesDto
24
+ from immich.client.models.server_media_types_response_dto import (
25
+ ServerMediaTypesResponseDto,
26
+ )
27
+ from immich.client.models.server_ping_response import ServerPingResponse
28
+ from immich.client.models.server_stats_response_dto import ServerStatsResponseDto
29
+ from immich.client.models.server_storage_response_dto import ServerStorageResponseDto
30
+ from immich.client.models.server_theme_dto import ServerThemeDto
31
+ from immich.client.models.server_version_history_response_dto import (
32
+ ServerVersionHistoryResponseDto,
33
+ )
34
+ from immich.client.models.server_version_response_dto import ServerVersionResponseDto
35
+ from immich.client.models.version_check_state_response_dto import (
36
+ VersionCheckStateResponseDto,
37
+ )
38
+
39
+ from immich.client.api_client import ApiClient, RequestSerialized
40
+ from immich.client.api_response import ApiResponse
41
+ from immich.client.rest import RESTResponseType
42
+
43
+
44
+ class ServerApi:
45
+ """NOTE: This class is auto generated by OpenAPI Generator
46
+ Ref: https://openapi-generator.tech
47
+
48
+ Do not edit the class manually.
49
+ """
50
+
51
+ def __init__(self, api_client=None) -> None:
52
+ if api_client is None:
53
+ api_client = ApiClient.get_default()
54
+ self.api_client = api_client
55
+
56
+ @validate_call
57
+ async def delete_server_license(
58
+ self,
59
+ _request_timeout: Union[
60
+ None,
61
+ Annotated[StrictFloat, Field(gt=0)],
62
+ Tuple[
63
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
64
+ ],
65
+ ] = None,
66
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
67
+ _content_type: Optional[StrictStr] = None,
68
+ _headers: Optional[Dict[StrictStr, Any]] = None,
69
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
70
+ ) -> None:
71
+ """Delete server product key
72
+
73
+ Delete the currently set server product key.
74
+
75
+ :param _request_timeout: timeout setting for this request. If one
76
+ number provided, it will be total request
77
+ timeout. It can also be a pair (tuple) of
78
+ (connection, read) timeouts.
79
+ :type _request_timeout: int, tuple(int, int), optional
80
+ :param _request_auth: set to override the auth_settings for an a single
81
+ request; this effectively ignores the
82
+ authentication in the spec for a single request.
83
+ :type _request_auth: dict, optional
84
+ :param _content_type: force content-type for the request.
85
+ :type _content_type: str, Optional
86
+ :param _headers: set to override the headers for a single
87
+ request; this effectively ignores the headers
88
+ in the spec for a single request.
89
+ :type _headers: dict, optional
90
+ :param _host_index: set to override the host_index for a single
91
+ request; this effectively ignores the host_index
92
+ in the spec for a single request.
93
+ :type _host_index: int, optional
94
+ :return: Returns the result object.
95
+ """ # noqa: E501
96
+
97
+ _param = self._delete_server_license_serialize(
98
+ _request_auth=_request_auth,
99
+ _content_type=_content_type,
100
+ _headers=_headers,
101
+ _host_index=_host_index,
102
+ )
103
+
104
+ _response_types_map: Dict[str, Optional[str]] = {
105
+ "204": None,
106
+ }
107
+ response_data = await self.api_client.call_api(
108
+ *_param, _request_timeout=_request_timeout
109
+ )
110
+ await response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+ @validate_call
117
+ async def delete_server_license_with_http_info(
118
+ self,
119
+ _request_timeout: Union[
120
+ None,
121
+ Annotated[StrictFloat, Field(gt=0)],
122
+ Tuple[
123
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
124
+ ],
125
+ ] = None,
126
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
127
+ _content_type: Optional[StrictStr] = None,
128
+ _headers: Optional[Dict[StrictStr, Any]] = None,
129
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
130
+ ) -> ApiResponse[None]:
131
+ """Delete server product key
132
+
133
+ Delete the currently set server product key.
134
+
135
+ :param _request_timeout: timeout setting for this request. If one
136
+ number provided, it will be total request
137
+ timeout. It can also be a pair (tuple) of
138
+ (connection, read) timeouts.
139
+ :type _request_timeout: int, tuple(int, int), optional
140
+ :param _request_auth: set to override the auth_settings for an a single
141
+ request; this effectively ignores the
142
+ authentication in the spec for a single request.
143
+ :type _request_auth: dict, optional
144
+ :param _content_type: force content-type for the request.
145
+ :type _content_type: str, Optional
146
+ :param _headers: set to override the headers for a single
147
+ request; this effectively ignores the headers
148
+ in the spec for a single request.
149
+ :type _headers: dict, optional
150
+ :param _host_index: set to override the host_index for a single
151
+ request; this effectively ignores the host_index
152
+ in the spec for a single request.
153
+ :type _host_index: int, optional
154
+ :return: Returns the result object.
155
+ """ # noqa: E501
156
+
157
+ _param = self._delete_server_license_serialize(
158
+ _request_auth=_request_auth,
159
+ _content_type=_content_type,
160
+ _headers=_headers,
161
+ _host_index=_host_index,
162
+ )
163
+
164
+ _response_types_map: Dict[str, Optional[str]] = {
165
+ "204": None,
166
+ }
167
+ response_data = await self.api_client.call_api(
168
+ *_param, _request_timeout=_request_timeout
169
+ )
170
+ await response_data.read()
171
+ return self.api_client.response_deserialize(
172
+ response_data=response_data,
173
+ response_types_map=_response_types_map,
174
+ )
175
+
176
+ @validate_call
177
+ async def delete_server_license_without_preload_content(
178
+ self,
179
+ _request_timeout: Union[
180
+ None,
181
+ Annotated[StrictFloat, Field(gt=0)],
182
+ Tuple[
183
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
184
+ ],
185
+ ] = None,
186
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
187
+ _content_type: Optional[StrictStr] = None,
188
+ _headers: Optional[Dict[StrictStr, Any]] = None,
189
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
190
+ ) -> RESTResponseType:
191
+ """Delete server product key
192
+
193
+ Delete the currently set server product key.
194
+
195
+ :param _request_timeout: timeout setting for this request. If one
196
+ number provided, it will be total request
197
+ timeout. It can also be a pair (tuple) of
198
+ (connection, read) timeouts.
199
+ :type _request_timeout: int, tuple(int, int), optional
200
+ :param _request_auth: set to override the auth_settings for an a single
201
+ request; this effectively ignores the
202
+ authentication in the spec for a single request.
203
+ :type _request_auth: dict, optional
204
+ :param _content_type: force content-type for the request.
205
+ :type _content_type: str, Optional
206
+ :param _headers: set to override the headers for a single
207
+ request; this effectively ignores the headers
208
+ in the spec for a single request.
209
+ :type _headers: dict, optional
210
+ :param _host_index: set to override the host_index for a single
211
+ request; this effectively ignores the host_index
212
+ in the spec for a single request.
213
+ :type _host_index: int, optional
214
+ :return: Returns the result object.
215
+ """ # noqa: E501
216
+
217
+ _param = self._delete_server_license_serialize(
218
+ _request_auth=_request_auth,
219
+ _content_type=_content_type,
220
+ _headers=_headers,
221
+ _host_index=_host_index,
222
+ )
223
+
224
+ _response_types_map: Dict[str, Optional[str]] = {
225
+ "204": None,
226
+ }
227
+ response_data = await self.api_client.call_api(
228
+ *_param, _request_timeout=_request_timeout
229
+ )
230
+ return response_data.response
231
+
232
+ def _delete_server_license_serialize(
233
+ self,
234
+ _request_auth,
235
+ _content_type,
236
+ _headers,
237
+ _host_index,
238
+ ) -> RequestSerialized:
239
+ _host = None
240
+
241
+ _collection_formats: Dict[str, str] = {}
242
+
243
+ _path_params: Dict[str, str] = {}
244
+ _query_params: List[Tuple[str, str]] = []
245
+ _header_params: Dict[str, Optional[str]] = _headers or {}
246
+ _form_params: List[Tuple[str, str]] = []
247
+ _files: Dict[
248
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
249
+ ] = {}
250
+ _body_params: Optional[bytes] = None
251
+
252
+ # process the path parameters
253
+ # process the query parameters
254
+ # process the header parameters
255
+ # process the form parameters
256
+ # process the body parameter
257
+
258
+ # authentication setting
259
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
260
+
261
+ return self.api_client.param_serialize(
262
+ method="DELETE",
263
+ resource_path="/server/license",
264
+ path_params=_path_params,
265
+ query_params=_query_params,
266
+ header_params=_header_params,
267
+ body=_body_params,
268
+ post_params=_form_params,
269
+ files=_files,
270
+ auth_settings=_auth_settings,
271
+ collection_formats=_collection_formats,
272
+ _host=_host,
273
+ _request_auth=_request_auth,
274
+ )
275
+
276
+ @validate_call
277
+ async def get_about_info(
278
+ self,
279
+ _request_timeout: Union[
280
+ None,
281
+ Annotated[StrictFloat, Field(gt=0)],
282
+ Tuple[
283
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
284
+ ],
285
+ ] = None,
286
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
287
+ _content_type: Optional[StrictStr] = None,
288
+ _headers: Optional[Dict[StrictStr, Any]] = None,
289
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
290
+ ) -> ServerAboutResponseDto:
291
+ """Get server information
292
+
293
+ Retrieve a list of information about the server.
294
+
295
+ :param _request_timeout: timeout setting for this request. If one
296
+ number provided, it will be total request
297
+ timeout. It can also be a pair (tuple) of
298
+ (connection, read) timeouts.
299
+ :type _request_timeout: int, tuple(int, int), optional
300
+ :param _request_auth: set to override the auth_settings for an a single
301
+ request; this effectively ignores the
302
+ authentication in the spec for a single request.
303
+ :type _request_auth: dict, optional
304
+ :param _content_type: force content-type for the request.
305
+ :type _content_type: str, Optional
306
+ :param _headers: set to override the headers for a single
307
+ request; this effectively ignores the headers
308
+ in the spec for a single request.
309
+ :type _headers: dict, optional
310
+ :param _host_index: set to override the host_index for a single
311
+ request; this effectively ignores the host_index
312
+ in the spec for a single request.
313
+ :type _host_index: int, optional
314
+ :return: Returns the result object.
315
+ """ # noqa: E501
316
+
317
+ _param = self._get_about_info_serialize(
318
+ _request_auth=_request_auth,
319
+ _content_type=_content_type,
320
+ _headers=_headers,
321
+ _host_index=_host_index,
322
+ )
323
+
324
+ _response_types_map: Dict[str, Optional[str]] = {
325
+ "200": "ServerAboutResponseDto",
326
+ }
327
+ response_data = await self.api_client.call_api(
328
+ *_param, _request_timeout=_request_timeout
329
+ )
330
+ await response_data.read()
331
+ return self.api_client.response_deserialize(
332
+ response_data=response_data,
333
+ response_types_map=_response_types_map,
334
+ ).data
335
+
336
+ @validate_call
337
+ async def get_about_info_with_http_info(
338
+ self,
339
+ _request_timeout: Union[
340
+ None,
341
+ Annotated[StrictFloat, Field(gt=0)],
342
+ Tuple[
343
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
344
+ ],
345
+ ] = None,
346
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
347
+ _content_type: Optional[StrictStr] = None,
348
+ _headers: Optional[Dict[StrictStr, Any]] = None,
349
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
350
+ ) -> ApiResponse[ServerAboutResponseDto]:
351
+ """Get server information
352
+
353
+ Retrieve a list of information about the server.
354
+
355
+ :param _request_timeout: timeout setting for this request. If one
356
+ number provided, it will be total request
357
+ timeout. It can also be a pair (tuple) of
358
+ (connection, read) timeouts.
359
+ :type _request_timeout: int, tuple(int, int), optional
360
+ :param _request_auth: set to override the auth_settings for an a single
361
+ request; this effectively ignores the
362
+ authentication in the spec for a single request.
363
+ :type _request_auth: dict, optional
364
+ :param _content_type: force content-type for the request.
365
+ :type _content_type: str, Optional
366
+ :param _headers: set to override the headers for a single
367
+ request; this effectively ignores the headers
368
+ in the spec for a single request.
369
+ :type _headers: dict, optional
370
+ :param _host_index: set to override the host_index for a single
371
+ request; this effectively ignores the host_index
372
+ in the spec for a single request.
373
+ :type _host_index: int, optional
374
+ :return: Returns the result object.
375
+ """ # noqa: E501
376
+
377
+ _param = self._get_about_info_serialize(
378
+ _request_auth=_request_auth,
379
+ _content_type=_content_type,
380
+ _headers=_headers,
381
+ _host_index=_host_index,
382
+ )
383
+
384
+ _response_types_map: Dict[str, Optional[str]] = {
385
+ "200": "ServerAboutResponseDto",
386
+ }
387
+ response_data = await self.api_client.call_api(
388
+ *_param, _request_timeout=_request_timeout
389
+ )
390
+ await response_data.read()
391
+ return self.api_client.response_deserialize(
392
+ response_data=response_data,
393
+ response_types_map=_response_types_map,
394
+ )
395
+
396
+ @validate_call
397
+ async def get_about_info_without_preload_content(
398
+ self,
399
+ _request_timeout: Union[
400
+ None,
401
+ Annotated[StrictFloat, Field(gt=0)],
402
+ Tuple[
403
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
404
+ ],
405
+ ] = None,
406
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
407
+ _content_type: Optional[StrictStr] = None,
408
+ _headers: Optional[Dict[StrictStr, Any]] = None,
409
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
410
+ ) -> RESTResponseType:
411
+ """Get server information
412
+
413
+ Retrieve a list of information about the server.
414
+
415
+ :param _request_timeout: timeout setting for this request. If one
416
+ number provided, it will be total request
417
+ timeout. It can also be a pair (tuple) of
418
+ (connection, read) timeouts.
419
+ :type _request_timeout: int, tuple(int, int), optional
420
+ :param _request_auth: set to override the auth_settings for an a single
421
+ request; this effectively ignores the
422
+ authentication in the spec for a single request.
423
+ :type _request_auth: dict, optional
424
+ :param _content_type: force content-type for the request.
425
+ :type _content_type: str, Optional
426
+ :param _headers: set to override the headers for a single
427
+ request; this effectively ignores the headers
428
+ in the spec for a single request.
429
+ :type _headers: dict, optional
430
+ :param _host_index: set to override the host_index for a single
431
+ request; this effectively ignores the host_index
432
+ in the spec for a single request.
433
+ :type _host_index: int, optional
434
+ :return: Returns the result object.
435
+ """ # noqa: E501
436
+
437
+ _param = self._get_about_info_serialize(
438
+ _request_auth=_request_auth,
439
+ _content_type=_content_type,
440
+ _headers=_headers,
441
+ _host_index=_host_index,
442
+ )
443
+
444
+ _response_types_map: Dict[str, Optional[str]] = {
445
+ "200": "ServerAboutResponseDto",
446
+ }
447
+ response_data = await self.api_client.call_api(
448
+ *_param, _request_timeout=_request_timeout
449
+ )
450
+ return response_data.response
451
+
452
+ def _get_about_info_serialize(
453
+ self,
454
+ _request_auth,
455
+ _content_type,
456
+ _headers,
457
+ _host_index,
458
+ ) -> RequestSerialized:
459
+ _host = None
460
+
461
+ _collection_formats: Dict[str, str] = {}
462
+
463
+ _path_params: Dict[str, str] = {}
464
+ _query_params: List[Tuple[str, str]] = []
465
+ _header_params: Dict[str, Optional[str]] = _headers or {}
466
+ _form_params: List[Tuple[str, str]] = []
467
+ _files: Dict[
468
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
469
+ ] = {}
470
+ _body_params: Optional[bytes] = None
471
+
472
+ # process the path parameters
473
+ # process the query parameters
474
+ # process the header parameters
475
+ # process the form parameters
476
+ # process the body parameter
477
+
478
+ # set the HTTP header `Accept`
479
+ if "Accept" not in _header_params:
480
+ _header_params["Accept"] = self.api_client.select_header_accept(
481
+ ["application/json"]
482
+ )
483
+
484
+ # authentication setting
485
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
486
+
487
+ return self.api_client.param_serialize(
488
+ method="GET",
489
+ resource_path="/server/about",
490
+ path_params=_path_params,
491
+ query_params=_query_params,
492
+ header_params=_header_params,
493
+ body=_body_params,
494
+ post_params=_form_params,
495
+ files=_files,
496
+ auth_settings=_auth_settings,
497
+ collection_formats=_collection_formats,
498
+ _host=_host,
499
+ _request_auth=_request_auth,
500
+ )
501
+
502
+ @validate_call
503
+ async def get_apk_links(
504
+ self,
505
+ _request_timeout: Union[
506
+ None,
507
+ Annotated[StrictFloat, Field(gt=0)],
508
+ Tuple[
509
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
510
+ ],
511
+ ] = None,
512
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
513
+ _content_type: Optional[StrictStr] = None,
514
+ _headers: Optional[Dict[StrictStr, Any]] = None,
515
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
516
+ ) -> ServerApkLinksDto:
517
+ """Get APK links
518
+
519
+ Retrieve links to the APKs for the current server version.
520
+
521
+ :param _request_timeout: timeout setting for this request. If one
522
+ number provided, it will be total request
523
+ timeout. It can also be a pair (tuple) of
524
+ (connection, read) timeouts.
525
+ :type _request_timeout: int, tuple(int, int), optional
526
+ :param _request_auth: set to override the auth_settings for an a single
527
+ request; this effectively ignores the
528
+ authentication in the spec for a single request.
529
+ :type _request_auth: dict, optional
530
+ :param _content_type: force content-type for the request.
531
+ :type _content_type: str, Optional
532
+ :param _headers: set to override the headers for a single
533
+ request; this effectively ignores the headers
534
+ in the spec for a single request.
535
+ :type _headers: dict, optional
536
+ :param _host_index: set to override the host_index for a single
537
+ request; this effectively ignores the host_index
538
+ in the spec for a single request.
539
+ :type _host_index: int, optional
540
+ :return: Returns the result object.
541
+ """ # noqa: E501
542
+
543
+ _param = self._get_apk_links_serialize(
544
+ _request_auth=_request_auth,
545
+ _content_type=_content_type,
546
+ _headers=_headers,
547
+ _host_index=_host_index,
548
+ )
549
+
550
+ _response_types_map: Dict[str, Optional[str]] = {
551
+ "200": "ServerApkLinksDto",
552
+ }
553
+ response_data = await self.api_client.call_api(
554
+ *_param, _request_timeout=_request_timeout
555
+ )
556
+ await response_data.read()
557
+ return self.api_client.response_deserialize(
558
+ response_data=response_data,
559
+ response_types_map=_response_types_map,
560
+ ).data
561
+
562
+ @validate_call
563
+ async def get_apk_links_with_http_info(
564
+ self,
565
+ _request_timeout: Union[
566
+ None,
567
+ Annotated[StrictFloat, Field(gt=0)],
568
+ Tuple[
569
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
570
+ ],
571
+ ] = None,
572
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
573
+ _content_type: Optional[StrictStr] = None,
574
+ _headers: Optional[Dict[StrictStr, Any]] = None,
575
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
576
+ ) -> ApiResponse[ServerApkLinksDto]:
577
+ """Get APK links
578
+
579
+ Retrieve links to the APKs for the current server version.
580
+
581
+ :param _request_timeout: timeout setting for this request. If one
582
+ number provided, it will be total request
583
+ timeout. It can also be a pair (tuple) of
584
+ (connection, read) timeouts.
585
+ :type _request_timeout: int, tuple(int, int), optional
586
+ :param _request_auth: set to override the auth_settings for an a single
587
+ request; this effectively ignores the
588
+ authentication in the spec for a single request.
589
+ :type _request_auth: dict, optional
590
+ :param _content_type: force content-type for the request.
591
+ :type _content_type: str, Optional
592
+ :param _headers: set to override the headers for a single
593
+ request; this effectively ignores the headers
594
+ in the spec for a single request.
595
+ :type _headers: dict, optional
596
+ :param _host_index: set to override the host_index for a single
597
+ request; this effectively ignores the host_index
598
+ in the spec for a single request.
599
+ :type _host_index: int, optional
600
+ :return: Returns the result object.
601
+ """ # noqa: E501
602
+
603
+ _param = self._get_apk_links_serialize(
604
+ _request_auth=_request_auth,
605
+ _content_type=_content_type,
606
+ _headers=_headers,
607
+ _host_index=_host_index,
608
+ )
609
+
610
+ _response_types_map: Dict[str, Optional[str]] = {
611
+ "200": "ServerApkLinksDto",
612
+ }
613
+ response_data = await self.api_client.call_api(
614
+ *_param, _request_timeout=_request_timeout
615
+ )
616
+ await response_data.read()
617
+ return self.api_client.response_deserialize(
618
+ response_data=response_data,
619
+ response_types_map=_response_types_map,
620
+ )
621
+
622
+ @validate_call
623
+ async def get_apk_links_without_preload_content(
624
+ self,
625
+ _request_timeout: Union[
626
+ None,
627
+ Annotated[StrictFloat, Field(gt=0)],
628
+ Tuple[
629
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
630
+ ],
631
+ ] = None,
632
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
633
+ _content_type: Optional[StrictStr] = None,
634
+ _headers: Optional[Dict[StrictStr, Any]] = None,
635
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
636
+ ) -> RESTResponseType:
637
+ """Get APK links
638
+
639
+ Retrieve links to the APKs for the current server version.
640
+
641
+ :param _request_timeout: timeout setting for this request. If one
642
+ number provided, it will be total request
643
+ timeout. It can also be a pair (tuple) of
644
+ (connection, read) timeouts.
645
+ :type _request_timeout: int, tuple(int, int), optional
646
+ :param _request_auth: set to override the auth_settings for an a single
647
+ request; this effectively ignores the
648
+ authentication in the spec for a single request.
649
+ :type _request_auth: dict, optional
650
+ :param _content_type: force content-type for the request.
651
+ :type _content_type: str, Optional
652
+ :param _headers: set to override the headers for a single
653
+ request; this effectively ignores the headers
654
+ in the spec for a single request.
655
+ :type _headers: dict, optional
656
+ :param _host_index: set to override the host_index for a single
657
+ request; this effectively ignores the host_index
658
+ in the spec for a single request.
659
+ :type _host_index: int, optional
660
+ :return: Returns the result object.
661
+ """ # noqa: E501
662
+
663
+ _param = self._get_apk_links_serialize(
664
+ _request_auth=_request_auth,
665
+ _content_type=_content_type,
666
+ _headers=_headers,
667
+ _host_index=_host_index,
668
+ )
669
+
670
+ _response_types_map: Dict[str, Optional[str]] = {
671
+ "200": "ServerApkLinksDto",
672
+ }
673
+ response_data = await self.api_client.call_api(
674
+ *_param, _request_timeout=_request_timeout
675
+ )
676
+ return response_data.response
677
+
678
+ def _get_apk_links_serialize(
679
+ self,
680
+ _request_auth,
681
+ _content_type,
682
+ _headers,
683
+ _host_index,
684
+ ) -> RequestSerialized:
685
+ _host = None
686
+
687
+ _collection_formats: Dict[str, str] = {}
688
+
689
+ _path_params: Dict[str, str] = {}
690
+ _query_params: List[Tuple[str, str]] = []
691
+ _header_params: Dict[str, Optional[str]] = _headers or {}
692
+ _form_params: List[Tuple[str, str]] = []
693
+ _files: Dict[
694
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
695
+ ] = {}
696
+ _body_params: Optional[bytes] = None
697
+
698
+ # process the path parameters
699
+ # process the query parameters
700
+ # process the header parameters
701
+ # process the form parameters
702
+ # process the body parameter
703
+
704
+ # set the HTTP header `Accept`
705
+ if "Accept" not in _header_params:
706
+ _header_params["Accept"] = self.api_client.select_header_accept(
707
+ ["application/json"]
708
+ )
709
+
710
+ # authentication setting
711
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
712
+
713
+ return self.api_client.param_serialize(
714
+ method="GET",
715
+ resource_path="/server/apk-links",
716
+ path_params=_path_params,
717
+ query_params=_query_params,
718
+ header_params=_header_params,
719
+ body=_body_params,
720
+ post_params=_form_params,
721
+ files=_files,
722
+ auth_settings=_auth_settings,
723
+ collection_formats=_collection_formats,
724
+ _host=_host,
725
+ _request_auth=_request_auth,
726
+ )
727
+
728
+ @validate_call
729
+ async def get_server_config(
730
+ self,
731
+ _request_timeout: Union[
732
+ None,
733
+ Annotated[StrictFloat, Field(gt=0)],
734
+ Tuple[
735
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
736
+ ],
737
+ ] = None,
738
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
739
+ _content_type: Optional[StrictStr] = None,
740
+ _headers: Optional[Dict[StrictStr, Any]] = None,
741
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
742
+ ) -> ServerConfigDto:
743
+ """Get config
744
+
745
+ Retrieve the current server configuration.
746
+
747
+ :param _request_timeout: timeout setting for this request. If one
748
+ number provided, it will be total request
749
+ timeout. It can also be a pair (tuple) of
750
+ (connection, read) timeouts.
751
+ :type _request_timeout: int, tuple(int, int), optional
752
+ :param _request_auth: set to override the auth_settings for an a single
753
+ request; this effectively ignores the
754
+ authentication in the spec for a single request.
755
+ :type _request_auth: dict, optional
756
+ :param _content_type: force content-type for the request.
757
+ :type _content_type: str, Optional
758
+ :param _headers: set to override the headers for a single
759
+ request; this effectively ignores the headers
760
+ in the spec for a single request.
761
+ :type _headers: dict, optional
762
+ :param _host_index: set to override the host_index for a single
763
+ request; this effectively ignores the host_index
764
+ in the spec for a single request.
765
+ :type _host_index: int, optional
766
+ :return: Returns the result object.
767
+ """ # noqa: E501
768
+
769
+ _param = self._get_server_config_serialize(
770
+ _request_auth=_request_auth,
771
+ _content_type=_content_type,
772
+ _headers=_headers,
773
+ _host_index=_host_index,
774
+ )
775
+
776
+ _response_types_map: Dict[str, Optional[str]] = {
777
+ "200": "ServerConfigDto",
778
+ }
779
+ response_data = await self.api_client.call_api(
780
+ *_param, _request_timeout=_request_timeout
781
+ )
782
+ await response_data.read()
783
+ return self.api_client.response_deserialize(
784
+ response_data=response_data,
785
+ response_types_map=_response_types_map,
786
+ ).data
787
+
788
+ @validate_call
789
+ async def get_server_config_with_http_info(
790
+ self,
791
+ _request_timeout: Union[
792
+ None,
793
+ Annotated[StrictFloat, Field(gt=0)],
794
+ Tuple[
795
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
796
+ ],
797
+ ] = None,
798
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
799
+ _content_type: Optional[StrictStr] = None,
800
+ _headers: Optional[Dict[StrictStr, Any]] = None,
801
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
802
+ ) -> ApiResponse[ServerConfigDto]:
803
+ """Get config
804
+
805
+ Retrieve the current server configuration.
806
+
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._get_server_config_serialize(
830
+ _request_auth=_request_auth,
831
+ _content_type=_content_type,
832
+ _headers=_headers,
833
+ _host_index=_host_index,
834
+ )
835
+
836
+ _response_types_map: Dict[str, Optional[str]] = {
837
+ "200": "ServerConfigDto",
838
+ }
839
+ response_data = await self.api_client.call_api(
840
+ *_param, _request_timeout=_request_timeout
841
+ )
842
+ await response_data.read()
843
+ return self.api_client.response_deserialize(
844
+ response_data=response_data,
845
+ response_types_map=_response_types_map,
846
+ )
847
+
848
+ @validate_call
849
+ async def get_server_config_without_preload_content(
850
+ self,
851
+ _request_timeout: Union[
852
+ None,
853
+ Annotated[StrictFloat, Field(gt=0)],
854
+ Tuple[
855
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
856
+ ],
857
+ ] = None,
858
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
859
+ _content_type: Optional[StrictStr] = None,
860
+ _headers: Optional[Dict[StrictStr, Any]] = None,
861
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
862
+ ) -> RESTResponseType:
863
+ """Get config
864
+
865
+ Retrieve the current server configuration.
866
+
867
+ :param _request_timeout: timeout setting for this request. If one
868
+ number provided, it will be total request
869
+ timeout. It can also be a pair (tuple) of
870
+ (connection, read) timeouts.
871
+ :type _request_timeout: int, tuple(int, int), optional
872
+ :param _request_auth: set to override the auth_settings for an a single
873
+ request; this effectively ignores the
874
+ authentication in the spec for a single request.
875
+ :type _request_auth: dict, optional
876
+ :param _content_type: force content-type for the request.
877
+ :type _content_type: str, Optional
878
+ :param _headers: set to override the headers for a single
879
+ request; this effectively ignores the headers
880
+ in the spec for a single request.
881
+ :type _headers: dict, optional
882
+ :param _host_index: set to override the host_index for a single
883
+ request; this effectively ignores the host_index
884
+ in the spec for a single request.
885
+ :type _host_index: int, optional
886
+ :return: Returns the result object.
887
+ """ # noqa: E501
888
+
889
+ _param = self._get_server_config_serialize(
890
+ _request_auth=_request_auth,
891
+ _content_type=_content_type,
892
+ _headers=_headers,
893
+ _host_index=_host_index,
894
+ )
895
+
896
+ _response_types_map: Dict[str, Optional[str]] = {
897
+ "200": "ServerConfigDto",
898
+ }
899
+ response_data = await self.api_client.call_api(
900
+ *_param, _request_timeout=_request_timeout
901
+ )
902
+ return response_data.response
903
+
904
+ def _get_server_config_serialize(
905
+ self,
906
+ _request_auth,
907
+ _content_type,
908
+ _headers,
909
+ _host_index,
910
+ ) -> RequestSerialized:
911
+ _host = None
912
+
913
+ _collection_formats: Dict[str, str] = {}
914
+
915
+ _path_params: Dict[str, str] = {}
916
+ _query_params: List[Tuple[str, str]] = []
917
+ _header_params: Dict[str, Optional[str]] = _headers or {}
918
+ _form_params: List[Tuple[str, str]] = []
919
+ _files: Dict[
920
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
921
+ ] = {}
922
+ _body_params: Optional[bytes] = None
923
+
924
+ # process the path parameters
925
+ # process the query parameters
926
+ # process the header parameters
927
+ # process the form parameters
928
+ # process the body parameter
929
+
930
+ # set the HTTP header `Accept`
931
+ if "Accept" not in _header_params:
932
+ _header_params["Accept"] = self.api_client.select_header_accept(
933
+ ["application/json"]
934
+ )
935
+
936
+ # authentication setting
937
+ _auth_settings: List[str] = []
938
+
939
+ return self.api_client.param_serialize(
940
+ method="GET",
941
+ resource_path="/server/config",
942
+ path_params=_path_params,
943
+ query_params=_query_params,
944
+ header_params=_header_params,
945
+ body=_body_params,
946
+ post_params=_form_params,
947
+ files=_files,
948
+ auth_settings=_auth_settings,
949
+ collection_formats=_collection_formats,
950
+ _host=_host,
951
+ _request_auth=_request_auth,
952
+ )
953
+
954
+ @validate_call
955
+ async def get_server_features(
956
+ self,
957
+ _request_timeout: Union[
958
+ None,
959
+ Annotated[StrictFloat, Field(gt=0)],
960
+ Tuple[
961
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
962
+ ],
963
+ ] = None,
964
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
965
+ _content_type: Optional[StrictStr] = None,
966
+ _headers: Optional[Dict[StrictStr, Any]] = None,
967
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
968
+ ) -> ServerFeaturesDto:
969
+ """Get features
970
+
971
+ Retrieve available features supported by this server.
972
+
973
+ :param _request_timeout: timeout setting for this request. If one
974
+ number provided, it will be total request
975
+ timeout. It can also be a pair (tuple) of
976
+ (connection, read) timeouts.
977
+ :type _request_timeout: int, tuple(int, int), optional
978
+ :param _request_auth: set to override the auth_settings for an a single
979
+ request; this effectively ignores the
980
+ authentication in the spec for a single request.
981
+ :type _request_auth: dict, optional
982
+ :param _content_type: force content-type for the request.
983
+ :type _content_type: str, Optional
984
+ :param _headers: set to override the headers for a single
985
+ request; this effectively ignores the headers
986
+ in the spec for a single request.
987
+ :type _headers: dict, optional
988
+ :param _host_index: set to override the host_index for a single
989
+ request; this effectively ignores the host_index
990
+ in the spec for a single request.
991
+ :type _host_index: int, optional
992
+ :return: Returns the result object.
993
+ """ # noqa: E501
994
+
995
+ _param = self._get_server_features_serialize(
996
+ _request_auth=_request_auth,
997
+ _content_type=_content_type,
998
+ _headers=_headers,
999
+ _host_index=_host_index,
1000
+ )
1001
+
1002
+ _response_types_map: Dict[str, Optional[str]] = {
1003
+ "200": "ServerFeaturesDto",
1004
+ }
1005
+ response_data = await self.api_client.call_api(
1006
+ *_param, _request_timeout=_request_timeout
1007
+ )
1008
+ await response_data.read()
1009
+ return self.api_client.response_deserialize(
1010
+ response_data=response_data,
1011
+ response_types_map=_response_types_map,
1012
+ ).data
1013
+
1014
+ @validate_call
1015
+ async def get_server_features_with_http_info(
1016
+ self,
1017
+ _request_timeout: Union[
1018
+ None,
1019
+ Annotated[StrictFloat, Field(gt=0)],
1020
+ Tuple[
1021
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1022
+ ],
1023
+ ] = None,
1024
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1025
+ _content_type: Optional[StrictStr] = None,
1026
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1027
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1028
+ ) -> ApiResponse[ServerFeaturesDto]:
1029
+ """Get features
1030
+
1031
+ Retrieve available features supported by this server.
1032
+
1033
+ :param _request_timeout: timeout setting for this request. If one
1034
+ number provided, it will be total request
1035
+ timeout. It can also be a pair (tuple) of
1036
+ (connection, read) timeouts.
1037
+ :type _request_timeout: int, tuple(int, int), optional
1038
+ :param _request_auth: set to override the auth_settings for an a single
1039
+ request; this effectively ignores the
1040
+ authentication in the spec for a single request.
1041
+ :type _request_auth: dict, optional
1042
+ :param _content_type: force content-type for the request.
1043
+ :type _content_type: str, Optional
1044
+ :param _headers: set to override the headers for a single
1045
+ request; this effectively ignores the headers
1046
+ in the spec for a single request.
1047
+ :type _headers: dict, optional
1048
+ :param _host_index: set to override the host_index for a single
1049
+ request; this effectively ignores the host_index
1050
+ in the spec for a single request.
1051
+ :type _host_index: int, optional
1052
+ :return: Returns the result object.
1053
+ """ # noqa: E501
1054
+
1055
+ _param = self._get_server_features_serialize(
1056
+ _request_auth=_request_auth,
1057
+ _content_type=_content_type,
1058
+ _headers=_headers,
1059
+ _host_index=_host_index,
1060
+ )
1061
+
1062
+ _response_types_map: Dict[str, Optional[str]] = {
1063
+ "200": "ServerFeaturesDto",
1064
+ }
1065
+ response_data = await self.api_client.call_api(
1066
+ *_param, _request_timeout=_request_timeout
1067
+ )
1068
+ await response_data.read()
1069
+ return self.api_client.response_deserialize(
1070
+ response_data=response_data,
1071
+ response_types_map=_response_types_map,
1072
+ )
1073
+
1074
+ @validate_call
1075
+ async def get_server_features_without_preload_content(
1076
+ self,
1077
+ _request_timeout: Union[
1078
+ None,
1079
+ Annotated[StrictFloat, Field(gt=0)],
1080
+ Tuple[
1081
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1082
+ ],
1083
+ ] = None,
1084
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1085
+ _content_type: Optional[StrictStr] = None,
1086
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1087
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1088
+ ) -> RESTResponseType:
1089
+ """Get features
1090
+
1091
+ Retrieve available features supported by this server.
1092
+
1093
+ :param _request_timeout: timeout setting for this request. If one
1094
+ number provided, it will be total request
1095
+ timeout. It can also be a pair (tuple) of
1096
+ (connection, read) timeouts.
1097
+ :type _request_timeout: int, tuple(int, int), optional
1098
+ :param _request_auth: set to override the auth_settings for an a single
1099
+ request; this effectively ignores the
1100
+ authentication in the spec for a single request.
1101
+ :type _request_auth: dict, optional
1102
+ :param _content_type: force content-type for the request.
1103
+ :type _content_type: str, Optional
1104
+ :param _headers: set to override the headers for a single
1105
+ request; this effectively ignores the headers
1106
+ in the spec for a single request.
1107
+ :type _headers: dict, optional
1108
+ :param _host_index: set to override the host_index for a single
1109
+ request; this effectively ignores the host_index
1110
+ in the spec for a single request.
1111
+ :type _host_index: int, optional
1112
+ :return: Returns the result object.
1113
+ """ # noqa: E501
1114
+
1115
+ _param = self._get_server_features_serialize(
1116
+ _request_auth=_request_auth,
1117
+ _content_type=_content_type,
1118
+ _headers=_headers,
1119
+ _host_index=_host_index,
1120
+ )
1121
+
1122
+ _response_types_map: Dict[str, Optional[str]] = {
1123
+ "200": "ServerFeaturesDto",
1124
+ }
1125
+ response_data = await self.api_client.call_api(
1126
+ *_param, _request_timeout=_request_timeout
1127
+ )
1128
+ return response_data.response
1129
+
1130
+ def _get_server_features_serialize(
1131
+ self,
1132
+ _request_auth,
1133
+ _content_type,
1134
+ _headers,
1135
+ _host_index,
1136
+ ) -> RequestSerialized:
1137
+ _host = None
1138
+
1139
+ _collection_formats: Dict[str, str] = {}
1140
+
1141
+ _path_params: Dict[str, str] = {}
1142
+ _query_params: List[Tuple[str, str]] = []
1143
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1144
+ _form_params: List[Tuple[str, str]] = []
1145
+ _files: Dict[
1146
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1147
+ ] = {}
1148
+ _body_params: Optional[bytes] = None
1149
+
1150
+ # process the path parameters
1151
+ # process the query parameters
1152
+ # process the header parameters
1153
+ # process the form parameters
1154
+ # process the body parameter
1155
+
1156
+ # set the HTTP header `Accept`
1157
+ if "Accept" not in _header_params:
1158
+ _header_params["Accept"] = self.api_client.select_header_accept(
1159
+ ["application/json"]
1160
+ )
1161
+
1162
+ # authentication setting
1163
+ _auth_settings: List[str] = []
1164
+
1165
+ return self.api_client.param_serialize(
1166
+ method="GET",
1167
+ resource_path="/server/features",
1168
+ path_params=_path_params,
1169
+ query_params=_query_params,
1170
+ header_params=_header_params,
1171
+ body=_body_params,
1172
+ post_params=_form_params,
1173
+ files=_files,
1174
+ auth_settings=_auth_settings,
1175
+ collection_formats=_collection_formats,
1176
+ _host=_host,
1177
+ _request_auth=_request_auth,
1178
+ )
1179
+
1180
+ @validate_call
1181
+ async def get_server_license(
1182
+ self,
1183
+ _request_timeout: Union[
1184
+ None,
1185
+ Annotated[StrictFloat, Field(gt=0)],
1186
+ Tuple[
1187
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1188
+ ],
1189
+ ] = None,
1190
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1191
+ _content_type: Optional[StrictStr] = None,
1192
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1193
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1194
+ ) -> LicenseResponseDto:
1195
+ """Get product key
1196
+
1197
+ Retrieve information about whether the server currently has a product key registered.
1198
+
1199
+ :param _request_timeout: timeout setting for this request. If one
1200
+ number provided, it will be total request
1201
+ timeout. It can also be a pair (tuple) of
1202
+ (connection, read) timeouts.
1203
+ :type _request_timeout: int, tuple(int, int), optional
1204
+ :param _request_auth: set to override the auth_settings for an a single
1205
+ request; this effectively ignores the
1206
+ authentication in the spec for a single request.
1207
+ :type _request_auth: dict, optional
1208
+ :param _content_type: force content-type for the request.
1209
+ :type _content_type: str, Optional
1210
+ :param _headers: set to override the headers for a single
1211
+ request; this effectively ignores the headers
1212
+ in the spec for a single request.
1213
+ :type _headers: dict, optional
1214
+ :param _host_index: set to override the host_index for a single
1215
+ request; this effectively ignores the host_index
1216
+ in the spec for a single request.
1217
+ :type _host_index: int, optional
1218
+ :return: Returns the result object.
1219
+ """ # noqa: E501
1220
+
1221
+ _param = self._get_server_license_serialize(
1222
+ _request_auth=_request_auth,
1223
+ _content_type=_content_type,
1224
+ _headers=_headers,
1225
+ _host_index=_host_index,
1226
+ )
1227
+
1228
+ _response_types_map: Dict[str, Optional[str]] = {
1229
+ "200": "LicenseResponseDto",
1230
+ "404": None,
1231
+ }
1232
+ response_data = await self.api_client.call_api(
1233
+ *_param, _request_timeout=_request_timeout
1234
+ )
1235
+ await response_data.read()
1236
+ return self.api_client.response_deserialize(
1237
+ response_data=response_data,
1238
+ response_types_map=_response_types_map,
1239
+ ).data
1240
+
1241
+ @validate_call
1242
+ async def get_server_license_with_http_info(
1243
+ self,
1244
+ _request_timeout: Union[
1245
+ None,
1246
+ Annotated[StrictFloat, Field(gt=0)],
1247
+ Tuple[
1248
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1249
+ ],
1250
+ ] = None,
1251
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1252
+ _content_type: Optional[StrictStr] = None,
1253
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1254
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1255
+ ) -> ApiResponse[LicenseResponseDto]:
1256
+ """Get product key
1257
+
1258
+ Retrieve information about whether the server currently has a product key registered.
1259
+
1260
+ :param _request_timeout: timeout setting for this request. If one
1261
+ number provided, it will be total request
1262
+ timeout. It can also be a pair (tuple) of
1263
+ (connection, read) timeouts.
1264
+ :type _request_timeout: int, tuple(int, int), optional
1265
+ :param _request_auth: set to override the auth_settings for an a single
1266
+ request; this effectively ignores the
1267
+ authentication in the spec for a single request.
1268
+ :type _request_auth: dict, optional
1269
+ :param _content_type: force content-type for the request.
1270
+ :type _content_type: str, Optional
1271
+ :param _headers: set to override the headers for a single
1272
+ request; this effectively ignores the headers
1273
+ in the spec for a single request.
1274
+ :type _headers: dict, optional
1275
+ :param _host_index: set to override the host_index for a single
1276
+ request; this effectively ignores the host_index
1277
+ in the spec for a single request.
1278
+ :type _host_index: int, optional
1279
+ :return: Returns the result object.
1280
+ """ # noqa: E501
1281
+
1282
+ _param = self._get_server_license_serialize(
1283
+ _request_auth=_request_auth,
1284
+ _content_type=_content_type,
1285
+ _headers=_headers,
1286
+ _host_index=_host_index,
1287
+ )
1288
+
1289
+ _response_types_map: Dict[str, Optional[str]] = {
1290
+ "200": "LicenseResponseDto",
1291
+ "404": None,
1292
+ }
1293
+ response_data = await self.api_client.call_api(
1294
+ *_param, _request_timeout=_request_timeout
1295
+ )
1296
+ await response_data.read()
1297
+ return self.api_client.response_deserialize(
1298
+ response_data=response_data,
1299
+ response_types_map=_response_types_map,
1300
+ )
1301
+
1302
+ @validate_call
1303
+ async def get_server_license_without_preload_content(
1304
+ self,
1305
+ _request_timeout: Union[
1306
+ None,
1307
+ Annotated[StrictFloat, Field(gt=0)],
1308
+ Tuple[
1309
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1310
+ ],
1311
+ ] = None,
1312
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1313
+ _content_type: Optional[StrictStr] = None,
1314
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1315
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1316
+ ) -> RESTResponseType:
1317
+ """Get product key
1318
+
1319
+ Retrieve information about whether the server currently has a product key registered.
1320
+
1321
+ :param _request_timeout: timeout setting for this request. If one
1322
+ number provided, it will be total request
1323
+ timeout. It can also be a pair (tuple) of
1324
+ (connection, read) timeouts.
1325
+ :type _request_timeout: int, tuple(int, int), optional
1326
+ :param _request_auth: set to override the auth_settings for an a single
1327
+ request; this effectively ignores the
1328
+ authentication in the spec for a single request.
1329
+ :type _request_auth: dict, optional
1330
+ :param _content_type: force content-type for the request.
1331
+ :type _content_type: str, Optional
1332
+ :param _headers: set to override the headers for a single
1333
+ request; this effectively ignores the headers
1334
+ in the spec for a single request.
1335
+ :type _headers: dict, optional
1336
+ :param _host_index: set to override the host_index for a single
1337
+ request; this effectively ignores the host_index
1338
+ in the spec for a single request.
1339
+ :type _host_index: int, optional
1340
+ :return: Returns the result object.
1341
+ """ # noqa: E501
1342
+
1343
+ _param = self._get_server_license_serialize(
1344
+ _request_auth=_request_auth,
1345
+ _content_type=_content_type,
1346
+ _headers=_headers,
1347
+ _host_index=_host_index,
1348
+ )
1349
+
1350
+ _response_types_map: Dict[str, Optional[str]] = {
1351
+ "200": "LicenseResponseDto",
1352
+ "404": None,
1353
+ }
1354
+ response_data = await self.api_client.call_api(
1355
+ *_param, _request_timeout=_request_timeout
1356
+ )
1357
+ return response_data.response
1358
+
1359
+ def _get_server_license_serialize(
1360
+ self,
1361
+ _request_auth,
1362
+ _content_type,
1363
+ _headers,
1364
+ _host_index,
1365
+ ) -> RequestSerialized:
1366
+ _host = None
1367
+
1368
+ _collection_formats: Dict[str, str] = {}
1369
+
1370
+ _path_params: Dict[str, str] = {}
1371
+ _query_params: List[Tuple[str, str]] = []
1372
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1373
+ _form_params: List[Tuple[str, str]] = []
1374
+ _files: Dict[
1375
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1376
+ ] = {}
1377
+ _body_params: Optional[bytes] = None
1378
+
1379
+ # process the path parameters
1380
+ # process the query parameters
1381
+ # process the header parameters
1382
+ # process the form parameters
1383
+ # process the body parameter
1384
+
1385
+ # set the HTTP header `Accept`
1386
+ if "Accept" not in _header_params:
1387
+ _header_params["Accept"] = self.api_client.select_header_accept(
1388
+ ["application/json"]
1389
+ )
1390
+
1391
+ # authentication setting
1392
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
1393
+
1394
+ return self.api_client.param_serialize(
1395
+ method="GET",
1396
+ resource_path="/server/license",
1397
+ path_params=_path_params,
1398
+ query_params=_query_params,
1399
+ header_params=_header_params,
1400
+ body=_body_params,
1401
+ post_params=_form_params,
1402
+ files=_files,
1403
+ auth_settings=_auth_settings,
1404
+ collection_formats=_collection_formats,
1405
+ _host=_host,
1406
+ _request_auth=_request_auth,
1407
+ )
1408
+
1409
+ @validate_call
1410
+ async def get_server_statistics(
1411
+ self,
1412
+ _request_timeout: Union[
1413
+ None,
1414
+ Annotated[StrictFloat, Field(gt=0)],
1415
+ Tuple[
1416
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1417
+ ],
1418
+ ] = None,
1419
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1420
+ _content_type: Optional[StrictStr] = None,
1421
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1422
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1423
+ ) -> ServerStatsResponseDto:
1424
+ """Get statistics
1425
+
1426
+ Retrieve statistics about the entire Immich instance such as asset counts.
1427
+
1428
+ :param _request_timeout: timeout setting for this request. If one
1429
+ number provided, it will be total request
1430
+ timeout. It can also be a pair (tuple) of
1431
+ (connection, read) timeouts.
1432
+ :type _request_timeout: int, tuple(int, int), optional
1433
+ :param _request_auth: set to override the auth_settings for an a single
1434
+ request; this effectively ignores the
1435
+ authentication in the spec for a single request.
1436
+ :type _request_auth: dict, optional
1437
+ :param _content_type: force content-type for the request.
1438
+ :type _content_type: str, Optional
1439
+ :param _headers: set to override the headers for a single
1440
+ request; this effectively ignores the headers
1441
+ in the spec for a single request.
1442
+ :type _headers: dict, optional
1443
+ :param _host_index: set to override the host_index for a single
1444
+ request; this effectively ignores the host_index
1445
+ in the spec for a single request.
1446
+ :type _host_index: int, optional
1447
+ :return: Returns the result object.
1448
+ """ # noqa: E501
1449
+
1450
+ _param = self._get_server_statistics_serialize(
1451
+ _request_auth=_request_auth,
1452
+ _content_type=_content_type,
1453
+ _headers=_headers,
1454
+ _host_index=_host_index,
1455
+ )
1456
+
1457
+ _response_types_map: Dict[str, Optional[str]] = {
1458
+ "200": "ServerStatsResponseDto",
1459
+ }
1460
+ response_data = await self.api_client.call_api(
1461
+ *_param, _request_timeout=_request_timeout
1462
+ )
1463
+ await response_data.read()
1464
+ return self.api_client.response_deserialize(
1465
+ response_data=response_data,
1466
+ response_types_map=_response_types_map,
1467
+ ).data
1468
+
1469
+ @validate_call
1470
+ async def get_server_statistics_with_http_info(
1471
+ self,
1472
+ _request_timeout: Union[
1473
+ None,
1474
+ Annotated[StrictFloat, Field(gt=0)],
1475
+ Tuple[
1476
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1477
+ ],
1478
+ ] = None,
1479
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1480
+ _content_type: Optional[StrictStr] = None,
1481
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1482
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1483
+ ) -> ApiResponse[ServerStatsResponseDto]:
1484
+ """Get statistics
1485
+
1486
+ Retrieve statistics about the entire Immich instance such as asset counts.
1487
+
1488
+ :param _request_timeout: timeout setting for this request. If one
1489
+ number provided, it will be total request
1490
+ timeout. It can also be a pair (tuple) of
1491
+ (connection, read) timeouts.
1492
+ :type _request_timeout: int, tuple(int, int), optional
1493
+ :param _request_auth: set to override the auth_settings for an a single
1494
+ request; this effectively ignores the
1495
+ authentication in the spec for a single request.
1496
+ :type _request_auth: dict, optional
1497
+ :param _content_type: force content-type for the request.
1498
+ :type _content_type: str, Optional
1499
+ :param _headers: set to override the headers for a single
1500
+ request; this effectively ignores the headers
1501
+ in the spec for a single request.
1502
+ :type _headers: dict, optional
1503
+ :param _host_index: set to override the host_index for a single
1504
+ request; this effectively ignores the host_index
1505
+ in the spec for a single request.
1506
+ :type _host_index: int, optional
1507
+ :return: Returns the result object.
1508
+ """ # noqa: E501
1509
+
1510
+ _param = self._get_server_statistics_serialize(
1511
+ _request_auth=_request_auth,
1512
+ _content_type=_content_type,
1513
+ _headers=_headers,
1514
+ _host_index=_host_index,
1515
+ )
1516
+
1517
+ _response_types_map: Dict[str, Optional[str]] = {
1518
+ "200": "ServerStatsResponseDto",
1519
+ }
1520
+ response_data = await self.api_client.call_api(
1521
+ *_param, _request_timeout=_request_timeout
1522
+ )
1523
+ await response_data.read()
1524
+ return self.api_client.response_deserialize(
1525
+ response_data=response_data,
1526
+ response_types_map=_response_types_map,
1527
+ )
1528
+
1529
+ @validate_call
1530
+ async def get_server_statistics_without_preload_content(
1531
+ self,
1532
+ _request_timeout: Union[
1533
+ None,
1534
+ Annotated[StrictFloat, Field(gt=0)],
1535
+ Tuple[
1536
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1537
+ ],
1538
+ ] = None,
1539
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1540
+ _content_type: Optional[StrictStr] = None,
1541
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1542
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1543
+ ) -> RESTResponseType:
1544
+ """Get statistics
1545
+
1546
+ Retrieve statistics about the entire Immich instance such as asset counts.
1547
+
1548
+ :param _request_timeout: timeout setting for this request. If one
1549
+ number provided, it will be total request
1550
+ timeout. It can also be a pair (tuple) of
1551
+ (connection, read) timeouts.
1552
+ :type _request_timeout: int, tuple(int, int), optional
1553
+ :param _request_auth: set to override the auth_settings for an a single
1554
+ request; this effectively ignores the
1555
+ authentication in the spec for a single request.
1556
+ :type _request_auth: dict, optional
1557
+ :param _content_type: force content-type for the request.
1558
+ :type _content_type: str, Optional
1559
+ :param _headers: set to override the headers for a single
1560
+ request; this effectively ignores the headers
1561
+ in the spec for a single request.
1562
+ :type _headers: dict, optional
1563
+ :param _host_index: set to override the host_index for a single
1564
+ request; this effectively ignores the host_index
1565
+ in the spec for a single request.
1566
+ :type _host_index: int, optional
1567
+ :return: Returns the result object.
1568
+ """ # noqa: E501
1569
+
1570
+ _param = self._get_server_statistics_serialize(
1571
+ _request_auth=_request_auth,
1572
+ _content_type=_content_type,
1573
+ _headers=_headers,
1574
+ _host_index=_host_index,
1575
+ )
1576
+
1577
+ _response_types_map: Dict[str, Optional[str]] = {
1578
+ "200": "ServerStatsResponseDto",
1579
+ }
1580
+ response_data = await self.api_client.call_api(
1581
+ *_param, _request_timeout=_request_timeout
1582
+ )
1583
+ return response_data.response
1584
+
1585
+ def _get_server_statistics_serialize(
1586
+ self,
1587
+ _request_auth,
1588
+ _content_type,
1589
+ _headers,
1590
+ _host_index,
1591
+ ) -> RequestSerialized:
1592
+ _host = None
1593
+
1594
+ _collection_formats: Dict[str, str] = {}
1595
+
1596
+ _path_params: Dict[str, str] = {}
1597
+ _query_params: List[Tuple[str, str]] = []
1598
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1599
+ _form_params: List[Tuple[str, str]] = []
1600
+ _files: Dict[
1601
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1602
+ ] = {}
1603
+ _body_params: Optional[bytes] = None
1604
+
1605
+ # process the path parameters
1606
+ # process the query parameters
1607
+ # process the header parameters
1608
+ # process the form parameters
1609
+ # process the body parameter
1610
+
1611
+ # set the HTTP header `Accept`
1612
+ if "Accept" not in _header_params:
1613
+ _header_params["Accept"] = self.api_client.select_header_accept(
1614
+ ["application/json"]
1615
+ )
1616
+
1617
+ # authentication setting
1618
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
1619
+
1620
+ return self.api_client.param_serialize(
1621
+ method="GET",
1622
+ resource_path="/server/statistics",
1623
+ path_params=_path_params,
1624
+ query_params=_query_params,
1625
+ header_params=_header_params,
1626
+ body=_body_params,
1627
+ post_params=_form_params,
1628
+ files=_files,
1629
+ auth_settings=_auth_settings,
1630
+ collection_formats=_collection_formats,
1631
+ _host=_host,
1632
+ _request_auth=_request_auth,
1633
+ )
1634
+
1635
+ @validate_call
1636
+ async def get_server_version(
1637
+ self,
1638
+ _request_timeout: Union[
1639
+ None,
1640
+ Annotated[StrictFloat, Field(gt=0)],
1641
+ Tuple[
1642
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1643
+ ],
1644
+ ] = None,
1645
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1646
+ _content_type: Optional[StrictStr] = None,
1647
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1648
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1649
+ ) -> ServerVersionResponseDto:
1650
+ """Get server version
1651
+
1652
+ Retrieve the current server version in semantic versioning (semver) format.
1653
+
1654
+ :param _request_timeout: timeout setting for this request. If one
1655
+ number provided, it will be total request
1656
+ timeout. It can also be a pair (tuple) of
1657
+ (connection, read) timeouts.
1658
+ :type _request_timeout: int, tuple(int, int), optional
1659
+ :param _request_auth: set to override the auth_settings for an a single
1660
+ request; this effectively ignores the
1661
+ authentication in the spec for a single request.
1662
+ :type _request_auth: dict, optional
1663
+ :param _content_type: force content-type for the request.
1664
+ :type _content_type: str, Optional
1665
+ :param _headers: set to override the headers for a single
1666
+ request; this effectively ignores the headers
1667
+ in the spec for a single request.
1668
+ :type _headers: dict, optional
1669
+ :param _host_index: set to override the host_index for a single
1670
+ request; this effectively ignores the host_index
1671
+ in the spec for a single request.
1672
+ :type _host_index: int, optional
1673
+ :return: Returns the result object.
1674
+ """ # noqa: E501
1675
+
1676
+ _param = self._get_server_version_serialize(
1677
+ _request_auth=_request_auth,
1678
+ _content_type=_content_type,
1679
+ _headers=_headers,
1680
+ _host_index=_host_index,
1681
+ )
1682
+
1683
+ _response_types_map: Dict[str, Optional[str]] = {
1684
+ "200": "ServerVersionResponseDto",
1685
+ }
1686
+ response_data = await self.api_client.call_api(
1687
+ *_param, _request_timeout=_request_timeout
1688
+ )
1689
+ await response_data.read()
1690
+ return self.api_client.response_deserialize(
1691
+ response_data=response_data,
1692
+ response_types_map=_response_types_map,
1693
+ ).data
1694
+
1695
+ @validate_call
1696
+ async def get_server_version_with_http_info(
1697
+ self,
1698
+ _request_timeout: Union[
1699
+ None,
1700
+ Annotated[StrictFloat, Field(gt=0)],
1701
+ Tuple[
1702
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1703
+ ],
1704
+ ] = None,
1705
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1706
+ _content_type: Optional[StrictStr] = None,
1707
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1708
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1709
+ ) -> ApiResponse[ServerVersionResponseDto]:
1710
+ """Get server version
1711
+
1712
+ Retrieve the current server version in semantic versioning (semver) format.
1713
+
1714
+ :param _request_timeout: timeout setting for this request. If one
1715
+ number provided, it will be total request
1716
+ timeout. It can also be a pair (tuple) of
1717
+ (connection, read) timeouts.
1718
+ :type _request_timeout: int, tuple(int, int), optional
1719
+ :param _request_auth: set to override the auth_settings for an a single
1720
+ request; this effectively ignores the
1721
+ authentication in the spec for a single request.
1722
+ :type _request_auth: dict, optional
1723
+ :param _content_type: force content-type for the request.
1724
+ :type _content_type: str, Optional
1725
+ :param _headers: set to override the headers for a single
1726
+ request; this effectively ignores the headers
1727
+ in the spec for a single request.
1728
+ :type _headers: dict, optional
1729
+ :param _host_index: set to override the host_index for a single
1730
+ request; this effectively ignores the host_index
1731
+ in the spec for a single request.
1732
+ :type _host_index: int, optional
1733
+ :return: Returns the result object.
1734
+ """ # noqa: E501
1735
+
1736
+ _param = self._get_server_version_serialize(
1737
+ _request_auth=_request_auth,
1738
+ _content_type=_content_type,
1739
+ _headers=_headers,
1740
+ _host_index=_host_index,
1741
+ )
1742
+
1743
+ _response_types_map: Dict[str, Optional[str]] = {
1744
+ "200": "ServerVersionResponseDto",
1745
+ }
1746
+ response_data = await self.api_client.call_api(
1747
+ *_param, _request_timeout=_request_timeout
1748
+ )
1749
+ await response_data.read()
1750
+ return self.api_client.response_deserialize(
1751
+ response_data=response_data,
1752
+ response_types_map=_response_types_map,
1753
+ )
1754
+
1755
+ @validate_call
1756
+ async def get_server_version_without_preload_content(
1757
+ self,
1758
+ _request_timeout: Union[
1759
+ None,
1760
+ Annotated[StrictFloat, Field(gt=0)],
1761
+ Tuple[
1762
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1763
+ ],
1764
+ ] = None,
1765
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1766
+ _content_type: Optional[StrictStr] = None,
1767
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1768
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1769
+ ) -> RESTResponseType:
1770
+ """Get server version
1771
+
1772
+ Retrieve the current server version in semantic versioning (semver) format.
1773
+
1774
+ :param _request_timeout: timeout setting for this request. If one
1775
+ number provided, it will be total request
1776
+ timeout. It can also be a pair (tuple) of
1777
+ (connection, read) timeouts.
1778
+ :type _request_timeout: int, tuple(int, int), optional
1779
+ :param _request_auth: set to override the auth_settings for an a single
1780
+ request; this effectively ignores the
1781
+ authentication in the spec for a single request.
1782
+ :type _request_auth: dict, optional
1783
+ :param _content_type: force content-type for the request.
1784
+ :type _content_type: str, Optional
1785
+ :param _headers: set to override the headers for a single
1786
+ request; this effectively ignores the headers
1787
+ in the spec for a single request.
1788
+ :type _headers: dict, optional
1789
+ :param _host_index: set to override the host_index for a single
1790
+ request; this effectively ignores the host_index
1791
+ in the spec for a single request.
1792
+ :type _host_index: int, optional
1793
+ :return: Returns the result object.
1794
+ """ # noqa: E501
1795
+
1796
+ _param = self._get_server_version_serialize(
1797
+ _request_auth=_request_auth,
1798
+ _content_type=_content_type,
1799
+ _headers=_headers,
1800
+ _host_index=_host_index,
1801
+ )
1802
+
1803
+ _response_types_map: Dict[str, Optional[str]] = {
1804
+ "200": "ServerVersionResponseDto",
1805
+ }
1806
+ response_data = await self.api_client.call_api(
1807
+ *_param, _request_timeout=_request_timeout
1808
+ )
1809
+ return response_data.response
1810
+
1811
+ def _get_server_version_serialize(
1812
+ self,
1813
+ _request_auth,
1814
+ _content_type,
1815
+ _headers,
1816
+ _host_index,
1817
+ ) -> RequestSerialized:
1818
+ _host = None
1819
+
1820
+ _collection_formats: Dict[str, str] = {}
1821
+
1822
+ _path_params: Dict[str, str] = {}
1823
+ _query_params: List[Tuple[str, str]] = []
1824
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1825
+ _form_params: List[Tuple[str, str]] = []
1826
+ _files: Dict[
1827
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1828
+ ] = {}
1829
+ _body_params: Optional[bytes] = None
1830
+
1831
+ # process the path parameters
1832
+ # process the query parameters
1833
+ # process the header parameters
1834
+ # process the form parameters
1835
+ # process the body parameter
1836
+
1837
+ # set the HTTP header `Accept`
1838
+ if "Accept" not in _header_params:
1839
+ _header_params["Accept"] = self.api_client.select_header_accept(
1840
+ ["application/json"]
1841
+ )
1842
+
1843
+ # authentication setting
1844
+ _auth_settings: List[str] = []
1845
+
1846
+ return self.api_client.param_serialize(
1847
+ method="GET",
1848
+ resource_path="/server/version",
1849
+ path_params=_path_params,
1850
+ query_params=_query_params,
1851
+ header_params=_header_params,
1852
+ body=_body_params,
1853
+ post_params=_form_params,
1854
+ files=_files,
1855
+ auth_settings=_auth_settings,
1856
+ collection_formats=_collection_formats,
1857
+ _host=_host,
1858
+ _request_auth=_request_auth,
1859
+ )
1860
+
1861
+ @validate_call
1862
+ async def get_storage(
1863
+ self,
1864
+ _request_timeout: Union[
1865
+ None,
1866
+ Annotated[StrictFloat, Field(gt=0)],
1867
+ Tuple[
1868
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1869
+ ],
1870
+ ] = None,
1871
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1872
+ _content_type: Optional[StrictStr] = None,
1873
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1874
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1875
+ ) -> ServerStorageResponseDto:
1876
+ """Get storage
1877
+
1878
+ Retrieve the current storage utilization information of the server.
1879
+
1880
+ :param _request_timeout: timeout setting for this request. If one
1881
+ number provided, it will be total request
1882
+ timeout. It can also be a pair (tuple) of
1883
+ (connection, read) timeouts.
1884
+ :type _request_timeout: int, tuple(int, int), optional
1885
+ :param _request_auth: set to override the auth_settings for an a single
1886
+ request; this effectively ignores the
1887
+ authentication in the spec for a single request.
1888
+ :type _request_auth: dict, optional
1889
+ :param _content_type: force content-type for the request.
1890
+ :type _content_type: str, Optional
1891
+ :param _headers: set to override the headers for a single
1892
+ request; this effectively ignores the headers
1893
+ in the spec for a single request.
1894
+ :type _headers: dict, optional
1895
+ :param _host_index: set to override the host_index for a single
1896
+ request; this effectively ignores the host_index
1897
+ in the spec for a single request.
1898
+ :type _host_index: int, optional
1899
+ :return: Returns the result object.
1900
+ """ # noqa: E501
1901
+
1902
+ _param = self._get_storage_serialize(
1903
+ _request_auth=_request_auth,
1904
+ _content_type=_content_type,
1905
+ _headers=_headers,
1906
+ _host_index=_host_index,
1907
+ )
1908
+
1909
+ _response_types_map: Dict[str, Optional[str]] = {
1910
+ "200": "ServerStorageResponseDto",
1911
+ }
1912
+ response_data = await self.api_client.call_api(
1913
+ *_param, _request_timeout=_request_timeout
1914
+ )
1915
+ await response_data.read()
1916
+ return self.api_client.response_deserialize(
1917
+ response_data=response_data,
1918
+ response_types_map=_response_types_map,
1919
+ ).data
1920
+
1921
+ @validate_call
1922
+ async def get_storage_with_http_info(
1923
+ self,
1924
+ _request_timeout: Union[
1925
+ None,
1926
+ Annotated[StrictFloat, Field(gt=0)],
1927
+ Tuple[
1928
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1929
+ ],
1930
+ ] = None,
1931
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1932
+ _content_type: Optional[StrictStr] = None,
1933
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1934
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1935
+ ) -> ApiResponse[ServerStorageResponseDto]:
1936
+ """Get storage
1937
+
1938
+ Retrieve the current storage utilization information of the server.
1939
+
1940
+ :param _request_timeout: timeout setting for this request. If one
1941
+ number provided, it will be total request
1942
+ timeout. It can also be a pair (tuple) of
1943
+ (connection, read) timeouts.
1944
+ :type _request_timeout: int, tuple(int, int), optional
1945
+ :param _request_auth: set to override the auth_settings for an a single
1946
+ request; this effectively ignores the
1947
+ authentication in the spec for a single request.
1948
+ :type _request_auth: dict, optional
1949
+ :param _content_type: force content-type for the request.
1950
+ :type _content_type: str, Optional
1951
+ :param _headers: set to override the headers for a single
1952
+ request; this effectively ignores the headers
1953
+ in the spec for a single request.
1954
+ :type _headers: dict, optional
1955
+ :param _host_index: set to override the host_index for a single
1956
+ request; this effectively ignores the host_index
1957
+ in the spec for a single request.
1958
+ :type _host_index: int, optional
1959
+ :return: Returns the result object.
1960
+ """ # noqa: E501
1961
+
1962
+ _param = self._get_storage_serialize(
1963
+ _request_auth=_request_auth,
1964
+ _content_type=_content_type,
1965
+ _headers=_headers,
1966
+ _host_index=_host_index,
1967
+ )
1968
+
1969
+ _response_types_map: Dict[str, Optional[str]] = {
1970
+ "200": "ServerStorageResponseDto",
1971
+ }
1972
+ response_data = await self.api_client.call_api(
1973
+ *_param, _request_timeout=_request_timeout
1974
+ )
1975
+ await response_data.read()
1976
+ return self.api_client.response_deserialize(
1977
+ response_data=response_data,
1978
+ response_types_map=_response_types_map,
1979
+ )
1980
+
1981
+ @validate_call
1982
+ async def get_storage_without_preload_content(
1983
+ self,
1984
+ _request_timeout: Union[
1985
+ None,
1986
+ Annotated[StrictFloat, Field(gt=0)],
1987
+ Tuple[
1988
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
1989
+ ],
1990
+ ] = None,
1991
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1992
+ _content_type: Optional[StrictStr] = None,
1993
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1994
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1995
+ ) -> RESTResponseType:
1996
+ """Get storage
1997
+
1998
+ Retrieve the current storage utilization information of the server.
1999
+
2000
+ :param _request_timeout: timeout setting for this request. If one
2001
+ number provided, it will be total request
2002
+ timeout. It can also be a pair (tuple) of
2003
+ (connection, read) timeouts.
2004
+ :type _request_timeout: int, tuple(int, int), optional
2005
+ :param _request_auth: set to override the auth_settings for an a single
2006
+ request; this effectively ignores the
2007
+ authentication in the spec for a single request.
2008
+ :type _request_auth: dict, optional
2009
+ :param _content_type: force content-type for the request.
2010
+ :type _content_type: str, Optional
2011
+ :param _headers: set to override the headers for a single
2012
+ request; this effectively ignores the headers
2013
+ in the spec for a single request.
2014
+ :type _headers: dict, optional
2015
+ :param _host_index: set to override the host_index for a single
2016
+ request; this effectively ignores the host_index
2017
+ in the spec for a single request.
2018
+ :type _host_index: int, optional
2019
+ :return: Returns the result object.
2020
+ """ # noqa: E501
2021
+
2022
+ _param = self._get_storage_serialize(
2023
+ _request_auth=_request_auth,
2024
+ _content_type=_content_type,
2025
+ _headers=_headers,
2026
+ _host_index=_host_index,
2027
+ )
2028
+
2029
+ _response_types_map: Dict[str, Optional[str]] = {
2030
+ "200": "ServerStorageResponseDto",
2031
+ }
2032
+ response_data = await self.api_client.call_api(
2033
+ *_param, _request_timeout=_request_timeout
2034
+ )
2035
+ return response_data.response
2036
+
2037
+ def _get_storage_serialize(
2038
+ self,
2039
+ _request_auth,
2040
+ _content_type,
2041
+ _headers,
2042
+ _host_index,
2043
+ ) -> RequestSerialized:
2044
+ _host = None
2045
+
2046
+ _collection_formats: Dict[str, str] = {}
2047
+
2048
+ _path_params: Dict[str, str] = {}
2049
+ _query_params: List[Tuple[str, str]] = []
2050
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2051
+ _form_params: List[Tuple[str, str]] = []
2052
+ _files: Dict[
2053
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2054
+ ] = {}
2055
+ _body_params: Optional[bytes] = None
2056
+
2057
+ # process the path parameters
2058
+ # process the query parameters
2059
+ # process the header parameters
2060
+ # process the form parameters
2061
+ # process the body parameter
2062
+
2063
+ # set the HTTP header `Accept`
2064
+ if "Accept" not in _header_params:
2065
+ _header_params["Accept"] = self.api_client.select_header_accept(
2066
+ ["application/json"]
2067
+ )
2068
+
2069
+ # authentication setting
2070
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
2071
+
2072
+ return self.api_client.param_serialize(
2073
+ method="GET",
2074
+ resource_path="/server/storage",
2075
+ path_params=_path_params,
2076
+ query_params=_query_params,
2077
+ header_params=_header_params,
2078
+ body=_body_params,
2079
+ post_params=_form_params,
2080
+ files=_files,
2081
+ auth_settings=_auth_settings,
2082
+ collection_formats=_collection_formats,
2083
+ _host=_host,
2084
+ _request_auth=_request_auth,
2085
+ )
2086
+
2087
+ @validate_call
2088
+ async def get_supported_media_types(
2089
+ self,
2090
+ _request_timeout: Union[
2091
+ None,
2092
+ Annotated[StrictFloat, Field(gt=0)],
2093
+ Tuple[
2094
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2095
+ ],
2096
+ ] = None,
2097
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2098
+ _content_type: Optional[StrictStr] = None,
2099
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2100
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2101
+ ) -> ServerMediaTypesResponseDto:
2102
+ """Get supported media types
2103
+
2104
+ Retrieve all media types supported by the server.
2105
+
2106
+ :param _request_timeout: timeout setting for this request. If one
2107
+ number provided, it will be total request
2108
+ timeout. It can also be a pair (tuple) of
2109
+ (connection, read) timeouts.
2110
+ :type _request_timeout: int, tuple(int, int), optional
2111
+ :param _request_auth: set to override the auth_settings for an a single
2112
+ request; this effectively ignores the
2113
+ authentication in the spec for a single request.
2114
+ :type _request_auth: dict, optional
2115
+ :param _content_type: force content-type for the request.
2116
+ :type _content_type: str, Optional
2117
+ :param _headers: set to override the headers for a single
2118
+ request; this effectively ignores the headers
2119
+ in the spec for a single request.
2120
+ :type _headers: dict, optional
2121
+ :param _host_index: set to override the host_index for a single
2122
+ request; this effectively ignores the host_index
2123
+ in the spec for a single request.
2124
+ :type _host_index: int, optional
2125
+ :return: Returns the result object.
2126
+ """ # noqa: E501
2127
+
2128
+ _param = self._get_supported_media_types_serialize(
2129
+ _request_auth=_request_auth,
2130
+ _content_type=_content_type,
2131
+ _headers=_headers,
2132
+ _host_index=_host_index,
2133
+ )
2134
+
2135
+ _response_types_map: Dict[str, Optional[str]] = {
2136
+ "200": "ServerMediaTypesResponseDto",
2137
+ }
2138
+ response_data = await self.api_client.call_api(
2139
+ *_param, _request_timeout=_request_timeout
2140
+ )
2141
+ await response_data.read()
2142
+ return self.api_client.response_deserialize(
2143
+ response_data=response_data,
2144
+ response_types_map=_response_types_map,
2145
+ ).data
2146
+
2147
+ @validate_call
2148
+ async def get_supported_media_types_with_http_info(
2149
+ self,
2150
+ _request_timeout: Union[
2151
+ None,
2152
+ Annotated[StrictFloat, Field(gt=0)],
2153
+ Tuple[
2154
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2155
+ ],
2156
+ ] = None,
2157
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2158
+ _content_type: Optional[StrictStr] = None,
2159
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2160
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2161
+ ) -> ApiResponse[ServerMediaTypesResponseDto]:
2162
+ """Get supported media types
2163
+
2164
+ Retrieve all media types supported by the server.
2165
+
2166
+ :param _request_timeout: timeout setting for this request. If one
2167
+ number provided, it will be total request
2168
+ timeout. It can also be a pair (tuple) of
2169
+ (connection, read) timeouts.
2170
+ :type _request_timeout: int, tuple(int, int), optional
2171
+ :param _request_auth: set to override the auth_settings for an a single
2172
+ request; this effectively ignores the
2173
+ authentication in the spec for a single request.
2174
+ :type _request_auth: dict, optional
2175
+ :param _content_type: force content-type for the request.
2176
+ :type _content_type: str, Optional
2177
+ :param _headers: set to override the headers for a single
2178
+ request; this effectively ignores the headers
2179
+ in the spec for a single request.
2180
+ :type _headers: dict, optional
2181
+ :param _host_index: set to override the host_index for a single
2182
+ request; this effectively ignores the host_index
2183
+ in the spec for a single request.
2184
+ :type _host_index: int, optional
2185
+ :return: Returns the result object.
2186
+ """ # noqa: E501
2187
+
2188
+ _param = self._get_supported_media_types_serialize(
2189
+ _request_auth=_request_auth,
2190
+ _content_type=_content_type,
2191
+ _headers=_headers,
2192
+ _host_index=_host_index,
2193
+ )
2194
+
2195
+ _response_types_map: Dict[str, Optional[str]] = {
2196
+ "200": "ServerMediaTypesResponseDto",
2197
+ }
2198
+ response_data = await self.api_client.call_api(
2199
+ *_param, _request_timeout=_request_timeout
2200
+ )
2201
+ await response_data.read()
2202
+ return self.api_client.response_deserialize(
2203
+ response_data=response_data,
2204
+ response_types_map=_response_types_map,
2205
+ )
2206
+
2207
+ @validate_call
2208
+ async def get_supported_media_types_without_preload_content(
2209
+ self,
2210
+ _request_timeout: Union[
2211
+ None,
2212
+ Annotated[StrictFloat, Field(gt=0)],
2213
+ Tuple[
2214
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2215
+ ],
2216
+ ] = None,
2217
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2218
+ _content_type: Optional[StrictStr] = None,
2219
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2220
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2221
+ ) -> RESTResponseType:
2222
+ """Get supported media types
2223
+
2224
+ Retrieve all media types supported by the server.
2225
+
2226
+ :param _request_timeout: timeout setting for this request. If one
2227
+ number provided, it will be total request
2228
+ timeout. It can also be a pair (tuple) of
2229
+ (connection, read) timeouts.
2230
+ :type _request_timeout: int, tuple(int, int), optional
2231
+ :param _request_auth: set to override the auth_settings for an a single
2232
+ request; this effectively ignores the
2233
+ authentication in the spec for a single request.
2234
+ :type _request_auth: dict, optional
2235
+ :param _content_type: force content-type for the request.
2236
+ :type _content_type: str, Optional
2237
+ :param _headers: set to override the headers for a single
2238
+ request; this effectively ignores the headers
2239
+ in the spec for a single request.
2240
+ :type _headers: dict, optional
2241
+ :param _host_index: set to override the host_index for a single
2242
+ request; this effectively ignores the host_index
2243
+ in the spec for a single request.
2244
+ :type _host_index: int, optional
2245
+ :return: Returns the result object.
2246
+ """ # noqa: E501
2247
+
2248
+ _param = self._get_supported_media_types_serialize(
2249
+ _request_auth=_request_auth,
2250
+ _content_type=_content_type,
2251
+ _headers=_headers,
2252
+ _host_index=_host_index,
2253
+ )
2254
+
2255
+ _response_types_map: Dict[str, Optional[str]] = {
2256
+ "200": "ServerMediaTypesResponseDto",
2257
+ }
2258
+ response_data = await self.api_client.call_api(
2259
+ *_param, _request_timeout=_request_timeout
2260
+ )
2261
+ return response_data.response
2262
+
2263
+ def _get_supported_media_types_serialize(
2264
+ self,
2265
+ _request_auth,
2266
+ _content_type,
2267
+ _headers,
2268
+ _host_index,
2269
+ ) -> RequestSerialized:
2270
+ _host = None
2271
+
2272
+ _collection_formats: Dict[str, str] = {}
2273
+
2274
+ _path_params: Dict[str, str] = {}
2275
+ _query_params: List[Tuple[str, str]] = []
2276
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2277
+ _form_params: List[Tuple[str, str]] = []
2278
+ _files: Dict[
2279
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2280
+ ] = {}
2281
+ _body_params: Optional[bytes] = None
2282
+
2283
+ # process the path parameters
2284
+ # process the query parameters
2285
+ # process the header parameters
2286
+ # process the form parameters
2287
+ # process the body parameter
2288
+
2289
+ # set the HTTP header `Accept`
2290
+ if "Accept" not in _header_params:
2291
+ _header_params["Accept"] = self.api_client.select_header_accept(
2292
+ ["application/json"]
2293
+ )
2294
+
2295
+ # authentication setting
2296
+ _auth_settings: List[str] = []
2297
+
2298
+ return self.api_client.param_serialize(
2299
+ method="GET",
2300
+ resource_path="/server/media-types",
2301
+ path_params=_path_params,
2302
+ query_params=_query_params,
2303
+ header_params=_header_params,
2304
+ body=_body_params,
2305
+ post_params=_form_params,
2306
+ files=_files,
2307
+ auth_settings=_auth_settings,
2308
+ collection_formats=_collection_formats,
2309
+ _host=_host,
2310
+ _request_auth=_request_auth,
2311
+ )
2312
+
2313
+ @validate_call
2314
+ async def get_theme(
2315
+ self,
2316
+ _request_timeout: Union[
2317
+ None,
2318
+ Annotated[StrictFloat, Field(gt=0)],
2319
+ Tuple[
2320
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2321
+ ],
2322
+ ] = None,
2323
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2324
+ _content_type: Optional[StrictStr] = None,
2325
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2326
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2327
+ ) -> ServerThemeDto:
2328
+ """Get theme
2329
+
2330
+ Retrieve the custom CSS, if existent.
2331
+
2332
+ :param _request_timeout: timeout setting for this request. If one
2333
+ number provided, it will be total request
2334
+ timeout. It can also be a pair (tuple) of
2335
+ (connection, read) timeouts.
2336
+ :type _request_timeout: int, tuple(int, int), optional
2337
+ :param _request_auth: set to override the auth_settings for an a single
2338
+ request; this effectively ignores the
2339
+ authentication in the spec for a single request.
2340
+ :type _request_auth: dict, optional
2341
+ :param _content_type: force content-type for the request.
2342
+ :type _content_type: str, Optional
2343
+ :param _headers: set to override the headers for a single
2344
+ request; this effectively ignores the headers
2345
+ in the spec for a single request.
2346
+ :type _headers: dict, optional
2347
+ :param _host_index: set to override the host_index for a single
2348
+ request; this effectively ignores the host_index
2349
+ in the spec for a single request.
2350
+ :type _host_index: int, optional
2351
+ :return: Returns the result object.
2352
+ """ # noqa: E501
2353
+
2354
+ _param = self._get_theme_serialize(
2355
+ _request_auth=_request_auth,
2356
+ _content_type=_content_type,
2357
+ _headers=_headers,
2358
+ _host_index=_host_index,
2359
+ )
2360
+
2361
+ _response_types_map: Dict[str, Optional[str]] = {
2362
+ "200": "ServerThemeDto",
2363
+ }
2364
+ response_data = await self.api_client.call_api(
2365
+ *_param, _request_timeout=_request_timeout
2366
+ )
2367
+ await response_data.read()
2368
+ return self.api_client.response_deserialize(
2369
+ response_data=response_data,
2370
+ response_types_map=_response_types_map,
2371
+ ).data
2372
+
2373
+ @validate_call
2374
+ async def get_theme_with_http_info(
2375
+ self,
2376
+ _request_timeout: Union[
2377
+ None,
2378
+ Annotated[StrictFloat, Field(gt=0)],
2379
+ Tuple[
2380
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2381
+ ],
2382
+ ] = None,
2383
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2384
+ _content_type: Optional[StrictStr] = None,
2385
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2386
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2387
+ ) -> ApiResponse[ServerThemeDto]:
2388
+ """Get theme
2389
+
2390
+ Retrieve the custom CSS, if existent.
2391
+
2392
+ :param _request_timeout: timeout setting for this request. If one
2393
+ number provided, it will be total request
2394
+ timeout. It can also be a pair (tuple) of
2395
+ (connection, read) timeouts.
2396
+ :type _request_timeout: int, tuple(int, int), optional
2397
+ :param _request_auth: set to override the auth_settings for an a single
2398
+ request; this effectively ignores the
2399
+ authentication in the spec for a single request.
2400
+ :type _request_auth: dict, optional
2401
+ :param _content_type: force content-type for the request.
2402
+ :type _content_type: str, Optional
2403
+ :param _headers: set to override the headers for a single
2404
+ request; this effectively ignores the headers
2405
+ in the spec for a single request.
2406
+ :type _headers: dict, optional
2407
+ :param _host_index: set to override the host_index for a single
2408
+ request; this effectively ignores the host_index
2409
+ in the spec for a single request.
2410
+ :type _host_index: int, optional
2411
+ :return: Returns the result object.
2412
+ """ # noqa: E501
2413
+
2414
+ _param = self._get_theme_serialize(
2415
+ _request_auth=_request_auth,
2416
+ _content_type=_content_type,
2417
+ _headers=_headers,
2418
+ _host_index=_host_index,
2419
+ )
2420
+
2421
+ _response_types_map: Dict[str, Optional[str]] = {
2422
+ "200": "ServerThemeDto",
2423
+ }
2424
+ response_data = await self.api_client.call_api(
2425
+ *_param, _request_timeout=_request_timeout
2426
+ )
2427
+ await response_data.read()
2428
+ return self.api_client.response_deserialize(
2429
+ response_data=response_data,
2430
+ response_types_map=_response_types_map,
2431
+ )
2432
+
2433
+ @validate_call
2434
+ async def get_theme_without_preload_content(
2435
+ self,
2436
+ _request_timeout: Union[
2437
+ None,
2438
+ Annotated[StrictFloat, Field(gt=0)],
2439
+ Tuple[
2440
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2441
+ ],
2442
+ ] = None,
2443
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2444
+ _content_type: Optional[StrictStr] = None,
2445
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2446
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2447
+ ) -> RESTResponseType:
2448
+ """Get theme
2449
+
2450
+ Retrieve the custom CSS, if existent.
2451
+
2452
+ :param _request_timeout: timeout setting for this request. If one
2453
+ number provided, it will be total request
2454
+ timeout. It can also be a pair (tuple) of
2455
+ (connection, read) timeouts.
2456
+ :type _request_timeout: int, tuple(int, int), optional
2457
+ :param _request_auth: set to override the auth_settings for an a single
2458
+ request; this effectively ignores the
2459
+ authentication in the spec for a single request.
2460
+ :type _request_auth: dict, optional
2461
+ :param _content_type: force content-type for the request.
2462
+ :type _content_type: str, Optional
2463
+ :param _headers: set to override the headers for a single
2464
+ request; this effectively ignores the headers
2465
+ in the spec for a single request.
2466
+ :type _headers: dict, optional
2467
+ :param _host_index: set to override the host_index for a single
2468
+ request; this effectively ignores the host_index
2469
+ in the spec for a single request.
2470
+ :type _host_index: int, optional
2471
+ :return: Returns the result object.
2472
+ """ # noqa: E501
2473
+
2474
+ _param = self._get_theme_serialize(
2475
+ _request_auth=_request_auth,
2476
+ _content_type=_content_type,
2477
+ _headers=_headers,
2478
+ _host_index=_host_index,
2479
+ )
2480
+
2481
+ _response_types_map: Dict[str, Optional[str]] = {
2482
+ "200": "ServerThemeDto",
2483
+ }
2484
+ response_data = await self.api_client.call_api(
2485
+ *_param, _request_timeout=_request_timeout
2486
+ )
2487
+ return response_data.response
2488
+
2489
+ def _get_theme_serialize(
2490
+ self,
2491
+ _request_auth,
2492
+ _content_type,
2493
+ _headers,
2494
+ _host_index,
2495
+ ) -> RequestSerialized:
2496
+ _host = None
2497
+
2498
+ _collection_formats: Dict[str, str] = {}
2499
+
2500
+ _path_params: Dict[str, str] = {}
2501
+ _query_params: List[Tuple[str, str]] = []
2502
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2503
+ _form_params: List[Tuple[str, str]] = []
2504
+ _files: Dict[
2505
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2506
+ ] = {}
2507
+ _body_params: Optional[bytes] = None
2508
+
2509
+ # process the path parameters
2510
+ # process the query parameters
2511
+ # process the header parameters
2512
+ # process the form parameters
2513
+ # process the body parameter
2514
+
2515
+ # set the HTTP header `Accept`
2516
+ if "Accept" not in _header_params:
2517
+ _header_params["Accept"] = self.api_client.select_header_accept(
2518
+ ["application/json"]
2519
+ )
2520
+
2521
+ # authentication setting
2522
+ _auth_settings: List[str] = []
2523
+
2524
+ return self.api_client.param_serialize(
2525
+ method="GET",
2526
+ resource_path="/server/theme",
2527
+ path_params=_path_params,
2528
+ query_params=_query_params,
2529
+ header_params=_header_params,
2530
+ body=_body_params,
2531
+ post_params=_form_params,
2532
+ files=_files,
2533
+ auth_settings=_auth_settings,
2534
+ collection_formats=_collection_formats,
2535
+ _host=_host,
2536
+ _request_auth=_request_auth,
2537
+ )
2538
+
2539
+ @validate_call
2540
+ async def get_version_check(
2541
+ self,
2542
+ _request_timeout: Union[
2543
+ None,
2544
+ Annotated[StrictFloat, Field(gt=0)],
2545
+ Tuple[
2546
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2547
+ ],
2548
+ ] = None,
2549
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2550
+ _content_type: Optional[StrictStr] = None,
2551
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2552
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2553
+ ) -> VersionCheckStateResponseDto:
2554
+ """Get version check status
2555
+
2556
+ Retrieve information about the last time the version check ran.
2557
+
2558
+ :param _request_timeout: timeout setting for this request. If one
2559
+ number provided, it will be total request
2560
+ timeout. It can also be a pair (tuple) of
2561
+ (connection, read) timeouts.
2562
+ :type _request_timeout: int, tuple(int, int), optional
2563
+ :param _request_auth: set to override the auth_settings for an a single
2564
+ request; this effectively ignores the
2565
+ authentication in the spec for a single request.
2566
+ :type _request_auth: dict, optional
2567
+ :param _content_type: force content-type for the request.
2568
+ :type _content_type: str, Optional
2569
+ :param _headers: set to override the headers for a single
2570
+ request; this effectively ignores the headers
2571
+ in the spec for a single request.
2572
+ :type _headers: dict, optional
2573
+ :param _host_index: set to override the host_index for a single
2574
+ request; this effectively ignores the host_index
2575
+ in the spec for a single request.
2576
+ :type _host_index: int, optional
2577
+ :return: Returns the result object.
2578
+ """ # noqa: E501
2579
+
2580
+ _param = self._get_version_check_serialize(
2581
+ _request_auth=_request_auth,
2582
+ _content_type=_content_type,
2583
+ _headers=_headers,
2584
+ _host_index=_host_index,
2585
+ )
2586
+
2587
+ _response_types_map: Dict[str, Optional[str]] = {
2588
+ "200": "VersionCheckStateResponseDto",
2589
+ }
2590
+ response_data = await self.api_client.call_api(
2591
+ *_param, _request_timeout=_request_timeout
2592
+ )
2593
+ await response_data.read()
2594
+ return self.api_client.response_deserialize(
2595
+ response_data=response_data,
2596
+ response_types_map=_response_types_map,
2597
+ ).data
2598
+
2599
+ @validate_call
2600
+ async def get_version_check_with_http_info(
2601
+ self,
2602
+ _request_timeout: Union[
2603
+ None,
2604
+ Annotated[StrictFloat, Field(gt=0)],
2605
+ Tuple[
2606
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2607
+ ],
2608
+ ] = None,
2609
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2610
+ _content_type: Optional[StrictStr] = None,
2611
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2612
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2613
+ ) -> ApiResponse[VersionCheckStateResponseDto]:
2614
+ """Get version check status
2615
+
2616
+ Retrieve information about the last time the version check ran.
2617
+
2618
+ :param _request_timeout: timeout setting for this request. If one
2619
+ number provided, it will be total request
2620
+ timeout. It can also be a pair (tuple) of
2621
+ (connection, read) timeouts.
2622
+ :type _request_timeout: int, tuple(int, int), optional
2623
+ :param _request_auth: set to override the auth_settings for an a single
2624
+ request; this effectively ignores the
2625
+ authentication in the spec for a single request.
2626
+ :type _request_auth: dict, optional
2627
+ :param _content_type: force content-type for the request.
2628
+ :type _content_type: str, Optional
2629
+ :param _headers: set to override the headers for a single
2630
+ request; this effectively ignores the headers
2631
+ in the spec for a single request.
2632
+ :type _headers: dict, optional
2633
+ :param _host_index: set to override the host_index for a single
2634
+ request; this effectively ignores the host_index
2635
+ in the spec for a single request.
2636
+ :type _host_index: int, optional
2637
+ :return: Returns the result object.
2638
+ """ # noqa: E501
2639
+
2640
+ _param = self._get_version_check_serialize(
2641
+ _request_auth=_request_auth,
2642
+ _content_type=_content_type,
2643
+ _headers=_headers,
2644
+ _host_index=_host_index,
2645
+ )
2646
+
2647
+ _response_types_map: Dict[str, Optional[str]] = {
2648
+ "200": "VersionCheckStateResponseDto",
2649
+ }
2650
+ response_data = await self.api_client.call_api(
2651
+ *_param, _request_timeout=_request_timeout
2652
+ )
2653
+ await response_data.read()
2654
+ return self.api_client.response_deserialize(
2655
+ response_data=response_data,
2656
+ response_types_map=_response_types_map,
2657
+ )
2658
+
2659
+ @validate_call
2660
+ async def get_version_check_without_preload_content(
2661
+ self,
2662
+ _request_timeout: Union[
2663
+ None,
2664
+ Annotated[StrictFloat, Field(gt=0)],
2665
+ Tuple[
2666
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2667
+ ],
2668
+ ] = None,
2669
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2670
+ _content_type: Optional[StrictStr] = None,
2671
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2672
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2673
+ ) -> RESTResponseType:
2674
+ """Get version check status
2675
+
2676
+ Retrieve information about the last time the version check ran.
2677
+
2678
+ :param _request_timeout: timeout setting for this request. If one
2679
+ number provided, it will be total request
2680
+ timeout. It can also be a pair (tuple) of
2681
+ (connection, read) timeouts.
2682
+ :type _request_timeout: int, tuple(int, int), optional
2683
+ :param _request_auth: set to override the auth_settings for an a single
2684
+ request; this effectively ignores the
2685
+ authentication in the spec for a single request.
2686
+ :type _request_auth: dict, optional
2687
+ :param _content_type: force content-type for the request.
2688
+ :type _content_type: str, Optional
2689
+ :param _headers: set to override the headers for a single
2690
+ request; this effectively ignores the headers
2691
+ in the spec for a single request.
2692
+ :type _headers: dict, optional
2693
+ :param _host_index: set to override the host_index for a single
2694
+ request; this effectively ignores the host_index
2695
+ in the spec for a single request.
2696
+ :type _host_index: int, optional
2697
+ :return: Returns the result object.
2698
+ """ # noqa: E501
2699
+
2700
+ _param = self._get_version_check_serialize(
2701
+ _request_auth=_request_auth,
2702
+ _content_type=_content_type,
2703
+ _headers=_headers,
2704
+ _host_index=_host_index,
2705
+ )
2706
+
2707
+ _response_types_map: Dict[str, Optional[str]] = {
2708
+ "200": "VersionCheckStateResponseDto",
2709
+ }
2710
+ response_data = await self.api_client.call_api(
2711
+ *_param, _request_timeout=_request_timeout
2712
+ )
2713
+ return response_data.response
2714
+
2715
+ def _get_version_check_serialize(
2716
+ self,
2717
+ _request_auth,
2718
+ _content_type,
2719
+ _headers,
2720
+ _host_index,
2721
+ ) -> RequestSerialized:
2722
+ _host = None
2723
+
2724
+ _collection_formats: Dict[str, str] = {}
2725
+
2726
+ _path_params: Dict[str, str] = {}
2727
+ _query_params: List[Tuple[str, str]] = []
2728
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2729
+ _form_params: List[Tuple[str, str]] = []
2730
+ _files: Dict[
2731
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2732
+ ] = {}
2733
+ _body_params: Optional[bytes] = None
2734
+
2735
+ # process the path parameters
2736
+ # process the query parameters
2737
+ # process the header parameters
2738
+ # process the form parameters
2739
+ # process the body parameter
2740
+
2741
+ # set the HTTP header `Accept`
2742
+ if "Accept" not in _header_params:
2743
+ _header_params["Accept"] = self.api_client.select_header_accept(
2744
+ ["application/json"]
2745
+ )
2746
+
2747
+ # authentication setting
2748
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
2749
+
2750
+ return self.api_client.param_serialize(
2751
+ method="GET",
2752
+ resource_path="/server/version-check",
2753
+ path_params=_path_params,
2754
+ query_params=_query_params,
2755
+ header_params=_header_params,
2756
+ body=_body_params,
2757
+ post_params=_form_params,
2758
+ files=_files,
2759
+ auth_settings=_auth_settings,
2760
+ collection_formats=_collection_formats,
2761
+ _host=_host,
2762
+ _request_auth=_request_auth,
2763
+ )
2764
+
2765
+ @validate_call
2766
+ async def get_version_history(
2767
+ self,
2768
+ _request_timeout: Union[
2769
+ None,
2770
+ Annotated[StrictFloat, Field(gt=0)],
2771
+ Tuple[
2772
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2773
+ ],
2774
+ ] = None,
2775
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2776
+ _content_type: Optional[StrictStr] = None,
2777
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2778
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2779
+ ) -> List[ServerVersionHistoryResponseDto]:
2780
+ """Get version history
2781
+
2782
+ Retrieve a list of past versions the server has been on.
2783
+
2784
+ :param _request_timeout: timeout setting for this request. If one
2785
+ number provided, it will be total request
2786
+ timeout. It can also be a pair (tuple) of
2787
+ (connection, read) timeouts.
2788
+ :type _request_timeout: int, tuple(int, int), optional
2789
+ :param _request_auth: set to override the auth_settings for an a single
2790
+ request; this effectively ignores the
2791
+ authentication in the spec for a single request.
2792
+ :type _request_auth: dict, optional
2793
+ :param _content_type: force content-type for the request.
2794
+ :type _content_type: str, Optional
2795
+ :param _headers: set to override the headers for a single
2796
+ request; this effectively ignores the headers
2797
+ in the spec for a single request.
2798
+ :type _headers: dict, optional
2799
+ :param _host_index: set to override the host_index for a single
2800
+ request; this effectively ignores the host_index
2801
+ in the spec for a single request.
2802
+ :type _host_index: int, optional
2803
+ :return: Returns the result object.
2804
+ """ # noqa: E501
2805
+
2806
+ _param = self._get_version_history_serialize(
2807
+ _request_auth=_request_auth,
2808
+ _content_type=_content_type,
2809
+ _headers=_headers,
2810
+ _host_index=_host_index,
2811
+ )
2812
+
2813
+ _response_types_map: Dict[str, Optional[str]] = {
2814
+ "200": "List[ServerVersionHistoryResponseDto]",
2815
+ }
2816
+ response_data = await self.api_client.call_api(
2817
+ *_param, _request_timeout=_request_timeout
2818
+ )
2819
+ await response_data.read()
2820
+ return self.api_client.response_deserialize(
2821
+ response_data=response_data,
2822
+ response_types_map=_response_types_map,
2823
+ ).data
2824
+
2825
+ @validate_call
2826
+ async def get_version_history_with_http_info(
2827
+ self,
2828
+ _request_timeout: Union[
2829
+ None,
2830
+ Annotated[StrictFloat, Field(gt=0)],
2831
+ Tuple[
2832
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2833
+ ],
2834
+ ] = None,
2835
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2836
+ _content_type: Optional[StrictStr] = None,
2837
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2838
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2839
+ ) -> ApiResponse[List[ServerVersionHistoryResponseDto]]:
2840
+ """Get version history
2841
+
2842
+ Retrieve a list of past versions the server has been on.
2843
+
2844
+ :param _request_timeout: timeout setting for this request. If one
2845
+ number provided, it will be total request
2846
+ timeout. It can also be a pair (tuple) of
2847
+ (connection, read) timeouts.
2848
+ :type _request_timeout: int, tuple(int, int), optional
2849
+ :param _request_auth: set to override the auth_settings for an a single
2850
+ request; this effectively ignores the
2851
+ authentication in the spec for a single request.
2852
+ :type _request_auth: dict, optional
2853
+ :param _content_type: force content-type for the request.
2854
+ :type _content_type: str, Optional
2855
+ :param _headers: set to override the headers for a single
2856
+ request; this effectively ignores the headers
2857
+ in the spec for a single request.
2858
+ :type _headers: dict, optional
2859
+ :param _host_index: set to override the host_index for a single
2860
+ request; this effectively ignores the host_index
2861
+ in the spec for a single request.
2862
+ :type _host_index: int, optional
2863
+ :return: Returns the result object.
2864
+ """ # noqa: E501
2865
+
2866
+ _param = self._get_version_history_serialize(
2867
+ _request_auth=_request_auth,
2868
+ _content_type=_content_type,
2869
+ _headers=_headers,
2870
+ _host_index=_host_index,
2871
+ )
2872
+
2873
+ _response_types_map: Dict[str, Optional[str]] = {
2874
+ "200": "List[ServerVersionHistoryResponseDto]",
2875
+ }
2876
+ response_data = await self.api_client.call_api(
2877
+ *_param, _request_timeout=_request_timeout
2878
+ )
2879
+ await response_data.read()
2880
+ return self.api_client.response_deserialize(
2881
+ response_data=response_data,
2882
+ response_types_map=_response_types_map,
2883
+ )
2884
+
2885
+ @validate_call
2886
+ async def get_version_history_without_preload_content(
2887
+ self,
2888
+ _request_timeout: Union[
2889
+ None,
2890
+ Annotated[StrictFloat, Field(gt=0)],
2891
+ Tuple[
2892
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2893
+ ],
2894
+ ] = None,
2895
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2896
+ _content_type: Optional[StrictStr] = None,
2897
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2898
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2899
+ ) -> RESTResponseType:
2900
+ """Get version history
2901
+
2902
+ Retrieve a list of past versions the server has been on.
2903
+
2904
+ :param _request_timeout: timeout setting for this request. If one
2905
+ number provided, it will be total request
2906
+ timeout. It can also be a pair (tuple) of
2907
+ (connection, read) timeouts.
2908
+ :type _request_timeout: int, tuple(int, int), optional
2909
+ :param _request_auth: set to override the auth_settings for an a single
2910
+ request; this effectively ignores the
2911
+ authentication in the spec for a single request.
2912
+ :type _request_auth: dict, optional
2913
+ :param _content_type: force content-type for the request.
2914
+ :type _content_type: str, Optional
2915
+ :param _headers: set to override the headers for a single
2916
+ request; this effectively ignores the headers
2917
+ in the spec for a single request.
2918
+ :type _headers: dict, optional
2919
+ :param _host_index: set to override the host_index for a single
2920
+ request; this effectively ignores the host_index
2921
+ in the spec for a single request.
2922
+ :type _host_index: int, optional
2923
+ :return: Returns the result object.
2924
+ """ # noqa: E501
2925
+
2926
+ _param = self._get_version_history_serialize(
2927
+ _request_auth=_request_auth,
2928
+ _content_type=_content_type,
2929
+ _headers=_headers,
2930
+ _host_index=_host_index,
2931
+ )
2932
+
2933
+ _response_types_map: Dict[str, Optional[str]] = {
2934
+ "200": "List[ServerVersionHistoryResponseDto]",
2935
+ }
2936
+ response_data = await self.api_client.call_api(
2937
+ *_param, _request_timeout=_request_timeout
2938
+ )
2939
+ return response_data.response
2940
+
2941
+ def _get_version_history_serialize(
2942
+ self,
2943
+ _request_auth,
2944
+ _content_type,
2945
+ _headers,
2946
+ _host_index,
2947
+ ) -> RequestSerialized:
2948
+ _host = None
2949
+
2950
+ _collection_formats: Dict[str, str] = {}
2951
+
2952
+ _path_params: Dict[str, str] = {}
2953
+ _query_params: List[Tuple[str, str]] = []
2954
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2955
+ _form_params: List[Tuple[str, str]] = []
2956
+ _files: Dict[
2957
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2958
+ ] = {}
2959
+ _body_params: Optional[bytes] = None
2960
+
2961
+ # process the path parameters
2962
+ # process the query parameters
2963
+ # process the header parameters
2964
+ # process the form parameters
2965
+ # process the body parameter
2966
+
2967
+ # set the HTTP header `Accept`
2968
+ if "Accept" not in _header_params:
2969
+ _header_params["Accept"] = self.api_client.select_header_accept(
2970
+ ["application/json"]
2971
+ )
2972
+
2973
+ # authentication setting
2974
+ _auth_settings: List[str] = []
2975
+
2976
+ return self.api_client.param_serialize(
2977
+ method="GET",
2978
+ resource_path="/server/version-history",
2979
+ path_params=_path_params,
2980
+ query_params=_query_params,
2981
+ header_params=_header_params,
2982
+ body=_body_params,
2983
+ post_params=_form_params,
2984
+ files=_files,
2985
+ auth_settings=_auth_settings,
2986
+ collection_formats=_collection_formats,
2987
+ _host=_host,
2988
+ _request_auth=_request_auth,
2989
+ )
2990
+
2991
+ @validate_call
2992
+ async def ping_server(
2993
+ self,
2994
+ _request_timeout: Union[
2995
+ None,
2996
+ Annotated[StrictFloat, Field(gt=0)],
2997
+ Tuple[
2998
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
2999
+ ],
3000
+ ] = None,
3001
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3002
+ _content_type: Optional[StrictStr] = None,
3003
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3004
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3005
+ ) -> ServerPingResponse:
3006
+ """Ping
3007
+
3008
+ Pong
3009
+
3010
+ :param _request_timeout: timeout setting for this request. If one
3011
+ number provided, it will be total request
3012
+ timeout. It can also be a pair (tuple) of
3013
+ (connection, read) timeouts.
3014
+ :type _request_timeout: int, tuple(int, int), optional
3015
+ :param _request_auth: set to override the auth_settings for an a single
3016
+ request; this effectively ignores the
3017
+ authentication in the spec for a single request.
3018
+ :type _request_auth: dict, optional
3019
+ :param _content_type: force content-type for the request.
3020
+ :type _content_type: str, Optional
3021
+ :param _headers: set to override the headers for a single
3022
+ request; this effectively ignores the headers
3023
+ in the spec for a single request.
3024
+ :type _headers: dict, optional
3025
+ :param _host_index: set to override the host_index for a single
3026
+ request; this effectively ignores the host_index
3027
+ in the spec for a single request.
3028
+ :type _host_index: int, optional
3029
+ :return: Returns the result object.
3030
+ """ # noqa: E501
3031
+
3032
+ _param = self._ping_server_serialize(
3033
+ _request_auth=_request_auth,
3034
+ _content_type=_content_type,
3035
+ _headers=_headers,
3036
+ _host_index=_host_index,
3037
+ )
3038
+
3039
+ _response_types_map: Dict[str, Optional[str]] = {
3040
+ "200": "ServerPingResponse",
3041
+ }
3042
+ response_data = await self.api_client.call_api(
3043
+ *_param, _request_timeout=_request_timeout
3044
+ )
3045
+ await response_data.read()
3046
+ return self.api_client.response_deserialize(
3047
+ response_data=response_data,
3048
+ response_types_map=_response_types_map,
3049
+ ).data
3050
+
3051
+ @validate_call
3052
+ async def ping_server_with_http_info(
3053
+ self,
3054
+ _request_timeout: Union[
3055
+ None,
3056
+ Annotated[StrictFloat, Field(gt=0)],
3057
+ Tuple[
3058
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
3059
+ ],
3060
+ ] = None,
3061
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3062
+ _content_type: Optional[StrictStr] = None,
3063
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3064
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3065
+ ) -> ApiResponse[ServerPingResponse]:
3066
+ """Ping
3067
+
3068
+ Pong
3069
+
3070
+ :param _request_timeout: timeout setting for this request. If one
3071
+ number provided, it will be total request
3072
+ timeout. It can also be a pair (tuple) of
3073
+ (connection, read) timeouts.
3074
+ :type _request_timeout: int, tuple(int, int), optional
3075
+ :param _request_auth: set to override the auth_settings for an a single
3076
+ request; this effectively ignores the
3077
+ authentication in the spec for a single request.
3078
+ :type _request_auth: dict, optional
3079
+ :param _content_type: force content-type for the request.
3080
+ :type _content_type: str, Optional
3081
+ :param _headers: set to override the headers for a single
3082
+ request; this effectively ignores the headers
3083
+ in the spec for a single request.
3084
+ :type _headers: dict, optional
3085
+ :param _host_index: set to override the host_index for a single
3086
+ request; this effectively ignores the host_index
3087
+ in the spec for a single request.
3088
+ :type _host_index: int, optional
3089
+ :return: Returns the result object.
3090
+ """ # noqa: E501
3091
+
3092
+ _param = self._ping_server_serialize(
3093
+ _request_auth=_request_auth,
3094
+ _content_type=_content_type,
3095
+ _headers=_headers,
3096
+ _host_index=_host_index,
3097
+ )
3098
+
3099
+ _response_types_map: Dict[str, Optional[str]] = {
3100
+ "200": "ServerPingResponse",
3101
+ }
3102
+ response_data = await self.api_client.call_api(
3103
+ *_param, _request_timeout=_request_timeout
3104
+ )
3105
+ await response_data.read()
3106
+ return self.api_client.response_deserialize(
3107
+ response_data=response_data,
3108
+ response_types_map=_response_types_map,
3109
+ )
3110
+
3111
+ @validate_call
3112
+ async def ping_server_without_preload_content(
3113
+ self,
3114
+ _request_timeout: Union[
3115
+ None,
3116
+ Annotated[StrictFloat, Field(gt=0)],
3117
+ Tuple[
3118
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
3119
+ ],
3120
+ ] = None,
3121
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3122
+ _content_type: Optional[StrictStr] = None,
3123
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3124
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3125
+ ) -> RESTResponseType:
3126
+ """Ping
3127
+
3128
+ Pong
3129
+
3130
+ :param _request_timeout: timeout setting for this request. If one
3131
+ number provided, it will be total request
3132
+ timeout. It can also be a pair (tuple) of
3133
+ (connection, read) timeouts.
3134
+ :type _request_timeout: int, tuple(int, int), optional
3135
+ :param _request_auth: set to override the auth_settings for an a single
3136
+ request; this effectively ignores the
3137
+ authentication in the spec for a single request.
3138
+ :type _request_auth: dict, optional
3139
+ :param _content_type: force content-type for the request.
3140
+ :type _content_type: str, Optional
3141
+ :param _headers: set to override the headers for a single
3142
+ request; this effectively ignores the headers
3143
+ in the spec for a single request.
3144
+ :type _headers: dict, optional
3145
+ :param _host_index: set to override the host_index for a single
3146
+ request; this effectively ignores the host_index
3147
+ in the spec for a single request.
3148
+ :type _host_index: int, optional
3149
+ :return: Returns the result object.
3150
+ """ # noqa: E501
3151
+
3152
+ _param = self._ping_server_serialize(
3153
+ _request_auth=_request_auth,
3154
+ _content_type=_content_type,
3155
+ _headers=_headers,
3156
+ _host_index=_host_index,
3157
+ )
3158
+
3159
+ _response_types_map: Dict[str, Optional[str]] = {
3160
+ "200": "ServerPingResponse",
3161
+ }
3162
+ response_data = await self.api_client.call_api(
3163
+ *_param, _request_timeout=_request_timeout
3164
+ )
3165
+ return response_data.response
3166
+
3167
+ def _ping_server_serialize(
3168
+ self,
3169
+ _request_auth,
3170
+ _content_type,
3171
+ _headers,
3172
+ _host_index,
3173
+ ) -> RequestSerialized:
3174
+ _host = None
3175
+
3176
+ _collection_formats: Dict[str, str] = {}
3177
+
3178
+ _path_params: Dict[str, str] = {}
3179
+ _query_params: List[Tuple[str, str]] = []
3180
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3181
+ _form_params: List[Tuple[str, str]] = []
3182
+ _files: Dict[
3183
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3184
+ ] = {}
3185
+ _body_params: Optional[bytes] = None
3186
+
3187
+ # process the path parameters
3188
+ # process the query parameters
3189
+ # process the header parameters
3190
+ # process the form parameters
3191
+ # process the body parameter
3192
+
3193
+ # set the HTTP header `Accept`
3194
+ if "Accept" not in _header_params:
3195
+ _header_params["Accept"] = self.api_client.select_header_accept(
3196
+ ["application/json"]
3197
+ )
3198
+
3199
+ # authentication setting
3200
+ _auth_settings: List[str] = []
3201
+
3202
+ return self.api_client.param_serialize(
3203
+ method="GET",
3204
+ resource_path="/server/ping",
3205
+ path_params=_path_params,
3206
+ query_params=_query_params,
3207
+ header_params=_header_params,
3208
+ body=_body_params,
3209
+ post_params=_form_params,
3210
+ files=_files,
3211
+ auth_settings=_auth_settings,
3212
+ collection_formats=_collection_formats,
3213
+ _host=_host,
3214
+ _request_auth=_request_auth,
3215
+ )
3216
+
3217
+ @validate_call
3218
+ async def set_server_license(
3219
+ self,
3220
+ license_key_dto: LicenseKeyDto,
3221
+ _request_timeout: Union[
3222
+ None,
3223
+ Annotated[StrictFloat, Field(gt=0)],
3224
+ Tuple[
3225
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
3226
+ ],
3227
+ ] = None,
3228
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3229
+ _content_type: Optional[StrictStr] = None,
3230
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3231
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3232
+ ) -> LicenseResponseDto:
3233
+ """Set server product key
3234
+
3235
+ Validate and set the server product key if successful.
3236
+
3237
+ :param license_key_dto: (required)
3238
+ :type license_key_dto: LicenseKeyDto
3239
+ :param _request_timeout: timeout setting for this request. If one
3240
+ number provided, it will be total request
3241
+ timeout. It can also be a pair (tuple) of
3242
+ (connection, read) timeouts.
3243
+ :type _request_timeout: int, tuple(int, int), optional
3244
+ :param _request_auth: set to override the auth_settings for an a single
3245
+ request; this effectively ignores the
3246
+ authentication in the spec for a single request.
3247
+ :type _request_auth: dict, optional
3248
+ :param _content_type: force content-type for the request.
3249
+ :type _content_type: str, Optional
3250
+ :param _headers: set to override the headers for a single
3251
+ request; this effectively ignores the headers
3252
+ in the spec for a single request.
3253
+ :type _headers: dict, optional
3254
+ :param _host_index: set to override the host_index for a single
3255
+ request; this effectively ignores the host_index
3256
+ in the spec for a single request.
3257
+ :type _host_index: int, optional
3258
+ :return: Returns the result object.
3259
+ """ # noqa: E501
3260
+
3261
+ _param = self._set_server_license_serialize(
3262
+ license_key_dto=license_key_dto,
3263
+ _request_auth=_request_auth,
3264
+ _content_type=_content_type,
3265
+ _headers=_headers,
3266
+ _host_index=_host_index,
3267
+ )
3268
+
3269
+ _response_types_map: Dict[str, Optional[str]] = {
3270
+ "200": "LicenseResponseDto",
3271
+ }
3272
+ response_data = await self.api_client.call_api(
3273
+ *_param, _request_timeout=_request_timeout
3274
+ )
3275
+ await response_data.read()
3276
+ return self.api_client.response_deserialize(
3277
+ response_data=response_data,
3278
+ response_types_map=_response_types_map,
3279
+ ).data
3280
+
3281
+ @validate_call
3282
+ async def set_server_license_with_http_info(
3283
+ self,
3284
+ license_key_dto: LicenseKeyDto,
3285
+ _request_timeout: Union[
3286
+ None,
3287
+ Annotated[StrictFloat, Field(gt=0)],
3288
+ Tuple[
3289
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
3290
+ ],
3291
+ ] = None,
3292
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3293
+ _content_type: Optional[StrictStr] = None,
3294
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3295
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3296
+ ) -> ApiResponse[LicenseResponseDto]:
3297
+ """Set server product key
3298
+
3299
+ Validate and set the server product key if successful.
3300
+
3301
+ :param license_key_dto: (required)
3302
+ :type license_key_dto: LicenseKeyDto
3303
+ :param _request_timeout: timeout setting for this request. If one
3304
+ number provided, it will be total request
3305
+ timeout. It can also be a pair (tuple) of
3306
+ (connection, read) timeouts.
3307
+ :type _request_timeout: int, tuple(int, int), optional
3308
+ :param _request_auth: set to override the auth_settings for an a single
3309
+ request; this effectively ignores the
3310
+ authentication in the spec for a single request.
3311
+ :type _request_auth: dict, optional
3312
+ :param _content_type: force content-type for the request.
3313
+ :type _content_type: str, Optional
3314
+ :param _headers: set to override the headers for a single
3315
+ request; this effectively ignores the headers
3316
+ in the spec for a single request.
3317
+ :type _headers: dict, optional
3318
+ :param _host_index: set to override the host_index for a single
3319
+ request; this effectively ignores the host_index
3320
+ in the spec for a single request.
3321
+ :type _host_index: int, optional
3322
+ :return: Returns the result object.
3323
+ """ # noqa: E501
3324
+
3325
+ _param = self._set_server_license_serialize(
3326
+ license_key_dto=license_key_dto,
3327
+ _request_auth=_request_auth,
3328
+ _content_type=_content_type,
3329
+ _headers=_headers,
3330
+ _host_index=_host_index,
3331
+ )
3332
+
3333
+ _response_types_map: Dict[str, Optional[str]] = {
3334
+ "200": "LicenseResponseDto",
3335
+ }
3336
+ response_data = await self.api_client.call_api(
3337
+ *_param, _request_timeout=_request_timeout
3338
+ )
3339
+ await response_data.read()
3340
+ return self.api_client.response_deserialize(
3341
+ response_data=response_data,
3342
+ response_types_map=_response_types_map,
3343
+ )
3344
+
3345
+ @validate_call
3346
+ async def set_server_license_without_preload_content(
3347
+ self,
3348
+ license_key_dto: LicenseKeyDto,
3349
+ _request_timeout: Union[
3350
+ None,
3351
+ Annotated[StrictFloat, Field(gt=0)],
3352
+ Tuple[
3353
+ Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
3354
+ ],
3355
+ ] = None,
3356
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3357
+ _content_type: Optional[StrictStr] = None,
3358
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3359
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3360
+ ) -> RESTResponseType:
3361
+ """Set server product key
3362
+
3363
+ Validate and set the server product key if successful.
3364
+
3365
+ :param license_key_dto: (required)
3366
+ :type license_key_dto: LicenseKeyDto
3367
+ :param _request_timeout: timeout setting for this request. If one
3368
+ number provided, it will be total request
3369
+ timeout. It can also be a pair (tuple) of
3370
+ (connection, read) timeouts.
3371
+ :type _request_timeout: int, tuple(int, int), optional
3372
+ :param _request_auth: set to override the auth_settings for an a single
3373
+ request; this effectively ignores the
3374
+ authentication in the spec for a single request.
3375
+ :type _request_auth: dict, optional
3376
+ :param _content_type: force content-type for the request.
3377
+ :type _content_type: str, Optional
3378
+ :param _headers: set to override the headers for a single
3379
+ request; this effectively ignores the headers
3380
+ in the spec for a single request.
3381
+ :type _headers: dict, optional
3382
+ :param _host_index: set to override the host_index for a single
3383
+ request; this effectively ignores the host_index
3384
+ in the spec for a single request.
3385
+ :type _host_index: int, optional
3386
+ :return: Returns the result object.
3387
+ """ # noqa: E501
3388
+
3389
+ _param = self._set_server_license_serialize(
3390
+ license_key_dto=license_key_dto,
3391
+ _request_auth=_request_auth,
3392
+ _content_type=_content_type,
3393
+ _headers=_headers,
3394
+ _host_index=_host_index,
3395
+ )
3396
+
3397
+ _response_types_map: Dict[str, Optional[str]] = {
3398
+ "200": "LicenseResponseDto",
3399
+ }
3400
+ response_data = await self.api_client.call_api(
3401
+ *_param, _request_timeout=_request_timeout
3402
+ )
3403
+ return response_data.response
3404
+
3405
+ def _set_server_license_serialize(
3406
+ self,
3407
+ license_key_dto,
3408
+ _request_auth,
3409
+ _content_type,
3410
+ _headers,
3411
+ _host_index,
3412
+ ) -> RequestSerialized:
3413
+ _host = None
3414
+
3415
+ _collection_formats: Dict[str, str] = {}
3416
+
3417
+ _path_params: Dict[str, str] = {}
3418
+ _query_params: List[Tuple[str, str]] = []
3419
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3420
+ _form_params: List[Tuple[str, str]] = []
3421
+ _files: Dict[
3422
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3423
+ ] = {}
3424
+ _body_params: Optional[bytes] = None
3425
+
3426
+ # process the path parameters
3427
+ # process the query parameters
3428
+ # process the header parameters
3429
+ # process the form parameters
3430
+ # process the body parameter
3431
+ if license_key_dto is not None:
3432
+ _body_params = license_key_dto
3433
+
3434
+ # set the HTTP header `Accept`
3435
+ if "Accept" not in _header_params:
3436
+ _header_params["Accept"] = self.api_client.select_header_accept(
3437
+ ["application/json"]
3438
+ )
3439
+
3440
+ # set the HTTP header `Content-Type`
3441
+ if _content_type:
3442
+ _header_params["Content-Type"] = _content_type
3443
+ else:
3444
+ _default_content_type = self.api_client.select_header_content_type(
3445
+ ["application/json"]
3446
+ )
3447
+ if _default_content_type is not None:
3448
+ _header_params["Content-Type"] = _default_content_type
3449
+
3450
+ # authentication setting
3451
+ _auth_settings: List[str] = ["cookie", "api_key", "bearer"]
3452
+
3453
+ return self.api_client.param_serialize(
3454
+ method="PUT",
3455
+ resource_path="/server/license",
3456
+ path_params=_path_params,
3457
+ query_params=_query_params,
3458
+ header_params=_header_params,
3459
+ body=_body_params,
3460
+ post_params=_form_params,
3461
+ files=_files,
3462
+ auth_settings=_auth_settings,
3463
+ collection_formats=_collection_formats,
3464
+ _host=_host,
3465
+ _request_auth=_request_auth,
3466
+ )