flywheel-sdk 21.4.0__py3-none-any.whl → 21.4.0rc0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (532) hide show
  1. flywheel/api/acquisitions_api.py +562 -1033
  2. flywheel/api/analyses_api.py +425 -786
  3. flywheel/api/audit_trail_api.py +44 -78
  4. flywheel/api/auth_api.py +4 -6
  5. flywheel/api/batch_api.py +36 -60
  6. flywheel/api/bulk_api.py +6 -10
  7. flywheel/api/change_log_api.py +22 -40
  8. flywheel/api/collections_api.py +403 -740
  9. flywheel/api/config_api.py +12 -18
  10. flywheel/api/container_tasks_api.py +8 -14
  11. flywheel/api/container_type_api.py +8 -14
  12. flywheel/api/containers_api.py +538 -989
  13. flywheel/api/custom_filters_api.py +36 -64
  14. flywheel/api/data_view_executions_api.py +52 -94
  15. flywheel/api/dataexplorer_api.py +90 -158
  16. flywheel/api/devices_api.py +76 -132
  17. flywheel/api/dimse_api.py +44 -72
  18. flywheel/api/download_api.py +25 -46
  19. flywheel/api/files_api.py +150 -266
  20. flywheel/api/form_responses_api.py +56 -100
  21. flywheel/api/gears_api.py +156 -278
  22. flywheel/api/groups_api.py +238 -426
  23. flywheel/api/jobs_api.py +166 -288
  24. flywheel/api/jupyterlab_servers_api.py +14 -24
  25. flywheel/api/modalities_api.py +44 -78
  26. flywheel/api/packfiles_api.py +4 -6
  27. flywheel/api/projects_api.py +854 -1565
  28. flywheel/api/protocols_api.py +54 -94
  29. flywheel/api/reports_api.py +108 -196
  30. flywheel/api/resolve_api.py +26 -48
  31. flywheel/api/roles_api.py +46 -82
  32. flywheel/api/sessions_api.py +616 -1137
  33. flywheel/api/site_api.py +106 -182
  34. flywheel/api/staffing_pools_api.py +50 -88
  35. flywheel/api/subjects_api.py +596 -1095
  36. flywheel/api/tasks_api.py +62 -108
  37. flywheel/api/tree_api.py +28 -52
  38. flywheel/api/uids_api.py +6 -10
  39. flywheel/api/upload_api.py +88 -162
  40. flywheel/api/users_api.py +228 -418
  41. flywheel/api/views_api.py +120 -222
  42. flywheel/api_client.py +1 -1
  43. flywheel/configuration.py +2 -2
  44. flywheel/flywheel.py +4422 -811
  45. flywheel/models/access_permission.py +7 -13
  46. flywheel/models/access_permission_output.py +7 -13
  47. flywheel/models/access_permission_update.py +4 -8
  48. flywheel/models/acquisition_copy_input.py +10 -18
  49. flywheel/models/acquisition_input.py +19 -33
  50. flywheel/models/acquisition_list_output.py +70 -118
  51. flywheel/models/acquisition_modify_input.py +19 -33
  52. flywheel/models/acquisition_output.py +70 -118
  53. flywheel/models/acquisition_parents.py +13 -23
  54. flywheel/models/acquisition_template_options.py +16 -28
  55. flywheel/models/acquisition_upsert_input.py +28 -48
  56. flywheel/models/acquisition_upsert_output.py +13 -23
  57. flywheel/models/adhoc_analysis_input.py +13 -23
  58. flywheel/models/analysis_files_create_ticket_output.py +13 -23
  59. flywheel/models/analysis_input.py +19 -33
  60. flywheel/models/analysis_list_output.py +61 -103
  61. flywheel/models/analysis_list_output_inflated_job.py +58 -98
  62. flywheel/models/analysis_modify_input.py +7 -13
  63. flywheel/models/analysis_output.py +61 -103
  64. flywheel/models/analysis_output_inflated_job.py +61 -103
  65. flywheel/models/analysis_parents.py +16 -28
  66. flywheel/models/api_key_input_with_optional_label.py +7 -13
  67. flywheel/models/api_key_output.py +19 -33
  68. flywheel/models/as_storage.py +19 -33
  69. flywheel/models/assignee.py +7 -13
  70. flywheel/models/audit_trail_report.py +40 -68
  71. flywheel/models/auth0_auth_out.py +22 -38
  72. flywheel/models/auth0_options_out.py +22 -38
  73. flywheel/models/auth_out.py +19 -33
  74. flywheel/models/auth_session_output.py +16 -28
  75. flywheel/models/avatars.py +10 -18
  76. flywheel/models/aws_creds.py +7 -13
  77. flywheel/models/aws_storage.py +25 -43
  78. flywheel/models/azure_creds.py +7 -13
  79. flywheel/models/base_aet.py +13 -23
  80. flywheel/models/base_compute.py +34 -58
  81. flywheel/models/batch.py +25 -43
  82. flywheel/models/batch_create_filters.py +10 -18
  83. flywheel/models/batch_job_analysis_input.py +16 -28
  84. flywheel/models/bookmark.py +7 -13
  85. flywheel/models/bulk_move_input.py +16 -28
  86. flywheel/models/cancelled_batch_output.py +4 -8
  87. flywheel/models/catalog_list_output.py +31 -53
  88. flywheel/models/central_out.py +19 -33
  89. flywheel/models/change.py +31 -53
  90. flywheel/models/change_log_document.py +13 -23
  91. flywheel/models/classic_batch_job_output.py +25 -43
  92. flywheel/models/classic_batch_job_output_inflated_jobs.py +28 -48
  93. flywheel/models/classic_batch_proposal_input.py +28 -48
  94. flywheel/models/classic_batch_proposal_output.py +37 -63
  95. flywheel/models/collection_input.py +10 -18
  96. flywheel/models/collection_input_with_contents.py +13 -23
  97. flywheel/models/collection_node.py +7 -13
  98. flywheel/models/collection_operation.py +7 -13
  99. flywheel/models/collection_output.py +55 -93
  100. flywheel/models/collection_with_stats.py +55 -93
  101. flywheel/models/column.py +16 -28
  102. flywheel/models/common_classification.py +1 -3
  103. flywheel/models/common_info.py +1 -3
  104. flywheel/models/complete_multipart_upload_output.py +7 -13
  105. flywheel/models/complete_s3_multipart_upload_input.py +13 -23
  106. flywheel/models/config_out.py +28 -48
  107. flywheel/models/container_filter.py +7 -13
  108. flywheel/models/container_id_view_input.py +43 -73
  109. flywheel/models/container_id_view_input_execute_and_save.py +19 -33
  110. flywheel/models/container_modify.py +43 -73
  111. flywheel/models/container_node_min.py +25 -43
  112. flywheel/models/container_output_with_files.py +16 -28
  113. flywheel/models/container_parents.py +19 -33
  114. flywheel/models/container_pipeline_input.py +43 -73
  115. flywheel/models/container_reference.py +7 -13
  116. flywheel/models/container_reference_with_label.py +10 -18
  117. flywheel/models/container_uidcheck.py +13 -23
  118. flywheel/models/container_update.py +1 -3
  119. flywheel/models/context_input.py +10 -18
  120. flywheel/models/copy_filter.py +19 -33
  121. flywheel/models/core_models_api_key_api_key_input.py +7 -13
  122. flywheel/models/core_models_audit_trail_create_report_input.py +16 -28
  123. flywheel/models/core_models_audit_trail_modify_report_input.py +4 -8
  124. flywheel/models/core_models_common_source.py +7 -13
  125. flywheel/models/core_models_jobs_api_key_input.py +7 -13
  126. flywheel/models/core_workflows_form_responses_models_form_parents.py +19 -33
  127. flywheel/models/core_workflows_form_responses_models_form_response_output.py +34 -58
  128. flywheel/models/core_workflows_reader_models_reader_task_parents.py +19 -33
  129. flywheel/models/creds.py +1 -3
  130. flywheel/models/curator.py +10 -18
  131. flywheel/models/current_user_output.py +64 -108
  132. flywheel/models/custom_field.py +34 -58
  133. flywheel/models/custom_form.py +13 -23
  134. flywheel/models/cvat_info.py +16 -28
  135. flywheel/models/cvat_settings.py +16 -28
  136. flywheel/models/cvat_settings_input.py +16 -28
  137. flywheel/models/daily_report_usage.py +46 -78
  138. flywheel/models/data_view_analysis_file_spec.py +10 -18
  139. flywheel/models/data_view_analysis_filter_spec.py +10 -18
  140. flywheel/models/data_view_column_alias.py +22 -38
  141. flywheel/models/data_view_column_spec.py +16 -28
  142. flywheel/models/data_view_execution.py +40 -68
  143. flywheel/models/data_view_file_spec.py +28 -48
  144. flywheel/models/data_view_group_by.py +4 -8
  145. flywheel/models/data_view_group_by_column.py +7 -13
  146. flywheel/models/data_view_name_filter_spec.py +7 -13
  147. flywheel/models/data_view_zip_filter_spec.py +10 -18
  148. flywheel/models/delete_by_search_query.py +13 -23
  149. flywheel/models/deleted_file.py +43 -73
  150. flywheel/models/deleted_result.py +10 -18
  151. flywheel/models/device.py +34 -58
  152. flywheel/models/device_admin_update.py +7 -13
  153. flywheel/models/device_create.py +10 -18
  154. flywheel/models/device_self_update.py +16 -28
  155. flywheel/models/device_status_entry.py +10 -18
  156. flywheel/models/device_storage_strategy_update.py +7 -13
  157. flywheel/models/download.py +13 -23
  158. flywheel/models/download_container_filter.py +4 -8
  159. flywheel/models/download_container_filter_definition.py +10 -18
  160. flywheel/models/download_filter.py +10 -18
  161. flywheel/models/download_filter_definition.py +7 -13
  162. flywheel/models/download_node.py +7 -13
  163. flywheel/models/download_ticket_stub.py +13 -23
  164. flywheel/models/e_signature.py +13 -23
  165. flywheel/models/edition.py +4 -8
  166. flywheel/models/egress_device.py +52 -88
  167. flywheel/models/egress_device_page.py +10 -18
  168. flywheel/models/egress_provider.py +31 -53
  169. flywheel/models/egress_provider_id.py +4 -8
  170. flywheel/models/exchange_storage.py +13 -23
  171. flywheel/models/executor_info.py +25 -43
  172. flywheel/models/export_templates.py +7 -13
  173. flywheel/models/features.py +193 -323
  174. flywheel/models/field_change.py +16 -28
  175. flywheel/models/field_change_log_document.py +13 -23
  176. flywheel/models/file.py +112 -188
  177. flywheel/models/file_classification_delta.py +13 -23
  178. flywheel/models/file_entry.py +64 -108
  179. flywheel/models/file_export_templates.py +16 -28
  180. flywheel/models/file_gear_info.py +10 -18
  181. flywheel/models/file_list_output.py +109 -183
  182. flywheel/models/file_modify_input.py +7 -13
  183. flywheel/models/file_move_input.py +10 -18
  184. flywheel/models/file_node.py +112 -188
  185. flywheel/models/file_node_min.py +22 -38
  186. flywheel/models/file_origin.py +16 -28
  187. flywheel/models/file_output.py +109 -183
  188. flywheel/models/file_parents.py +19 -33
  189. flywheel/models/file_reference.py +10 -18
  190. flywheel/models/file_suggestion.py +13 -23
  191. flywheel/models/file_template_options.py +19 -33
  192. flywheel/models/file_upsert_input.py +52 -88
  193. flywheel/models/file_upsert_output.py +112 -188
  194. flywheel/models/file_version.py +7 -13
  195. flywheel/models/file_version_copy_of.py +16 -28
  196. flywheel/models/file_version_output.py +22 -38
  197. flywheel/models/file_via.py +13 -23
  198. flywheel/models/filter.py +25 -43
  199. flywheel/models/filter_input.py +10 -18
  200. flywheel/models/filter_values.py +7 -13
  201. flywheel/models/fixed_file_version_input.py +10 -18
  202. flywheel/models/fixed_input.py +19 -33
  203. flywheel/models/form_definition.py +4 -8
  204. flywheel/models/form_response_base.py +19 -33
  205. flywheel/models/form_response_create.py +7 -13
  206. flywheel/models/gcp_creds.py +31 -53
  207. flywheel/models/gcp_storage.py +19 -33
  208. flywheel/models/gear.py +52 -88
  209. flywheel/models/gear_config.py +1 -3
  210. flywheel/models/gear_context_input.py +4 -8
  211. flywheel/models/gear_context_value_output.py +16 -28
  212. flywheel/models/gear_context_value_output_unfound.py +4 -8
  213. flywheel/models/gear_custom.py +1 -3
  214. flywheel/models/gear_directive.py +1 -3
  215. flywheel/models/gear_document.py +22 -38
  216. flywheel/models/gear_document_input.py +19 -33
  217. flywheel/models/gear_document_legacy_input.py +19 -33
  218. flywheel/models/gear_environment.py +1 -3
  219. flywheel/models/gear_exchange.py +10 -18
  220. flywheel/models/gear_file_input.py +7 -13
  221. flywheel/models/gear_id_output.py +4 -8
  222. flywheel/models/gear_info.py +13 -23
  223. flywheel/models/gear_input_item.py +10 -18
  224. flywheel/models/gear_inputs.py +1 -3
  225. flywheel/models/gear_key_input.py +7 -13
  226. flywheel/models/gear_manifest.py +55 -93
  227. flywheel/models/gear_node.py +25 -43
  228. flywheel/models/gear_output_configuration.py +4 -8
  229. flywheel/models/gear_permissions.py +7 -13
  230. flywheel/models/gear_permissions_input.py +4 -8
  231. flywheel/models/gear_rule.py +61 -103
  232. flywheel/models/gear_rule_condition.py +10 -18
  233. flywheel/models/gear_rule_input.py +46 -78
  234. flywheel/models/gear_rule_modify_input.py +43 -73
  235. flywheel/models/gear_rule_output.py +61 -103
  236. flywheel/models/gear_save_submission.py +10 -18
  237. flywheel/models/gear_series.py +19 -33
  238. flywheel/models/gear_series_update.py +4 -8
  239. flywheel/models/gear_suggestion_output.py +19 -33
  240. flywheel/models/gear_ticket.py +13 -23
  241. flywheel/models/gear_ticket_output.py +4 -8
  242. flywheel/models/graph_filter.py +22 -38
  243. flywheel/models/group_by.py +4 -8
  244. flywheel/models/group_input.py +13 -23
  245. flywheel/models/group_output.py +37 -63
  246. flywheel/models/group_report.py +10 -18
  247. flywheel/models/group_role.py +4 -8
  248. flywheel/models/group_settings_output.py +13 -23
  249. flywheel/models/group_update.py +13 -23
  250. flywheel/models/hierarchy_export_templates.py +16 -28
  251. flywheel/models/http_validation_error.py +4 -8
  252. flywheel/models/info.py +10 -18
  253. flywheel/models/ingress_provider.py +19 -33
  254. flywheel/models/ingress_providers.py +16 -28
  255. flywheel/models/ingress_site_settings.py +16 -28
  256. flywheel/models/ingress_update_provider.py +10 -18
  257. flywheel/models/inline_response200.py +4 -8
  258. flywheel/models/inline_response2001.py +4 -8
  259. flywheel/models/inline_response2002.py +4 -8
  260. flywheel/models/input_filter.py +10 -18
  261. flywheel/models/input_job.py +43 -73
  262. flywheel/models/input_job_profile.py +16 -28
  263. flywheel/models/inserted_id.py +4 -8
  264. flywheel/models/job.py +76 -128
  265. flywheel/models/job_analysis_input.py +16 -28
  266. flywheel/models/job_ask.py +19 -33
  267. flywheel/models/job_ask_response.py +7 -13
  268. flywheel/models/job_ask_response_job.py +94 -158
  269. flywheel/models/job_ask_return_criteria.py +13 -23
  270. flywheel/models/job_ask_state_response.py +4 -8
  271. flywheel/models/job_complete.py +10 -18
  272. flywheel/models/job_config.py +1 -3
  273. flywheel/models/job_config_input.py +16 -28
  274. flywheel/models/job_destination.py +7 -13
  275. flywheel/models/job_detail.py +88 -148
  276. flywheel/models/job_detail_container.py +7 -13
  277. flywheel/models/job_detail_file_entry.py +7 -13
  278. flywheel/models/job_detail_group.py +7 -13
  279. flywheel/models/job_detail_parent_info.py +19 -33
  280. flywheel/models/job_executor_info.py +25 -43
  281. flywheel/models/job_file_input.py +13 -23
  282. flywheel/models/job_file_input_list_output.py +13 -23
  283. flywheel/models/job_file_object.py +34 -58
  284. flywheel/models/job_file_object_list_output.py +31 -53
  285. flywheel/models/job_inputs_array_item.py +19 -33
  286. flywheel/models/job_inputs_item.py +13 -23
  287. flywheel/models/job_inputs_object.py +1 -3
  288. flywheel/models/job_list_output.py +94 -158
  289. flywheel/models/job_list_output_config.py +10 -18
  290. flywheel/models/job_log.py +7 -13
  291. flywheel/models/job_log_record.py +7 -13
  292. flywheel/models/job_modify.py +7 -13
  293. flywheel/models/job_origin.py +7 -13
  294. flywheel/models/job_output.py +97 -163
  295. flywheel/models/job_output_config.py +13 -23
  296. flywheel/models/job_parents.py +19 -33
  297. flywheel/models/job_priority_update.py +7 -13
  298. flywheel/models/job_profile.py +31 -53
  299. flywheel/models/job_request.py +10 -18
  300. flywheel/models/job_request_item.py +13 -23
  301. flywheel/models/job_request_target.py +16 -28
  302. flywheel/models/job_ticket_output.py +4 -8
  303. flywheel/models/job_transition_times.py +13 -23
  304. flywheel/models/job_version_info.py +1 -3
  305. flywheel/models/jobs_by_state.py +16 -28
  306. flywheel/models/jobs_list.py +4 -8
  307. flywheel/models/join_origin_device.py +4 -8
  308. flywheel/models/join_origin_job.py +10 -18
  309. flywheel/models/join_origin_user.py +7 -13
  310. flywheel/models/join_origins.py +10 -18
  311. flywheel/models/jupyterhub_workspace.py +4 -8
  312. flywheel/models/jupyterlab_server_modify.py +16 -28
  313. flywheel/models/jupyterlab_server_response.py +31 -53
  314. flywheel/models/ldap_sync_config.py +4 -8
  315. flywheel/models/ldap_sync_status.py +13 -23
  316. flywheel/models/legacy_api_key_output.py +16 -28
  317. flywheel/models/legacy_input.py +13 -23
  318. flywheel/models/legacy_usage_report.py +19 -33
  319. flywheel/models/legacys_usage_project_entry.py +7 -13
  320. flywheel/models/libs_viewer_config_models_viewer_config.py +7 -13
  321. flywheel/models/local_storage.py +10 -18
  322. flywheel/models/location.py +7 -13
  323. flywheel/models/locked.py +10 -18
  324. flywheel/models/master_subject_code_dob_input.py +16 -28
  325. flywheel/models/master_subject_code_input.py +16 -28
  326. flywheel/models/master_subject_code_output.py +4 -8
  327. flywheel/models/matched_acquisition_output.py +43 -73
  328. flywheel/models/measurement_config.py +10 -18
  329. flywheel/models/measurement_item_config.py +10 -18
  330. flywheel/models/mfa_settings.py +4 -8
  331. flywheel/models/ml_set_filter.py +7 -13
  332. flywheel/models/modality.py +13 -23
  333. flywheel/models/modality_input.py +13 -23
  334. flywheel/models/modality_modify.py +10 -18
  335. flywheel/models/modality_output.py +16 -28
  336. flywheel/models/modified_result.py +7 -13
  337. flywheel/models/modify_user_input.py +37 -63
  338. flywheel/models/move_conflict.py +19 -33
  339. flywheel/models/note.py +28 -48
  340. flywheel/models/note_input.py +4 -8
  341. flywheel/models/origin.py +7 -13
  342. flywheel/models/orphaned_count.py +4 -8
  343. flywheel/models/output_user_page.py +10 -18
  344. flywheel/models/packfile_cleanup_output.py +4 -8
  345. flywheel/models/packfile_removed_output.py +7 -13
  346. flywheel/models/page.py +10 -18
  347. flywheel/models/page_generic_file_output.py +10 -18
  348. flywheel/models/page_generic_filter.py +10 -18
  349. flywheel/models/page_generic_form_response_output.py +10 -18
  350. flywheel/models/page_generic_protocol.py +13 -23
  351. flywheel/models/page_generic_reader_task_output.py +13 -23
  352. flywheel/models/page_generic_staffing_pool.py +13 -23
  353. flywheel/models/parsed_query_response.py +7 -13
  354. flywheel/models/premade_jobs_batch_job_output.py +19 -33
  355. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +19 -33
  356. flywheel/models/premade_jobs_batch_proposal.py +22 -38
  357. flywheel/models/premade_jobs_batch_proposal_detail.py +4 -8
  358. flywheel/models/premade_jobs_batch_proposal_input.py +4 -8
  359. flywheel/models/project_aet.py +22 -38
  360. flywheel/models/project_aet_input.py +13 -23
  361. flywheel/models/project_contact.py +7 -13
  362. flywheel/models/project_copy_input.py +13 -23
  363. flywheel/models/project_copy_output.py +10 -18
  364. flywheel/models/project_counters.py +28 -48
  365. flywheel/models/project_delete_status_output.py +7 -13
  366. flywheel/models/project_group_info.py +7 -13
  367. flywheel/models/project_hierarchy_input.py +16 -28
  368. flywheel/models/project_hierarchy_output.py +10 -18
  369. flywheel/models/project_input.py +28 -48
  370. flywheel/models/project_institution.py +7 -13
  371. flywheel/models/project_list_output.py +94 -158
  372. flywheel/models/project_modify.py +37 -63
  373. flywheel/models/project_output.py +94 -158
  374. flywheel/models/project_parents.py +4 -8
  375. flywheel/models/project_report.py +37 -63
  376. flywheel/models/project_report_list.py +4 -8
  377. flywheel/models/project_settings_input.py +22 -38
  378. flywheel/models/project_settings_output.py +22 -38
  379. flywheel/models/project_settings_sharing.py +22 -38
  380. flywheel/models/project_settings_sharing_input.py +22 -38
  381. flywheel/models/project_settings_workspaces.py +4 -8
  382. flywheel/models/project_settings_workspaces_input.py +4 -8
  383. flywheel/models/project_stats.py +16 -28
  384. flywheel/models/project_template.py +7 -13
  385. flywheel/models/project_template_input.py +7 -13
  386. flywheel/models/project_template_list_input.py +4 -8
  387. flywheel/models/protocol.py +46 -78
  388. flywheel/models/protocol_e_signature_config.py +7 -13
  389. flywheel/models/protocol_input.py +25 -43
  390. flywheel/models/protocol_modify.py +16 -28
  391. flywheel/models/provider.py +37 -63
  392. flywheel/models/provider_deletion_status.py +7 -13
  393. flywheel/models/provider_links.py +16 -28
  394. flywheel/models/providers.py +16 -28
  395. flywheel/models/reader_batch_create.py +37 -63
  396. flywheel/models/reader_task.py +67 -113
  397. flywheel/models/reader_task_config.py +10 -18
  398. flywheel/models/reader_task_create.py +46 -78
  399. flywheel/models/reader_task_modify.py +19 -33
  400. flywheel/models/reader_task_output.py +70 -118
  401. flywheel/models/reader_task_parent_details.py +22 -38
  402. flywheel/models/report_access_log_context.py +19 -33
  403. flywheel/models/report_access_log_context_entry.py +7 -13
  404. flywheel/models/report_access_log_context_file_entry.py +4 -8
  405. flywheel/models/report_access_log_entry.py +52 -88
  406. flywheel/models/report_access_log_origin.py +7 -13
  407. flywheel/models/report_availability_list.py +4 -8
  408. flywheel/models/report_daily_usage_entry.py +40 -68
  409. flywheel/models/report_ethnicity_grid.py +13 -23
  410. flywheel/models/report_gender_count.py +10 -18
  411. flywheel/models/report_group_report.py +10 -18
  412. flywheel/models/report_site.py +7 -13
  413. flywheel/models/report_time_period.py +7 -13
  414. flywheel/models/report_usage.py +52 -88
  415. flywheel/models/resolve_input.py +4 -8
  416. flywheel/models/resolve_output.py +7 -13
  417. flywheel/models/resolver_node.py +4 -8
  418. flywheel/models/role_input.py +7 -13
  419. flywheel/models/role_output.py +16 -28
  420. flywheel/models/role_permission.py +7 -13
  421. flywheel/models/role_permission_output.py +7 -13
  422. flywheel/models/role_permission_update.py +4 -8
  423. flywheel/models/role_update.py +7 -13
  424. flywheel/models/roles_role_assignment.py +7 -13
  425. flywheel/models/rule.py +37 -63
  426. flywheel/models/rule_any.py +10 -18
  427. flywheel/models/s3_compat_storage.py +28 -48
  428. flywheel/models/save_search.py +19 -33
  429. flywheel/models/save_search_input.py +10 -18
  430. flywheel/models/save_search_output.py +19 -33
  431. flywheel/models/save_search_page.py +10 -18
  432. flywheel/models/save_search_parent.py +7 -13
  433. flywheel/models/save_search_update.py +7 -13
  434. flywheel/models/search_acquisition_response.py +13 -23
  435. flywheel/models/search_analysis_response.py +13 -23
  436. flywheel/models/search_collection_response.py +13 -23
  437. flywheel/models/search_file_response.py +19 -33
  438. flywheel/models/search_group_response.py +7 -13
  439. flywheel/models/search_parent_response.py +7 -13
  440. flywheel/models/search_parse_error.py +13 -23
  441. flywheel/models/search_project_response.py +7 -13
  442. flywheel/models/search_query.py +22 -38
  443. flywheel/models/search_response.py +34 -58
  444. flywheel/models/search_session_response.py +13 -23
  445. flywheel/models/search_status.py +4 -8
  446. flywheel/models/search_subject_response.py +10 -18
  447. flywheel/models/select_item.py +7 -13
  448. flywheel/models/server_state.py +19 -33
  449. flywheel/models/service_aet.py +19 -33
  450. flywheel/models/service_aet_input.py +16 -28
  451. flywheel/models/session_copy_input.py +13 -23
  452. flywheel/models/session_embedded_subject.py +19 -33
  453. flywheel/models/session_input.py +34 -58
  454. flywheel/models/session_list_output.py +85 -143
  455. flywheel/models/session_modify.py +37 -63
  456. flywheel/models/session_output.py +85 -143
  457. flywheel/models/session_parents.py +10 -18
  458. flywheel/models/session_template_options.py +10 -18
  459. flywheel/models/session_template_recalc_output.py +4 -8
  460. flywheel/models/session_upsert_input.py +37 -63
  461. flywheel/models/session_upsert_output.py +13 -23
  462. flywheel/models/sharing_filter_options.py +25 -43
  463. flywheel/models/signed_fs_upload_output.py +7 -13
  464. flywheel/models/signed_url_cleanup_input.py +7 -13
  465. flywheel/models/signed_url_upload_input.py +7 -13
  466. flywheel/models/signed_url_upload_output.py +25 -43
  467. flywheel/models/site.py +55 -93
  468. flywheel/models/site_report.py +7 -13
  469. flywheel/models/site_settings.py +28 -48
  470. flywheel/models/sort.py +7 -13
  471. flywheel/models/staffing_pool.py +22 -38
  472. flywheel/models/staffing_pool_create.py +10 -18
  473. flywheel/models/staffing_pool_list.py +4 -8
  474. flywheel/models/staffing_pool_modify.py +10 -18
  475. flywheel/models/static_compute.py +10 -18
  476. flywheel/models/status_transitions.py +13 -23
  477. flywheel/models/storage_strategy_config.py +7 -13
  478. flywheel/models/structured_query.py +4 -8
  479. flywheel/models/structured_query_suggestions.py +7 -13
  480. flywheel/models/structured_query_value_suggestion.py +13 -23
  481. flywheel/models/subject_copy_input.py +10 -18
  482. flywheel/models/subject_input.py +55 -93
  483. flywheel/models/subject_modify.py +61 -103
  484. flywheel/models/subject_output.py +97 -163
  485. flywheel/models/subject_output_for_list.py +97 -163
  486. flywheel/models/subject_parents.py +7 -13
  487. flywheel/models/subject_role_permission.py +7 -13
  488. flywheel/models/subject_template_options.py +7 -13
  489. flywheel/models/subject_upsert_input.py +49 -83
  490. flywheel/models/subject_upsert_output.py +10 -18
  491. flywheel/models/sync_user_input.py +22 -38
  492. flywheel/models/tag.py +4 -8
  493. flywheel/models/task_assign.py +7 -13
  494. flywheel/models/task_parent_ref.py +13 -23
  495. flywheel/models/task_parent_ref_input.py +10 -18
  496. flywheel/models/task_submission.py +7 -13
  497. flywheel/models/toolbar_config.py +4 -8
  498. flywheel/models/transitions.py +16 -28
  499. flywheel/models/tree_container_request_spec.py +16 -28
  500. flywheel/models/tree_graph.py +1 -3
  501. flywheel/models/tree_graph_connection.py +13 -23
  502. flywheel/models/tree_graph_connections.py +1 -3
  503. flywheel/models/tree_graph_node.py +4 -8
  504. flywheel/models/tree_response_item.py +1 -3
  505. flywheel/models/uid_check_input_acquisitions.py +13 -23
  506. flywheel/models/uid_check_input_sessions.py +13 -23
  507. flywheel/models/uid_check_output.py +7 -13
  508. flywheel/models/upload_ticket_output.py +10 -18
  509. flywheel/models/upload_token_output.py +4 -8
  510. flywheel/models/user.py +67 -113
  511. flywheel/models/user_api_key.py +10 -18
  512. flywheel/models/user_input.py +37 -63
  513. flywheel/models/user_jobs.py +10 -18
  514. flywheel/models/user_output_id.py +4 -8
  515. flywheel/models/user_preferences.py +1 -3
  516. flywheel/models/user_wechat.py +1 -3
  517. flywheel/models/validation_error.py +10 -18
  518. flywheel/models/validation_rule.py +7 -13
  519. flywheel/models/version.py +25 -43
  520. flywheel/models/view_id_output.py +4 -8
  521. flywheel/models/view_output.py +34 -58
  522. flywheel/models/viewer_app.py +28 -48
  523. flywheel/models/viewer_app_input.py +28 -48
  524. flywheel/models/virus_scan.py +4 -8
  525. flywheel/models/work_in_progress_features.py +1 -3
  526. flywheel/models/zipfile_info.py +7 -13
  527. flywheel/models/zipfile_member_info.py +13 -23
  528. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/METADATA +1 -1
  529. flywheel_sdk-21.4.0rc0.dist-info/RECORD +778 -0
  530. flywheel_sdk-21.4.0.dist-info/RECORD +0 -778
  531. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/WHEEL +0 -0
  532. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/licenses/LICENSE.txt +0 -0
@@ -30,13 +30,10 @@ class AnalysesApi(object):
30
30
  Add a note to a(n) analysis.
31
31
  This method makes a synchronous HTTP request by default.
32
32
 
33
- :param container_id:
34
- :type container_id: str
35
- :param body:
36
- :type body: NoteInput
37
- :param async_: Perform the request asynchronously
38
- :type async_: bool, optional
39
- :rtype: Note
33
+ :param str container_id: (required)
34
+ :param NoteInput body: (required)
35
+ :param bool async_: Perform the request asynchronously
36
+ :return: Note
40
37
  """
41
38
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
42
39
  kwargs['_return_http_data_only'] = True
@@ -60,13 +57,10 @@ class AnalysesApi(object):
60
57
  Add a note to a(n) analysis.
61
58
  This method makes a synchronous HTTP request by default.
62
59
 
63
- :param container_id:
64
- :type container_id: str
65
- :param body:
66
- :type body: NoteInput
67
- :param async_: Perform the request asynchronously
68
- :type async_: bool, optional
69
- :rtype: Note
60
+ :param str container_id: (required)
61
+ :param NoteInput body: (required)
62
+ :param bool async_: Perform the request asynchronously
63
+ :return: Note
70
64
  """
71
65
 
72
66
  all_params = ['container_id','body',] # noqa: E501
@@ -152,13 +146,10 @@ class AnalysesApi(object):
152
146
  Propagates changes to projects, sessions and acquisitions
153
147
  This method makes a synchronous HTTP request by default.
154
148
 
155
- :param container_id:
156
- :type container_id: str
157
- :param body:
158
- :type body: Tag
159
- :param async_: Perform the request asynchronously
160
- :type async_: bool, optional
161
- :rtype: ModifiedResult
149
+ :param str container_id: (required)
150
+ :param Tag body: (required)
151
+ :param bool async_: Perform the request asynchronously
152
+ :return: ModifiedResult
162
153
  """
163
154
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
164
155
  kwargs['_return_http_data_only'] = True
@@ -182,13 +173,10 @@ class AnalysesApi(object):
182
173
  Propagates changes to projects, sessions and acquisitions
183
174
  This method makes a synchronous HTTP request by default.
184
175
 
185
- :param container_id:
186
- :type container_id: str
187
- :param body:
188
- :type body: Tag
189
- :param async_: Perform the request asynchronously
190
- :type async_: bool, optional
191
- :rtype: ModifiedResult
176
+ :param str container_id: (required)
177
+ :param Tag body: (required)
178
+ :param bool async_: Perform the request asynchronously
179
+ :return: ModifiedResult
192
180
  """
193
181
 
194
182
  all_params = ['container_id','body',] # noqa: E501
@@ -274,13 +262,10 @@ class AnalysesApi(object):
274
262
  Delete multiple analyses by ID list
275
263
  This method makes a synchronous HTTP request by default.
276
264
 
277
- :param body: List of IDs to delete
278
- :type body: list[str]
279
- :param delete_reason:
280
- :type delete_reason: ContainerDeleteReason, optional
281
- :param async_: Perform the request asynchronously
282
- :type async_: bool, optional
283
- :rtype: DeletedResult
265
+ :param list[str] body: List of IDs to delete (required)
266
+ :param ContainerDeleteReason delete_reason:
267
+ :param bool async_: Perform the request asynchronously
268
+ :return: DeletedResult
284
269
  """
285
270
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
286
271
  kwargs['_return_http_data_only'] = True
@@ -304,13 +289,10 @@ class AnalysesApi(object):
304
289
  Delete multiple analyses by ID list
305
290
  This method makes a synchronous HTTP request by default.
306
291
 
307
- :param body: List of IDs to delete
308
- :type body: list[str]
309
- :param delete_reason:
310
- :type delete_reason: ContainerDeleteReason, optional
311
- :param async_: Perform the request asynchronously
312
- :type async_: bool, optional
313
- :rtype: DeletedResult
292
+ :param list[str] body: List of IDs to delete (required)
293
+ :param ContainerDeleteReason delete_reason:
294
+ :param bool async_: Perform the request asynchronously
295
+ :return: DeletedResult
314
296
  """
315
297
 
316
298
  all_params = ['body','delete_reason',] # noqa: E501
@@ -385,13 +367,10 @@ class AnalysesApi(object):
385
367
  Delete an analysis by its id Args: analysis_id: The id of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when audit-trail is enabled)
386
368
  This method makes a synchronous HTTP request by default.
387
369
 
388
- :param analysis_id: 24-char hex analysis id
389
- :type analysis_id: str
390
- :param delete_reason:
391
- :type delete_reason: ContainerDeleteReason, optional
392
- :param async_: Perform the request asynchronously
393
- :type async_: bool, optional
394
- :rtype: DeletedResult
370
+ :param str analysis_id: 24-char hex analysis id (required)
371
+ :param ContainerDeleteReason delete_reason:
372
+ :param bool async_: Perform the request asynchronously
373
+ :return: DeletedResult
395
374
  """
396
375
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
397
376
  kwargs['_return_http_data_only'] = True
@@ -415,13 +394,10 @@ class AnalysesApi(object):
415
394
  Delete an analysis by its id Args: analysis_id: The id of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when audit-trail is enabled)
416
395
  This method makes a synchronous HTTP request by default.
417
396
 
418
- :param analysis_id: 24-char hex analysis id
419
- :type analysis_id: str
420
- :param delete_reason:
421
- :type delete_reason: ContainerDeleteReason, optional
422
- :param async_: Perform the request asynchronously
423
- :type async_: bool, optional
424
- :rtype: DeletedResult
397
+ :param str analysis_id: 24-char hex analysis id (required)
398
+ :param ContainerDeleteReason delete_reason:
399
+ :param bool async_: Perform the request asynchronously
400
+ :return: DeletedResult
425
401
  """
426
402
 
427
403
  all_params = ['analysis_id','delete_reason',] # noqa: E501
@@ -492,17 +468,12 @@ class AnalysesApi(object):
492
468
  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.
493
469
  This method makes a synchronous HTTP request by default.
494
470
 
495
- :param cid:
496
- :type cid: str
497
- :param filename:
498
- :type filename: str
499
- :param delete_reason: A reason for deletion when audit-trail is enabled
500
- :type delete_reason: ContainerDeleteReason, optional
501
- :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
502
- :type force: bool, optional
503
- :param async_: Perform the request asynchronously
504
- :type async_: bool, optional
505
- :rtype: DeletedResult
471
+ :param str cid: (required)
472
+ :param str filename: (required)
473
+ :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
474
+ :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
475
+ :param bool async_: Perform the request asynchronously
476
+ :return: DeletedResult
506
477
  """
507
478
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
508
479
  kwargs['_return_http_data_only'] = True
@@ -526,17 +497,12 @@ class AnalysesApi(object):
526
497
  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.
527
498
  This method makes a synchronous HTTP request by default.
528
499
 
529
- :param cid:
530
- :type cid: str
531
- :param filename:
532
- :type filename: str
533
- :param delete_reason: A reason for deletion when audit-trail is enabled
534
- :type delete_reason: ContainerDeleteReason, optional
535
- :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
536
- :type force: bool, optional
537
- :param async_: Perform the request asynchronously
538
- :type async_: bool, optional
539
- :rtype: DeletedResult
500
+ :param str cid: (required)
501
+ :param str filename: (required)
502
+ :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
503
+ :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
504
+ :param bool async_: Perform the request asynchronously
505
+ :return: DeletedResult
540
506
  """
541
507
 
542
508
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -615,13 +581,10 @@ class AnalysesApi(object):
615
581
  Remove a note from a(n) analysis
616
582
  This method makes a synchronous HTTP request by default.
617
583
 
618
- :param container_id:
619
- :type container_id: str
620
- :param note_id:
621
- :type note_id: str
622
- :param async_: Perform the request asynchronously
623
- :type async_: bool, optional
624
- :rtype: DeletedResult
584
+ :param str container_id: (required)
585
+ :param str note_id: (required)
586
+ :param bool async_: Perform the request asynchronously
587
+ :return: DeletedResult
625
588
  """
626
589
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
627
590
  kwargs['_return_http_data_only'] = True
@@ -645,13 +608,10 @@ class AnalysesApi(object):
645
608
  Remove a note from a(n) analysis
646
609
  This method makes a synchronous HTTP request by default.
647
610
 
648
- :param container_id:
649
- :type container_id: str
650
- :param note_id:
651
- :type note_id: str
652
- :param async_: Perform the request asynchronously
653
- :type async_: bool, optional
654
- :rtype: DeletedResult
611
+ :param str container_id: (required)
612
+ :param str note_id: (required)
613
+ :param bool async_: Perform the request asynchronously
614
+ :return: DeletedResult
655
615
  """
656
616
 
657
617
  all_params = ['container_id','note_id',] # noqa: E501
@@ -726,13 +686,10 @@ class AnalysesApi(object):
726
686
  Delete a tag
727
687
  This method makes a synchronous HTTP request by default.
728
688
 
729
- :param container_id:
730
- :type container_id: str
731
- :param value: The tag to interact with
732
- :type value: str
733
- :param async_: Perform the request asynchronously
734
- :type async_: bool, optional
735
- :rtype: DeletedResult
689
+ :param str container_id: (required)
690
+ :param str value: The tag to interact with (required)
691
+ :param bool async_: Perform the request asynchronously
692
+ :return: DeletedResult
736
693
  """
737
694
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
738
695
  kwargs['_return_http_data_only'] = True
@@ -756,13 +713,10 @@ class AnalysesApi(object):
756
713
  Delete a tag
757
714
  This method makes a synchronous HTTP request by default.
758
715
 
759
- :param container_id:
760
- :type container_id: str
761
- :param value: The tag to interact with
762
- :type value: str
763
- :param async_: Perform the request asynchronously
764
- :type async_: bool, optional
765
- :rtype: DeletedResult
716
+ :param str container_id: (required)
717
+ :param str value: The tag to interact with (required)
718
+ :param bool async_: Perform the request asynchronously
719
+ :return: DeletedResult
766
720
  """
767
721
 
768
722
  all_params = ['container_id','value',] # noqa: E501
@@ -837,29 +791,18 @@ class AnalysesApi(object):
837
791
  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.
838
792
  This method makes a synchronous HTTP request by default.
839
793
 
840
- :param analysis_id: 24-character hex ID
841
- :type analysis_id: str
842
- :param file_name: output file name
843
- :type file_name: str
844
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
845
- :type info: bool, optional
846
- :param member: The filename of a zipfile member to download rather than the entire file
847
- :type member: str, optional
848
- :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
849
- :type view: bool, optional
850
- :param version: version of the file to download
851
- :type version: int, optional
852
- :param hash: file hash for comparison
853
- :type hash: str, optional
854
- :param range: byte ranges to return
855
- :type range: str, optional
856
- :param x_accept_feature: redirect header, defaults to []
857
- :type x_accept_feature: list[str], optional
858
- :param dest_file: Destination file path
859
- :type dest_file: str
860
- :param async_: Perform the request asynchronously
861
- :type async_: bool, optional
862
- :rtype: union[DownloadTicketStub,ZipfileInfo]
794
+ :param str analysis_id: 24-character hex ID (required)
795
+ :param str file_name: output file name (required)
796
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
797
+ :param str member: The filename of a zipfile member to download rather than the entire file
798
+ :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\"
799
+ :param int version: version of the file to download
800
+ :param str hash: file hash for comparison
801
+ :param str range: byte ranges to return
802
+ :param list[str] x_accept_feature: redirect header
803
+ :param str dest_file: Destination file path
804
+ :param bool async_: Perform the request asynchronously
805
+ :return: union[DownloadTicketStub,ZipfileInfo]
863
806
  """
864
807
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
865
808
  kwargs['_return_http_data_only'] = True
@@ -882,27 +825,17 @@ class AnalysesApi(object):
882
825
  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.
883
826
  This method makes a synchronous HTTP request by default.
884
827
 
885
- :param analysis_id: 24-character hex ID
886
- :type analysis_id: str
887
- :param file_name: output file name
888
- :type file_name: str
889
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
890
- :type info: bool, optional
891
- :param member: The filename of a zipfile member to download rather than the entire file
892
- :type member: str, optional
893
- :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
894
- :type view: bool, optional
895
- :param version: version of the file to download
896
- :type version: int, optional
897
- :param hash: file hash for comparison
898
- :type hash: str, optional
899
- :param range: byte ranges to return
900
- :type range: str, optional
901
- :param x_accept_feature: redirect header, defaults to []
902
- :type x_accept_feature: list[str], optional
903
- :param async_: Perform the request asynchronously
904
- :type async_: bool, optional
905
- :rtype: union[DownloadTicketStub,ZipfileInfo]
828
+ :param str analysis_id: 24-character hex ID (required)
829
+ :param str file_name: output file name (required)
830
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
831
+ :param str member: The filename of a zipfile member to download rather than the entire file
832
+ :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\"
833
+ :param int version: version of the file to download
834
+ :param str hash: file hash for comparison
835
+ :param str range: byte ranges to return
836
+ :param list[str] x_accept_feature: redirect header
837
+ :param bool async_: Perform the request asynchronously
838
+ :return: union[DownloadTicketStub,ZipfileInfo]
906
839
  """
907
840
 
908
841
  all_params = ['analysis_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -992,29 +925,18 @@ class AnalysesApi(object):
992
925
  Does not work on files whose names contain a forward slash.
993
926
  This method makes a synchronous HTTP request by default.
994
927
 
995
- :param analysis_id: 24-character hex ID
996
- :type analysis_id: str
997
- :param file_name: output file name
998
- :type file_name: str
999
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1000
- :type ticket: str, optional
1001
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1002
- :type info: bool, optional
1003
- :param member: The filename of a zipfile member to download rather than the entire file
1004
- :type member: str, optional
1005
- :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
1006
- :type view: bool, optional
1007
- :param version: version of the file to download
1008
- :type version: int, optional
1009
- :param hash: file hash for comparison
1010
- :type hash: str, optional
1011
- :param range: byte ranges to return
1012
- :type range: str, optional
1013
- :param x_accept_feature: redirect header, defaults to []
1014
- :type x_accept_feature: list[str], optional
1015
- :param async_: Perform the request asynchronously
1016
- :type async_: bool, optional
1017
- :rtype: FileZipInfo
928
+ :param str analysis_id: 24-character hex ID (required)
929
+ :param str file_name: output file name (required)
930
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
931
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
932
+ :param str member: The filename of a zipfile member to download rather than the entire file
933
+ :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\"
934
+ :param int version: version of the file to download
935
+ :param str hash: file hash for comparison
936
+ :param str range: byte ranges to return
937
+ :param list[str] x_accept_feature: redirect header
938
+ :param bool async_: Perform the request asynchronously
939
+ :return: FileZipInfo
1018
940
  """
1019
941
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1020
942
  kwargs['_return_http_data_only'] = True
@@ -1038,29 +960,18 @@ class AnalysesApi(object):
1038
960
  Does not work on files whose names contain a forward slash.
1039
961
  This method makes a synchronous HTTP request by default.
1040
962
 
1041
- :param analysis_id: 24-character hex ID
1042
- :type analysis_id: str
1043
- :param file_name: output file name
1044
- :type file_name: str
1045
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1046
- :type ticket: str, optional
1047
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1048
- :type info: bool, optional
1049
- :param member: The filename of a zipfile member to download rather than the entire file
1050
- :type member: str, optional
1051
- :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
1052
- :type view: bool, optional
1053
- :param version: version of the file to download
1054
- :type version: int, optional
1055
- :param hash: file hash for comparison
1056
- :type hash: str, optional
1057
- :param range: byte ranges to return
1058
- :type range: str, optional
1059
- :param x_accept_feature: redirect header, defaults to []
1060
- :type x_accept_feature: list[str], optional
1061
- :param async_: Perform the request asynchronously
1062
- :type async_: bool, optional
1063
- :rtype: FileZipInfo
963
+ :param str analysis_id: 24-character hex ID (required)
964
+ :param str file_name: output file name (required)
965
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
966
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
967
+ :param str member: The filename of a zipfile member to download rather than the entire file
968
+ :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\"
969
+ :param int version: version of the file to download
970
+ :param str hash: file hash for comparison
971
+ :param str range: byte ranges to return
972
+ :param list[str] x_accept_feature: redirect header
973
+ :param bool async_: Perform the request asynchronously
974
+ :return: FileZipInfo
1064
975
  """
1065
976
 
1066
977
  all_params = ['analysis_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1153,29 +1064,18 @@ class AnalysesApi(object):
1153
1064
 
1154
1065
  This method makes a synchronous HTTP request by default.
1155
1066
 
1156
- :param analysis_id: 24-character hex ID
1157
- :type analysis_id: str
1158
- :param file_name: output file name
1159
- :type file_name: str
1160
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1161
- :type ticket: str, optional
1162
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1163
- :type info: bool, optional
1164
- :param member: The filename of a zipfile member to download rather than the entire file
1165
- :type member: str, optional
1166
- :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
1167
- :type view: bool, optional
1168
- :param version: version of the file to download
1169
- :type version: int, optional
1170
- :param hash: file hash for comparison
1171
- :type hash: str, optional
1172
- :param range: byte ranges to return
1173
- :type range: str, optional
1174
- :param x_accept_feature: redirect header, defaults to []
1175
- :type x_accept_feature: list[str], optional
1176
- :param async_: Perform the request asynchronously
1177
- :type async_: bool, optional
1178
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1067
+ :param str analysis_id: 24-character hex ID (required)
1068
+ :param str file_name: output file name (required)
1069
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1070
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1071
+ :param str member: The filename of a zipfile member to download rather than the entire file
1072
+ :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\"
1073
+ :param int version: version of the file to download
1074
+ :param str hash: file hash for comparison
1075
+ :param str range: byte ranges to return
1076
+ :param list[str] x_accept_feature: redirect header
1077
+ :param bool async_: Perform the request asynchronously
1078
+ :return: union[DownloadTicketStub,ZipfileInfo]
1179
1079
  """
1180
1080
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1181
1081
  kwargs['_return_http_data_only'] = True
@@ -1198,29 +1098,18 @@ class AnalysesApi(object):
1198
1098
 
1199
1099
  This method makes a synchronous HTTP request by default.
1200
1100
 
1201
- :param analysis_id: 24-character hex ID
1202
- :type analysis_id: str
1203
- :param file_name: output file name
1204
- :type file_name: str
1205
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1206
- :type ticket: str, optional
1207
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1208
- :type info: bool, optional
1209
- :param member: The filename of a zipfile member to download rather than the entire file
1210
- :type member: str, optional
1211
- :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
1212
- :type view: bool, optional
1213
- :param version: version of the file to download
1214
- :type version: int, optional
1215
- :param hash: file hash for comparison
1216
- :type hash: str, optional
1217
- :param range: byte ranges to return
1218
- :type range: str, optional
1219
- :param x_accept_feature: redirect header, defaults to []
1220
- :type x_accept_feature: list[str], optional
1221
- :param async_: Perform the request asynchronously
1222
- :type async_: bool, optional
1223
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1101
+ :param str analysis_id: 24-character hex ID (required)
1102
+ :param str file_name: output file name (required)
1103
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1104
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1105
+ :param str member: The filename of a zipfile member to download rather than the entire file
1106
+ :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\"
1107
+ :param int version: version of the file to download
1108
+ :param str hash: file hash for comparison
1109
+ :param str range: byte ranges to return
1110
+ :param list[str] x_accept_feature: redirect header
1111
+ :param bool async_: Perform the request asynchronously
1112
+ :return: union[DownloadTicketStub,ZipfileInfo]
1224
1113
  """
1225
1114
 
1226
1115
  all_params = ['analysis_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1312,25 +1201,16 @@ class AnalysesApi(object):
1312
1201
  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.
1313
1202
  This method makes a synchronous HTTP request by default.
1314
1203
 
1315
- :param analysis_id: 24-character hex ID
1316
- :type analysis_id: str
1317
- :param filename: input filename
1318
- :type filename: str
1319
- :param info: get file info only, defaults to false
1320
- :type info: bool, optional
1321
- :param member: get zipfile member
1322
- :type member: str, optional
1323
- :param view: feature flag for view/download, defaults to false
1324
- :type view: bool, optional
1325
- :param range: byte ranges to return
1326
- :type range: str, optional
1327
- :param x_accept_feature: redirect header, defaults to []
1328
- :type x_accept_feature: list[str], optional
1329
- :param dest_file: Destination file path
1330
- :type dest_file: str
1331
- :param async_: Perform the request asynchronously
1332
- :type async_: bool, optional
1333
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1204
+ :param str analysis_id: 24-character hex ID (required)
1205
+ :param str filename: input filename (required)
1206
+ :param bool info: get file info only
1207
+ :param str member: get zipfile member
1208
+ :param bool view: feature flag for view/download
1209
+ :param str range: byte ranges to return
1210
+ :param list[str] x_accept_feature: redirect header
1211
+ :param str dest_file: Destination file path
1212
+ :param bool async_: Perform the request asynchronously
1213
+ :return: union[DownloadTicketStub,ZipfileInfo]
1334
1214
  """
1335
1215
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1336
1216
  kwargs['_return_http_data_only'] = True
@@ -1353,23 +1233,15 @@ class AnalysesApi(object):
1353
1233
  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.
1354
1234
  This method makes a synchronous HTTP request by default.
1355
1235
 
1356
- :param analysis_id: 24-character hex ID
1357
- :type analysis_id: str
1358
- :param filename: input filename
1359
- :type filename: str
1360
- :param info: get file info only, defaults to false
1361
- :type info: bool, optional
1362
- :param member: get zipfile member
1363
- :type member: str, optional
1364
- :param view: feature flag for view/download, defaults to false
1365
- :type view: bool, optional
1366
- :param range: byte ranges to return
1367
- :type range: str, optional
1368
- :param x_accept_feature: redirect header, defaults to []
1369
- :type x_accept_feature: list[str], optional
1370
- :param async_: Perform the request asynchronously
1371
- :type async_: bool, optional
1372
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1236
+ :param str analysis_id: 24-character hex ID (required)
1237
+ :param str filename: input filename (required)
1238
+ :param bool info: get file info only
1239
+ :param str member: get zipfile member
1240
+ :param bool view: feature flag for view/download
1241
+ :param str range: byte ranges to return
1242
+ :param list[str] x_accept_feature: redirect header
1243
+ :param bool async_: Perform the request asynchronously
1244
+ :return: union[DownloadTicketStub,ZipfileInfo]
1373
1245
  """
1374
1246
 
1375
1247
  all_params = ['analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -1455,25 +1327,16 @@ class AnalysesApi(object):
1455
1327
  Does not work on files whose names contain a forward slash.
1456
1328
  This method makes a synchronous HTTP request by default.
1457
1329
 
1458
- :param analysis_id: 24-character hex ID
1459
- :type analysis_id: str
1460
- :param filename: input filename
1461
- :type filename: str
1462
- :param ticket: 24-char hex ticket id
1463
- :type ticket: str, optional
1464
- :param info: get file info only, defaults to false
1465
- :type info: bool, optional
1466
- :param member: get zipfile member
1467
- :type member: str, optional
1468
- :param view: feature flag for view/download, defaults to false
1469
- :type view: bool, optional
1470
- :param range: byte ranges to return
1471
- :type range: str, optional
1472
- :param x_accept_feature: redirect header, defaults to []
1473
- :type x_accept_feature: list[str], optional
1474
- :param async_: Perform the request asynchronously
1475
- :type async_: bool, optional
1476
- :rtype: FileZipInfo
1330
+ :param str analysis_id: 24-character hex ID (required)
1331
+ :param str filename: input filename (required)
1332
+ :param str ticket: 24-char hex ticket id
1333
+ :param bool info: get file info only
1334
+ :param str member: get zipfile member
1335
+ :param bool view: feature flag for view/download
1336
+ :param str range: byte ranges to return
1337
+ :param list[str] x_accept_feature: redirect header
1338
+ :param bool async_: Perform the request asynchronously
1339
+ :return: FileZipInfo
1477
1340
  """
1478
1341
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1479
1342
  kwargs['_return_http_data_only'] = True
@@ -1497,25 +1360,16 @@ class AnalysesApi(object):
1497
1360
  Does not work on files whose names contain a forward slash.
1498
1361
  This method makes a synchronous HTTP request by default.
1499
1362
 
1500
- :param analysis_id: 24-character hex ID
1501
- :type analysis_id: str
1502
- :param filename: input filename
1503
- :type filename: str
1504
- :param ticket: 24-char hex ticket id
1505
- :type ticket: str, optional
1506
- :param info: get file info only, defaults to false
1507
- :type info: bool, optional
1508
- :param member: get zipfile member
1509
- :type member: str, optional
1510
- :param view: feature flag for view/download, defaults to false
1511
- :type view: bool, optional
1512
- :param range: byte ranges to return
1513
- :type range: str, optional
1514
- :param x_accept_feature: redirect header, defaults to []
1515
- :type x_accept_feature: list[str], optional
1516
- :param async_: Perform the request asynchronously
1517
- :type async_: bool, optional
1518
- :rtype: FileZipInfo
1363
+ :param str analysis_id: 24-character hex ID (required)
1364
+ :param str filename: input filename (required)
1365
+ :param str ticket: 24-char hex ticket id
1366
+ :param bool info: get file info only
1367
+ :param str member: get zipfile member
1368
+ :param bool view: feature flag for view/download
1369
+ :param str range: byte ranges to return
1370
+ :param list[str] x_accept_feature: redirect header
1371
+ :param bool async_: Perform the request asynchronously
1372
+ :return: FileZipInfo
1519
1373
  """
1520
1374
 
1521
1375
  all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -1604,25 +1458,16 @@ class AnalysesApi(object):
1604
1458
 
1605
1459
  This method makes a synchronous HTTP request by default.
1606
1460
 
1607
- :param analysis_id: 24-character hex ID
1608
- :type analysis_id: str
1609
- :param filename: input filename
1610
- :type filename: str
1611
- :param ticket: 24-char hex ticket id
1612
- :type ticket: str, optional
1613
- :param info: get file info only, defaults to false
1614
- :type info: bool, optional
1615
- :param member: get zipfile member
1616
- :type member: str, optional
1617
- :param view: feature flag for view/download, defaults to false
1618
- :type view: bool, optional
1619
- :param range: byte ranges to return
1620
- :type range: str, optional
1621
- :param x_accept_feature: redirect header, defaults to []
1622
- :type x_accept_feature: list[str], optional
1623
- :param async_: Perform the request asynchronously
1624
- :type async_: bool, optional
1625
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1461
+ :param str analysis_id: 24-character hex ID (required)
1462
+ :param str filename: input filename (required)
1463
+ :param str ticket: 24-char hex ticket id
1464
+ :param bool info: get file info only
1465
+ :param str member: get zipfile member
1466
+ :param bool view: feature flag for view/download
1467
+ :param str range: byte ranges to return
1468
+ :param list[str] x_accept_feature: redirect header
1469
+ :param bool async_: Perform the request asynchronously
1470
+ :return: union[DownloadTicketStub,ZipfileInfo]
1626
1471
  """
1627
1472
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1628
1473
  kwargs['_return_http_data_only'] = True
@@ -1645,25 +1490,16 @@ class AnalysesApi(object):
1645
1490
 
1646
1491
  This method makes a synchronous HTTP request by default.
1647
1492
 
1648
- :param analysis_id: 24-character hex ID
1649
- :type analysis_id: str
1650
- :param filename: input filename
1651
- :type filename: str
1652
- :param ticket: 24-char hex ticket id
1653
- :type ticket: str, optional
1654
- :param info: get file info only, defaults to false
1655
- :type info: bool, optional
1656
- :param member: get zipfile member
1657
- :type member: str, optional
1658
- :param view: feature flag for view/download, defaults to false
1659
- :type view: bool, optional
1660
- :param range: byte ranges to return
1661
- :type range: str, optional
1662
- :param x_accept_feature: redirect header, defaults to []
1663
- :type x_accept_feature: list[str], optional
1664
- :param async_: Perform the request asynchronously
1665
- :type async_: bool, optional
1666
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1493
+ :param str analysis_id: 24-character hex ID (required)
1494
+ :param str filename: input filename (required)
1495
+ :param str ticket: 24-char hex ticket id
1496
+ :param bool info: get file info only
1497
+ :param str member: get zipfile member
1498
+ :param bool view: feature flag for view/download
1499
+ :param str range: byte ranges to return
1500
+ :param list[str] x_accept_feature: redirect header
1501
+ :param bool async_: Perform the request asynchronously
1502
+ :return: union[DownloadTicketStub,ZipfileInfo]
1667
1503
  """
1668
1504
 
1669
1505
  all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -1751,25 +1587,16 @@ class AnalysesApi(object):
1751
1587
  Download output file from analysis
1752
1588
  This method makes a synchronous HTTP request by default.
1753
1589
 
1754
- :param analysis_id: Container ID
1755
- :type analysis_id: str
1756
- :param filename: output file name
1757
- :type filename: str
1758
- :param info: get file info only, defaults to false
1759
- :type info: bool, optional
1760
- :param member: get zipfile member
1761
- :type member: str, optional
1762
- :param view: feature flag for view/download, defaults to false
1763
- :type view: bool, optional
1764
- :param range: byte ranges to return
1765
- :type range: str, optional
1766
- :param x_accept_feature: redirect header, defaults to []
1767
- :type x_accept_feature: list[str], optional
1768
- :param dest_file: Destination file path
1769
- :type dest_file: str
1770
- :param async_: Perform the request asynchronously
1771
- :type async_: bool, optional
1772
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1590
+ :param str analysis_id: Container ID (required)
1591
+ :param str filename: output file name (required)
1592
+ :param bool info: get file info only
1593
+ :param str member: get zipfile member
1594
+ :param bool view: feature flag for view/download
1595
+ :param str range: byte ranges to return
1596
+ :param list[str] x_accept_feature: redirect header
1597
+ :param str dest_file: Destination file path
1598
+ :param bool async_: Perform the request asynchronously
1599
+ :return: union[DownloadTicketStub,ZipfileInfo]
1773
1600
  """
1774
1601
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1775
1602
  kwargs['_return_http_data_only'] = True
@@ -1792,23 +1619,15 @@ class AnalysesApi(object):
1792
1619
  Download output file from analysis
1793
1620
  This method makes a synchronous HTTP request by default.
1794
1621
 
1795
- :param analysis_id: Container ID
1796
- :type analysis_id: str
1797
- :param filename: output file name
1798
- :type filename: str
1799
- :param info: get file info only, defaults to false
1800
- :type info: bool, optional
1801
- :param member: get zipfile member
1802
- :type member: str, optional
1803
- :param view: feature flag for view/download, defaults to false
1804
- :type view: bool, optional
1805
- :param range: byte ranges to return
1806
- :type range: str, optional
1807
- :param x_accept_feature: redirect header, defaults to []
1808
- :type x_accept_feature: list[str], optional
1809
- :param async_: Perform the request asynchronously
1810
- :type async_: bool, optional
1811
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1622
+ :param str analysis_id: Container ID (required)
1623
+ :param str filename: output file name (required)
1624
+ :param bool info: get file info only
1625
+ :param str member: get zipfile member
1626
+ :param bool view: feature flag for view/download
1627
+ :param str range: byte ranges to return
1628
+ :param list[str] x_accept_feature: redirect header
1629
+ :param bool async_: Perform the request asynchronously
1630
+ :return: union[DownloadTicketStub,ZipfileInfo]
1812
1631
  """
1813
1632
 
1814
1633
  all_params = ['analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -1894,25 +1713,16 @@ class AnalysesApi(object):
1894
1713
  Does not work on files whose names contain a forward slash.
1895
1714
  This method makes a synchronous HTTP request by default.
1896
1715
 
1897
- :param analysis_id: Container ID
1898
- :type analysis_id: str
1899
- :param filename: output file name
1900
- :type filename: str
1901
- :param ticket: 24-char hex ticket id
1902
- :type ticket: str, optional
1903
- :param info: get file info only, defaults to false
1904
- :type info: bool, optional
1905
- :param member: get zipfile member
1906
- :type member: str, optional
1907
- :param view: feature flag for view/download, defaults to false
1908
- :type view: bool, optional
1909
- :param range: byte ranges to return
1910
- :type range: str, optional
1911
- :param x_accept_feature: redirect header, defaults to []
1912
- :type x_accept_feature: list[str], optional
1913
- :param async_: Perform the request asynchronously
1914
- :type async_: bool, optional
1915
- :rtype: FileZipInfo
1716
+ :param str analysis_id: Container ID (required)
1717
+ :param str filename: output file name (required)
1718
+ :param str ticket: 24-char hex ticket id
1719
+ :param bool info: get file info only
1720
+ :param str member: get zipfile member
1721
+ :param bool view: feature flag for view/download
1722
+ :param str range: byte ranges to return
1723
+ :param list[str] x_accept_feature: redirect header
1724
+ :param bool async_: Perform the request asynchronously
1725
+ :return: FileZipInfo
1916
1726
  """
1917
1727
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1918
1728
  kwargs['_return_http_data_only'] = True
@@ -1936,25 +1746,16 @@ class AnalysesApi(object):
1936
1746
  Does not work on files whose names contain a forward slash.
1937
1747
  This method makes a synchronous HTTP request by default.
1938
1748
 
1939
- :param analysis_id: Container ID
1940
- :type analysis_id: str
1941
- :param filename: output file name
1942
- :type filename: str
1943
- :param ticket: 24-char hex ticket id
1944
- :type ticket: str, optional
1945
- :param info: get file info only, defaults to false
1946
- :type info: bool, optional
1947
- :param member: get zipfile member
1948
- :type member: str, optional
1949
- :param view: feature flag for view/download, defaults to false
1950
- :type view: bool, optional
1951
- :param range: byte ranges to return
1952
- :type range: str, optional
1953
- :param x_accept_feature: redirect header, defaults to []
1954
- :type x_accept_feature: list[str], optional
1955
- :param async_: Perform the request asynchronously
1956
- :type async_: bool, optional
1957
- :rtype: FileZipInfo
1749
+ :param str analysis_id: Container ID (required)
1750
+ :param str filename: output file name (required)
1751
+ :param str ticket: 24-char hex ticket id
1752
+ :param bool info: get file info only
1753
+ :param str member: get zipfile member
1754
+ :param bool view: feature flag for view/download
1755
+ :param str range: byte ranges to return
1756
+ :param list[str] x_accept_feature: redirect header
1757
+ :param bool async_: Perform the request asynchronously
1758
+ :return: FileZipInfo
1958
1759
  """
1959
1760
 
1960
1761
  all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2043,25 +1844,16 @@ class AnalysesApi(object):
2043
1844
 
2044
1845
  This method makes a synchronous HTTP request by default.
2045
1846
 
2046
- :param analysis_id: Container ID
2047
- :type analysis_id: str
2048
- :param filename: output file name
2049
- :type filename: str
2050
- :param ticket: 24-char hex ticket id
2051
- :type ticket: str, optional
2052
- :param info: get file info only, defaults to false
2053
- :type info: bool, optional
2054
- :param member: get zipfile member
2055
- :type member: str, optional
2056
- :param view: feature flag for view/download, defaults to false
2057
- :type view: bool, optional
2058
- :param range: byte ranges to return
2059
- :type range: str, optional
2060
- :param x_accept_feature: redirect header, defaults to []
2061
- :type x_accept_feature: list[str], optional
2062
- :param async_: Perform the request asynchronously
2063
- :type async_: bool, optional
2064
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1847
+ :param str analysis_id: Container ID (required)
1848
+ :param str filename: output file name (required)
1849
+ :param str ticket: 24-char hex ticket id
1850
+ :param bool info: get file info only
1851
+ :param str member: get zipfile member
1852
+ :param bool view: feature flag for view/download
1853
+ :param str range: byte ranges to return
1854
+ :param list[str] x_accept_feature: redirect header
1855
+ :param bool async_: Perform the request asynchronously
1856
+ :return: union[DownloadTicketStub,ZipfileInfo]
2065
1857
  """
2066
1858
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2067
1859
  kwargs['_return_http_data_only'] = True
@@ -2084,25 +1876,16 @@ class AnalysesApi(object):
2084
1876
 
2085
1877
  This method makes a synchronous HTTP request by default.
2086
1878
 
2087
- :param analysis_id: Container ID
2088
- :type analysis_id: str
2089
- :param filename: output file name
2090
- :type filename: str
2091
- :param ticket: 24-char hex ticket id
2092
- :type ticket: str, optional
2093
- :param info: get file info only, defaults to false
2094
- :type info: bool, optional
2095
- :param member: get zipfile member
2096
- :type member: str, optional
2097
- :param view: feature flag for view/download, defaults to false
2098
- :type view: bool, optional
2099
- :param range: byte ranges to return
2100
- :type range: str, optional
2101
- :param x_accept_feature: redirect header, defaults to []
2102
- :type x_accept_feature: list[str], optional
2103
- :param async_: Perform the request asynchronously
2104
- :type async_: bool, optional
2105
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1879
+ :param str analysis_id: Container ID (required)
1880
+ :param str filename: output file name (required)
1881
+ :param str ticket: 24-char hex ticket id
1882
+ :param bool info: get file info only
1883
+ :param str member: get zipfile member
1884
+ :param bool view: feature flag for view/download
1885
+ :param str range: byte ranges to return
1886
+ :param list[str] x_accept_feature: redirect header
1887
+ :param bool async_: Perform the request asynchronously
1888
+ :return: union[DownloadTicketStub,ZipfileInfo]
2106
1889
  """
2107
1890
 
2108
1891
  all_params = ['analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2190,27 +1973,17 @@ class AnalysesApi(object):
2190
1973
  Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None
2191
1974
  This method makes a synchronous HTTP request by default.
2192
1975
 
2193
- :param inflate_job: Return job as an object instead of an id, defaults to false
2194
- :type inflate_job: bool, optional
2195
- :param include_all_info: Include all info in returned objects, defaults to false
2196
- :type include_all_info: bool, optional
2197
- :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)
2198
- :type filter: str, optional
2199
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2200
- :type sort: str, optional
2201
- :param limit: The maximum number of entries to return.
2202
- :type limit: int, optional
2203
- :param skip: The number of entries to skip., defaults to 0
2204
- :type skip: int, optional
2205
- :param page: The page number (i.e. skip limit*page entries)
2206
- :type page: int, optional
2207
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2208
- :type after_id: str, optional
2209
- :param x_accept_feature:, defaults to []
2210
- :type x_accept_feature: list[str], optional
2211
- :param async_: Perform the request asynchronously
2212
- :type async_: bool, optional
2213
- :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
1976
+ :param bool inflate_job: Return job as an object instead of an id
1977
+ :param bool include_all_info: Include all info in returned objects
1978
+ :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)
1979
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1980
+ :param int limit: The maximum number of entries to return.
1981
+ :param int skip: The number of entries to skip.
1982
+ :param int page: The page number (i.e. skip limit*page entries)
1983
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1984
+ :param list[str] x_accept_feature:
1985
+ :param bool async_: Perform the request asynchronously
1986
+ :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
2214
1987
  """
2215
1988
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2216
1989
  kwargs['_return_http_data_only'] = True
@@ -2234,27 +2007,17 @@ class AnalysesApi(object):
2234
2007
  Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None
2235
2008
  This method makes a synchronous HTTP request by default.
2236
2009
 
2237
- :param inflate_job: Return job as an object instead of an id, defaults to false
2238
- :type inflate_job: bool, optional
2239
- :param include_all_info: Include all info in returned objects, defaults to false
2240
- :type include_all_info: bool, optional
2241
- :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)
2242
- :type filter: str, optional
2243
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2244
- :type sort: str, optional
2245
- :param limit: The maximum number of entries to return.
2246
- :type limit: int, optional
2247
- :param skip: The number of entries to skip., defaults to 0
2248
- :type skip: int, optional
2249
- :param page: The page number (i.e. skip limit*page entries)
2250
- :type page: int, optional
2251
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2252
- :type after_id: str, optional
2253
- :param x_accept_feature:, defaults to []
2254
- :type x_accept_feature: list[str], optional
2255
- :param async_: Perform the request asynchronously
2256
- :type async_: bool, optional
2257
- :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
2010
+ :param bool inflate_job: Return job as an object instead of an id
2011
+ :param bool include_all_info: Include all info in returned objects
2012
+ :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)
2013
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2014
+ :param int limit: The maximum number of entries to return.
2015
+ :param int skip: The number of entries to skip.
2016
+ :param int page: The page number (i.e. skip limit*page entries)
2017
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2018
+ :param list[str] x_accept_feature:
2019
+ :param bool async_: Perform the request asynchronously
2020
+ :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
2258
2021
  """
2259
2022
 
2260
2023
  all_params = ['inflate_job','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -2336,15 +2099,11 @@ class AnalysesApi(object):
2336
2099
  Returns analyses that belong to containers of the specified type that belong to ContainerId. Ex: `projects/{ProjectId}/acquisitions/analyses` will return any analyses that have an acquisition that is under that project as a parent. The `all` keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.
2337
2100
  This method makes a synchronous HTTP request by default.
2338
2101
 
2339
- :param container_name: The parent container type
2340
- :type container_name: str
2341
- :param container_id: The parent container id
2342
- :type container_id: str
2343
- :param subcontainer_name: The sub container type
2344
- :type subcontainer_name: str
2345
- :param async_: Perform the request asynchronously
2346
- :type async_: bool, optional
2347
- :rtype: list[AnalysisListOutput]
2102
+ :param str container_name: The parent container type (required)
2103
+ :param str container_id: The parent container id (required)
2104
+ :param str subcontainer_name: The sub container type (required)
2105
+ :param bool async_: Perform the request asynchronously
2106
+ :return: list[AnalysisListOutput]
2348
2107
  """
2349
2108
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2350
2109
  kwargs['_return_http_data_only'] = True
@@ -2368,15 +2127,11 @@ class AnalysesApi(object):
2368
2127
  Returns analyses that belong to containers of the specified type that belong to ContainerId. Ex: `projects/{ProjectId}/acquisitions/analyses` will return any analyses that have an acquisition that is under that project as a parent. The `all` keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.
2369
2128
  This method makes a synchronous HTTP request by default.
2370
2129
 
2371
- :param container_name: The parent container type
2372
- :type container_name: str
2373
- :param container_id: The parent container id
2374
- :type container_id: str
2375
- :param subcontainer_name: The sub container type
2376
- :type subcontainer_name: str
2377
- :param async_: Perform the request asynchronously
2378
- :type async_: bool, optional
2379
- :rtype: list[AnalysisListOutput]
2130
+ :param str container_name: The parent container type (required)
2131
+ :param str container_id: The parent container id (required)
2132
+ :param str subcontainer_name: The sub container type (required)
2133
+ :param bool async_: Perform the request asynchronously
2134
+ :return: list[AnalysisListOutput]
2380
2135
  """
2381
2136
 
2382
2137
  all_params = ['container_name','container_id','subcontainer_name',] # noqa: E501
@@ -2457,17 +2212,12 @@ class AnalysesApi(object):
2457
2212
  Get an analysis by its id
2458
2213
  This method makes a synchronous HTTP request by default.
2459
2214
 
2460
- :param analysis_id: 24-char hex analysis id
2461
- :type analysis_id: str
2462
- :param inflate_job: expand job info, defaults to false
2463
- :type inflate_job: bool, optional
2464
- :param join_avatars: add name and avatar to notes, defaults to false
2465
- :type join_avatars: bool, optional
2466
- :param join:
2467
- :type join: JoinType, optional
2468
- :param async_: Perform the request asynchronously
2469
- :type async_: bool, optional
2470
- :rtype: union[AnalysisOutput,AnalysisOutputInflatedJob]
2215
+ :param str analysis_id: 24-char hex analysis id (required)
2216
+ :param bool inflate_job: expand job info
2217
+ :param bool join_avatars: add name and avatar to notes
2218
+ :param JoinType join:
2219
+ :param bool async_: Perform the request asynchronously
2220
+ :return: union[AnalysisOutput,AnalysisOutputInflatedJob]
2471
2221
  """
2472
2222
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2473
2223
  kwargs['_return_http_data_only'] = True
@@ -2491,17 +2241,12 @@ class AnalysesApi(object):
2491
2241
  Get an analysis by its id
2492
2242
  This method makes a synchronous HTTP request by default.
2493
2243
 
2494
- :param analysis_id: 24-char hex analysis id
2495
- :type analysis_id: str
2496
- :param inflate_job: expand job info, defaults to false
2497
- :type inflate_job: bool, optional
2498
- :param join_avatars: add name and avatar to notes, defaults to false
2499
- :type join_avatars: bool, optional
2500
- :param join:
2501
- :type join: JoinType, optional
2502
- :param async_: Perform the request asynchronously
2503
- :type async_: bool, optional
2504
- :rtype: union[AnalysisOutput,AnalysisOutputInflatedJob]
2244
+ :param str analysis_id: 24-char hex analysis id (required)
2245
+ :param bool inflate_job: expand job info
2246
+ :param bool join_avatars: add name and avatar to notes
2247
+ :param JoinType join:
2248
+ :param bool async_: Perform the request asynchronously
2249
+ :return: union[AnalysisOutput,AnalysisOutputInflatedJob]
2505
2250
  """
2506
2251
 
2507
2252
  all_params = ['analysis_id','inflate_job','join_avatars','join',] # noqa: E501
@@ -2578,13 +2323,10 @@ class AnalysesApi(object):
2578
2323
  Get metadata for an input file of an analysis.
2579
2324
  This method makes a synchronous HTTP request by default.
2580
2325
 
2581
- :param container_id: Container Id
2582
- :type container_id: str
2583
- :param filename:
2584
- :type filename: str
2585
- :param async_: Perform the request asynchronously
2586
- :type async_: bool, optional
2587
- :rtype: FileOutput
2326
+ :param str container_id: Container Id (required)
2327
+ :param str filename: (required)
2328
+ :param bool async_: Perform the request asynchronously
2329
+ :return: FileOutput
2588
2330
  """
2589
2331
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2590
2332
  kwargs['_return_http_data_only'] = True
@@ -2608,13 +2350,10 @@ class AnalysesApi(object):
2608
2350
  Get metadata for an input file of an analysis.
2609
2351
  This method makes a synchronous HTTP request by default.
2610
2352
 
2611
- :param container_id: Container Id
2612
- :type container_id: str
2613
- :param filename:
2614
- :type filename: str
2615
- :param async_: Perform the request asynchronously
2616
- :type async_: bool, optional
2617
- :rtype: FileOutput
2353
+ :param str container_id: Container Id (required)
2354
+ :param str filename: (required)
2355
+ :param bool async_: Perform the request asynchronously
2356
+ :return: FileOutput
2618
2357
  """
2619
2358
 
2620
2359
  all_params = ['container_id','filename',] # noqa: E501
@@ -2689,13 +2428,10 @@ class AnalysesApi(object):
2689
2428
  Get metadata for input file(s) for an analysis. There may be more than one since input filenames are not guaranteed to be unique.
2690
2429
  This method makes a synchronous HTTP request by default.
2691
2430
 
2692
- :param container_id: Container Id
2693
- :type container_id: str
2694
- :param filename:
2695
- :type filename: str
2696
- :param async_: Perform the request asynchronously
2697
- :type async_: bool, optional
2698
- :rtype: list[FileOutput]
2431
+ :param str container_id: Container Id (required)
2432
+ :param str filename: (required)
2433
+ :param bool async_: Perform the request asynchronously
2434
+ :return: list[FileOutput]
2699
2435
  """
2700
2436
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2701
2437
  kwargs['_return_http_data_only'] = True
@@ -2719,13 +2455,10 @@ class AnalysesApi(object):
2719
2455
  Get metadata for input file(s) for an analysis. There may be more than one since input filenames are not guaranteed to be unique.
2720
2456
  This method makes a synchronous HTTP request by default.
2721
2457
 
2722
- :param container_id: Container Id
2723
- :type container_id: str
2724
- :param filename:
2725
- :type filename: str
2726
- :param async_: Perform the request asynchronously
2727
- :type async_: bool, optional
2728
- :rtype: list[FileOutput]
2458
+ :param str container_id: Container Id (required)
2459
+ :param str filename: (required)
2460
+ :param bool async_: Perform the request asynchronously
2461
+ :return: list[FileOutput]
2729
2462
  """
2730
2463
 
2731
2464
  all_params = ['container_id','filename',] # noqa: E501
@@ -2800,13 +2533,10 @@ class AnalysesApi(object):
2800
2533
  Get a note of a(n) analysis
2801
2534
  This method makes a synchronous HTTP request by default.
2802
2535
 
2803
- :param container_id:
2804
- :type container_id: str
2805
- :param note_id:
2806
- :type note_id: str
2807
- :param async_: Perform the request asynchronously
2808
- :type async_: bool, optional
2809
- :rtype: Note
2536
+ :param str container_id: (required)
2537
+ :param str note_id: (required)
2538
+ :param bool async_: Perform the request asynchronously
2539
+ :return: Note
2810
2540
  """
2811
2541
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2812
2542
  kwargs['_return_http_data_only'] = True
@@ -2830,13 +2560,10 @@ class AnalysesApi(object):
2830
2560
  Get a note of a(n) analysis
2831
2561
  This method makes a synchronous HTTP request by default.
2832
2562
 
2833
- :param container_id:
2834
- :type container_id: str
2835
- :param note_id:
2836
- :type note_id: str
2837
- :param async_: Perform the request asynchronously
2838
- :type async_: bool, optional
2839
- :rtype: Note
2563
+ :param str container_id: (required)
2564
+ :param str note_id: (required)
2565
+ :param bool async_: Perform the request asynchronously
2566
+ :return: Note
2840
2567
  """
2841
2568
 
2842
2569
  all_params = ['container_id','note_id',] # noqa: E501
@@ -2911,15 +2638,11 @@ class AnalysesApi(object):
2911
2638
  Get metadata for an output file of an analysis.
2912
2639
  This method makes a synchronous HTTP request by default.
2913
2640
 
2914
- :param cid: Container Id
2915
- :type cid: str
2916
- :param filename:
2917
- :type filename: str
2918
- :param ctype:
2919
- :type ctype: FileContainerType, optional
2920
- :param async_: Perform the request asynchronously
2921
- :type async_: bool, optional
2922
- :rtype: FileOutput
2641
+ :param str cid: Container Id (required)
2642
+ :param str filename: (required)
2643
+ :param FileContainerType ctype:
2644
+ :param bool async_: Perform the request asynchronously
2645
+ :return: FileOutput
2923
2646
  """
2924
2647
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2925
2648
  kwargs['_return_http_data_only'] = True
@@ -2943,15 +2666,11 @@ class AnalysesApi(object):
2943
2666
  Get metadata for an output file of an analysis.
2944
2667
  This method makes a synchronous HTTP request by default.
2945
2668
 
2946
- :param cid: Container Id
2947
- :type cid: str
2948
- :param filename:
2949
- :type filename: str
2950
- :param ctype:
2951
- :type ctype: FileContainerType, optional
2952
- :param async_: Perform the request asynchronously
2953
- :type async_: bool, optional
2954
- :rtype: FileOutput
2669
+ :param str cid: Container Id (required)
2670
+ :param str filename: (required)
2671
+ :param FileContainerType ctype:
2672
+ :param bool async_: Perform the request asynchronously
2673
+ :return: FileOutput
2955
2674
  """
2956
2675
 
2957
2676
  all_params = ['cid','filename','ctype',] # noqa: E501
@@ -3028,13 +2747,10 @@ class AnalysesApi(object):
3028
2747
  Get the value of a tag, by name
3029
2748
  This method makes a synchronous HTTP request by default.
3030
2749
 
3031
- :param container_id:
3032
- :type container_id: str
3033
- :param value: The tag to interact with
3034
- :type value: str
3035
- :param async_: Perform the request asynchronously
3036
- :type async_: bool, optional
3037
- :rtype: str
2750
+ :param str container_id: (required)
2751
+ :param str value: The tag to interact with (required)
2752
+ :param bool async_: Perform the request asynchronously
2753
+ :return: str
3038
2754
  """
3039
2755
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3040
2756
  kwargs['_return_http_data_only'] = True
@@ -3058,13 +2774,10 @@ class AnalysesApi(object):
3058
2774
  Get the value of a tag, by name
3059
2775
  This method makes a synchronous HTTP request by default.
3060
2776
 
3061
- :param container_id:
3062
- :type container_id: str
3063
- :param value: The tag to interact with
3064
- :type value: str
3065
- :param async_: Perform the request asynchronously
3066
- :type async_: bool, optional
3067
- :rtype: str
2777
+ :param str container_id: (required)
2778
+ :param str value: The tag to interact with (required)
2779
+ :param bool async_: Perform the request asynchronously
2780
+ :return: str
3068
2781
  """
3069
2782
 
3070
2783
  all_params = ['container_id','value',] # noqa: E501
@@ -3139,13 +2852,10 @@ class AnalysesApi(object):
3139
2852
  Modify an analysis by its id Args: analysis_id: The id of the analysis analysis_modify: The modifications to make auth_session: The auth session
3140
2853
  This method makes a synchronous HTTP request by default.
3141
2854
 
3142
- :param analysis_id: 24-char hex analysis id
3143
- :type analysis_id: str
3144
- :param body:
3145
- :type body: AnalysisModifyInput
3146
- :param async_: Perform the request asynchronously
3147
- :type async_: bool, optional
3148
- :rtype: ModifiedResult
2855
+ :param str analysis_id: 24-char hex analysis id (required)
2856
+ :param AnalysisModifyInput body: (required)
2857
+ :param bool async_: Perform the request asynchronously
2858
+ :return: ModifiedResult
3149
2859
  """
3150
2860
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3151
2861
  kwargs['_return_http_data_only'] = True
@@ -3169,13 +2879,10 @@ class AnalysesApi(object):
3169
2879
  Modify an analysis by its id Args: analysis_id: The id of the analysis analysis_modify: The modifications to make auth_session: The auth session
3170
2880
  This method makes a synchronous HTTP request by default.
3171
2881
 
3172
- :param analysis_id: 24-char hex analysis id
3173
- :type analysis_id: str
3174
- :param body:
3175
- :type body: AnalysisModifyInput
3176
- :param async_: Perform the request asynchronously
3177
- :type async_: bool, optional
3178
- :rtype: ModifiedResult
2882
+ :param str analysis_id: 24-char hex analysis id (required)
2883
+ :param AnalysisModifyInput body: (required)
2884
+ :param bool async_: Perform the request asynchronously
2885
+ :return: ModifiedResult
3179
2886
  """
3180
2887
 
3181
2888
  all_params = ['analysis_id','body',] # noqa: E501
@@ -3261,15 +2968,11 @@ class AnalysesApi(object):
3261
2968
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
3262
2969
  This method makes a synchronous HTTP request by default.
3263
2970
 
3264
- :param cid:
3265
- :type cid: str
3266
- :param filename:
3267
- :type filename: str
3268
- :param body:
3269
- :type body: FileModifyInput
3270
- :param async_: Perform the request asynchronously
3271
- :type async_: bool, optional
3272
- :rtype: ModifiedResult
2971
+ :param str cid: (required)
2972
+ :param str filename: (required)
2973
+ :param FileModifyInput body: (required)
2974
+ :param bool async_: Perform the request asynchronously
2975
+ :return: ModifiedResult
3273
2976
  """
3274
2977
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3275
2978
  kwargs['_return_http_data_only'] = True
@@ -3293,15 +2996,11 @@ class AnalysesApi(object):
3293
2996
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
3294
2997
  This method makes a synchronous HTTP request by default.
3295
2998
 
3296
- :param cid:
3297
- :type cid: str
3298
- :param filename:
3299
- :type filename: str
3300
- :param body:
3301
- :type body: FileModifyInput
3302
- :param async_: Perform the request asynchronously
3303
- :type async_: bool, optional
3304
- :rtype: ModifiedResult
2999
+ :param str cid: (required)
3000
+ :param str filename: (required)
3001
+ :param FileModifyInput body: (required)
3002
+ :param bool async_: Perform the request asynchronously
3003
+ :return: ModifiedResult
3305
3004
  """
3306
3005
 
3307
3006
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3393,15 +3092,11 @@ class AnalysesApi(object):
3393
3092
  If replacing a file's classification, the modality can optionally be modified as well.
3394
3093
  This method makes a synchronous HTTP request by default.
3395
3094
 
3396
- :param cid:
3397
- :type cid: str
3398
- :param filename:
3399
- :type filename: str
3400
- :param body:
3401
- :type body: FileClassificationDelta
3402
- :param async_: Perform the request asynchronously
3403
- :type async_: bool, optional
3404
- :rtype: ModifiedResult
3095
+ :param str cid: (required)
3096
+ :param str filename: (required)
3097
+ :param FileClassificationDelta body: (required)
3098
+ :param bool async_: Perform the request asynchronously
3099
+ :return: ModifiedResult
3405
3100
  """
3406
3101
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3407
3102
  kwargs['_return_http_data_only'] = True
@@ -3425,15 +3120,11 @@ class AnalysesApi(object):
3425
3120
  If replacing a file's classification, the modality can optionally be modified as well.
3426
3121
  This method makes a synchronous HTTP request by default.
3427
3122
 
3428
- :param cid:
3429
- :type cid: str
3430
- :param filename:
3431
- :type filename: str
3432
- :param body:
3433
- :type body: FileClassificationDelta
3434
- :param async_: Perform the request asynchronously
3435
- :type async_: bool, optional
3436
- :rtype: ModifiedResult
3123
+ :param str cid: (required)
3124
+ :param str filename: (required)
3125
+ :param FileClassificationDelta body: (required)
3126
+ :param bool async_: Perform the request asynchronously
3127
+ :return: ModifiedResult
3437
3128
  """
3438
3129
 
3439
3130
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3525,15 +3216,11 @@ class AnalysesApi(object):
3525
3216
  Modify and return the file 'info' field
3526
3217
  This method makes a synchronous HTTP request by default.
3527
3218
 
3528
- :param cid:
3529
- :type cid: str
3530
- :param filename:
3531
- :type filename: str
3532
- :param body:
3533
- :type body: Info
3534
- :param async_: Perform the request asynchronously
3535
- :type async_: bool, optional
3536
- :rtype: ModifiedResult
3219
+ :param str cid: (required)
3220
+ :param str filename: (required)
3221
+ :param Info body: (required)
3222
+ :param bool async_: Perform the request asynchronously
3223
+ :return: ModifiedResult
3537
3224
  """
3538
3225
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3539
3226
  kwargs['_return_http_data_only'] = True
@@ -3557,15 +3244,11 @@ class AnalysesApi(object):
3557
3244
  Modify and return the file 'info' field
3558
3245
  This method makes a synchronous HTTP request by default.
3559
3246
 
3560
- :param cid:
3561
- :type cid: str
3562
- :param filename:
3563
- :type filename: str
3564
- :param body:
3565
- :type body: Info
3566
- :param async_: Perform the request asynchronously
3567
- :type async_: bool, optional
3568
- :rtype: ModifiedResult
3247
+ :param str cid: (required)
3248
+ :param str filename: (required)
3249
+ :param Info body: (required)
3250
+ :param bool async_: Perform the request asynchronously
3251
+ :return: ModifiedResult
3569
3252
  """
3570
3253
 
3571
3254
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3657,13 +3340,10 @@ class AnalysesApi(object):
3657
3340
  Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
3658
3341
  This method makes a synchronous HTTP request by default.
3659
3342
 
3660
- :param container_id:
3661
- :type container_id: str
3662
- :param body:
3663
- :type body: Info
3664
- :param async_: Perform the request asynchronously
3665
- :type async_: bool, optional
3666
- :rtype: ModifiedResult
3343
+ :param str container_id: (required)
3344
+ :param Info body: (required)
3345
+ :param bool async_: Perform the request asynchronously
3346
+ :return: ModifiedResult
3667
3347
  """
3668
3348
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3669
3349
  kwargs['_return_http_data_only'] = True
@@ -3687,13 +3367,10 @@ class AnalysesApi(object):
3687
3367
  Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
3688
3368
  This method makes a synchronous HTTP request by default.
3689
3369
 
3690
- :param container_id:
3691
- :type container_id: str
3692
- :param body:
3693
- :type body: Info
3694
- :param async_: Perform the request asynchronously
3695
- :type async_: bool, optional
3696
- :rtype: ModifiedResult
3370
+ :param str container_id: (required)
3371
+ :param Info body: (required)
3372
+ :param bool async_: Perform the request asynchronously
3373
+ :return: ModifiedResult
3697
3374
  """
3698
3375
 
3699
3376
  all_params = ['container_id','body',] # noqa: E501
@@ -3779,15 +3456,11 @@ class AnalysesApi(object):
3779
3456
  Update a note of a(n) analysis
3780
3457
  This method makes a synchronous HTTP request by default.
3781
3458
 
3782
- :param container_id:
3783
- :type container_id: str
3784
- :param note_id:
3785
- :type note_id: str
3786
- :param body:
3787
- :type body: NoteInput
3788
- :param async_: Perform the request asynchronously
3789
- :type async_: bool, optional
3790
- :rtype: int
3459
+ :param str container_id: (required)
3460
+ :param str note_id: (required)
3461
+ :param NoteInput body: (required)
3462
+ :param bool async_: Perform the request asynchronously
3463
+ :return: int
3791
3464
  """
3792
3465
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3793
3466
  kwargs['_return_http_data_only'] = True
@@ -3811,15 +3484,11 @@ class AnalysesApi(object):
3811
3484
  Update a note of a(n) analysis
3812
3485
  This method makes a synchronous HTTP request by default.
3813
3486
 
3814
- :param container_id:
3815
- :type container_id: str
3816
- :param note_id:
3817
- :type note_id: str
3818
- :param body:
3819
- :type body: NoteInput
3820
- :param async_: Perform the request asynchronously
3821
- :type async_: bool, optional
3822
- :rtype: int
3487
+ :param str container_id: (required)
3488
+ :param str note_id: (required)
3489
+ :param NoteInput body: (required)
3490
+ :param bool async_: Perform the request asynchronously
3491
+ :return: int
3823
3492
  """
3824
3493
 
3825
3494
  all_params = ['container_id','note_id','body',] # noqa: E501
@@ -3911,15 +3580,11 @@ class AnalysesApi(object):
3911
3580
  Rename a tag
3912
3581
  This method makes a synchronous HTTP request by default.
3913
3582
 
3914
- :param container_id:
3915
- :type container_id: str
3916
- :param value: The tag to interact with
3917
- :type value: str
3918
- :param body:
3919
- :type body: Tag
3920
- :param async_: Perform the request asynchronously
3921
- :type async_: bool, optional
3922
- :rtype: str
3583
+ :param str container_id: (required)
3584
+ :param str value: The tag to interact with (required)
3585
+ :param Tag body: (required)
3586
+ :param bool async_: Perform the request asynchronously
3587
+ :return: str
3923
3588
  """
3924
3589
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3925
3590
  kwargs['_return_http_data_only'] = True
@@ -3943,15 +3608,11 @@ class AnalysesApi(object):
3943
3608
  Rename a tag
3944
3609
  This method makes a synchronous HTTP request by default.
3945
3610
 
3946
- :param container_id:
3947
- :type container_id: str
3948
- :param value: The tag to interact with
3949
- :type value: str
3950
- :param body:
3951
- :type body: Tag
3952
- :param async_: Perform the request asynchronously
3953
- :type async_: bool, optional
3954
- :rtype: str
3611
+ :param str container_id: (required)
3612
+ :param str value: The tag to interact with (required)
3613
+ :param Tag body: (required)
3614
+ :param bool async_: Perform the request asynchronously
3615
+ :return: str
3955
3616
  """
3956
3617
 
3957
3618
  all_params = ['container_id','value','body',] # noqa: E501
@@ -4043,29 +3704,18 @@ class AnalysesApi(object):
4043
3704
  Upload an output file to an analysis
4044
3705
  This method makes a synchronous HTTP request by default.
4045
3706
 
4046
- :param container_id:
4047
- :type container_id: str
4048
- :param file: The file to upload
4049
- :type file: str
4050
- :param ticket:
4051
- :type ticket: str, optional
4052
- :param preserve_metadata:, defaults to false
4053
- :type preserve_metadata: bool, optional
4054
- :param id:
4055
- :type id: str, optional
4056
- :param level:
4057
- :type level: ContainerType, optional
4058
- :param job:
4059
- :type job: str, optional
4060
- :param metadata: Dictionary of file metadata (type, modality, info, etc.)
4061
- :type metadata: object, optional
4062
- :param x_accept_feature: redirect header, defaults to []
4063
- :type x_accept_feature: list[str], optional
4064
- :param content_type:
4065
- :type content_type: str, optional
4066
- :param async_: Perform the request asynchronously
4067
- :type async_: bool, optional
4068
- :rtype: union[list[FileOutput],UploadTicketOutput]
3707
+ :param str container_id: (required)
3708
+ :param str file: The file to upload (required)
3709
+ :param str ticket:
3710
+ :param bool preserve_metadata:
3711
+ :param str id:
3712
+ :param ContainerType level:
3713
+ :param str job:
3714
+ :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
3715
+ :param list[str] x_accept_feature: redirect header
3716
+ :param str content_type:
3717
+ :param bool async_: Perform the request asynchronously
3718
+ :return: union[list[FileOutput],UploadTicketOutput]
4069
3719
  """
4070
3720
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4071
3721
  kwargs['_return_http_data_only'] = True
@@ -4089,29 +3739,18 @@ class AnalysesApi(object):
4089
3739
  Upload an output file to an analysis
4090
3740
  This method makes a synchronous HTTP request by default.
4091
3741
 
4092
- :param container_id:
4093
- :type container_id: str
4094
- :param file: The file to upload
4095
- :type file: str
4096
- :param ticket:
4097
- :type ticket: str, optional
4098
- :param preserve_metadata:, defaults to false
4099
- :type preserve_metadata: bool, optional
4100
- :param id:
4101
- :type id: str, optional
4102
- :param level:
4103
- :type level: ContainerType, optional
4104
- :param job:
4105
- :type job: str, optional
4106
- :param metadata: Dictionary of file metadata (type, modality, info, etc.)
4107
- :type metadata: object, optional
4108
- :param x_accept_feature: redirect header, defaults to []
4109
- :type x_accept_feature: list[str], optional
4110
- :param content_type:
4111
- :type content_type: str, optional
4112
- :param async_: Perform the request asynchronously
4113
- :type async_: bool, optional
4114
- :rtype: union[list[FileOutput],UploadTicketOutput]
3742
+ :param str container_id: (required)
3743
+ :param str file: The file to upload (required)
3744
+ :param str ticket:
3745
+ :param bool preserve_metadata:
3746
+ :param str id:
3747
+ :param ContainerType level:
3748
+ :param str job:
3749
+ :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
3750
+ :param list[str] x_accept_feature: redirect header
3751
+ :param str content_type:
3752
+ :param bool async_: Perform the request asynchronously
3753
+ :return: union[list[FileOutput],UploadTicketOutput]
4115
3754
  """
4116
3755
 
4117
3756
  all_params = ['container_id','file','ticket','preserve_metadata','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501