flywheel-sdk 21.3.0rc0__py3-none-any.whl → 21.4.0__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 (773) hide show
  1. flywheel/__init__.py +7 -8
  2. flywheel/api/acquisitions_api.py +1033 -569
  3. flywheel/api/analyses_api.py +786 -432
  4. flywheel/api/audit_trail_api.py +78 -51
  5. flywheel/api/auth_api.py +6 -11
  6. flywheel/api/batch_api.py +60 -43
  7. flywheel/api/bulk_api.py +10 -13
  8. flywheel/api/change_log_api.py +40 -29
  9. flywheel/api/collections_api.py +740 -410
  10. flywheel/api/config_api.py +18 -19
  11. flywheel/api/container_tasks_api.py +14 -15
  12. flywheel/api/container_type_api.py +14 -15
  13. flywheel/api/containers_api.py +989 -545
  14. flywheel/api/custom_filters_api.py +64 -43
  15. flywheel/api/data_view_executions_api.py +94 -59
  16. flywheel/api/dataexplorer_api.py +158 -99
  17. flywheel/api/devices_api.py +132 -83
  18. flywheel/api/dimse_api.py +72 -51
  19. flywheel/api/download_api.py +46 -32
  20. flywheel/api/files_api.py +266 -157
  21. flywheel/api/form_responses_api.py +100 -63
  22. flywheel/api/gears_api.py +278 -163
  23. flywheel/api/groups_api.py +426 -245
  24. flywheel/api/jobs_api.py +288 -173
  25. flywheel/api/jupyterlab_servers_api.py +24 -21
  26. flywheel/api/modalities_api.py +78 -51
  27. flywheel/api/packfiles_api.py +6 -11
  28. flywheel/api/projects_api.py +1661 -856
  29. flywheel/api/protocols_api.py +94 -61
  30. flywheel/api/reports_api.py +196 -115
  31. flywheel/api/resolve_api.py +48 -33
  32. flywheel/api/roles_api.py +82 -53
  33. flywheel/api/sessions_api.py +1137 -623
  34. flywheel/api/site_api.py +182 -113
  35. flywheel/api/staffing_pools_api.py +88 -57
  36. flywheel/api/subjects_api.py +1095 -603
  37. flywheel/api/tasks_api.py +108 -69
  38. flywheel/api/tree_api.py +52 -35
  39. flywheel/api/uids_api.py +10 -13
  40. flywheel/api/upload_api.py +162 -95
  41. flywheel/api/users_api.py +418 -235
  42. flywheel/api/views_api.py +222 -127
  43. flywheel/api_client.py +19 -18
  44. flywheel/configuration.py +2 -9
  45. flywheel/file_spec.py +0 -7
  46. flywheel/flywheel.py +818 -4423
  47. flywheel/gear_context.py +10 -10
  48. flywheel/models/__init__.py +7 -8
  49. flywheel/models/access_level.py +0 -7
  50. flywheel/models/access_permission.py +13 -14
  51. flywheel/models/access_permission_output.py +13 -14
  52. flywheel/models/access_permission_update.py +8 -11
  53. flywheel/models/access_type.py +0 -7
  54. flywheel/models/accumulator.py +0 -7
  55. flywheel/models/acquisition.py +0 -7
  56. flywheel/models/acquisition_container_output.py +0 -7
  57. flywheel/models/acquisition_copy_input.py +18 -17
  58. flywheel/models/acquisition_input.py +33 -26
  59. flywheel/models/acquisition_list_output.py +118 -77
  60. flywheel/models/acquisition_modify_input.py +33 -26
  61. flywheel/models/acquisition_node.py +0 -7
  62. flywheel/models/acquisition_output.py +118 -77
  63. flywheel/models/acquisition_parents.py +23 -20
  64. flywheel/models/acquisition_template_options.py +28 -23
  65. flywheel/models/acquisition_upsert_input.py +48 -35
  66. flywheel/models/acquisition_upsert_output.py +23 -20
  67. flywheel/models/action.py +1 -7
  68. flywheel/models/adhoc_analysis_input.py +23 -20
  69. flywheel/models/analysis.py +0 -7
  70. flywheel/models/analysis_container_output.py +0 -7
  71. flywheel/models/analysis_files_create_ticket_output.py +23 -20
  72. flywheel/models/analysis_input.py +33 -26
  73. flywheel/models/analysis_input_legacy.py +0 -7
  74. flywheel/models/analysis_list_output.py +103 -68
  75. flywheel/models/analysis_list_output_inflated_job.py +98 -65
  76. flywheel/models/analysis_modify_input.py +13 -14
  77. flywheel/models/analysis_node.py +0 -7
  78. flywheel/models/analysis_output.py +103 -68
  79. flywheel/models/analysis_output_inflated_job.py +103 -68
  80. flywheel/models/analysis_parents.py +28 -23
  81. flywheel/models/analysis_update.py +0 -7
  82. flywheel/models/api_key_input_with_optional_label.py +13 -14
  83. flywheel/models/api_key_output.py +33 -26
  84. flywheel/models/as_storage.py +33 -26
  85. flywheel/models/assignee.py +13 -14
  86. flywheel/models/assignee_type.py +0 -7
  87. flywheel/models/audit_trail_report.py +68 -47
  88. flywheel/models/audit_trail_report_status.py +0 -7
  89. flywheel/models/auth0_auth_out.py +38 -29
  90. flywheel/models/auth0_options_out.py +38 -29
  91. flywheel/models/auth_out.py +34 -82
  92. flywheel/models/auth_session_output.py +28 -23
  93. flywheel/models/avatars.py +18 -17
  94. flywheel/models/aws_creds.py +13 -14
  95. flywheel/models/aws_storage.py +43 -32
  96. flywheel/models/azure_creds.py +13 -14
  97. flywheel/models/base_aet.py +23 -20
  98. flywheel/models/base_compute.py +58 -41
  99. flywheel/models/batch.py +43 -32
  100. flywheel/models/batch_cancel_output.py +0 -7
  101. flywheel/models/batch_create_filters.py +18 -17
  102. flywheel/models/batch_job_analysis_input.py +28 -23
  103. flywheel/models/batch_jobs_proposal_input.py +0 -7
  104. flywheel/models/batch_proposal.py +0 -7
  105. flywheel/models/batch_proposal_detail.py +0 -7
  106. flywheel/models/batch_proposal_input.py +0 -7
  107. flywheel/models/body.py +0 -7
  108. flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +0 -7
  109. flywheel/models/body_region.py +0 -7
  110. flywheel/models/bookmark.py +13 -14
  111. flywheel/models/bulk_move_input.py +28 -23
  112. flywheel/models/bulk_move_sessions.py +0 -7
  113. flywheel/models/callbacks_virus_scan_input.py +0 -7
  114. flywheel/models/cancelled_batch_output.py +8 -11
  115. flywheel/models/catalog_list_output.py +53 -38
  116. flywheel/models/central_out.py +33 -26
  117. flywheel/models/change.py +80 -39
  118. flywheel/models/change_log_container_type.py +0 -7
  119. flywheel/models/change_log_document.py +23 -20
  120. flywheel/models/change_method.py +1 -7
  121. flywheel/models/classic_batch_job_output.py +43 -32
  122. flywheel/models/classic_batch_job_output_inflated_jobs.py +48 -35
  123. flywheel/models/classic_batch_proposal_input.py +48 -35
  124. flywheel/models/classic_batch_proposal_output.py +63 -44
  125. flywheel/models/classification_add_delete.py +0 -7
  126. flywheel/models/classification_replace.py +0 -7
  127. flywheel/models/classification_update_input.py +0 -7
  128. flywheel/models/cohort.py +0 -7
  129. flywheel/models/collection.py +0 -7
  130. flywheel/models/collection_container_output.py +0 -7
  131. flywheel/models/collection_input.py +18 -17
  132. flywheel/models/collection_input_with_contents.py +23 -20
  133. flywheel/models/collection_node.py +13 -14
  134. flywheel/models/collection_node_level.py +0 -7
  135. flywheel/models/collection_operation.py +13 -14
  136. flywheel/models/collection_operation_type.py +0 -7
  137. flywheel/models/collection_output.py +93 -62
  138. flywheel/models/collection_with_stats.py +93 -62
  139. flywheel/models/column.py +28 -23
  140. flywheel/models/column_type.py +0 -7
  141. flywheel/models/common_classification.py +3 -8
  142. flywheel/models/common_deleted_count.py +0 -7
  143. flywheel/models/common_editions.py +0 -7
  144. flywheel/models/common_info.py +3 -8
  145. flywheel/models/common_join_origins.py +0 -7
  146. flywheel/models/common_key.py +0 -7
  147. flywheel/models/common_modified_count.py +0 -7
  148. flywheel/models/common_object_created.py +0 -7
  149. flywheel/models/common_project_settings.py +0 -7
  150. flywheel/models/common_settings.py +0 -7
  151. flywheel/models/complete_multipart_upload_output.py +13 -14
  152. flywheel/models/complete_s3_multipart_upload_input.py +23 -20
  153. flywheel/models/config_feature_map.py +0 -7
  154. flywheel/models/config_out.py +48 -35
  155. flywheel/models/config_output.py +0 -7
  156. flywheel/models/config_site_config_output.py +0 -7
  157. flywheel/models/config_site_settings.py +0 -7
  158. flywheel/models/config_site_settings_input.py +0 -7
  159. flywheel/models/conflict_types.py +0 -7
  160. flywheel/models/container_delete_reason.py +0 -7
  161. flywheel/models/container_filter.py +13 -14
  162. flywheel/models/container_id_view_input.py +73 -50
  163. flywheel/models/container_id_view_input_execute_and_save.py +33 -26
  164. flywheel/models/container_modify.py +73 -50
  165. flywheel/models/container_new_output.py +0 -7
  166. flywheel/models/container_node_min.py +43 -32
  167. flywheel/models/container_output.py +0 -7
  168. flywheel/models/container_output_with_files.py +28 -23
  169. flywheel/models/container_parents.py +33 -26
  170. flywheel/models/container_pipeline_input.py +73 -50
  171. flywheel/models/container_project_parents.py +0 -7
  172. flywheel/models/container_reference.py +13 -14
  173. flywheel/models/container_reference_with_label.py +18 -17
  174. flywheel/models/container_session_parents.py +0 -7
  175. flywheel/models/container_subject_parents.py +0 -7
  176. flywheel/models/container_type.py +2 -7
  177. flywheel/models/container_uidcheck.py +23 -20
  178. flywheel/models/container_update.py +3 -8
  179. flywheel/models/context_input.py +18 -17
  180. flywheel/models/copy_filter.py +33 -26
  181. flywheel/models/copy_status.py +0 -7
  182. flywheel/models/core_models_api_key_api_key_input.py +13 -14
  183. flywheel/models/core_models_audit_trail_create_report_input.py +28 -23
  184. flywheel/models/core_models_audit_trail_modify_report_input.py +8 -11
  185. flywheel/models/core_models_common_source.py +13 -14
  186. flywheel/models/core_models_jobs_api_key_input.py +13 -14
  187. flywheel/models/core_models_search_parent_type.py +0 -7
  188. flywheel/models/core_workflows_form_responses_models_form_parents.py +157 -15
  189. flywheel/models/core_workflows_form_responses_models_form_response_output.py +58 -41
  190. flywheel/models/core_workflows_reader_models_reader_task_parents.py +33 -26
  191. flywheel/models/creds.py +3 -8
  192. flywheel/models/curator.py +18 -17
  193. flywheel/models/current_user_output.py +108 -71
  194. flywheel/models/custom_field.py +61 -44
  195. flywheel/models/custom_form.py +23 -20
  196. flywheel/models/cvat_info.py +28 -23
  197. flywheel/models/cvat_settings.py +28 -23
  198. flywheel/models/cvat_settings_input.py +28 -23
  199. flywheel/models/cvat_sync_state.py +0 -7
  200. flywheel/models/daily_report_usage.py +78 -53
  201. flywheel/models/data_strategy.py +0 -7
  202. flywheel/models/data_view.py +0 -7
  203. flywheel/models/data_view_analysis_file_spec.py +18 -17
  204. flywheel/models/data_view_analysis_filter_spec.py +18 -17
  205. flywheel/models/data_view_column_alias.py +38 -29
  206. flywheel/models/data_view_column_spec.py +28 -23
  207. flywheel/models/data_view_execution.py +68 -47
  208. flywheel/models/data_view_execution_state.py +0 -7
  209. flywheel/models/data_view_file_spec.py +48 -35
  210. flywheel/models/data_view_group_by.py +8 -11
  211. flywheel/models/data_view_group_by_column.py +13 -14
  212. flywheel/models/data_view_name_filter_spec.py +13 -14
  213. flywheel/models/data_view_output.py +0 -7
  214. flywheel/models/data_view_save_data_view_input.py +0 -7
  215. flywheel/models/data_view_zip_filter_spec.py +18 -17
  216. flywheel/models/default_flywheel_role.py +0 -7
  217. flywheel/models/deid_log_skip_reason.py +0 -7
  218. flywheel/models/delete_by_search_query.py +23 -20
  219. flywheel/models/delete_status.py +25 -0
  220. flywheel/models/deleted_file.py +73 -50
  221. flywheel/models/deleted_result.py +50 -19
  222. flywheel/models/deprecated_action.py +0 -7
  223. flywheel/models/destination_container_type.py +0 -7
  224. flywheel/models/device.py +58 -41
  225. flywheel/models/device_admin_update.py +13 -14
  226. flywheel/models/device_create.py +18 -17
  227. flywheel/models/device_self_update.py +28 -23
  228. flywheel/models/device_status.py +0 -7
  229. flywheel/models/device_status_entry.py +18 -17
  230. flywheel/models/device_storage_strategy_update.py +13 -14
  231. flywheel/models/dimse_project_input.py +0 -7
  232. flywheel/models/dimse_project_output.py +0 -7
  233. flywheel/models/dimse_service_input.py +0 -7
  234. flywheel/models/dimse_service_output.py +0 -7
  235. flywheel/models/download.py +23 -20
  236. flywheel/models/download_container_filter.py +8 -11
  237. flywheel/models/download_container_filter_definition.py +18 -17
  238. flywheel/models/download_filter.py +18 -17
  239. flywheel/models/download_filter_definition.py +13 -14
  240. flywheel/models/download_format.py +0 -7
  241. flywheel/models/download_input.py +0 -7
  242. flywheel/models/download_node.py +13 -14
  243. flywheel/models/download_strategy.py +0 -7
  244. flywheel/models/download_ticket.py +0 -7
  245. flywheel/models/download_ticket_stub.py +23 -20
  246. flywheel/models/download_ticket_with_summary.py +0 -7
  247. flywheel/models/e_signature.py +23 -20
  248. flywheel/models/edition.py +8 -11
  249. flywheel/models/egress_device.py +88 -59
  250. flywheel/models/egress_device_page.py +18 -17
  251. flywheel/models/egress_provider.py +53 -38
  252. flywheel/models/egress_provider_id.py +8 -11
  253. flywheel/models/exchange_storage.py +23 -20
  254. flywheel/models/executor_info.py +43 -32
  255. flywheel/models/export_templates.py +13 -14
  256. flywheel/models/features.py +457 -307
  257. flywheel/models/field_change.py +28 -23
  258. flywheel/models/field_change_log_document.py +23 -20
  259. flywheel/models/field_type.py +0 -7
  260. flywheel/models/file.py +188 -119
  261. flywheel/models/file_classification_delta.py +23 -20
  262. flywheel/models/file_container_type.py +0 -7
  263. flywheel/models/file_entry.py +108 -71
  264. flywheel/models/file_export_templates.py +28 -23
  265. flywheel/models/file_format.py +0 -7
  266. flywheel/models/file_gear_info.py +18 -17
  267. flywheel/models/file_group.py +0 -7
  268. flywheel/models/file_list_output.py +183 -116
  269. flywheel/models/file_modify_input.py +13 -14
  270. flywheel/models/file_move_input.py +18 -17
  271. flywheel/models/file_node.py +188 -119
  272. flywheel/models/file_node_min.py +38 -29
  273. flywheel/models/file_origin.py +28 -23
  274. flywheel/models/file_output.py +183 -116
  275. flywheel/models/file_parents.py +33 -26
  276. flywheel/models/file_reference.py +18 -17
  277. flywheel/models/file_suggestion.py +23 -20
  278. flywheel/models/file_template_options.py +33 -26
  279. flywheel/models/file_upsert_input.py +88 -59
  280. flywheel/models/file_upsert_origin.py +0 -7
  281. flywheel/models/file_upsert_output.py +188 -119
  282. flywheel/models/file_version.py +13 -14
  283. flywheel/models/file_version_copy_of.py +28 -23
  284. flywheel/models/file_version_output.py +38 -29
  285. flywheel/models/file_via.py +23 -20
  286. flywheel/models/file_zip_entry.py +0 -7
  287. flywheel/models/file_zip_info.py +0 -7
  288. flywheel/models/filter.py +43 -32
  289. flywheel/models/filter_input.py +18 -17
  290. flywheel/models/filter_values.py +13 -14
  291. flywheel/models/filter_view.py +0 -7
  292. flywheel/models/fixed_file_version_input.py +18 -17
  293. flywheel/models/fixed_input.py +33 -26
  294. flywheel/models/form_definition.py +8 -11
  295. flywheel/models/form_response_base.py +33 -26
  296. flywheel/models/form_response_create.py +13 -14
  297. flywheel/models/gcp_creds.py +53 -38
  298. flywheel/models/gcp_storage.py +33 -26
  299. flywheel/models/gear.py +88 -59
  300. flywheel/models/gear_category.py +0 -7
  301. flywheel/models/gear_config.py +3 -8
  302. flywheel/models/gear_context_input.py +8 -11
  303. flywheel/models/gear_context_lookup.py +0 -7
  304. flywheel/models/gear_context_lookup_item.py +0 -7
  305. flywheel/models/gear_context_value_output.py +28 -23
  306. flywheel/models/gear_context_value_output_unfound.py +8 -11
  307. flywheel/models/gear_custom.py +3 -8
  308. flywheel/models/gear_directive.py +3 -8
  309. flywheel/models/gear_doc.py +0 -7
  310. flywheel/models/gear_document.py +38 -29
  311. flywheel/models/gear_document_input.py +33 -26
  312. flywheel/models/gear_document_legacy_input.py +33 -26
  313. flywheel/models/gear_environment.py +3 -8
  314. flywheel/models/gear_exchange.py +18 -17
  315. flywheel/models/gear_file_input.py +13 -14
  316. flywheel/models/gear_id_output.py +8 -11
  317. flywheel/models/gear_info.py +23 -20
  318. flywheel/models/gear_input_item.py +18 -17
  319. flywheel/models/gear_inputs.py +3 -8
  320. flywheel/models/gear_key_input.py +13 -14
  321. flywheel/models/gear_manifest.py +93 -62
  322. flywheel/models/gear_mixin.py +26 -6
  323. flywheel/models/gear_node.py +43 -32
  324. flywheel/models/gear_output_configuration.py +8 -11
  325. flywheel/models/gear_permissions.py +13 -14
  326. flywheel/models/gear_permissions_input.py +8 -11
  327. flywheel/models/gear_permissions_type.py +0 -7
  328. flywheel/models/gear_return_ticket.py +0 -7
  329. flywheel/models/gear_rule.py +133 -69
  330. flywheel/models/gear_rule_condition.py +18 -17
  331. flywheel/models/gear_rule_condition_type.py +0 -7
  332. flywheel/models/gear_rule_input.py +108 -54
  333. flywheel/models/gear_rule_modify_input.py +103 -51
  334. flywheel/models/gear_rule_output.py +133 -69
  335. flywheel/models/gear_save_submission.py +18 -17
  336. flywheel/models/gear_series.py +33 -26
  337. flywheel/models/gear_series_update.py +8 -11
  338. flywheel/models/gear_suggestion_output.py +33 -26
  339. flywheel/models/gear_ticket.py +23 -20
  340. flywheel/models/gear_ticket_output.py +8 -11
  341. flywheel/models/graph_filter.py +38 -29
  342. flywheel/models/group.py +0 -7
  343. flywheel/models/group_by.py +8 -11
  344. flywheel/models/group_by_column.py +0 -7
  345. flywheel/models/group_container_output.py +0 -7
  346. flywheel/models/group_input.py +23 -20
  347. flywheel/models/group_metadata_input.py +0 -7
  348. flywheel/models/group_node.py +0 -7
  349. flywheel/models/group_output.py +63 -44
  350. flywheel/models/group_report.py +18 -17
  351. flywheel/models/group_role.py +8 -11
  352. flywheel/models/group_settings_output.py +23 -20
  353. flywheel/models/group_update.py +23 -20
  354. flywheel/models/header_feature.py +0 -7
  355. flywheel/models/hierarchy_export_templates.py +28 -23
  356. flywheel/models/http_validation_error.py +8 -11
  357. flywheel/models/info.py +18 -17
  358. flywheel/models/info_add_remove.py +0 -7
  359. flywheel/models/info_container_type.py +0 -7
  360. flywheel/models/info_replace.py +0 -7
  361. flywheel/models/info_update_input.py +0 -7
  362. flywheel/models/ingress_provider.py +33 -26
  363. flywheel/models/ingress_providers.py +28 -23
  364. flywheel/models/ingress_site_settings.py +29 -52
  365. flywheel/models/ingress_update_provider.py +18 -17
  366. flywheel/models/inline_response200.py +8 -11
  367. flywheel/models/inline_response2001.py +8 -11
  368. flywheel/models/inline_response2002.py +8 -11
  369. flywheel/models/inline_response2003.py +0 -7
  370. flywheel/models/inline_response2005.py +0 -7
  371. flywheel/models/input_filter.py +18 -17
  372. flywheel/models/input_job.py +73 -50
  373. flywheel/models/input_job_profile.py +28 -23
  374. flywheel/models/inserted_id.py +8 -11
  375. flywheel/models/job.py +128 -83
  376. flywheel/models/job_analysis_input.py +28 -23
  377. flywheel/models/job_ask.py +33 -26
  378. flywheel/models/job_ask_response.py +13 -14
  379. flywheel/models/job_ask_response_job.py +158 -101
  380. flywheel/models/job_ask_return.py +0 -7
  381. flywheel/models/job_ask_return_criteria.py +23 -20
  382. flywheel/models/job_ask_state.py +0 -7
  383. flywheel/models/job_ask_state_response.py +8 -11
  384. flywheel/models/job_complete.py +18 -17
  385. flywheel/models/job_completion_input.py +0 -7
  386. flywheel/models/job_completion_ticket.py +0 -7
  387. flywheel/models/job_config.py +3 -8
  388. flywheel/models/job_config_input.py +28 -23
  389. flywheel/models/job_config_inputs.py +0 -7
  390. flywheel/models/job_config_output.py +0 -7
  391. flywheel/models/job_container_detail.py +0 -7
  392. flywheel/models/job_destination.py +13 -14
  393. flywheel/models/job_detail.py +148 -95
  394. flywheel/models/job_detail_container.py +13 -14
  395. flywheel/models/job_detail_file_entry.py +13 -14
  396. flywheel/models/job_detail_group.py +13 -14
  397. flywheel/models/job_detail_parent_info.py +33 -26
  398. flywheel/models/job_executor_info.py +43 -32
  399. flywheel/models/job_file_input.py +23 -20
  400. flywheel/models/job_file_input_list_output.py +23 -20
  401. flywheel/models/job_file_object.py +58 -41
  402. flywheel/models/job_file_object_list_output.py +53 -38
  403. flywheel/models/job_gear_match.py +0 -7
  404. flywheel/models/job_inputs_array_item.py +33 -26
  405. flywheel/models/job_inputs_item.py +23 -20
  406. flywheel/models/job_inputs_object.py +3 -8
  407. flywheel/models/job_list_entry.py +0 -7
  408. flywheel/models/job_list_output.py +158 -101
  409. flywheel/models/job_list_output_config.py +18 -17
  410. flywheel/models/job_log.py +13 -14
  411. flywheel/models/job_log_column.py +0 -7
  412. flywheel/models/job_log_record.py +13 -14
  413. flywheel/models/job_modify.py +13 -14
  414. flywheel/models/job_origin.py +13 -14
  415. flywheel/models/job_output.py +163 -104
  416. flywheel/models/job_output_config.py +23 -20
  417. flywheel/models/job_parents.py +33 -26
  418. flywheel/models/job_priority.py +0 -7
  419. flywheel/models/job_priority_update.py +13 -14
  420. flywheel/models/job_profile.py +53 -38
  421. flywheel/models/job_profile_input.py +0 -7
  422. flywheel/models/job_request.py +18 -17
  423. flywheel/models/job_request_item.py +23 -20
  424. flywheel/models/job_request_item_type.py +0 -7
  425. flywheel/models/job_request_target.py +28 -23
  426. flywheel/models/job_state.py +0 -7
  427. flywheel/models/job_state_counts.py +0 -7
  428. flywheel/models/job_stats_by_state.py +0 -7
  429. flywheel/models/job_ticket_output.py +8 -11
  430. flywheel/models/job_transition_times.py +23 -20
  431. flywheel/models/job_version_info.py +3 -8
  432. flywheel/models/jobs_by_state.py +28 -23
  433. flywheel/models/jobs_list.py +8 -11
  434. flywheel/models/join_origin_device.py +8 -11
  435. flywheel/models/join_origin_job.py +18 -17
  436. flywheel/models/join_origin_user.py +13 -14
  437. flywheel/models/join_origins.py +18 -17
  438. flywheel/models/join_type.py +0 -7
  439. flywheel/models/jupyterhub_workspace.py +8 -11
  440. flywheel/models/jupyterlab_server_modify.py +28 -23
  441. flywheel/models/jupyterlab_server_origin.py +0 -7
  442. flywheel/models/jupyterlab_server_output.py +0 -7
  443. flywheel/models/jupyterlab_server_response.py +53 -38
  444. flywheel/models/jupyterlab_server_update.py +0 -7
  445. flywheel/models/ldap_sync.py +0 -7
  446. flywheel/models/ldap_sync_config.py +8 -11
  447. flywheel/models/ldap_sync_input.py +0 -7
  448. flywheel/models/ldap_sync_status.py +23 -20
  449. flywheel/models/legacy_api_key_output.py +28 -23
  450. flywheel/models/legacy_input.py +23 -20
  451. flywheel/models/legacy_usage_report.py +33 -26
  452. flywheel/models/legacys_usage_project_entry.py +13 -14
  453. flywheel/models/libs_viewer_config_models_viewer_config.py +194 -0
  454. flywheel/models/libs_workflows_models_parent_type.py +0 -7
  455. flywheel/models/libs_workflows_models_task_status.py +0 -7
  456. flywheel/models/local_storage.py +18 -17
  457. flywheel/models/location.py +13 -14
  458. flywheel/models/locked.py +18 -17
  459. flywheel/models/master_subject_code_dob_input.py +28 -23
  460. flywheel/models/master_subject_code_input.py +28 -23
  461. flywheel/models/master_subject_code_output.py +8 -11
  462. flywheel/models/matched_acquisition_output.py +73 -50
  463. flywheel/models/measurement_config.py +222 -0
  464. flywheel/models/measurement_item_config.py +217 -0
  465. flywheel/models/mfa_channel.py +0 -7
  466. flywheel/models/mfa_settings.py +8 -11
  467. flywheel/models/ml_set_filter.py +13 -14
  468. flywheel/models/ml_type.py +0 -7
  469. flywheel/models/modality.py +23 -20
  470. flywheel/models/modality_input.py +23 -20
  471. flywheel/models/modality_modify.py +18 -17
  472. flywheel/models/modality_output.py +28 -23
  473. flywheel/models/modified_result.py +13 -14
  474. flywheel/models/modify_user_input.py +63 -44
  475. flywheel/models/move_conflict.py +33 -26
  476. flywheel/models/note.py +48 -35
  477. flywheel/models/note_input.py +8 -11
  478. flywheel/models/optional_input_policy.py +0 -7
  479. flywheel/models/order.py +0 -7
  480. flywheel/models/organ_system.py +0 -7
  481. flywheel/models/origin.py +13 -14
  482. flywheel/models/origin_type.py +0 -7
  483. flywheel/models/orphaned_count.py +8 -11
  484. flywheel/models/output_user_page.py +18 -17
  485. flywheel/models/packfile_cleanup_output.py +8 -11
  486. flywheel/models/packfile_removed_output.py +13 -14
  487. flywheel/models/page.py +18 -17
  488. flywheel/models/page_generic_file_output.py +18 -17
  489. flywheel/models/page_generic_filter.py +18 -17
  490. flywheel/models/page_generic_form_response_output.py +18 -17
  491. flywheel/models/page_generic_protocol.py +23 -20
  492. flywheel/models/page_generic_reader_task_output.py +23 -20
  493. flywheel/models/page_generic_staffing_pool.py +23 -20
  494. flywheel/models/parsed_query_response.py +13 -14
  495. flywheel/models/permission_access_permission.py +0 -7
  496. flywheel/models/premade_jobs_batch_job_output.py +33 -26
  497. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +33 -26
  498. flywheel/models/premade_jobs_batch_proposal.py +38 -29
  499. flywheel/models/premade_jobs_batch_proposal_detail.py +8 -11
  500. flywheel/models/premade_jobs_batch_proposal_input.py +8 -11
  501. flywheel/models/project.py +0 -7
  502. flywheel/models/project_acquisition_upsert_input.py +0 -7
  503. flywheel/models/project_acquisition_upsert_output.py +0 -7
  504. flywheel/models/project_aet.py +38 -29
  505. flywheel/models/project_aet_input.py +23 -20
  506. flywheel/models/project_catalog_list_output.py +0 -7
  507. flywheel/models/project_contact.py +13 -14
  508. flywheel/models/project_container_output.py +2 -7
  509. flywheel/models/project_copy_input.py +23 -20
  510. flywheel/models/project_copy_output.py +18 -17
  511. flywheel/models/project_counters.py +76 -36
  512. flywheel/models/project_delete_status_output.py +192 -0
  513. flywheel/models/project_group_info.py +189 -0
  514. flywheel/models/project_hierarchy_input.py +28 -23
  515. flywheel/models/project_hierarchy_output.py +18 -17
  516. flywheel/models/project_hierarchy_upsert_input.py +0 -7
  517. flywheel/models/project_hierarchy_upsert_output.py +0 -7
  518. flywheel/models/project_input.py +48 -35
  519. flywheel/models/project_institution.py +13 -14
  520. flywheel/models/project_list_output.py +234 -93
  521. flywheel/models/project_locking_reason.py +0 -7
  522. flywheel/models/project_modify.py +116 -42
  523. flywheel/models/project_node.py +2 -7
  524. flywheel/models/project_output.py +235 -93
  525. flywheel/models/project_parents.py +8 -11
  526. flywheel/models/project_report.py +63 -44
  527. flywheel/models/project_report_list.py +8 -11
  528. flywheel/models/project_session_upsert_input.py +0 -7
  529. flywheel/models/project_session_upsert_output.py +0 -7
  530. flywheel/models/project_settings_input.py +38 -29
  531. flywheel/models/project_settings_output.py +38 -29
  532. flywheel/models/project_settings_sharing.py +38 -29
  533. flywheel/models/project_settings_sharing_input.py +38 -29
  534. flywheel/models/project_settings_workspaces.py +8 -11
  535. flywheel/models/project_settings_workspaces_input.py +8 -11
  536. flywheel/models/project_share_level.py +0 -7
  537. flywheel/models/project_sharing_settings_project_contact.py +0 -7
  538. flywheel/models/project_sharing_settings_project_counters.py +0 -7
  539. flywheel/models/project_sharing_settings_project_institution.py +0 -7
  540. flywheel/models/project_sharing_settings_project_settings_input.py +0 -7
  541. flywheel/models/project_sharing_settings_project_settings_output.py +0 -7
  542. flywheel/models/project_sharing_settings_project_settings_sharing.py +0 -7
  543. flywheel/models/project_sharing_settings_project_settings_sharing_input.py +0 -7
  544. flywheel/models/project_sharing_settings_project_stats.py +0 -7
  545. flywheel/models/project_stats.py +28 -23
  546. flywheel/models/project_subject_upsert_input.py +0 -7
  547. flywheel/models/project_subject_upsert_output.py +0 -7
  548. flywheel/models/project_template.py +13 -14
  549. flywheel/models/project_template_input.py +13 -14
  550. flywheel/models/project_template_list_input.py +8 -11
  551. flywheel/models/project_template_requirement.py +0 -7
  552. flywheel/models/project_template_session_template.py +0 -7
  553. flywheel/models/project_upsert_origin.py +0 -7
  554. flywheel/models/protocol.py +78 -53
  555. flywheel/models/protocol_e_signature_config.py +13 -14
  556. flywheel/models/protocol_input.py +43 -32
  557. flywheel/models/protocol_modify.py +28 -23
  558. flywheel/models/protocol_status.py +0 -7
  559. flywheel/models/provider.py +63 -44
  560. flywheel/models/provider_access_type.py +0 -7
  561. flywheel/models/provider_class.py +0 -7
  562. flywheel/models/provider_deletion_status.py +13 -14
  563. flywheel/models/provider_input.py +0 -7
  564. flywheel/models/provider_links.py +28 -23
  565. flywheel/models/provider_type.py +0 -7
  566. flywheel/models/providers.py +28 -23
  567. flywheel/models/reader_batch_create.py +63 -44
  568. flywheel/models/reader_task.py +113 -74
  569. flywheel/models/reader_task_config.py +49 -18
  570. flywheel/models/reader_task_create.py +78 -53
  571. flywheel/models/reader_task_modify.py +33 -26
  572. flywheel/models/reader_task_output.py +118 -77
  573. flywheel/models/reader_task_parent_details.py +38 -29
  574. flywheel/models/report_access_log_context.py +33 -26
  575. flywheel/models/report_access_log_context_entry.py +13 -14
  576. flywheel/models/report_access_log_context_file_entry.py +8 -11
  577. flywheel/models/report_access_log_entry.py +88 -59
  578. flywheel/models/report_access_log_origin.py +13 -14
  579. flywheel/models/report_availability_list.py +8 -11
  580. flywheel/models/report_daily_usage_entry.py +68 -47
  581. flywheel/models/report_demographics_grid.py +0 -7
  582. flywheel/models/report_ethnicity_grid.py +23 -20
  583. flywheel/models/report_gender_count.py +18 -17
  584. flywheel/models/report_group_report.py +18 -17
  585. flywheel/models/report_legacy_usage_entry.py +0 -7
  586. flywheel/models/report_legacy_usage_project_entry.py +0 -7
  587. flywheel/models/report_project.py +0 -7
  588. flywheel/models/report_site.py +13 -14
  589. flywheel/models/report_time_period.py +13 -14
  590. flywheel/models/report_usage.py +88 -59
  591. flywheel/models/report_usage_entry.py +0 -7
  592. flywheel/models/resolve_input.py +8 -11
  593. flywheel/models/resolve_output.py +13 -14
  594. flywheel/models/resolver_acquisition_node.py +0 -7
  595. flywheel/models/resolver_analysis_node.py +0 -7
  596. flywheel/models/resolver_file_node.py +0 -7
  597. flywheel/models/resolver_gear_node.py +0 -7
  598. flywheel/models/resolver_group_node.py +0 -7
  599. flywheel/models/resolver_input.py +0 -7
  600. flywheel/models/resolver_node.py +8 -11
  601. flywheel/models/resolver_output.py +0 -7
  602. flywheel/models/resolver_project_node.py +0 -7
  603. flywheel/models/resolver_session_node.py +0 -7
  604. flywheel/models/resolver_subject_node.py +0 -7
  605. flywheel/models/role_input.py +13 -14
  606. flywheel/models/role_output.py +28 -23
  607. flywheel/models/role_permission.py +13 -14
  608. flywheel/models/role_permission_output.py +13 -14
  609. flywheel/models/role_permission_update.py +8 -11
  610. flywheel/models/role_type.py +0 -7
  611. flywheel/models/role_update.py +13 -14
  612. flywheel/models/roles_backwards_compatible_role_assignment.py +0 -7
  613. flywheel/models/roles_group_role_pool_input.py +0 -7
  614. flywheel/models/roles_role.py +0 -7
  615. flywheel/models/roles_role_assignment.py +13 -14
  616. flywheel/models/roles_role_input.py +0 -7
  617. flywheel/models/rule.py +63 -44
  618. flywheel/models/rule_any.py +18 -17
  619. flywheel/models/s3_addressing_style.py +0 -7
  620. flywheel/models/s3_compat_storage.py +48 -35
  621. flywheel/models/save_search.py +33 -26
  622. flywheel/models/save_search_input.py +18 -17
  623. flywheel/models/save_search_output.py +33 -26
  624. flywheel/models/save_search_page.py +18 -17
  625. flywheel/models/save_search_parent.py +13 -14
  626. flywheel/models/save_search_update.py +13 -14
  627. flywheel/models/search_acquisition_response.py +23 -20
  628. flywheel/models/search_analysis_response.py +23 -20
  629. flywheel/models/search_collection_response.py +23 -20
  630. flywheel/models/search_file_response.py +33 -26
  631. flywheel/models/search_group_response.py +13 -14
  632. flywheel/models/search_parent_acquisition.py +0 -7
  633. flywheel/models/search_parent_analysis.py +0 -7
  634. flywheel/models/search_parent_collection.py +0 -7
  635. flywheel/models/search_parent_project.py +2 -7
  636. flywheel/models/search_parent_response.py +13 -14
  637. flywheel/models/search_parent_session.py +0 -7
  638. flywheel/models/search_parent_subject.py +0 -7
  639. flywheel/models/search_parse_error.py +23 -20
  640. flywheel/models/search_parse_search_query_result.py +0 -7
  641. flywheel/models/search_project_response.py +13 -14
  642. flywheel/models/search_query.py +38 -29
  643. flywheel/models/search_query_suggestions.py +0 -7
  644. flywheel/models/search_response.py +58 -41
  645. flywheel/models/search_return_type.py +0 -7
  646. flywheel/models/search_save_search.py +0 -7
  647. flywheel/models/search_save_search_input.py +0 -7
  648. flywheel/models/search_save_search_parent.py +0 -7
  649. flywheel/models/search_save_search_update.py +0 -7
  650. flywheel/models/search_session_response.py +23 -20
  651. flywheel/models/search_status.py +8 -11
  652. flywheel/models/search_structured_search_query.py +0 -7
  653. flywheel/models/search_subject_response.py +18 -17
  654. flywheel/models/search_suggestion.py +0 -7
  655. flywheel/models/select_item.py +13 -14
  656. flywheel/models/server_state.py +33 -26
  657. flywheel/models/service_aet.py +33 -26
  658. flywheel/models/service_aet_input.py +28 -23
  659. flywheel/models/session.py +0 -7
  660. flywheel/models/session_container_output.py +0 -7
  661. flywheel/models/session_copy_input.py +23 -20
  662. flywheel/models/session_embedded_subject.py +33 -26
  663. flywheel/models/session_input.py +58 -41
  664. flywheel/models/session_list_output.py +143 -92
  665. flywheel/models/session_metadata_input.py +0 -7
  666. flywheel/models/session_modify.py +63 -44
  667. flywheel/models/session_node.py +0 -7
  668. flywheel/models/session_output.py +143 -92
  669. flywheel/models/session_parents.py +18 -17
  670. flywheel/models/session_template_options.py +18 -17
  671. flywheel/models/session_template_recalc_output.py +8 -11
  672. flywheel/models/session_upsert_input.py +63 -44
  673. flywheel/models/session_upsert_output.py +23 -20
  674. flywheel/models/sharing_filter_options.py +43 -32
  675. flywheel/models/signed_fs_upload_output.py +13 -14
  676. flywheel/models/signed_url_cleanup_input.py +13 -14
  677. flywheel/models/signed_url_upload_input.py +13 -14
  678. flywheel/models/signed_url_upload_output.py +43 -32
  679. flywheel/models/site.py +93 -62
  680. flywheel/models/site_report.py +13 -14
  681. flywheel/models/site_settings.py +48 -35
  682. flywheel/models/sort.py +13 -14
  683. flywheel/models/stable_api_key_input.py +0 -7
  684. flywheel/models/staffing_pool.py +38 -29
  685. flywheel/models/staffing_pool_create.py +18 -17
  686. flywheel/models/staffing_pool_list.py +8 -11
  687. flywheel/models/staffing_pool_modify.py +18 -17
  688. flywheel/models/state.py +0 -7
  689. flywheel/models/static_compute.py +18 -17
  690. flywheel/models/status_transitions.py +23 -20
  691. flywheel/models/status_type.py +0 -7
  692. flywheel/models/status_value.py +0 -7
  693. flywheel/models/storage_strategy.py +0 -7
  694. flywheel/models/storage_strategy_config.py +13 -14
  695. flywheel/models/structured_query.py +8 -11
  696. flywheel/models/structured_query_suggestions.py +13 -14
  697. flywheel/models/structured_query_value_suggestion.py +23 -20
  698. flywheel/models/subject.py +0 -7
  699. flywheel/models/subject_container_output.py +0 -7
  700. flywheel/models/subject_copy_input.py +18 -17
  701. flywheel/models/subject_input.py +93 -62
  702. flywheel/models/subject_modify.py +103 -68
  703. flywheel/models/subject_node.py +0 -7
  704. flywheel/models/subject_output.py +163 -104
  705. flywheel/models/subject_output_for_list.py +163 -104
  706. flywheel/models/subject_parents.py +13 -14
  707. flywheel/models/subject_role_permission.py +13 -14
  708. flywheel/models/subject_state.py +0 -7
  709. flywheel/models/subject_template_options.py +13 -14
  710. flywheel/models/subject_upsert_input.py +83 -56
  711. flywheel/models/subject_upsert_output.py +18 -17
  712. flywheel/models/sync_user_input.py +38 -29
  713. flywheel/models/tag.py +8 -11
  714. flywheel/models/task_assign.py +13 -14
  715. flywheel/models/task_facet.py +0 -7
  716. flywheel/models/task_parent_ref.py +23 -20
  717. flywheel/models/task_parent_ref_input.py +18 -17
  718. flywheel/models/task_priority.py +0 -7
  719. flywheel/models/task_submission.py +13 -14
  720. flywheel/models/therapeutic_area.py +0 -7
  721. flywheel/models/toolbar_config.py +161 -0
  722. flywheel/models/transitions.py +28 -23
  723. flywheel/models/tree_container_request_spec.py +28 -23
  724. flywheel/models/tree_graph.py +3 -8
  725. flywheel/models/tree_graph_connection.py +23 -20
  726. flywheel/models/tree_graph_connections.py +3 -8
  727. flywheel/models/tree_graph_node.py +8 -11
  728. flywheel/models/tree_request.py +0 -7
  729. flywheel/models/tree_response_item.py +3 -8
  730. flywheel/models/type_str.py +0 -7
  731. flywheel/models/uid_check_input_acquisitions.py +23 -20
  732. flywheel/models/uid_check_input_sessions.py +23 -20
  733. flywheel/models/uid_check_output.py +13 -14
  734. flywheel/models/upload_complete_s3_multipart_input.py +0 -7
  735. flywheel/models/upload_complete_s3_multipart_output.py +0 -7
  736. flywheel/models/upload_signed_fs_file_upload_output.py +0 -7
  737. flywheel/models/upload_signed_upload_url_input.py +0 -7
  738. flywheel/models/upload_signed_upload_url_output.py +0 -7
  739. flywheel/models/upload_ticket_output.py +18 -17
  740. flywheel/models/upload_token_output.py +8 -11
  741. flywheel/models/upsert_result.py +0 -7
  742. flywheel/models/user.py +113 -74
  743. flywheel/models/user_api_key.py +18 -17
  744. flywheel/models/user_input.py +63 -44
  745. flywheel/models/user_jobs.py +18 -17
  746. flywheel/models/user_jobs_output.py +0 -7
  747. flywheel/models/user_output.py +0 -7
  748. flywheel/models/user_output_id.py +8 -11
  749. flywheel/models/user_preferences.py +3 -8
  750. flywheel/models/user_wechat.py +3 -8
  751. flywheel/models/validation_error.py +18 -17
  752. flywheel/models/validation_rule.py +13 -14
  753. flywheel/models/version.py +43 -32
  754. flywheel/models/version_output.py +0 -7
  755. flywheel/models/view_id_output.py +8 -11
  756. flywheel/models/view_output.py +58 -41
  757. flywheel/models/viewer_app.py +48 -35
  758. flywheel/models/viewer_app_input.py +48 -35
  759. flywheel/models/viewer_app_type.py +0 -7
  760. flywheel/models/virus_scan.py +8 -11
  761. flywheel/models/virus_scan_state.py +0 -7
  762. flywheel/models/work_in_progress_features.py +3 -8
  763. flywheel/models/zipfile_info.py +13 -14
  764. flywheel/models/zipfile_member_info.py +23 -20
  765. flywheel/partial_reader.py +0 -7
  766. flywheel/rest.py +0 -7
  767. flywheel/view_builder.py +2 -1
  768. {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/METADATA +1 -1
  769. flywheel_sdk-21.4.0.dist-info/RECORD +778 -0
  770. {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/WHEEL +1 -1
  771. flywheel/models/google_auth_out.py +0 -299
  772. flywheel_sdk-21.3.0rc0.dist-info/RECORD +0 -772
  773. {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/licenses/LICENSE.txt +0 -0
@@ -1,13 +1,6 @@
1
1
  # coding: utf-8
2
2
 
3
3
  """
4
- Flywheel
5
-
6
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
7
-
8
- OpenAPI spec version: 0.0.1
9
-
10
- Generated by: https://github.com/swagger-api/swagger-codegen.git
11
4
  """
12
5
 
13
6
 
@@ -37,10 +30,13 @@ class AcquisitionsApi(object):
37
30
  Smart copy an acquisition
38
31
  This method makes a synchronous HTTP request by default.
39
32
 
40
- :param str acquisition_id: (required)
41
- :param AcquisitionCopyInput body: (required)
42
- :param bool async_: Perform the request asynchronously
43
- :return: Acquisition
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
44
40
  """
45
41
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
46
42
  kwargs['_return_http_data_only'] = True
@@ -64,10 +60,13 @@ class AcquisitionsApi(object):
64
60
  Smart copy an acquisition
65
61
  This method makes a synchronous HTTP request by default.
66
62
 
67
- :param str acquisition_id: (required)
68
- :param AcquisitionCopyInput body: (required)
69
- :param bool async_: Perform the request asynchronously
70
- :return: Acquisition
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
71
70
  """
72
71
 
73
72
  all_params = ['acquisition_id','body',] # noqa: E501
@@ -153,9 +152,11 @@ class AcquisitionsApi(object):
153
152
  Create a new acquisition
154
153
  This method makes a synchronous HTTP request by default.
155
154
 
156
- :param AcquisitionInput body: (required)
157
- :param bool async_: Perform the request asynchronously
158
- :return: InsertedId
155
+ :param body:
156
+ :type body: AcquisitionInput
157
+ :param async_: Perform the request asynchronously
158
+ :type async_: bool, optional
159
+ :rtype: InsertedId
159
160
  """
160
161
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
161
162
  kwargs['_return_http_data_only'] = True
@@ -179,9 +180,11 @@ class AcquisitionsApi(object):
179
180
  Create a new acquisition
180
181
  This method makes a synchronous HTTP request by default.
181
182
 
182
- :param AcquisitionInput body: (required)
183
- :param bool async_: Perform the request asynchronously
184
- :return: InsertedId
183
+ :param body:
184
+ :type body: AcquisitionInput
185
+ :param async_: Perform the request asynchronously
186
+ :type async_: bool, optional
187
+ :rtype: InsertedId
185
188
  """
186
189
 
187
190
  all_params = ['body',] # noqa: E501
@@ -261,12 +264,15 @@ class AcquisitionsApi(object):
261
264
  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.
262
265
  This method makes a synchronous HTTP request by default.
263
266
 
264
- :param str cid: (required)
265
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
266
- :param bool job: returns job_id instead of analysis.id
267
- :param bool job: returns job_id instead of analysis.id
268
- :param bool async_: Perform the request asynchronously
269
- :return: InsertedId
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
270
276
  """
271
277
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
272
278
  kwargs['_return_http_data_only'] = True
@@ -290,15 +296,18 @@ class AcquisitionsApi(object):
290
296
  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.
291
297
  This method makes a synchronous HTTP request by default.
292
298
 
293
- :param str cid: (required)
294
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
295
- :param bool job: returns job_id instead of analysis.id
296
- :param bool job: returns job_id instead of analysis.id
297
- :param bool async_: Perform the request asynchronously
298
- :return: InsertedId
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
299
308
  """
300
309
 
301
- all_params = ['cid','body','job','job',] # noqa: E501
310
+ all_params = ['cid','body','job',] # noqa: E501
302
311
  all_params.append('async_')
303
312
  all_params.append('_return_http_data_only')
304
313
  all_params.append('_preload_content')
@@ -331,8 +340,6 @@ class AcquisitionsApi(object):
331
340
  path_params['cid'] = params['cid'] # noqa: E501
332
341
 
333
342
  query_params = []
334
- if 'job' in params:
335
- query_params.append(('job', params['job'])) # noqa: E501
336
343
  if 'job' in params:
337
344
  query_params.append(('job', params['job'])) # noqa: E501
338
345
  else:
@@ -387,11 +394,15 @@ class AcquisitionsApi(object):
387
394
  Add a note to a(n) acquisition analysis.
388
395
  This method makes a synchronous HTTP request by default.
389
396
 
390
- :param str container_id: 24-char hex id (required)
391
- :param str analysis_id: 24-char hex analysis id (required)
392
- :param NoteInput body: (required)
393
- :param bool async_: Perform the request asynchronously
394
- :return: Note
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
395
406
  """
396
407
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
397
408
  kwargs['_return_http_data_only'] = True
@@ -415,11 +426,15 @@ class AcquisitionsApi(object):
415
426
  Add a note to a(n) acquisition analysis.
416
427
  This method makes a synchronous HTTP request by default.
417
428
 
418
- :param str container_id: 24-char hex id (required)
419
- :param str analysis_id: 24-char hex analysis id (required)
420
- :param NoteInput body: (required)
421
- :param bool async_: Perform the request asynchronously
422
- :return: Note
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
423
438
  """
424
439
 
425
440
  all_params = ['container_id','analysis_id','body',] # noqa: E501
@@ -511,10 +526,13 @@ class AcquisitionsApi(object):
511
526
  Add a note to a(n) acquisition.
512
527
  This method makes a synchronous HTTP request by default.
513
528
 
514
- :param str container_id: (required)
515
- :param NoteInput body: (required)
516
- :param bool async_: Perform the request asynchronously
517
- :return: Note
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
518
536
  """
519
537
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
520
538
  kwargs['_return_http_data_only'] = True
@@ -538,10 +556,13 @@ class AcquisitionsApi(object):
538
556
  Add a note to a(n) acquisition.
539
557
  This method makes a synchronous HTTP request by default.
540
558
 
541
- :param str container_id: (required)
542
- :param NoteInput body: (required)
543
- :param bool async_: Perform the request asynchronously
544
- :return: Note
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
545
566
  """
546
567
 
547
568
  all_params = ['container_id','body',] # noqa: E501
@@ -627,10 +648,13 @@ class AcquisitionsApi(object):
627
648
  Propagates changes to projects, sessions and acquisitions
628
649
  This method makes a synchronous HTTP request by default.
629
650
 
630
- :param str cid: (required)
631
- :param Tag body: (required)
632
- :param bool async_: Perform the request asynchronously
633
- :return: ModifiedResult
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
634
658
  """
635
659
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
636
660
  kwargs['_return_http_data_only'] = True
@@ -654,10 +678,13 @@ class AcquisitionsApi(object):
654
678
  Propagates changes to projects, sessions and acquisitions
655
679
  This method makes a synchronous HTTP request by default.
656
680
 
657
- :param str cid: (required)
658
- :param Tag body: (required)
659
- :param bool async_: Perform the request asynchronously
660
- :return: ModifiedResult
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
661
688
  """
662
689
 
663
690
  all_params = ['cid','body',] # noqa: E501
@@ -743,10 +770,13 @@ class AcquisitionsApi(object):
743
770
  Add multiple tags to a(n) acquisition
744
771
  This method makes a synchronous HTTP request by default.
745
772
 
746
- :param str cid: (required)
747
- :param list[str] body: (required)
748
- :param bool async_: Perform the request asynchronously
749
- :return: None
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
750
780
  """
751
781
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
752
782
  kwargs['_return_http_data_only'] = True
@@ -770,10 +800,13 @@ class AcquisitionsApi(object):
770
800
  Add multiple tags to a(n) acquisition
771
801
  This method makes a synchronous HTTP request by default.
772
802
 
773
- :param str cid: (required)
774
- :param list[str] body: (required)
775
- :param bool async_: Perform the request asynchronously
776
- :return: None
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
777
810
  """
778
811
 
779
812
  all_params = ['cid','body',] # noqa: E501
@@ -852,10 +885,13 @@ class AcquisitionsApi(object):
852
885
  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.
853
886
  This method makes a synchronous HTTP request by default.
854
887
 
855
- :param str acquisition_id: (required)
856
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
857
- :param bool async_: Perform the request asynchronously
858
- :return: DeletedResult
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
859
895
  """
860
896
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
861
897
  kwargs['_return_http_data_only'] = True
@@ -879,10 +915,13 @@ class AcquisitionsApi(object):
879
915
  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.
880
916
  This method makes a synchronous HTTP request by default.
881
917
 
882
- :param str acquisition_id: (required)
883
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
884
- :param bool async_: Perform the request asynchronously
885
- :return: DeletedResult
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
886
925
  """
887
926
 
888
927
  all_params = ['acquisition_id','delete_reason',] # noqa: E501
@@ -953,11 +992,15 @@ class AcquisitionsApi(object):
953
992
  Delete an analysis for a container.
954
993
  This method makes a synchronous HTTP request by default.
955
994
 
956
- :param str cid: (required)
957
- :param str analysis_id: (required)
958
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
959
- :param bool async_: Perform the request asynchronously
960
- :return: DeletedResult
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
961
1004
  """
962
1005
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
963
1006
  kwargs['_return_http_data_only'] = True
@@ -981,11 +1024,15 @@ class AcquisitionsApi(object):
981
1024
  Delete an analysis for a container.
982
1025
  This method makes a synchronous HTTP request by default.
983
1026
 
984
- :param str cid: (required)
985
- :param str analysis_id: (required)
986
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
987
- :param bool async_: Perform the request asynchronously
988
- :return: DeletedResult
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
989
1036
  """
990
1037
 
991
1038
  all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
@@ -1062,11 +1109,15 @@ class AcquisitionsApi(object):
1062
1109
  Remove a note from a(n) acquisition analysis.
1063
1110
  This method makes a synchronous HTTP request by default.
1064
1111
 
1065
- :param str cid: 24-char hex id (required)
1066
- :param str analysis_id: 24-char hex analysis id (required)
1067
- :param str note_id: 24-char hex note id (required)
1068
- :param bool async_: Perform the request asynchronously
1069
- :return: DeletedResult
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
1070
1121
  """
1071
1122
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1072
1123
  kwargs['_return_http_data_only'] = True
@@ -1090,11 +1141,15 @@ class AcquisitionsApi(object):
1090
1141
  Remove a note from a(n) acquisition analysis.
1091
1142
  This method makes a synchronous HTTP request by default.
1092
1143
 
1093
- :param str cid: 24-char hex id (required)
1094
- :param str analysis_id: 24-char hex analysis id (required)
1095
- :param str note_id: 24-char hex note id (required)
1096
- :param bool async_: Perform the request asynchronously
1097
- :return: DeletedResult
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
1098
1153
  """
1099
1154
 
1100
1155
  all_params = ['cid','analysis_id','note_id',] # noqa: E501
@@ -1175,12 +1230,17 @@ class AcquisitionsApi(object):
1175
1230
  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.
1176
1231
  This method makes a synchronous HTTP request by default.
1177
1232
 
1178
- :param str cid: (required)
1179
- :param str filename: (required)
1180
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1181
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1182
- :param bool async_: Perform the request asynchronously
1183
- :return: DeletedResult
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
1184
1244
  """
1185
1245
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1186
1246
  kwargs['_return_http_data_only'] = True
@@ -1204,12 +1264,17 @@ class AcquisitionsApi(object):
1204
1264
  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.
1205
1265
  This method makes a synchronous HTTP request by default.
1206
1266
 
1207
- :param str cid: (required)
1208
- :param str filename: (required)
1209
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1210
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1211
- :param bool async_: Perform the request asynchronously
1212
- :return: DeletedResult
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
1213
1278
  """
1214
1279
 
1215
1280
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -1288,10 +1353,13 @@ class AcquisitionsApi(object):
1288
1353
  Remove a note from a(n) acquisition
1289
1354
  This method makes a synchronous HTTP request by default.
1290
1355
 
1291
- :param str cid: (required)
1292
- :param str note_id: (required)
1293
- :param bool async_: Perform the request asynchronously
1294
- :return: DeletedResult
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
1295
1363
  """
1296
1364
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1297
1365
  kwargs['_return_http_data_only'] = True
@@ -1315,10 +1383,13 @@ class AcquisitionsApi(object):
1315
1383
  Remove a note from a(n) acquisition
1316
1384
  This method makes a synchronous HTTP request by default.
1317
1385
 
1318
- :param str cid: (required)
1319
- :param str note_id: (required)
1320
- :param bool async_: Perform the request asynchronously
1321
- :return: DeletedResult
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
1322
1393
  """
1323
1394
 
1324
1395
  all_params = ['cid','note_id',] # noqa: E501
@@ -1393,10 +1464,13 @@ class AcquisitionsApi(object):
1393
1464
  Delete a tag
1394
1465
  This method makes a synchronous HTTP request by default.
1395
1466
 
1396
- :param str cid: (required)
1397
- :param str value: The tag to interact with (required)
1398
- :param bool async_: Perform the request asynchronously
1399
- :return: DeletedResult
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
1400
1474
  """
1401
1475
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1402
1476
  kwargs['_return_http_data_only'] = True
@@ -1420,10 +1494,13 @@ class AcquisitionsApi(object):
1420
1494
  Delete a tag
1421
1495
  This method makes a synchronous HTTP request by default.
1422
1496
 
1423
- :param str cid: (required)
1424
- :param str value: The tag to interact with (required)
1425
- :param bool async_: Perform the request asynchronously
1426
- :return: DeletedResult
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
1427
1504
  """
1428
1505
 
1429
1506
  all_params = ['cid','value',] # noqa: E501
@@ -1498,10 +1575,13 @@ class AcquisitionsApi(object):
1498
1575
  Delete multiple tags from a(n) acquisition
1499
1576
  This method makes a synchronous HTTP request by default.
1500
1577
 
1501
- :param str cid: (required)
1502
- :param list[str] body: (required)
1503
- :param bool async_: Perform the request asynchronously
1504
- :return: None
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
1505
1585
  """
1506
1586
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1507
1587
  kwargs['_return_http_data_only'] = True
@@ -1525,10 +1605,13 @@ class AcquisitionsApi(object):
1525
1605
  Delete multiple tags from a(n) acquisition
1526
1606
  This method makes a synchronous HTTP request by default.
1527
1607
 
1528
- :param str cid: (required)
1529
- :param list[str] body: (required)
1530
- :param bool async_: Perform the request asynchronously
1531
- :return: None
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
1532
1615
  """
1533
1616
 
1534
1617
  all_params = ['cid','body',] # noqa: E501
@@ -1607,10 +1690,13 @@ class AcquisitionsApi(object):
1607
1690
  Delete multiple acquisitions by ID list
1608
1691
  This method makes a synchronous HTTP request by default.
1609
1692
 
1610
- :param list[str] body: List of IDs to delete (required)
1611
- :param ContainerDeleteReason delete_reason:
1612
- :param bool async_: Perform the request asynchronously
1613
- :return: DeletedResult
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
1614
1700
  """
1615
1701
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1616
1702
  kwargs['_return_http_data_only'] = True
@@ -1634,10 +1720,13 @@ class AcquisitionsApi(object):
1634
1720
  Delete multiple acquisitions by ID list
1635
1721
  This method makes a synchronous HTTP request by default.
1636
1722
 
1637
- :param list[str] body: List of IDs to delete (required)
1638
- :param ContainerDeleteReason delete_reason:
1639
- :param bool async_: Perform the request asynchronously
1640
- :return: DeletedResult
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
1641
1730
  """
1642
1731
 
1643
1732
  all_params = ['body','delete_reason',] # noqa: E501
@@ -1712,18 +1801,29 @@ class AcquisitionsApi(object):
1712
1801
  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.
1713
1802
  This method makes a synchronous HTTP request by default.
1714
1803
 
1715
- :param str acquisition_id: 24-character hex ID (required)
1716
- :param str file_name: output file name (required)
1717
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1718
- :param str member: The filename of a zipfile member to download rather than the entire file
1719
- :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\"
1720
- :param int version: version of the file to download
1721
- :param str hash: file hash for comparison
1722
- :param str range: byte ranges to return
1723
- :param list[str] x_accept_feature: redirect header
1724
- :param str dest_file: Destination file path
1725
- :param bool async_: Perform the request asynchronously
1726
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
1727
1827
  """
1728
1828
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1729
1829
  kwargs['_return_http_data_only'] = True
@@ -1746,17 +1846,27 @@ class AcquisitionsApi(object):
1746
1846
  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.
1747
1847
  This method makes a synchronous HTTP request by default.
1748
1848
 
1749
- :param str acquisition_id: 24-character hex ID (required)
1750
- :param str file_name: output file name (required)
1751
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1752
- :param str member: The filename of a zipfile member to download rather than the entire file
1753
- :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\"
1754
- :param int version: version of the file to download
1755
- :param str hash: file hash for comparison
1756
- :param str range: byte ranges to return
1757
- :param list[str] x_accept_feature: redirect header
1758
- :param bool async_: Perform the request asynchronously
1759
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
1760
1870
  """
1761
1871
 
1762
1872
  all_params = ['acquisition_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1846,18 +1956,29 @@ class AcquisitionsApi(object):
1846
1956
  Does not work on files whose names contain a forward slash.
1847
1957
  This method makes a synchronous HTTP request by default.
1848
1958
 
1849
- :param str acquisition_id: 24-character hex ID (required)
1850
- :param str file_name: output file name (required)
1851
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1852
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1853
- :param str member: The filename of a zipfile member to download rather than the entire file
1854
- :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\"
1855
- :param int version: version of the file to download
1856
- :param str hash: file hash for comparison
1857
- :param str range: byte ranges to return
1858
- :param list[str] x_accept_feature: redirect header
1859
- :param bool async_: Perform the request asynchronously
1860
- :return: FileZipInfo
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
1861
1982
  """
1862
1983
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1863
1984
  kwargs['_return_http_data_only'] = True
@@ -1881,18 +2002,29 @@ class AcquisitionsApi(object):
1881
2002
  Does not work on files whose names contain a forward slash.
1882
2003
  This method makes a synchronous HTTP request by default.
1883
2004
 
1884
- :param str acquisition_id: 24-character hex ID (required)
1885
- :param str file_name: output file name (required)
1886
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1887
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1888
- :param str member: The filename of a zipfile member to download rather than the entire file
1889
- :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\"
1890
- :param int version: version of the file to download
1891
- :param str hash: file hash for comparison
1892
- :param str range: byte ranges to return
1893
- :param list[str] x_accept_feature: redirect header
1894
- :param bool async_: Perform the request asynchronously
1895
- :return: FileZipInfo
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
1896
2028
  """
1897
2029
 
1898
2030
  all_params = ['acquisition_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1985,18 +2117,29 @@ class AcquisitionsApi(object):
1985
2117
 
1986
2118
  This method makes a synchronous HTTP request by default.
1987
2119
 
1988
- :param str acquisition_id: 24-character hex ID (required)
1989
- :param str file_name: output file name (required)
1990
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1991
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1992
- :param str member: The filename of a zipfile member to download rather than the entire file
1993
- :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\"
1994
- :param int version: version of the file to download
1995
- :param str hash: file hash for comparison
1996
- :param str range: byte ranges to return
1997
- :param list[str] x_accept_feature: redirect header
1998
- :param bool async_: Perform the request asynchronously
1999
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2000
2143
  """
2001
2144
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2002
2145
  kwargs['_return_http_data_only'] = True
@@ -2019,18 +2162,29 @@ class AcquisitionsApi(object):
2019
2162
 
2020
2163
  This method makes a synchronous HTTP request by default.
2021
2164
 
2022
- :param str acquisition_id: 24-character hex ID (required)
2023
- :param str file_name: output file name (required)
2024
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2025
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2026
- :param str member: The filename of a zipfile member to download rather than the entire file
2027
- :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\"
2028
- :param int version: version of the file to download
2029
- :param str hash: file hash for comparison
2030
- :param str range: byte ranges to return
2031
- :param list[str] x_accept_feature: redirect header
2032
- :param bool async_: Perform the request asynchronously
2033
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2034
2188
  """
2035
2189
 
2036
2190
  all_params = ['acquisition_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2122,17 +2276,27 @@ class AcquisitionsApi(object):
2122
2276
  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.
2123
2277
  This method makes a synchronous HTTP request by default.
2124
2278
 
2125
- :param str acquisition_id: 24-character hex ID (required)
2126
- :param str analysis_id: 24-char hex analysis id (required)
2127
- :param str filename: filename to download (get tar of all if empty) (required)
2128
- :param bool info: get file info only
2129
- :param str member: get zipfile member
2130
- :param bool view: feature flag for view/download
2131
- :param str range: byte ranges to return
2132
- :param list[str] x_accept_feature: redirect header
2133
- :param str dest_file: Destination file path
2134
- :param bool async_: Perform the request asynchronously
2135
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2136
2300
  """
2137
2301
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2138
2302
  kwargs['_return_http_data_only'] = True
@@ -2155,16 +2319,25 @@ class AcquisitionsApi(object):
2155
2319
  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.
2156
2320
  This method makes a synchronous HTTP request by default.
2157
2321
 
2158
- :param str acquisition_id: 24-character hex ID (required)
2159
- :param str analysis_id: 24-char hex analysis id (required)
2160
- :param str filename: filename to download (get tar of all if empty) (required)
2161
- :param bool info: get file info only
2162
- :param str member: get zipfile member
2163
- :param bool view: feature flag for view/download
2164
- :param str range: byte ranges to return
2165
- :param list[str] x_accept_feature: redirect header
2166
- :param bool async_: Perform the request asynchronously
2167
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2168
2341
  """
2169
2342
 
2170
2343
  all_params = ['acquisition_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2256,17 +2429,27 @@ class AcquisitionsApi(object):
2256
2429
  Does not work on files whose names contain a forward slash.
2257
2430
  This method makes a synchronous HTTP request by default.
2258
2431
 
2259
- :param str acquisition_id: 24-character hex ID (required)
2260
- :param str analysis_id: 24-char hex analysis id (required)
2261
- :param str filename: filename to download (get tar of all if empty) (required)
2262
- :param str ticket: 24-char hex ticket id
2263
- :param bool info: get file info only
2264
- :param str member: get zipfile member
2265
- :param bool view: feature flag for view/download
2266
- :param str range: byte ranges to return
2267
- :param list[str] x_accept_feature: redirect header
2268
- :param bool async_: Perform the request asynchronously
2269
- :return: FileZipInfo
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
2270
2453
  """
2271
2454
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2272
2455
  kwargs['_return_http_data_only'] = True
@@ -2290,17 +2473,27 @@ class AcquisitionsApi(object):
2290
2473
  Does not work on files whose names contain a forward slash.
2291
2474
  This method makes a synchronous HTTP request by default.
2292
2475
 
2293
- :param str acquisition_id: 24-character hex ID (required)
2294
- :param str analysis_id: 24-char hex analysis id (required)
2295
- :param str filename: filename to download (get tar of all if empty) (required)
2296
- :param str ticket: 24-char hex ticket id
2297
- :param bool info: get file info only
2298
- :param str member: get zipfile member
2299
- :param bool view: feature flag for view/download
2300
- :param str range: byte ranges to return
2301
- :param list[str] x_accept_feature: redirect header
2302
- :param bool async_: Perform the request asynchronously
2303
- :return: FileZipInfo
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
2304
2497
  """
2305
2498
 
2306
2499
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2395,17 +2588,27 @@ class AcquisitionsApi(object):
2395
2588
 
2396
2589
  This method makes a synchronous HTTP request by default.
2397
2590
 
2398
- :param str acquisition_id: 24-character hex ID (required)
2399
- :param str analysis_id: 24-char hex analysis id (required)
2400
- :param str filename: filename to download (get tar of all if empty) (required)
2401
- :param str ticket: 24-char hex ticket id
2402
- :param bool info: get file info only
2403
- :param str member: get zipfile member
2404
- :param bool view: feature flag for view/download
2405
- :param str range: byte ranges to return
2406
- :param list[str] x_accept_feature: redirect header
2407
- :param bool async_: Perform the request asynchronously
2408
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2409
2612
  """
2410
2613
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2411
2614
  kwargs['_return_http_data_only'] = True
@@ -2428,17 +2631,27 @@ class AcquisitionsApi(object):
2428
2631
 
2429
2632
  This method makes a synchronous HTTP request by default.
2430
2633
 
2431
- :param str acquisition_id: 24-character hex ID (required)
2432
- :param str analysis_id: 24-char hex analysis id (required)
2433
- :param str filename: filename to download (get tar of all if empty) (required)
2434
- :param str ticket: 24-char hex ticket id
2435
- :param bool info: get file info only
2436
- :param str member: get zipfile member
2437
- :param bool view: feature flag for view/download
2438
- :param str range: byte ranges to return
2439
- :param list[str] x_accept_feature: redirect header
2440
- :param bool async_: Perform the request asynchronously
2441
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2442
2655
  """
2443
2656
 
2444
2657
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2532,17 +2745,27 @@ class AcquisitionsApi(object):
2532
2745
  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.
2533
2746
  This method makes a synchronous HTTP request by default.
2534
2747
 
2535
- :param str acquisition_id: 24-character hex ID (required)
2536
- :param str analysis_id: 24-char hex analysis id (required)
2537
- :param str filename: filename to download (get tar of all if empty) (required)
2538
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2539
- :param str member: The filename of a zipfile member to download rather than the entire file
2540
- :param bool view: feature flag for view/download
2541
- :param str range: byte ranges to return
2542
- :param list[str] x_accept_feature: redirect header
2543
- :param str dest_file: Destination file path
2544
- :param bool async_: Perform the request asynchronously
2545
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2546
2769
  """
2547
2770
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2548
2771
  kwargs['_return_http_data_only'] = True
@@ -2565,16 +2788,25 @@ class AcquisitionsApi(object):
2565
2788
  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.
2566
2789
  This method makes a synchronous HTTP request by default.
2567
2790
 
2568
- :param str acquisition_id: 24-character hex ID (required)
2569
- :param str analysis_id: 24-char hex analysis id (required)
2570
- :param str filename: filename to download (get tar of all if empty) (required)
2571
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2572
- :param str member: The filename of a zipfile member to download rather than the entire file
2573
- :param bool view: feature flag for view/download
2574
- :param str range: byte ranges to return
2575
- :param list[str] x_accept_feature: redirect header
2576
- :param bool async_: Perform the request asynchronously
2577
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2578
2810
  """
2579
2811
 
2580
2812
  all_params = ['acquisition_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2666,17 +2898,27 @@ class AcquisitionsApi(object):
2666
2898
  Does not work on files whose names contain a forward slash.
2667
2899
  This method makes a synchronous HTTP request by default.
2668
2900
 
2669
- :param str acquisition_id: 24-character hex ID (required)
2670
- :param str analysis_id: 24-char hex analysis id (required)
2671
- :param str filename: filename to download (get tar of all if empty) (required)
2672
- :param str ticket: ticket id of the outputs to download
2673
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2674
- :param str member: The filename of a zipfile member to download rather than the entire file
2675
- :param bool view: feature flag for view/download
2676
- :param str range: byte ranges to return
2677
- :param list[str] x_accept_feature: redirect header
2678
- :param bool async_: Perform the request asynchronously
2679
- :return: FileZipInfo
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
2680
2922
  """
2681
2923
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2682
2924
  kwargs['_return_http_data_only'] = True
@@ -2700,17 +2942,27 @@ class AcquisitionsApi(object):
2700
2942
  Does not work on files whose names contain a forward slash.
2701
2943
  This method makes a synchronous HTTP request by default.
2702
2944
 
2703
- :param str acquisition_id: 24-character hex ID (required)
2704
- :param str analysis_id: 24-char hex analysis id (required)
2705
- :param str filename: filename to download (get tar of all if empty) (required)
2706
- :param str ticket: ticket id of the outputs to download
2707
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2708
- :param str member: The filename of a zipfile member to download rather than the entire file
2709
- :param bool view: feature flag for view/download
2710
- :param str range: byte ranges to return
2711
- :param list[str] x_accept_feature: redirect header
2712
- :param bool async_: Perform the request asynchronously
2713
- :return: FileZipInfo
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
2714
2966
  """
2715
2967
 
2716
2968
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2805,17 +3057,27 @@ class AcquisitionsApi(object):
2805
3057
 
2806
3058
  This method makes a synchronous HTTP request by default.
2807
3059
 
2808
- :param str acquisition_id: 24-character hex ID (required)
2809
- :param str analysis_id: 24-char hex analysis id (required)
2810
- :param str filename: filename to download (get tar of all if empty) (required)
2811
- :param str ticket: ticket id of the outputs to download
2812
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2813
- :param str member: The filename of a zipfile member to download rather than the entire file
2814
- :param bool view: feature flag for view/download
2815
- :param str range: byte ranges to return
2816
- :param list[str] x_accept_feature: redirect header
2817
- :param bool async_: Perform the request asynchronously
2818
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2819
3081
  """
2820
3082
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2821
3083
  kwargs['_return_http_data_only'] = True
@@ -2838,17 +3100,27 @@ class AcquisitionsApi(object):
2838
3100
 
2839
3101
  This method makes a synchronous HTTP request by default.
2840
3102
 
2841
- :param str acquisition_id: 24-character hex ID (required)
2842
- :param str analysis_id: 24-char hex analysis id (required)
2843
- :param str filename: filename to download (get tar of all if empty) (required)
2844
- :param str ticket: ticket id of the outputs to download
2845
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2846
- :param str member: The filename of a zipfile member to download rather than the entire file
2847
- :param bool view: feature flag for view/download
2848
- :param str range: byte ranges to return
2849
- :param list[str] x_accept_feature: redirect header
2850
- :param bool async_: Perform the request asynchronously
2851
- :return: union[DownloadTicketStub,ZipfileInfo]
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]
2852
3124
  """
2853
3125
 
2854
3126
  all_params = ['acquisition_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2942,12 +3214,17 @@ class AcquisitionsApi(object):
2942
3214
  Get a single acquisition
2943
3215
  This method makes a synchronous HTTP request by default.
2944
3216
 
2945
- :param str acquisition_id: (required)
2946
- :param JoinType join:
2947
- :param bool join_avatars: add name and avatar to notes
2948
- :param list[union[HeaderFeature,str]] x_accept_feature:
2949
- :param bool async_: Perform the request asynchronously
2950
- :return: AcquisitionOutput
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
2951
3228
  """
2952
3229
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2953
3230
  kwargs['_return_http_data_only'] = True
@@ -2971,12 +3248,17 @@ class AcquisitionsApi(object):
2971
3248
  Get a single acquisition
2972
3249
  This method makes a synchronous HTTP request by default.
2973
3250
 
2974
- :param str acquisition_id: (required)
2975
- :param JoinType join:
2976
- :param bool join_avatars: add name and avatar to notes
2977
- :param list[union[HeaderFeature,str]] x_accept_feature:
2978
- :param bool async_: Perform the request asynchronously
2979
- :return: AcquisitionOutput
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
2980
3262
  """
2981
3263
 
2982
3264
  all_params = ['acquisition_id','join','join_avatars','x_accept_feature',] # noqa: E501
@@ -3052,20 +3334,33 @@ class AcquisitionsApi(object):
3052
3334
  Returns analyses that directly belong to this resource.
3053
3335
  This method makes a synchronous HTTP request by default.
3054
3336
 
3055
- :param str cid: (required)
3056
- :param bool inflate_job:
3057
- :param bool join_avatars:
3058
- :param JoinType join:
3059
- :param bool include_all_info: Include all info in returned objects
3060
- :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)
3061
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3062
- :param int limit: The maximum number of entries to return.
3063
- :param int skip: The number of entries to skip.
3064
- :param int page: The page number (i.e. skip limit*page entries)
3065
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3066
- :param list[str] x_accept_feature:
3067
- :param bool async_: Perform the request asynchronously
3068
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
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]]]
3069
3364
  """
3070
3365
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3071
3366
  kwargs['_return_http_data_only'] = True
@@ -3089,20 +3384,33 @@ class AcquisitionsApi(object):
3089
3384
  Returns analyses that directly belong to this resource.
3090
3385
  This method makes a synchronous HTTP request by default.
3091
3386
 
3092
- :param str cid: (required)
3093
- :param bool inflate_job:
3094
- :param bool join_avatars:
3095
- :param JoinType join:
3096
- :param bool include_all_info: Include all info in returned objects
3097
- :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)
3098
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3099
- :param int limit: The maximum number of entries to return.
3100
- :param int skip: The number of entries to skip.
3101
- :param int page: The page number (i.e. skip limit*page entries)
3102
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3103
- :param list[str] x_accept_feature:
3104
- :param bool async_: Perform the request asynchronously
3105
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
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]]]
3106
3414
  """
3107
3415
 
3108
3416
  all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3194,13 +3502,19 @@ class AcquisitionsApi(object):
3194
3502
  Get an analysis.
3195
3503
  This method makes a synchronous HTTP request by default.
3196
3504
 
3197
- :param str cid: (required)
3198
- :param str analysis_id: (required)
3199
- :param bool inflate_job: Return job as an object instead of an id
3200
- :param bool join_avatars:
3201
- :param JoinType join:
3202
- :param bool async_: Perform the request asynchronously
3203
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
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]
3204
3518
  """
3205
3519
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3206
3520
  kwargs['_return_http_data_only'] = True
@@ -3224,13 +3538,19 @@ class AcquisitionsApi(object):
3224
3538
  Get an analysis.
3225
3539
  This method makes a synchronous HTTP request by default.
3226
3540
 
3227
- :param str cid: (required)
3228
- :param str analysis_id: (required)
3229
- :param bool inflate_job: Return job as an object instead of an id
3230
- :param bool join_avatars:
3231
- :param JoinType join:
3232
- :param bool async_: Perform the request asynchronously
3233
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
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]
3234
3554
  """
3235
3555
 
3236
3556
  all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
@@ -3311,10 +3631,13 @@ class AcquisitionsApi(object):
3311
3631
  Get info for a particular file.
3312
3632
  This method makes a synchronous HTTP request by default.
3313
3633
 
3314
- :param str cid: Container Id (required)
3315
- :param str filename: (required)
3316
- :param bool async_: Perform the request asynchronously
3317
- :return: FileOutput
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
3318
3641
  """
3319
3642
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3320
3643
  kwargs['_return_http_data_only'] = True
@@ -3338,10 +3661,13 @@ class AcquisitionsApi(object):
3338
3661
  Get info for a particular file.
3339
3662
  This method makes a synchronous HTTP request by default.
3340
3663
 
3341
- :param str cid: Container Id (required)
3342
- :param str filename: (required)
3343
- :param bool async_: Perform the request asynchronously
3344
- :return: FileOutput
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
3345
3671
  """
3346
3672
 
3347
3673
  all_params = ['cid','filename',] # noqa: E501
@@ -3416,10 +3742,13 @@ class AcquisitionsApi(object):
3416
3742
  Get a note of a(n) acquisition
3417
3743
  This method makes a synchronous HTTP request by default.
3418
3744
 
3419
- :param str cid: (required)
3420
- :param str note_id: (required)
3421
- :param bool async_: Perform the request asynchronously
3422
- :return: Note
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
3423
3752
  """
3424
3753
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3425
3754
  kwargs['_return_http_data_only'] = True
@@ -3443,10 +3772,13 @@ class AcquisitionsApi(object):
3443
3772
  Get a note of a(n) acquisition
3444
3773
  This method makes a synchronous HTTP request by default.
3445
3774
 
3446
- :param str cid: (required)
3447
- :param str note_id: (required)
3448
- :param bool async_: Perform the request asynchronously
3449
- :return: Note
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
3450
3782
  """
3451
3783
 
3452
3784
  all_params = ['cid','note_id',] # noqa: E501
@@ -3521,10 +3853,13 @@ class AcquisitionsApi(object):
3521
3853
  Get the value of a tag, by name
3522
3854
  This method makes a synchronous HTTP request by default.
3523
3855
 
3524
- :param str cid: (required)
3525
- :param str value: The tag to interact with (required)
3526
- :param bool async_: Perform the request asynchronously
3527
- :return: str
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
3528
3863
  """
3529
3864
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3530
3865
  kwargs['_return_http_data_only'] = True
@@ -3548,10 +3883,13 @@ class AcquisitionsApi(object):
3548
3883
  Get the value of a tag, by name
3549
3884
  This method makes a synchronous HTTP request by default.
3550
3885
 
3551
- :param str cid: (required)
3552
- :param str value: The tag to interact with (required)
3553
- :param bool async_: Perform the request asynchronously
3554
- :return: str
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
3555
3893
  """
3556
3894
 
3557
3895
  all_params = ['cid','value',] # noqa: E501
@@ -3626,20 +3964,33 @@ class AcquisitionsApi(object):
3626
3964
  Get a list of acquisitions.
3627
3965
  This method makes a synchronous HTTP request by default.
3628
3966
 
3629
- :param bool exhaustive: Set to return a complete list regardless of permissions
3630
- :param JoinType join:
3631
- :param bool join_avatars: add name and avatar to notes
3632
- :param str collection_id:
3633
- :param bool include_all_info: Include all info in returned objects
3634
- :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)
3635
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3636
- :param int limit: The maximum number of entries to return.
3637
- :param int skip: The number of entries to skip.
3638
- :param int page: The page number (i.e. skip limit*page entries)
3639
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3640
- :param list[union[HeaderFeature,str]] x_accept_feature:
3641
- :param bool async_: Perform the request asynchronously
3642
- :return: union[list[AcquisitionListOutput],Page]
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]
3643
3994
  """
3644
3995
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3645
3996
  kwargs['_return_http_data_only'] = True
@@ -3663,20 +4014,33 @@ class AcquisitionsApi(object):
3663
4014
  Get a list of acquisitions.
3664
4015
  This method makes a synchronous HTTP request by default.
3665
4016
 
3666
- :param bool exhaustive: Set to return a complete list regardless of permissions
3667
- :param JoinType join:
3668
- :param bool join_avatars: add name and avatar to notes
3669
- :param str collection_id:
3670
- :param bool include_all_info: Include all info in returned objects
3671
- :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)
3672
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3673
- :param int limit: The maximum number of entries to return.
3674
- :param int skip: The number of entries to skip.
3675
- :param int page: The page number (i.e. skip limit*page entries)
3676
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3677
- :param list[union[HeaderFeature,str]] x_accept_feature:
3678
- :param bool async_: Perform the request asynchronously
3679
- :return: union[list[AcquisitionListOutput],Page]
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]
3680
4044
  """
3681
4045
 
3682
4046
  all_params = ['exhaustive','join','join_avatars','collection_id','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3764,10 +4128,13 @@ class AcquisitionsApi(object):
3764
4128
  Update an acquisition
3765
4129
  This method makes a synchronous HTTP request by default.
3766
4130
 
3767
- :param str acquisition_id: (required)
3768
- :param AcquisitionModifyInput body: (required)
3769
- :param bool async_: Perform the request asynchronously
3770
- :return: ModifiedResult
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
3771
4138
  """
3772
4139
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3773
4140
  kwargs['_return_http_data_only'] = True
@@ -3791,10 +4158,13 @@ class AcquisitionsApi(object):
3791
4158
  Update an acquisition
3792
4159
  This method makes a synchronous HTTP request by default.
3793
4160
 
3794
- :param str acquisition_id: (required)
3795
- :param AcquisitionModifyInput body: (required)
3796
- :param bool async_: Perform the request asynchronously
3797
- :return: ModifiedResult
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
3798
4168
  """
3799
4169
 
3800
4170
  all_params = ['acquisition_id','body',] # noqa: E501
@@ -3880,11 +4250,15 @@ class AcquisitionsApi(object):
3880
4250
  Modify an analysis.
3881
4251
  This method makes a synchronous HTTP request by default.
3882
4252
 
3883
- :param str cid: (required)
3884
- :param str analysis_id: (required)
3885
- :param AnalysisModifyInput body: (required)
3886
- :param bool async_: Perform the request asynchronously
3887
- :return: ModifiedResult
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
3888
4262
  """
3889
4263
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3890
4264
  kwargs['_return_http_data_only'] = True
@@ -3908,11 +4282,15 @@ class AcquisitionsApi(object):
3908
4282
  Modify an analysis.
3909
4283
  This method makes a synchronous HTTP request by default.
3910
4284
 
3911
- :param str cid: (required)
3912
- :param str analysis_id: (required)
3913
- :param AnalysisModifyInput body: (required)
3914
- :param bool async_: Perform the request asynchronously
3915
- :return: ModifiedResult
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
3916
4294
  """
3917
4295
 
3918
4296
  all_params = ['cid','analysis_id','body',] # noqa: E501
@@ -4004,11 +4382,15 @@ class AcquisitionsApi(object):
4004
4382
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
4005
4383
  This method makes a synchronous HTTP request by default.
4006
4384
 
4007
- :param str cid: (required)
4008
- :param str filename: (required)
4009
- :param FileModifyInput body: (required)
4010
- :param bool async_: Perform the request asynchronously
4011
- :return: ModifiedResult
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
4012
4394
  """
4013
4395
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4014
4396
  kwargs['_return_http_data_only'] = True
@@ -4032,11 +4414,15 @@ class AcquisitionsApi(object):
4032
4414
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
4033
4415
  This method makes a synchronous HTTP request by default.
4034
4416
 
4035
- :param str cid: (required)
4036
- :param str filename: (required)
4037
- :param FileModifyInput body: (required)
4038
- :param bool async_: Perform the request asynchronously
4039
- :return: ModifiedResult
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
4040
4426
  """
4041
4427
 
4042
4428
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4128,11 +4514,15 @@ class AcquisitionsApi(object):
4128
4514
  If replacing a file's classification, the modality can optionally be modified as well.
4129
4515
  This method makes a synchronous HTTP request by default.
4130
4516
 
4131
- :param str cid: (required)
4132
- :param str filename: (required)
4133
- :param FileClassificationDelta body: (required)
4134
- :param bool async_: Perform the request asynchronously
4135
- :return: ModifiedResult
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
4136
4526
  """
4137
4527
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4138
4528
  kwargs['_return_http_data_only'] = True
@@ -4156,11 +4546,15 @@ class AcquisitionsApi(object):
4156
4546
  If replacing a file's classification, the modality can optionally be modified as well.
4157
4547
  This method makes a synchronous HTTP request by default.
4158
4548
 
4159
- :param str cid: (required)
4160
- :param str filename: (required)
4161
- :param FileClassificationDelta body: (required)
4162
- :param bool async_: Perform the request asynchronously
4163
- :return: ModifiedResult
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
4164
4558
  """
4165
4559
 
4166
4560
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4252,11 +4646,15 @@ class AcquisitionsApi(object):
4252
4646
  Modify and return the file 'info' field
4253
4647
  This method makes a synchronous HTTP request by default.
4254
4648
 
4255
- :param str cid: (required)
4256
- :param str filename: (required)
4257
- :param Info body: (required)
4258
- :param bool async_: Perform the request asynchronously
4259
- :return: ModifiedResult
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
4260
4658
  """
4261
4659
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4262
4660
  kwargs['_return_http_data_only'] = True
@@ -4280,11 +4678,15 @@ class AcquisitionsApi(object):
4280
4678
  Modify and return the file 'info' field
4281
4679
  This method makes a synchronous HTTP request by default.
4282
4680
 
4283
- :param str cid: (required)
4284
- :param str filename: (required)
4285
- :param Info body: (required)
4286
- :param bool async_: Perform the request asynchronously
4287
- :return: ModifiedResult
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
4288
4690
  """
4289
4691
 
4290
4692
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4376,10 +4778,13 @@ class AcquisitionsApi(object):
4376
4778
  Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4377
4779
  This method makes a synchronous HTTP request by default.
4378
4780
 
4379
- :param str cid: (required)
4380
- :param Info body: (required)
4381
- :param bool async_: Perform the request asynchronously
4382
- :return: ModifiedResult
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
4383
4788
  """
4384
4789
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4385
4790
  kwargs['_return_http_data_only'] = True
@@ -4403,10 +4808,13 @@ class AcquisitionsApi(object):
4403
4808
  Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4404
4809
  This method makes a synchronous HTTP request by default.
4405
4810
 
4406
- :param str cid: (required)
4407
- :param Info body: (required)
4408
- :param bool async_: Perform the request asynchronously
4409
- :return: ModifiedResult
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
4410
4818
  """
4411
4819
 
4412
4820
  all_params = ['cid','body',] # noqa: E501
@@ -4492,11 +4900,15 @@ class AcquisitionsApi(object):
4492
4900
  Update a note of a(n) acquisition
4493
4901
  This method makes a synchronous HTTP request by default.
4494
4902
 
4495
- :param str cid: (required)
4496
- :param str note_id: (required)
4497
- :param NoteInput body: (required)
4498
- :param bool async_: Perform the request asynchronously
4499
- :return: int
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
4500
4912
  """
4501
4913
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4502
4914
  kwargs['_return_http_data_only'] = True
@@ -4520,11 +4932,15 @@ class AcquisitionsApi(object):
4520
4932
  Update a note of a(n) acquisition
4521
4933
  This method makes a synchronous HTTP request by default.
4522
4934
 
4523
- :param str cid: (required)
4524
- :param str note_id: (required)
4525
- :param NoteInput body: (required)
4526
- :param bool async_: Perform the request asynchronously
4527
- :return: int
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
4528
4944
  """
4529
4945
 
4530
4946
  all_params = ['cid','note_id','body',] # noqa: E501
@@ -4616,11 +5032,15 @@ class AcquisitionsApi(object):
4616
5032
  Rename a tag
4617
5033
  This method makes a synchronous HTTP request by default.
4618
5034
 
4619
- :param str cid: (required)
4620
- :param str value: The tag to interact with (required)
4621
- :param Tag body: (required)
4622
- :param bool async_: Perform the request asynchronously
4623
- :return: str
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
4624
5044
  """
4625
5045
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4626
5046
  kwargs['_return_http_data_only'] = True
@@ -4644,11 +5064,15 @@ class AcquisitionsApi(object):
4644
5064
  Rename a tag
4645
5065
  This method makes a synchronous HTTP request by default.
4646
5066
 
4647
- :param str cid: (required)
4648
- :param str value: The tag to interact with (required)
4649
- :param Tag body: (required)
4650
- :param bool async_: Perform the request asynchronously
4651
- :return: str
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
4652
5076
  """
4653
5077
 
4654
5078
  all_params = ['cid','value','body',] # noqa: E501
@@ -4740,18 +5164,29 @@ class AcquisitionsApi(object):
4740
5164
  Upload a file to a(n) acquisition.
4741
5165
  This method makes a synchronous HTTP request by default.
4742
5166
 
4743
- :param str container_id: (required)
4744
- :param str file: The file to upload (required)
4745
- :param bool preserve_metadata:
4746
- :param str ticket:
4747
- :param str id:
4748
- :param ContainerType level:
4749
- :param str job:
4750
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4751
- :param list[str] x_accept_feature: redirect header
4752
- :param str content_type:
4753
- :param bool async_: Perform the request asynchronously
4754
- :return: union[list[FileOutput],UploadTicketOutput]
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]
4755
5190
  """
4756
5191
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4757
5192
  kwargs['_return_http_data_only'] = True
@@ -4775,18 +5210,29 @@ class AcquisitionsApi(object):
4775
5210
  Upload a file to a(n) acquisition.
4776
5211
  This method makes a synchronous HTTP request by default.
4777
5212
 
4778
- :param str container_id: (required)
4779
- :param str file: The file to upload (required)
4780
- :param bool preserve_metadata:
4781
- :param str ticket:
4782
- :param str id:
4783
- :param ContainerType level:
4784
- :param str job:
4785
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4786
- :param list[str] x_accept_feature: redirect header
4787
- :param str content_type:
4788
- :param bool async_: Perform the request asynchronously
4789
- :return: union[list[FileOutput],UploadTicketOutput]
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]
4790
5236
  """
4791
5237
 
4792
5238
  all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
@@ -4882,16 +5328,25 @@ class AcquisitionsApi(object):
4882
5328
  Upload an output file to an analysis
4883
5329
  This method makes a synchronous HTTP request by default.
4884
5330
 
4885
- :param str cid: (required)
4886
- :param str analysis_id: (required)
4887
- :param str file: The file to upload (required)
4888
- :param str ticket:
4889
- :param str id:
4890
- :param ContainerType level:
4891
- :param str job:
4892
- :param str content_type:
4893
- :param bool async_: Perform the request asynchronously
4894
- :return: list[FileOutput]
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]
4895
5350
  """
4896
5351
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4897
5352
  kwargs['_return_http_data_only'] = True
@@ -4915,16 +5370,25 @@ class AcquisitionsApi(object):
4915
5370
  Upload an output file to an analysis
4916
5371
  This method makes a synchronous HTTP request by default.
4917
5372
 
4918
- :param str cid: (required)
4919
- :param str analysis_id: (required)
4920
- :param str file: The file to upload (required)
4921
- :param str ticket:
4922
- :param str id:
4923
- :param ContainerType level:
4924
- :param str job:
4925
- :param str content_type:
4926
- :param bool async_: Perform the request asynchronously
4927
- :return: list[FileOutput]
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]
4928
5392
  """
4929
5393
 
4930
5394
  all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501