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,12 +30,15 @@ class ContainersApi(object):
37
30
  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.
38
31
  This method makes a synchronous HTTP request by default.
39
32
 
40
- :param str cid: (required)
41
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
42
- :param bool job: returns job_id instead of analysis.id
43
- :param bool job: returns job_id instead of analysis.id
44
- :param bool async_: Perform the request asynchronously
45
- :return: InsertedId
33
+ :param cid:
34
+ :type cid: str
35
+ :param body:
36
+ :type body: union[AdhocAnalysisInput,JobAnalysisInput]
37
+ :param job: returns job_id instead of analysis.id, defaults to false
38
+ :type job: bool, optional
39
+ :param async_: Perform the request asynchronously
40
+ :type async_: bool, optional
41
+ :rtype: InsertedId
46
42
  """
47
43
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
48
44
  kwargs['_return_http_data_only'] = True
@@ -66,15 +62,18 @@ class ContainersApi(object):
66
62
  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.
67
63
  This method makes a synchronous HTTP request by default.
68
64
 
69
- :param str cid: (required)
70
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
71
- :param bool job: returns job_id instead of analysis.id
72
- :param bool job: returns job_id instead of analysis.id
73
- :param bool async_: Perform the request asynchronously
74
- :return: InsertedId
65
+ :param cid:
66
+ :type cid: str
67
+ :param body:
68
+ :type body: union[AdhocAnalysisInput,JobAnalysisInput]
69
+ :param job: returns job_id instead of analysis.id, defaults to false
70
+ :type job: bool, optional
71
+ :param async_: Perform the request asynchronously
72
+ :type async_: bool, optional
73
+ :rtype: InsertedId
75
74
  """
76
75
 
77
- all_params = ['cid','body','job','job',] # noqa: E501
76
+ all_params = ['cid','body','job',] # noqa: E501
78
77
  all_params.append('async_')
79
78
  all_params.append('_return_http_data_only')
80
79
  all_params.append('_preload_content')
@@ -107,8 +106,6 @@ class ContainersApi(object):
107
106
  path_params['cid'] = params['cid'] # noqa: E501
108
107
 
109
108
  query_params = []
110
- if 'job' in params:
111
- query_params.append(('job', params['job'])) # noqa: E501
112
109
  if 'job' in params:
113
110
  query_params.append(('job', params['job'])) # noqa: E501
114
111
  else:
@@ -163,11 +160,15 @@ class ContainersApi(object):
163
160
  Add a note to a(n) container analysis.
164
161
  This method makes a synchronous HTTP request by default.
165
162
 
166
- :param str container_id: 24-char hex id (required)
167
- :param str analysis_id: 24-char hex analysis id (required)
168
- :param NoteInput body: (required)
169
- :param bool async_: Perform the request asynchronously
170
- :return: Note
163
+ :param container_id: 24-char hex id
164
+ :type container_id: str
165
+ :param analysis_id: 24-char hex analysis id
166
+ :type analysis_id: str
167
+ :param body:
168
+ :type body: NoteInput
169
+ :param async_: Perform the request asynchronously
170
+ :type async_: bool, optional
171
+ :rtype: Note
171
172
  """
172
173
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
173
174
  kwargs['_return_http_data_only'] = True
@@ -191,11 +192,15 @@ class ContainersApi(object):
191
192
  Add a note to a(n) container analysis.
192
193
  This method makes a synchronous HTTP request by default.
193
194
 
194
- :param str container_id: 24-char hex id (required)
195
- :param str analysis_id: 24-char hex analysis id (required)
196
- :param NoteInput body: (required)
197
- :param bool async_: Perform the request asynchronously
198
- :return: Note
195
+ :param container_id: 24-char hex id
196
+ :type container_id: str
197
+ :param analysis_id: 24-char hex analysis id
198
+ :type analysis_id: str
199
+ :param body:
200
+ :type body: NoteInput
201
+ :param async_: Perform the request asynchronously
202
+ :type async_: bool, optional
203
+ :rtype: Note
199
204
  """
200
205
 
201
206
  all_params = ['container_id','analysis_id','body',] # noqa: E501
@@ -287,10 +292,13 @@ class ContainersApi(object):
287
292
  Add a note to a(n) container.
288
293
  This method makes a synchronous HTTP request by default.
289
294
 
290
- :param str container_id: (required)
291
- :param NoteInput body: (required)
292
- :param bool async_: Perform the request asynchronously
293
- :return: Note
295
+ :param container_id:
296
+ :type container_id: str
297
+ :param body:
298
+ :type body: NoteInput
299
+ :param async_: Perform the request asynchronously
300
+ :type async_: bool, optional
301
+ :rtype: Note
294
302
  """
295
303
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
296
304
  kwargs['_return_http_data_only'] = True
@@ -314,10 +322,13 @@ class ContainersApi(object):
314
322
  Add a note to a(n) container.
315
323
  This method makes a synchronous HTTP request by default.
316
324
 
317
- :param str container_id: (required)
318
- :param NoteInput body: (required)
319
- :param bool async_: Perform the request asynchronously
320
- :return: Note
325
+ :param container_id:
326
+ :type container_id: str
327
+ :param body:
328
+ :type body: NoteInput
329
+ :param async_: Perform the request asynchronously
330
+ :type async_: bool, optional
331
+ :rtype: Note
321
332
  """
322
333
 
323
334
  all_params = ['container_id','body',] # noqa: E501
@@ -403,10 +414,13 @@ class ContainersApi(object):
403
414
  Propagates changes to projects, sessions and acquisitions
404
415
  This method makes a synchronous HTTP request by default.
405
416
 
406
- :param str cid: (required)
407
- :param Tag body: (required)
408
- :param bool async_: Perform the request asynchronously
409
- :return: ModifiedResult
417
+ :param cid:
418
+ :type cid: str
419
+ :param body:
420
+ :type body: Tag
421
+ :param async_: Perform the request asynchronously
422
+ :type async_: bool, optional
423
+ :rtype: ModifiedResult
410
424
  """
411
425
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
412
426
  kwargs['_return_http_data_only'] = True
@@ -430,10 +444,13 @@ class ContainersApi(object):
430
444
  Propagates changes to projects, sessions and acquisitions
431
445
  This method makes a synchronous HTTP request by default.
432
446
 
433
- :param str cid: (required)
434
- :param Tag body: (required)
435
- :param bool async_: Perform the request asynchronously
436
- :return: ModifiedResult
447
+ :param cid:
448
+ :type cid: str
449
+ :param body:
450
+ :type body: Tag
451
+ :param async_: Perform the request asynchronously
452
+ :type async_: bool, optional
453
+ :rtype: ModifiedResult
437
454
  """
438
455
 
439
456
  all_params = ['cid','body',] # noqa: E501
@@ -519,10 +536,13 @@ class ContainersApi(object):
519
536
  Add multiple tags to a(n) container
520
537
  This method makes a synchronous HTTP request by default.
521
538
 
522
- :param str cid: (required)
523
- :param list[str] body: (required)
524
- :param bool async_: Perform the request asynchronously
525
- :return: None
539
+ :param cid:
540
+ :type cid: str
541
+ :param body:
542
+ :type body: list[str]
543
+ :param async_: Perform the request asynchronously
544
+ :type async_: bool, optional
545
+ :rtype: None
526
546
  """
527
547
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
528
548
  kwargs['_return_http_data_only'] = True
@@ -546,10 +566,13 @@ class ContainersApi(object):
546
566
  Add multiple tags to a(n) container
547
567
  This method makes a synchronous HTTP request by default.
548
568
 
549
- :param str cid: (required)
550
- :param list[str] body: (required)
551
- :param bool async_: Perform the request asynchronously
552
- :return: None
569
+ :param cid:
570
+ :type cid: str
571
+ :param body:
572
+ :type body: list[str]
573
+ :param async_: Perform the request asynchronously
574
+ :type async_: bool, optional
575
+ :rtype: None
553
576
  """
554
577
 
555
578
  all_params = ['cid','body',] # noqa: E501
@@ -628,10 +651,13 @@ class ContainersApi(object):
628
651
  Create container view
629
652
  This method makes a synchronous HTTP request by default.
630
653
 
631
- :param str container_id: (required)
632
- :param ContainerIdViewInput body: (required)
633
- :param bool async_: Perform the request asynchronously
634
- :return: ViewIdOutput
654
+ :param container_id:
655
+ :type container_id: str
656
+ :param body:
657
+ :type body: ContainerIdViewInput
658
+ :param async_: Perform the request asynchronously
659
+ :type async_: bool, optional
660
+ :rtype: ViewIdOutput
635
661
  """
636
662
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
637
663
  kwargs['_return_http_data_only'] = True
@@ -655,10 +681,13 @@ class ContainersApi(object):
655
681
  Create container view
656
682
  This method makes a synchronous HTTP request by default.
657
683
 
658
- :param str container_id: (required)
659
- :param ContainerIdViewInput body: (required)
660
- :param bool async_: Perform the request asynchronously
661
- :return: ViewIdOutput
684
+ :param container_id:
685
+ :type container_id: str
686
+ :param body:
687
+ :type body: ContainerIdViewInput
688
+ :param async_: Perform the request asynchronously
689
+ :type async_: bool, optional
690
+ :rtype: ViewIdOutput
662
691
  """
663
692
 
664
693
  all_params = ['container_id','body',] # noqa: E501
@@ -744,10 +773,13 @@ class ContainersApi(object):
744
773
  Delete Container
745
774
  This method makes a synchronous HTTP request by default.
746
775
 
747
- :param str container_id: (required)
748
- :param ContainerDeleteReason delete_reason:
749
- :param bool async_: Perform the request asynchronously
750
- :return: DeletedResult
776
+ :param container_id:
777
+ :type container_id: str
778
+ :param delete_reason:
779
+ :type delete_reason: ContainerDeleteReason, optional
780
+ :param async_: Perform the request asynchronously
781
+ :type async_: bool, optional
782
+ :rtype: DeletedResult
751
783
  """
752
784
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
753
785
  kwargs['_return_http_data_only'] = True
@@ -771,10 +803,13 @@ class ContainersApi(object):
771
803
  Delete Container
772
804
  This method makes a synchronous HTTP request by default.
773
805
 
774
- :param str container_id: (required)
775
- :param ContainerDeleteReason delete_reason:
776
- :param bool async_: Perform the request asynchronously
777
- :return: DeletedResult
806
+ :param container_id:
807
+ :type container_id: str
808
+ :param delete_reason:
809
+ :type delete_reason: ContainerDeleteReason, optional
810
+ :param async_: Perform the request asynchronously
811
+ :type async_: bool, optional
812
+ :rtype: DeletedResult
778
813
  """
779
814
 
780
815
  all_params = ['container_id','delete_reason',] # noqa: E501
@@ -845,11 +880,15 @@ class ContainersApi(object):
845
880
  Delete an analysis for a container.
846
881
  This method makes a synchronous HTTP request by default.
847
882
 
848
- :param str cid: (required)
849
- :param str analysis_id: (required)
850
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
851
- :param bool async_: Perform the request asynchronously
852
- :return: DeletedResult
883
+ :param cid:
884
+ :type cid: str
885
+ :param analysis_id:
886
+ :type analysis_id: str
887
+ :param delete_reason: Provide a reason for the deletion
888
+ :type delete_reason: ContainerDeleteReason, optional
889
+ :param async_: Perform the request asynchronously
890
+ :type async_: bool, optional
891
+ :rtype: DeletedResult
853
892
  """
854
893
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
855
894
  kwargs['_return_http_data_only'] = True
@@ -873,11 +912,15 @@ class ContainersApi(object):
873
912
  Delete an analysis for a container.
874
913
  This method makes a synchronous HTTP request by default.
875
914
 
876
- :param str cid: (required)
877
- :param str analysis_id: (required)
878
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
879
- :param bool async_: Perform the request asynchronously
880
- :return: DeletedResult
915
+ :param cid:
916
+ :type cid: str
917
+ :param analysis_id:
918
+ :type analysis_id: str
919
+ :param delete_reason: Provide a reason for the deletion
920
+ :type delete_reason: ContainerDeleteReason, optional
921
+ :param async_: Perform the request asynchronously
922
+ :type async_: bool, optional
923
+ :rtype: DeletedResult
881
924
  """
882
925
 
883
926
  all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
@@ -954,11 +997,15 @@ class ContainersApi(object):
954
997
  Remove a note from a(n) container analysis.
955
998
  This method makes a synchronous HTTP request by default.
956
999
 
957
- :param str cid: 24-char hex id (required)
958
- :param str analysis_id: 24-char hex analysis id (required)
959
- :param str note_id: 24-char hex note id (required)
960
- :param bool async_: Perform the request asynchronously
961
- :return: DeletedResult
1000
+ :param cid: 24-char hex id
1001
+ :type cid: str
1002
+ :param analysis_id: 24-char hex analysis id
1003
+ :type analysis_id: str
1004
+ :param note_id: 24-char hex note id
1005
+ :type note_id: str
1006
+ :param async_: Perform the request asynchronously
1007
+ :type async_: bool, optional
1008
+ :rtype: DeletedResult
962
1009
  """
963
1010
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
964
1011
  kwargs['_return_http_data_only'] = True
@@ -982,11 +1029,15 @@ class ContainersApi(object):
982
1029
  Remove a note from a(n) container analysis.
983
1030
  This method makes a synchronous HTTP request by default.
984
1031
 
985
- :param str cid: 24-char hex id (required)
986
- :param str analysis_id: 24-char hex analysis id (required)
987
- :param str note_id: 24-char hex note id (required)
988
- :param bool async_: Perform the request asynchronously
989
- :return: DeletedResult
1032
+ :param cid: 24-char hex id
1033
+ :type cid: str
1034
+ :param analysis_id: 24-char hex analysis id
1035
+ :type analysis_id: str
1036
+ :param note_id: 24-char hex note id
1037
+ :type note_id: str
1038
+ :param async_: Perform the request asynchronously
1039
+ :type async_: bool, optional
1040
+ :rtype: DeletedResult
990
1041
  """
991
1042
 
992
1043
  all_params = ['cid','analysis_id','note_id',] # noqa: E501
@@ -1067,12 +1118,17 @@ class ContainersApi(object):
1067
1118
  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.
1068
1119
  This method makes a synchronous HTTP request by default.
1069
1120
 
1070
- :param str cid: (required)
1071
- :param str filename: (required)
1072
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1073
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1074
- :param bool async_: Perform the request asynchronously
1075
- :return: DeletedResult
1121
+ :param cid:
1122
+ :type cid: str
1123
+ :param filename:
1124
+ :type filename: str
1125
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1126
+ :type delete_reason: ContainerDeleteReason, optional
1127
+ :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1128
+ :type force: bool, optional
1129
+ :param async_: Perform the request asynchronously
1130
+ :type async_: bool, optional
1131
+ :rtype: DeletedResult
1076
1132
  """
1077
1133
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1078
1134
  kwargs['_return_http_data_only'] = True
@@ -1096,12 +1152,17 @@ class ContainersApi(object):
1096
1152
  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.
1097
1153
  This method makes a synchronous HTTP request by default.
1098
1154
 
1099
- :param str cid: (required)
1100
- :param str filename: (required)
1101
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1102
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1103
- :param bool async_: Perform the request asynchronously
1104
- :return: DeletedResult
1155
+ :param cid:
1156
+ :type cid: str
1157
+ :param filename:
1158
+ :type filename: str
1159
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1160
+ :type delete_reason: ContainerDeleteReason, optional
1161
+ :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1162
+ :type force: bool, optional
1163
+ :param async_: Perform the request asynchronously
1164
+ :type async_: bool, optional
1165
+ :rtype: DeletedResult
1105
1166
  """
1106
1167
 
1107
1168
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -1180,10 +1241,13 @@ class ContainersApi(object):
1180
1241
  Remove a note from a(n) container
1181
1242
  This method makes a synchronous HTTP request by default.
1182
1243
 
1183
- :param str cid: (required)
1184
- :param str note_id: (required)
1185
- :param bool async_: Perform the request asynchronously
1186
- :return: DeletedResult
1244
+ :param cid:
1245
+ :type cid: str
1246
+ :param note_id:
1247
+ :type note_id: str
1248
+ :param async_: Perform the request asynchronously
1249
+ :type async_: bool, optional
1250
+ :rtype: DeletedResult
1187
1251
  """
1188
1252
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1189
1253
  kwargs['_return_http_data_only'] = True
@@ -1207,10 +1271,13 @@ class ContainersApi(object):
1207
1271
  Remove a note from a(n) container
1208
1272
  This method makes a synchronous HTTP request by default.
1209
1273
 
1210
- :param str cid: (required)
1211
- :param str note_id: (required)
1212
- :param bool async_: Perform the request asynchronously
1213
- :return: DeletedResult
1274
+ :param cid:
1275
+ :type cid: str
1276
+ :param note_id:
1277
+ :type note_id: str
1278
+ :param async_: Perform the request asynchronously
1279
+ :type async_: bool, optional
1280
+ :rtype: DeletedResult
1214
1281
  """
1215
1282
 
1216
1283
  all_params = ['cid','note_id',] # noqa: E501
@@ -1285,10 +1352,13 @@ class ContainersApi(object):
1285
1352
  Delete a tag
1286
1353
  This method makes a synchronous HTTP request by default.
1287
1354
 
1288
- :param str cid: (required)
1289
- :param str value: The tag to interact with (required)
1290
- :param bool async_: Perform the request asynchronously
1291
- :return: DeletedResult
1355
+ :param cid:
1356
+ :type cid: str
1357
+ :param value: The tag to interact with
1358
+ :type value: str
1359
+ :param async_: Perform the request asynchronously
1360
+ :type async_: bool, optional
1361
+ :rtype: DeletedResult
1292
1362
  """
1293
1363
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1294
1364
  kwargs['_return_http_data_only'] = True
@@ -1312,10 +1382,13 @@ class ContainersApi(object):
1312
1382
  Delete a tag
1313
1383
  This method makes a synchronous HTTP request by default.
1314
1384
 
1315
- :param str cid: (required)
1316
- :param str value: The tag to interact with (required)
1317
- :param bool async_: Perform the request asynchronously
1318
- :return: DeletedResult
1385
+ :param cid:
1386
+ :type cid: str
1387
+ :param value: The tag to interact with
1388
+ :type value: str
1389
+ :param async_: Perform the request asynchronously
1390
+ :type async_: bool, optional
1391
+ :rtype: DeletedResult
1319
1392
  """
1320
1393
 
1321
1394
  all_params = ['cid','value',] # noqa: E501
@@ -1390,10 +1463,13 @@ class ContainersApi(object):
1390
1463
  Delete multiple tags from a(n) container
1391
1464
  This method makes a synchronous HTTP request by default.
1392
1465
 
1393
- :param str cid: (required)
1394
- :param list[str] body: (required)
1395
- :param bool async_: Perform the request asynchronously
1396
- :return: None
1466
+ :param cid:
1467
+ :type cid: str
1468
+ :param body:
1469
+ :type body: list[str]
1470
+ :param async_: Perform the request asynchronously
1471
+ :type async_: bool, optional
1472
+ :rtype: None
1397
1473
  """
1398
1474
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1399
1475
  kwargs['_return_http_data_only'] = True
@@ -1417,10 +1493,13 @@ class ContainersApi(object):
1417
1493
  Delete multiple tags from a(n) container
1418
1494
  This method makes a synchronous HTTP request by default.
1419
1495
 
1420
- :param str cid: (required)
1421
- :param list[str] body: (required)
1422
- :param bool async_: Perform the request asynchronously
1423
- :return: None
1496
+ :param cid:
1497
+ :type cid: str
1498
+ :param body:
1499
+ :type body: list[str]
1500
+ :param async_: Perform the request asynchronously
1501
+ :type async_: bool, optional
1502
+ :rtype: None
1424
1503
  """
1425
1504
 
1426
1505
  all_params = ['cid','body',] # noqa: E501
@@ -1499,18 +1578,29 @@ class ContainersApi(object):
1499
1578
  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.
1500
1579
  This method makes a synchronous HTTP request by default.
1501
1580
 
1502
- :param str container_id: 24-character hex ID (required)
1503
- :param str file_name: output file name (required)
1504
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1505
- :param str member: The filename of a zipfile member to download rather than the entire file
1506
- :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\"
1507
- :param int version: version of the file to download
1508
- :param str hash: file hash for comparison
1509
- :param str range: byte ranges to return
1510
- :param list[str] x_accept_feature: redirect header
1511
- :param str dest_file: Destination file path
1512
- :param bool async_: Perform the request asynchronously
1513
- :return: union[DownloadTicketStub,ZipfileInfo]
1581
+ :param container_id: 24-character hex ID
1582
+ :type container_id: str
1583
+ :param file_name: output file name
1584
+ :type file_name: str
1585
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1586
+ :type info: bool, optional
1587
+ :param member: The filename of a zipfile member to download rather than the entire file
1588
+ :type member: str, optional
1589
+ :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
1590
+ :type view: bool, optional
1591
+ :param version: version of the file to download
1592
+ :type version: int, optional
1593
+ :param hash: file hash for comparison
1594
+ :type hash: str, optional
1595
+ :param range: byte ranges to return
1596
+ :type range: str, optional
1597
+ :param x_accept_feature: redirect header, defaults to []
1598
+ :type x_accept_feature: list[str], optional
1599
+ :param dest_file: Destination file path
1600
+ :type dest_file: str
1601
+ :param async_: Perform the request asynchronously
1602
+ :type async_: bool, optional
1603
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1514
1604
  """
1515
1605
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1516
1606
  kwargs['_return_http_data_only'] = True
@@ -1533,17 +1623,27 @@ class ContainersApi(object):
1533
1623
  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.
1534
1624
  This method makes a synchronous HTTP request by default.
1535
1625
 
1536
- :param str container_id: 24-character hex ID (required)
1537
- :param str file_name: output file name (required)
1538
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1539
- :param str member: The filename of a zipfile member to download rather than the entire file
1540
- :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\"
1541
- :param int version: version of the file to download
1542
- :param str hash: file hash for comparison
1543
- :param str range: byte ranges to return
1544
- :param list[str] x_accept_feature: redirect header
1545
- :param bool async_: Perform the request asynchronously
1546
- :return: union[DownloadTicketStub,ZipfileInfo]
1626
+ :param container_id: 24-character hex ID
1627
+ :type container_id: str
1628
+ :param file_name: output file name
1629
+ :type file_name: str
1630
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1631
+ :type info: bool, optional
1632
+ :param member: The filename of a zipfile member to download rather than the entire file
1633
+ :type member: str, optional
1634
+ :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
1635
+ :type view: bool, optional
1636
+ :param version: version of the file to download
1637
+ :type version: int, optional
1638
+ :param hash: file hash for comparison
1639
+ :type hash: str, optional
1640
+ :param range: byte ranges to return
1641
+ :type range: str, optional
1642
+ :param x_accept_feature: redirect header, defaults to []
1643
+ :type x_accept_feature: list[str], optional
1644
+ :param async_: Perform the request asynchronously
1645
+ :type async_: bool, optional
1646
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1547
1647
  """
1548
1648
 
1549
1649
  all_params = ['container_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1633,18 +1733,29 @@ class ContainersApi(object):
1633
1733
  Does not work on files whose names contain a forward slash.
1634
1734
  This method makes a synchronous HTTP request by default.
1635
1735
 
1636
- :param str container_id: 24-character hex ID (required)
1637
- :param str file_name: output file name (required)
1638
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1639
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1640
- :param str member: The filename of a zipfile member to download rather than the entire file
1641
- :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\"
1642
- :param int version: version of the file to download
1643
- :param str hash: file hash for comparison
1644
- :param str range: byte ranges to return
1645
- :param list[str] x_accept_feature: redirect header
1646
- :param bool async_: Perform the request asynchronously
1647
- :return: FileZipInfo
1736
+ :param container_id: 24-character hex ID
1737
+ :type container_id: str
1738
+ :param file_name: output file name
1739
+ :type file_name: str
1740
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1741
+ :type ticket: str, optional
1742
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1743
+ :type info: bool, optional
1744
+ :param member: The filename of a zipfile member to download rather than the entire file
1745
+ :type member: str, optional
1746
+ :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
1747
+ :type view: bool, optional
1748
+ :param version: version of the file to download
1749
+ :type version: int, optional
1750
+ :param hash: file hash for comparison
1751
+ :type hash: str, optional
1752
+ :param range: byte ranges to return
1753
+ :type range: str, optional
1754
+ :param x_accept_feature: redirect header, defaults to []
1755
+ :type x_accept_feature: list[str], optional
1756
+ :param async_: Perform the request asynchronously
1757
+ :type async_: bool, optional
1758
+ :rtype: FileZipInfo
1648
1759
  """
1649
1760
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1650
1761
  kwargs['_return_http_data_only'] = True
@@ -1668,18 +1779,29 @@ class ContainersApi(object):
1668
1779
  Does not work on files whose names contain a forward slash.
1669
1780
  This method makes a synchronous HTTP request by default.
1670
1781
 
1671
- :param str container_id: 24-character hex ID (required)
1672
- :param str file_name: output file name (required)
1673
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1674
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1675
- :param str member: The filename of a zipfile member to download rather than the entire file
1676
- :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\"
1677
- :param int version: version of the file to download
1678
- :param str hash: file hash for comparison
1679
- :param str range: byte ranges to return
1680
- :param list[str] x_accept_feature: redirect header
1681
- :param bool async_: Perform the request asynchronously
1682
- :return: FileZipInfo
1782
+ :param container_id: 24-character hex ID
1783
+ :type container_id: str
1784
+ :param file_name: output file name
1785
+ :type file_name: str
1786
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1787
+ :type ticket: str, optional
1788
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1789
+ :type info: bool, optional
1790
+ :param member: The filename of a zipfile member to download rather than the entire file
1791
+ :type member: str, optional
1792
+ :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
1793
+ :type view: bool, optional
1794
+ :param version: version of the file to download
1795
+ :type version: int, optional
1796
+ :param hash: file hash for comparison
1797
+ :type hash: str, optional
1798
+ :param range: byte ranges to return
1799
+ :type range: str, optional
1800
+ :param x_accept_feature: redirect header, defaults to []
1801
+ :type x_accept_feature: list[str], optional
1802
+ :param async_: Perform the request asynchronously
1803
+ :type async_: bool, optional
1804
+ :rtype: FileZipInfo
1683
1805
  """
1684
1806
 
1685
1807
  all_params = ['container_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1772,18 +1894,29 @@ class ContainersApi(object):
1772
1894
 
1773
1895
  This method makes a synchronous HTTP request by default.
1774
1896
 
1775
- :param str container_id: 24-character hex ID (required)
1776
- :param str file_name: output file name (required)
1777
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1778
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1779
- :param str member: The filename of a zipfile member to download rather than the entire file
1780
- :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\"
1781
- :param int version: version of the file to download
1782
- :param str hash: file hash for comparison
1783
- :param str range: byte ranges to return
1784
- :param list[str] x_accept_feature: redirect header
1785
- :param bool async_: Perform the request asynchronously
1786
- :return: union[DownloadTicketStub,ZipfileInfo]
1897
+ :param container_id: 24-character hex ID
1898
+ :type container_id: str
1899
+ :param file_name: output file name
1900
+ :type file_name: str
1901
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1902
+ :type ticket: str, optional
1903
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1904
+ :type info: bool, optional
1905
+ :param member: The filename of a zipfile member to download rather than the entire file
1906
+ :type member: str, optional
1907
+ :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
1908
+ :type view: bool, optional
1909
+ :param version: version of the file to download
1910
+ :type version: int, optional
1911
+ :param hash: file hash for comparison
1912
+ :type hash: str, optional
1913
+ :param range: byte ranges to return
1914
+ :type range: str, optional
1915
+ :param x_accept_feature: redirect header, defaults to []
1916
+ :type x_accept_feature: list[str], optional
1917
+ :param async_: Perform the request asynchronously
1918
+ :type async_: bool, optional
1919
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1787
1920
  """
1788
1921
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1789
1922
  kwargs['_return_http_data_only'] = True
@@ -1806,18 +1939,29 @@ class ContainersApi(object):
1806
1939
 
1807
1940
  This method makes a synchronous HTTP request by default.
1808
1941
 
1809
- :param str container_id: 24-character hex ID (required)
1810
- :param str file_name: output file name (required)
1811
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1812
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1813
- :param str member: The filename of a zipfile member to download rather than the entire file
1814
- :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\"
1815
- :param int version: version of the file to download
1816
- :param str hash: file hash for comparison
1817
- :param str range: byte ranges to return
1818
- :param list[str] x_accept_feature: redirect header
1819
- :param bool async_: Perform the request asynchronously
1820
- :return: union[DownloadTicketStub,ZipfileInfo]
1942
+ :param container_id: 24-character hex ID
1943
+ :type container_id: str
1944
+ :param file_name: output file name
1945
+ :type file_name: str
1946
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1947
+ :type ticket: str, optional
1948
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1949
+ :type info: bool, optional
1950
+ :param member: The filename of a zipfile member to download rather than the entire file
1951
+ :type member: str, optional
1952
+ :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
1953
+ :type view: bool, optional
1954
+ :param version: version of the file to download
1955
+ :type version: int, optional
1956
+ :param hash: file hash for comparison
1957
+ :type hash: str, optional
1958
+ :param range: byte ranges to return
1959
+ :type range: str, optional
1960
+ :param x_accept_feature: redirect header, defaults to []
1961
+ :type x_accept_feature: list[str], optional
1962
+ :param async_: Perform the request asynchronously
1963
+ :type async_: bool, optional
1964
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1821
1965
  """
1822
1966
 
1823
1967
  all_params = ['container_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1909,17 +2053,27 @@ class ContainersApi(object):
1909
2053
  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.
1910
2054
  This method makes a synchronous HTTP request by default.
1911
2055
 
1912
- :param str container_id: 24-character hex ID (required)
1913
- :param str analysis_id: 24-char hex analysis id (required)
1914
- :param str filename: filename to download (get tar of all if empty) (required)
1915
- :param bool info: get file info only
1916
- :param str member: get zipfile member
1917
- :param bool view: feature flag for view/download
1918
- :param str range: byte ranges to return
1919
- :param list[str] x_accept_feature: redirect header
1920
- :param str dest_file: Destination file path
1921
- :param bool async_: Perform the request asynchronously
1922
- :return: union[DownloadTicketStub,ZipfileInfo]
2056
+ :param container_id: 24-character hex ID
2057
+ :type container_id: str
2058
+ :param analysis_id: 24-char hex analysis id
2059
+ :type analysis_id: str
2060
+ :param filename: filename to download (get tar of all if empty)
2061
+ :type filename: str
2062
+ :param info: get file info only, defaults to false
2063
+ :type info: bool, optional
2064
+ :param member: get zipfile member
2065
+ :type member: str, optional
2066
+ :param view: feature flag for view/download, defaults to false
2067
+ :type view: bool, optional
2068
+ :param range: byte ranges to return
2069
+ :type range: str, optional
2070
+ :param x_accept_feature: redirect header, defaults to []
2071
+ :type x_accept_feature: list[str], optional
2072
+ :param dest_file: Destination file path
2073
+ :type dest_file: str
2074
+ :param async_: Perform the request asynchronously
2075
+ :type async_: bool, optional
2076
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1923
2077
  """
1924
2078
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1925
2079
  kwargs['_return_http_data_only'] = True
@@ -1942,16 +2096,25 @@ class ContainersApi(object):
1942
2096
  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.
1943
2097
  This method makes a synchronous HTTP request by default.
1944
2098
 
1945
- :param str container_id: 24-character hex ID (required)
1946
- :param str analysis_id: 24-char hex analysis id (required)
1947
- :param str filename: filename to download (get tar of all if empty) (required)
1948
- :param bool info: get file info only
1949
- :param str member: get zipfile member
1950
- :param bool view: feature flag for view/download
1951
- :param str range: byte ranges to return
1952
- :param list[str] x_accept_feature: redirect header
1953
- :param bool async_: Perform the request asynchronously
1954
- :return: union[DownloadTicketStub,ZipfileInfo]
2099
+ :param container_id: 24-character hex ID
2100
+ :type container_id: str
2101
+ :param analysis_id: 24-char hex analysis id
2102
+ :type analysis_id: str
2103
+ :param filename: filename to download (get tar of all if empty)
2104
+ :type filename: str
2105
+ :param info: get file info only, defaults to false
2106
+ :type info: bool, optional
2107
+ :param member: get zipfile member
2108
+ :type member: str, optional
2109
+ :param view: feature flag for view/download, defaults to false
2110
+ :type view: bool, optional
2111
+ :param range: byte ranges to return
2112
+ :type range: str, optional
2113
+ :param x_accept_feature: redirect header, defaults to []
2114
+ :type x_accept_feature: list[str], optional
2115
+ :param async_: Perform the request asynchronously
2116
+ :type async_: bool, optional
2117
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1955
2118
  """
1956
2119
 
1957
2120
  all_params = ['container_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2043,17 +2206,27 @@ class ContainersApi(object):
2043
2206
  Does not work on files whose names contain a forward slash.
2044
2207
  This method makes a synchronous HTTP request by default.
2045
2208
 
2046
- :param str container_id: 24-character hex ID (required)
2047
- :param str analysis_id: 24-char hex analysis id (required)
2048
- :param str filename: filename to download (get tar of all if empty) (required)
2049
- :param str ticket: 24-char hex ticket id
2050
- :param bool info: get file info only
2051
- :param str member: get zipfile member
2052
- :param bool view: feature flag for view/download
2053
- :param str range: byte ranges to return
2054
- :param list[str] x_accept_feature: redirect header
2055
- :param bool async_: Perform the request asynchronously
2056
- :return: FileZipInfo
2209
+ :param container_id: 24-character hex ID
2210
+ :type container_id: str
2211
+ :param analysis_id: 24-char hex analysis id
2212
+ :type analysis_id: str
2213
+ :param filename: filename to download (get tar of all if empty)
2214
+ :type filename: str
2215
+ :param ticket: 24-char hex ticket id
2216
+ :type ticket: str, optional
2217
+ :param info: get file info only, defaults to false
2218
+ :type info: bool, optional
2219
+ :param member: get zipfile member
2220
+ :type member: str, optional
2221
+ :param view: feature flag for view/download, defaults to false
2222
+ :type view: bool, optional
2223
+ :param range: byte ranges to return
2224
+ :type range: str, optional
2225
+ :param x_accept_feature: redirect header, defaults to []
2226
+ :type x_accept_feature: list[str], optional
2227
+ :param async_: Perform the request asynchronously
2228
+ :type async_: bool, optional
2229
+ :rtype: FileZipInfo
2057
2230
  """
2058
2231
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2059
2232
  kwargs['_return_http_data_only'] = True
@@ -2077,17 +2250,27 @@ class ContainersApi(object):
2077
2250
  Does not work on files whose names contain a forward slash.
2078
2251
  This method makes a synchronous HTTP request by default.
2079
2252
 
2080
- :param str container_id: 24-character hex ID (required)
2081
- :param str analysis_id: 24-char hex analysis id (required)
2082
- :param str filename: filename to download (get tar of all if empty) (required)
2083
- :param str ticket: 24-char hex ticket id
2084
- :param bool info: get file info only
2085
- :param str member: get zipfile member
2086
- :param bool view: feature flag for view/download
2087
- :param str range: byte ranges to return
2088
- :param list[str] x_accept_feature: redirect header
2089
- :param bool async_: Perform the request asynchronously
2090
- :return: FileZipInfo
2253
+ :param container_id: 24-character hex ID
2254
+ :type container_id: str
2255
+ :param analysis_id: 24-char hex analysis id
2256
+ :type analysis_id: str
2257
+ :param filename: filename to download (get tar of all if empty)
2258
+ :type filename: str
2259
+ :param ticket: 24-char hex ticket id
2260
+ :type ticket: str, optional
2261
+ :param info: get file info only, defaults to false
2262
+ :type info: bool, optional
2263
+ :param member: get zipfile member
2264
+ :type member: str, optional
2265
+ :param view: feature flag for view/download, defaults to false
2266
+ :type view: bool, optional
2267
+ :param range: byte ranges to return
2268
+ :type range: str, optional
2269
+ :param x_accept_feature: redirect header, defaults to []
2270
+ :type x_accept_feature: list[str], optional
2271
+ :param async_: Perform the request asynchronously
2272
+ :type async_: bool, optional
2273
+ :rtype: FileZipInfo
2091
2274
  """
2092
2275
 
2093
2276
  all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2182,17 +2365,27 @@ class ContainersApi(object):
2182
2365
 
2183
2366
  This method makes a synchronous HTTP request by default.
2184
2367
 
2185
- :param str container_id: 24-character hex ID (required)
2186
- :param str analysis_id: 24-char hex analysis id (required)
2187
- :param str filename: filename to download (get tar of all if empty) (required)
2188
- :param str ticket: 24-char hex ticket id
2189
- :param bool info: get file info only
2190
- :param str member: get zipfile member
2191
- :param bool view: feature flag for view/download
2192
- :param str range: byte ranges to return
2193
- :param list[str] x_accept_feature: redirect header
2194
- :param bool async_: Perform the request asynchronously
2195
- :return: union[DownloadTicketStub,ZipfileInfo]
2368
+ :param container_id: 24-character hex ID
2369
+ :type container_id: str
2370
+ :param analysis_id: 24-char hex analysis id
2371
+ :type analysis_id: str
2372
+ :param filename: filename to download (get tar of all if empty)
2373
+ :type filename: str
2374
+ :param ticket: 24-char hex ticket id
2375
+ :type ticket: str, optional
2376
+ :param info: get file info only, defaults to false
2377
+ :type info: bool, optional
2378
+ :param member: get zipfile member
2379
+ :type member: str, optional
2380
+ :param view: feature flag for view/download, defaults to false
2381
+ :type view: bool, optional
2382
+ :param range: byte ranges to return
2383
+ :type range: str, optional
2384
+ :param x_accept_feature: redirect header, defaults to []
2385
+ :type x_accept_feature: list[str], optional
2386
+ :param async_: Perform the request asynchronously
2387
+ :type async_: bool, optional
2388
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2196
2389
  """
2197
2390
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2198
2391
  kwargs['_return_http_data_only'] = True
@@ -2215,17 +2408,27 @@ class ContainersApi(object):
2215
2408
 
2216
2409
  This method makes a synchronous HTTP request by default.
2217
2410
 
2218
- :param str container_id: 24-character hex ID (required)
2219
- :param str analysis_id: 24-char hex analysis id (required)
2220
- :param str filename: filename to download (get tar of all if empty) (required)
2221
- :param str ticket: 24-char hex ticket id
2222
- :param bool info: get file info only
2223
- :param str member: get zipfile member
2224
- :param bool view: feature flag for view/download
2225
- :param str range: byte ranges to return
2226
- :param list[str] x_accept_feature: redirect header
2227
- :param bool async_: Perform the request asynchronously
2228
- :return: union[DownloadTicketStub,ZipfileInfo]
2411
+ :param container_id: 24-character hex ID
2412
+ :type container_id: str
2413
+ :param analysis_id: 24-char hex analysis id
2414
+ :type analysis_id: str
2415
+ :param filename: filename to download (get tar of all if empty)
2416
+ :type filename: str
2417
+ :param ticket: 24-char hex ticket id
2418
+ :type ticket: str, optional
2419
+ :param info: get file info only, defaults to false
2420
+ :type info: bool, optional
2421
+ :param member: get zipfile member
2422
+ :type member: str, optional
2423
+ :param view: feature flag for view/download, defaults to false
2424
+ :type view: bool, optional
2425
+ :param range: byte ranges to return
2426
+ :type range: str, optional
2427
+ :param x_accept_feature: redirect header, defaults to []
2428
+ :type x_accept_feature: list[str], optional
2429
+ :param async_: Perform the request asynchronously
2430
+ :type async_: bool, optional
2431
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2229
2432
  """
2230
2433
 
2231
2434
  all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2319,17 +2522,27 @@ class ContainersApi(object):
2319
2522
  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.
2320
2523
  This method makes a synchronous HTTP request by default.
2321
2524
 
2322
- :param str container_id: 24-character hex ID (required)
2323
- :param str analysis_id: 24-char hex analysis id (required)
2324
- :param str filename: filename to download (get tar of all if empty) (required)
2325
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2326
- :param str member: The filename of a zipfile member to download rather than the entire file
2327
- :param bool view: feature flag for view/download
2328
- :param str range: byte ranges to return
2329
- :param list[str] x_accept_feature: redirect header
2330
- :param str dest_file: Destination file path
2331
- :param bool async_: Perform the request asynchronously
2332
- :return: union[DownloadTicketStub,ZipfileInfo]
2525
+ :param container_id: 24-character hex ID
2526
+ :type container_id: str
2527
+ :param analysis_id: 24-char hex analysis id
2528
+ :type analysis_id: str
2529
+ :param filename: filename to download (get tar of all if empty)
2530
+ :type filename: str
2531
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2532
+ :type info: bool, optional
2533
+ :param member: The filename of a zipfile member to download rather than the entire file
2534
+ :type member: str, optional
2535
+ :param view: feature flag for view/download, defaults to false
2536
+ :type view: bool, optional
2537
+ :param range: byte ranges to return
2538
+ :type range: str, optional
2539
+ :param x_accept_feature: redirect header, defaults to []
2540
+ :type x_accept_feature: list[str], optional
2541
+ :param dest_file: Destination file path
2542
+ :type dest_file: str
2543
+ :param async_: Perform the request asynchronously
2544
+ :type async_: bool, optional
2545
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2333
2546
  """
2334
2547
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2335
2548
  kwargs['_return_http_data_only'] = True
@@ -2352,16 +2565,25 @@ class ContainersApi(object):
2352
2565
  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.
2353
2566
  This method makes a synchronous HTTP request by default.
2354
2567
 
2355
- :param str container_id: 24-character hex ID (required)
2356
- :param str analysis_id: 24-char hex analysis id (required)
2357
- :param str filename: filename to download (get tar of all if empty) (required)
2358
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2359
- :param str member: The filename of a zipfile member to download rather than the entire file
2360
- :param bool view: feature flag for view/download
2361
- :param str range: byte ranges to return
2362
- :param list[str] x_accept_feature: redirect header
2363
- :param bool async_: Perform the request asynchronously
2364
- :return: union[DownloadTicketStub,ZipfileInfo]
2568
+ :param container_id: 24-character hex ID
2569
+ :type container_id: str
2570
+ :param analysis_id: 24-char hex analysis id
2571
+ :type analysis_id: str
2572
+ :param filename: filename to download (get tar of all if empty)
2573
+ :type filename: str
2574
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2575
+ :type info: bool, optional
2576
+ :param member: The filename of a zipfile member to download rather than the entire file
2577
+ :type member: str, optional
2578
+ :param view: feature flag for view/download, defaults to false
2579
+ :type view: bool, optional
2580
+ :param range: byte ranges to return
2581
+ :type range: str, optional
2582
+ :param x_accept_feature: redirect header, defaults to []
2583
+ :type x_accept_feature: list[str], optional
2584
+ :param async_: Perform the request asynchronously
2585
+ :type async_: bool, optional
2586
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2365
2587
  """
2366
2588
 
2367
2589
  all_params = ['container_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2453,17 +2675,27 @@ class ContainersApi(object):
2453
2675
  Does not work on files whose names contain a forward slash.
2454
2676
  This method makes a synchronous HTTP request by default.
2455
2677
 
2456
- :param str container_id: 24-character hex ID (required)
2457
- :param str analysis_id: 24-char hex analysis id (required)
2458
- :param str filename: filename to download (get tar of all if empty) (required)
2459
- :param str ticket: ticket id of the outputs to download
2460
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2461
- :param str member: The filename of a zipfile member to download rather than the entire file
2462
- :param bool view: feature flag for view/download
2463
- :param str range: byte ranges to return
2464
- :param list[str] x_accept_feature: redirect header
2465
- :param bool async_: Perform the request asynchronously
2466
- :return: FileZipInfo
2678
+ :param container_id: 24-character hex ID
2679
+ :type container_id: str
2680
+ :param analysis_id: 24-char hex analysis id
2681
+ :type analysis_id: str
2682
+ :param filename: filename to download (get tar of all if empty)
2683
+ :type filename: str
2684
+ :param ticket: ticket id of the outputs to download
2685
+ :type ticket: str, optional
2686
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2687
+ :type info: bool, optional
2688
+ :param member: The filename of a zipfile member to download rather than the entire file
2689
+ :type member: str, optional
2690
+ :param view: feature flag for view/download, defaults to false
2691
+ :type view: bool, optional
2692
+ :param range: byte ranges to return
2693
+ :type range: str, optional
2694
+ :param x_accept_feature: redirect header, defaults to []
2695
+ :type x_accept_feature: list[str], optional
2696
+ :param async_: Perform the request asynchronously
2697
+ :type async_: bool, optional
2698
+ :rtype: FileZipInfo
2467
2699
  """
2468
2700
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2469
2701
  kwargs['_return_http_data_only'] = True
@@ -2487,17 +2719,27 @@ class ContainersApi(object):
2487
2719
  Does not work on files whose names contain a forward slash.
2488
2720
  This method makes a synchronous HTTP request by default.
2489
2721
 
2490
- :param str container_id: 24-character hex ID (required)
2491
- :param str analysis_id: 24-char hex analysis id (required)
2492
- :param str filename: filename to download (get tar of all if empty) (required)
2493
- :param str ticket: ticket id of the outputs to download
2494
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2495
- :param str member: The filename of a zipfile member to download rather than the entire file
2496
- :param bool view: feature flag for view/download
2497
- :param str range: byte ranges to return
2498
- :param list[str] x_accept_feature: redirect header
2499
- :param bool async_: Perform the request asynchronously
2500
- :return: FileZipInfo
2722
+ :param container_id: 24-character hex ID
2723
+ :type container_id: str
2724
+ :param analysis_id: 24-char hex analysis id
2725
+ :type analysis_id: str
2726
+ :param filename: filename to download (get tar of all if empty)
2727
+ :type filename: str
2728
+ :param ticket: ticket id of the outputs to download
2729
+ :type ticket: str, optional
2730
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2731
+ :type info: bool, optional
2732
+ :param member: The filename of a zipfile member to download rather than the entire file
2733
+ :type member: str, optional
2734
+ :param view: feature flag for view/download, defaults to false
2735
+ :type view: bool, optional
2736
+ :param range: byte ranges to return
2737
+ :type range: str, optional
2738
+ :param x_accept_feature: redirect header, defaults to []
2739
+ :type x_accept_feature: list[str], optional
2740
+ :param async_: Perform the request asynchronously
2741
+ :type async_: bool, optional
2742
+ :rtype: FileZipInfo
2501
2743
  """
2502
2744
 
2503
2745
  all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2592,17 +2834,27 @@ class ContainersApi(object):
2592
2834
 
2593
2835
  This method makes a synchronous HTTP request by default.
2594
2836
 
2595
- :param str container_id: 24-character hex ID (required)
2596
- :param str analysis_id: 24-char hex analysis id (required)
2597
- :param str filename: filename to download (get tar of all if empty) (required)
2598
- :param str ticket: ticket id of the outputs to download
2599
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2600
- :param str member: The filename of a zipfile member to download rather than the entire file
2601
- :param bool view: feature flag for view/download
2602
- :param str range: byte ranges to return
2603
- :param list[str] x_accept_feature: redirect header
2604
- :param bool async_: Perform the request asynchronously
2605
- :return: union[DownloadTicketStub,ZipfileInfo]
2837
+ :param container_id: 24-character hex ID
2838
+ :type container_id: str
2839
+ :param analysis_id: 24-char hex analysis id
2840
+ :type analysis_id: str
2841
+ :param filename: filename to download (get tar of all if empty)
2842
+ :type filename: str
2843
+ :param ticket: ticket id of the outputs to download
2844
+ :type ticket: str, optional
2845
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2846
+ :type info: bool, optional
2847
+ :param member: The filename of a zipfile member to download rather than the entire file
2848
+ :type member: str, optional
2849
+ :param view: feature flag for view/download, defaults to false
2850
+ :type view: bool, optional
2851
+ :param range: byte ranges to return
2852
+ :type range: str, optional
2853
+ :param x_accept_feature: redirect header, defaults to []
2854
+ :type x_accept_feature: list[str], optional
2855
+ :param async_: Perform the request asynchronously
2856
+ :type async_: bool, optional
2857
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2606
2858
  """
2607
2859
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2608
2860
  kwargs['_return_http_data_only'] = True
@@ -2625,17 +2877,27 @@ class ContainersApi(object):
2625
2877
 
2626
2878
  This method makes a synchronous HTTP request by default.
2627
2879
 
2628
- :param str container_id: 24-character hex ID (required)
2629
- :param str analysis_id: 24-char hex analysis id (required)
2630
- :param str filename: filename to download (get tar of all if empty) (required)
2631
- :param str ticket: ticket id of the outputs to download
2632
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2633
- :param str member: The filename of a zipfile member to download rather than the entire file
2634
- :param bool view: feature flag for view/download
2635
- :param str range: byte ranges to return
2636
- :param list[str] x_accept_feature: redirect header
2637
- :param bool async_: Perform the request asynchronously
2638
- :return: union[DownloadTicketStub,ZipfileInfo]
2880
+ :param container_id: 24-character hex ID
2881
+ :type container_id: str
2882
+ :param analysis_id: 24-char hex analysis id
2883
+ :type analysis_id: str
2884
+ :param filename: filename to download (get tar of all if empty)
2885
+ :type filename: str
2886
+ :param ticket: ticket id of the outputs to download
2887
+ :type ticket: str, optional
2888
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2889
+ :type info: bool, optional
2890
+ :param member: The filename of a zipfile member to download rather than the entire file
2891
+ :type member: str, optional
2892
+ :param view: feature flag for view/download, defaults to false
2893
+ :type view: bool, optional
2894
+ :param range: byte ranges to return
2895
+ :type range: str, optional
2896
+ :param x_accept_feature: redirect header, defaults to []
2897
+ :type x_accept_feature: list[str], optional
2898
+ :param async_: Perform the request asynchronously
2899
+ :type async_: bool, optional
2900
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2639
2901
  """
2640
2902
 
2641
2903
  all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2729,11 +2991,15 @@ class ContainersApi(object):
2729
2991
  Find Container by ID
2730
2992
  This method makes a synchronous HTTP request by default.
2731
2993
 
2732
- :param str container_id: (required)
2733
- :param JoinType join:
2734
- :param bool join_avatars:
2735
- :param bool async_: Perform the request asynchronously
2736
- :return: union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]
2994
+ :param container_id:
2995
+ :type container_id: str
2996
+ :param join:
2997
+ :type join: JoinType, optional
2998
+ :param join_avatars:, defaults to false
2999
+ :type join_avatars: bool, optional
3000
+ :param async_: Perform the request asynchronously
3001
+ :type async_: bool, optional
3002
+ :rtype: union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]
2737
3003
  """
2738
3004
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2739
3005
  kwargs['_return_http_data_only'] = True
@@ -2757,11 +3023,15 @@ class ContainersApi(object):
2757
3023
  Find Container by ID
2758
3024
  This method makes a synchronous HTTP request by default.
2759
3025
 
2760
- :param str container_id: (required)
2761
- :param JoinType join:
2762
- :param bool join_avatars:
2763
- :param bool async_: Perform the request asynchronously
2764
- :return: union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]
3026
+ :param container_id:
3027
+ :type container_id: str
3028
+ :param join:
3029
+ :type join: JoinType, optional
3030
+ :param join_avatars:, defaults to false
3031
+ :type join_avatars: bool, optional
3032
+ :param async_: Perform the request asynchronously
3033
+ :type async_: bool, optional
3034
+ :rtype: union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]
2765
3035
  """
2766
3036
 
2767
3037
  all_params = ['container_id','join','join_avatars',] # noqa: E501
@@ -2834,20 +3104,33 @@ class ContainersApi(object):
2834
3104
  Returns analyses that directly belong to this resource.
2835
3105
  This method makes a synchronous HTTP request by default.
2836
3106
 
2837
- :param str cid: (required)
2838
- :param bool inflate_job:
2839
- :param bool join_avatars:
2840
- :param JoinType join:
2841
- :param bool include_all_info: Include all info in returned objects
2842
- :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)
2843
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2844
- :param int limit: The maximum number of entries to return.
2845
- :param int skip: The number of entries to skip.
2846
- :param int page: The page number (i.e. skip limit*page entries)
2847
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2848
- :param list[str] x_accept_feature:
2849
- :param bool async_: Perform the request asynchronously
2850
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3107
+ :param cid:
3108
+ :type cid: str
3109
+ :param inflate_job:, defaults to false
3110
+ :type inflate_job: bool, optional
3111
+ :param join_avatars:, defaults to false
3112
+ :type join_avatars: bool, optional
3113
+ :param join:
3114
+ :type join: JoinType, optional
3115
+ :param include_all_info: Include all info in returned objects, defaults to false
3116
+ :type include_all_info: bool, optional
3117
+ :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)
3118
+ :type filter: str, optional
3119
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3120
+ :type sort: str, optional
3121
+ :param limit: The maximum number of entries to return.
3122
+ :type limit: int, optional
3123
+ :param skip: The number of entries to skip., defaults to 0
3124
+ :type skip: int, optional
3125
+ :param page: The page number (i.e. skip limit*page entries)
3126
+ :type page: int, optional
3127
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3128
+ :type after_id: str, optional
3129
+ :param x_accept_feature:, defaults to []
3130
+ :type x_accept_feature: list[str], optional
3131
+ :param async_: Perform the request asynchronously
3132
+ :type async_: bool, optional
3133
+ :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
2851
3134
  """
2852
3135
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2853
3136
  kwargs['_return_http_data_only'] = True
@@ -2871,20 +3154,33 @@ class ContainersApi(object):
2871
3154
  Returns analyses that directly belong to this resource.
2872
3155
  This method makes a synchronous HTTP request by default.
2873
3156
 
2874
- :param str cid: (required)
2875
- :param bool inflate_job:
2876
- :param bool join_avatars:
2877
- :param JoinType join:
2878
- :param bool include_all_info: Include all info in returned objects
2879
- :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)
2880
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2881
- :param int limit: The maximum number of entries to return.
2882
- :param int skip: The number of entries to skip.
2883
- :param int page: The page number (i.e. skip limit*page entries)
2884
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2885
- :param list[str] x_accept_feature:
2886
- :param bool async_: Perform the request asynchronously
2887
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3157
+ :param cid:
3158
+ :type cid: str
3159
+ :param inflate_job:, defaults to false
3160
+ :type inflate_job: bool, optional
3161
+ :param join_avatars:, defaults to false
3162
+ :type join_avatars: bool, optional
3163
+ :param join:
3164
+ :type join: JoinType, optional
3165
+ :param include_all_info: Include all info in returned objects, defaults to false
3166
+ :type include_all_info: bool, optional
3167
+ :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)
3168
+ :type filter: str, optional
3169
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3170
+ :type sort: str, optional
3171
+ :param limit: The maximum number of entries to return.
3172
+ :type limit: int, optional
3173
+ :param skip: The number of entries to skip., defaults to 0
3174
+ :type skip: int, optional
3175
+ :param page: The page number (i.e. skip limit*page entries)
3176
+ :type page: int, optional
3177
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3178
+ :type after_id: str, optional
3179
+ :param x_accept_feature:, defaults to []
3180
+ :type x_accept_feature: list[str], optional
3181
+ :param async_: Perform the request asynchronously
3182
+ :type async_: bool, optional
3183
+ :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
2888
3184
  """
2889
3185
 
2890
3186
  all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -2976,13 +3272,19 @@ class ContainersApi(object):
2976
3272
  Get an analysis.
2977
3273
  This method makes a synchronous HTTP request by default.
2978
3274
 
2979
- :param str cid: (required)
2980
- :param str analysis_id: (required)
2981
- :param bool inflate_job: Return job as an object instead of an id
2982
- :param bool join_avatars:
2983
- :param JoinType join:
2984
- :param bool async_: Perform the request asynchronously
2985
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
3275
+ :param cid:
3276
+ :type cid: str
3277
+ :param analysis_id:
3278
+ :type analysis_id: str
3279
+ :param inflate_job: Return job as an object instead of an id, defaults to false
3280
+ :type inflate_job: bool, optional
3281
+ :param join_avatars:, defaults to false
3282
+ :type join_avatars: bool, optional
3283
+ :param join:
3284
+ :type join: JoinType, optional
3285
+ :param async_: Perform the request asynchronously
3286
+ :type async_: bool, optional
3287
+ :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
2986
3288
  """
2987
3289
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2988
3290
  kwargs['_return_http_data_only'] = True
@@ -3006,13 +3308,19 @@ class ContainersApi(object):
3006
3308
  Get an analysis.
3007
3309
  This method makes a synchronous HTTP request by default.
3008
3310
 
3009
- :param str cid: (required)
3010
- :param str analysis_id: (required)
3011
- :param bool inflate_job: Return job as an object instead of an id
3012
- :param bool join_avatars:
3013
- :param JoinType join:
3014
- :param bool async_: Perform the request asynchronously
3015
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
3311
+ :param cid:
3312
+ :type cid: str
3313
+ :param analysis_id:
3314
+ :type analysis_id: str
3315
+ :param inflate_job: Return job as an object instead of an id, defaults to false
3316
+ :type inflate_job: bool, optional
3317
+ :param join_avatars:, defaults to false
3318
+ :type join_avatars: bool, optional
3319
+ :param join:
3320
+ :type join: JoinType, optional
3321
+ :param async_: Perform the request asynchronously
3322
+ :type async_: bool, optional
3323
+ :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
3016
3324
  """
3017
3325
 
3018
3326
  all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
@@ -3093,10 +3401,13 @@ class ContainersApi(object):
3093
3401
  Get info for a particular file.
3094
3402
  This method makes a synchronous HTTP request by default.
3095
3403
 
3096
- :param str cid: Container Id (required)
3097
- :param str filename: (required)
3098
- :param bool async_: Perform the request asynchronously
3099
- :return: FileOutput
3404
+ :param cid: Container Id
3405
+ :type cid: str
3406
+ :param filename:
3407
+ :type filename: str
3408
+ :param async_: Perform the request asynchronously
3409
+ :type async_: bool, optional
3410
+ :rtype: FileOutput
3100
3411
  """
3101
3412
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3102
3413
  kwargs['_return_http_data_only'] = True
@@ -3120,10 +3431,13 @@ class ContainersApi(object):
3120
3431
  Get info for a particular file.
3121
3432
  This method makes a synchronous HTTP request by default.
3122
3433
 
3123
- :param str cid: Container Id (required)
3124
- :param str filename: (required)
3125
- :param bool async_: Perform the request asynchronously
3126
- :return: FileOutput
3434
+ :param cid: Container Id
3435
+ :type cid: str
3436
+ :param filename:
3437
+ :type filename: str
3438
+ :param async_: Perform the request asynchronously
3439
+ :type async_: bool, optional
3440
+ :rtype: FileOutput
3127
3441
  """
3128
3442
 
3129
3443
  all_params = ['cid','filename',] # noqa: E501
@@ -3198,10 +3512,13 @@ class ContainersApi(object):
3198
3512
  Get a note of a(n) container
3199
3513
  This method makes a synchronous HTTP request by default.
3200
3514
 
3201
- :param str cid: (required)
3202
- :param str note_id: (required)
3203
- :param bool async_: Perform the request asynchronously
3204
- :return: Note
3515
+ :param cid:
3516
+ :type cid: str
3517
+ :param note_id:
3518
+ :type note_id: str
3519
+ :param async_: Perform the request asynchronously
3520
+ :type async_: bool, optional
3521
+ :rtype: Note
3205
3522
  """
3206
3523
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3207
3524
  kwargs['_return_http_data_only'] = True
@@ -3225,10 +3542,13 @@ class ContainersApi(object):
3225
3542
  Get a note of a(n) container
3226
3543
  This method makes a synchronous HTTP request by default.
3227
3544
 
3228
- :param str cid: (required)
3229
- :param str note_id: (required)
3230
- :param bool async_: Perform the request asynchronously
3231
- :return: Note
3545
+ :param cid:
3546
+ :type cid: str
3547
+ :param note_id:
3548
+ :type note_id: str
3549
+ :param async_: Perform the request asynchronously
3550
+ :type async_: bool, optional
3551
+ :rtype: Note
3232
3552
  """
3233
3553
 
3234
3554
  all_params = ['cid','note_id',] # noqa: E501
@@ -3303,10 +3623,13 @@ class ContainersApi(object):
3303
3623
  Get the value of a tag, by name
3304
3624
  This method makes a synchronous HTTP request by default.
3305
3625
 
3306
- :param str cid: (required)
3307
- :param str value: The tag to interact with (required)
3308
- :param bool async_: Perform the request asynchronously
3309
- :return: str
3626
+ :param cid:
3627
+ :type cid: str
3628
+ :param value: The tag to interact with
3629
+ :type value: str
3630
+ :param async_: Perform the request asynchronously
3631
+ :type async_: bool, optional
3632
+ :rtype: str
3310
3633
  """
3311
3634
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3312
3635
  kwargs['_return_http_data_only'] = True
@@ -3330,10 +3653,13 @@ class ContainersApi(object):
3330
3653
  Get the value of a tag, by name
3331
3654
  This method makes a synchronous HTTP request by default.
3332
3655
 
3333
- :param str cid: (required)
3334
- :param str value: The tag to interact with (required)
3335
- :param bool async_: Perform the request asynchronously
3336
- :return: str
3656
+ :param cid:
3657
+ :type cid: str
3658
+ :param value: The tag to interact with
3659
+ :type value: str
3660
+ :param async_: Perform the request asynchronously
3661
+ :type async_: bool, optional
3662
+ :rtype: str
3337
3663
  """
3338
3664
 
3339
3665
  all_params = ['cid','value',] # noqa: E501
@@ -3408,16 +3734,25 @@ class ContainersApi(object):
3408
3734
  View all containers
3409
3735
  This method makes a synchronous HTTP request by default.
3410
3736
 
3411
- :param str container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view. (required)
3412
- :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)
3413
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3414
- :param int limit: The maximum number of entries to return.
3415
- :param int skip: The number of entries to skip.
3416
- :param int page: The page number (i.e. skip limit*page entries)
3417
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3418
- :param list[union[HeaderFeature,str]] x_accept_feature:
3419
- :param bool async_: Perform the request asynchronously
3420
- :return: union[Page,list[ViewOutput]]
3737
+ :param container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view.
3738
+ :type container_id: str
3739
+ :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)
3740
+ :type filter: str, optional
3741
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3742
+ :type sort: str, optional
3743
+ :param limit: The maximum number of entries to return.
3744
+ :type limit: int, optional
3745
+ :param skip: The number of entries to skip., defaults to 0
3746
+ :type skip: int, optional
3747
+ :param page: The page number (i.e. skip limit*page entries)
3748
+ :type page: int, optional
3749
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3750
+ :type after_id: str, optional
3751
+ :param x_accept_feature:, defaults to []
3752
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3753
+ :param async_: Perform the request asynchronously
3754
+ :type async_: bool, optional
3755
+ :rtype: union[Page,list[ViewOutput]]
3421
3756
  """
3422
3757
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3423
3758
  kwargs['_return_http_data_only'] = True
@@ -3441,16 +3776,25 @@ class ContainersApi(object):
3441
3776
  View all containers
3442
3777
  This method makes a synchronous HTTP request by default.
3443
3778
 
3444
- :param str container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view. (required)
3445
- :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)
3446
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3447
- :param int limit: The maximum number of entries to return.
3448
- :param int skip: The number of entries to skip.
3449
- :param int page: The page number (i.e. skip limit*page entries)
3450
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3451
- :param list[union[HeaderFeature,str]] x_accept_feature:
3452
- :param bool async_: Perform the request asynchronously
3453
- :return: union[Page,list[ViewOutput]]
3779
+ :param container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view.
3780
+ :type container_id: str
3781
+ :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)
3782
+ :type filter: str, optional
3783
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3784
+ :type sort: str, optional
3785
+ :param limit: The maximum number of entries to return.
3786
+ :type limit: int, optional
3787
+ :param skip: The number of entries to skip., defaults to 0
3788
+ :type skip: int, optional
3789
+ :param page: The page number (i.e. skip limit*page entries)
3790
+ :type page: int, optional
3791
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3792
+ :type after_id: str, optional
3793
+ :param x_accept_feature:, defaults to []
3794
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3795
+ :param async_: Perform the request asynchronously
3796
+ :type async_: bool, optional
3797
+ :rtype: union[Page,list[ViewOutput]]
3454
3798
  """
3455
3799
 
3456
3800
  all_params = ['container_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3534,10 +3878,13 @@ class ContainersApi(object):
3534
3878
  Modify Container
3535
3879
  This method makes a synchronous HTTP request by default.
3536
3880
 
3537
- :param str container_id: (required)
3538
- :param ContainerUpdate body: (required)
3539
- :param bool async_: Perform the request asynchronously
3540
- :return: ModifiedResult
3881
+ :param container_id:
3882
+ :type container_id: str
3883
+ :param body:
3884
+ :type body: ContainerUpdate
3885
+ :param async_: Perform the request asynchronously
3886
+ :type async_: bool, optional
3887
+ :rtype: ModifiedResult
3541
3888
  """
3542
3889
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3543
3890
  kwargs['_return_http_data_only'] = True
@@ -3561,10 +3908,13 @@ class ContainersApi(object):
3561
3908
  Modify Container
3562
3909
  This method makes a synchronous HTTP request by default.
3563
3910
 
3564
- :param str container_id: (required)
3565
- :param ContainerUpdate body: (required)
3566
- :param bool async_: Perform the request asynchronously
3567
- :return: ModifiedResult
3911
+ :param container_id:
3912
+ :type container_id: str
3913
+ :param body:
3914
+ :type body: ContainerUpdate
3915
+ :param async_: Perform the request asynchronously
3916
+ :type async_: bool, optional
3917
+ :rtype: ModifiedResult
3568
3918
  """
3569
3919
 
3570
3920
  all_params = ['container_id','body',] # noqa: E501
@@ -3650,11 +4000,15 @@ class ContainersApi(object):
3650
4000
  Modify an analysis.
3651
4001
  This method makes a synchronous HTTP request by default.
3652
4002
 
3653
- :param str cid: (required)
3654
- :param str analysis_id: (required)
3655
- :param AnalysisModifyInput body: (required)
3656
- :param bool async_: Perform the request asynchronously
3657
- :return: ModifiedResult
4003
+ :param cid:
4004
+ :type cid: str
4005
+ :param analysis_id:
4006
+ :type analysis_id: str
4007
+ :param body:
4008
+ :type body: AnalysisModifyInput
4009
+ :param async_: Perform the request asynchronously
4010
+ :type async_: bool, optional
4011
+ :rtype: ModifiedResult
3658
4012
  """
3659
4013
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3660
4014
  kwargs['_return_http_data_only'] = True
@@ -3678,11 +4032,15 @@ class ContainersApi(object):
3678
4032
  Modify an analysis.
3679
4033
  This method makes a synchronous HTTP request by default.
3680
4034
 
3681
- :param str cid: (required)
3682
- :param str analysis_id: (required)
3683
- :param AnalysisModifyInput body: (required)
3684
- :param bool async_: Perform the request asynchronously
3685
- :return: ModifiedResult
4035
+ :param cid:
4036
+ :type cid: str
4037
+ :param analysis_id:
4038
+ :type analysis_id: str
4039
+ :param body:
4040
+ :type body: AnalysisModifyInput
4041
+ :param async_: Perform the request asynchronously
4042
+ :type async_: bool, optional
4043
+ :rtype: ModifiedResult
3686
4044
  """
3687
4045
 
3688
4046
  all_params = ['cid','analysis_id','body',] # noqa: E501
@@ -3774,11 +4132,15 @@ class ContainersApi(object):
3774
4132
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
3775
4133
  This method makes a synchronous HTTP request by default.
3776
4134
 
3777
- :param str cid: (required)
3778
- :param str filename: (required)
3779
- :param FileModifyInput body: (required)
3780
- :param bool async_: Perform the request asynchronously
3781
- :return: ModifiedResult
4135
+ :param cid:
4136
+ :type cid: str
4137
+ :param filename:
4138
+ :type filename: str
4139
+ :param body:
4140
+ :type body: FileModifyInput
4141
+ :param async_: Perform the request asynchronously
4142
+ :type async_: bool, optional
4143
+ :rtype: ModifiedResult
3782
4144
  """
3783
4145
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3784
4146
  kwargs['_return_http_data_only'] = True
@@ -3802,11 +4164,15 @@ class ContainersApi(object):
3802
4164
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
3803
4165
  This method makes a synchronous HTTP request by default.
3804
4166
 
3805
- :param str cid: (required)
3806
- :param str filename: (required)
3807
- :param FileModifyInput body: (required)
3808
- :param bool async_: Perform the request asynchronously
3809
- :return: ModifiedResult
4167
+ :param cid:
4168
+ :type cid: str
4169
+ :param filename:
4170
+ :type filename: str
4171
+ :param body:
4172
+ :type body: FileModifyInput
4173
+ :param async_: Perform the request asynchronously
4174
+ :type async_: bool, optional
4175
+ :rtype: ModifiedResult
3810
4176
  """
3811
4177
 
3812
4178
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3898,11 +4264,15 @@ class ContainersApi(object):
3898
4264
  If replacing a file's classification, the modality can optionally be modified as well.
3899
4265
  This method makes a synchronous HTTP request by default.
3900
4266
 
3901
- :param str cid: (required)
3902
- :param str filename: (required)
3903
- :param FileClassificationDelta body: (required)
3904
- :param bool async_: Perform the request asynchronously
3905
- :return: ModifiedResult
4267
+ :param cid:
4268
+ :type cid: str
4269
+ :param filename:
4270
+ :type filename: str
4271
+ :param body:
4272
+ :type body: FileClassificationDelta
4273
+ :param async_: Perform the request asynchronously
4274
+ :type async_: bool, optional
4275
+ :rtype: ModifiedResult
3906
4276
  """
3907
4277
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3908
4278
  kwargs['_return_http_data_only'] = True
@@ -3926,11 +4296,15 @@ class ContainersApi(object):
3926
4296
  If replacing a file's classification, the modality can optionally be modified as well.
3927
4297
  This method makes a synchronous HTTP request by default.
3928
4298
 
3929
- :param str cid: (required)
3930
- :param str filename: (required)
3931
- :param FileClassificationDelta body: (required)
3932
- :param bool async_: Perform the request asynchronously
3933
- :return: ModifiedResult
4299
+ :param cid:
4300
+ :type cid: str
4301
+ :param filename:
4302
+ :type filename: str
4303
+ :param body:
4304
+ :type body: FileClassificationDelta
4305
+ :param async_: Perform the request asynchronously
4306
+ :type async_: bool, optional
4307
+ :rtype: ModifiedResult
3934
4308
  """
3935
4309
 
3936
4310
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4022,11 +4396,15 @@ class ContainersApi(object):
4022
4396
  Modify and return the file 'info' field
4023
4397
  This method makes a synchronous HTTP request by default.
4024
4398
 
4025
- :param str cid: (required)
4026
- :param str filename: (required)
4027
- :param Info body: (required)
4028
- :param bool async_: Perform the request asynchronously
4029
- :return: ModifiedResult
4399
+ :param cid:
4400
+ :type cid: str
4401
+ :param filename:
4402
+ :type filename: str
4403
+ :param body:
4404
+ :type body: Info
4405
+ :param async_: Perform the request asynchronously
4406
+ :type async_: bool, optional
4407
+ :rtype: ModifiedResult
4030
4408
  """
4031
4409
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4032
4410
  kwargs['_return_http_data_only'] = True
@@ -4050,11 +4428,15 @@ class ContainersApi(object):
4050
4428
  Modify and return the file 'info' field
4051
4429
  This method makes a synchronous HTTP request by default.
4052
4430
 
4053
- :param str cid: (required)
4054
- :param str filename: (required)
4055
- :param Info body: (required)
4056
- :param bool async_: Perform the request asynchronously
4057
- :return: ModifiedResult
4431
+ :param cid:
4432
+ :type cid: str
4433
+ :param filename:
4434
+ :type filename: str
4435
+ :param body:
4436
+ :type body: Info
4437
+ :param async_: Perform the request asynchronously
4438
+ :type async_: bool, optional
4439
+ :rtype: ModifiedResult
4058
4440
  """
4059
4441
 
4060
4442
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4146,10 +4528,13 @@ class ContainersApi(object):
4146
4528
  Update or replace info for a(n) container. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4147
4529
  This method makes a synchronous HTTP request by default.
4148
4530
 
4149
- :param str cid: (required)
4150
- :param Info body: (required)
4151
- :param bool async_: Perform the request asynchronously
4152
- :return: ModifiedResult
4531
+ :param cid:
4532
+ :type cid: str
4533
+ :param body:
4534
+ :type body: Info
4535
+ :param async_: Perform the request asynchronously
4536
+ :type async_: bool, optional
4537
+ :rtype: ModifiedResult
4153
4538
  """
4154
4539
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4155
4540
  kwargs['_return_http_data_only'] = True
@@ -4173,10 +4558,13 @@ class ContainersApi(object):
4173
4558
  Update or replace info for a(n) container. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4174
4559
  This method makes a synchronous HTTP request by default.
4175
4560
 
4176
- :param str cid: (required)
4177
- :param Info body: (required)
4178
- :param bool async_: Perform the request asynchronously
4179
- :return: ModifiedResult
4561
+ :param cid:
4562
+ :type cid: str
4563
+ :param body:
4564
+ :type body: Info
4565
+ :param async_: Perform the request asynchronously
4566
+ :type async_: bool, optional
4567
+ :rtype: ModifiedResult
4180
4568
  """
4181
4569
 
4182
4570
  all_params = ['cid','body',] # noqa: E501
@@ -4262,11 +4650,15 @@ class ContainersApi(object):
4262
4650
  Update a note of a(n) container
4263
4651
  This method makes a synchronous HTTP request by default.
4264
4652
 
4265
- :param str cid: (required)
4266
- :param str note_id: (required)
4267
- :param NoteInput body: (required)
4268
- :param bool async_: Perform the request asynchronously
4269
- :return: int
4653
+ :param cid:
4654
+ :type cid: str
4655
+ :param note_id:
4656
+ :type note_id: str
4657
+ :param body:
4658
+ :type body: NoteInput
4659
+ :param async_: Perform the request asynchronously
4660
+ :type async_: bool, optional
4661
+ :rtype: int
4270
4662
  """
4271
4663
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4272
4664
  kwargs['_return_http_data_only'] = True
@@ -4290,11 +4682,15 @@ class ContainersApi(object):
4290
4682
  Update a note of a(n) container
4291
4683
  This method makes a synchronous HTTP request by default.
4292
4684
 
4293
- :param str cid: (required)
4294
- :param str note_id: (required)
4295
- :param NoteInput body: (required)
4296
- :param bool async_: Perform the request asynchronously
4297
- :return: int
4685
+ :param cid:
4686
+ :type cid: str
4687
+ :param note_id:
4688
+ :type note_id: str
4689
+ :param body:
4690
+ :type body: NoteInput
4691
+ :param async_: Perform the request asynchronously
4692
+ :type async_: bool, optional
4693
+ :rtype: int
4298
4694
  """
4299
4695
 
4300
4696
  all_params = ['cid','note_id','body',] # noqa: E501
@@ -4386,11 +4782,15 @@ class ContainersApi(object):
4386
4782
  Rename a tag
4387
4783
  This method makes a synchronous HTTP request by default.
4388
4784
 
4389
- :param str cid: (required)
4390
- :param str value: The tag to interact with (required)
4391
- :param Tag body: (required)
4392
- :param bool async_: Perform the request asynchronously
4393
- :return: str
4785
+ :param cid:
4786
+ :type cid: str
4787
+ :param value: The tag to interact with
4788
+ :type value: str
4789
+ :param body:
4790
+ :type body: Tag
4791
+ :param async_: Perform the request asynchronously
4792
+ :type async_: bool, optional
4793
+ :rtype: str
4394
4794
  """
4395
4795
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4396
4796
  kwargs['_return_http_data_only'] = True
@@ -4414,11 +4814,15 @@ class ContainersApi(object):
4414
4814
  Rename a tag
4415
4815
  This method makes a synchronous HTTP request by default.
4416
4816
 
4417
- :param str cid: (required)
4418
- :param str value: The tag to interact with (required)
4419
- :param Tag body: (required)
4420
- :param bool async_: Perform the request asynchronously
4421
- :return: str
4817
+ :param cid:
4818
+ :type cid: str
4819
+ :param value: The tag to interact with
4820
+ :type value: str
4821
+ :param body:
4822
+ :type body: Tag
4823
+ :param async_: Perform the request asynchronously
4824
+ :type async_: bool, optional
4825
+ :rtype: str
4422
4826
  """
4423
4827
 
4424
4828
  all_params = ['cid','value','body',] # noqa: E501
@@ -4510,18 +4914,29 @@ class ContainersApi(object):
4510
4914
  Upload a file to a(n) container.
4511
4915
  This method makes a synchronous HTTP request by default.
4512
4916
 
4513
- :param str container_id: (required)
4514
- :param str file: The file to upload (required)
4515
- :param bool preserve_metadata:
4516
- :param str ticket:
4517
- :param str id:
4518
- :param ContainerType level:
4519
- :param str job:
4520
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4521
- :param list[str] x_accept_feature: redirect header
4522
- :param str content_type:
4523
- :param bool async_: Perform the request asynchronously
4524
- :return: union[list[FileOutput],UploadTicketOutput]
4917
+ :param container_id:
4918
+ :type container_id: str
4919
+ :param file: The file to upload
4920
+ :type file: str
4921
+ :param preserve_metadata:, defaults to false
4922
+ :type preserve_metadata: bool, optional
4923
+ :param ticket:
4924
+ :type ticket: str, optional
4925
+ :param id:
4926
+ :type id: str, optional
4927
+ :param level:
4928
+ :type level: ContainerType, optional
4929
+ :param job:
4930
+ :type job: str, optional
4931
+ :param metadata: Dictionary of file metadata (type, modality, info, etc.)
4932
+ :type metadata: object, optional
4933
+ :param x_accept_feature: redirect header, defaults to []
4934
+ :type x_accept_feature: list[str], optional
4935
+ :param content_type:
4936
+ :type content_type: str, optional
4937
+ :param async_: Perform the request asynchronously
4938
+ :type async_: bool, optional
4939
+ :rtype: union[list[FileOutput],UploadTicketOutput]
4525
4940
  """
4526
4941
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4527
4942
  kwargs['_return_http_data_only'] = True
@@ -4545,18 +4960,29 @@ class ContainersApi(object):
4545
4960
  Upload a file to a(n) container.
4546
4961
  This method makes a synchronous HTTP request by default.
4547
4962
 
4548
- :param str container_id: (required)
4549
- :param str file: The file to upload (required)
4550
- :param bool preserve_metadata:
4551
- :param str ticket:
4552
- :param str id:
4553
- :param ContainerType level:
4554
- :param str job:
4555
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4556
- :param list[str] x_accept_feature: redirect header
4557
- :param str content_type:
4558
- :param bool async_: Perform the request asynchronously
4559
- :return: union[list[FileOutput],UploadTicketOutput]
4963
+ :param container_id:
4964
+ :type container_id: str
4965
+ :param file: The file to upload
4966
+ :type file: str
4967
+ :param preserve_metadata:, defaults to false
4968
+ :type preserve_metadata: bool, optional
4969
+ :param ticket:
4970
+ :type ticket: str, optional
4971
+ :param id:
4972
+ :type id: str, optional
4973
+ :param level:
4974
+ :type level: ContainerType, optional
4975
+ :param job:
4976
+ :type job: str, optional
4977
+ :param metadata: Dictionary of file metadata (type, modality, info, etc.)
4978
+ :type metadata: object, optional
4979
+ :param x_accept_feature: redirect header, defaults to []
4980
+ :type x_accept_feature: list[str], optional
4981
+ :param content_type:
4982
+ :type content_type: str, optional
4983
+ :param async_: Perform the request asynchronously
4984
+ :type async_: bool, optional
4985
+ :rtype: union[list[FileOutput],UploadTicketOutput]
4560
4986
  """
4561
4987
 
4562
4988
  all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
@@ -4652,16 +5078,25 @@ class ContainersApi(object):
4652
5078
  Upload an output file to an analysis
4653
5079
  This method makes a synchronous HTTP request by default.
4654
5080
 
4655
- :param str cid: (required)
4656
- :param str analysis_id: (required)
4657
- :param str file: The file to upload (required)
4658
- :param str ticket:
4659
- :param str id:
4660
- :param ContainerType level:
4661
- :param str job:
4662
- :param str content_type:
4663
- :param bool async_: Perform the request asynchronously
4664
- :return: list[FileOutput]
5081
+ :param cid:
5082
+ :type cid: str
5083
+ :param analysis_id:
5084
+ :type analysis_id: str
5085
+ :param file: The file to upload
5086
+ :type file: str
5087
+ :param ticket:
5088
+ :type ticket: str, optional
5089
+ :param id:
5090
+ :type id: str, optional
5091
+ :param level:
5092
+ :type level: ContainerType, optional
5093
+ :param job:
5094
+ :type job: str, optional
5095
+ :param content_type:
5096
+ :type content_type: str, optional
5097
+ :param async_: Perform the request asynchronously
5098
+ :type async_: bool, optional
5099
+ :rtype: list[FileOutput]
4665
5100
  """
4666
5101
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4667
5102
  kwargs['_return_http_data_only'] = True
@@ -4685,16 +5120,25 @@ class ContainersApi(object):
4685
5120
  Upload an output file to an analysis
4686
5121
  This method makes a synchronous HTTP request by default.
4687
5122
 
4688
- :param str cid: (required)
4689
- :param str analysis_id: (required)
4690
- :param str file: The file to upload (required)
4691
- :param str ticket:
4692
- :param str id:
4693
- :param ContainerType level:
4694
- :param str job:
4695
- :param str content_type:
4696
- :param bool async_: Perform the request asynchronously
4697
- :return: list[FileOutput]
5123
+ :param cid:
5124
+ :type cid: str
5125
+ :param analysis_id:
5126
+ :type analysis_id: str
5127
+ :param file: The file to upload
5128
+ :type file: str
5129
+ :param ticket:
5130
+ :type ticket: str, optional
5131
+ :param id:
5132
+ :type id: str, optional
5133
+ :param level:
5134
+ :type level: ContainerType, optional
5135
+ :param job:
5136
+ :type job: str, optional
5137
+ :param content_type:
5138
+ :type content_type: str, optional
5139
+ :param async_: Perform the request asynchronously
5140
+ :type async_: bool, optional
5141
+ :rtype: list[FileOutput]
4698
5142
  """
4699
5143
 
4700
5144
  all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501