flywheel-sdk 21.2.0rc0__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 (772) hide show
  1. flywheel/__init__.py +784 -0
  2. flywheel/api/__init__.py +46 -0
  3. flywheel/api/acquisitions_api.py +5014 -0
  4. flywheel/api/analyses_api.py +3848 -0
  5. flywheel/api/audit_trail_api.py +568 -0
  6. flywheel/api/auth_api.py +121 -0
  7. flywheel/api/batch_api.py +630 -0
  8. flywheel/api/bulk_api.py +140 -0
  9. flywheel/api/change_log_api.py +254 -0
  10. flywheel/api/collections_api.py +3913 -0
  11. flywheel/api/config_api.py +299 -0
  12. flywheel/api/container_tasks_api.py +137 -0
  13. flywheel/api/container_type_api.py +137 -0
  14. flywheel/api/containers_api.py +4784 -0
  15. flywheel/api/custom_filters_api.py +466 -0
  16. flywheel/api/data_view_executions_api.py +549 -0
  17. flywheel/api/dataexplorer_api.py +1192 -0
  18. flywheel/api/devices_api.py +1071 -0
  19. flywheel/api/dimse_api.py +814 -0
  20. flywheel/api/download_api.py +261 -0
  21. flywheel/api/files_api.py +1868 -0
  22. flywheel/api/form_responses_api.py +703 -0
  23. flywheel/api/gears_api.py +1875 -0
  24. flywheel/api/groups_api.py +2829 -0
  25. flywheel/api/jobs_api.py +2320 -0
  26. flywheel/api/jupyterlab_servers_api.py +245 -0
  27. flywheel/api/modalities_api.py +562 -0
  28. flywheel/api/packfiles_api.py +121 -0
  29. flywheel/api/projects_api.py +7820 -0
  30. flywheel/api/protocols_api.py +757 -0
  31. flywheel/api/reports_api.py +1057 -0
  32. flywheel/api/resolve_api.py +276 -0
  33. flywheel/api/roles_api.py +563 -0
  34. flywheel/api/sessions_api.py +5296 -0
  35. flywheel/api/site_api.py +1552 -0
  36. flywheel/api/staffing_pools_api.py +677 -0
  37. flywheel/api/subjects_api.py +5349 -0
  38. flywheel/api/tasks_api.py +897 -0
  39. flywheel/api/tree_api.py +266 -0
  40. flywheel/api/uids_api.py +140 -0
  41. flywheel/api/upload_api.py +842 -0
  42. flywheel/api/users_api.py +2142 -0
  43. flywheel/api/views_api.py +1089 -0
  44. flywheel/api_client.py +748 -0
  45. flywheel/client.py +291 -0
  46. flywheel/configuration.py +308 -0
  47. flywheel/drone_login.py +65 -0
  48. flywheel/file_spec.py +67 -0
  49. flywheel/finder.py +168 -0
  50. flywheel/flywheel.py +9867 -0
  51. flywheel/gear_context.py +374 -0
  52. flywheel/models/__init__.py +726 -0
  53. flywheel/models/access_level.py +30 -0
  54. flywheel/models/access_permission.py +197 -0
  55. flywheel/models/access_permission_output.py +192 -0
  56. flywheel/models/access_permission_update.py +166 -0
  57. flywheel/models/access_type.py +54 -0
  58. flywheel/models/accumulator.py +33 -0
  59. flywheel/models/acquisition.py +25 -0
  60. flywheel/models/acquisition_container_output.py +34 -0
  61. flywheel/models/acquisition_copy_input.py +223 -0
  62. flywheel/models/acquisition_input.py +297 -0
  63. flywheel/models/acquisition_list_output.py +767 -0
  64. flywheel/models/acquisition_modify_input.py +299 -0
  65. flywheel/models/acquisition_node.py +35 -0
  66. flywheel/models/acquisition_output.py +767 -0
  67. flywheel/models/acquisition_parents.py +241 -0
  68. flywheel/models/acquisition_template_options.py +275 -0
  69. flywheel/models/acquisition_upsert_input.py +383 -0
  70. flywheel/models/acquisition_upsert_output.py +243 -0
  71. flywheel/models/action.py +91 -0
  72. flywheel/models/adhoc_analysis_input.py +247 -0
  73. flywheel/models/analysis.py +25 -0
  74. flywheel/models/analysis_container_output.py +34 -0
  75. flywheel/models/analysis_files_create_ticket_output.py +241 -0
  76. flywheel/models/analysis_input.py +310 -0
  77. flywheel/models/analysis_input_legacy.py +25 -0
  78. flywheel/models/analysis_list_output.py +680 -0
  79. flywheel/models/analysis_list_output_inflated_job.py +650 -0
  80. flywheel/models/analysis_modify_input.py +191 -0
  81. flywheel/models/analysis_node.py +35 -0
  82. flywheel/models/analysis_output.py +683 -0
  83. flywheel/models/analysis_output_inflated_job.py +674 -0
  84. flywheel/models/analysis_parents.py +270 -0
  85. flywheel/models/analysis_update.py +25 -0
  86. flywheel/models/api_key_input_with_optional_label.py +191 -0
  87. flywheel/models/api_key_output.py +297 -0
  88. flywheel/models/as_storage.py +298 -0
  89. flywheel/models/assignee.py +192 -0
  90. flywheel/models/assignee_type.py +29 -0
  91. flywheel/models/audit_trail_report.py +486 -0
  92. flywheel/models/audit_trail_report_status.py +32 -0
  93. flywheel/models/auth0_auth_out.py +323 -0
  94. flywheel/models/auth0_options_out.py +319 -0
  95. flywheel/models/auth_out.py +357 -0
  96. flywheel/models/auth_session_output.py +272 -0
  97. flywheel/models/avatars.py +218 -0
  98. flywheel/models/aws_creds.py +191 -0
  99. flywheel/models/aws_storage.py +354 -0
  100. flywheel/models/azure_creds.py +190 -0
  101. flywheel/models/base_aet.py +245 -0
  102. flywheel/models/base_compute.py +426 -0
  103. flywheel/models/batch.py +360 -0
  104. flywheel/models/batch_cancel_output.py +36 -0
  105. flywheel/models/batch_create_filters.py +220 -0
  106. flywheel/models/batch_job_analysis_input.py +281 -0
  107. flywheel/models/batch_jobs_proposal_input.py +36 -0
  108. flywheel/models/batch_proposal.py +25 -0
  109. flywheel/models/batch_proposal_detail.py +36 -0
  110. flywheel/models/batch_proposal_input.py +25 -0
  111. flywheel/models/body.py +36 -0
  112. flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +25 -0
  113. flywheel/models/body_region.py +46 -0
  114. flywheel/models/bookmark.py +189 -0
  115. flywheel/models/bulk_move_input.py +272 -0
  116. flywheel/models/bulk_move_sessions.py +25 -0
  117. flywheel/models/callbacks_virus_scan_input.py +36 -0
  118. flywheel/models/cancelled_batch_output.py +163 -0
  119. flywheel/models/catalog_list_output.py +407 -0
  120. flywheel/models/central_out.py +299 -0
  121. flywheel/models/change.py +379 -0
  122. flywheel/models/change_log_container_type.py +38 -0
  123. flywheel/models/change_log_document.py +245 -0
  124. flywheel/models/change_method.py +33 -0
  125. flywheel/models/classic_batch_job_output.py +352 -0
  126. flywheel/models/classic_batch_job_output_inflated_jobs.py +379 -0
  127. flywheel/models/classic_batch_proposal_input.py +388 -0
  128. flywheel/models/classic_batch_proposal_output.py +471 -0
  129. flywheel/models/classification_add_delete.py +36 -0
  130. flywheel/models/classification_replace.py +36 -0
  131. flywheel/models/classification_update_input.py +36 -0
  132. flywheel/models/cohort.py +29 -0
  133. flywheel/models/collection.py +25 -0
  134. flywheel/models/collection_container_output.py +32 -0
  135. flywheel/models/collection_input.py +217 -0
  136. flywheel/models/collection_input_with_contents.py +248 -0
  137. flywheel/models/collection_node.py +192 -0
  138. flywheel/models/collection_node_level.py +31 -0
  139. flywheel/models/collection_operation.py +193 -0
  140. flywheel/models/collection_operation_type.py +29 -0
  141. flywheel/models/collection_output.py +639 -0
  142. flywheel/models/collection_with_stats.py +637 -0
  143. flywheel/models/column.py +286 -0
  144. flywheel/models/column_type.py +32 -0
  145. flywheel/models/common_classification.py +135 -0
  146. flywheel/models/common_deleted_count.py +25 -0
  147. flywheel/models/common_editions.py +25 -0
  148. flywheel/models/common_info.py +135 -0
  149. flywheel/models/common_join_origins.py +25 -0
  150. flywheel/models/common_key.py +36 -0
  151. flywheel/models/common_modified_count.py +25 -0
  152. flywheel/models/common_object_created.py +36 -0
  153. flywheel/models/common_project_settings.py +25 -0
  154. flywheel/models/common_settings.py +36 -0
  155. flywheel/models/complete_multipart_upload_output.py +189 -0
  156. flywheel/models/complete_s3_multipart_upload_input.py +241 -0
  157. flywheel/models/config_feature_map.py +36 -0
  158. flywheel/models/config_out.py +381 -0
  159. flywheel/models/config_output.py +36 -0
  160. flywheel/models/config_site_config_output.py +36 -0
  161. flywheel/models/config_site_settings.py +36 -0
  162. flywheel/models/config_site_settings_input.py +36 -0
  163. flywheel/models/conflict_types.py +30 -0
  164. flywheel/models/container_delete_reason.py +39 -0
  165. flywheel/models/container_filter.py +193 -0
  166. flywheel/models/container_id_view_input.py +521 -0
  167. flywheel/models/container_id_view_input_execute_and_save.py +308 -0
  168. flywheel/models/container_modify.py +536 -0
  169. flywheel/models/container_new_output.py +25 -0
  170. flywheel/models/container_node_min.py +350 -0
  171. flywheel/models/container_output.py +36 -0
  172. flywheel/models/container_output_with_files.py +283 -0
  173. flywheel/models/container_parents.py +311 -0
  174. flywheel/models/container_pipeline_input.py +536 -0
  175. flywheel/models/container_project_parents.py +25 -0
  176. flywheel/models/container_reference.py +193 -0
  177. flywheel/models/container_reference_with_label.py +219 -0
  178. flywheel/models/container_session_parents.py +25 -0
  179. flywheel/models/container_subject_parents.py +25 -0
  180. flywheel/models/container_type.py +39 -0
  181. flywheel/models/container_uidcheck.py +253 -0
  182. flywheel/models/container_update.py +135 -0
  183. flywheel/models/context_input.py +217 -0
  184. flywheel/models/copy_filter.py +299 -0
  185. flywheel/models/copy_status.py +32 -0
  186. flywheel/models/core_models_api_key_api_key_input.py +190 -0
  187. flywheel/models/core_models_audit_trail_create_report_input.py +273 -0
  188. flywheel/models/core_models_audit_trail_modify_report_input.py +167 -0
  189. flywheel/models/core_models_common_source.py +189 -0
  190. flywheel/models/core_models_jobs_api_key_input.py +191 -0
  191. flywheel/models/core_models_search_parent_type.py +33 -0
  192. flywheel/models/core_workflows_form_responses_models_form_parents.py +163 -0
  193. flywheel/models/core_workflows_form_responses_models_form_response_output.py +440 -0
  194. flywheel/models/core_workflows_reader_models_reader_task_parents.py +295 -0
  195. flywheel/models/creds.py +135 -0
  196. flywheel/models/curator.py +221 -0
  197. flywheel/models/current_user_output.py +707 -0
  198. flywheel/models/custom_field.py +437 -0
  199. flywheel/models/custom_form.py +244 -0
  200. flywheel/models/cvat_info.py +275 -0
  201. flywheel/models/cvat_settings.py +272 -0
  202. flywheel/models/cvat_settings_input.py +272 -0
  203. flywheel/models/cvat_sync_state.py +30 -0
  204. flywheel/models/daily_report_usage.py +565 -0
  205. flywheel/models/data_strategy.py +29 -0
  206. flywheel/models/data_view.py +25 -0
  207. flywheel/models/data_view_analysis_file_spec.py +221 -0
  208. flywheel/models/data_view_analysis_filter_spec.py +221 -0
  209. flywheel/models/data_view_column_alias.py +337 -0
  210. flywheel/models/data_view_column_spec.py +286 -0
  211. flywheel/models/data_view_execution.py +505 -0
  212. flywheel/models/data_view_execution_state.py +31 -0
  213. flywheel/models/data_view_file_spec.py +392 -0
  214. flywheel/models/data_view_group_by.py +166 -0
  215. flywheel/models/data_view_group_by_column.py +194 -0
  216. flywheel/models/data_view_name_filter_spec.py +194 -0
  217. flywheel/models/data_view_output.py +25 -0
  218. flywheel/models/data_view_save_data_view_input.py +25 -0
  219. flywheel/models/data_view_zip_filter_spec.py +223 -0
  220. flywheel/models/default_flywheel_role.py +30 -0
  221. flywheel/models/deid_log_skip_reason.py +29 -0
  222. flywheel/models/delete_by_search_query.py +253 -0
  223. flywheel/models/deleted_file.py +514 -0
  224. flywheel/models/deleted_result.py +194 -0
  225. flywheel/models/deprecated_action.py +29 -0
  226. flywheel/models/destination_container_type.py +30 -0
  227. flywheel/models/device.py +437 -0
  228. flywheel/models/device_admin_update.py +194 -0
  229. flywheel/models/device_create.py +219 -0
  230. flywheel/models/device_self_update.py +272 -0
  231. flywheel/models/device_status.py +36 -0
  232. flywheel/models/device_status_entry.py +221 -0
  233. flywheel/models/device_storage_strategy_update.py +193 -0
  234. flywheel/models/dimse_project_input.py +36 -0
  235. flywheel/models/dimse_project_output.py +36 -0
  236. flywheel/models/dimse_service_input.py +36 -0
  237. flywheel/models/dimse_service_output.py +36 -0
  238. flywheel/models/download.py +249 -0
  239. flywheel/models/download_container_filter.py +167 -0
  240. flywheel/models/download_container_filter_definition.py +222 -0
  241. flywheel/models/download_filter.py +221 -0
  242. flywheel/models/download_filter_definition.py +195 -0
  243. flywheel/models/download_format.py +29 -0
  244. flywheel/models/download_input.py +25 -0
  245. flywheel/models/download_node.py +189 -0
  246. flywheel/models/download_strategy.py +31 -0
  247. flywheel/models/download_ticket.py +36 -0
  248. flywheel/models/download_ticket_stub.py +249 -0
  249. flywheel/models/download_ticket_with_summary.py +36 -0
  250. flywheel/models/e_signature.py +242 -0
  251. flywheel/models/edition.py +169 -0
  252. flywheel/models/egress_device.py +597 -0
  253. flywheel/models/egress_device_page.py +219 -0
  254. flywheel/models/egress_provider.py +408 -0
  255. flywheel/models/egress_provider_id.py +164 -0
  256. flywheel/models/exchange_storage.py +243 -0
  257. flywheel/models/executor_info.py +353 -0
  258. flywheel/models/export_templates.py +195 -0
  259. flywheel/models/features.py +1838 -0
  260. flywheel/models/field_change.py +271 -0
  261. flywheel/models/field_change_log_document.py +245 -0
  262. flywheel/models/field_type.py +37 -0
  263. flywheel/models/file.py +1139 -0
  264. flywheel/models/file_classification_delta.py +245 -0
  265. flywheel/models/file_container_type.py +34 -0
  266. flywheel/models/file_entry.py +740 -0
  267. flywheel/models/file_export_templates.py +272 -0
  268. flywheel/models/file_format.py +33 -0
  269. flywheel/models/file_gear_info.py +215 -0
  270. flywheel/models/file_group.py +29 -0
  271. flywheel/models/file_list_output.py +1115 -0
  272. flywheel/models/file_modify_input.py +191 -0
  273. flywheel/models/file_move_input.py +221 -0
  274. flywheel/models/file_node.py +1138 -0
  275. flywheel/models/file_node_min.py +321 -0
  276. flywheel/models/file_origin.py +283 -0
  277. flywheel/models/file_output.py +1135 -0
  278. flywheel/models/file_parents.py +297 -0
  279. flywheel/models/file_reference.py +221 -0
  280. flywheel/models/file_suggestion.py +241 -0
  281. flywheel/models/file_template_options.py +299 -0
  282. flywheel/models/file_upsert_input.py +612 -0
  283. flywheel/models/file_upsert_origin.py +36 -0
  284. flywheel/models/file_upsert_output.py +1154 -0
  285. flywheel/models/file_version.py +190 -0
  286. flywheel/models/file_version_copy_of.py +273 -0
  287. flywheel/models/file_version_output.py +325 -0
  288. flywheel/models/file_via.py +245 -0
  289. flywheel/models/file_zip_entry.py +25 -0
  290. flywheel/models/file_zip_info.py +25 -0
  291. flywheel/models/filter.py +350 -0
  292. flywheel/models/filter_input.py +218 -0
  293. flywheel/models/filter_values.py +195 -0
  294. flywheel/models/filter_view.py +28 -0
  295. flywheel/models/fixed_file_version_input.py +216 -0
  296. flywheel/models/fixed_input.py +299 -0
  297. flywheel/models/form_definition.py +163 -0
  298. flywheel/models/form_response_base.py +311 -0
  299. flywheel/models/form_response_create.py +193 -0
  300. flywheel/models/gcp_creds.py +397 -0
  301. flywheel/models/gcp_storage.py +298 -0
  302. flywheel/models/gear.py +619 -0
  303. flywheel/models/gear_category.py +32 -0
  304. flywheel/models/gear_config.py +138 -0
  305. flywheel/models/gear_context_input.py +164 -0
  306. flywheel/models/gear_context_lookup.py +25 -0
  307. flywheel/models/gear_context_lookup_item.py +36 -0
  308. flywheel/models/gear_context_value_output.py +272 -0
  309. flywheel/models/gear_context_value_output_unfound.py +164 -0
  310. flywheel/models/gear_custom.py +135 -0
  311. flywheel/models/gear_directive.py +135 -0
  312. flywheel/models/gear_doc.py +25 -0
  313. flywheel/models/gear_document.py +332 -0
  314. flywheel/models/gear_document_input.py +303 -0
  315. flywheel/models/gear_document_legacy_input.py +302 -0
  316. flywheel/models/gear_environment.py +135 -0
  317. flywheel/models/gear_exchange.py +221 -0
  318. flywheel/models/gear_file_input.py +192 -0
  319. flywheel/models/gear_id_output.py +170 -0
  320. flywheel/models/gear_info.py +251 -0
  321. flywheel/models/gear_input_item.py +231 -0
  322. flywheel/models/gear_inputs.py +140 -0
  323. flywheel/models/gear_invocation.py +138 -0
  324. flywheel/models/gear_key_input.py +191 -0
  325. flywheel/models/gear_manifest.py +624 -0
  326. flywheel/models/gear_mixin.py +218 -0
  327. flywheel/models/gear_node.py +355 -0
  328. flywheel/models/gear_output_configuration.py +164 -0
  329. flywheel/models/gear_permissions.py +191 -0
  330. flywheel/models/gear_permissions_input.py +163 -0
  331. flywheel/models/gear_permissions_type.py +29 -0
  332. flywheel/models/gear_return_ticket.py +25 -0
  333. flywheel/models/gear_rule.py +653 -0
  334. flywheel/models/gear_rule_condition.py +219 -0
  335. flywheel/models/gear_rule_condition_type.py +37 -0
  336. flywheel/models/gear_rule_input.py +517 -0
  337. flywheel/models/gear_rule_modify_input.py +492 -0
  338. flywheel/models/gear_rule_output.py +652 -0
  339. flywheel/models/gear_save_submission.py +221 -0
  340. flywheel/models/gear_series.py +298 -0
  341. flywheel/models/gear_series_update.py +163 -0
  342. flywheel/models/gear_suggestion_output.py +301 -0
  343. flywheel/models/gear_ticket.py +245 -0
  344. flywheel/models/gear_ticket_output.py +163 -0
  345. flywheel/models/google_auth_out.py +299 -0
  346. flywheel/models/graph_filter.py +329 -0
  347. flywheel/models/group.py +25 -0
  348. flywheel/models/group_by.py +163 -0
  349. flywheel/models/group_by_column.py +36 -0
  350. flywheel/models/group_container_output.py +33 -0
  351. flywheel/models/group_input.py +248 -0
  352. flywheel/models/group_metadata_input.py +36 -0
  353. flywheel/models/group_node.py +34 -0
  354. flywheel/models/group_output.py +471 -0
  355. flywheel/models/group_report.py +218 -0
  356. flywheel/models/group_role.py +163 -0
  357. flywheel/models/group_settings_output.py +249 -0
  358. flywheel/models/group_update.py +249 -0
  359. flywheel/models/header_feature.py +37 -0
  360. flywheel/models/hierarchy_export_templates.py +272 -0
  361. flywheel/models/http_validation_error.py +167 -0
  362. flywheel/models/info.py +218 -0
  363. flywheel/models/info_add_remove.py +36 -0
  364. flywheel/models/info_container_type.py +35 -0
  365. flywheel/models/info_replace.py +36 -0
  366. flywheel/models/info_update_input.py +36 -0
  367. flywheel/models/ingress_provider.py +299 -0
  368. flywheel/models/ingress_providers.py +272 -0
  369. flywheel/models/ingress_site_settings.py +305 -0
  370. flywheel/models/ingress_update_provider.py +218 -0
  371. flywheel/models/inline_response200.py +163 -0
  372. flywheel/models/inline_response2001.py +171 -0
  373. flywheel/models/inline_response2002.py +163 -0
  374. flywheel/models/inline_response2003.py +36 -0
  375. flywheel/models/inline_response2005.py +25 -0
  376. flywheel/models/input_filter.py +221 -0
  377. flywheel/models/input_job.py +521 -0
  378. flywheel/models/input_job_profile.py +275 -0
  379. flywheel/models/inserted_id.py +163 -0
  380. flywheel/models/job.py +841 -0
  381. flywheel/models/job_analysis_input.py +273 -0
  382. flywheel/models/job_ask.py +301 -0
  383. flywheel/models/job_ask_response.py +195 -0
  384. flywheel/models/job_ask_response_job.py +978 -0
  385. flywheel/models/job_ask_return.py +25 -0
  386. flywheel/models/job_ask_return_criteria.py +245 -0
  387. flywheel/models/job_ask_state.py +25 -0
  388. flywheel/models/job_ask_state_response.py +163 -0
  389. flywheel/models/job_complete.py +220 -0
  390. flywheel/models/job_completion_input.py +25 -0
  391. flywheel/models/job_completion_ticket.py +25 -0
  392. flywheel/models/job_config.py +135 -0
  393. flywheel/models/job_config_input.py +272 -0
  394. flywheel/models/job_config_inputs.py +25 -0
  395. flywheel/models/job_config_output.py +25 -0
  396. flywheel/models/job_container_detail.py +25 -0
  397. flywheel/models/job_destination.py +189 -0
  398. flywheel/models/job_detail.py +925 -0
  399. flywheel/models/job_detail_container.py +190 -0
  400. flywheel/models/job_detail_file_entry.py +194 -0
  401. flywheel/models/job_detail_group.py +190 -0
  402. flywheel/models/job_detail_parent_info.py +303 -0
  403. flywheel/models/job_executor_info.py +369 -0
  404. flywheel/models/job_file_input.py +247 -0
  405. flywheel/models/job_file_input_list_output.py +247 -0
  406. flywheel/models/job_file_object.py +435 -0
  407. flywheel/models/job_file_object_list_output.py +407 -0
  408. flywheel/models/job_gear_match.py +25 -0
  409. flywheel/models/job_inputs_array_item.py +305 -0
  410. flywheel/models/job_inputs_item.py +242 -0
  411. flywheel/models/job_inputs_object.py +138 -0
  412. flywheel/models/job_list_entry.py +25 -0
  413. flywheel/models/job_list_output.py +979 -0
  414. flywheel/models/job_list_output_config.py +220 -0
  415. flywheel/models/job_log.py +189 -0
  416. flywheel/models/job_log_column.py +40 -0
  417. flywheel/models/job_log_record.py +192 -0
  418. flywheel/models/job_modify.py +193 -0
  419. flywheel/models/job_origin.py +190 -0
  420. flywheel/models/job_output.py +1005 -0
  421. flywheel/models/job_output_config.py +247 -0
  422. flywheel/models/job_parents.py +297 -0
  423. flywheel/models/job_priority.py +31 -0
  424. flywheel/models/job_priority_update.py +192 -0
  425. flywheel/models/job_profile.py +427 -0
  426. flywheel/models/job_profile_input.py +25 -0
  427. flywheel/models/job_request.py +221 -0
  428. flywheel/models/job_request_item.py +246 -0
  429. flywheel/models/job_request_item_type.py +31 -0
  430. flywheel/models/job_request_target.py +270 -0
  431. flywheel/models/job_state.py +32 -0
  432. flywheel/models/job_state_counts.py +25 -0
  433. flywheel/models/job_stats_by_state.py +25 -0
  434. flywheel/models/job_ticket_output.py +165 -0
  435. flywheel/models/job_transition_times.py +253 -0
  436. flywheel/models/job_version_info.py +135 -0
  437. flywheel/models/jobs_by_state.py +272 -0
  438. flywheel/models/jobs_list.py +166 -0
  439. flywheel/models/join_origin_device.py +164 -0
  440. flywheel/models/join_origin_job.py +219 -0
  441. flywheel/models/join_origin_user.py +189 -0
  442. flywheel/models/join_origins.py +223 -0
  443. flywheel/models/join_type.py +28 -0
  444. flywheel/models/jupyterhub_workspace.py +163 -0
  445. flywheel/models/jupyterlab_server_modify.py +275 -0
  446. flywheel/models/jupyterlab_server_origin.py +25 -0
  447. flywheel/models/jupyterlab_server_output.py +25 -0
  448. flywheel/models/jupyterlab_server_response.py +415 -0
  449. flywheel/models/jupyterlab_server_update.py +25 -0
  450. flywheel/models/ldap_sync.py +36 -0
  451. flywheel/models/ldap_sync_config.py +163 -0
  452. flywheel/models/ldap_sync_input.py +36 -0
  453. flywheel/models/ldap_sync_status.py +250 -0
  454. flywheel/models/legacy_api_key_output.py +271 -0
  455. flywheel/models/legacy_input.py +244 -0
  456. flywheel/models/legacy_usage_report.py +309 -0
  457. flywheel/models/legacys_usage_project_entry.py +194 -0
  458. flywheel/models/libs_workflows_models_parent_type.py +33 -0
  459. flywheel/models/libs_workflows_models_task_status.py +32 -0
  460. flywheel/models/local_storage.py +217 -0
  461. flywheel/models/location.py +189 -0
  462. flywheel/models/locked.py +219 -0
  463. flywheel/models/master_subject_code_dob_input.py +279 -0
  464. flywheel/models/master_subject_code_input.py +281 -0
  465. flywheel/models/master_subject_code_output.py +166 -0
  466. flywheel/models/matched_acquisition_output.py +518 -0
  467. flywheel/models/mfa_channel.py +30 -0
  468. flywheel/models/mfa_settings.py +167 -0
  469. flywheel/models/mixins.py +794 -0
  470. flywheel/models/ml_set_filter.py +194 -0
  471. flywheel/models/ml_type.py +30 -0
  472. flywheel/models/modality.py +250 -0
  473. flywheel/models/modality_input.py +244 -0
  474. flywheel/models/modality_modify.py +218 -0
  475. flywheel/models/modality_output.py +271 -0
  476. flywheel/models/modified_result.py +190 -0
  477. flywheel/models/modify_user_input.py +466 -0
  478. flywheel/models/move_conflict.py +300 -0
  479. flywheel/models/note.py +391 -0
  480. flywheel/models/note_input.py +165 -0
  481. flywheel/models/optional_input_policy.py +30 -0
  482. flywheel/models/order.py +29 -0
  483. flywheel/models/organ_system.py +64 -0
  484. flywheel/models/origin.py +193 -0
  485. flywheel/models/origin_type.py +35 -0
  486. flywheel/models/orphaned_count.py +163 -0
  487. flywheel/models/output_user_page.py +219 -0
  488. flywheel/models/packfile_cleanup_output.py +166 -0
  489. flywheel/models/packfile_removed_output.py +189 -0
  490. flywheel/models/page.py +216 -0
  491. flywheel/models/page_generic_file_output.py +219 -0
  492. flywheel/models/page_generic_filter.py +219 -0
  493. flywheel/models/page_generic_form_response_output.py +219 -0
  494. flywheel/models/page_generic_protocol.py +244 -0
  495. flywheel/models/page_generic_reader_task_output.py +244 -0
  496. flywheel/models/page_generic_staffing_pool.py +244 -0
  497. flywheel/models/parsed_query_response.py +194 -0
  498. flywheel/models/permission_access_permission.py +25 -0
  499. flywheel/models/premade_jobs_batch_job_output.py +298 -0
  500. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +299 -0
  501. flywheel/models/premade_jobs_batch_proposal.py +334 -0
  502. flywheel/models/premade_jobs_batch_proposal_detail.py +166 -0
  503. flywheel/models/premade_jobs_batch_proposal_input.py +166 -0
  504. flywheel/models/project.py +25 -0
  505. flywheel/models/project_acquisition_upsert_input.py +25 -0
  506. flywheel/models/project_acquisition_upsert_output.py +25 -0
  507. flywheel/models/project_aet.py +331 -0
  508. flywheel/models/project_aet_input.py +248 -0
  509. flywheel/models/project_catalog_list_output.py +25 -0
  510. flywheel/models/project_contact.py +194 -0
  511. flywheel/models/project_container_output.py +41 -0
  512. flywheel/models/project_copy_input.py +245 -0
  513. flywheel/models/project_copy_output.py +215 -0
  514. flywheel/models/project_counters.py +346 -0
  515. flywheel/models/project_hierarchy_input.py +278 -0
  516. flywheel/models/project_hierarchy_output.py +222 -0
  517. flywheel/models/project_hierarchy_upsert_input.py +25 -0
  518. flywheel/models/project_hierarchy_upsert_output.py +25 -0
  519. flywheel/models/project_input.py +384 -0
  520. flywheel/models/project_institution.py +194 -0
  521. flywheel/models/project_list_output.py +897 -0
  522. flywheel/models/project_locking_reason.py +32 -0
  523. flywheel/models/project_modify.py +413 -0
  524. flywheel/models/project_node.py +42 -0
  525. flywheel/models/project_output.py +899 -0
  526. flywheel/models/project_parents.py +168 -0
  527. flywheel/models/project_report.py +463 -0
  528. flywheel/models/project_report_list.py +167 -0
  529. flywheel/models/project_session_upsert_input.py +25 -0
  530. flywheel/models/project_session_upsert_output.py +25 -0
  531. flywheel/models/project_settings_input.py +333 -0
  532. flywheel/models/project_settings_output.py +333 -0
  533. flywheel/models/project_settings_sharing.py +327 -0
  534. flywheel/models/project_settings_sharing_input.py +334 -0
  535. flywheel/models/project_settings_workspaces.py +167 -0
  536. flywheel/models/project_settings_workspaces_input.py +167 -0
  537. flywheel/models/project_share_level.py +29 -0
  538. flywheel/models/project_sharing_settings_project_contact.py +25 -0
  539. flywheel/models/project_sharing_settings_project_counters.py +36 -0
  540. flywheel/models/project_sharing_settings_project_institution.py +25 -0
  541. flywheel/models/project_sharing_settings_project_settings_input.py +25 -0
  542. flywheel/models/project_sharing_settings_project_settings_output.py +25 -0
  543. flywheel/models/project_sharing_settings_project_settings_sharing.py +25 -0
  544. flywheel/models/project_sharing_settings_project_settings_sharing_input.py +25 -0
  545. flywheel/models/project_sharing_settings_project_stats.py +36 -0
  546. flywheel/models/project_stats.py +270 -0
  547. flywheel/models/project_subject_upsert_input.py +25 -0
  548. flywheel/models/project_subject_upsert_output.py +25 -0
  549. flywheel/models/project_template.py +195 -0
  550. flywheel/models/project_template_input.py +195 -0
  551. flywheel/models/project_template_list_input.py +166 -0
  552. flywheel/models/project_template_requirement.py +36 -0
  553. flywheel/models/project_template_session_template.py +36 -0
  554. flywheel/models/project_upsert_origin.py +36 -0
  555. flywheel/models/protocol.py +515 -0
  556. flywheel/models/protocol_e_signature_config.py +191 -0
  557. flywheel/models/protocol_input.py +354 -0
  558. flywheel/models/protocol_modify.py +277 -0
  559. flywheel/models/protocol_status.py +30 -0
  560. flywheel/models/provider.py +461 -0
  561. flywheel/models/provider_access_type.py +29 -0
  562. flywheel/models/provider_class.py +29 -0
  563. flywheel/models/provider_deletion_status.py +189 -0
  564. flywheel/models/provider_input.py +25 -0
  565. flywheel/models/provider_links.py +282 -0
  566. flywheel/models/provider_type.py +34 -0
  567. flywheel/models/providers.py +277 -0
  568. flywheel/models/reader_batch_create.py +463 -0
  569. flywheel/models/reader_task.py +725 -0
  570. flywheel/models/reader_task_config.py +189 -0
  571. flywheel/models/reader_task_create.py +543 -0
  572. flywheel/models/reader_task_modify.py +303 -0
  573. flywheel/models/reader_task_output.py +752 -0
  574. flywheel/models/reader_task_parent_details.py +322 -0
  575. flywheel/models/report_access_log_context.py +301 -0
  576. flywheel/models/report_access_log_context_entry.py +194 -0
  577. flywheel/models/report_access_log_context_file_entry.py +165 -0
  578. flywheel/models/report_access_log_entry.py +624 -0
  579. flywheel/models/report_access_log_origin.py +194 -0
  580. flywheel/models/report_availability_list.py +167 -0
  581. flywheel/models/report_daily_usage_entry.py +501 -0
  582. flywheel/models/report_demographics_grid.py +36 -0
  583. flywheel/models/report_ethnicity_grid.py +252 -0
  584. flywheel/models/report_gender_count.py +222 -0
  585. flywheel/models/report_group_report.py +217 -0
  586. flywheel/models/report_legacy_usage_entry.py +36 -0
  587. flywheel/models/report_legacy_usage_project_entry.py +36 -0
  588. flywheel/models/report_project.py +25 -0
  589. flywheel/models/report_site.py +192 -0
  590. flywheel/models/report_time_period.py +193 -0
  591. flywheel/models/report_usage.py +630 -0
  592. flywheel/models/report_usage_entry.py +25 -0
  593. flywheel/models/resolve_input.py +163 -0
  594. flywheel/models/resolve_output.py +194 -0
  595. flywheel/models/resolver_acquisition_node.py +36 -0
  596. flywheel/models/resolver_analysis_node.py +36 -0
  597. flywheel/models/resolver_file_node.py +36 -0
  598. flywheel/models/resolver_gear_node.py +36 -0
  599. flywheel/models/resolver_group_node.py +36 -0
  600. flywheel/models/resolver_input.py +25 -0
  601. flywheel/models/resolver_node.py +182 -0
  602. flywheel/models/resolver_output.py +25 -0
  603. flywheel/models/resolver_project_node.py +36 -0
  604. flywheel/models/resolver_session_node.py +36 -0
  605. flywheel/models/resolver_subject_node.py +36 -0
  606. flywheel/models/role_input.py +192 -0
  607. flywheel/models/role_output.py +273 -0
  608. flywheel/models/role_permission.py +194 -0
  609. flywheel/models/role_permission_output.py +189 -0
  610. flywheel/models/role_permission_update.py +163 -0
  611. flywheel/models/role_type.py +32 -0
  612. flywheel/models/role_update.py +194 -0
  613. flywheel/models/roles_backwards_compatible_role_assignment.py +36 -0
  614. flywheel/models/roles_group_role_pool_input.py +36 -0
  615. flywheel/models/roles_role.py +36 -0
  616. flywheel/models/roles_role_assignment.py +195 -0
  617. flywheel/models/roles_role_input.py +36 -0
  618. flywheel/models/rule.py +467 -0
  619. flywheel/models/rule_any.py +216 -0
  620. flywheel/models/s3_addressing_style.py +29 -0
  621. flywheel/models/s3_compat_storage.py +381 -0
  622. flywheel/models/save_search.py +298 -0
  623. flywheel/models/save_search_input.py +219 -0
  624. flywheel/models/save_search_output.py +301 -0
  625. flywheel/models/save_search_page.py +219 -0
  626. flywheel/models/save_search_parent.py +192 -0
  627. flywheel/models/save_search_update.py +194 -0
  628. flywheel/models/search_acquisition_response.py +252 -0
  629. flywheel/models/search_analysis_response.py +254 -0
  630. flywheel/models/search_collection_response.py +254 -0
  631. flywheel/models/search_file_response.py +312 -0
  632. flywheel/models/search_group_response.py +196 -0
  633. flywheel/models/search_parent_acquisition.py +47 -0
  634. flywheel/models/search_parent_analysis.py +47 -0
  635. flywheel/models/search_parent_collection.py +46 -0
  636. flywheel/models/search_parent_project.py +54 -0
  637. flywheel/models/search_parent_response.py +213 -0
  638. flywheel/models/search_parent_session.py +48 -0
  639. flywheel/models/search_parent_subject.py +48 -0
  640. flywheel/models/search_parse_error.py +252 -0
  641. flywheel/models/search_parse_search_query_result.py +36 -0
  642. flywheel/models/search_project_response.py +196 -0
  643. flywheel/models/search_query.py +337 -0
  644. flywheel/models/search_query_suggestions.py +36 -0
  645. flywheel/models/search_response.py +448 -0
  646. flywheel/models/search_return_type.py +33 -0
  647. flywheel/models/search_save_search.py +36 -0
  648. flywheel/models/search_save_search_input.py +36 -0
  649. flywheel/models/search_save_search_parent.py +36 -0
  650. flywheel/models/search_save_search_update.py +36 -0
  651. flywheel/models/search_session_response.py +252 -0
  652. flywheel/models/search_status.py +166 -0
  653. flywheel/models/search_structured_search_query.py +25 -0
  654. flywheel/models/search_subject_response.py +225 -0
  655. flywheel/models/search_suggestion.py +36 -0
  656. flywheel/models/select_item.py +190 -0
  657. flywheel/models/server_state.py +303 -0
  658. flywheel/models/service_aet.py +301 -0
  659. flywheel/models/service_aet_input.py +276 -0
  660. flywheel/models/session.py +25 -0
  661. flywheel/models/session_container_output.py +35 -0
  662. flywheel/models/session_copy_input.py +253 -0
  663. flywheel/models/session_embedded_subject.py +299 -0
  664. flywheel/models/session_input.py +431 -0
  665. flywheel/models/session_list_output.py +897 -0
  666. flywheel/models/session_metadata_input.py +36 -0
  667. flywheel/models/session_modify.py +464 -0
  668. flywheel/models/session_node.py +36 -0
  669. flywheel/models/session_output.py +897 -0
  670. flywheel/models/session_parents.py +220 -0
  671. flywheel/models/session_template_options.py +221 -0
  672. flywheel/models/session_template_recalc_output.py +165 -0
  673. flywheel/models/session_upsert_input.py +464 -0
  674. flywheel/models/session_upsert_output.py +243 -0
  675. flywheel/models/sharing_filter_options.py +345 -0
  676. flywheel/models/signed_fs_upload_output.py +189 -0
  677. flywheel/models/signed_url_cleanup_input.py +189 -0
  678. flywheel/models/signed_url_upload_input.py +190 -0
  679. flywheel/models/signed_url_upload_output.py +349 -0
  680. flywheel/models/site.py +623 -0
  681. flywheel/models/site_report.py +194 -0
  682. flywheel/models/site_settings.py +385 -0
  683. flywheel/models/sort.py +192 -0
  684. flywheel/models/stable_api_key_input.py +25 -0
  685. flywheel/models/staffing_pool.py +324 -0
  686. flywheel/models/staffing_pool_create.py +216 -0
  687. flywheel/models/staffing_pool_list.py +164 -0
  688. flywheel/models/staffing_pool_modify.py +218 -0
  689. flywheel/models/state.py +32 -0
  690. flywheel/models/static_compute.py +218 -0
  691. flywheel/models/status_transitions.py +245 -0
  692. flywheel/models/status_type.py +31 -0
  693. flywheel/models/status_value.py +31 -0
  694. flywheel/models/storage_strategy.py +30 -0
  695. flywheel/models/storage_strategy_config.py +194 -0
  696. flywheel/models/structured_query.py +165 -0
  697. flywheel/models/structured_query_suggestions.py +196 -0
  698. flywheel/models/structured_query_value_suggestion.py +247 -0
  699. flywheel/models/subject.py +34 -0
  700. flywheel/models/subject_container_output.py +36 -0
  701. flywheel/models/subject_copy_input.py +223 -0
  702. flywheel/models/subject_input.py +627 -0
  703. flywheel/models/subject_modify.py +684 -0
  704. flywheel/models/subject_node.py +37 -0
  705. flywheel/models/subject_output.py +1008 -0
  706. flywheel/models/subject_output_for_list.py +1005 -0
  707. flywheel/models/subject_parents.py +194 -0
  708. flywheel/models/subject_role_permission.py +194 -0
  709. flywheel/models/subject_state.py +30 -0
  710. flywheel/models/subject_template_options.py +191 -0
  711. flywheel/models/subject_upsert_input.py +573 -0
  712. flywheel/models/subject_upsert_output.py +216 -0
  713. flywheel/models/sync_user_input.py +322 -0
  714. flywheel/models/tag.py +165 -0
  715. flywheel/models/task_assign.py +194 -0
  716. flywheel/models/task_facet.py +29 -0
  717. flywheel/models/task_parent_ref.py +245 -0
  718. flywheel/models/task_parent_ref_input.py +219 -0
  719. flywheel/models/task_priority.py +31 -0
  720. flywheel/models/task_submission.py +189 -0
  721. flywheel/models/therapeutic_area.py +60 -0
  722. flywheel/models/transitions.py +272 -0
  723. flywheel/models/tree_container_request_spec.py +281 -0
  724. flywheel/models/tree_graph.py +142 -0
  725. flywheel/models/tree_graph_connection.py +244 -0
  726. flywheel/models/tree_graph_connections.py +142 -0
  727. flywheel/models/tree_graph_node.py +166 -0
  728. flywheel/models/tree_request.py +25 -0
  729. flywheel/models/tree_response_item.py +142 -0
  730. flywheel/models/type_str.py +31 -0
  731. flywheel/models/uid_check_input_acquisitions.py +244 -0
  732. flywheel/models/uid_check_input_sessions.py +244 -0
  733. flywheel/models/uid_check_output.py +191 -0
  734. flywheel/models/upload_complete_s3_multipart_input.py +25 -0
  735. flywheel/models/upload_complete_s3_multipart_output.py +25 -0
  736. flywheel/models/upload_signed_fs_file_upload_output.py +36 -0
  737. flywheel/models/upload_signed_upload_url_input.py +36 -0
  738. flywheel/models/upload_signed_upload_url_output.py +36 -0
  739. flywheel/models/upload_ticket_output.py +215 -0
  740. flywheel/models/upload_token_output.py +163 -0
  741. flywheel/models/upsert_result.py +31 -0
  742. flywheel/models/user.py +760 -0
  743. flywheel/models/user_api_key.py +220 -0
  744. flywheel/models/user_input.py +461 -0
  745. flywheel/models/user_jobs.py +219 -0
  746. flywheel/models/user_jobs_output.py +25 -0
  747. flywheel/models/user_output.py +36 -0
  748. flywheel/models/user_output_id.py +163 -0
  749. flywheel/models/user_preferences.py +135 -0
  750. flywheel/models/user_wechat.py +135 -0
  751. flywheel/models/validation_error.py +215 -0
  752. flywheel/models/validation_rule.py +190 -0
  753. flywheel/models/version.py +363 -0
  754. flywheel/models/version_output.py +25 -0
  755. flywheel/models/view_id_output.py +164 -0
  756. flywheel/models/view_output.py +440 -0
  757. flywheel/models/viewer_app.py +381 -0
  758. flywheel/models/viewer_app_input.py +382 -0
  759. flywheel/models/viewer_app_type.py +29 -0
  760. flywheel/models/virus_scan.py +166 -0
  761. flywheel/models/virus_scan_state.py +30 -0
  762. flywheel/models/work_in_progress_features.py +135 -0
  763. flywheel/models/zipfile_info.py +192 -0
  764. flywheel/models/zipfile_member_info.py +241 -0
  765. flywheel/partial_reader.py +50 -0
  766. flywheel/rest.py +352 -0
  767. flywheel/util.py +95 -0
  768. flywheel/view_builder.py +449 -0
  769. flywheel_sdk-21.2.0rc0.dist-info/METADATA +41 -0
  770. flywheel_sdk-21.2.0rc0.dist-info/RECORD +772 -0
  771. flywheel_sdk-21.2.0rc0.dist-info/WHEEL +4 -0
  772. flywheel_sdk-21.2.0rc0.dist-info/licenses/LICENSE.txt +18 -0
@@ -0,0 +1,1192 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Flywheel
5
+
6
+ No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
7
+
8
+ OpenAPI spec version: 0.0.1
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ """
12
+
13
+
14
+ from __future__ import absolute_import
15
+
16
+ import re # noqa: F401
17
+
18
+ # python 2 and python 3 compatibility library
19
+ import six
20
+
21
+ from flywheel.api_client import ApiClient
22
+ import flywheel.models
23
+ from flywheel.util import check_filename_params
24
+
25
+ # NOTE: This file is auto generated by the swagger code generator program.
26
+ # Do not edit the class manually.
27
+
28
+ class DataexplorerApi(object):
29
+ def __init__(self, api_client=None):
30
+ if api_client is None:
31
+ api_client = ApiClient()
32
+ self.api_client = api_client
33
+
34
+ def delete_by_search(self, body, **kwargs): # noqa: E501
35
+ """Delete containers by a search query
36
+
37
+ This method makes a synchronous HTTP request by default.
38
+
39
+ :param DeleteBySearchQuery body: (required)
40
+ :param ContainerDeleteReason delete_reason:
41
+ :param bool async_: Perform the request asynchronously
42
+ :return: DeletedResult
43
+ """
44
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
45
+ kwargs['_return_http_data_only'] = True
46
+
47
+ if kwargs.get('async_'):
48
+ return self.delete_by_search_with_http_info(body, **kwargs) # noqa: E501
49
+ else:
50
+ (data) = self.delete_by_search_with_http_info(body, **kwargs) # noqa: E501
51
+ if (
52
+ data
53
+ and hasattr(data, 'return_value')
54
+ and not ignore_simplified_return_value
55
+ ):
56
+ return data.return_value()
57
+ return data
58
+
59
+
60
+ def delete_by_search_with_http_info(self, body, **kwargs): # noqa: E501
61
+ """Delete containers by a search query
62
+
63
+ This method makes a synchronous HTTP request by default.
64
+
65
+ :param DeleteBySearchQuery body: (required)
66
+ :param ContainerDeleteReason delete_reason:
67
+ :param bool async_: Perform the request asynchronously
68
+ :return: DeletedResult
69
+ """
70
+
71
+ all_params = ['body','delete_reason',] # noqa: E501
72
+ all_params.append('async_')
73
+ all_params.append('_return_http_data_only')
74
+ all_params.append('_preload_content')
75
+ all_params.append('_request_timeout')
76
+ all_params.append('_request_out')
77
+
78
+ params = locals()
79
+ for key, val in six.iteritems(params['kwargs']):
80
+ if key not in all_params:
81
+ raise TypeError(
82
+ "Got an unexpected keyword argument '%s'"
83
+ " to method delete_by_search" % key
84
+ )
85
+ params[key] = val
86
+ del params['kwargs']
87
+ # verify the required parameter 'body' is set
88
+ if ('body' not in params or
89
+ params['body'] is None):
90
+ raise ValueError("Missing the required parameter `body` when calling `delete_by_search`") # noqa: E501
91
+ check_filename_params(params)
92
+
93
+ collection_formats = {}
94
+
95
+ path_params = {}
96
+
97
+ query_params = []
98
+ if 'delete_reason' in params:
99
+ query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
100
+
101
+ header_params = {}
102
+
103
+ form_params = []
104
+ local_var_files = {}
105
+
106
+ body_params = None
107
+ if 'body' in params:
108
+ if 'DeleteBySearchQuery'.startswith('union'):
109
+ body_type = type(params['body'])
110
+ if getattr(body_type, 'positional_to_model', None):
111
+ body_params = body_type.positional_to_model(params['body'])
112
+ else:
113
+ body_params = params['body']
114
+ else:
115
+ body_params = flywheel.models.DeleteBySearchQuery.positional_to_model(params['body'])
116
+ # HTTP header `Accept`
117
+ header_params['Accept'] = self.api_client.select_header_accept(
118
+ ['application/json']) # noqa: E501
119
+
120
+ # HTTP header `Content-Type`
121
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
122
+ ['application/json']) # noqa: E501
123
+
124
+ # Authentication setting
125
+ auth_settings = ['ApiKey'] # noqa: E501
126
+
127
+ return self.api_client.call_api(
128
+ '/dataexplorer/search', 'DELETE',
129
+ path_params,
130
+ query_params,
131
+ header_params,
132
+ body=body_params,
133
+ post_params=form_params,
134
+ files=local_var_files,
135
+ response_type='DeletedResult', # noqa: E501
136
+ auth_settings=auth_settings,
137
+ async_=params.get('async_'),
138
+ _return_http_data_only=params.get('_return_http_data_only'),
139
+ _preload_content=params.get('_preload_content', True),
140
+ _request_timeout=params.get('_request_timeout'),
141
+ _request_out=params.get('_request_out'),
142
+ collection_formats=collection_formats)
143
+
144
+ def delete_save_search(self, search_id, **kwargs): # noqa: E501
145
+ """Delete a saved search
146
+
147
+ This method makes a synchronous HTTP request by default.
148
+
149
+ :param str search_id: (required)
150
+ :param bool async_: Perform the request asynchronously
151
+ :return: DeletedResult
152
+ """
153
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
154
+ kwargs['_return_http_data_only'] = True
155
+
156
+ if kwargs.get('async_'):
157
+ return self.delete_save_search_with_http_info(search_id, **kwargs) # noqa: E501
158
+ else:
159
+ (data) = self.delete_save_search_with_http_info(search_id, **kwargs) # noqa: E501
160
+ if (
161
+ data
162
+ and hasattr(data, 'return_value')
163
+ and not ignore_simplified_return_value
164
+ ):
165
+ return data.return_value()
166
+ return data
167
+
168
+
169
+ def delete_save_search_with_http_info(self, search_id, **kwargs): # noqa: E501
170
+ """Delete a saved search
171
+
172
+ This method makes a synchronous HTTP request by default.
173
+
174
+ :param str search_id: (required)
175
+ :param bool async_: Perform the request asynchronously
176
+ :return: DeletedResult
177
+ """
178
+
179
+ all_params = ['search_id',] # noqa: E501
180
+ all_params.append('async_')
181
+ all_params.append('_return_http_data_only')
182
+ all_params.append('_preload_content')
183
+ all_params.append('_request_timeout')
184
+ all_params.append('_request_out')
185
+
186
+ params = locals()
187
+ for key, val in six.iteritems(params['kwargs']):
188
+ if key not in all_params:
189
+ raise TypeError(
190
+ "Got an unexpected keyword argument '%s'"
191
+ " to method delete_save_search" % key
192
+ )
193
+ params[key] = val
194
+ del params['kwargs']
195
+ # verify the required parameter 'search_id' is set
196
+ if ('search_id' not in params or
197
+ params['search_id'] is None):
198
+ raise ValueError("Missing the required parameter `search_id` when calling `delete_save_search`") # noqa: E501
199
+ check_filename_params(params)
200
+
201
+ collection_formats = {}
202
+
203
+ path_params = {}
204
+ if 'search_id' in params:
205
+ path_params['search_id'] = params['search_id'] # noqa: E501
206
+
207
+ query_params = []
208
+
209
+ header_params = {}
210
+
211
+ form_params = []
212
+ local_var_files = {}
213
+
214
+ body_params = None
215
+ # HTTP header `Accept`
216
+ header_params['Accept'] = self.api_client.select_header_accept(
217
+ ['application/json']) # noqa: E501
218
+
219
+ # Authentication setting
220
+ auth_settings = ['ApiKey'] # noqa: E501
221
+
222
+ return self.api_client.call_api(
223
+ '/dataexplorer/queries/{search_id}', 'DELETE',
224
+ path_params,
225
+ query_params,
226
+ header_params,
227
+ body=body_params,
228
+ post_params=form_params,
229
+ files=local_var_files,
230
+ response_type='DeletedResult', # noqa: E501
231
+ auth_settings=auth_settings,
232
+ async_=params.get('async_'),
233
+ _return_http_data_only=params.get('_return_http_data_only'),
234
+ _preload_content=params.get('_preload_content', True),
235
+ _request_timeout=params.get('_request_timeout'),
236
+ _request_out=params.get('_request_out'),
237
+ collection_formats=collection_formats)
238
+
239
+ def get_all_saved_searches(self, **kwargs): # noqa: E501
240
+ """Get Queries
241
+
242
+ This method makes a synchronous HTTP request by default.
243
+
244
+ :param bool exhaustive: Return all queries, Admin only
245
+ :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
246
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
247
+ :param int limit: The maximum number of entries to return.
248
+ :param int skip: The number of entries to skip.
249
+ :param int page: The page number (i.e. skip limit*page entries)
250
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
251
+ :param list[str] x_accept_feature:
252
+ :param bool async_: Perform the request asynchronously
253
+ :return: union[list[SaveSearchOutput],SaveSearchPage]
254
+ """
255
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
256
+ kwargs['_return_http_data_only'] = True
257
+
258
+ if kwargs.get('async_'):
259
+ return self.get_all_saved_searches_with_http_info(**kwargs) # noqa: E501
260
+ else:
261
+ (data) = self.get_all_saved_searches_with_http_info(**kwargs) # noqa: E501
262
+ if (
263
+ data
264
+ and hasattr(data, 'return_value')
265
+ and not ignore_simplified_return_value
266
+ ):
267
+ return data.return_value()
268
+ return data
269
+
270
+
271
+ def get_all_saved_searches_with_http_info(self, **kwargs): # noqa: E501
272
+ """Get Queries
273
+
274
+ This method makes a synchronous HTTP request by default.
275
+
276
+ :param bool exhaustive: Return all queries, Admin only
277
+ :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
278
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
279
+ :param int limit: The maximum number of entries to return.
280
+ :param int skip: The number of entries to skip.
281
+ :param int page: The page number (i.e. skip limit*page entries)
282
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
283
+ :param list[str] x_accept_feature:
284
+ :param bool async_: Perform the request asynchronously
285
+ :return: union[list[SaveSearchOutput],SaveSearchPage]
286
+ """
287
+
288
+ all_params = ['exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
289
+ all_params.append('async_')
290
+ all_params.append('_return_http_data_only')
291
+ all_params.append('_preload_content')
292
+ all_params.append('_request_timeout')
293
+ all_params.append('_request_out')
294
+
295
+ params = locals()
296
+ for key, val in six.iteritems(params['kwargs']):
297
+ if key not in all_params:
298
+ raise TypeError(
299
+ "Got an unexpected keyword argument '%s'"
300
+ " to method get_all_saved_searches" % key
301
+ )
302
+ params[key] = val
303
+ del params['kwargs']
304
+ check_filename_params(params)
305
+
306
+ collection_formats = {}
307
+
308
+ path_params = {}
309
+
310
+ query_params = []
311
+ if 'exhaustive' in params:
312
+ query_params.append(('exhaustive', params['exhaustive'])) # noqa: E501
313
+ if 'filter' in params:
314
+ query_params.append(('filter', params['filter'])) # noqa: E501
315
+ if 'sort' in params:
316
+ query_params.append(('sort', params['sort'])) # noqa: E501
317
+ if 'limit' in params:
318
+ query_params.append(('limit', params['limit'])) # noqa: E501
319
+ if 'skip' in params:
320
+ query_params.append(('skip', params['skip'])) # noqa: E501
321
+ if 'page' in params:
322
+ query_params.append(('page', params['page'])) # noqa: E501
323
+ if 'after_id' in params:
324
+ query_params.append(('after_id', params['after_id'])) # noqa: E501
325
+
326
+ header_params = {}
327
+ if 'x_accept_feature' in params:
328
+ header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
329
+ collection_formats['x-accept-feature'] = '' # noqa: E501
330
+
331
+ form_params = []
332
+ local_var_files = {}
333
+
334
+ body_params = None
335
+ # HTTP header `Accept`
336
+ header_params['Accept'] = self.api_client.select_header_accept(
337
+ ['application/json']) # noqa: E501
338
+
339
+ # Authentication setting
340
+ auth_settings = ['ApiKey'] # noqa: E501
341
+
342
+ return self.api_client.call_api(
343
+ '/dataexplorer/queries', 'GET',
344
+ path_params,
345
+ query_params,
346
+ header_params,
347
+ body=body_params,
348
+ post_params=form_params,
349
+ files=local_var_files,
350
+ response_type='union[list[SaveSearchOutput],SaveSearchPage]', # noqa: E501
351
+ auth_settings=auth_settings,
352
+ async_=params.get('async_'),
353
+ _return_http_data_only=params.get('_return_http_data_only'),
354
+ _preload_content=params.get('_preload_content', True),
355
+ _request_timeout=params.get('_request_timeout'),
356
+ _request_out=params.get('_request_out'),
357
+ collection_formats=collection_formats)
358
+
359
+ def get_mapped_fields(self, **kwargs): # noqa: E501
360
+ """Get fields mapped for search
361
+
362
+ This method makes a synchronous HTTP request by default.
363
+
364
+ :param str path: Dot-separated subfield to drill down to
365
+ :param bool async_: Perform the request asynchronously
366
+ :return: object
367
+ """
368
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
369
+ kwargs['_return_http_data_only'] = True
370
+
371
+ if kwargs.get('async_'):
372
+ return self.get_mapped_fields_with_http_info(**kwargs) # noqa: E501
373
+ else:
374
+ (data) = self.get_mapped_fields_with_http_info(**kwargs) # noqa: E501
375
+ if (
376
+ data
377
+ and hasattr(data, 'return_value')
378
+ and not ignore_simplified_return_value
379
+ ):
380
+ return data.return_value()
381
+ return data
382
+
383
+
384
+ def get_mapped_fields_with_http_info(self, **kwargs): # noqa: E501
385
+ """Get fields mapped for search
386
+
387
+ This method makes a synchronous HTTP request by default.
388
+
389
+ :param str path: Dot-separated subfield to drill down to
390
+ :param bool async_: Perform the request asynchronously
391
+ :return: object
392
+ """
393
+
394
+ all_params = ['path',] # noqa: E501
395
+ all_params.append('async_')
396
+ all_params.append('_return_http_data_only')
397
+ all_params.append('_preload_content')
398
+ all_params.append('_request_timeout')
399
+ all_params.append('_request_out')
400
+
401
+ params = locals()
402
+ for key, val in six.iteritems(params['kwargs']):
403
+ if key not in all_params:
404
+ raise TypeError(
405
+ "Got an unexpected keyword argument '%s'"
406
+ " to method get_mapped_fields" % key
407
+ )
408
+ params[key] = val
409
+ del params['kwargs']
410
+ check_filename_params(params)
411
+
412
+ collection_formats = {}
413
+
414
+ path_params = {}
415
+
416
+ query_params = []
417
+ if 'path' in params:
418
+ query_params.append(('path', params['path'])) # noqa: E501
419
+
420
+ header_params = {}
421
+
422
+ form_params = []
423
+ local_var_files = {}
424
+
425
+ body_params = None
426
+ # HTTP header `Accept`
427
+ header_params['Accept'] = self.api_client.select_header_accept(
428
+ ['application/json']) # noqa: E501
429
+
430
+ # Authentication setting
431
+ auth_settings = ['ApiKey'] # noqa: E501
432
+
433
+ return self.api_client.call_api(
434
+ '/dataexplorer/mapped_fields', 'GET',
435
+ path_params,
436
+ query_params,
437
+ header_params,
438
+ body=body_params,
439
+ post_params=form_params,
440
+ files=local_var_files,
441
+ response_type='object', # noqa: E501
442
+ auth_settings=auth_settings,
443
+ async_=params.get('async_'),
444
+ _return_http_data_only=params.get('_return_http_data_only'),
445
+ _preload_content=params.get('_preload_content', True),
446
+ _request_timeout=params.get('_request_timeout'),
447
+ _request_out=params.get('_request_out'),
448
+ collection_formats=collection_formats)
449
+
450
+ def get_saved_search(self, sid, **kwargs): # noqa: E501
451
+ """Return a saved search query
452
+
453
+ This method makes a synchronous HTTP request by default.
454
+
455
+ :param str sid: (required)
456
+ :param bool async_: Perform the request asynchronously
457
+ :return: SaveSearch
458
+ """
459
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
460
+ kwargs['_return_http_data_only'] = True
461
+
462
+ if kwargs.get('async_'):
463
+ return self.get_saved_search_with_http_info(sid, **kwargs) # noqa: E501
464
+ else:
465
+ (data) = self.get_saved_search_with_http_info(sid, **kwargs) # noqa: E501
466
+ if (
467
+ data
468
+ and hasattr(data, 'return_value')
469
+ and not ignore_simplified_return_value
470
+ ):
471
+ return data.return_value()
472
+ return data
473
+
474
+
475
+ def get_saved_search_with_http_info(self, sid, **kwargs): # noqa: E501
476
+ """Return a saved search query
477
+
478
+ This method makes a synchronous HTTP request by default.
479
+
480
+ :param str sid: (required)
481
+ :param bool async_: Perform the request asynchronously
482
+ :return: SaveSearch
483
+ """
484
+
485
+ all_params = ['sid',] # noqa: E501
486
+ all_params.append('async_')
487
+ all_params.append('_return_http_data_only')
488
+ all_params.append('_preload_content')
489
+ all_params.append('_request_timeout')
490
+ all_params.append('_request_out')
491
+
492
+ params = locals()
493
+ for key, val in six.iteritems(params['kwargs']):
494
+ if key not in all_params:
495
+ raise TypeError(
496
+ "Got an unexpected keyword argument '%s'"
497
+ " to method get_saved_search" % key
498
+ )
499
+ params[key] = val
500
+ del params['kwargs']
501
+ # verify the required parameter 'sid' is set
502
+ if ('sid' not in params or
503
+ params['sid'] is None):
504
+ raise ValueError("Missing the required parameter `sid` when calling `get_saved_search`") # noqa: E501
505
+ check_filename_params(params)
506
+
507
+ collection_formats = {}
508
+
509
+ path_params = {}
510
+ if 'sid' in params:
511
+ path_params['sid'] = params['sid'] # noqa: E501
512
+
513
+ query_params = []
514
+
515
+ header_params = {}
516
+
517
+ form_params = []
518
+ local_var_files = {}
519
+
520
+ body_params = None
521
+ # HTTP header `Accept`
522
+ header_params['Accept'] = self.api_client.select_header_accept(
523
+ ['application/json']) # noqa: E501
524
+
525
+ # Authentication setting
526
+ auth_settings = ['ApiKey'] # noqa: E501
527
+
528
+ return self.api_client.call_api(
529
+ '/dataexplorer/queries/{sid}', 'GET',
530
+ path_params,
531
+ query_params,
532
+ header_params,
533
+ body=body_params,
534
+ post_params=form_params,
535
+ files=local_var_files,
536
+ response_type='SaveSearch', # noqa: E501
537
+ auth_settings=auth_settings,
538
+ async_=params.get('async_'),
539
+ _return_http_data_only=params.get('_return_http_data_only'),
540
+ _preload_content=params.get('_preload_content', True),
541
+ _request_timeout=params.get('_request_timeout'),
542
+ _request_out=params.get('_request_out'),
543
+ collection_formats=collection_formats)
544
+
545
+ def get_search_query_suggestions(self, body, **kwargs): # noqa: E501
546
+ """Get suggestions for a structured search query
547
+
548
+ Send the search query from the start of the string, and get a set of suggested replacements back. When utilizing a suggestion, the caller should replace the contents from the \"from\" field to the end of the string with the provided \"value\".
549
+ This method makes a synchronous HTTP request by default.
550
+
551
+ :param StructuredQuery body: (required)
552
+ :param bool async_: Perform the request asynchronously
553
+ :return: StructuredQuerySuggestions
554
+ """
555
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
556
+ kwargs['_return_http_data_only'] = True
557
+
558
+ if kwargs.get('async_'):
559
+ return self.get_search_query_suggestions_with_http_info(body, **kwargs) # noqa: E501
560
+ else:
561
+ (data) = self.get_search_query_suggestions_with_http_info(body, **kwargs) # noqa: E501
562
+ if (
563
+ data
564
+ and hasattr(data, 'return_value')
565
+ and not ignore_simplified_return_value
566
+ ):
567
+ return data.return_value()
568
+ return data
569
+
570
+
571
+ def get_search_query_suggestions_with_http_info(self, body, **kwargs): # noqa: E501
572
+ """Get suggestions for a structured search query
573
+
574
+ Send the search query from the start of the string, and get a set of suggested replacements back. When utilizing a suggestion, the caller should replace the contents from the \"from\" field to the end of the string with the provided \"value\".
575
+ This method makes a synchronous HTTP request by default.
576
+
577
+ :param StructuredQuery body: (required)
578
+ :param bool async_: Perform the request asynchronously
579
+ :return: StructuredQuerySuggestions
580
+ """
581
+
582
+ all_params = ['body',] # noqa: E501
583
+ all_params.append('async_')
584
+ all_params.append('_return_http_data_only')
585
+ all_params.append('_preload_content')
586
+ all_params.append('_request_timeout')
587
+ all_params.append('_request_out')
588
+
589
+ params = locals()
590
+ for key, val in six.iteritems(params['kwargs']):
591
+ if key not in all_params:
592
+ raise TypeError(
593
+ "Got an unexpected keyword argument '%s'"
594
+ " to method get_search_query_suggestions" % key
595
+ )
596
+ params[key] = val
597
+ del params['kwargs']
598
+ # verify the required parameter 'body' is set
599
+ if ('body' not in params or
600
+ params['body'] is None):
601
+ raise ValueError("Missing the required parameter `body` when calling `get_search_query_suggestions`") # noqa: E501
602
+ check_filename_params(params)
603
+
604
+ collection_formats = {}
605
+
606
+ path_params = {}
607
+
608
+ query_params = []
609
+
610
+ header_params = {}
611
+
612
+ form_params = []
613
+ local_var_files = {}
614
+
615
+ body_params = None
616
+ if 'body' in params:
617
+ if 'StructuredQuery'.startswith('union'):
618
+ body_type = type(params['body'])
619
+ if getattr(body_type, 'positional_to_model', None):
620
+ body_params = body_type.positional_to_model(params['body'])
621
+ else:
622
+ body_params = params['body']
623
+ else:
624
+ body_params = flywheel.models.StructuredQuery.positional_to_model(params['body'])
625
+ # HTTP header `Accept`
626
+ header_params['Accept'] = self.api_client.select_header_accept(
627
+ ['application/json']) # noqa: E501
628
+
629
+ # HTTP header `Content-Type`
630
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
631
+ ['application/json']) # noqa: E501
632
+
633
+ # Authentication setting
634
+ auth_settings = ['ApiKey'] # noqa: E501
635
+
636
+ return self.api_client.call_api(
637
+ '/dataexplorer/search/suggest', 'POST',
638
+ path_params,
639
+ query_params,
640
+ header_params,
641
+ body=body_params,
642
+ post_params=form_params,
643
+ files=local_var_files,
644
+ response_type='StructuredQuerySuggestions', # noqa: E501
645
+ auth_settings=auth_settings,
646
+ async_=params.get('async_'),
647
+ _return_http_data_only=params.get('_return_http_data_only'),
648
+ _preload_content=params.get('_preload_content', True),
649
+ _request_timeout=params.get('_request_timeout'),
650
+ _request_out=params.get('_request_out'),
651
+ collection_formats=collection_formats)
652
+
653
+ def get_search_status(self, **kwargs): # noqa: E501
654
+ """Get the status of search (Mongo Connector)
655
+
656
+ This method makes a synchronous HTTP request by default.
657
+
658
+ :param bool async_: Perform the request asynchronously
659
+ :return: SearchStatus
660
+ """
661
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
662
+ kwargs['_return_http_data_only'] = True
663
+
664
+ if kwargs.get('async_'):
665
+ return self.get_search_status_with_http_info(**kwargs) # noqa: E501
666
+ else:
667
+ (data) = self.get_search_status_with_http_info(**kwargs) # noqa: E501
668
+ if (
669
+ data
670
+ and hasattr(data, 'return_value')
671
+ and not ignore_simplified_return_value
672
+ ):
673
+ return data.return_value()
674
+ return data
675
+
676
+
677
+ def get_search_status_with_http_info(self, **kwargs): # noqa: E501
678
+ """Get the status of search (Mongo Connector)
679
+
680
+ This method makes a synchronous HTTP request by default.
681
+
682
+ :param bool async_: Perform the request asynchronously
683
+ :return: SearchStatus
684
+ """
685
+
686
+ all_params = [] # noqa: E501
687
+ all_params.append('async_')
688
+ all_params.append('_return_http_data_only')
689
+ all_params.append('_preload_content')
690
+ all_params.append('_request_timeout')
691
+ all_params.append('_request_out')
692
+
693
+ params = locals()
694
+ for key, val in six.iteritems(params['kwargs']):
695
+ if key not in all_params:
696
+ raise TypeError(
697
+ "Got an unexpected keyword argument '%s'"
698
+ " to method get_search_status" % key
699
+ )
700
+ params[key] = val
701
+ del params['kwargs']
702
+ check_filename_params(params)
703
+
704
+ collection_formats = {}
705
+
706
+ path_params = {}
707
+
708
+ query_params = []
709
+
710
+ header_params = {}
711
+
712
+ form_params = []
713
+ local_var_files = {}
714
+
715
+ body_params = None
716
+ # HTTP header `Accept`
717
+ header_params['Accept'] = self.api_client.select_header_accept(
718
+ ['application/json']) # noqa: E501
719
+
720
+ # Authentication setting
721
+ auth_settings = ['ApiKey'] # noqa: E501
722
+
723
+ return self.api_client.call_api(
724
+ '/dataexplorer/search/status', 'GET',
725
+ path_params,
726
+ query_params,
727
+ header_params,
728
+ body=body_params,
729
+ post_params=form_params,
730
+ files=local_var_files,
731
+ response_type='SearchStatus', # noqa: E501
732
+ auth_settings=auth_settings,
733
+ async_=params.get('async_'),
734
+ _return_http_data_only=params.get('_return_http_data_only'),
735
+ _preload_content=params.get('_preload_content', True),
736
+ _request_timeout=params.get('_request_timeout'),
737
+ _request_out=params.get('_request_out'),
738
+ collection_formats=collection_formats)
739
+
740
+ def parse_search_query(self, body, **kwargs): # noqa: E501
741
+ """Parse a structured search query
742
+
743
+ Validates a search query, returning any parse errors that were encountered. In the future, this endpoint may return the abstract syntax tree or evaluated query.
744
+ This method makes a synchronous HTTP request by default.
745
+
746
+ :param StructuredQuery body: (required)
747
+ :param bool async_: Perform the request asynchronously
748
+ :return: ParsedQueryResponse
749
+ """
750
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
751
+ kwargs['_return_http_data_only'] = True
752
+
753
+ if kwargs.get('async_'):
754
+ return self.parse_search_query_with_http_info(body, **kwargs) # noqa: E501
755
+ else:
756
+ (data) = self.parse_search_query_with_http_info(body, **kwargs) # noqa: E501
757
+ if (
758
+ data
759
+ and hasattr(data, 'return_value')
760
+ and not ignore_simplified_return_value
761
+ ):
762
+ return data.return_value()
763
+ return data
764
+
765
+
766
+ def parse_search_query_with_http_info(self, body, **kwargs): # noqa: E501
767
+ """Parse a structured search query
768
+
769
+ Validates a search query, returning any parse errors that were encountered. In the future, this endpoint may return the abstract syntax tree or evaluated query.
770
+ This method makes a synchronous HTTP request by default.
771
+
772
+ :param StructuredQuery body: (required)
773
+ :param bool async_: Perform the request asynchronously
774
+ :return: ParsedQueryResponse
775
+ """
776
+
777
+ all_params = ['body',] # noqa: E501
778
+ all_params.append('async_')
779
+ all_params.append('_return_http_data_only')
780
+ all_params.append('_preload_content')
781
+ all_params.append('_request_timeout')
782
+ all_params.append('_request_out')
783
+
784
+ params = locals()
785
+ for key, val in six.iteritems(params['kwargs']):
786
+ if key not in all_params:
787
+ raise TypeError(
788
+ "Got an unexpected keyword argument '%s'"
789
+ " to method parse_search_query" % key
790
+ )
791
+ params[key] = val
792
+ del params['kwargs']
793
+ # verify the required parameter 'body' is set
794
+ if ('body' not in params or
795
+ params['body'] is None):
796
+ raise ValueError("Missing the required parameter `body` when calling `parse_search_query`") # noqa: E501
797
+ check_filename_params(params)
798
+
799
+ collection_formats = {}
800
+
801
+ path_params = {}
802
+
803
+ query_params = []
804
+
805
+ header_params = {}
806
+
807
+ form_params = []
808
+ local_var_files = {}
809
+
810
+ body_params = None
811
+ if 'body' in params:
812
+ if 'StructuredQuery'.startswith('union'):
813
+ body_type = type(params['body'])
814
+ if getattr(body_type, 'positional_to_model', None):
815
+ body_params = body_type.positional_to_model(params['body'])
816
+ else:
817
+ body_params = params['body']
818
+ else:
819
+ body_params = flywheel.models.StructuredQuery.positional_to_model(params['body'])
820
+ # HTTP header `Accept`
821
+ header_params['Accept'] = self.api_client.select_header_accept(
822
+ ['application/json']) # noqa: E501
823
+
824
+ # HTTP header `Content-Type`
825
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
826
+ ['application/json']) # noqa: E501
827
+
828
+ # Authentication setting
829
+ auth_settings = ['ApiKey'] # noqa: E501
830
+
831
+ return self.api_client.call_api(
832
+ '/dataexplorer/search/parse', 'POST',
833
+ path_params,
834
+ query_params,
835
+ header_params,
836
+ body=body_params,
837
+ post_params=form_params,
838
+ files=local_var_files,
839
+ response_type='ParsedQueryResponse', # noqa: E501
840
+ auth_settings=auth_settings,
841
+ async_=params.get('async_'),
842
+ _return_http_data_only=params.get('_return_http_data_only'),
843
+ _preload_content=params.get('_preload_content', True),
844
+ _request_timeout=params.get('_request_timeout'),
845
+ _request_out=params.get('_request_out'),
846
+ collection_formats=collection_formats)
847
+
848
+ def replace_search(self, sid, body, **kwargs): # noqa: E501
849
+ """Replace a search query
850
+
851
+ This method makes a synchronous HTTP request by default.
852
+
853
+ :param str sid: (required)
854
+ :param SaveSearchUpdate body: (required)
855
+ :param bool async_: Perform the request asynchronously
856
+ :return: SaveSearch
857
+ """
858
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
859
+ kwargs['_return_http_data_only'] = True
860
+
861
+ if kwargs.get('async_'):
862
+ return self.replace_search_with_http_info(sid, body, **kwargs) # noqa: E501
863
+ else:
864
+ (data) = self.replace_search_with_http_info(sid, body, **kwargs) # noqa: E501
865
+ if (
866
+ data
867
+ and hasattr(data, 'return_value')
868
+ and not ignore_simplified_return_value
869
+ ):
870
+ return data.return_value()
871
+ return data
872
+
873
+
874
+ def replace_search_with_http_info(self, sid, body, **kwargs): # noqa: E501
875
+ """Replace a search query
876
+
877
+ This method makes a synchronous HTTP request by default.
878
+
879
+ :param str sid: (required)
880
+ :param SaveSearchUpdate body: (required)
881
+ :param bool async_: Perform the request asynchronously
882
+ :return: SaveSearch
883
+ """
884
+
885
+ all_params = ['sid','body',] # noqa: E501
886
+ all_params.append('async_')
887
+ all_params.append('_return_http_data_only')
888
+ all_params.append('_preload_content')
889
+ all_params.append('_request_timeout')
890
+ all_params.append('_request_out')
891
+
892
+ params = locals()
893
+ for key, val in six.iteritems(params['kwargs']):
894
+ if key not in all_params:
895
+ raise TypeError(
896
+ "Got an unexpected keyword argument '%s'"
897
+ " to method replace_search" % key
898
+ )
899
+ params[key] = val
900
+ del params['kwargs']
901
+ # verify the required parameter 'sid' is set
902
+ if ('sid' not in params or
903
+ params['sid'] is None):
904
+ raise ValueError("Missing the required parameter `sid` when calling `replace_search`") # noqa: E501
905
+ # verify the required parameter 'body' is set
906
+ if ('body' not in params or
907
+ params['body'] is None):
908
+ raise ValueError("Missing the required parameter `body` when calling `replace_search`") # noqa: E501
909
+ check_filename_params(params)
910
+
911
+ collection_formats = {}
912
+
913
+ path_params = {}
914
+ if 'sid' in params:
915
+ path_params['sid'] = params['sid'] # noqa: E501
916
+
917
+ query_params = []
918
+
919
+ header_params = {}
920
+
921
+ form_params = []
922
+ local_var_files = {}
923
+
924
+ body_params = None
925
+ if 'body' in params:
926
+ if 'SaveSearchUpdate'.startswith('union'):
927
+ body_type = type(params['body'])
928
+ if getattr(body_type, 'positional_to_model', None):
929
+ body_params = body_type.positional_to_model(params['body'])
930
+ else:
931
+ body_params = params['body']
932
+ else:
933
+ body_params = flywheel.models.SaveSearchUpdate.positional_to_model(params['body'])
934
+ # HTTP header `Accept`
935
+ header_params['Accept'] = self.api_client.select_header_accept(
936
+ ['application/json']) # noqa: E501
937
+
938
+ # HTTP header `Content-Type`
939
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
940
+ ['application/json']) # noqa: E501
941
+
942
+ # Authentication setting
943
+ auth_settings = ['ApiKey'] # noqa: E501
944
+
945
+ return self.api_client.call_api(
946
+ '/dataexplorer/queries/{sid}', 'PUT',
947
+ path_params,
948
+ query_params,
949
+ header_params,
950
+ body=body_params,
951
+ post_params=form_params,
952
+ files=local_var_files,
953
+ response_type='SaveSearch', # noqa: E501
954
+ auth_settings=auth_settings,
955
+ async_=params.get('async_'),
956
+ _return_http_data_only=params.get('_return_http_data_only'),
957
+ _preload_content=params.get('_preload_content', True),
958
+ _request_timeout=params.get('_request_timeout'),
959
+ _request_out=params.get('_request_out'),
960
+ collection_formats=collection_formats)
961
+
962
+ def save_search(self, body, **kwargs): # noqa: E501
963
+ """Save a search query
964
+
965
+ This method makes a synchronous HTTP request by default.
966
+
967
+ :param SaveSearchInput body: (required)
968
+ :param bool async_: Perform the request asynchronously
969
+ :return: InsertedId
970
+ """
971
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
972
+ kwargs['_return_http_data_only'] = True
973
+
974
+ if kwargs.get('async_'):
975
+ return self.save_search_with_http_info(body, **kwargs) # noqa: E501
976
+ else:
977
+ (data) = self.save_search_with_http_info(body, **kwargs) # noqa: E501
978
+ if (
979
+ data
980
+ and hasattr(data, 'return_value')
981
+ and not ignore_simplified_return_value
982
+ ):
983
+ return data.return_value()
984
+ return data
985
+
986
+
987
+ def save_search_with_http_info(self, body, **kwargs): # noqa: E501
988
+ """Save a search query
989
+
990
+ This method makes a synchronous HTTP request by default.
991
+
992
+ :param SaveSearchInput body: (required)
993
+ :param bool async_: Perform the request asynchronously
994
+ :return: InsertedId
995
+ """
996
+
997
+ all_params = ['body',] # noqa: E501
998
+ all_params.append('async_')
999
+ all_params.append('_return_http_data_only')
1000
+ all_params.append('_preload_content')
1001
+ all_params.append('_request_timeout')
1002
+ all_params.append('_request_out')
1003
+
1004
+ params = locals()
1005
+ for key, val in six.iteritems(params['kwargs']):
1006
+ if key not in all_params:
1007
+ raise TypeError(
1008
+ "Got an unexpected keyword argument '%s'"
1009
+ " to method save_search" % key
1010
+ )
1011
+ params[key] = val
1012
+ del params['kwargs']
1013
+ # verify the required parameter 'body' is set
1014
+ if ('body' not in params or
1015
+ params['body'] is None):
1016
+ raise ValueError("Missing the required parameter `body` when calling `save_search`") # noqa: E501
1017
+ check_filename_params(params)
1018
+
1019
+ collection_formats = {}
1020
+
1021
+ path_params = {}
1022
+
1023
+ query_params = []
1024
+
1025
+ header_params = {}
1026
+
1027
+ form_params = []
1028
+ local_var_files = {}
1029
+
1030
+ body_params = None
1031
+ if 'body' in params:
1032
+ if 'SaveSearchInput'.startswith('union'):
1033
+ body_type = type(params['body'])
1034
+ if getattr(body_type, 'positional_to_model', None):
1035
+ body_params = body_type.positional_to_model(params['body'])
1036
+ else:
1037
+ body_params = params['body']
1038
+ else:
1039
+ body_params = flywheel.models.SaveSearchInput.positional_to_model(params['body'])
1040
+ # HTTP header `Accept`
1041
+ header_params['Accept'] = self.api_client.select_header_accept(
1042
+ ['application/json']) # noqa: E501
1043
+
1044
+ # HTTP header `Content-Type`
1045
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
1046
+ ['application/json']) # noqa: E501
1047
+
1048
+ # Authentication setting
1049
+ auth_settings = ['ApiKey'] # noqa: E501
1050
+
1051
+ return self.api_client.call_api(
1052
+ '/dataexplorer/queries', 'POST',
1053
+ path_params,
1054
+ query_params,
1055
+ header_params,
1056
+ body=body_params,
1057
+ post_params=form_params,
1058
+ files=local_var_files,
1059
+ response_type='InsertedId', # noqa: E501
1060
+ auth_settings=auth_settings,
1061
+ async_=params.get('async_'),
1062
+ _return_http_data_only=params.get('_return_http_data_only'),
1063
+ _preload_content=params.get('_preload_content', True),
1064
+ _request_timeout=params.get('_request_timeout'),
1065
+ _request_out=params.get('_request_out'),
1066
+ collection_formats=collection_formats)
1067
+
1068
+ def search(self, body, **kwargs): # noqa: E501
1069
+ """Perform a search query
1070
+
1071
+ This method makes a synchronous HTTP request by default.
1072
+
1073
+ :param SearchQuery body: (required)
1074
+ :param bool simple: Unwrap result documents into a list.
1075
+ :param int size: The maximum number of results to return.
1076
+ :param bool facets: Include additional statistics about the search results. Internal use only.
1077
+ :param bool csv: Format the response as a CSV file
1078
+ :param bool async_: Perform the request asynchronously
1079
+ :return: union[list[SearchResponse],object]
1080
+ """
1081
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1082
+ kwargs['_return_http_data_only'] = True
1083
+
1084
+ if kwargs.get('async_'):
1085
+ return self.search_with_http_info(body, **kwargs) # noqa: E501
1086
+ else:
1087
+ (data) = self.search_with_http_info(body, **kwargs) # noqa: E501
1088
+ if (
1089
+ data
1090
+ and hasattr(data, 'return_value')
1091
+ and not ignore_simplified_return_value
1092
+ ):
1093
+ return data.return_value()
1094
+ return data
1095
+
1096
+
1097
+ def search_with_http_info(self, body, **kwargs): # noqa: E501
1098
+ """Perform a search query
1099
+
1100
+ This method makes a synchronous HTTP request by default.
1101
+
1102
+ :param SearchQuery body: (required)
1103
+ :param bool simple: Unwrap result documents into a list.
1104
+ :param int size: The maximum number of results to return.
1105
+ :param bool facets: Include additional statistics about the search results. Internal use only.
1106
+ :param bool csv: Format the response as a CSV file
1107
+ :param bool async_: Perform the request asynchronously
1108
+ :return: union[list[SearchResponse],object]
1109
+ """
1110
+
1111
+ all_params = ['body','simple','size','facets','csv',] # noqa: E501
1112
+ all_params.append('async_')
1113
+ all_params.append('_return_http_data_only')
1114
+ all_params.append('_preload_content')
1115
+ all_params.append('_request_timeout')
1116
+ all_params.append('_request_out')
1117
+
1118
+ params = locals()
1119
+ for key, val in six.iteritems(params['kwargs']):
1120
+ if key not in all_params:
1121
+ raise TypeError(
1122
+ "Got an unexpected keyword argument '%s'"
1123
+ " to method search" % key
1124
+ )
1125
+ params[key] = val
1126
+ del params['kwargs']
1127
+ # verify the required parameter 'body' is set
1128
+ if ('body' not in params or
1129
+ params['body'] is None):
1130
+ raise ValueError("Missing the required parameter `body` when calling `search`") # noqa: E501
1131
+ check_filename_params(params)
1132
+
1133
+ collection_formats = {}
1134
+
1135
+ path_params = {}
1136
+
1137
+ query_params = []
1138
+ if 'simple' in params:
1139
+ query_params.append(('simple', params['simple'])) # noqa: E501
1140
+ else:
1141
+ query_params.append(('simple', 'true'))
1142
+ if 'size' in params:
1143
+ query_params.append(('size', params['size'])) # noqa: E501
1144
+ else:
1145
+ query_params.append(('size', '100'))
1146
+ if 'facets' in params:
1147
+ query_params.append(('facets', params['facets'])) # noqa: E501
1148
+ if 'csv' in params:
1149
+ query_params.append(('csv', params['csv'])) # noqa: E501
1150
+
1151
+ header_params = {}
1152
+
1153
+ form_params = []
1154
+ local_var_files = {}
1155
+
1156
+ body_params = None
1157
+ if 'body' in params:
1158
+ if 'SearchQuery'.startswith('union'):
1159
+ body_type = type(params['body'])
1160
+ if getattr(body_type, 'positional_to_model', None):
1161
+ body_params = body_type.positional_to_model(params['body'])
1162
+ else:
1163
+ body_params = params['body']
1164
+ else:
1165
+ body_params = flywheel.models.SearchQuery.positional_to_model(params['body'])
1166
+ # HTTP header `Accept`
1167
+ header_params['Accept'] = self.api_client.select_header_accept(
1168
+ ['application/json']) # noqa: E501
1169
+
1170
+ # HTTP header `Content-Type`
1171
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
1172
+ ['application/json']) # noqa: E501
1173
+
1174
+ # Authentication setting
1175
+ auth_settings = ['ApiKey'] # noqa: E501
1176
+
1177
+ return self.api_client.call_api(
1178
+ '/dataexplorer/search', 'POST',
1179
+ path_params,
1180
+ query_params,
1181
+ header_params,
1182
+ body=body_params,
1183
+ post_params=form_params,
1184
+ files=local_var_files,
1185
+ response_type='union[list[SearchResponse],object]', # noqa: E501
1186
+ auth_settings=auth_settings,
1187
+ async_=params.get('async_'),
1188
+ _return_http_data_only=params.get('_return_http_data_only'),
1189
+ _preload_content=params.get('_preload_content', True),
1190
+ _request_timeout=params.get('_request_timeout'),
1191
+ _request_out=params.get('_request_out'),
1192
+ collection_formats=collection_formats)