flywheel-sdk 21.4.0__py3-none-any.whl → 21.4.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 (532) hide show
  1. flywheel/api/acquisitions_api.py +562 -1033
  2. flywheel/api/analyses_api.py +425 -786
  3. flywheel/api/audit_trail_api.py +44 -78
  4. flywheel/api/auth_api.py +4 -6
  5. flywheel/api/batch_api.py +36 -60
  6. flywheel/api/bulk_api.py +6 -10
  7. flywheel/api/change_log_api.py +22 -40
  8. flywheel/api/collections_api.py +403 -740
  9. flywheel/api/config_api.py +12 -18
  10. flywheel/api/container_tasks_api.py +8 -14
  11. flywheel/api/container_type_api.py +8 -14
  12. flywheel/api/containers_api.py +538 -989
  13. flywheel/api/custom_filters_api.py +36 -64
  14. flywheel/api/data_view_executions_api.py +52 -94
  15. flywheel/api/dataexplorer_api.py +90 -158
  16. flywheel/api/devices_api.py +76 -132
  17. flywheel/api/dimse_api.py +44 -72
  18. flywheel/api/download_api.py +25 -46
  19. flywheel/api/files_api.py +150 -266
  20. flywheel/api/form_responses_api.py +56 -100
  21. flywheel/api/gears_api.py +156 -278
  22. flywheel/api/groups_api.py +238 -426
  23. flywheel/api/jobs_api.py +166 -288
  24. flywheel/api/jupyterlab_servers_api.py +14 -24
  25. flywheel/api/modalities_api.py +44 -78
  26. flywheel/api/packfiles_api.py +4 -6
  27. flywheel/api/projects_api.py +854 -1565
  28. flywheel/api/protocols_api.py +54 -94
  29. flywheel/api/reports_api.py +108 -196
  30. flywheel/api/resolve_api.py +26 -48
  31. flywheel/api/roles_api.py +46 -82
  32. flywheel/api/sessions_api.py +616 -1137
  33. flywheel/api/site_api.py +106 -182
  34. flywheel/api/staffing_pools_api.py +50 -88
  35. flywheel/api/subjects_api.py +596 -1095
  36. flywheel/api/tasks_api.py +62 -108
  37. flywheel/api/tree_api.py +28 -52
  38. flywheel/api/uids_api.py +6 -10
  39. flywheel/api/upload_api.py +88 -162
  40. flywheel/api/users_api.py +228 -418
  41. flywheel/api/views_api.py +120 -222
  42. flywheel/api_client.py +1 -1
  43. flywheel/configuration.py +2 -2
  44. flywheel/flywheel.py +4422 -811
  45. flywheel/models/access_permission.py +7 -13
  46. flywheel/models/access_permission_output.py +7 -13
  47. flywheel/models/access_permission_update.py +4 -8
  48. flywheel/models/acquisition_copy_input.py +10 -18
  49. flywheel/models/acquisition_input.py +19 -33
  50. flywheel/models/acquisition_list_output.py +70 -118
  51. flywheel/models/acquisition_modify_input.py +19 -33
  52. flywheel/models/acquisition_output.py +70 -118
  53. flywheel/models/acquisition_parents.py +13 -23
  54. flywheel/models/acquisition_template_options.py +16 -28
  55. flywheel/models/acquisition_upsert_input.py +28 -48
  56. flywheel/models/acquisition_upsert_output.py +13 -23
  57. flywheel/models/adhoc_analysis_input.py +13 -23
  58. flywheel/models/analysis_files_create_ticket_output.py +13 -23
  59. flywheel/models/analysis_input.py +19 -33
  60. flywheel/models/analysis_list_output.py +61 -103
  61. flywheel/models/analysis_list_output_inflated_job.py +58 -98
  62. flywheel/models/analysis_modify_input.py +7 -13
  63. flywheel/models/analysis_output.py +61 -103
  64. flywheel/models/analysis_output_inflated_job.py +61 -103
  65. flywheel/models/analysis_parents.py +16 -28
  66. flywheel/models/api_key_input_with_optional_label.py +7 -13
  67. flywheel/models/api_key_output.py +19 -33
  68. flywheel/models/as_storage.py +19 -33
  69. flywheel/models/assignee.py +7 -13
  70. flywheel/models/audit_trail_report.py +40 -68
  71. flywheel/models/auth0_auth_out.py +22 -38
  72. flywheel/models/auth0_options_out.py +22 -38
  73. flywheel/models/auth_out.py +19 -33
  74. flywheel/models/auth_session_output.py +16 -28
  75. flywheel/models/avatars.py +10 -18
  76. flywheel/models/aws_creds.py +7 -13
  77. flywheel/models/aws_storage.py +25 -43
  78. flywheel/models/azure_creds.py +7 -13
  79. flywheel/models/base_aet.py +13 -23
  80. flywheel/models/base_compute.py +34 -58
  81. flywheel/models/batch.py +25 -43
  82. flywheel/models/batch_create_filters.py +10 -18
  83. flywheel/models/batch_job_analysis_input.py +16 -28
  84. flywheel/models/bookmark.py +7 -13
  85. flywheel/models/bulk_move_input.py +16 -28
  86. flywheel/models/cancelled_batch_output.py +4 -8
  87. flywheel/models/catalog_list_output.py +31 -53
  88. flywheel/models/central_out.py +19 -33
  89. flywheel/models/change.py +31 -53
  90. flywheel/models/change_log_document.py +13 -23
  91. flywheel/models/classic_batch_job_output.py +25 -43
  92. flywheel/models/classic_batch_job_output_inflated_jobs.py +28 -48
  93. flywheel/models/classic_batch_proposal_input.py +28 -48
  94. flywheel/models/classic_batch_proposal_output.py +37 -63
  95. flywheel/models/collection_input.py +10 -18
  96. flywheel/models/collection_input_with_contents.py +13 -23
  97. flywheel/models/collection_node.py +7 -13
  98. flywheel/models/collection_operation.py +7 -13
  99. flywheel/models/collection_output.py +55 -93
  100. flywheel/models/collection_with_stats.py +55 -93
  101. flywheel/models/column.py +16 -28
  102. flywheel/models/common_classification.py +1 -3
  103. flywheel/models/common_info.py +1 -3
  104. flywheel/models/complete_multipart_upload_output.py +7 -13
  105. flywheel/models/complete_s3_multipart_upload_input.py +13 -23
  106. flywheel/models/config_out.py +28 -48
  107. flywheel/models/container_filter.py +7 -13
  108. flywheel/models/container_id_view_input.py +43 -73
  109. flywheel/models/container_id_view_input_execute_and_save.py +19 -33
  110. flywheel/models/container_modify.py +43 -73
  111. flywheel/models/container_node_min.py +25 -43
  112. flywheel/models/container_output_with_files.py +16 -28
  113. flywheel/models/container_parents.py +19 -33
  114. flywheel/models/container_pipeline_input.py +43 -73
  115. flywheel/models/container_reference.py +7 -13
  116. flywheel/models/container_reference_with_label.py +10 -18
  117. flywheel/models/container_uidcheck.py +13 -23
  118. flywheel/models/container_update.py +1 -3
  119. flywheel/models/context_input.py +10 -18
  120. flywheel/models/copy_filter.py +19 -33
  121. flywheel/models/core_models_api_key_api_key_input.py +7 -13
  122. flywheel/models/core_models_audit_trail_create_report_input.py +16 -28
  123. flywheel/models/core_models_audit_trail_modify_report_input.py +4 -8
  124. flywheel/models/core_models_common_source.py +7 -13
  125. flywheel/models/core_models_jobs_api_key_input.py +7 -13
  126. flywheel/models/core_workflows_form_responses_models_form_parents.py +19 -33
  127. flywheel/models/core_workflows_form_responses_models_form_response_output.py +34 -58
  128. flywheel/models/core_workflows_reader_models_reader_task_parents.py +19 -33
  129. flywheel/models/creds.py +1 -3
  130. flywheel/models/curator.py +10 -18
  131. flywheel/models/current_user_output.py +64 -108
  132. flywheel/models/custom_field.py +34 -58
  133. flywheel/models/custom_form.py +13 -23
  134. flywheel/models/cvat_info.py +16 -28
  135. flywheel/models/cvat_settings.py +16 -28
  136. flywheel/models/cvat_settings_input.py +16 -28
  137. flywheel/models/daily_report_usage.py +46 -78
  138. flywheel/models/data_view_analysis_file_spec.py +10 -18
  139. flywheel/models/data_view_analysis_filter_spec.py +10 -18
  140. flywheel/models/data_view_column_alias.py +22 -38
  141. flywheel/models/data_view_column_spec.py +16 -28
  142. flywheel/models/data_view_execution.py +40 -68
  143. flywheel/models/data_view_file_spec.py +28 -48
  144. flywheel/models/data_view_group_by.py +4 -8
  145. flywheel/models/data_view_group_by_column.py +7 -13
  146. flywheel/models/data_view_name_filter_spec.py +7 -13
  147. flywheel/models/data_view_zip_filter_spec.py +10 -18
  148. flywheel/models/delete_by_search_query.py +13 -23
  149. flywheel/models/deleted_file.py +43 -73
  150. flywheel/models/deleted_result.py +10 -18
  151. flywheel/models/device.py +34 -58
  152. flywheel/models/device_admin_update.py +7 -13
  153. flywheel/models/device_create.py +10 -18
  154. flywheel/models/device_self_update.py +16 -28
  155. flywheel/models/device_status_entry.py +10 -18
  156. flywheel/models/device_storage_strategy_update.py +7 -13
  157. flywheel/models/download.py +13 -23
  158. flywheel/models/download_container_filter.py +4 -8
  159. flywheel/models/download_container_filter_definition.py +10 -18
  160. flywheel/models/download_filter.py +10 -18
  161. flywheel/models/download_filter_definition.py +7 -13
  162. flywheel/models/download_node.py +7 -13
  163. flywheel/models/download_ticket_stub.py +13 -23
  164. flywheel/models/e_signature.py +13 -23
  165. flywheel/models/edition.py +4 -8
  166. flywheel/models/egress_device.py +52 -88
  167. flywheel/models/egress_device_page.py +10 -18
  168. flywheel/models/egress_provider.py +31 -53
  169. flywheel/models/egress_provider_id.py +4 -8
  170. flywheel/models/exchange_storage.py +13 -23
  171. flywheel/models/executor_info.py +25 -43
  172. flywheel/models/export_templates.py +7 -13
  173. flywheel/models/features.py +193 -323
  174. flywheel/models/field_change.py +16 -28
  175. flywheel/models/field_change_log_document.py +13 -23
  176. flywheel/models/file.py +112 -188
  177. flywheel/models/file_classification_delta.py +13 -23
  178. flywheel/models/file_entry.py +64 -108
  179. flywheel/models/file_export_templates.py +16 -28
  180. flywheel/models/file_gear_info.py +10 -18
  181. flywheel/models/file_list_output.py +109 -183
  182. flywheel/models/file_modify_input.py +7 -13
  183. flywheel/models/file_move_input.py +10 -18
  184. flywheel/models/file_node.py +112 -188
  185. flywheel/models/file_node_min.py +22 -38
  186. flywheel/models/file_origin.py +16 -28
  187. flywheel/models/file_output.py +109 -183
  188. flywheel/models/file_parents.py +19 -33
  189. flywheel/models/file_reference.py +10 -18
  190. flywheel/models/file_suggestion.py +13 -23
  191. flywheel/models/file_template_options.py +19 -33
  192. flywheel/models/file_upsert_input.py +52 -88
  193. flywheel/models/file_upsert_output.py +112 -188
  194. flywheel/models/file_version.py +7 -13
  195. flywheel/models/file_version_copy_of.py +16 -28
  196. flywheel/models/file_version_output.py +22 -38
  197. flywheel/models/file_via.py +13 -23
  198. flywheel/models/filter.py +25 -43
  199. flywheel/models/filter_input.py +10 -18
  200. flywheel/models/filter_values.py +7 -13
  201. flywheel/models/fixed_file_version_input.py +10 -18
  202. flywheel/models/fixed_input.py +19 -33
  203. flywheel/models/form_definition.py +4 -8
  204. flywheel/models/form_response_base.py +19 -33
  205. flywheel/models/form_response_create.py +7 -13
  206. flywheel/models/gcp_creds.py +31 -53
  207. flywheel/models/gcp_storage.py +19 -33
  208. flywheel/models/gear.py +52 -88
  209. flywheel/models/gear_config.py +1 -3
  210. flywheel/models/gear_context_input.py +4 -8
  211. flywheel/models/gear_context_value_output.py +16 -28
  212. flywheel/models/gear_context_value_output_unfound.py +4 -8
  213. flywheel/models/gear_custom.py +1 -3
  214. flywheel/models/gear_directive.py +1 -3
  215. flywheel/models/gear_document.py +22 -38
  216. flywheel/models/gear_document_input.py +19 -33
  217. flywheel/models/gear_document_legacy_input.py +19 -33
  218. flywheel/models/gear_environment.py +1 -3
  219. flywheel/models/gear_exchange.py +10 -18
  220. flywheel/models/gear_file_input.py +7 -13
  221. flywheel/models/gear_id_output.py +4 -8
  222. flywheel/models/gear_info.py +13 -23
  223. flywheel/models/gear_input_item.py +10 -18
  224. flywheel/models/gear_inputs.py +1 -3
  225. flywheel/models/gear_key_input.py +7 -13
  226. flywheel/models/gear_manifest.py +55 -93
  227. flywheel/models/gear_node.py +25 -43
  228. flywheel/models/gear_output_configuration.py +4 -8
  229. flywheel/models/gear_permissions.py +7 -13
  230. flywheel/models/gear_permissions_input.py +4 -8
  231. flywheel/models/gear_rule.py +61 -103
  232. flywheel/models/gear_rule_condition.py +10 -18
  233. flywheel/models/gear_rule_input.py +46 -78
  234. flywheel/models/gear_rule_modify_input.py +43 -73
  235. flywheel/models/gear_rule_output.py +61 -103
  236. flywheel/models/gear_save_submission.py +10 -18
  237. flywheel/models/gear_series.py +19 -33
  238. flywheel/models/gear_series_update.py +4 -8
  239. flywheel/models/gear_suggestion_output.py +19 -33
  240. flywheel/models/gear_ticket.py +13 -23
  241. flywheel/models/gear_ticket_output.py +4 -8
  242. flywheel/models/graph_filter.py +22 -38
  243. flywheel/models/group_by.py +4 -8
  244. flywheel/models/group_input.py +13 -23
  245. flywheel/models/group_output.py +37 -63
  246. flywheel/models/group_report.py +10 -18
  247. flywheel/models/group_role.py +4 -8
  248. flywheel/models/group_settings_output.py +13 -23
  249. flywheel/models/group_update.py +13 -23
  250. flywheel/models/hierarchy_export_templates.py +16 -28
  251. flywheel/models/http_validation_error.py +4 -8
  252. flywheel/models/info.py +10 -18
  253. flywheel/models/ingress_provider.py +19 -33
  254. flywheel/models/ingress_providers.py +16 -28
  255. flywheel/models/ingress_site_settings.py +16 -28
  256. flywheel/models/ingress_update_provider.py +10 -18
  257. flywheel/models/inline_response200.py +4 -8
  258. flywheel/models/inline_response2001.py +4 -8
  259. flywheel/models/inline_response2002.py +4 -8
  260. flywheel/models/input_filter.py +10 -18
  261. flywheel/models/input_job.py +43 -73
  262. flywheel/models/input_job_profile.py +16 -28
  263. flywheel/models/inserted_id.py +4 -8
  264. flywheel/models/job.py +76 -128
  265. flywheel/models/job_analysis_input.py +16 -28
  266. flywheel/models/job_ask.py +19 -33
  267. flywheel/models/job_ask_response.py +7 -13
  268. flywheel/models/job_ask_response_job.py +94 -158
  269. flywheel/models/job_ask_return_criteria.py +13 -23
  270. flywheel/models/job_ask_state_response.py +4 -8
  271. flywheel/models/job_complete.py +10 -18
  272. flywheel/models/job_config.py +1 -3
  273. flywheel/models/job_config_input.py +16 -28
  274. flywheel/models/job_destination.py +7 -13
  275. flywheel/models/job_detail.py +88 -148
  276. flywheel/models/job_detail_container.py +7 -13
  277. flywheel/models/job_detail_file_entry.py +7 -13
  278. flywheel/models/job_detail_group.py +7 -13
  279. flywheel/models/job_detail_parent_info.py +19 -33
  280. flywheel/models/job_executor_info.py +25 -43
  281. flywheel/models/job_file_input.py +13 -23
  282. flywheel/models/job_file_input_list_output.py +13 -23
  283. flywheel/models/job_file_object.py +34 -58
  284. flywheel/models/job_file_object_list_output.py +31 -53
  285. flywheel/models/job_inputs_array_item.py +19 -33
  286. flywheel/models/job_inputs_item.py +13 -23
  287. flywheel/models/job_inputs_object.py +1 -3
  288. flywheel/models/job_list_output.py +94 -158
  289. flywheel/models/job_list_output_config.py +10 -18
  290. flywheel/models/job_log.py +7 -13
  291. flywheel/models/job_log_record.py +7 -13
  292. flywheel/models/job_modify.py +7 -13
  293. flywheel/models/job_origin.py +7 -13
  294. flywheel/models/job_output.py +97 -163
  295. flywheel/models/job_output_config.py +13 -23
  296. flywheel/models/job_parents.py +19 -33
  297. flywheel/models/job_priority_update.py +7 -13
  298. flywheel/models/job_profile.py +31 -53
  299. flywheel/models/job_request.py +10 -18
  300. flywheel/models/job_request_item.py +13 -23
  301. flywheel/models/job_request_target.py +16 -28
  302. flywheel/models/job_ticket_output.py +4 -8
  303. flywheel/models/job_transition_times.py +13 -23
  304. flywheel/models/job_version_info.py +1 -3
  305. flywheel/models/jobs_by_state.py +16 -28
  306. flywheel/models/jobs_list.py +4 -8
  307. flywheel/models/join_origin_device.py +4 -8
  308. flywheel/models/join_origin_job.py +10 -18
  309. flywheel/models/join_origin_user.py +7 -13
  310. flywheel/models/join_origins.py +10 -18
  311. flywheel/models/jupyterhub_workspace.py +4 -8
  312. flywheel/models/jupyterlab_server_modify.py +16 -28
  313. flywheel/models/jupyterlab_server_response.py +31 -53
  314. flywheel/models/ldap_sync_config.py +4 -8
  315. flywheel/models/ldap_sync_status.py +13 -23
  316. flywheel/models/legacy_api_key_output.py +16 -28
  317. flywheel/models/legacy_input.py +13 -23
  318. flywheel/models/legacy_usage_report.py +19 -33
  319. flywheel/models/legacys_usage_project_entry.py +7 -13
  320. flywheel/models/libs_viewer_config_models_viewer_config.py +7 -13
  321. flywheel/models/local_storage.py +10 -18
  322. flywheel/models/location.py +7 -13
  323. flywheel/models/locked.py +10 -18
  324. flywheel/models/master_subject_code_dob_input.py +16 -28
  325. flywheel/models/master_subject_code_input.py +16 -28
  326. flywheel/models/master_subject_code_output.py +4 -8
  327. flywheel/models/matched_acquisition_output.py +43 -73
  328. flywheel/models/measurement_config.py +10 -18
  329. flywheel/models/measurement_item_config.py +10 -18
  330. flywheel/models/mfa_settings.py +4 -8
  331. flywheel/models/ml_set_filter.py +7 -13
  332. flywheel/models/modality.py +13 -23
  333. flywheel/models/modality_input.py +13 -23
  334. flywheel/models/modality_modify.py +10 -18
  335. flywheel/models/modality_output.py +16 -28
  336. flywheel/models/modified_result.py +7 -13
  337. flywheel/models/modify_user_input.py +37 -63
  338. flywheel/models/move_conflict.py +19 -33
  339. flywheel/models/note.py +28 -48
  340. flywheel/models/note_input.py +4 -8
  341. flywheel/models/origin.py +7 -13
  342. flywheel/models/orphaned_count.py +4 -8
  343. flywheel/models/output_user_page.py +10 -18
  344. flywheel/models/packfile_cleanup_output.py +4 -8
  345. flywheel/models/packfile_removed_output.py +7 -13
  346. flywheel/models/page.py +10 -18
  347. flywheel/models/page_generic_file_output.py +10 -18
  348. flywheel/models/page_generic_filter.py +10 -18
  349. flywheel/models/page_generic_form_response_output.py +10 -18
  350. flywheel/models/page_generic_protocol.py +13 -23
  351. flywheel/models/page_generic_reader_task_output.py +13 -23
  352. flywheel/models/page_generic_staffing_pool.py +13 -23
  353. flywheel/models/parsed_query_response.py +7 -13
  354. flywheel/models/premade_jobs_batch_job_output.py +19 -33
  355. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +19 -33
  356. flywheel/models/premade_jobs_batch_proposal.py +22 -38
  357. flywheel/models/premade_jobs_batch_proposal_detail.py +4 -8
  358. flywheel/models/premade_jobs_batch_proposal_input.py +4 -8
  359. flywheel/models/project_aet.py +22 -38
  360. flywheel/models/project_aet_input.py +13 -23
  361. flywheel/models/project_contact.py +7 -13
  362. flywheel/models/project_copy_input.py +13 -23
  363. flywheel/models/project_copy_output.py +10 -18
  364. flywheel/models/project_counters.py +28 -48
  365. flywheel/models/project_delete_status_output.py +7 -13
  366. flywheel/models/project_group_info.py +7 -13
  367. flywheel/models/project_hierarchy_input.py +16 -28
  368. flywheel/models/project_hierarchy_output.py +10 -18
  369. flywheel/models/project_input.py +28 -48
  370. flywheel/models/project_institution.py +7 -13
  371. flywheel/models/project_list_output.py +94 -158
  372. flywheel/models/project_modify.py +37 -63
  373. flywheel/models/project_output.py +94 -158
  374. flywheel/models/project_parents.py +4 -8
  375. flywheel/models/project_report.py +37 -63
  376. flywheel/models/project_report_list.py +4 -8
  377. flywheel/models/project_settings_input.py +22 -38
  378. flywheel/models/project_settings_output.py +22 -38
  379. flywheel/models/project_settings_sharing.py +22 -38
  380. flywheel/models/project_settings_sharing_input.py +22 -38
  381. flywheel/models/project_settings_workspaces.py +4 -8
  382. flywheel/models/project_settings_workspaces_input.py +4 -8
  383. flywheel/models/project_stats.py +16 -28
  384. flywheel/models/project_template.py +7 -13
  385. flywheel/models/project_template_input.py +7 -13
  386. flywheel/models/project_template_list_input.py +4 -8
  387. flywheel/models/protocol.py +46 -78
  388. flywheel/models/protocol_e_signature_config.py +7 -13
  389. flywheel/models/protocol_input.py +25 -43
  390. flywheel/models/protocol_modify.py +16 -28
  391. flywheel/models/provider.py +37 -63
  392. flywheel/models/provider_deletion_status.py +7 -13
  393. flywheel/models/provider_links.py +16 -28
  394. flywheel/models/providers.py +16 -28
  395. flywheel/models/reader_batch_create.py +37 -63
  396. flywheel/models/reader_task.py +67 -113
  397. flywheel/models/reader_task_config.py +10 -18
  398. flywheel/models/reader_task_create.py +46 -78
  399. flywheel/models/reader_task_modify.py +19 -33
  400. flywheel/models/reader_task_output.py +70 -118
  401. flywheel/models/reader_task_parent_details.py +22 -38
  402. flywheel/models/report_access_log_context.py +19 -33
  403. flywheel/models/report_access_log_context_entry.py +7 -13
  404. flywheel/models/report_access_log_context_file_entry.py +4 -8
  405. flywheel/models/report_access_log_entry.py +52 -88
  406. flywheel/models/report_access_log_origin.py +7 -13
  407. flywheel/models/report_availability_list.py +4 -8
  408. flywheel/models/report_daily_usage_entry.py +40 -68
  409. flywheel/models/report_ethnicity_grid.py +13 -23
  410. flywheel/models/report_gender_count.py +10 -18
  411. flywheel/models/report_group_report.py +10 -18
  412. flywheel/models/report_site.py +7 -13
  413. flywheel/models/report_time_period.py +7 -13
  414. flywheel/models/report_usage.py +52 -88
  415. flywheel/models/resolve_input.py +4 -8
  416. flywheel/models/resolve_output.py +7 -13
  417. flywheel/models/resolver_node.py +4 -8
  418. flywheel/models/role_input.py +7 -13
  419. flywheel/models/role_output.py +16 -28
  420. flywheel/models/role_permission.py +7 -13
  421. flywheel/models/role_permission_output.py +7 -13
  422. flywheel/models/role_permission_update.py +4 -8
  423. flywheel/models/role_update.py +7 -13
  424. flywheel/models/roles_role_assignment.py +7 -13
  425. flywheel/models/rule.py +37 -63
  426. flywheel/models/rule_any.py +10 -18
  427. flywheel/models/s3_compat_storage.py +28 -48
  428. flywheel/models/save_search.py +19 -33
  429. flywheel/models/save_search_input.py +10 -18
  430. flywheel/models/save_search_output.py +19 -33
  431. flywheel/models/save_search_page.py +10 -18
  432. flywheel/models/save_search_parent.py +7 -13
  433. flywheel/models/save_search_update.py +7 -13
  434. flywheel/models/search_acquisition_response.py +13 -23
  435. flywheel/models/search_analysis_response.py +13 -23
  436. flywheel/models/search_collection_response.py +13 -23
  437. flywheel/models/search_file_response.py +19 -33
  438. flywheel/models/search_group_response.py +7 -13
  439. flywheel/models/search_parent_response.py +7 -13
  440. flywheel/models/search_parse_error.py +13 -23
  441. flywheel/models/search_project_response.py +7 -13
  442. flywheel/models/search_query.py +22 -38
  443. flywheel/models/search_response.py +34 -58
  444. flywheel/models/search_session_response.py +13 -23
  445. flywheel/models/search_status.py +4 -8
  446. flywheel/models/search_subject_response.py +10 -18
  447. flywheel/models/select_item.py +7 -13
  448. flywheel/models/server_state.py +19 -33
  449. flywheel/models/service_aet.py +19 -33
  450. flywheel/models/service_aet_input.py +16 -28
  451. flywheel/models/session_copy_input.py +13 -23
  452. flywheel/models/session_embedded_subject.py +19 -33
  453. flywheel/models/session_input.py +34 -58
  454. flywheel/models/session_list_output.py +85 -143
  455. flywheel/models/session_modify.py +37 -63
  456. flywheel/models/session_output.py +85 -143
  457. flywheel/models/session_parents.py +10 -18
  458. flywheel/models/session_template_options.py +10 -18
  459. flywheel/models/session_template_recalc_output.py +4 -8
  460. flywheel/models/session_upsert_input.py +37 -63
  461. flywheel/models/session_upsert_output.py +13 -23
  462. flywheel/models/sharing_filter_options.py +25 -43
  463. flywheel/models/signed_fs_upload_output.py +7 -13
  464. flywheel/models/signed_url_cleanup_input.py +7 -13
  465. flywheel/models/signed_url_upload_input.py +7 -13
  466. flywheel/models/signed_url_upload_output.py +25 -43
  467. flywheel/models/site.py +55 -93
  468. flywheel/models/site_report.py +7 -13
  469. flywheel/models/site_settings.py +28 -48
  470. flywheel/models/sort.py +7 -13
  471. flywheel/models/staffing_pool.py +22 -38
  472. flywheel/models/staffing_pool_create.py +10 -18
  473. flywheel/models/staffing_pool_list.py +4 -8
  474. flywheel/models/staffing_pool_modify.py +10 -18
  475. flywheel/models/static_compute.py +10 -18
  476. flywheel/models/status_transitions.py +13 -23
  477. flywheel/models/storage_strategy_config.py +7 -13
  478. flywheel/models/structured_query.py +4 -8
  479. flywheel/models/structured_query_suggestions.py +7 -13
  480. flywheel/models/structured_query_value_suggestion.py +13 -23
  481. flywheel/models/subject_copy_input.py +10 -18
  482. flywheel/models/subject_input.py +55 -93
  483. flywheel/models/subject_modify.py +61 -103
  484. flywheel/models/subject_output.py +97 -163
  485. flywheel/models/subject_output_for_list.py +97 -163
  486. flywheel/models/subject_parents.py +7 -13
  487. flywheel/models/subject_role_permission.py +7 -13
  488. flywheel/models/subject_template_options.py +7 -13
  489. flywheel/models/subject_upsert_input.py +49 -83
  490. flywheel/models/subject_upsert_output.py +10 -18
  491. flywheel/models/sync_user_input.py +22 -38
  492. flywheel/models/tag.py +4 -8
  493. flywheel/models/task_assign.py +7 -13
  494. flywheel/models/task_parent_ref.py +13 -23
  495. flywheel/models/task_parent_ref_input.py +10 -18
  496. flywheel/models/task_submission.py +7 -13
  497. flywheel/models/toolbar_config.py +4 -8
  498. flywheel/models/transitions.py +16 -28
  499. flywheel/models/tree_container_request_spec.py +16 -28
  500. flywheel/models/tree_graph.py +1 -3
  501. flywheel/models/tree_graph_connection.py +13 -23
  502. flywheel/models/tree_graph_connections.py +1 -3
  503. flywheel/models/tree_graph_node.py +4 -8
  504. flywheel/models/tree_response_item.py +1 -3
  505. flywheel/models/uid_check_input_acquisitions.py +13 -23
  506. flywheel/models/uid_check_input_sessions.py +13 -23
  507. flywheel/models/uid_check_output.py +7 -13
  508. flywheel/models/upload_ticket_output.py +10 -18
  509. flywheel/models/upload_token_output.py +4 -8
  510. flywheel/models/user.py +67 -113
  511. flywheel/models/user_api_key.py +10 -18
  512. flywheel/models/user_input.py +37 -63
  513. flywheel/models/user_jobs.py +10 -18
  514. flywheel/models/user_output_id.py +4 -8
  515. flywheel/models/user_preferences.py +1 -3
  516. flywheel/models/user_wechat.py +1 -3
  517. flywheel/models/validation_error.py +10 -18
  518. flywheel/models/validation_rule.py +7 -13
  519. flywheel/models/version.py +25 -43
  520. flywheel/models/view_id_output.py +4 -8
  521. flywheel/models/view_output.py +34 -58
  522. flywheel/models/viewer_app.py +28 -48
  523. flywheel/models/viewer_app_input.py +28 -48
  524. flywheel/models/virus_scan.py +4 -8
  525. flywheel/models/work_in_progress_features.py +1 -3
  526. flywheel/models/zipfile_info.py +7 -13
  527. flywheel/models/zipfile_member_info.py +13 -23
  528. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/METADATA +1 -1
  529. flywheel_sdk-21.4.0rc0.dist-info/RECORD +778 -0
  530. flywheel_sdk-21.4.0.dist-info/RECORD +0 -778
  531. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/WHEEL +0 -0
  532. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/licenses/LICENSE.txt +0 -0
@@ -30,13 +30,10 @@ class AcquisitionsApi(object):
30
30
  Smart copy an acquisition
31
31
  This method makes a synchronous HTTP request by default.
32
32
 
33
- :param acquisition_id:
34
- :type acquisition_id: str
35
- :param body:
36
- :type body: AcquisitionCopyInput
37
- :param async_: Perform the request asynchronously
38
- :type async_: bool, optional
39
- :rtype: Acquisition
33
+ :param str acquisition_id: (required)
34
+ :param AcquisitionCopyInput body: (required)
35
+ :param bool async_: Perform the request asynchronously
36
+ :return: Acquisition
40
37
  """
41
38
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
42
39
  kwargs['_return_http_data_only'] = True
@@ -60,13 +57,10 @@ class AcquisitionsApi(object):
60
57
  Smart copy an acquisition
61
58
  This method makes a synchronous HTTP request by default.
62
59
 
63
- :param acquisition_id:
64
- :type acquisition_id: str
65
- :param body:
66
- :type body: AcquisitionCopyInput
67
- :param async_: Perform the request asynchronously
68
- :type async_: bool, optional
69
- :rtype: Acquisition
60
+ :param str acquisition_id: (required)
61
+ :param AcquisitionCopyInput body: (required)
62
+ :param bool async_: Perform the request asynchronously
63
+ :return: Acquisition
70
64
  """
71
65
 
72
66
  all_params = ['acquisition_id','body',] # noqa: E501
@@ -152,11 +146,9 @@ class AcquisitionsApi(object):
152
146
  Create a new acquisition
153
147
  This method makes a synchronous HTTP request by default.
154
148
 
155
- :param body:
156
- :type body: AcquisitionInput
157
- :param async_: Perform the request asynchronously
158
- :type async_: bool, optional
159
- :rtype: InsertedId
149
+ :param AcquisitionInput body: (required)
150
+ :param bool async_: Perform the request asynchronously
151
+ :return: InsertedId
160
152
  """
161
153
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
162
154
  kwargs['_return_http_data_only'] = True
@@ -180,11 +172,9 @@ class AcquisitionsApi(object):
180
172
  Create a new acquisition
181
173
  This method makes a synchronous HTTP request by default.
182
174
 
183
- :param body:
184
- :type body: AcquisitionInput
185
- :param async_: Perform the request asynchronously
186
- :type async_: bool, optional
187
- :rtype: InsertedId
175
+ :param AcquisitionInput body: (required)
176
+ :param bool async_: Perform the request asynchronously
177
+ :return: InsertedId
188
178
  """
189
179
 
190
180
  all_params = ['body',] # noqa: E501
@@ -264,15 +254,12 @@ class AcquisitionsApi(object):
264
254
  When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
265
255
  This method makes a synchronous HTTP request by default.
266
256
 
267
- :param cid:
268
- :type cid: str
269
- :param body:
270
- :type body: union[AdhocAnalysisInput,JobAnalysisInput]
271
- :param job: returns job_id instead of analysis.id, defaults to false
272
- :type job: bool, optional
273
- :param async_: Perform the request asynchronously
274
- :type async_: bool, optional
275
- :rtype: InsertedId
257
+ :param str cid: (required)
258
+ :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
259
+ :param bool job: returns job_id instead of analysis.id
260
+ :param bool job: returns job_id instead of analysis.id
261
+ :param bool async_: Perform the request asynchronously
262
+ :return: InsertedId
276
263
  """
277
264
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
278
265
  kwargs['_return_http_data_only'] = True
@@ -296,18 +283,15 @@ class AcquisitionsApi(object):
296
283
  When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
297
284
  This method makes a synchronous HTTP request by default.
298
285
 
299
- :param cid:
300
- :type cid: str
301
- :param body:
302
- :type body: union[AdhocAnalysisInput,JobAnalysisInput]
303
- :param job: returns job_id instead of analysis.id, defaults to false
304
- :type job: bool, optional
305
- :param async_: Perform the request asynchronously
306
- :type async_: bool, optional
307
- :rtype: InsertedId
286
+ :param str cid: (required)
287
+ :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
288
+ :param bool job: returns job_id instead of analysis.id
289
+ :param bool job: returns job_id instead of analysis.id
290
+ :param bool async_: Perform the request asynchronously
291
+ :return: InsertedId
308
292
  """
309
293
 
310
- all_params = ['cid','body','job',] # noqa: E501
294
+ all_params = ['cid','body','job','job',] # noqa: E501
311
295
  all_params.append('async_')
312
296
  all_params.append('_return_http_data_only')
313
297
  all_params.append('_preload_content')
@@ -340,6 +324,8 @@ class AcquisitionsApi(object):
340
324
  path_params['cid'] = params['cid'] # noqa: E501
341
325
 
342
326
  query_params = []
327
+ if 'job' in params:
328
+ query_params.append(('job', params['job'])) # noqa: E501
343
329
  if 'job' in params:
344
330
  query_params.append(('job', params['job'])) # noqa: E501
345
331
  else:
@@ -394,15 +380,11 @@ class AcquisitionsApi(object):
394
380
  Add a note to a(n) acquisition analysis.
395
381
  This method makes a synchronous HTTP request by default.
396
382
 
397
- :param container_id: 24-char hex id
398
- :type container_id: str
399
- :param analysis_id: 24-char hex analysis id
400
- :type analysis_id: str
401
- :param body:
402
- :type body: NoteInput
403
- :param async_: Perform the request asynchronously
404
- :type async_: bool, optional
405
- :rtype: Note
383
+ :param str container_id: 24-char hex id (required)
384
+ :param str analysis_id: 24-char hex analysis id (required)
385
+ :param NoteInput body: (required)
386
+ :param bool async_: Perform the request asynchronously
387
+ :return: Note
406
388
  """
407
389
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
408
390
  kwargs['_return_http_data_only'] = True
@@ -426,15 +408,11 @@ class AcquisitionsApi(object):
426
408
  Add a note to a(n) acquisition analysis.
427
409
  This method makes a synchronous HTTP request by default.
428
410
 
429
- :param container_id: 24-char hex id
430
- :type container_id: str
431
- :param analysis_id: 24-char hex analysis id
432
- :type analysis_id: str
433
- :param body:
434
- :type body: NoteInput
435
- :param async_: Perform the request asynchronously
436
- :type async_: bool, optional
437
- :rtype: Note
411
+ :param str container_id: 24-char hex id (required)
412
+ :param str analysis_id: 24-char hex analysis id (required)
413
+ :param NoteInput body: (required)
414
+ :param bool async_: Perform the request asynchronously
415
+ :return: Note
438
416
  """
439
417
 
440
418
  all_params = ['container_id','analysis_id','body',] # noqa: E501
@@ -526,13 +504,10 @@ class AcquisitionsApi(object):
526
504
  Add a note to a(n) acquisition.
527
505
  This method makes a synchronous HTTP request by default.
528
506
 
529
- :param container_id:
530
- :type container_id: str
531
- :param body:
532
- :type body: NoteInput
533
- :param async_: Perform the request asynchronously
534
- :type async_: bool, optional
535
- :rtype: Note
507
+ :param str container_id: (required)
508
+ :param NoteInput body: (required)
509
+ :param bool async_: Perform the request asynchronously
510
+ :return: Note
536
511
  """
537
512
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
538
513
  kwargs['_return_http_data_only'] = True
@@ -556,13 +531,10 @@ class AcquisitionsApi(object):
556
531
  Add a note to a(n) acquisition.
557
532
  This method makes a synchronous HTTP request by default.
558
533
 
559
- :param container_id:
560
- :type container_id: str
561
- :param body:
562
- :type body: NoteInput
563
- :param async_: Perform the request asynchronously
564
- :type async_: bool, optional
565
- :rtype: Note
534
+ :param str container_id: (required)
535
+ :param NoteInput body: (required)
536
+ :param bool async_: Perform the request asynchronously
537
+ :return: Note
566
538
  """
567
539
 
568
540
  all_params = ['container_id','body',] # noqa: E501
@@ -648,13 +620,10 @@ class AcquisitionsApi(object):
648
620
  Propagates changes to projects, sessions and acquisitions
649
621
  This method makes a synchronous HTTP request by default.
650
622
 
651
- :param cid:
652
- :type cid: str
653
- :param body:
654
- :type body: Tag
655
- :param async_: Perform the request asynchronously
656
- :type async_: bool, optional
657
- :rtype: ModifiedResult
623
+ :param str cid: (required)
624
+ :param Tag body: (required)
625
+ :param bool async_: Perform the request asynchronously
626
+ :return: ModifiedResult
658
627
  """
659
628
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
660
629
  kwargs['_return_http_data_only'] = True
@@ -678,13 +647,10 @@ class AcquisitionsApi(object):
678
647
  Propagates changes to projects, sessions and acquisitions
679
648
  This method makes a synchronous HTTP request by default.
680
649
 
681
- :param cid:
682
- :type cid: str
683
- :param body:
684
- :type body: Tag
685
- :param async_: Perform the request asynchronously
686
- :type async_: bool, optional
687
- :rtype: ModifiedResult
650
+ :param str cid: (required)
651
+ :param Tag body: (required)
652
+ :param bool async_: Perform the request asynchronously
653
+ :return: ModifiedResult
688
654
  """
689
655
 
690
656
  all_params = ['cid','body',] # noqa: E501
@@ -770,13 +736,10 @@ class AcquisitionsApi(object):
770
736
  Add multiple tags to a(n) acquisition
771
737
  This method makes a synchronous HTTP request by default.
772
738
 
773
- :param cid:
774
- :type cid: str
775
- :param body:
776
- :type body: list[str]
777
- :param async_: Perform the request asynchronously
778
- :type async_: bool, optional
779
- :rtype: None
739
+ :param str cid: (required)
740
+ :param list[str] body: (required)
741
+ :param bool async_: Perform the request asynchronously
742
+ :return: None
780
743
  """
781
744
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
782
745
  kwargs['_return_http_data_only'] = True
@@ -800,13 +763,10 @@ class AcquisitionsApi(object):
800
763
  Add multiple tags to a(n) acquisition
801
764
  This method makes a synchronous HTTP request by default.
802
765
 
803
- :param cid:
804
- :type cid: str
805
- :param body:
806
- :type body: list[str]
807
- :param async_: Perform the request asynchronously
808
- :type async_: bool, optional
809
- :rtype: None
766
+ :param str cid: (required)
767
+ :param list[str] body: (required)
768
+ :param bool async_: Perform the request asynchronously
769
+ :return: None
810
770
  """
811
771
 
812
772
  all_params = ['cid','body',] # noqa: E501
@@ -885,13 +845,10 @@ class AcquisitionsApi(object):
885
845
  Read-write project permissions are required to delete an acquisition. </br>Admin project permissions are required if the acquisition contains data uploaded by sources other than users and jobs.
886
846
  This method makes a synchronous HTTP request by default.
887
847
 
888
- :param acquisition_id:
889
- :type acquisition_id: str
890
- :param delete_reason: Provide a reason for the deletion
891
- :type delete_reason: ContainerDeleteReason, optional
892
- :param async_: Perform the request asynchronously
893
- :type async_: bool, optional
894
- :rtype: DeletedResult
848
+ :param str acquisition_id: (required)
849
+ :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
850
+ :param bool async_: Perform the request asynchronously
851
+ :return: DeletedResult
895
852
  """
896
853
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
897
854
  kwargs['_return_http_data_only'] = True
@@ -915,13 +872,10 @@ class AcquisitionsApi(object):
915
872
  Read-write project permissions are required to delete an acquisition. </br>Admin project permissions are required if the acquisition contains data uploaded by sources other than users and jobs.
916
873
  This method makes a synchronous HTTP request by default.
917
874
 
918
- :param acquisition_id:
919
- :type acquisition_id: str
920
- :param delete_reason: Provide a reason for the deletion
921
- :type delete_reason: ContainerDeleteReason, optional
922
- :param async_: Perform the request asynchronously
923
- :type async_: bool, optional
924
- :rtype: DeletedResult
875
+ :param str acquisition_id: (required)
876
+ :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
877
+ :param bool async_: Perform the request asynchronously
878
+ :return: DeletedResult
925
879
  """
926
880
 
927
881
  all_params = ['acquisition_id','delete_reason',] # noqa: E501
@@ -992,15 +946,11 @@ class AcquisitionsApi(object):
992
946
  Delete an analysis for a container.
993
947
  This method makes a synchronous HTTP request by default.
994
948
 
995
- :param cid:
996
- :type cid: str
997
- :param analysis_id:
998
- :type analysis_id: str
999
- :param delete_reason: Provide a reason for the deletion
1000
- :type delete_reason: ContainerDeleteReason, optional
1001
- :param async_: Perform the request asynchronously
1002
- :type async_: bool, optional
1003
- :rtype: DeletedResult
949
+ :param str cid: (required)
950
+ :param str analysis_id: (required)
951
+ :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
952
+ :param bool async_: Perform the request asynchronously
953
+ :return: DeletedResult
1004
954
  """
1005
955
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1006
956
  kwargs['_return_http_data_only'] = True
@@ -1024,15 +974,11 @@ class AcquisitionsApi(object):
1024
974
  Delete an analysis for a container.
1025
975
  This method makes a synchronous HTTP request by default.
1026
976
 
1027
- :param cid:
1028
- :type cid: str
1029
- :param analysis_id:
1030
- :type analysis_id: str
1031
- :param delete_reason: Provide a reason for the deletion
1032
- :type delete_reason: ContainerDeleteReason, optional
1033
- :param async_: Perform the request asynchronously
1034
- :type async_: bool, optional
1035
- :rtype: DeletedResult
977
+ :param str cid: (required)
978
+ :param str analysis_id: (required)
979
+ :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
980
+ :param bool async_: Perform the request asynchronously
981
+ :return: DeletedResult
1036
982
  """
1037
983
 
1038
984
  all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
@@ -1109,15 +1055,11 @@ class AcquisitionsApi(object):
1109
1055
  Remove a note from a(n) acquisition analysis.
1110
1056
  This method makes a synchronous HTTP request by default.
1111
1057
 
1112
- :param cid: 24-char hex id
1113
- :type cid: str
1114
- :param analysis_id: 24-char hex analysis id
1115
- :type analysis_id: str
1116
- :param note_id: 24-char hex note id
1117
- :type note_id: str
1118
- :param async_: Perform the request asynchronously
1119
- :type async_: bool, optional
1120
- :rtype: DeletedResult
1058
+ :param str cid: 24-char hex id (required)
1059
+ :param str analysis_id: 24-char hex analysis id (required)
1060
+ :param str note_id: 24-char hex note id (required)
1061
+ :param bool async_: Perform the request asynchronously
1062
+ :return: DeletedResult
1121
1063
  """
1122
1064
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1123
1065
  kwargs['_return_http_data_only'] = True
@@ -1141,15 +1083,11 @@ class AcquisitionsApi(object):
1141
1083
  Remove a note from a(n) acquisition analysis.
1142
1084
  This method makes a synchronous HTTP request by default.
1143
1085
 
1144
- :param cid: 24-char hex id
1145
- :type cid: str
1146
- :param analysis_id: 24-char hex analysis id
1147
- :type analysis_id: str
1148
- :param note_id: 24-char hex note id
1149
- :type note_id: str
1150
- :param async_: Perform the request asynchronously
1151
- :type async_: bool, optional
1152
- :rtype: DeletedResult
1086
+ :param str cid: 24-char hex id (required)
1087
+ :param str analysis_id: 24-char hex analysis id (required)
1088
+ :param str note_id: 24-char hex note id (required)
1089
+ :param bool async_: Perform the request asynchronously
1090
+ :return: DeletedResult
1153
1091
  """
1154
1092
 
1155
1093
  all_params = ['cid','analysis_id','note_id',] # noqa: E501
@@ -1230,17 +1168,12 @@ class AcquisitionsApi(object):
1230
1168
  A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
1231
1169
  This method makes a synchronous HTTP request by default.
1232
1170
 
1233
- :param cid:
1234
- :type cid: str
1235
- :param filename:
1236
- :type filename: str
1237
- :param delete_reason: A reason for deletion when audit-trail is enabled
1238
- :type delete_reason: ContainerDeleteReason, optional
1239
- :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1240
- :type force: bool, optional
1241
- :param async_: Perform the request asynchronously
1242
- :type async_: bool, optional
1243
- :rtype: DeletedResult
1171
+ :param str cid: (required)
1172
+ :param str filename: (required)
1173
+ :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1174
+ :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1175
+ :param bool async_: Perform the request asynchronously
1176
+ :return: DeletedResult
1244
1177
  """
1245
1178
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1246
1179
  kwargs['_return_http_data_only'] = True
@@ -1264,17 +1197,12 @@ class AcquisitionsApi(object):
1264
1197
  A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
1265
1198
  This method makes a synchronous HTTP request by default.
1266
1199
 
1267
- :param cid:
1268
- :type cid: str
1269
- :param filename:
1270
- :type filename: str
1271
- :param delete_reason: A reason for deletion when audit-trail is enabled
1272
- :type delete_reason: ContainerDeleteReason, optional
1273
- :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1274
- :type force: bool, optional
1275
- :param async_: Perform the request asynchronously
1276
- :type async_: bool, optional
1277
- :rtype: DeletedResult
1200
+ :param str cid: (required)
1201
+ :param str filename: (required)
1202
+ :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1203
+ :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1204
+ :param bool async_: Perform the request asynchronously
1205
+ :return: DeletedResult
1278
1206
  """
1279
1207
 
1280
1208
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -1353,13 +1281,10 @@ class AcquisitionsApi(object):
1353
1281
  Remove a note from a(n) acquisition
1354
1282
  This method makes a synchronous HTTP request by default.
1355
1283
 
1356
- :param cid:
1357
- :type cid: str
1358
- :param note_id:
1359
- :type note_id: str
1360
- :param async_: Perform the request asynchronously
1361
- :type async_: bool, optional
1362
- :rtype: DeletedResult
1284
+ :param str cid: (required)
1285
+ :param str note_id: (required)
1286
+ :param bool async_: Perform the request asynchronously
1287
+ :return: DeletedResult
1363
1288
  """
1364
1289
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1365
1290
  kwargs['_return_http_data_only'] = True
@@ -1383,13 +1308,10 @@ class AcquisitionsApi(object):
1383
1308
  Remove a note from a(n) acquisition
1384
1309
  This method makes a synchronous HTTP request by default.
1385
1310
 
1386
- :param cid:
1387
- :type cid: str
1388
- :param note_id:
1389
- :type note_id: str
1390
- :param async_: Perform the request asynchronously
1391
- :type async_: bool, optional
1392
- :rtype: DeletedResult
1311
+ :param str cid: (required)
1312
+ :param str note_id: (required)
1313
+ :param bool async_: Perform the request asynchronously
1314
+ :return: DeletedResult
1393
1315
  """
1394
1316
 
1395
1317
  all_params = ['cid','note_id',] # noqa: E501
@@ -1464,13 +1386,10 @@ class AcquisitionsApi(object):
1464
1386
  Delete a tag
1465
1387
  This method makes a synchronous HTTP request by default.
1466
1388
 
1467
- :param cid:
1468
- :type cid: str
1469
- :param value: The tag to interact with
1470
- :type value: str
1471
- :param async_: Perform the request asynchronously
1472
- :type async_: bool, optional
1473
- :rtype: DeletedResult
1389
+ :param str cid: (required)
1390
+ :param str value: The tag to interact with (required)
1391
+ :param bool async_: Perform the request asynchronously
1392
+ :return: DeletedResult
1474
1393
  """
1475
1394
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1476
1395
  kwargs['_return_http_data_only'] = True
@@ -1494,13 +1413,10 @@ class AcquisitionsApi(object):
1494
1413
  Delete a tag
1495
1414
  This method makes a synchronous HTTP request by default.
1496
1415
 
1497
- :param cid:
1498
- :type cid: str
1499
- :param value: The tag to interact with
1500
- :type value: str
1501
- :param async_: Perform the request asynchronously
1502
- :type async_: bool, optional
1503
- :rtype: DeletedResult
1416
+ :param str cid: (required)
1417
+ :param str value: The tag to interact with (required)
1418
+ :param bool async_: Perform the request asynchronously
1419
+ :return: DeletedResult
1504
1420
  """
1505
1421
 
1506
1422
  all_params = ['cid','value',] # noqa: E501
@@ -1575,13 +1491,10 @@ class AcquisitionsApi(object):
1575
1491
  Delete multiple tags from a(n) acquisition
1576
1492
  This method makes a synchronous HTTP request by default.
1577
1493
 
1578
- :param cid:
1579
- :type cid: str
1580
- :param body:
1581
- :type body: list[str]
1582
- :param async_: Perform the request asynchronously
1583
- :type async_: bool, optional
1584
- :rtype: None
1494
+ :param str cid: (required)
1495
+ :param list[str] body: (required)
1496
+ :param bool async_: Perform the request asynchronously
1497
+ :return: None
1585
1498
  """
1586
1499
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1587
1500
  kwargs['_return_http_data_only'] = True
@@ -1605,13 +1518,10 @@ class AcquisitionsApi(object):
1605
1518
  Delete multiple tags from a(n) acquisition
1606
1519
  This method makes a synchronous HTTP request by default.
1607
1520
 
1608
- :param cid:
1609
- :type cid: str
1610
- :param body:
1611
- :type body: list[str]
1612
- :param async_: Perform the request asynchronously
1613
- :type async_: bool, optional
1614
- :rtype: None
1521
+ :param str cid: (required)
1522
+ :param list[str] body: (required)
1523
+ :param bool async_: Perform the request asynchronously
1524
+ :return: None
1615
1525
  """
1616
1526
 
1617
1527
  all_params = ['cid','body',] # noqa: E501
@@ -1690,13 +1600,10 @@ class AcquisitionsApi(object):
1690
1600
  Delete multiple acquisitions by ID list
1691
1601
  This method makes a synchronous HTTP request by default.
1692
1602
 
1693
- :param body: List of IDs to delete
1694
- :type body: list[str]
1695
- :param delete_reason:
1696
- :type delete_reason: ContainerDeleteReason, optional
1697
- :param async_: Perform the request asynchronously
1698
- :type async_: bool, optional
1699
- :rtype: DeletedResult
1603
+ :param list[str] body: List of IDs to delete (required)
1604
+ :param ContainerDeleteReason delete_reason:
1605
+ :param bool async_: Perform the request asynchronously
1606
+ :return: DeletedResult
1700
1607
  """
1701
1608
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1702
1609
  kwargs['_return_http_data_only'] = True
@@ -1720,13 +1627,10 @@ class AcquisitionsApi(object):
1720
1627
  Delete multiple acquisitions by ID list
1721
1628
  This method makes a synchronous HTTP request by default.
1722
1629
 
1723
- :param body: List of IDs to delete
1724
- :type body: list[str]
1725
- :param delete_reason:
1726
- :type delete_reason: ContainerDeleteReason, optional
1727
- :param async_: Perform the request asynchronously
1728
- :type async_: bool, optional
1729
- :rtype: DeletedResult
1630
+ :param list[str] body: List of IDs to delete (required)
1631
+ :param ContainerDeleteReason delete_reason:
1632
+ :param bool async_: Perform the request asynchronously
1633
+ :return: DeletedResult
1730
1634
  """
1731
1635
 
1732
1636
  all_params = ['body','delete_reason',] # noqa: E501
@@ -1801,29 +1705,18 @@ class AcquisitionsApi(object):
1801
1705
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
1802
1706
  This method makes a synchronous HTTP request by default.
1803
1707
 
1804
- :param acquisition_id: 24-character hex ID
1805
- :type acquisition_id: str
1806
- :param file_name: output file name
1807
- :type file_name: str
1808
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1809
- :type info: bool, optional
1810
- :param member: The filename of a zipfile member to download rather than the entire file
1811
- :type member: str, optional
1812
- :param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
1813
- :type view: bool, optional
1814
- :param version: version of the file to download
1815
- :type version: int, optional
1816
- :param hash: file hash for comparison
1817
- :type hash: str, optional
1818
- :param range: byte ranges to return
1819
- :type range: str, optional
1820
- :param x_accept_feature: redirect header, defaults to []
1821
- :type x_accept_feature: list[str], optional
1822
- :param dest_file: Destination file path
1823
- :type dest_file: str
1824
- :param async_: Perform the request asynchronously
1825
- :type async_: bool, optional
1826
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1708
+ :param str acquisition_id: 24-character hex ID (required)
1709
+ :param str file_name: output file name (required)
1710
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1711
+ :param str member: The filename of a zipfile member to download rather than the entire file
1712
+ :param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
1713
+ :param int version: version of the file to download
1714
+ :param str hash: file hash for comparison
1715
+ :param str range: byte ranges to return
1716
+ :param list[str] x_accept_feature: redirect header
1717
+ :param str dest_file: Destination file path
1718
+ :param bool async_: Perform the request asynchronously
1719
+ :return: union[DownloadTicketStub,ZipfileInfo]
1827
1720
  """
1828
1721
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1829
1722
  kwargs['_return_http_data_only'] = True
@@ -1846,27 +1739,17 @@ class AcquisitionsApi(object):
1846
1739
  Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
1847
1740
  This method makes a synchronous HTTP request by default.
1848
1741
 
1849
- :param acquisition_id: 24-character hex ID
1850
- :type acquisition_id: str
1851
- :param file_name: output file name
1852
- :type file_name: str
1853
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1854
- :type info: bool, optional
1855
- :param member: The filename of a zipfile member to download rather than the entire file
1856
- :type member: str, optional
1857
- :param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
1858
- :type view: bool, optional
1859
- :param version: version of the file to download
1860
- :type version: int, optional
1861
- :param hash: file hash for comparison
1862
- :type hash: str, optional
1863
- :param range: byte ranges to return
1864
- :type range: str, optional
1865
- :param x_accept_feature: redirect header, defaults to []
1866
- :type x_accept_feature: list[str], optional
1867
- :param async_: Perform the request asynchronously
1868
- :type async_: bool, optional
1869
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1742
+ :param str acquisition_id: 24-character hex ID (required)
1743
+ :param str file_name: output file name (required)
1744
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1745
+ :param str member: The filename of a zipfile member to download rather than the entire file
1746
+ :param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
1747
+ :param int version: version of the file to download
1748
+ :param str hash: file hash for comparison
1749
+ :param str range: byte ranges to return
1750
+ :param list[str] x_accept_feature: redirect header
1751
+ :param bool async_: Perform the request asynchronously
1752
+ :return: union[DownloadTicketStub,ZipfileInfo]
1870
1753
  """
1871
1754
 
1872
1755
  all_params = ['acquisition_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1956,29 +1839,18 @@ class AcquisitionsApi(object):
1956
1839
  Does not work on files whose names contain a forward slash.
1957
1840
  This method makes a synchronous HTTP request by default.
1958
1841
 
1959
- :param acquisition_id: 24-character hex ID
1960
- :type acquisition_id: str
1961
- :param file_name: output file name
1962
- :type file_name: str
1963
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1964
- :type ticket: str, optional
1965
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1966
- :type info: bool, optional
1967
- :param member: The filename of a zipfile member to download rather than the entire file
1968
- :type member: str, optional
1969
- :param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
1970
- :type view: bool, optional
1971
- :param version: version of the file to download
1972
- :type version: int, optional
1973
- :param hash: file hash for comparison
1974
- :type hash: str, optional
1975
- :param range: byte ranges to return
1976
- :type range: str, optional
1977
- :param x_accept_feature: redirect header, defaults to []
1978
- :type x_accept_feature: list[str], optional
1979
- :param async_: Perform the request asynchronously
1980
- :type async_: bool, optional
1981
- :rtype: FileZipInfo
1842
+ :param str acquisition_id: 24-character hex ID (required)
1843
+ :param str file_name: output file name (required)
1844
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1845
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1846
+ :param str member: The filename of a zipfile member to download rather than the entire file
1847
+ :param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
1848
+ :param int version: version of the file to download
1849
+ :param str hash: file hash for comparison
1850
+ :param str range: byte ranges to return
1851
+ :param list[str] x_accept_feature: redirect header
1852
+ :param bool async_: Perform the request asynchronously
1853
+ :return: FileZipInfo
1982
1854
  """
1983
1855
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1984
1856
  kwargs['_return_http_data_only'] = True
@@ -2002,29 +1874,18 @@ class AcquisitionsApi(object):
2002
1874
  Does not work on files whose names contain a forward slash.
2003
1875
  This method makes a synchronous HTTP request by default.
2004
1876
 
2005
- :param acquisition_id: 24-character hex ID
2006
- :type acquisition_id: str
2007
- :param file_name: output file name
2008
- :type file_name: str
2009
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2010
- :type ticket: str, optional
2011
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2012
- :type info: bool, optional
2013
- :param member: The filename of a zipfile member to download rather than the entire file
2014
- :type member: str, optional
2015
- :param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
2016
- :type view: bool, optional
2017
- :param version: version of the file to download
2018
- :type version: int, optional
2019
- :param hash: file hash for comparison
2020
- :type hash: str, optional
2021
- :param range: byte ranges to return
2022
- :type range: str, optional
2023
- :param x_accept_feature: redirect header, defaults to []
2024
- :type x_accept_feature: list[str], optional
2025
- :param async_: Perform the request asynchronously
2026
- :type async_: bool, optional
2027
- :rtype: FileZipInfo
1877
+ :param str acquisition_id: 24-character hex ID (required)
1878
+ :param str file_name: output file name (required)
1879
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1880
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1881
+ :param str member: The filename of a zipfile member to download rather than the entire file
1882
+ :param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
1883
+ :param int version: version of the file to download
1884
+ :param str hash: file hash for comparison
1885
+ :param str range: byte ranges to return
1886
+ :param list[str] x_accept_feature: redirect header
1887
+ :param bool async_: Perform the request asynchronously
1888
+ :return: FileZipInfo
2028
1889
  """
2029
1890
 
2030
1891
  all_params = ['acquisition_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2117,29 +1978,18 @@ class AcquisitionsApi(object):
2117
1978
 
2118
1979
  This method makes a synchronous HTTP request by default.
2119
1980
 
2120
- :param acquisition_id: 24-character hex ID
2121
- :type acquisition_id: str
2122
- :param file_name: output file name
2123
- :type file_name: str
2124
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2125
- :type ticket: str, optional
2126
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2127
- :type info: bool, optional
2128
- :param member: The filename of a zipfile member to download rather than the entire file
2129
- :type member: str, optional
2130
- :param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
2131
- :type view: bool, optional
2132
- :param version: version of the file to download
2133
- :type version: int, optional
2134
- :param hash: file hash for comparison
2135
- :type hash: str, optional
2136
- :param range: byte ranges to return
2137
- :type range: str, optional
2138
- :param x_accept_feature: redirect header, defaults to []
2139
- :type x_accept_feature: list[str], optional
2140
- :param async_: Perform the request asynchronously
2141
- :type async_: bool, optional
2142
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1981
+ :param str acquisition_id: 24-character hex ID (required)
1982
+ :param str file_name: output file name (required)
1983
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1984
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1985
+ :param str member: The filename of a zipfile member to download rather than the entire file
1986
+ :param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
1987
+ :param int version: version of the file to download
1988
+ :param str hash: file hash for comparison
1989
+ :param str range: byte ranges to return
1990
+ :param list[str] x_accept_feature: redirect header
1991
+ :param bool async_: Perform the request asynchronously
1992
+ :return: union[DownloadTicketStub,ZipfileInfo]
2143
1993
  """
2144
1994
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2145
1995
  kwargs['_return_http_data_only'] = True
@@ -2162,29 +2012,18 @@ class AcquisitionsApi(object):
2162
2012
 
2163
2013
  This method makes a synchronous HTTP request by default.
2164
2014
 
2165
- :param acquisition_id: 24-character hex ID
2166
- :type acquisition_id: str
2167
- :param file_name: output file name
2168
- :type file_name: str
2169
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2170
- :type ticket: str, optional
2171
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2172
- :type info: bool, optional
2173
- :param member: The filename of a zipfile member to download rather than the entire file
2174
- :type member: str, optional
2175
- :param view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\" , defaults to false
2176
- :type view: bool, optional
2177
- :param version: version of the file to download
2178
- :type version: int, optional
2179
- :param hash: file hash for comparison
2180
- :type hash: str, optional
2181
- :param range: byte ranges to return
2182
- :type range: str, optional
2183
- :param x_accept_feature: redirect header, defaults to []
2184
- :type x_accept_feature: list[str], optional
2185
- :param async_: Perform the request asynchronously
2186
- :type async_: bool, optional
2187
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2015
+ :param str acquisition_id: 24-character hex ID (required)
2016
+ :param str file_name: output file name (required)
2017
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2018
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2019
+ :param str member: The filename of a zipfile member to download rather than the entire file
2020
+ :param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
2021
+ :param int version: version of the file to download
2022
+ :param str hash: file hash for comparison
2023
+ :param str range: byte ranges to return
2024
+ :param list[str] x_accept_feature: redirect header
2025
+ :param bool async_: Perform the request asynchronously
2026
+ :return: union[DownloadTicketStub,ZipfileInfo]
2188
2027
  """
2189
2028
 
2190
2029
  all_params = ['acquisition_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2276,27 +2115,17 @@ class AcquisitionsApi(object):
2276
2115
  If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
2277
2116
  This method makes a synchronous HTTP request by default.
2278
2117
 
2279
- :param acquisition_id: 24-character hex ID
2280
- :type acquisition_id: str
2281
- :param analysis_id: 24-char hex analysis id
2282
- :type analysis_id: str
2283
- :param filename: filename to download (get tar of all if empty)
2284
- :type filename: str
2285
- :param info: get file info only, defaults to false
2286
- :type info: bool, optional
2287
- :param member: get zipfile member
2288
- :type member: str, optional
2289
- :param view: feature flag for view/download, defaults to false
2290
- :type view: bool, optional
2291
- :param range: byte ranges to return
2292
- :type range: str, optional
2293
- :param x_accept_feature: redirect header, defaults to []
2294
- :type x_accept_feature: list[str], optional
2295
- :param dest_file: Destination file path
2296
- :type dest_file: str
2297
- :param async_: Perform the request asynchronously
2298
- :type async_: bool, optional
2299
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2118
+ :param str acquisition_id: 24-character hex ID (required)
2119
+ :param str analysis_id: 24-char hex analysis id (required)
2120
+ :param str filename: filename to download (get tar of all if empty) (required)
2121
+ :param bool info: get file info only
2122
+ :param str member: get zipfile member
2123
+ :param bool view: feature flag for view/download
2124
+ :param str range: byte ranges to return
2125
+ :param list[str] x_accept_feature: redirect header
2126
+ :param str dest_file: Destination file path
2127
+ :param bool async_: Perform the request asynchronously
2128
+ :return: union[DownloadTicketStub,ZipfileInfo]
2300
2129
  """
2301
2130
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2302
2131
  kwargs['_return_http_data_only'] = True
@@ -2319,25 +2148,16 @@ class AcquisitionsApi(object):
2319
2148
  If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
2320
2149
  This method makes a synchronous HTTP request by default.
2321
2150
 
2322
- :param acquisition_id: 24-character hex ID
2323
- :type acquisition_id: str
2324
- :param analysis_id: 24-char hex analysis id
2325
- :type analysis_id: str
2326
- :param filename: filename to download (get tar of all if empty)
2327
- :type filename: str
2328
- :param info: get file info only, defaults to false
2329
- :type info: bool, optional
2330
- :param member: get zipfile member
2331
- :type member: str, optional
2332
- :param view: feature flag for view/download, defaults to false
2333
- :type view: bool, optional
2334
- :param range: byte ranges to return
2335
- :type range: str, optional
2336
- :param x_accept_feature: redirect header, defaults to []
2337
- :type x_accept_feature: list[str], optional
2338
- :param async_: Perform the request asynchronously
2339
- :type async_: bool, optional
2340
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2151
+ :param str acquisition_id: 24-character hex ID (required)
2152
+ :param str analysis_id: 24-char hex analysis id (required)
2153
+ :param str filename: filename to download (get tar of all if empty) (required)
2154
+ :param bool info: get file info only
2155
+ :param str member: get zipfile member
2156
+ :param bool view: feature flag for view/download
2157
+ :param str range: byte ranges to return
2158
+ :param list[str] x_accept_feature: redirect header
2159
+ :param bool async_: Perform the request asynchronously
2160
+ :return: union[DownloadTicketStub,ZipfileInfo]
2341
2161
  """
2342
2162
 
2343
2163
  all_params = ['acquisition_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2429,27 +2249,17 @@ class AcquisitionsApi(object):
2429
2249
  Does not work on files whose names contain a forward slash.
2430
2250
  This method makes a synchronous HTTP request by default.
2431
2251
 
2432
- :param acquisition_id: 24-character hex ID
2433
- :type acquisition_id: str
2434
- :param analysis_id: 24-char hex analysis id
2435
- :type analysis_id: str
2436
- :param filename: filename to download (get tar of all if empty)
2437
- :type filename: str
2438
- :param ticket: 24-char hex ticket id
2439
- :type ticket: str, optional
2440
- :param info: get file info only, defaults to false
2441
- :type info: bool, optional
2442
- :param member: get zipfile member
2443
- :type member: str, optional
2444
- :param view: feature flag for view/download, defaults to false
2445
- :type view: bool, optional
2446
- :param range: byte ranges to return
2447
- :type range: str, optional
2448
- :param x_accept_feature: redirect header, defaults to []
2449
- :type x_accept_feature: list[str], optional
2450
- :param async_: Perform the request asynchronously
2451
- :type async_: bool, optional
2452
- :rtype: FileZipInfo
2252
+ :param str acquisition_id: 24-character hex ID (required)
2253
+ :param str analysis_id: 24-char hex analysis id (required)
2254
+ :param str filename: filename to download (get tar of all if empty) (required)
2255
+ :param str ticket: 24-char hex ticket id
2256
+ :param bool info: get file info only
2257
+ :param str member: get zipfile member
2258
+ :param bool view: feature flag for view/download
2259
+ :param str range: byte ranges to return
2260
+ :param list[str] x_accept_feature: redirect header
2261
+ :param bool async_: Perform the request asynchronously
2262
+ :return: FileZipInfo
2453
2263
  """
2454
2264
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2455
2265
  kwargs['_return_http_data_only'] = True
@@ -2473,27 +2283,17 @@ class AcquisitionsApi(object):
2473
2283
  Does not work on files whose names contain a forward slash.
2474
2284
  This method makes a synchronous HTTP request by default.
2475
2285
 
2476
- :param acquisition_id: 24-character hex ID
2477
- :type acquisition_id: str
2478
- :param analysis_id: 24-char hex analysis id
2479
- :type analysis_id: str
2480
- :param filename: filename to download (get tar of all if empty)
2481
- :type filename: str
2482
- :param ticket: 24-char hex ticket id
2483
- :type ticket: str, optional
2484
- :param info: get file info only, defaults to false
2485
- :type info: bool, optional
2486
- :param member: get zipfile member
2487
- :type member: str, optional
2488
- :param view: feature flag for view/download, defaults to false
2489
- :type view: bool, optional
2490
- :param range: byte ranges to return
2491
- :type range: str, optional
2492
- :param x_accept_feature: redirect header, defaults to []
2493
- :type x_accept_feature: list[str], optional
2494
- :param async_: Perform the request asynchronously
2495
- :type async_: bool, optional
2496
- :rtype: FileZipInfo
2286
+ :param str acquisition_id: 24-character hex ID (required)
2287
+ :param str analysis_id: 24-char hex analysis id (required)
2288
+ :param str filename: filename to download (get tar of all if empty) (required)
2289
+ :param str ticket: 24-char hex ticket id
2290
+ :param bool info: get file info only
2291
+ :param str member: get zipfile member
2292
+ :param bool view: feature flag for view/download
2293
+ :param str range: byte ranges to return
2294
+ :param list[str] x_accept_feature: redirect header
2295
+ :param bool async_: Perform the request asynchronously
2296
+ :return: FileZipInfo
2497
2297
  """
2498
2298
 
2499
2299
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2588,27 +2388,17 @@ class AcquisitionsApi(object):
2588
2388
 
2589
2389
  This method makes a synchronous HTTP request by default.
2590
2390
 
2591
- :param acquisition_id: 24-character hex ID
2592
- :type acquisition_id: str
2593
- :param analysis_id: 24-char hex analysis id
2594
- :type analysis_id: str
2595
- :param filename: filename to download (get tar of all if empty)
2596
- :type filename: str
2597
- :param ticket: 24-char hex ticket id
2598
- :type ticket: str, optional
2599
- :param info: get file info only, defaults to false
2600
- :type info: bool, optional
2601
- :param member: get zipfile member
2602
- :type member: str, optional
2603
- :param view: feature flag for view/download, defaults to false
2604
- :type view: bool, optional
2605
- :param range: byte ranges to return
2606
- :type range: str, optional
2607
- :param x_accept_feature: redirect header, defaults to []
2608
- :type x_accept_feature: list[str], optional
2609
- :param async_: Perform the request asynchronously
2610
- :type async_: bool, optional
2611
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2391
+ :param str acquisition_id: 24-character hex ID (required)
2392
+ :param str analysis_id: 24-char hex analysis id (required)
2393
+ :param str filename: filename to download (get tar of all if empty) (required)
2394
+ :param str ticket: 24-char hex ticket id
2395
+ :param bool info: get file info only
2396
+ :param str member: get zipfile member
2397
+ :param bool view: feature flag for view/download
2398
+ :param str range: byte ranges to return
2399
+ :param list[str] x_accept_feature: redirect header
2400
+ :param bool async_: Perform the request asynchronously
2401
+ :return: union[DownloadTicketStub,ZipfileInfo]
2612
2402
  """
2613
2403
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2614
2404
  kwargs['_return_http_data_only'] = True
@@ -2631,27 +2421,17 @@ class AcquisitionsApi(object):
2631
2421
 
2632
2422
  This method makes a synchronous HTTP request by default.
2633
2423
 
2634
- :param acquisition_id: 24-character hex ID
2635
- :type acquisition_id: str
2636
- :param analysis_id: 24-char hex analysis id
2637
- :type analysis_id: str
2638
- :param filename: filename to download (get tar of all if empty)
2639
- :type filename: str
2640
- :param ticket: 24-char hex ticket id
2641
- :type ticket: str, optional
2642
- :param info: get file info only, defaults to false
2643
- :type info: bool, optional
2644
- :param member: get zipfile member
2645
- :type member: str, optional
2646
- :param view: feature flag for view/download, defaults to false
2647
- :type view: bool, optional
2648
- :param range: byte ranges to return
2649
- :type range: str, optional
2650
- :param x_accept_feature: redirect header, defaults to []
2651
- :type x_accept_feature: list[str], optional
2652
- :param async_: Perform the request asynchronously
2653
- :type async_: bool, optional
2654
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2424
+ :param str acquisition_id: 24-character hex ID (required)
2425
+ :param str analysis_id: 24-char hex analysis id (required)
2426
+ :param str filename: filename to download (get tar of all if empty) (required)
2427
+ :param str ticket: 24-char hex ticket id
2428
+ :param bool info: get file info only
2429
+ :param str member: get zipfile member
2430
+ :param bool view: feature flag for view/download
2431
+ :param str range: byte ranges to return
2432
+ :param list[str] x_accept_feature: redirect header
2433
+ :param bool async_: Perform the request asynchronously
2434
+ :return: union[DownloadTicketStub,ZipfileInfo]
2655
2435
  """
2656
2436
 
2657
2437
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2745,27 +2525,17 @@ class AcquisitionsApi(object):
2745
2525
  If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
2746
2526
  This method makes a synchronous HTTP request by default.
2747
2527
 
2748
- :param acquisition_id: 24-character hex ID
2749
- :type acquisition_id: str
2750
- :param analysis_id: 24-char hex analysis id
2751
- :type analysis_id: str
2752
- :param filename: filename to download (get tar of all if empty)
2753
- :type filename: str
2754
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2755
- :type info: bool, optional
2756
- :param member: The filename of a zipfile member to download rather than the entire file
2757
- :type member: str, optional
2758
- :param view: feature flag for view/download, defaults to false
2759
- :type view: bool, optional
2760
- :param range: byte ranges to return
2761
- :type range: str, optional
2762
- :param x_accept_feature: redirect header, defaults to []
2763
- :type x_accept_feature: list[str], optional
2764
- :param dest_file: Destination file path
2765
- :type dest_file: str
2766
- :param async_: Perform the request asynchronously
2767
- :type async_: bool, optional
2768
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2528
+ :param str acquisition_id: 24-character hex ID (required)
2529
+ :param str analysis_id: 24-char hex analysis id (required)
2530
+ :param str filename: filename to download (get tar of all if empty) (required)
2531
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2532
+ :param str member: The filename of a zipfile member to download rather than the entire file
2533
+ :param bool view: feature flag for view/download
2534
+ :param str range: byte ranges to return
2535
+ :param list[str] x_accept_feature: redirect header
2536
+ :param str dest_file: Destination file path
2537
+ :param bool async_: Perform the request asynchronously
2538
+ :return: union[DownloadTicketStub,ZipfileInfo]
2769
2539
  """
2770
2540
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2771
2541
  kwargs['_return_http_data_only'] = True
@@ -2788,25 +2558,16 @@ class AcquisitionsApi(object):
2788
2558
  If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
2789
2559
  This method makes a synchronous HTTP request by default.
2790
2560
 
2791
- :param acquisition_id: 24-character hex ID
2792
- :type acquisition_id: str
2793
- :param analysis_id: 24-char hex analysis id
2794
- :type analysis_id: str
2795
- :param filename: filename to download (get tar of all if empty)
2796
- :type filename: str
2797
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2798
- :type info: bool, optional
2799
- :param member: The filename of a zipfile member to download rather than the entire file
2800
- :type member: str, optional
2801
- :param view: feature flag for view/download, defaults to false
2802
- :type view: bool, optional
2803
- :param range: byte ranges to return
2804
- :type range: str, optional
2805
- :param x_accept_feature: redirect header, defaults to []
2806
- :type x_accept_feature: list[str], optional
2807
- :param async_: Perform the request asynchronously
2808
- :type async_: bool, optional
2809
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2561
+ :param str acquisition_id: 24-character hex ID (required)
2562
+ :param str analysis_id: 24-char hex analysis id (required)
2563
+ :param str filename: filename to download (get tar of all if empty) (required)
2564
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2565
+ :param str member: The filename of a zipfile member to download rather than the entire file
2566
+ :param bool view: feature flag for view/download
2567
+ :param str range: byte ranges to return
2568
+ :param list[str] x_accept_feature: redirect header
2569
+ :param bool async_: Perform the request asynchronously
2570
+ :return: union[DownloadTicketStub,ZipfileInfo]
2810
2571
  """
2811
2572
 
2812
2573
  all_params = ['acquisition_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2898,27 +2659,17 @@ class AcquisitionsApi(object):
2898
2659
  Does not work on files whose names contain a forward slash.
2899
2660
  This method makes a synchronous HTTP request by default.
2900
2661
 
2901
- :param acquisition_id: 24-character hex ID
2902
- :type acquisition_id: str
2903
- :param analysis_id: 24-char hex analysis id
2904
- :type analysis_id: str
2905
- :param filename: filename to download (get tar of all if empty)
2906
- :type filename: str
2907
- :param ticket: ticket id of the outputs to download
2908
- :type ticket: str, optional
2909
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2910
- :type info: bool, optional
2911
- :param member: The filename of a zipfile member to download rather than the entire file
2912
- :type member: str, optional
2913
- :param view: feature flag for view/download, defaults to false
2914
- :type view: bool, optional
2915
- :param range: byte ranges to return
2916
- :type range: str, optional
2917
- :param x_accept_feature: redirect header, defaults to []
2918
- :type x_accept_feature: list[str], optional
2919
- :param async_: Perform the request asynchronously
2920
- :type async_: bool, optional
2921
- :rtype: FileZipInfo
2662
+ :param str acquisition_id: 24-character hex ID (required)
2663
+ :param str analysis_id: 24-char hex analysis id (required)
2664
+ :param str filename: filename to download (get tar of all if empty) (required)
2665
+ :param str ticket: ticket id of the outputs to download
2666
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2667
+ :param str member: The filename of a zipfile member to download rather than the entire file
2668
+ :param bool view: feature flag for view/download
2669
+ :param str range: byte ranges to return
2670
+ :param list[str] x_accept_feature: redirect header
2671
+ :param bool async_: Perform the request asynchronously
2672
+ :return: FileZipInfo
2922
2673
  """
2923
2674
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2924
2675
  kwargs['_return_http_data_only'] = True
@@ -2942,27 +2693,17 @@ class AcquisitionsApi(object):
2942
2693
  Does not work on files whose names contain a forward slash.
2943
2694
  This method makes a synchronous HTTP request by default.
2944
2695
 
2945
- :param acquisition_id: 24-character hex ID
2946
- :type acquisition_id: str
2947
- :param analysis_id: 24-char hex analysis id
2948
- :type analysis_id: str
2949
- :param filename: filename to download (get tar of all if empty)
2950
- :type filename: str
2951
- :param ticket: ticket id of the outputs to download
2952
- :type ticket: str, optional
2953
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2954
- :type info: bool, optional
2955
- :param member: The filename of a zipfile member to download rather than the entire file
2956
- :type member: str, optional
2957
- :param view: feature flag for view/download, defaults to false
2958
- :type view: bool, optional
2959
- :param range: byte ranges to return
2960
- :type range: str, optional
2961
- :param x_accept_feature: redirect header, defaults to []
2962
- :type x_accept_feature: list[str], optional
2963
- :param async_: Perform the request asynchronously
2964
- :type async_: bool, optional
2965
- :rtype: FileZipInfo
2696
+ :param str acquisition_id: 24-character hex ID (required)
2697
+ :param str analysis_id: 24-char hex analysis id (required)
2698
+ :param str filename: filename to download (get tar of all if empty) (required)
2699
+ :param str ticket: ticket id of the outputs to download
2700
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2701
+ :param str member: The filename of a zipfile member to download rather than the entire file
2702
+ :param bool view: feature flag for view/download
2703
+ :param str range: byte ranges to return
2704
+ :param list[str] x_accept_feature: redirect header
2705
+ :param bool async_: Perform the request asynchronously
2706
+ :return: FileZipInfo
2966
2707
  """
2967
2708
 
2968
2709
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -3057,27 +2798,17 @@ class AcquisitionsApi(object):
3057
2798
 
3058
2799
  This method makes a synchronous HTTP request by default.
3059
2800
 
3060
- :param acquisition_id: 24-character hex ID
3061
- :type acquisition_id: str
3062
- :param analysis_id: 24-char hex analysis id
3063
- :type analysis_id: str
3064
- :param filename: filename to download (get tar of all if empty)
3065
- :type filename: str
3066
- :param ticket: ticket id of the outputs to download
3067
- :type ticket: str, optional
3068
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3069
- :type info: bool, optional
3070
- :param member: The filename of a zipfile member to download rather than the entire file
3071
- :type member: str, optional
3072
- :param view: feature flag for view/download, defaults to false
3073
- :type view: bool, optional
3074
- :param range: byte ranges to return
3075
- :type range: str, optional
3076
- :param x_accept_feature: redirect header, defaults to []
3077
- :type x_accept_feature: list[str], optional
3078
- :param async_: Perform the request asynchronously
3079
- :type async_: bool, optional
3080
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2801
+ :param str acquisition_id: 24-character hex ID (required)
2802
+ :param str analysis_id: 24-char hex analysis id (required)
2803
+ :param str filename: filename to download (get tar of all if empty) (required)
2804
+ :param str ticket: ticket id of the outputs to download
2805
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2806
+ :param str member: The filename of a zipfile member to download rather than the entire file
2807
+ :param bool view: feature flag for view/download
2808
+ :param str range: byte ranges to return
2809
+ :param list[str] x_accept_feature: redirect header
2810
+ :param bool async_: Perform the request asynchronously
2811
+ :return: union[DownloadTicketStub,ZipfileInfo]
3081
2812
  """
3082
2813
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3083
2814
  kwargs['_return_http_data_only'] = True
@@ -3100,27 +2831,17 @@ class AcquisitionsApi(object):
3100
2831
 
3101
2832
  This method makes a synchronous HTTP request by default.
3102
2833
 
3103
- :param acquisition_id: 24-character hex ID
3104
- :type acquisition_id: str
3105
- :param analysis_id: 24-char hex analysis id
3106
- :type analysis_id: str
3107
- :param filename: filename to download (get tar of all if empty)
3108
- :type filename: str
3109
- :param ticket: ticket id of the outputs to download
3110
- :type ticket: str, optional
3111
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3112
- :type info: bool, optional
3113
- :param member: The filename of a zipfile member to download rather than the entire file
3114
- :type member: str, optional
3115
- :param view: feature flag for view/download, defaults to false
3116
- :type view: bool, optional
3117
- :param range: byte ranges to return
3118
- :type range: str, optional
3119
- :param x_accept_feature: redirect header, defaults to []
3120
- :type x_accept_feature: list[str], optional
3121
- :param async_: Perform the request asynchronously
3122
- :type async_: bool, optional
3123
- :rtype: union[DownloadTicketStub,ZipfileInfo]
2834
+ :param str acquisition_id: 24-character hex ID (required)
2835
+ :param str analysis_id: 24-char hex analysis id (required)
2836
+ :param str filename: filename to download (get tar of all if empty) (required)
2837
+ :param str ticket: ticket id of the outputs to download
2838
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
2839
+ :param str member: The filename of a zipfile member to download rather than the entire file
2840
+ :param bool view: feature flag for view/download
2841
+ :param str range: byte ranges to return
2842
+ :param list[str] x_accept_feature: redirect header
2843
+ :param bool async_: Perform the request asynchronously
2844
+ :return: union[DownloadTicketStub,ZipfileInfo]
3124
2845
  """
3125
2846
 
3126
2847
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -3214,17 +2935,12 @@ class AcquisitionsApi(object):
3214
2935
  Get a single acquisition
3215
2936
  This method makes a synchronous HTTP request by default.
3216
2937
 
3217
- :param acquisition_id:
3218
- :type acquisition_id: str
3219
- :param join:
3220
- :type join: JoinType, optional
3221
- :param join_avatars: add name and avatar to notes, defaults to false
3222
- :type join_avatars: bool, optional
3223
- :param x_accept_feature:, defaults to []
3224
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
3225
- :param async_: Perform the request asynchronously
3226
- :type async_: bool, optional
3227
- :rtype: AcquisitionOutput
2938
+ :param str acquisition_id: (required)
2939
+ :param JoinType join:
2940
+ :param bool join_avatars: add name and avatar to notes
2941
+ :param list[union[HeaderFeature,str]] x_accept_feature:
2942
+ :param bool async_: Perform the request asynchronously
2943
+ :return: AcquisitionOutput
3228
2944
  """
3229
2945
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3230
2946
  kwargs['_return_http_data_only'] = True
@@ -3248,17 +2964,12 @@ class AcquisitionsApi(object):
3248
2964
  Get a single acquisition
3249
2965
  This method makes a synchronous HTTP request by default.
3250
2966
 
3251
- :param acquisition_id:
3252
- :type acquisition_id: str
3253
- :param join:
3254
- :type join: JoinType, optional
3255
- :param join_avatars: add name and avatar to notes, defaults to false
3256
- :type join_avatars: bool, optional
3257
- :param x_accept_feature:, defaults to []
3258
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
3259
- :param async_: Perform the request asynchronously
3260
- :type async_: bool, optional
3261
- :rtype: AcquisitionOutput
2967
+ :param str acquisition_id: (required)
2968
+ :param JoinType join:
2969
+ :param bool join_avatars: add name and avatar to notes
2970
+ :param list[union[HeaderFeature,str]] x_accept_feature:
2971
+ :param bool async_: Perform the request asynchronously
2972
+ :return: AcquisitionOutput
3262
2973
  """
3263
2974
 
3264
2975
  all_params = ['acquisition_id','join','join_avatars','x_accept_feature',] # noqa: E501
@@ -3334,33 +3045,20 @@ class AcquisitionsApi(object):
3334
3045
  Returns analyses that directly belong to this resource.
3335
3046
  This method makes a synchronous HTTP request by default.
3336
3047
 
3337
- :param cid:
3338
- :type cid: str
3339
- :param inflate_job:, defaults to false
3340
- :type inflate_job: bool, optional
3341
- :param join_avatars:, defaults to false
3342
- :type join_avatars: bool, optional
3343
- :param join:
3344
- :type join: JoinType, optional
3345
- :param include_all_info: Include all info in returned objects, defaults to false
3346
- :type include_all_info: bool, optional
3347
- :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3348
- :type filter: str, optional
3349
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3350
- :type sort: str, optional
3351
- :param limit: The maximum number of entries to return.
3352
- :type limit: int, optional
3353
- :param skip: The number of entries to skip., defaults to 0
3354
- :type skip: int, optional
3355
- :param page: The page number (i.e. skip limit*page entries)
3356
- :type page: int, optional
3357
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3358
- :type after_id: str, optional
3359
- :param x_accept_feature:, defaults to []
3360
- :type x_accept_feature: list[str], optional
3361
- :param async_: Perform the request asynchronously
3362
- :type async_: bool, optional
3363
- :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3048
+ :param str cid: (required)
3049
+ :param bool inflate_job:
3050
+ :param bool join_avatars:
3051
+ :param JoinType join:
3052
+ :param bool include_all_info: Include all info in returned objects
3053
+ :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3054
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3055
+ :param int limit: The maximum number of entries to return.
3056
+ :param int skip: The number of entries to skip.
3057
+ :param int page: The page number (i.e. skip limit*page entries)
3058
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3059
+ :param list[str] x_accept_feature:
3060
+ :param bool async_: Perform the request asynchronously
3061
+ :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3364
3062
  """
3365
3063
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3366
3064
  kwargs['_return_http_data_only'] = True
@@ -3384,33 +3082,20 @@ class AcquisitionsApi(object):
3384
3082
  Returns analyses that directly belong to this resource.
3385
3083
  This method makes a synchronous HTTP request by default.
3386
3084
 
3387
- :param cid:
3388
- :type cid: str
3389
- :param inflate_job:, defaults to false
3390
- :type inflate_job: bool, optional
3391
- :param join_avatars:, defaults to false
3392
- :type join_avatars: bool, optional
3393
- :param join:
3394
- :type join: JoinType, optional
3395
- :param include_all_info: Include all info in returned objects, defaults to false
3396
- :type include_all_info: bool, optional
3397
- :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3398
- :type filter: str, optional
3399
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3400
- :type sort: str, optional
3401
- :param limit: The maximum number of entries to return.
3402
- :type limit: int, optional
3403
- :param skip: The number of entries to skip., defaults to 0
3404
- :type skip: int, optional
3405
- :param page: The page number (i.e. skip limit*page entries)
3406
- :type page: int, optional
3407
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3408
- :type after_id: str, optional
3409
- :param x_accept_feature:, defaults to []
3410
- :type x_accept_feature: list[str], optional
3411
- :param async_: Perform the request asynchronously
3412
- :type async_: bool, optional
3413
- :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3085
+ :param str cid: (required)
3086
+ :param bool inflate_job:
3087
+ :param bool join_avatars:
3088
+ :param JoinType join:
3089
+ :param bool include_all_info: Include all info in returned objects
3090
+ :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3091
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3092
+ :param int limit: The maximum number of entries to return.
3093
+ :param int skip: The number of entries to skip.
3094
+ :param int page: The page number (i.e. skip limit*page entries)
3095
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3096
+ :param list[str] x_accept_feature:
3097
+ :param bool async_: Perform the request asynchronously
3098
+ :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3414
3099
  """
3415
3100
 
3416
3101
  all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3502,19 +3187,13 @@ class AcquisitionsApi(object):
3502
3187
  Get an analysis.
3503
3188
  This method makes a synchronous HTTP request by default.
3504
3189
 
3505
- :param cid:
3506
- :type cid: str
3507
- :param analysis_id:
3508
- :type analysis_id: str
3509
- :param inflate_job: Return job as an object instead of an id, defaults to false
3510
- :type inflate_job: bool, optional
3511
- :param join_avatars:, defaults to false
3512
- :type join_avatars: bool, optional
3513
- :param join:
3514
- :type join: JoinType, optional
3515
- :param async_: Perform the request asynchronously
3516
- :type async_: bool, optional
3517
- :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
3190
+ :param str cid: (required)
3191
+ :param str analysis_id: (required)
3192
+ :param bool inflate_job: Return job as an object instead of an id
3193
+ :param bool join_avatars:
3194
+ :param JoinType join:
3195
+ :param bool async_: Perform the request asynchronously
3196
+ :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
3518
3197
  """
3519
3198
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3520
3199
  kwargs['_return_http_data_only'] = True
@@ -3538,19 +3217,13 @@ class AcquisitionsApi(object):
3538
3217
  Get an analysis.
3539
3218
  This method makes a synchronous HTTP request by default.
3540
3219
 
3541
- :param cid:
3542
- :type cid: str
3543
- :param analysis_id:
3544
- :type analysis_id: str
3545
- :param inflate_job: Return job as an object instead of an id, defaults to false
3546
- :type inflate_job: bool, optional
3547
- :param join_avatars:, defaults to false
3548
- :type join_avatars: bool, optional
3549
- :param join:
3550
- :type join: JoinType, optional
3551
- :param async_: Perform the request asynchronously
3552
- :type async_: bool, optional
3553
- :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
3220
+ :param str cid: (required)
3221
+ :param str analysis_id: (required)
3222
+ :param bool inflate_job: Return job as an object instead of an id
3223
+ :param bool join_avatars:
3224
+ :param JoinType join:
3225
+ :param bool async_: Perform the request asynchronously
3226
+ :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
3554
3227
  """
3555
3228
 
3556
3229
  all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
@@ -3631,13 +3304,10 @@ class AcquisitionsApi(object):
3631
3304
  Get info for a particular file.
3632
3305
  This method makes a synchronous HTTP request by default.
3633
3306
 
3634
- :param cid: Container Id
3635
- :type cid: str
3636
- :param filename:
3637
- :type filename: str
3638
- :param async_: Perform the request asynchronously
3639
- :type async_: bool, optional
3640
- :rtype: FileOutput
3307
+ :param str cid: Container Id (required)
3308
+ :param str filename: (required)
3309
+ :param bool async_: Perform the request asynchronously
3310
+ :return: FileOutput
3641
3311
  """
3642
3312
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3643
3313
  kwargs['_return_http_data_only'] = True
@@ -3661,13 +3331,10 @@ class AcquisitionsApi(object):
3661
3331
  Get info for a particular file.
3662
3332
  This method makes a synchronous HTTP request by default.
3663
3333
 
3664
- :param cid: Container Id
3665
- :type cid: str
3666
- :param filename:
3667
- :type filename: str
3668
- :param async_: Perform the request asynchronously
3669
- :type async_: bool, optional
3670
- :rtype: FileOutput
3334
+ :param str cid: Container Id (required)
3335
+ :param str filename: (required)
3336
+ :param bool async_: Perform the request asynchronously
3337
+ :return: FileOutput
3671
3338
  """
3672
3339
 
3673
3340
  all_params = ['cid','filename',] # noqa: E501
@@ -3742,13 +3409,10 @@ class AcquisitionsApi(object):
3742
3409
  Get a note of a(n) acquisition
3743
3410
  This method makes a synchronous HTTP request by default.
3744
3411
 
3745
- :param cid:
3746
- :type cid: str
3747
- :param note_id:
3748
- :type note_id: str
3749
- :param async_: Perform the request asynchronously
3750
- :type async_: bool, optional
3751
- :rtype: Note
3412
+ :param str cid: (required)
3413
+ :param str note_id: (required)
3414
+ :param bool async_: Perform the request asynchronously
3415
+ :return: Note
3752
3416
  """
3753
3417
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3754
3418
  kwargs['_return_http_data_only'] = True
@@ -3772,13 +3436,10 @@ class AcquisitionsApi(object):
3772
3436
  Get a note of a(n) acquisition
3773
3437
  This method makes a synchronous HTTP request by default.
3774
3438
 
3775
- :param cid:
3776
- :type cid: str
3777
- :param note_id:
3778
- :type note_id: str
3779
- :param async_: Perform the request asynchronously
3780
- :type async_: bool, optional
3781
- :rtype: Note
3439
+ :param str cid: (required)
3440
+ :param str note_id: (required)
3441
+ :param bool async_: Perform the request asynchronously
3442
+ :return: Note
3782
3443
  """
3783
3444
 
3784
3445
  all_params = ['cid','note_id',] # noqa: E501
@@ -3853,13 +3514,10 @@ class AcquisitionsApi(object):
3853
3514
  Get the value of a tag, by name
3854
3515
  This method makes a synchronous HTTP request by default.
3855
3516
 
3856
- :param cid:
3857
- :type cid: str
3858
- :param value: The tag to interact with
3859
- :type value: str
3860
- :param async_: Perform the request asynchronously
3861
- :type async_: bool, optional
3862
- :rtype: str
3517
+ :param str cid: (required)
3518
+ :param str value: The tag to interact with (required)
3519
+ :param bool async_: Perform the request asynchronously
3520
+ :return: str
3863
3521
  """
3864
3522
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3865
3523
  kwargs['_return_http_data_only'] = True
@@ -3883,13 +3541,10 @@ class AcquisitionsApi(object):
3883
3541
  Get the value of a tag, by name
3884
3542
  This method makes a synchronous HTTP request by default.
3885
3543
 
3886
- :param cid:
3887
- :type cid: str
3888
- :param value: The tag to interact with
3889
- :type value: str
3890
- :param async_: Perform the request asynchronously
3891
- :type async_: bool, optional
3892
- :rtype: str
3544
+ :param str cid: (required)
3545
+ :param str value: The tag to interact with (required)
3546
+ :param bool async_: Perform the request asynchronously
3547
+ :return: str
3893
3548
  """
3894
3549
 
3895
3550
  all_params = ['cid','value',] # noqa: E501
@@ -3964,33 +3619,20 @@ class AcquisitionsApi(object):
3964
3619
  Get a list of acquisitions.
3965
3620
  This method makes a synchronous HTTP request by default.
3966
3621
 
3967
- :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
3968
- :type exhaustive: bool, optional
3969
- :param join:
3970
- :type join: JoinType, optional
3971
- :param join_avatars: add name and avatar to notes, defaults to false
3972
- :type join_avatars: bool, optional
3973
- :param collection_id:
3974
- :type collection_id: str, optional
3975
- :param include_all_info: Include all info in returned objects, defaults to false
3976
- :type include_all_info: bool, optional
3977
- :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3978
- :type filter: str, optional
3979
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3980
- :type sort: str, optional
3981
- :param limit: The maximum number of entries to return.
3982
- :type limit: int, optional
3983
- :param skip: The number of entries to skip., defaults to 0
3984
- :type skip: int, optional
3985
- :param page: The page number (i.e. skip limit*page entries)
3986
- :type page: int, optional
3987
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3988
- :type after_id: str, optional
3989
- :param x_accept_feature:, defaults to []
3990
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
3991
- :param async_: Perform the request asynchronously
3992
- :type async_: bool, optional
3993
- :rtype: union[list[AcquisitionListOutput],Page]
3622
+ :param bool exhaustive: Set to return a complete list regardless of permissions
3623
+ :param JoinType join:
3624
+ :param bool join_avatars: add name and avatar to notes
3625
+ :param str collection_id:
3626
+ :param bool include_all_info: Include all info in returned objects
3627
+ :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3628
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3629
+ :param int limit: The maximum number of entries to return.
3630
+ :param int skip: The number of entries to skip.
3631
+ :param int page: The page number (i.e. skip limit*page entries)
3632
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3633
+ :param list[union[HeaderFeature,str]] x_accept_feature:
3634
+ :param bool async_: Perform the request asynchronously
3635
+ :return: union[list[AcquisitionListOutput],Page]
3994
3636
  """
3995
3637
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3996
3638
  kwargs['_return_http_data_only'] = True
@@ -4014,33 +3656,20 @@ class AcquisitionsApi(object):
4014
3656
  Get a list of acquisitions.
4015
3657
  This method makes a synchronous HTTP request by default.
4016
3658
 
4017
- :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
4018
- :type exhaustive: bool, optional
4019
- :param join:
4020
- :type join: JoinType, optional
4021
- :param join_avatars: add name and avatar to notes, defaults to false
4022
- :type join_avatars: bool, optional
4023
- :param collection_id:
4024
- :type collection_id: str, optional
4025
- :param include_all_info: Include all info in returned objects, defaults to false
4026
- :type include_all_info: bool, optional
4027
- :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
4028
- :type filter: str, optional
4029
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4030
- :type sort: str, optional
4031
- :param limit: The maximum number of entries to return.
4032
- :type limit: int, optional
4033
- :param skip: The number of entries to skip., defaults to 0
4034
- :type skip: int, optional
4035
- :param page: The page number (i.e. skip limit*page entries)
4036
- :type page: int, optional
4037
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4038
- :type after_id: str, optional
4039
- :param x_accept_feature:, defaults to []
4040
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
4041
- :param async_: Perform the request asynchronously
4042
- :type async_: bool, optional
4043
- :rtype: union[list[AcquisitionListOutput],Page]
3659
+ :param bool exhaustive: Set to return a complete list regardless of permissions
3660
+ :param JoinType join:
3661
+ :param bool join_avatars: add name and avatar to notes
3662
+ :param str collection_id:
3663
+ :param bool include_all_info: Include all info in returned objects
3664
+ :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
3665
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3666
+ :param int limit: The maximum number of entries to return.
3667
+ :param int skip: The number of entries to skip.
3668
+ :param int page: The page number (i.e. skip limit*page entries)
3669
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3670
+ :param list[union[HeaderFeature,str]] x_accept_feature:
3671
+ :param bool async_: Perform the request asynchronously
3672
+ :return: union[list[AcquisitionListOutput],Page]
4044
3673
  """
4045
3674
 
4046
3675
  all_params = ['exhaustive','join','join_avatars','collection_id','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -4128,13 +3757,10 @@ class AcquisitionsApi(object):
4128
3757
  Update an acquisition
4129
3758
  This method makes a synchronous HTTP request by default.
4130
3759
 
4131
- :param acquisition_id:
4132
- :type acquisition_id: str
4133
- :param body:
4134
- :type body: AcquisitionModifyInput
4135
- :param async_: Perform the request asynchronously
4136
- :type async_: bool, optional
4137
- :rtype: ModifiedResult
3760
+ :param str acquisition_id: (required)
3761
+ :param AcquisitionModifyInput body: (required)
3762
+ :param bool async_: Perform the request asynchronously
3763
+ :return: ModifiedResult
4138
3764
  """
4139
3765
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4140
3766
  kwargs['_return_http_data_only'] = True
@@ -4158,13 +3784,10 @@ class AcquisitionsApi(object):
4158
3784
  Update an acquisition
4159
3785
  This method makes a synchronous HTTP request by default.
4160
3786
 
4161
- :param acquisition_id:
4162
- :type acquisition_id: str
4163
- :param body:
4164
- :type body: AcquisitionModifyInput
4165
- :param async_: Perform the request asynchronously
4166
- :type async_: bool, optional
4167
- :rtype: ModifiedResult
3787
+ :param str acquisition_id: (required)
3788
+ :param AcquisitionModifyInput body: (required)
3789
+ :param bool async_: Perform the request asynchronously
3790
+ :return: ModifiedResult
4168
3791
  """
4169
3792
 
4170
3793
  all_params = ['acquisition_id','body',] # noqa: E501
@@ -4250,15 +3873,11 @@ class AcquisitionsApi(object):
4250
3873
  Modify an analysis.
4251
3874
  This method makes a synchronous HTTP request by default.
4252
3875
 
4253
- :param cid:
4254
- :type cid: str
4255
- :param analysis_id:
4256
- :type analysis_id: str
4257
- :param body:
4258
- :type body: AnalysisModifyInput
4259
- :param async_: Perform the request asynchronously
4260
- :type async_: bool, optional
4261
- :rtype: ModifiedResult
3876
+ :param str cid: (required)
3877
+ :param str analysis_id: (required)
3878
+ :param AnalysisModifyInput body: (required)
3879
+ :param bool async_: Perform the request asynchronously
3880
+ :return: ModifiedResult
4262
3881
  """
4263
3882
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4264
3883
  kwargs['_return_http_data_only'] = True
@@ -4282,15 +3901,11 @@ class AcquisitionsApi(object):
4282
3901
  Modify an analysis.
4283
3902
  This method makes a synchronous HTTP request by default.
4284
3903
 
4285
- :param cid:
4286
- :type cid: str
4287
- :param analysis_id:
4288
- :type analysis_id: str
4289
- :param body:
4290
- :type body: AnalysisModifyInput
4291
- :param async_: Perform the request asynchronously
4292
- :type async_: bool, optional
4293
- :rtype: ModifiedResult
3904
+ :param str cid: (required)
3905
+ :param str analysis_id: (required)
3906
+ :param AnalysisModifyInput body: (required)
3907
+ :param bool async_: Perform the request asynchronously
3908
+ :return: ModifiedResult
4294
3909
  """
4295
3910
 
4296
3911
  all_params = ['cid','analysis_id','body',] # noqa: E501
@@ -4382,15 +3997,11 @@ class AcquisitionsApi(object):
4382
3997
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
4383
3998
  This method makes a synchronous HTTP request by default.
4384
3999
 
4385
- :param cid:
4386
- :type cid: str
4387
- :param filename:
4388
- :type filename: str
4389
- :param body:
4390
- :type body: FileModifyInput
4391
- :param async_: Perform the request asynchronously
4392
- :type async_: bool, optional
4393
- :rtype: ModifiedResult
4000
+ :param str cid: (required)
4001
+ :param str filename: (required)
4002
+ :param FileModifyInput body: (required)
4003
+ :param bool async_: Perform the request asynchronously
4004
+ :return: ModifiedResult
4394
4005
  """
4395
4006
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4396
4007
  kwargs['_return_http_data_only'] = True
@@ -4414,15 +4025,11 @@ class AcquisitionsApi(object):
4414
4025
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
4415
4026
  This method makes a synchronous HTTP request by default.
4416
4027
 
4417
- :param cid:
4418
- :type cid: str
4419
- :param filename:
4420
- :type filename: str
4421
- :param body:
4422
- :type body: FileModifyInput
4423
- :param async_: Perform the request asynchronously
4424
- :type async_: bool, optional
4425
- :rtype: ModifiedResult
4028
+ :param str cid: (required)
4029
+ :param str filename: (required)
4030
+ :param FileModifyInput body: (required)
4031
+ :param bool async_: Perform the request asynchronously
4032
+ :return: ModifiedResult
4426
4033
  """
4427
4034
 
4428
4035
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4514,15 +4121,11 @@ class AcquisitionsApi(object):
4514
4121
  If replacing a file's classification, the modality can optionally be modified as well.
4515
4122
  This method makes a synchronous HTTP request by default.
4516
4123
 
4517
- :param cid:
4518
- :type cid: str
4519
- :param filename:
4520
- :type filename: str
4521
- :param body:
4522
- :type body: FileClassificationDelta
4523
- :param async_: Perform the request asynchronously
4524
- :type async_: bool, optional
4525
- :rtype: ModifiedResult
4124
+ :param str cid: (required)
4125
+ :param str filename: (required)
4126
+ :param FileClassificationDelta body: (required)
4127
+ :param bool async_: Perform the request asynchronously
4128
+ :return: ModifiedResult
4526
4129
  """
4527
4130
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4528
4131
  kwargs['_return_http_data_only'] = True
@@ -4546,15 +4149,11 @@ class AcquisitionsApi(object):
4546
4149
  If replacing a file's classification, the modality can optionally be modified as well.
4547
4150
  This method makes a synchronous HTTP request by default.
4548
4151
 
4549
- :param cid:
4550
- :type cid: str
4551
- :param filename:
4552
- :type filename: str
4553
- :param body:
4554
- :type body: FileClassificationDelta
4555
- :param async_: Perform the request asynchronously
4556
- :type async_: bool, optional
4557
- :rtype: ModifiedResult
4152
+ :param str cid: (required)
4153
+ :param str filename: (required)
4154
+ :param FileClassificationDelta body: (required)
4155
+ :param bool async_: Perform the request asynchronously
4156
+ :return: ModifiedResult
4558
4157
  """
4559
4158
 
4560
4159
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4646,15 +4245,11 @@ class AcquisitionsApi(object):
4646
4245
  Modify and return the file 'info' field
4647
4246
  This method makes a synchronous HTTP request by default.
4648
4247
 
4649
- :param cid:
4650
- :type cid: str
4651
- :param filename:
4652
- :type filename: str
4653
- :param body:
4654
- :type body: Info
4655
- :param async_: Perform the request asynchronously
4656
- :type async_: bool, optional
4657
- :rtype: ModifiedResult
4248
+ :param str cid: (required)
4249
+ :param str filename: (required)
4250
+ :param Info body: (required)
4251
+ :param bool async_: Perform the request asynchronously
4252
+ :return: ModifiedResult
4658
4253
  """
4659
4254
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4660
4255
  kwargs['_return_http_data_only'] = True
@@ -4678,15 +4273,11 @@ class AcquisitionsApi(object):
4678
4273
  Modify and return the file 'info' field
4679
4274
  This method makes a synchronous HTTP request by default.
4680
4275
 
4681
- :param cid:
4682
- :type cid: str
4683
- :param filename:
4684
- :type filename: str
4685
- :param body:
4686
- :type body: Info
4687
- :param async_: Perform the request asynchronously
4688
- :type async_: bool, optional
4689
- :rtype: ModifiedResult
4276
+ :param str cid: (required)
4277
+ :param str filename: (required)
4278
+ :param Info body: (required)
4279
+ :param bool async_: Perform the request asynchronously
4280
+ :return: ModifiedResult
4690
4281
  """
4691
4282
 
4692
4283
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4778,13 +4369,10 @@ class AcquisitionsApi(object):
4778
4369
  Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4779
4370
  This method makes a synchronous HTTP request by default.
4780
4371
 
4781
- :param cid:
4782
- :type cid: str
4783
- :param body:
4784
- :type body: Info
4785
- :param async_: Perform the request asynchronously
4786
- :type async_: bool, optional
4787
- :rtype: ModifiedResult
4372
+ :param str cid: (required)
4373
+ :param Info body: (required)
4374
+ :param bool async_: Perform the request asynchronously
4375
+ :return: ModifiedResult
4788
4376
  """
4789
4377
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4790
4378
  kwargs['_return_http_data_only'] = True
@@ -4808,13 +4396,10 @@ class AcquisitionsApi(object):
4808
4396
  Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4809
4397
  This method makes a synchronous HTTP request by default.
4810
4398
 
4811
- :param cid:
4812
- :type cid: str
4813
- :param body:
4814
- :type body: Info
4815
- :param async_: Perform the request asynchronously
4816
- :type async_: bool, optional
4817
- :rtype: ModifiedResult
4399
+ :param str cid: (required)
4400
+ :param Info body: (required)
4401
+ :param bool async_: Perform the request asynchronously
4402
+ :return: ModifiedResult
4818
4403
  """
4819
4404
 
4820
4405
  all_params = ['cid','body',] # noqa: E501
@@ -4900,15 +4485,11 @@ class AcquisitionsApi(object):
4900
4485
  Update a note of a(n) acquisition
4901
4486
  This method makes a synchronous HTTP request by default.
4902
4487
 
4903
- :param cid:
4904
- :type cid: str
4905
- :param note_id:
4906
- :type note_id: str
4907
- :param body:
4908
- :type body: NoteInput
4909
- :param async_: Perform the request asynchronously
4910
- :type async_: bool, optional
4911
- :rtype: int
4488
+ :param str cid: (required)
4489
+ :param str note_id: (required)
4490
+ :param NoteInput body: (required)
4491
+ :param bool async_: Perform the request asynchronously
4492
+ :return: int
4912
4493
  """
4913
4494
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4914
4495
  kwargs['_return_http_data_only'] = True
@@ -4932,15 +4513,11 @@ class AcquisitionsApi(object):
4932
4513
  Update a note of a(n) acquisition
4933
4514
  This method makes a synchronous HTTP request by default.
4934
4515
 
4935
- :param cid:
4936
- :type cid: str
4937
- :param note_id:
4938
- :type note_id: str
4939
- :param body:
4940
- :type body: NoteInput
4941
- :param async_: Perform the request asynchronously
4942
- :type async_: bool, optional
4943
- :rtype: int
4516
+ :param str cid: (required)
4517
+ :param str note_id: (required)
4518
+ :param NoteInput body: (required)
4519
+ :param bool async_: Perform the request asynchronously
4520
+ :return: int
4944
4521
  """
4945
4522
 
4946
4523
  all_params = ['cid','note_id','body',] # noqa: E501
@@ -5032,15 +4609,11 @@ class AcquisitionsApi(object):
5032
4609
  Rename a tag
5033
4610
  This method makes a synchronous HTTP request by default.
5034
4611
 
5035
- :param cid:
5036
- :type cid: str
5037
- :param value: The tag to interact with
5038
- :type value: str
5039
- :param body:
5040
- :type body: Tag
5041
- :param async_: Perform the request asynchronously
5042
- :type async_: bool, optional
5043
- :rtype: str
4612
+ :param str cid: (required)
4613
+ :param str value: The tag to interact with (required)
4614
+ :param Tag body: (required)
4615
+ :param bool async_: Perform the request asynchronously
4616
+ :return: str
5044
4617
  """
5045
4618
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5046
4619
  kwargs['_return_http_data_only'] = True
@@ -5064,15 +4637,11 @@ class AcquisitionsApi(object):
5064
4637
  Rename a tag
5065
4638
  This method makes a synchronous HTTP request by default.
5066
4639
 
5067
- :param cid:
5068
- :type cid: str
5069
- :param value: The tag to interact with
5070
- :type value: str
5071
- :param body:
5072
- :type body: Tag
5073
- :param async_: Perform the request asynchronously
5074
- :type async_: bool, optional
5075
- :rtype: str
4640
+ :param str cid: (required)
4641
+ :param str value: The tag to interact with (required)
4642
+ :param Tag body: (required)
4643
+ :param bool async_: Perform the request asynchronously
4644
+ :return: str
5076
4645
  """
5077
4646
 
5078
4647
  all_params = ['cid','value','body',] # noqa: E501
@@ -5164,29 +4733,18 @@ class AcquisitionsApi(object):
5164
4733
  Upload a file to a(n) acquisition.
5165
4734
  This method makes a synchronous HTTP request by default.
5166
4735
 
5167
- :param container_id:
5168
- :type container_id: str
5169
- :param file: The file to upload
5170
- :type file: str
5171
- :param preserve_metadata:, defaults to false
5172
- :type preserve_metadata: bool, optional
5173
- :param ticket:
5174
- :type ticket: str, optional
5175
- :param id:
5176
- :type id: str, optional
5177
- :param level:
5178
- :type level: ContainerType, optional
5179
- :param job:
5180
- :type job: str, optional
5181
- :param metadata: Dictionary of file metadata (type, modality, info, etc.)
5182
- :type metadata: object, optional
5183
- :param x_accept_feature: redirect header, defaults to []
5184
- :type x_accept_feature: list[str], optional
5185
- :param content_type:
5186
- :type content_type: str, optional
5187
- :param async_: Perform the request asynchronously
5188
- :type async_: bool, optional
5189
- :rtype: union[list[FileOutput],UploadTicketOutput]
4736
+ :param str container_id: (required)
4737
+ :param str file: The file to upload (required)
4738
+ :param bool preserve_metadata:
4739
+ :param str ticket:
4740
+ :param str id:
4741
+ :param ContainerType level:
4742
+ :param str job:
4743
+ :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4744
+ :param list[str] x_accept_feature: redirect header
4745
+ :param str content_type:
4746
+ :param bool async_: Perform the request asynchronously
4747
+ :return: union[list[FileOutput],UploadTicketOutput]
5190
4748
  """
5191
4749
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5192
4750
  kwargs['_return_http_data_only'] = True
@@ -5210,29 +4768,18 @@ class AcquisitionsApi(object):
5210
4768
  Upload a file to a(n) acquisition.
5211
4769
  This method makes a synchronous HTTP request by default.
5212
4770
 
5213
- :param container_id:
5214
- :type container_id: str
5215
- :param file: The file to upload
5216
- :type file: str
5217
- :param preserve_metadata:, defaults to false
5218
- :type preserve_metadata: bool, optional
5219
- :param ticket:
5220
- :type ticket: str, optional
5221
- :param id:
5222
- :type id: str, optional
5223
- :param level:
5224
- :type level: ContainerType, optional
5225
- :param job:
5226
- :type job: str, optional
5227
- :param metadata: Dictionary of file metadata (type, modality, info, etc.)
5228
- :type metadata: object, optional
5229
- :param x_accept_feature: redirect header, defaults to []
5230
- :type x_accept_feature: list[str], optional
5231
- :param content_type:
5232
- :type content_type: str, optional
5233
- :param async_: Perform the request asynchronously
5234
- :type async_: bool, optional
5235
- :rtype: union[list[FileOutput],UploadTicketOutput]
4771
+ :param str container_id: (required)
4772
+ :param str file: The file to upload (required)
4773
+ :param bool preserve_metadata:
4774
+ :param str ticket:
4775
+ :param str id:
4776
+ :param ContainerType level:
4777
+ :param str job:
4778
+ :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4779
+ :param list[str] x_accept_feature: redirect header
4780
+ :param str content_type:
4781
+ :param bool async_: Perform the request asynchronously
4782
+ :return: union[list[FileOutput],UploadTicketOutput]
5236
4783
  """
5237
4784
 
5238
4785
  all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
@@ -5328,25 +4875,16 @@ class AcquisitionsApi(object):
5328
4875
  Upload an output file to an analysis
5329
4876
  This method makes a synchronous HTTP request by default.
5330
4877
 
5331
- :param cid:
5332
- :type cid: str
5333
- :param analysis_id:
5334
- :type analysis_id: str
5335
- :param file: The file to upload
5336
- :type file: str
5337
- :param ticket:
5338
- :type ticket: str, optional
5339
- :param id:
5340
- :type id: str, optional
5341
- :param level:
5342
- :type level: ContainerType, optional
5343
- :param job:
5344
- :type job: str, optional
5345
- :param content_type:
5346
- :type content_type: str, optional
5347
- :param async_: Perform the request asynchronously
5348
- :type async_: bool, optional
5349
- :rtype: list[FileOutput]
4878
+ :param str cid: (required)
4879
+ :param str analysis_id: (required)
4880
+ :param str file: The file to upload (required)
4881
+ :param str ticket:
4882
+ :param str id:
4883
+ :param ContainerType level:
4884
+ :param str job:
4885
+ :param str content_type:
4886
+ :param bool async_: Perform the request asynchronously
4887
+ :return: list[FileOutput]
5350
4888
  """
5351
4889
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5352
4890
  kwargs['_return_http_data_only'] = True
@@ -5370,25 +4908,16 @@ class AcquisitionsApi(object):
5370
4908
  Upload an output file to an analysis
5371
4909
  This method makes a synchronous HTTP request by default.
5372
4910
 
5373
- :param cid:
5374
- :type cid: str
5375
- :param analysis_id:
5376
- :type analysis_id: str
5377
- :param file: The file to upload
5378
- :type file: str
5379
- :param ticket:
5380
- :type ticket: str, optional
5381
- :param id:
5382
- :type id: str, optional
5383
- :param level:
5384
- :type level: ContainerType, optional
5385
- :param job:
5386
- :type job: str, optional
5387
- :param content_type:
5388
- :type content_type: str, optional
5389
- :param async_: Perform the request asynchronously
5390
- :type async_: bool, optional
5391
- :rtype: list[FileOutput]
4911
+ :param str cid: (required)
4912
+ :param str analysis_id: (required)
4913
+ :param str file: The file to upload (required)
4914
+ :param str ticket:
4915
+ :param str id:
4916
+ :param ContainerType level:
4917
+ :param str job:
4918
+ :param str content_type:
4919
+ :param bool async_: Perform the request asynchronously
4920
+ :return: list[FileOutput]
5392
4921
  """
5393
4922
 
5394
4923
  all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501