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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (773) hide show
  1. flywheel/__init__.py +6 -8
  2. flywheel/api/acquisitions_api.py +1033 -569
  3. flywheel/api/analyses_api.py +786 -432
  4. flywheel/api/audit_trail_api.py +78 -51
  5. flywheel/api/auth_api.py +6 -11
  6. flywheel/api/batch_api.py +60 -43
  7. flywheel/api/bulk_api.py +10 -13
  8. flywheel/api/change_log_api.py +40 -29
  9. flywheel/api/collections_api.py +740 -410
  10. flywheel/api/config_api.py +18 -19
  11. flywheel/api/container_tasks_api.py +14 -15
  12. flywheel/api/container_type_api.py +14 -15
  13. flywheel/api/containers_api.py +989 -545
  14. flywheel/api/custom_filters_api.py +64 -43
  15. flywheel/api/data_view_executions_api.py +94 -59
  16. flywheel/api/dataexplorer_api.py +158 -99
  17. flywheel/api/devices_api.py +132 -83
  18. flywheel/api/dimse_api.py +72 -51
  19. flywheel/api/download_api.py +46 -32
  20. flywheel/api/files_api.py +266 -157
  21. flywheel/api/form_responses_api.py +100 -63
  22. flywheel/api/gears_api.py +278 -163
  23. flywheel/api/groups_api.py +426 -245
  24. flywheel/api/jobs_api.py +288 -173
  25. flywheel/api/jupyterlab_servers_api.py +24 -21
  26. flywheel/api/modalities_api.py +78 -51
  27. flywheel/api/packfiles_api.py +6 -11
  28. flywheel/api/projects_api.py +1661 -856
  29. flywheel/api/protocols_api.py +94 -61
  30. flywheel/api/reports_api.py +196 -115
  31. flywheel/api/resolve_api.py +48 -33
  32. flywheel/api/roles_api.py +82 -53
  33. flywheel/api/sessions_api.py +1137 -623
  34. flywheel/api/site_api.py +182 -113
  35. flywheel/api/staffing_pools_api.py +88 -57
  36. flywheel/api/subjects_api.py +1095 -603
  37. flywheel/api/tasks_api.py +108 -69
  38. flywheel/api/tree_api.py +52 -35
  39. flywheel/api/uids_api.py +10 -13
  40. flywheel/api/upload_api.py +162 -95
  41. flywheel/api/users_api.py +418 -235
  42. flywheel/api/views_api.py +222 -127
  43. flywheel/api_client.py +19 -18
  44. flywheel/configuration.py +2 -9
  45. flywheel/file_spec.py +0 -7
  46. flywheel/flywheel.py +818 -4423
  47. flywheel/gear_context.py +10 -10
  48. flywheel/models/__init__.py +6 -8
  49. flywheel/models/access_level.py +0 -7
  50. flywheel/models/access_permission.py +13 -14
  51. flywheel/models/access_permission_output.py +13 -14
  52. flywheel/models/access_permission_update.py +8 -11
  53. flywheel/models/access_type.py +0 -7
  54. flywheel/models/accumulator.py +0 -7
  55. flywheel/models/acquisition.py +0 -7
  56. flywheel/models/acquisition_container_output.py +0 -7
  57. flywheel/models/acquisition_copy_input.py +18 -17
  58. flywheel/models/acquisition_input.py +33 -26
  59. flywheel/models/acquisition_list_output.py +118 -77
  60. flywheel/models/acquisition_modify_input.py +33 -26
  61. flywheel/models/acquisition_node.py +0 -7
  62. flywheel/models/acquisition_output.py +118 -77
  63. flywheel/models/acquisition_parents.py +23 -20
  64. flywheel/models/acquisition_template_options.py +28 -23
  65. flywheel/models/acquisition_upsert_input.py +48 -35
  66. flywheel/models/acquisition_upsert_output.py +23 -20
  67. flywheel/models/action.py +1 -7
  68. flywheel/models/adhoc_analysis_input.py +23 -20
  69. flywheel/models/analysis.py +0 -7
  70. flywheel/models/analysis_container_output.py +0 -7
  71. flywheel/models/analysis_files_create_ticket_output.py +23 -20
  72. flywheel/models/analysis_input.py +33 -26
  73. flywheel/models/analysis_input_legacy.py +0 -7
  74. flywheel/models/analysis_list_output.py +103 -68
  75. flywheel/models/analysis_list_output_inflated_job.py +98 -65
  76. flywheel/models/analysis_modify_input.py +13 -14
  77. flywheel/models/analysis_node.py +0 -7
  78. flywheel/models/analysis_output.py +103 -68
  79. flywheel/models/analysis_output_inflated_job.py +103 -68
  80. flywheel/models/analysis_parents.py +28 -23
  81. flywheel/models/analysis_update.py +0 -7
  82. flywheel/models/api_key_input_with_optional_label.py +13 -14
  83. flywheel/models/api_key_output.py +33 -26
  84. flywheel/models/as_storage.py +33 -26
  85. flywheel/models/assignee.py +13 -14
  86. flywheel/models/assignee_type.py +0 -7
  87. flywheel/models/audit_trail_report.py +68 -47
  88. flywheel/models/audit_trail_report_status.py +0 -7
  89. flywheel/models/auth0_auth_out.py +38 -29
  90. flywheel/models/auth0_options_out.py +38 -29
  91. flywheel/models/auth_out.py +34 -82
  92. flywheel/models/auth_session_output.py +28 -23
  93. flywheel/models/avatars.py +18 -17
  94. flywheel/models/aws_creds.py +13 -14
  95. flywheel/models/aws_storage.py +43 -32
  96. flywheel/models/azure_creds.py +13 -14
  97. flywheel/models/base_aet.py +23 -20
  98. flywheel/models/base_compute.py +58 -41
  99. flywheel/models/batch.py +43 -32
  100. flywheel/models/batch_cancel_output.py +0 -7
  101. flywheel/models/batch_create_filters.py +18 -17
  102. flywheel/models/batch_job_analysis_input.py +28 -23
  103. flywheel/models/batch_jobs_proposal_input.py +0 -7
  104. flywheel/models/batch_proposal.py +0 -7
  105. flywheel/models/batch_proposal_detail.py +0 -7
  106. flywheel/models/batch_proposal_input.py +0 -7
  107. flywheel/models/body.py +0 -7
  108. flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +0 -7
  109. flywheel/models/body_region.py +0 -7
  110. flywheel/models/bookmark.py +13 -14
  111. flywheel/models/bulk_move_input.py +28 -23
  112. flywheel/models/bulk_move_sessions.py +0 -7
  113. flywheel/models/callbacks_virus_scan_input.py +0 -7
  114. flywheel/models/cancelled_batch_output.py +8 -11
  115. flywheel/models/catalog_list_output.py +53 -38
  116. flywheel/models/central_out.py +33 -26
  117. flywheel/models/change.py +80 -39
  118. flywheel/models/change_log_container_type.py +0 -7
  119. flywheel/models/change_log_document.py +23 -20
  120. flywheel/models/change_method.py +1 -7
  121. flywheel/models/classic_batch_job_output.py +43 -32
  122. flywheel/models/classic_batch_job_output_inflated_jobs.py +48 -35
  123. flywheel/models/classic_batch_proposal_input.py +48 -35
  124. flywheel/models/classic_batch_proposal_output.py +63 -44
  125. flywheel/models/classification_add_delete.py +0 -7
  126. flywheel/models/classification_replace.py +0 -7
  127. flywheel/models/classification_update_input.py +0 -7
  128. flywheel/models/cohort.py +0 -7
  129. flywheel/models/collection.py +0 -7
  130. flywheel/models/collection_container_output.py +0 -7
  131. flywheel/models/collection_input.py +18 -17
  132. flywheel/models/collection_input_with_contents.py +23 -20
  133. flywheel/models/collection_node.py +13 -14
  134. flywheel/models/collection_node_level.py +0 -7
  135. flywheel/models/collection_operation.py +13 -14
  136. flywheel/models/collection_operation_type.py +0 -7
  137. flywheel/models/collection_output.py +93 -62
  138. flywheel/models/collection_with_stats.py +93 -62
  139. flywheel/models/column.py +28 -23
  140. flywheel/models/column_type.py +0 -7
  141. flywheel/models/common_classification.py +3 -8
  142. flywheel/models/common_deleted_count.py +0 -7
  143. flywheel/models/common_editions.py +0 -7
  144. flywheel/models/common_info.py +3 -8
  145. flywheel/models/common_join_origins.py +0 -7
  146. flywheel/models/common_key.py +0 -7
  147. flywheel/models/common_modified_count.py +0 -7
  148. flywheel/models/common_object_created.py +0 -7
  149. flywheel/models/common_project_settings.py +0 -7
  150. flywheel/models/common_settings.py +0 -7
  151. flywheel/models/complete_multipart_upload_output.py +13 -14
  152. flywheel/models/complete_s3_multipart_upload_input.py +23 -20
  153. flywheel/models/config_feature_map.py +0 -7
  154. flywheel/models/config_out.py +48 -35
  155. flywheel/models/config_output.py +0 -7
  156. flywheel/models/config_site_config_output.py +0 -7
  157. flywheel/models/config_site_settings.py +0 -7
  158. flywheel/models/config_site_settings_input.py +0 -7
  159. flywheel/models/conflict_types.py +0 -7
  160. flywheel/models/container_delete_reason.py +0 -7
  161. flywheel/models/container_filter.py +13 -14
  162. flywheel/models/container_id_view_input.py +73 -50
  163. flywheel/models/container_id_view_input_execute_and_save.py +33 -26
  164. flywheel/models/container_modify.py +73 -50
  165. flywheel/models/container_new_output.py +0 -7
  166. flywheel/models/container_node_min.py +43 -32
  167. flywheel/models/container_output.py +0 -7
  168. flywheel/models/container_output_with_files.py +28 -23
  169. flywheel/models/container_parents.py +33 -26
  170. flywheel/models/container_pipeline_input.py +73 -50
  171. flywheel/models/container_project_parents.py +0 -7
  172. flywheel/models/container_reference.py +13 -14
  173. flywheel/models/container_reference_with_label.py +18 -17
  174. flywheel/models/container_session_parents.py +0 -7
  175. flywheel/models/container_subject_parents.py +0 -7
  176. flywheel/models/container_type.py +0 -7
  177. flywheel/models/container_uidcheck.py +23 -20
  178. flywheel/models/container_update.py +3 -8
  179. flywheel/models/context_input.py +18 -17
  180. flywheel/models/copy_filter.py +33 -26
  181. flywheel/models/copy_status.py +0 -7
  182. flywheel/models/core_models_api_key_api_key_input.py +13 -14
  183. flywheel/models/core_models_audit_trail_create_report_input.py +28 -23
  184. flywheel/models/core_models_audit_trail_modify_report_input.py +8 -11
  185. flywheel/models/core_models_common_source.py +13 -14
  186. flywheel/models/core_models_jobs_api_key_input.py +13 -14
  187. flywheel/models/core_models_search_parent_type.py +0 -7
  188. flywheel/models/core_workflows_form_responses_models_form_parents.py +33 -26
  189. flywheel/models/core_workflows_form_responses_models_form_response_output.py +58 -41
  190. flywheel/models/core_workflows_reader_models_reader_task_parents.py +33 -26
  191. flywheel/models/creds.py +3 -8
  192. flywheel/models/curator.py +18 -17
  193. flywheel/models/current_user_output.py +108 -71
  194. flywheel/models/custom_field.py +58 -41
  195. flywheel/models/custom_form.py +23 -20
  196. flywheel/models/cvat_info.py +28 -23
  197. flywheel/models/cvat_settings.py +28 -23
  198. flywheel/models/cvat_settings_input.py +28 -23
  199. flywheel/models/cvat_sync_state.py +0 -7
  200. flywheel/models/daily_report_usage.py +78 -53
  201. flywheel/models/data_strategy.py +0 -7
  202. flywheel/models/data_view.py +0 -7
  203. flywheel/models/data_view_analysis_file_spec.py +18 -17
  204. flywheel/models/data_view_analysis_filter_spec.py +18 -17
  205. flywheel/models/data_view_column_alias.py +38 -29
  206. flywheel/models/data_view_column_spec.py +28 -23
  207. flywheel/models/data_view_execution.py +68 -47
  208. flywheel/models/data_view_execution_state.py +0 -7
  209. flywheel/models/data_view_file_spec.py +48 -35
  210. flywheel/models/data_view_group_by.py +8 -11
  211. flywheel/models/data_view_group_by_column.py +13 -14
  212. flywheel/models/data_view_name_filter_spec.py +13 -14
  213. flywheel/models/data_view_output.py +0 -7
  214. flywheel/models/data_view_save_data_view_input.py +0 -7
  215. flywheel/models/data_view_zip_filter_spec.py +18 -17
  216. flywheel/models/default_flywheel_role.py +0 -7
  217. flywheel/models/deid_log_skip_reason.py +0 -7
  218. flywheel/models/delete_by_search_query.py +23 -20
  219. flywheel/models/delete_status.py +25 -0
  220. flywheel/models/deleted_file.py +73 -50
  221. flywheel/models/deleted_result.py +50 -19
  222. flywheel/models/deprecated_action.py +0 -7
  223. flywheel/models/destination_container_type.py +0 -7
  224. flywheel/models/device.py +58 -41
  225. flywheel/models/device_admin_update.py +13 -14
  226. flywheel/models/device_create.py +18 -17
  227. flywheel/models/device_self_update.py +28 -23
  228. flywheel/models/device_status.py +0 -7
  229. flywheel/models/device_status_entry.py +18 -17
  230. flywheel/models/device_storage_strategy_update.py +13 -14
  231. flywheel/models/dimse_project_input.py +0 -7
  232. flywheel/models/dimse_project_output.py +0 -7
  233. flywheel/models/dimse_service_input.py +0 -7
  234. flywheel/models/dimse_service_output.py +0 -7
  235. flywheel/models/download.py +23 -20
  236. flywheel/models/download_container_filter.py +8 -11
  237. flywheel/models/download_container_filter_definition.py +18 -17
  238. flywheel/models/download_filter.py +18 -17
  239. flywheel/models/download_filter_definition.py +13 -14
  240. flywheel/models/download_format.py +0 -7
  241. flywheel/models/download_input.py +0 -7
  242. flywheel/models/download_node.py +13 -14
  243. flywheel/models/download_strategy.py +0 -7
  244. flywheel/models/download_ticket.py +0 -7
  245. flywheel/models/download_ticket_stub.py +23 -20
  246. flywheel/models/download_ticket_with_summary.py +0 -7
  247. flywheel/models/e_signature.py +23 -20
  248. flywheel/models/edition.py +8 -11
  249. flywheel/models/egress_device.py +88 -59
  250. flywheel/models/egress_device_page.py +18 -17
  251. flywheel/models/egress_provider.py +53 -38
  252. flywheel/models/egress_provider_id.py +8 -11
  253. flywheel/models/exchange_storage.py +23 -20
  254. flywheel/models/executor_info.py +43 -32
  255. flywheel/models/export_templates.py +13 -14
  256. flywheel/models/features.py +348 -225
  257. flywheel/models/field_change.py +28 -23
  258. flywheel/models/field_change_log_document.py +23 -20
  259. flywheel/models/field_type.py +0 -7
  260. flywheel/models/file.py +188 -119
  261. flywheel/models/file_classification_delta.py +23 -20
  262. flywheel/models/file_container_type.py +0 -7
  263. flywheel/models/file_entry.py +108 -71
  264. flywheel/models/file_export_templates.py +28 -23
  265. flywheel/models/file_format.py +0 -7
  266. flywheel/models/file_gear_info.py +18 -17
  267. flywheel/models/file_group.py +0 -7
  268. flywheel/models/file_list_output.py +183 -116
  269. flywheel/models/file_modify_input.py +13 -14
  270. flywheel/models/file_move_input.py +18 -17
  271. flywheel/models/file_node.py +188 -119
  272. flywheel/models/file_node_min.py +38 -29
  273. flywheel/models/file_origin.py +28 -23
  274. flywheel/models/file_output.py +183 -116
  275. flywheel/models/file_parents.py +33 -26
  276. flywheel/models/file_reference.py +18 -17
  277. flywheel/models/file_suggestion.py +23 -20
  278. flywheel/models/file_template_options.py +33 -26
  279. flywheel/models/file_upsert_input.py +88 -59
  280. flywheel/models/file_upsert_origin.py +0 -7
  281. flywheel/models/file_upsert_output.py +188 -119
  282. flywheel/models/file_version.py +13 -14
  283. flywheel/models/file_version_copy_of.py +28 -23
  284. flywheel/models/file_version_output.py +38 -29
  285. flywheel/models/file_via.py +23 -20
  286. flywheel/models/file_zip_entry.py +0 -7
  287. flywheel/models/file_zip_info.py +0 -7
  288. flywheel/models/filter.py +43 -32
  289. flywheel/models/filter_input.py +18 -17
  290. flywheel/models/filter_values.py +13 -14
  291. flywheel/models/filter_view.py +0 -7
  292. flywheel/models/fixed_file_version_input.py +18 -17
  293. flywheel/models/fixed_input.py +33 -26
  294. flywheel/models/form_definition.py +8 -11
  295. flywheel/models/form_response_base.py +33 -26
  296. flywheel/models/form_response_create.py +13 -14
  297. flywheel/models/gcp_creds.py +53 -38
  298. flywheel/models/gcp_storage.py +33 -26
  299. flywheel/models/gear.py +88 -59
  300. flywheel/models/gear_category.py +0 -7
  301. flywheel/models/gear_config.py +3 -8
  302. flywheel/models/gear_context_input.py +8 -11
  303. flywheel/models/gear_context_lookup.py +0 -7
  304. flywheel/models/gear_context_lookup_item.py +0 -7
  305. flywheel/models/gear_context_value_output.py +28 -23
  306. flywheel/models/gear_context_value_output_unfound.py +8 -11
  307. flywheel/models/gear_custom.py +3 -8
  308. flywheel/models/gear_directive.py +3 -8
  309. flywheel/models/gear_doc.py +0 -7
  310. flywheel/models/gear_document.py +38 -29
  311. flywheel/models/gear_document_input.py +33 -26
  312. flywheel/models/gear_document_legacy_input.py +33 -26
  313. flywheel/models/gear_environment.py +3 -8
  314. flywheel/models/gear_exchange.py +18 -17
  315. flywheel/models/gear_file_input.py +13 -14
  316. flywheel/models/gear_id_output.py +8 -11
  317. flywheel/models/gear_info.py +23 -20
  318. flywheel/models/gear_input_item.py +18 -17
  319. flywheel/models/gear_inputs.py +3 -8
  320. flywheel/models/gear_key_input.py +13 -14
  321. flywheel/models/gear_manifest.py +93 -62
  322. flywheel/models/gear_mixin.py +26 -6
  323. flywheel/models/gear_node.py +43 -32
  324. flywheel/models/gear_output_configuration.py +8 -11
  325. flywheel/models/gear_permissions.py +13 -14
  326. flywheel/models/gear_permissions_input.py +8 -11
  327. flywheel/models/gear_permissions_type.py +0 -7
  328. flywheel/models/gear_return_ticket.py +0 -7
  329. flywheel/models/gear_rule.py +133 -69
  330. flywheel/models/gear_rule_condition.py +18 -17
  331. flywheel/models/gear_rule_condition_type.py +0 -7
  332. flywheel/models/gear_rule_input.py +108 -54
  333. flywheel/models/gear_rule_modify_input.py +103 -51
  334. flywheel/models/gear_rule_output.py +133 -69
  335. flywheel/models/gear_save_submission.py +18 -17
  336. flywheel/models/gear_series.py +33 -26
  337. flywheel/models/gear_series_update.py +8 -11
  338. flywheel/models/gear_suggestion_output.py +33 -26
  339. flywheel/models/gear_ticket.py +23 -20
  340. flywheel/models/gear_ticket_output.py +8 -11
  341. flywheel/models/graph_filter.py +38 -29
  342. flywheel/models/group.py +0 -7
  343. flywheel/models/group_by.py +8 -11
  344. flywheel/models/group_by_column.py +0 -7
  345. flywheel/models/group_container_output.py +0 -7
  346. flywheel/models/group_input.py +23 -20
  347. flywheel/models/group_metadata_input.py +0 -7
  348. flywheel/models/group_node.py +0 -7
  349. flywheel/models/group_output.py +63 -44
  350. flywheel/models/group_report.py +18 -17
  351. flywheel/models/group_role.py +8 -11
  352. flywheel/models/group_settings_output.py +23 -20
  353. flywheel/models/group_update.py +23 -20
  354. flywheel/models/header_feature.py +0 -7
  355. flywheel/models/hierarchy_export_templates.py +28 -23
  356. flywheel/models/http_validation_error.py +8 -11
  357. flywheel/models/info.py +18 -17
  358. flywheel/models/info_add_remove.py +0 -7
  359. flywheel/models/info_container_type.py +0 -7
  360. flywheel/models/info_replace.py +0 -7
  361. flywheel/models/info_update_input.py +0 -7
  362. flywheel/models/ingress_provider.py +33 -26
  363. flywheel/models/ingress_providers.py +28 -23
  364. flywheel/models/ingress_site_settings.py +29 -52
  365. flywheel/models/ingress_update_provider.py +18 -17
  366. flywheel/models/inline_response200.py +8 -11
  367. flywheel/models/inline_response2001.py +8 -11
  368. flywheel/models/inline_response2002.py +8 -11
  369. flywheel/models/inline_response2003.py +0 -7
  370. flywheel/models/inline_response2005.py +0 -7
  371. flywheel/models/input_filter.py +18 -17
  372. flywheel/models/input_job.py +73 -50
  373. flywheel/models/input_job_profile.py +28 -23
  374. flywheel/models/inserted_id.py +8 -11
  375. flywheel/models/job.py +128 -83
  376. flywheel/models/job_analysis_input.py +28 -23
  377. flywheel/models/job_ask.py +33 -26
  378. flywheel/models/job_ask_response.py +13 -14
  379. flywheel/models/job_ask_response_job.py +158 -101
  380. flywheel/models/job_ask_return.py +0 -7
  381. flywheel/models/job_ask_return_criteria.py +23 -20
  382. flywheel/models/job_ask_state.py +0 -7
  383. flywheel/models/job_ask_state_response.py +8 -11
  384. flywheel/models/job_complete.py +18 -17
  385. flywheel/models/job_completion_input.py +0 -7
  386. flywheel/models/job_completion_ticket.py +0 -7
  387. flywheel/models/job_config.py +3 -8
  388. flywheel/models/job_config_input.py +28 -23
  389. flywheel/models/job_config_inputs.py +0 -7
  390. flywheel/models/job_config_output.py +0 -7
  391. flywheel/models/job_container_detail.py +0 -7
  392. flywheel/models/job_destination.py +13 -14
  393. flywheel/models/job_detail.py +148 -95
  394. flywheel/models/job_detail_container.py +13 -14
  395. flywheel/models/job_detail_file_entry.py +13 -14
  396. flywheel/models/job_detail_group.py +13 -14
  397. flywheel/models/job_detail_parent_info.py +33 -26
  398. flywheel/models/job_executor_info.py +43 -32
  399. flywheel/models/job_file_input.py +23 -20
  400. flywheel/models/job_file_input_list_output.py +23 -20
  401. flywheel/models/job_file_object.py +58 -41
  402. flywheel/models/job_file_object_list_output.py +53 -38
  403. flywheel/models/job_gear_match.py +0 -7
  404. flywheel/models/job_inputs_array_item.py +33 -26
  405. flywheel/models/job_inputs_item.py +23 -20
  406. flywheel/models/job_inputs_object.py +3 -8
  407. flywheel/models/job_list_entry.py +0 -7
  408. flywheel/models/job_list_output.py +158 -101
  409. flywheel/models/job_list_output_config.py +18 -17
  410. flywheel/models/job_log.py +13 -14
  411. flywheel/models/job_log_column.py +0 -7
  412. flywheel/models/job_log_record.py +13 -14
  413. flywheel/models/job_modify.py +13 -14
  414. flywheel/models/job_origin.py +13 -14
  415. flywheel/models/job_output.py +163 -104
  416. flywheel/models/job_output_config.py +23 -20
  417. flywheel/models/job_parents.py +33 -26
  418. flywheel/models/job_priority.py +0 -7
  419. flywheel/models/job_priority_update.py +13 -14
  420. flywheel/models/job_profile.py +53 -38
  421. flywheel/models/job_profile_input.py +0 -7
  422. flywheel/models/job_request.py +18 -17
  423. flywheel/models/job_request_item.py +23 -20
  424. flywheel/models/job_request_item_type.py +0 -7
  425. flywheel/models/job_request_target.py +28 -23
  426. flywheel/models/job_state.py +0 -7
  427. flywheel/models/job_state_counts.py +0 -7
  428. flywheel/models/job_stats_by_state.py +0 -7
  429. flywheel/models/job_ticket_output.py +8 -11
  430. flywheel/models/job_transition_times.py +23 -20
  431. flywheel/models/job_version_info.py +3 -8
  432. flywheel/models/jobs_by_state.py +28 -23
  433. flywheel/models/jobs_list.py +8 -11
  434. flywheel/models/join_origin_device.py +8 -11
  435. flywheel/models/join_origin_job.py +18 -17
  436. flywheel/models/join_origin_user.py +13 -14
  437. flywheel/models/join_origins.py +18 -17
  438. flywheel/models/join_type.py +0 -7
  439. flywheel/models/jupyterhub_workspace.py +8 -11
  440. flywheel/models/jupyterlab_server_modify.py +28 -23
  441. flywheel/models/jupyterlab_server_origin.py +0 -7
  442. flywheel/models/jupyterlab_server_output.py +0 -7
  443. flywheel/models/jupyterlab_server_response.py +53 -38
  444. flywheel/models/jupyterlab_server_update.py +0 -7
  445. flywheel/models/ldap_sync.py +0 -7
  446. flywheel/models/ldap_sync_config.py +8 -11
  447. flywheel/models/ldap_sync_input.py +0 -7
  448. flywheel/models/ldap_sync_status.py +23 -20
  449. flywheel/models/legacy_api_key_output.py +28 -23
  450. flywheel/models/legacy_input.py +23 -20
  451. flywheel/models/legacy_usage_report.py +33 -26
  452. flywheel/models/legacys_usage_project_entry.py +13 -14
  453. flywheel/models/libs_viewer_config_models_viewer_config.py +194 -0
  454. flywheel/models/libs_workflows_models_parent_type.py +0 -7
  455. flywheel/models/libs_workflows_models_task_status.py +0 -7
  456. flywheel/models/local_storage.py +18 -17
  457. flywheel/models/location.py +13 -14
  458. flywheel/models/locked.py +18 -17
  459. flywheel/models/master_subject_code_dob_input.py +28 -23
  460. flywheel/models/master_subject_code_input.py +28 -23
  461. flywheel/models/master_subject_code_output.py +8 -11
  462. flywheel/models/matched_acquisition_output.py +73 -50
  463. flywheel/models/measurement_config.py +222 -0
  464. flywheel/models/measurement_item_config.py +217 -0
  465. flywheel/models/mfa_channel.py +0 -7
  466. flywheel/models/mfa_settings.py +8 -11
  467. flywheel/models/ml_set_filter.py +13 -14
  468. flywheel/models/ml_type.py +0 -7
  469. flywheel/models/modality.py +23 -20
  470. flywheel/models/modality_input.py +23 -20
  471. flywheel/models/modality_modify.py +18 -17
  472. flywheel/models/modality_output.py +28 -23
  473. flywheel/models/modified_result.py +13 -14
  474. flywheel/models/modify_user_input.py +63 -44
  475. flywheel/models/move_conflict.py +33 -26
  476. flywheel/models/note.py +48 -35
  477. flywheel/models/note_input.py +8 -11
  478. flywheel/models/optional_input_policy.py +0 -7
  479. flywheel/models/order.py +0 -7
  480. flywheel/models/organ_system.py +0 -7
  481. flywheel/models/origin.py +13 -14
  482. flywheel/models/origin_type.py +0 -7
  483. flywheel/models/orphaned_count.py +8 -11
  484. flywheel/models/output_user_page.py +18 -17
  485. flywheel/models/packfile_cleanup_output.py +8 -11
  486. flywheel/models/packfile_removed_output.py +13 -14
  487. flywheel/models/page.py +18 -17
  488. flywheel/models/page_generic_file_output.py +18 -17
  489. flywheel/models/page_generic_filter.py +18 -17
  490. flywheel/models/page_generic_form_response_output.py +18 -17
  491. flywheel/models/page_generic_protocol.py +23 -20
  492. flywheel/models/page_generic_reader_task_output.py +23 -20
  493. flywheel/models/page_generic_staffing_pool.py +23 -20
  494. flywheel/models/parsed_query_response.py +13 -14
  495. flywheel/models/permission_access_permission.py +0 -7
  496. flywheel/models/premade_jobs_batch_job_output.py +33 -26
  497. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +33 -26
  498. flywheel/models/premade_jobs_batch_proposal.py +38 -29
  499. flywheel/models/premade_jobs_batch_proposal_detail.py +8 -11
  500. flywheel/models/premade_jobs_batch_proposal_input.py +8 -11
  501. flywheel/models/project.py +0 -7
  502. flywheel/models/project_acquisition_upsert_input.py +0 -7
  503. flywheel/models/project_acquisition_upsert_output.py +0 -7
  504. flywheel/models/project_aet.py +38 -29
  505. flywheel/models/project_aet_input.py +23 -20
  506. flywheel/models/project_catalog_list_output.py +0 -7
  507. flywheel/models/project_contact.py +13 -14
  508. flywheel/models/project_container_output.py +1 -7
  509. flywheel/models/project_copy_input.py +23 -20
  510. flywheel/models/project_copy_output.py +18 -17
  511. flywheel/models/project_counters.py +76 -36
  512. flywheel/models/project_delete_status_output.py +192 -0
  513. flywheel/models/project_group_info.py +13 -14
  514. flywheel/models/project_hierarchy_input.py +28 -23
  515. flywheel/models/project_hierarchy_output.py +18 -17
  516. flywheel/models/project_hierarchy_upsert_input.py +0 -7
  517. flywheel/models/project_hierarchy_upsert_output.py +0 -7
  518. flywheel/models/project_input.py +48 -35
  519. flywheel/models/project_institution.py +13 -14
  520. flywheel/models/project_list_output.py +207 -96
  521. flywheel/models/project_locking_reason.py +0 -7
  522. flywheel/models/project_modify.py +116 -42
  523. flywheel/models/project_node.py +1 -7
  524. flywheel/models/project_output.py +208 -96
  525. flywheel/models/project_parents.py +8 -11
  526. flywheel/models/project_report.py +63 -44
  527. flywheel/models/project_report_list.py +8 -11
  528. flywheel/models/project_session_upsert_input.py +0 -7
  529. flywheel/models/project_session_upsert_output.py +0 -7
  530. flywheel/models/project_settings_input.py +38 -29
  531. flywheel/models/project_settings_output.py +38 -29
  532. flywheel/models/project_settings_sharing.py +38 -29
  533. flywheel/models/project_settings_sharing_input.py +38 -29
  534. flywheel/models/project_settings_workspaces.py +8 -11
  535. flywheel/models/project_settings_workspaces_input.py +8 -11
  536. flywheel/models/project_share_level.py +0 -7
  537. flywheel/models/project_sharing_settings_project_contact.py +0 -7
  538. flywheel/models/project_sharing_settings_project_counters.py +0 -7
  539. flywheel/models/project_sharing_settings_project_institution.py +0 -7
  540. flywheel/models/project_sharing_settings_project_settings_input.py +0 -7
  541. flywheel/models/project_sharing_settings_project_settings_output.py +0 -7
  542. flywheel/models/project_sharing_settings_project_settings_sharing.py +0 -7
  543. flywheel/models/project_sharing_settings_project_settings_sharing_input.py +0 -7
  544. flywheel/models/project_sharing_settings_project_stats.py +0 -7
  545. flywheel/models/project_stats.py +28 -23
  546. flywheel/models/project_subject_upsert_input.py +0 -7
  547. flywheel/models/project_subject_upsert_output.py +0 -7
  548. flywheel/models/project_template.py +13 -14
  549. flywheel/models/project_template_input.py +13 -14
  550. flywheel/models/project_template_list_input.py +8 -11
  551. flywheel/models/project_template_requirement.py +0 -7
  552. flywheel/models/project_template_session_template.py +0 -7
  553. flywheel/models/project_upsert_origin.py +0 -7
  554. flywheel/models/protocol.py +78 -53
  555. flywheel/models/protocol_e_signature_config.py +13 -14
  556. flywheel/models/protocol_input.py +43 -32
  557. flywheel/models/protocol_modify.py +28 -23
  558. flywheel/models/protocol_status.py +0 -7
  559. flywheel/models/provider.py +63 -44
  560. flywheel/models/provider_access_type.py +0 -7
  561. flywheel/models/provider_class.py +0 -7
  562. flywheel/models/provider_deletion_status.py +13 -14
  563. flywheel/models/provider_input.py +0 -7
  564. flywheel/models/provider_links.py +28 -23
  565. flywheel/models/provider_type.py +0 -7
  566. flywheel/models/providers.py +28 -23
  567. flywheel/models/reader_batch_create.py +63 -44
  568. flywheel/models/reader_task.py +113 -74
  569. flywheel/models/reader_task_config.py +49 -18
  570. flywheel/models/reader_task_create.py +78 -53
  571. flywheel/models/reader_task_modify.py +33 -26
  572. flywheel/models/reader_task_output.py +118 -77
  573. flywheel/models/reader_task_parent_details.py +38 -29
  574. flywheel/models/report_access_log_context.py +33 -26
  575. flywheel/models/report_access_log_context_entry.py +13 -14
  576. flywheel/models/report_access_log_context_file_entry.py +8 -11
  577. flywheel/models/report_access_log_entry.py +88 -59
  578. flywheel/models/report_access_log_origin.py +13 -14
  579. flywheel/models/report_availability_list.py +8 -11
  580. flywheel/models/report_daily_usage_entry.py +68 -47
  581. flywheel/models/report_demographics_grid.py +0 -7
  582. flywheel/models/report_ethnicity_grid.py +23 -20
  583. flywheel/models/report_gender_count.py +18 -17
  584. flywheel/models/report_group_report.py +18 -17
  585. flywheel/models/report_legacy_usage_entry.py +0 -7
  586. flywheel/models/report_legacy_usage_project_entry.py +0 -7
  587. flywheel/models/report_project.py +0 -7
  588. flywheel/models/report_site.py +13 -14
  589. flywheel/models/report_time_period.py +13 -14
  590. flywheel/models/report_usage.py +88 -59
  591. flywheel/models/report_usage_entry.py +0 -7
  592. flywheel/models/resolve_input.py +8 -11
  593. flywheel/models/resolve_output.py +13 -14
  594. flywheel/models/resolver_acquisition_node.py +0 -7
  595. flywheel/models/resolver_analysis_node.py +0 -7
  596. flywheel/models/resolver_file_node.py +0 -7
  597. flywheel/models/resolver_gear_node.py +0 -7
  598. flywheel/models/resolver_group_node.py +0 -7
  599. flywheel/models/resolver_input.py +0 -7
  600. flywheel/models/resolver_node.py +8 -11
  601. flywheel/models/resolver_output.py +0 -7
  602. flywheel/models/resolver_project_node.py +0 -7
  603. flywheel/models/resolver_session_node.py +0 -7
  604. flywheel/models/resolver_subject_node.py +0 -7
  605. flywheel/models/role_input.py +13 -14
  606. flywheel/models/role_output.py +28 -23
  607. flywheel/models/role_permission.py +13 -14
  608. flywheel/models/role_permission_output.py +13 -14
  609. flywheel/models/role_permission_update.py +8 -11
  610. flywheel/models/role_type.py +0 -7
  611. flywheel/models/role_update.py +13 -14
  612. flywheel/models/roles_backwards_compatible_role_assignment.py +0 -7
  613. flywheel/models/roles_group_role_pool_input.py +0 -7
  614. flywheel/models/roles_role.py +0 -7
  615. flywheel/models/roles_role_assignment.py +13 -14
  616. flywheel/models/roles_role_input.py +0 -7
  617. flywheel/models/rule.py +63 -44
  618. flywheel/models/rule_any.py +18 -17
  619. flywheel/models/s3_addressing_style.py +0 -7
  620. flywheel/models/s3_compat_storage.py +48 -35
  621. flywheel/models/save_search.py +33 -26
  622. flywheel/models/save_search_input.py +18 -17
  623. flywheel/models/save_search_output.py +33 -26
  624. flywheel/models/save_search_page.py +18 -17
  625. flywheel/models/save_search_parent.py +13 -14
  626. flywheel/models/save_search_update.py +13 -14
  627. flywheel/models/search_acquisition_response.py +23 -20
  628. flywheel/models/search_analysis_response.py +23 -20
  629. flywheel/models/search_collection_response.py +23 -20
  630. flywheel/models/search_file_response.py +33 -26
  631. flywheel/models/search_group_response.py +13 -14
  632. flywheel/models/search_parent_acquisition.py +0 -7
  633. flywheel/models/search_parent_analysis.py +0 -7
  634. flywheel/models/search_parent_collection.py +0 -7
  635. flywheel/models/search_parent_project.py +1 -7
  636. flywheel/models/search_parent_response.py +13 -14
  637. flywheel/models/search_parent_session.py +0 -7
  638. flywheel/models/search_parent_subject.py +0 -7
  639. flywheel/models/search_parse_error.py +23 -20
  640. flywheel/models/search_parse_search_query_result.py +0 -7
  641. flywheel/models/search_project_response.py +13 -14
  642. flywheel/models/search_query.py +38 -29
  643. flywheel/models/search_query_suggestions.py +0 -7
  644. flywheel/models/search_response.py +58 -41
  645. flywheel/models/search_return_type.py +0 -7
  646. flywheel/models/search_save_search.py +0 -7
  647. flywheel/models/search_save_search_input.py +0 -7
  648. flywheel/models/search_save_search_parent.py +0 -7
  649. flywheel/models/search_save_search_update.py +0 -7
  650. flywheel/models/search_session_response.py +23 -20
  651. flywheel/models/search_status.py +8 -11
  652. flywheel/models/search_structured_search_query.py +0 -7
  653. flywheel/models/search_subject_response.py +18 -17
  654. flywheel/models/search_suggestion.py +0 -7
  655. flywheel/models/select_item.py +13 -14
  656. flywheel/models/server_state.py +33 -26
  657. flywheel/models/service_aet.py +33 -26
  658. flywheel/models/service_aet_input.py +28 -23
  659. flywheel/models/session.py +0 -7
  660. flywheel/models/session_container_output.py +0 -7
  661. flywheel/models/session_copy_input.py +23 -20
  662. flywheel/models/session_embedded_subject.py +33 -26
  663. flywheel/models/session_input.py +58 -41
  664. flywheel/models/session_list_output.py +143 -92
  665. flywheel/models/session_metadata_input.py +0 -7
  666. flywheel/models/session_modify.py +63 -44
  667. flywheel/models/session_node.py +0 -7
  668. flywheel/models/session_output.py +143 -92
  669. flywheel/models/session_parents.py +18 -17
  670. flywheel/models/session_template_options.py +18 -17
  671. flywheel/models/session_template_recalc_output.py +8 -11
  672. flywheel/models/session_upsert_input.py +63 -44
  673. flywheel/models/session_upsert_output.py +23 -20
  674. flywheel/models/sharing_filter_options.py +43 -32
  675. flywheel/models/signed_fs_upload_output.py +13 -14
  676. flywheel/models/signed_url_cleanup_input.py +13 -14
  677. flywheel/models/signed_url_upload_input.py +13 -14
  678. flywheel/models/signed_url_upload_output.py +43 -32
  679. flywheel/models/site.py +93 -62
  680. flywheel/models/site_report.py +13 -14
  681. flywheel/models/site_settings.py +48 -35
  682. flywheel/models/sort.py +13 -14
  683. flywheel/models/stable_api_key_input.py +0 -7
  684. flywheel/models/staffing_pool.py +38 -29
  685. flywheel/models/staffing_pool_create.py +18 -17
  686. flywheel/models/staffing_pool_list.py +8 -11
  687. flywheel/models/staffing_pool_modify.py +18 -17
  688. flywheel/models/state.py +0 -7
  689. flywheel/models/static_compute.py +18 -17
  690. flywheel/models/status_transitions.py +23 -20
  691. flywheel/models/status_type.py +0 -7
  692. flywheel/models/status_value.py +0 -7
  693. flywheel/models/storage_strategy.py +0 -7
  694. flywheel/models/storage_strategy_config.py +13 -14
  695. flywheel/models/structured_query.py +8 -11
  696. flywheel/models/structured_query_suggestions.py +13 -14
  697. flywheel/models/structured_query_value_suggestion.py +23 -20
  698. flywheel/models/subject.py +0 -7
  699. flywheel/models/subject_container_output.py +0 -7
  700. flywheel/models/subject_copy_input.py +18 -17
  701. flywheel/models/subject_input.py +93 -62
  702. flywheel/models/subject_modify.py +103 -68
  703. flywheel/models/subject_node.py +0 -7
  704. flywheel/models/subject_output.py +163 -104
  705. flywheel/models/subject_output_for_list.py +163 -104
  706. flywheel/models/subject_parents.py +13 -14
  707. flywheel/models/subject_role_permission.py +13 -14
  708. flywheel/models/subject_state.py +0 -7
  709. flywheel/models/subject_template_options.py +13 -14
  710. flywheel/models/subject_upsert_input.py +83 -56
  711. flywheel/models/subject_upsert_output.py +18 -17
  712. flywheel/models/sync_user_input.py +38 -29
  713. flywheel/models/tag.py +8 -11
  714. flywheel/models/task_assign.py +13 -14
  715. flywheel/models/task_facet.py +0 -7
  716. flywheel/models/task_parent_ref.py +23 -20
  717. flywheel/models/task_parent_ref_input.py +18 -17
  718. flywheel/models/task_priority.py +0 -7
  719. flywheel/models/task_submission.py +13 -14
  720. flywheel/models/therapeutic_area.py +0 -7
  721. flywheel/models/toolbar_config.py +161 -0
  722. flywheel/models/transitions.py +28 -23
  723. flywheel/models/tree_container_request_spec.py +28 -23
  724. flywheel/models/tree_graph.py +3 -8
  725. flywheel/models/tree_graph_connection.py +23 -20
  726. flywheel/models/tree_graph_connections.py +3 -8
  727. flywheel/models/tree_graph_node.py +8 -11
  728. flywheel/models/tree_request.py +0 -7
  729. flywheel/models/tree_response_item.py +3 -8
  730. flywheel/models/type_str.py +0 -7
  731. flywheel/models/uid_check_input_acquisitions.py +23 -20
  732. flywheel/models/uid_check_input_sessions.py +23 -20
  733. flywheel/models/uid_check_output.py +13 -14
  734. flywheel/models/upload_complete_s3_multipart_input.py +0 -7
  735. flywheel/models/upload_complete_s3_multipart_output.py +0 -7
  736. flywheel/models/upload_signed_fs_file_upload_output.py +0 -7
  737. flywheel/models/upload_signed_upload_url_input.py +0 -7
  738. flywheel/models/upload_signed_upload_url_output.py +0 -7
  739. flywheel/models/upload_ticket_output.py +18 -17
  740. flywheel/models/upload_token_output.py +8 -11
  741. flywheel/models/upsert_result.py +0 -7
  742. flywheel/models/user.py +113 -74
  743. flywheel/models/user_api_key.py +18 -17
  744. flywheel/models/user_input.py +63 -44
  745. flywheel/models/user_jobs.py +18 -17
  746. flywheel/models/user_jobs_output.py +0 -7
  747. flywheel/models/user_output.py +0 -7
  748. flywheel/models/user_output_id.py +8 -11
  749. flywheel/models/user_preferences.py +3 -8
  750. flywheel/models/user_wechat.py +3 -8
  751. flywheel/models/validation_error.py +18 -17
  752. flywheel/models/validation_rule.py +13 -14
  753. flywheel/models/version.py +43 -32
  754. flywheel/models/version_output.py +0 -7
  755. flywheel/models/view_id_output.py +8 -11
  756. flywheel/models/view_output.py +58 -41
  757. flywheel/models/viewer_app.py +48 -35
  758. flywheel/models/viewer_app_input.py +48 -35
  759. flywheel/models/viewer_app_type.py +0 -7
  760. flywheel/models/virus_scan.py +8 -11
  761. flywheel/models/virus_scan_state.py +0 -7
  762. flywheel/models/work_in_progress_features.py +3 -8
  763. flywheel/models/zipfile_info.py +13 -14
  764. flywheel/models/zipfile_member_info.py +23 -20
  765. flywheel/partial_reader.py +0 -7
  766. flywheel/rest.py +0 -7
  767. flywheel/view_builder.py +2 -1
  768. {flywheel_sdk-21.3.0.dist-info → flywheel_sdk-21.4.0.dist-info}/METADATA +1 -1
  769. flywheel_sdk-21.4.0.dist-info/RECORD +778 -0
  770. flywheel/models/google_auth_out.py +0 -299
  771. flywheel_sdk-21.3.0.dist-info/RECORD +0 -773
  772. {flywheel_sdk-21.3.0.dist-info → flywheel_sdk-21.4.0.dist-info}/WHEEL +0 -0
  773. {flywheel_sdk-21.3.0.dist-info → flywheel_sdk-21.4.0.dist-info}/licenses/LICENSE.txt +0 -0
@@ -1,13 +1,6 @@
1
1
  # coding: utf-8
2
2
 
3
3
  """
4
- Flywheel
5
-
6
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
7
-
8
- OpenAPI spec version: 0.0.1
9
-
10
- Generated by: https://github.com/swagger-api/swagger-codegen.git
11
4
  """
12
5
 
13
6
 
@@ -37,9 +30,11 @@ class SubjectsApi(object):
37
30
  Create a new subject
38
31
  This method makes a synchronous HTTP request by default.
39
32
 
40
- :param SubjectInput body: (required)
41
- :param bool async_: Perform the request asynchronously
42
- :return: InsertedId
33
+ :param body:
34
+ :type body: SubjectInput
35
+ :param async_: Perform the request asynchronously
36
+ :type async_: bool, optional
37
+ :rtype: InsertedId
43
38
  """
44
39
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
45
40
  kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ class SubjectsApi(object):
63
58
  Create a new subject
64
59
  This method makes a synchronous HTTP request by default.
65
60
 
66
- :param SubjectInput body: (required)
67
- :param bool async_: Perform the request asynchronously
68
- :return: InsertedId
61
+ :param body:
62
+ :type body: SubjectInput
63
+ :param async_: Perform the request asynchronously
64
+ :type async_: bool, optional
65
+ :rtype: InsertedId
69
66
  """
70
67
 
71
68
  all_params = ['body',] # noqa: E501
@@ -145,12 +142,15 @@ class SubjectsApi(object):
145
142
  When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
146
143
  This method makes a synchronous HTTP request by default.
147
144
 
148
- :param str cid: (required)
149
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
150
- :param bool job: returns job_id instead of analysis.id
151
- :param bool job: returns job_id instead of analysis.id
152
- :param bool async_: Perform the request asynchronously
153
- :return: InsertedId
145
+ :param cid:
146
+ :type cid: str
147
+ :param body:
148
+ :type body: union[AdhocAnalysisInput,JobAnalysisInput]
149
+ :param job: returns job_id instead of analysis.id, defaults to false
150
+ :type job: bool, optional
151
+ :param async_: Perform the request asynchronously
152
+ :type async_: bool, optional
153
+ :rtype: InsertedId
154
154
  """
155
155
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
156
156
  kwargs['_return_http_data_only'] = True
@@ -174,15 +174,18 @@ class SubjectsApi(object):
174
174
  When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
175
175
  This method makes a synchronous HTTP request by default.
176
176
 
177
- :param str cid: (required)
178
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
179
- :param bool job: returns job_id instead of analysis.id
180
- :param bool job: returns job_id instead of analysis.id
181
- :param bool async_: Perform the request asynchronously
182
- :return: InsertedId
177
+ :param cid:
178
+ :type cid: str
179
+ :param body:
180
+ :type body: union[AdhocAnalysisInput,JobAnalysisInput]
181
+ :param job: returns job_id instead of analysis.id, defaults to false
182
+ :type job: bool, optional
183
+ :param async_: Perform the request asynchronously
184
+ :type async_: bool, optional
185
+ :rtype: InsertedId
183
186
  """
184
187
 
185
- all_params = ['cid','body','job','job',] # noqa: E501
188
+ all_params = ['cid','body','job',] # noqa: E501
186
189
  all_params.append('async_')
187
190
  all_params.append('_return_http_data_only')
188
191
  all_params.append('_preload_content')
@@ -215,8 +218,6 @@ class SubjectsApi(object):
215
218
  path_params['cid'] = params['cid'] # noqa: E501
216
219
 
217
220
  query_params = []
218
- if 'job' in params:
219
- query_params.append(('job', params['job'])) # noqa: E501
220
221
  if 'job' in params:
221
222
  query_params.append(('job', params['job'])) # noqa: E501
222
223
  else:
@@ -271,11 +272,15 @@ class SubjectsApi(object):
271
272
  Add a note to a(n) subject analysis.
272
273
  This method makes a synchronous HTTP request by default.
273
274
 
274
- :param str container_id: 24-char hex id (required)
275
- :param str analysis_id: 24-char hex analysis id (required)
276
- :param NoteInput body: (required)
277
- :param bool async_: Perform the request asynchronously
278
- :return: Note
275
+ :param container_id: 24-char hex id
276
+ :type container_id: str
277
+ :param analysis_id: 24-char hex analysis id
278
+ :type analysis_id: str
279
+ :param body:
280
+ :type body: NoteInput
281
+ :param async_: Perform the request asynchronously
282
+ :type async_: bool, optional
283
+ :rtype: Note
279
284
  """
280
285
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
281
286
  kwargs['_return_http_data_only'] = True
@@ -299,11 +304,15 @@ class SubjectsApi(object):
299
304
  Add a note to a(n) subject analysis.
300
305
  This method makes a synchronous HTTP request by default.
301
306
 
302
- :param str container_id: 24-char hex id (required)
303
- :param str analysis_id: 24-char hex analysis id (required)
304
- :param NoteInput body: (required)
305
- :param bool async_: Perform the request asynchronously
306
- :return: Note
307
+ :param container_id: 24-char hex id
308
+ :type container_id: str
309
+ :param analysis_id: 24-char hex analysis id
310
+ :type analysis_id: str
311
+ :param body:
312
+ :type body: NoteInput
313
+ :param async_: Perform the request asynchronously
314
+ :type async_: bool, optional
315
+ :rtype: Note
307
316
  """
308
317
 
309
318
  all_params = ['container_id','analysis_id','body',] # noqa: E501
@@ -395,10 +404,13 @@ class SubjectsApi(object):
395
404
  Add a note to a(n) subject.
396
405
  This method makes a synchronous HTTP request by default.
397
406
 
398
- :param str container_id: (required)
399
- :param NoteInput body: (required)
400
- :param bool async_: Perform the request asynchronously
401
- :return: Note
407
+ :param container_id:
408
+ :type container_id: str
409
+ :param body:
410
+ :type body: NoteInput
411
+ :param async_: Perform the request asynchronously
412
+ :type async_: bool, optional
413
+ :rtype: Note
402
414
  """
403
415
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
404
416
  kwargs['_return_http_data_only'] = True
@@ -422,10 +434,13 @@ class SubjectsApi(object):
422
434
  Add a note to a(n) subject.
423
435
  This method makes a synchronous HTTP request by default.
424
436
 
425
- :param str container_id: (required)
426
- :param NoteInput body: (required)
427
- :param bool async_: Perform the request asynchronously
428
- :return: Note
437
+ :param container_id:
438
+ :type container_id: str
439
+ :param body:
440
+ :type body: NoteInput
441
+ :param async_: Perform the request asynchronously
442
+ :type async_: bool, optional
443
+ :rtype: Note
429
444
  """
430
445
 
431
446
  all_params = ['container_id','body',] # noqa: E501
@@ -511,10 +526,13 @@ class SubjectsApi(object):
511
526
  Propagates changes to projects, sessions and acquisitions
512
527
  This method makes a synchronous HTTP request by default.
513
528
 
514
- :param str cid: (required)
515
- :param Tag body: (required)
516
- :param bool async_: Perform the request asynchronously
517
- :return: ModifiedResult
529
+ :param cid:
530
+ :type cid: str
531
+ :param body:
532
+ :type body: Tag
533
+ :param async_: Perform the request asynchronously
534
+ :type async_: bool, optional
535
+ :rtype: ModifiedResult
518
536
  """
519
537
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
520
538
  kwargs['_return_http_data_only'] = True
@@ -538,10 +556,13 @@ class SubjectsApi(object):
538
556
  Propagates changes to projects, sessions and acquisitions
539
557
  This method makes a synchronous HTTP request by default.
540
558
 
541
- :param str cid: (required)
542
- :param Tag body: (required)
543
- :param bool async_: Perform the request asynchronously
544
- :return: ModifiedResult
559
+ :param cid:
560
+ :type cid: str
561
+ :param body:
562
+ :type body: Tag
563
+ :param async_: Perform the request asynchronously
564
+ :type async_: bool, optional
565
+ :rtype: ModifiedResult
545
566
  """
546
567
 
547
568
  all_params = ['cid','body',] # noqa: E501
@@ -627,10 +648,13 @@ class SubjectsApi(object):
627
648
  Add multiple tags to a(n) subject
628
649
  This method makes a synchronous HTTP request by default.
629
650
 
630
- :param str cid: (required)
631
- :param list[str] body: (required)
632
- :param bool async_: Perform the request asynchronously
633
- :return: None
651
+ :param cid:
652
+ :type cid: str
653
+ :param body:
654
+ :type body: list[str]
655
+ :param async_: Perform the request asynchronously
656
+ :type async_: bool, optional
657
+ :rtype: None
634
658
  """
635
659
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
636
660
  kwargs['_return_http_data_only'] = True
@@ -654,10 +678,13 @@ class SubjectsApi(object):
654
678
  Add multiple tags to a(n) subject
655
679
  This method makes a synchronous HTTP request by default.
656
680
 
657
- :param str cid: (required)
658
- :param list[str] body: (required)
659
- :param bool async_: Perform the request asynchronously
660
- :return: None
681
+ :param cid:
682
+ :type cid: str
683
+ :param body:
684
+ :type body: list[str]
685
+ :param async_: Perform the request asynchronously
686
+ :type async_: bool, optional
687
+ :rtype: None
661
688
  """
662
689
 
663
690
  all_params = ['cid','body',] # noqa: E501
@@ -736,9 +763,11 @@ class SubjectsApi(object):
736
763
  The workflow is the following. - send `patient_id` (e.g., MRN) and/or `first_name`, `last_name`, `date_of_birth` - indicate whether to use `patient_id` for identification or `first_name`, `last_name`, `date_of_birth` by the `use_patient_id` field - the response will contain a master subject code - if you send the same identifying information again, you will receive the same code Note that if you received a MSC code for example by just providing the `patient_id`, you can save more information for that MSC in a second request (`first_name`, `last_name`, `date_of_birth`). Only the missing fields will be set, so you can't update any existing field (e.g. changing the name). Since you can create multiple MSC codes with the same name and date of birth using different patient ids, you will get HTTP 400 error if you request an MSC code by name and date of birth and there are multiple matches. In this case you need to use patient id.
737
764
  This method makes a synchronous HTTP request by default.
738
765
 
739
- :param union[MasterSubjectCodeInput,MasterSubjectCodeDobInput] body: (required)
740
- :param bool async_: Perform the request asynchronously
741
- :return: MasterSubjectCodeOutput
766
+ :param body:
767
+ :type body: union[MasterSubjectCodeInput,MasterSubjectCodeDobInput]
768
+ :param async_: Perform the request asynchronously
769
+ :type async_: bool, optional
770
+ :rtype: MasterSubjectCodeOutput
742
771
  """
743
772
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
744
773
  kwargs['_return_http_data_only'] = True
@@ -762,9 +791,11 @@ class SubjectsApi(object):
762
791
  The workflow is the following. - send `patient_id` (e.g., MRN) and/or `first_name`, `last_name`, `date_of_birth` - indicate whether to use `patient_id` for identification or `first_name`, `last_name`, `date_of_birth` by the `use_patient_id` field - the response will contain a master subject code - if you send the same identifying information again, you will receive the same code Note that if you received a MSC code for example by just providing the `patient_id`, you can save more information for that MSC in a second request (`first_name`, `last_name`, `date_of_birth`). Only the missing fields will be set, so you can't update any existing field (e.g. changing the name). Since you can create multiple MSC codes with the same name and date of birth using different patient ids, you will get HTTP 400 error if you request an MSC code by name and date of birth and there are multiple matches. In this case you need to use patient id.
763
792
  This method makes a synchronous HTTP request by default.
764
793
 
765
- :param union[MasterSubjectCodeInput,MasterSubjectCodeDobInput] body: (required)
766
- :param bool async_: Perform the request asynchronously
767
- :return: MasterSubjectCodeOutput
794
+ :param body:
795
+ :type body: union[MasterSubjectCodeInput,MasterSubjectCodeDobInput]
796
+ :param async_: Perform the request asynchronously
797
+ :type async_: bool, optional
798
+ :rtype: MasterSubjectCodeOutput
768
799
  """
769
800
 
770
801
  all_params = ['body',] # noqa: E501
@@ -844,10 +875,13 @@ class SubjectsApi(object):
844
875
  Read-write project permissions are required to delete a subject. Admin project permissions are required if the subject or it's acquisitions contain data uploaded by sources other than users and jobs.
845
876
  This method makes a synchronous HTTP request by default.
846
877
 
847
- :param str subject_id: 24-char hex subject id (required)
848
- :param ContainerDeleteReason delete_reason:
849
- :param bool async_: Perform the request asynchronously
850
- :return: DeletedResult
878
+ :param subject_id: 24-char hex subject id
879
+ :type subject_id: str
880
+ :param delete_reason:
881
+ :type delete_reason: ContainerDeleteReason, optional
882
+ :param async_: Perform the request asynchronously
883
+ :type async_: bool, optional
884
+ :rtype: DeletedResult
851
885
  """
852
886
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
853
887
  kwargs['_return_http_data_only'] = True
@@ -871,10 +905,13 @@ class SubjectsApi(object):
871
905
  Read-write project permissions are required to delete a subject. Admin project permissions are required if the subject or it's acquisitions contain data uploaded by sources other than users and jobs.
872
906
  This method makes a synchronous HTTP request by default.
873
907
 
874
- :param str subject_id: 24-char hex subject id (required)
875
- :param ContainerDeleteReason delete_reason:
876
- :param bool async_: Perform the request asynchronously
877
- :return: DeletedResult
908
+ :param subject_id: 24-char hex subject id
909
+ :type subject_id: str
910
+ :param delete_reason:
911
+ :type delete_reason: ContainerDeleteReason, optional
912
+ :param async_: Perform the request asynchronously
913
+ :type async_: bool, optional
914
+ :rtype: DeletedResult
878
915
  """
879
916
 
880
917
  all_params = ['subject_id','delete_reason',] # noqa: E501
@@ -945,11 +982,15 @@ class SubjectsApi(object):
945
982
  Delete an analysis for a container.
946
983
  This method makes a synchronous HTTP request by default.
947
984
 
948
- :param str cid: (required)
949
- :param str analysis_id: (required)
950
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
951
- :param bool async_: Perform the request asynchronously
952
- :return: DeletedResult
985
+ :param cid:
986
+ :type cid: str
987
+ :param analysis_id:
988
+ :type analysis_id: str
989
+ :param delete_reason: Provide a reason for the deletion
990
+ :type delete_reason: ContainerDeleteReason, optional
991
+ :param async_: Perform the request asynchronously
992
+ :type async_: bool, optional
993
+ :rtype: DeletedResult
953
994
  """
954
995
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
955
996
  kwargs['_return_http_data_only'] = True
@@ -973,11 +1014,15 @@ class SubjectsApi(object):
973
1014
  Delete an analysis for a container.
974
1015
  This method makes a synchronous HTTP request by default.
975
1016
 
976
- :param str cid: (required)
977
- :param str analysis_id: (required)
978
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
979
- :param bool async_: Perform the request asynchronously
980
- :return: DeletedResult
1017
+ :param cid:
1018
+ :type cid: str
1019
+ :param analysis_id:
1020
+ :type analysis_id: str
1021
+ :param delete_reason: Provide a reason for the deletion
1022
+ :type delete_reason: ContainerDeleteReason, optional
1023
+ :param async_: Perform the request asynchronously
1024
+ :type async_: bool, optional
1025
+ :rtype: DeletedResult
981
1026
  """
982
1027
 
983
1028
  all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
@@ -1054,11 +1099,15 @@ class SubjectsApi(object):
1054
1099
  Remove a note from a(n) subject analysis.
1055
1100
  This method makes a synchronous HTTP request by default.
1056
1101
 
1057
- :param str cid: 24-char hex id (required)
1058
- :param str analysis_id: 24-char hex analysis id (required)
1059
- :param str note_id: 24-char hex note id (required)
1060
- :param bool async_: Perform the request asynchronously
1061
- :return: DeletedResult
1102
+ :param cid: 24-char hex id
1103
+ :type cid: str
1104
+ :param analysis_id: 24-char hex analysis id
1105
+ :type analysis_id: str
1106
+ :param note_id: 24-char hex note id
1107
+ :type note_id: str
1108
+ :param async_: Perform the request asynchronously
1109
+ :type async_: bool, optional
1110
+ :rtype: DeletedResult
1062
1111
  """
1063
1112
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1064
1113
  kwargs['_return_http_data_only'] = True
@@ -1082,11 +1131,15 @@ class SubjectsApi(object):
1082
1131
  Remove a note from a(n) subject analysis.
1083
1132
  This method makes a synchronous HTTP request by default.
1084
1133
 
1085
- :param str cid: 24-char hex id (required)
1086
- :param str analysis_id: 24-char hex analysis id (required)
1087
- :param str note_id: 24-char hex note id (required)
1088
- :param bool async_: Perform the request asynchronously
1089
- :return: DeletedResult
1134
+ :param cid: 24-char hex id
1135
+ :type cid: str
1136
+ :param analysis_id: 24-char hex analysis id
1137
+ :type analysis_id: str
1138
+ :param note_id: 24-char hex note id
1139
+ :type note_id: str
1140
+ :param async_: Perform the request asynchronously
1141
+ :type async_: bool, optional
1142
+ :rtype: DeletedResult
1090
1143
  """
1091
1144
 
1092
1145
  all_params = ['cid','analysis_id','note_id',] # noqa: E501
@@ -1167,12 +1220,17 @@ class SubjectsApi(object):
1167
1220
  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.
1168
1221
  This method makes a synchronous HTTP request by default.
1169
1222
 
1170
- :param str cid: (required)
1171
- :param str filename: (required)
1172
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1173
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1174
- :param bool async_: Perform the request asynchronously
1175
- :return: DeletedResult
1223
+ :param cid:
1224
+ :type cid: str
1225
+ :param filename:
1226
+ :type filename: str
1227
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1228
+ :type delete_reason: ContainerDeleteReason, optional
1229
+ :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1230
+ :type force: bool, optional
1231
+ :param async_: Perform the request asynchronously
1232
+ :type async_: bool, optional
1233
+ :rtype: DeletedResult
1176
1234
  """
1177
1235
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1178
1236
  kwargs['_return_http_data_only'] = True
@@ -1196,12 +1254,17 @@ class SubjectsApi(object):
1196
1254
  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.
1197
1255
  This method makes a synchronous HTTP request by default.
1198
1256
 
1199
- :param str cid: (required)
1200
- :param str filename: (required)
1201
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1202
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1203
- :param bool async_: Perform the request asynchronously
1204
- :return: DeletedResult
1257
+ :param cid:
1258
+ :type cid: str
1259
+ :param filename:
1260
+ :type filename: str
1261
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1262
+ :type delete_reason: ContainerDeleteReason, optional
1263
+ :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1264
+ :type force: bool, optional
1265
+ :param async_: Perform the request asynchronously
1266
+ :type async_: bool, optional
1267
+ :rtype: DeletedResult
1205
1268
  """
1206
1269
 
1207
1270
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -1280,10 +1343,13 @@ class SubjectsApi(object):
1280
1343
  Remove a note from a(n) subject
1281
1344
  This method makes a synchronous HTTP request by default.
1282
1345
 
1283
- :param str cid: (required)
1284
- :param str note_id: (required)
1285
- :param bool async_: Perform the request asynchronously
1286
- :return: DeletedResult
1346
+ :param cid:
1347
+ :type cid: str
1348
+ :param note_id:
1349
+ :type note_id: str
1350
+ :param async_: Perform the request asynchronously
1351
+ :type async_: bool, optional
1352
+ :rtype: DeletedResult
1287
1353
  """
1288
1354
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1289
1355
  kwargs['_return_http_data_only'] = True
@@ -1307,10 +1373,13 @@ class SubjectsApi(object):
1307
1373
  Remove a note from a(n) subject
1308
1374
  This method makes a synchronous HTTP request by default.
1309
1375
 
1310
- :param str cid: (required)
1311
- :param str note_id: (required)
1312
- :param bool async_: Perform the request asynchronously
1313
- :return: DeletedResult
1376
+ :param cid:
1377
+ :type cid: str
1378
+ :param note_id:
1379
+ :type note_id: str
1380
+ :param async_: Perform the request asynchronously
1381
+ :type async_: bool, optional
1382
+ :rtype: DeletedResult
1314
1383
  """
1315
1384
 
1316
1385
  all_params = ['cid','note_id',] # noqa: E501
@@ -1385,10 +1454,13 @@ class SubjectsApi(object):
1385
1454
  Delete a tag
1386
1455
  This method makes a synchronous HTTP request by default.
1387
1456
 
1388
- :param str cid: (required)
1389
- :param str value: The tag to interact with (required)
1390
- :param bool async_: Perform the request asynchronously
1391
- :return: DeletedResult
1457
+ :param cid:
1458
+ :type cid: str
1459
+ :param value: The tag to interact with
1460
+ :type value: str
1461
+ :param async_: Perform the request asynchronously
1462
+ :type async_: bool, optional
1463
+ :rtype: DeletedResult
1392
1464
  """
1393
1465
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1394
1466
  kwargs['_return_http_data_only'] = True
@@ -1412,10 +1484,13 @@ class SubjectsApi(object):
1412
1484
  Delete a tag
1413
1485
  This method makes a synchronous HTTP request by default.
1414
1486
 
1415
- :param str cid: (required)
1416
- :param str value: The tag to interact with (required)
1417
- :param bool async_: Perform the request asynchronously
1418
- :return: DeletedResult
1487
+ :param cid:
1488
+ :type cid: str
1489
+ :param value: The tag to interact with
1490
+ :type value: str
1491
+ :param async_: Perform the request asynchronously
1492
+ :type async_: bool, optional
1493
+ :rtype: DeletedResult
1419
1494
  """
1420
1495
 
1421
1496
  all_params = ['cid','value',] # noqa: E501
@@ -1490,10 +1565,13 @@ class SubjectsApi(object):
1490
1565
  Delete multiple tags from a(n) subject
1491
1566
  This method makes a synchronous HTTP request by default.
1492
1567
 
1493
- :param str cid: (required)
1494
- :param list[str] body: (required)
1495
- :param bool async_: Perform the request asynchronously
1496
- :return: None
1568
+ :param cid:
1569
+ :type cid: str
1570
+ :param body:
1571
+ :type body: list[str]
1572
+ :param async_: Perform the request asynchronously
1573
+ :type async_: bool, optional
1574
+ :rtype: None
1497
1575
  """
1498
1576
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1499
1577
  kwargs['_return_http_data_only'] = True
@@ -1517,10 +1595,13 @@ class SubjectsApi(object):
1517
1595
  Delete multiple tags from a(n) subject
1518
1596
  This method makes a synchronous HTTP request by default.
1519
1597
 
1520
- :param str cid: (required)
1521
- :param list[str] body: (required)
1522
- :param bool async_: Perform the request asynchronously
1523
- :return: None
1598
+ :param cid:
1599
+ :type cid: str
1600
+ :param body:
1601
+ :type body: list[str]
1602
+ :param async_: Perform the request asynchronously
1603
+ :type async_: bool, optional
1604
+ :rtype: None
1524
1605
  """
1525
1606
 
1526
1607
  all_params = ['cid','body',] # noqa: E501
@@ -1599,10 +1680,13 @@ class SubjectsApi(object):
1599
1680
  Delete multiple subjects by ID list
1600
1681
  This method makes a synchronous HTTP request by default.
1601
1682
 
1602
- :param list[str] body: List of IDs to delete (required)
1603
- :param ContainerDeleteReason delete_reason:
1604
- :param bool async_: Perform the request asynchronously
1605
- :return: DeletedResult
1683
+ :param body: List of IDs to delete
1684
+ :type body: list[str]
1685
+ :param delete_reason:
1686
+ :type delete_reason: ContainerDeleteReason, optional
1687
+ :param async_: Perform the request asynchronously
1688
+ :type async_: bool, optional
1689
+ :rtype: DeletedResult
1606
1690
  """
1607
1691
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1608
1692
  kwargs['_return_http_data_only'] = True
@@ -1626,10 +1710,13 @@ class SubjectsApi(object):
1626
1710
  Delete multiple subjects by ID list
1627
1711
  This method makes a synchronous HTTP request by default.
1628
1712
 
1629
- :param list[str] body: List of IDs to delete (required)
1630
- :param ContainerDeleteReason delete_reason:
1631
- :param bool async_: Perform the request asynchronously
1632
- :return: DeletedResult
1713
+ :param body: List of IDs to delete
1714
+ :type body: list[str]
1715
+ :param delete_reason:
1716
+ :type delete_reason: ContainerDeleteReason, optional
1717
+ :param async_: Perform the request asynchronously
1718
+ :type async_: bool, optional
1719
+ :rtype: DeletedResult
1633
1720
  """
1634
1721
 
1635
1722
  all_params = ['body','delete_reason',] # noqa: E501
@@ -1704,18 +1791,29 @@ class SubjectsApi(object):
1704
1791
  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.
1705
1792
  This method makes a synchronous HTTP request by default.
1706
1793
 
1707
- :param str subject_id: 24-character hex ID (required)
1708
- :param str file_name: output file name (required)
1709
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1710
- :param str member: The filename of a zipfile member to download rather than the entire file
1711
- :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\"
1712
- :param int version: version of the file to download
1713
- :param str hash: file hash for comparison
1714
- :param str range: byte ranges to return
1715
- :param list[str] x_accept_feature: redirect header
1716
- :param str dest_file: Destination file path
1717
- :param bool async_: Perform the request asynchronously
1718
- :return: union[DownloadTicketStub,ZipfileInfo]
1794
+ :param subject_id: 24-character hex ID
1795
+ :type subject_id: str
1796
+ :param file_name: output file name
1797
+ :type file_name: str
1798
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1799
+ :type info: bool, optional
1800
+ :param member: The filename of a zipfile member to download rather than the entire file
1801
+ :type member: str, optional
1802
+ :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
1803
+ :type view: bool, optional
1804
+ :param version: version of the file to download
1805
+ :type version: int, optional
1806
+ :param hash: file hash for comparison
1807
+ :type hash: str, optional
1808
+ :param range: byte ranges to return
1809
+ :type range: str, optional
1810
+ :param x_accept_feature: redirect header, defaults to []
1811
+ :type x_accept_feature: list[str], optional
1812
+ :param dest_file: Destination file path
1813
+ :type dest_file: str
1814
+ :param async_: Perform the request asynchronously
1815
+ :type async_: bool, optional
1816
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1719
1817
  """
1720
1818
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1721
1819
  kwargs['_return_http_data_only'] = True
@@ -1738,17 +1836,27 @@ class SubjectsApi(object):
1738
1836
  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.
1739
1837
  This method makes a synchronous HTTP request by default.
1740
1838
 
1741
- :param str subject_id: 24-character hex ID (required)
1742
- :param str file_name: output file name (required)
1743
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1744
- :param str member: The filename of a zipfile member to download rather than the entire file
1745
- :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\"
1746
- :param int version: version of the file to download
1747
- :param str hash: file hash for comparison
1748
- :param str range: byte ranges to return
1749
- :param list[str] x_accept_feature: redirect header
1750
- :param bool async_: Perform the request asynchronously
1751
- :return: union[DownloadTicketStub,ZipfileInfo]
1839
+ :param subject_id: 24-character hex ID
1840
+ :type subject_id: str
1841
+ :param file_name: output file name
1842
+ :type file_name: str
1843
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1844
+ :type info: bool, optional
1845
+ :param member: The filename of a zipfile member to download rather than the entire file
1846
+ :type member: str, optional
1847
+ :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
1848
+ :type view: bool, optional
1849
+ :param version: version of the file to download
1850
+ :type version: int, optional
1851
+ :param hash: file hash for comparison
1852
+ :type hash: str, optional
1853
+ :param range: byte ranges to return
1854
+ :type range: str, optional
1855
+ :param x_accept_feature: redirect header, defaults to []
1856
+ :type x_accept_feature: list[str], optional
1857
+ :param async_: Perform the request asynchronously
1858
+ :type async_: bool, optional
1859
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1752
1860
  """
1753
1861
 
1754
1862
  all_params = ['subject_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1838,18 +1946,29 @@ class SubjectsApi(object):
1838
1946
  Does not work on files whose names contain a forward slash.
1839
1947
  This method makes a synchronous HTTP request by default.
1840
1948
 
1841
- :param str subject_id: 24-character hex ID (required)
1842
- :param str file_name: output file name (required)
1843
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1844
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1845
- :param str member: The filename of a zipfile member to download rather than the entire file
1846
- :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\"
1847
- :param int version: version of the file to download
1848
- :param str hash: file hash for comparison
1849
- :param str range: byte ranges to return
1850
- :param list[str] x_accept_feature: redirect header
1851
- :param bool async_: Perform the request asynchronously
1852
- :return: FileZipInfo
1949
+ :param subject_id: 24-character hex ID
1950
+ :type subject_id: str
1951
+ :param file_name: output file name
1952
+ :type file_name: str
1953
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1954
+ :type ticket: str, optional
1955
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1956
+ :type info: bool, optional
1957
+ :param member: The filename of a zipfile member to download rather than the entire file
1958
+ :type member: str, optional
1959
+ :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
1960
+ :type view: bool, optional
1961
+ :param version: version of the file to download
1962
+ :type version: int, optional
1963
+ :param hash: file hash for comparison
1964
+ :type hash: str, optional
1965
+ :param range: byte ranges to return
1966
+ :type range: str, optional
1967
+ :param x_accept_feature: redirect header, defaults to []
1968
+ :type x_accept_feature: list[str], optional
1969
+ :param async_: Perform the request asynchronously
1970
+ :type async_: bool, optional
1971
+ :rtype: FileZipInfo
1853
1972
  """
1854
1973
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1855
1974
  kwargs['_return_http_data_only'] = True
@@ -1873,18 +1992,29 @@ class SubjectsApi(object):
1873
1992
  Does not work on files whose names contain a forward slash.
1874
1993
  This method makes a synchronous HTTP request by default.
1875
1994
 
1876
- :param str subject_id: 24-character hex ID (required)
1877
- :param str file_name: output file name (required)
1878
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1879
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1880
- :param str member: The filename of a zipfile member to download rather than the entire file
1881
- :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\"
1882
- :param int version: version of the file to download
1883
- :param str hash: file hash for comparison
1884
- :param str range: byte ranges to return
1885
- :param list[str] x_accept_feature: redirect header
1886
- :param bool async_: Perform the request asynchronously
1887
- :return: FileZipInfo
1995
+ :param subject_id: 24-character hex ID
1996
+ :type subject_id: str
1997
+ :param file_name: output file name
1998
+ :type file_name: str
1999
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2000
+ :type ticket: str, optional
2001
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2002
+ :type info: bool, optional
2003
+ :param member: The filename of a zipfile member to download rather than the entire file
2004
+ :type member: str, optional
2005
+ :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
2006
+ :type view: bool, optional
2007
+ :param version: version of the file to download
2008
+ :type version: int, optional
2009
+ :param hash: file hash for comparison
2010
+ :type hash: str, optional
2011
+ :param range: byte ranges to return
2012
+ :type range: str, optional
2013
+ :param x_accept_feature: redirect header, defaults to []
2014
+ :type x_accept_feature: list[str], optional
2015
+ :param async_: Perform the request asynchronously
2016
+ :type async_: bool, optional
2017
+ :rtype: FileZipInfo
1888
2018
  """
1889
2019
 
1890
2020
  all_params = ['subject_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1977,18 +2107,29 @@ class SubjectsApi(object):
1977
2107
 
1978
2108
  This method makes a synchronous HTTP request by default.
1979
2109
 
1980
- :param str subject_id: 24-character hex ID (required)
1981
- :param str file_name: output file name (required)
1982
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1983
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
1984
- :param str member: The filename of a zipfile member to download rather than the entire file
1985
- :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\"
1986
- :param int version: version of the file to download
1987
- :param str hash: file hash for comparison
1988
- :param str range: byte ranges to return
1989
- :param list[str] x_accept_feature: redirect header
1990
- :param bool async_: Perform the request asynchronously
1991
- :return: union[DownloadTicketStub,ZipfileInfo]
2110
+ :param subject_id: 24-character hex ID
2111
+ :type subject_id: str
2112
+ :param file_name: output file name
2113
+ :type file_name: str
2114
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2115
+ :type ticket: str, optional
2116
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2117
+ :type info: bool, optional
2118
+ :param member: The filename of a zipfile member to download rather than the entire file
2119
+ :type member: str, optional
2120
+ :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
2121
+ :type view: bool, optional
2122
+ :param version: version of the file to download
2123
+ :type version: int, optional
2124
+ :param hash: file hash for comparison
2125
+ :type hash: str, optional
2126
+ :param range: byte ranges to return
2127
+ :type range: str, optional
2128
+ :param x_accept_feature: redirect header, defaults to []
2129
+ :type x_accept_feature: list[str], optional
2130
+ :param async_: Perform the request asynchronously
2131
+ :type async_: bool, optional
2132
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
1992
2133
  """
1993
2134
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1994
2135
  kwargs['_return_http_data_only'] = True
@@ -2011,18 +2152,29 @@ class SubjectsApi(object):
2011
2152
 
2012
2153
  This method makes a synchronous HTTP request by default.
2013
2154
 
2014
- :param str subject_id: 24-character hex ID (required)
2015
- :param str file_name: output file name (required)
2016
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2017
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2018
- :param str member: The filename of a zipfile member to download rather than the entire file
2019
- :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\"
2020
- :param int version: version of the file to download
2021
- :param str hash: file hash for comparison
2022
- :param str range: byte ranges to return
2023
- :param list[str] x_accept_feature: redirect header
2024
- :param bool async_: Perform the request asynchronously
2025
- :return: union[DownloadTicketStub,ZipfileInfo]
2155
+ :param subject_id: 24-character hex ID
2156
+ :type subject_id: str
2157
+ :param file_name: output file name
2158
+ :type file_name: str
2159
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2160
+ :type ticket: str, optional
2161
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2162
+ :type info: bool, optional
2163
+ :param member: The filename of a zipfile member to download rather than the entire file
2164
+ :type member: str, optional
2165
+ :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
2166
+ :type view: bool, optional
2167
+ :param version: version of the file to download
2168
+ :type version: int, optional
2169
+ :param hash: file hash for comparison
2170
+ :type hash: str, optional
2171
+ :param range: byte ranges to return
2172
+ :type range: str, optional
2173
+ :param x_accept_feature: redirect header, defaults to []
2174
+ :type x_accept_feature: list[str], optional
2175
+ :param async_: Perform the request asynchronously
2176
+ :type async_: bool, optional
2177
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2026
2178
  """
2027
2179
 
2028
2180
  all_params = ['subject_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2114,17 +2266,27 @@ class SubjectsApi(object):
2114
2266
  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.
2115
2267
  This method makes a synchronous HTTP request by default.
2116
2268
 
2117
- :param str subject_id: 24-character hex ID (required)
2118
- :param str analysis_id: 24-char hex analysis id (required)
2119
- :param str filename: filename to download (get tar of all if empty) (required)
2120
- :param bool info: get file info only
2121
- :param str member: get zipfile member
2122
- :param bool view: feature flag for view/download
2123
- :param str range: byte ranges to return
2124
- :param list[str] x_accept_feature: redirect header
2125
- :param str dest_file: Destination file path
2126
- :param bool async_: Perform the request asynchronously
2127
- :return: union[DownloadTicketStub,ZipfileInfo]
2269
+ :param subject_id: 24-character hex ID
2270
+ :type subject_id: str
2271
+ :param analysis_id: 24-char hex analysis id
2272
+ :type analysis_id: str
2273
+ :param filename: filename to download (get tar of all if empty)
2274
+ :type filename: str
2275
+ :param info: get file info only, defaults to false
2276
+ :type info: bool, optional
2277
+ :param member: get zipfile member
2278
+ :type member: str, optional
2279
+ :param view: feature flag for view/download, defaults to false
2280
+ :type view: bool, optional
2281
+ :param range: byte ranges to return
2282
+ :type range: str, optional
2283
+ :param x_accept_feature: redirect header, defaults to []
2284
+ :type x_accept_feature: list[str], optional
2285
+ :param dest_file: Destination file path
2286
+ :type dest_file: str
2287
+ :param async_: Perform the request asynchronously
2288
+ :type async_: bool, optional
2289
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2128
2290
  """
2129
2291
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2130
2292
  kwargs['_return_http_data_only'] = True
@@ -2147,16 +2309,25 @@ class SubjectsApi(object):
2147
2309
  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.
2148
2310
  This method makes a synchronous HTTP request by default.
2149
2311
 
2150
- :param str subject_id: 24-character hex ID (required)
2151
- :param str analysis_id: 24-char hex analysis id (required)
2152
- :param str filename: filename to download (get tar of all if empty) (required)
2153
- :param bool info: get file info only
2154
- :param str member: get zipfile member
2155
- :param bool view: feature flag for view/download
2156
- :param str range: byte ranges to return
2157
- :param list[str] x_accept_feature: redirect header
2158
- :param bool async_: Perform the request asynchronously
2159
- :return: union[DownloadTicketStub,ZipfileInfo]
2312
+ :param subject_id: 24-character hex ID
2313
+ :type subject_id: str
2314
+ :param analysis_id: 24-char hex analysis id
2315
+ :type analysis_id: str
2316
+ :param filename: filename to download (get tar of all if empty)
2317
+ :type filename: str
2318
+ :param info: get file info only, defaults to false
2319
+ :type info: bool, optional
2320
+ :param member: get zipfile member
2321
+ :type member: str, optional
2322
+ :param view: feature flag for view/download, defaults to false
2323
+ :type view: bool, optional
2324
+ :param range: byte ranges to return
2325
+ :type range: str, optional
2326
+ :param x_accept_feature: redirect header, defaults to []
2327
+ :type x_accept_feature: list[str], optional
2328
+ :param async_: Perform the request asynchronously
2329
+ :type async_: bool, optional
2330
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2160
2331
  """
2161
2332
 
2162
2333
  all_params = ['subject_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2248,17 +2419,27 @@ class SubjectsApi(object):
2248
2419
  Does not work on files whose names contain a forward slash.
2249
2420
  This method makes a synchronous HTTP request by default.
2250
2421
 
2251
- :param str subject_id: 24-character hex ID (required)
2252
- :param str analysis_id: 24-char hex analysis id (required)
2253
- :param str filename: filename to download (get tar of all if empty) (required)
2254
- :param str ticket: 24-char hex ticket id
2255
- :param bool info: get file info only
2256
- :param str member: get zipfile member
2257
- :param bool view: feature flag for view/download
2258
- :param str range: byte ranges to return
2259
- :param list[str] x_accept_feature: redirect header
2260
- :param bool async_: Perform the request asynchronously
2261
- :return: FileZipInfo
2422
+ :param subject_id: 24-character hex ID
2423
+ :type subject_id: str
2424
+ :param analysis_id: 24-char hex analysis id
2425
+ :type analysis_id: str
2426
+ :param filename: filename to download (get tar of all if empty)
2427
+ :type filename: str
2428
+ :param ticket: 24-char hex ticket id
2429
+ :type ticket: str, optional
2430
+ :param info: get file info only, defaults to false
2431
+ :type info: bool, optional
2432
+ :param member: get zipfile member
2433
+ :type member: str, optional
2434
+ :param view: feature flag for view/download, defaults to false
2435
+ :type view: bool, optional
2436
+ :param range: byte ranges to return
2437
+ :type range: str, optional
2438
+ :param x_accept_feature: redirect header, defaults to []
2439
+ :type x_accept_feature: list[str], optional
2440
+ :param async_: Perform the request asynchronously
2441
+ :type async_: bool, optional
2442
+ :rtype: FileZipInfo
2262
2443
  """
2263
2444
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2264
2445
  kwargs['_return_http_data_only'] = True
@@ -2282,17 +2463,27 @@ class SubjectsApi(object):
2282
2463
  Does not work on files whose names contain a forward slash.
2283
2464
  This method makes a synchronous HTTP request by default.
2284
2465
 
2285
- :param str subject_id: 24-character hex ID (required)
2286
- :param str analysis_id: 24-char hex analysis id (required)
2287
- :param str filename: filename to download (get tar of all if empty) (required)
2288
- :param str ticket: 24-char hex ticket id
2289
- :param bool info: get file info only
2290
- :param str member: get zipfile member
2291
- :param bool view: feature flag for view/download
2292
- :param str range: byte ranges to return
2293
- :param list[str] x_accept_feature: redirect header
2294
- :param bool async_: Perform the request asynchronously
2295
- :return: FileZipInfo
2466
+ :param subject_id: 24-character hex ID
2467
+ :type subject_id: str
2468
+ :param analysis_id: 24-char hex analysis id
2469
+ :type analysis_id: str
2470
+ :param filename: filename to download (get tar of all if empty)
2471
+ :type filename: str
2472
+ :param ticket: 24-char hex ticket id
2473
+ :type ticket: str, optional
2474
+ :param info: get file info only, defaults to false
2475
+ :type info: bool, optional
2476
+ :param member: get zipfile member
2477
+ :type member: str, optional
2478
+ :param view: feature flag for view/download, defaults to false
2479
+ :type view: bool, optional
2480
+ :param range: byte ranges to return
2481
+ :type range: str, optional
2482
+ :param x_accept_feature: redirect header, defaults to []
2483
+ :type x_accept_feature: list[str], optional
2484
+ :param async_: Perform the request asynchronously
2485
+ :type async_: bool, optional
2486
+ :rtype: FileZipInfo
2296
2487
  """
2297
2488
 
2298
2489
  all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2387,17 +2578,27 @@ class SubjectsApi(object):
2387
2578
 
2388
2579
  This method makes a synchronous HTTP request by default.
2389
2580
 
2390
- :param str subject_id: 24-character hex ID (required)
2391
- :param str analysis_id: 24-char hex analysis id (required)
2392
- :param str filename: filename to download (get tar of all if empty) (required)
2393
- :param str ticket: 24-char hex ticket id
2394
- :param bool info: get file info only
2395
- :param str member: get zipfile member
2396
- :param bool view: feature flag for view/download
2397
- :param str range: byte ranges to return
2398
- :param list[str] x_accept_feature: redirect header
2399
- :param bool async_: Perform the request asynchronously
2400
- :return: union[DownloadTicketStub,ZipfileInfo]
2581
+ :param subject_id: 24-character hex ID
2582
+ :type subject_id: str
2583
+ :param analysis_id: 24-char hex analysis id
2584
+ :type analysis_id: str
2585
+ :param filename: filename to download (get tar of all if empty)
2586
+ :type filename: str
2587
+ :param ticket: 24-char hex ticket id
2588
+ :type ticket: str, optional
2589
+ :param info: get file info only, defaults to false
2590
+ :type info: bool, optional
2591
+ :param member: get zipfile member
2592
+ :type member: str, optional
2593
+ :param view: feature flag for view/download, defaults to false
2594
+ :type view: bool, optional
2595
+ :param range: byte ranges to return
2596
+ :type range: str, optional
2597
+ :param x_accept_feature: redirect header, defaults to []
2598
+ :type x_accept_feature: list[str], optional
2599
+ :param async_: Perform the request asynchronously
2600
+ :type async_: bool, optional
2601
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2401
2602
  """
2402
2603
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2403
2604
  kwargs['_return_http_data_only'] = True
@@ -2420,17 +2621,27 @@ class SubjectsApi(object):
2420
2621
 
2421
2622
  This method makes a synchronous HTTP request by default.
2422
2623
 
2423
- :param str subject_id: 24-character hex ID (required)
2424
- :param str analysis_id: 24-char hex analysis id (required)
2425
- :param str filename: filename to download (get tar of all if empty) (required)
2426
- :param str ticket: 24-char hex ticket id
2427
- :param bool info: get file info only
2428
- :param str member: get zipfile member
2429
- :param bool view: feature flag for view/download
2430
- :param str range: byte ranges to return
2431
- :param list[str] x_accept_feature: redirect header
2432
- :param bool async_: Perform the request asynchronously
2433
- :return: union[DownloadTicketStub,ZipfileInfo]
2624
+ :param subject_id: 24-character hex ID
2625
+ :type subject_id: str
2626
+ :param analysis_id: 24-char hex analysis id
2627
+ :type analysis_id: str
2628
+ :param filename: filename to download (get tar of all if empty)
2629
+ :type filename: str
2630
+ :param ticket: 24-char hex ticket id
2631
+ :type ticket: str, optional
2632
+ :param info: get file info only, defaults to false
2633
+ :type info: bool, optional
2634
+ :param member: get zipfile member
2635
+ :type member: str, optional
2636
+ :param view: feature flag for view/download, defaults to false
2637
+ :type view: bool, optional
2638
+ :param range: byte ranges to return
2639
+ :type range: str, optional
2640
+ :param x_accept_feature: redirect header, defaults to []
2641
+ :type x_accept_feature: list[str], optional
2642
+ :param async_: Perform the request asynchronously
2643
+ :type async_: bool, optional
2644
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2434
2645
  """
2435
2646
 
2436
2647
  all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2524,17 +2735,27 @@ class SubjectsApi(object):
2524
2735
  If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
2525
2736
  This method makes a synchronous HTTP request by default.
2526
2737
 
2527
- :param str subject_id: 24-character hex ID (required)
2528
- :param str analysis_id: 24-char hex analysis id (required)
2529
- :param str filename: filename to download (get tar of all if empty) (required)
2530
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2531
- :param str member: The filename of a zipfile member to download rather than the entire file
2532
- :param bool view: feature flag for view/download
2533
- :param str range: byte ranges to return
2534
- :param list[str] x_accept_feature: redirect header
2535
- :param str dest_file: Destination file path
2536
- :param bool async_: Perform the request asynchronously
2537
- :return: union[DownloadTicketStub,ZipfileInfo]
2738
+ :param subject_id: 24-character hex ID
2739
+ :type subject_id: str
2740
+ :param analysis_id: 24-char hex analysis id
2741
+ :type analysis_id: str
2742
+ :param filename: filename to download (get tar of all if empty)
2743
+ :type filename: str
2744
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2745
+ :type info: bool, optional
2746
+ :param member: The filename of a zipfile member to download rather than the entire file
2747
+ :type member: str, optional
2748
+ :param view: feature flag for view/download, defaults to false
2749
+ :type view: bool, optional
2750
+ :param range: byte ranges to return
2751
+ :type range: str, optional
2752
+ :param x_accept_feature: redirect header, defaults to []
2753
+ :type x_accept_feature: list[str], optional
2754
+ :param dest_file: Destination file path
2755
+ :type dest_file: str
2756
+ :param async_: Perform the request asynchronously
2757
+ :type async_: bool, optional
2758
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2538
2759
  """
2539
2760
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2540
2761
  kwargs['_return_http_data_only'] = True
@@ -2557,16 +2778,25 @@ class SubjectsApi(object):
2557
2778
  If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
2558
2779
  This method makes a synchronous HTTP request by default.
2559
2780
 
2560
- :param str subject_id: 24-character hex ID (required)
2561
- :param str analysis_id: 24-char hex analysis id (required)
2562
- :param str filename: filename to download (get tar of all if empty) (required)
2563
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2564
- :param str member: The filename of a zipfile member to download rather than the entire file
2565
- :param bool view: feature flag for view/download
2566
- :param str range: byte ranges to return
2567
- :param list[str] x_accept_feature: redirect header
2568
- :param bool async_: Perform the request asynchronously
2569
- :return: union[DownloadTicketStub,ZipfileInfo]
2781
+ :param subject_id: 24-character hex ID
2782
+ :type subject_id: str
2783
+ :param analysis_id: 24-char hex analysis id
2784
+ :type analysis_id: str
2785
+ :param filename: filename to download (get tar of all if empty)
2786
+ :type filename: str
2787
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2788
+ :type info: bool, optional
2789
+ :param member: The filename of a zipfile member to download rather than the entire file
2790
+ :type member: str, optional
2791
+ :param view: feature flag for view/download, defaults to false
2792
+ :type view: bool, optional
2793
+ :param range: byte ranges to return
2794
+ :type range: str, optional
2795
+ :param x_accept_feature: redirect header, defaults to []
2796
+ :type x_accept_feature: list[str], optional
2797
+ :param async_: Perform the request asynchronously
2798
+ :type async_: bool, optional
2799
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2570
2800
  """
2571
2801
 
2572
2802
  all_params = ['subject_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2658,17 +2888,27 @@ class SubjectsApi(object):
2658
2888
  Does not work on files whose names contain a forward slash.
2659
2889
  This method makes a synchronous HTTP request by default.
2660
2890
 
2661
- :param str subject_id: 24-character hex ID (required)
2662
- :param str analysis_id: 24-char hex analysis id (required)
2663
- :param str filename: filename to download (get tar of all if empty) (required)
2664
- :param str ticket: ticket id of the outputs to download
2665
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2666
- :param str member: The filename of a zipfile member to download rather than the entire file
2667
- :param bool view: feature flag for view/download
2668
- :param str range: byte ranges to return
2669
- :param list[str] x_accept_feature: redirect header
2670
- :param bool async_: Perform the request asynchronously
2671
- :return: FileZipInfo
2891
+ :param subject_id: 24-character hex ID
2892
+ :type subject_id: str
2893
+ :param analysis_id: 24-char hex analysis id
2894
+ :type analysis_id: str
2895
+ :param filename: filename to download (get tar of all if empty)
2896
+ :type filename: str
2897
+ :param ticket: ticket id of the outputs to download
2898
+ :type ticket: str, optional
2899
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2900
+ :type info: bool, optional
2901
+ :param member: The filename of a zipfile member to download rather than the entire file
2902
+ :type member: str, optional
2903
+ :param view: feature flag for view/download, defaults to false
2904
+ :type view: bool, optional
2905
+ :param range: byte ranges to return
2906
+ :type range: str, optional
2907
+ :param x_accept_feature: redirect header, defaults to []
2908
+ :type x_accept_feature: list[str], optional
2909
+ :param async_: Perform the request asynchronously
2910
+ :type async_: bool, optional
2911
+ :rtype: FileZipInfo
2672
2912
  """
2673
2913
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2674
2914
  kwargs['_return_http_data_only'] = True
@@ -2692,17 +2932,27 @@ class SubjectsApi(object):
2692
2932
  Does not work on files whose names contain a forward slash.
2693
2933
  This method makes a synchronous HTTP request by default.
2694
2934
 
2695
- :param str subject_id: 24-character hex ID (required)
2696
- :param str analysis_id: 24-char hex analysis id (required)
2697
- :param str filename: filename to download (get tar of all if empty) (required)
2698
- :param str ticket: ticket id of the outputs to download
2699
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2700
- :param str member: The filename of a zipfile member to download rather than the entire file
2701
- :param bool view: feature flag for view/download
2702
- :param str range: byte ranges to return
2703
- :param list[str] x_accept_feature: redirect header
2704
- :param bool async_: Perform the request asynchronously
2705
- :return: FileZipInfo
2935
+ :param subject_id: 24-character hex ID
2936
+ :type subject_id: str
2937
+ :param analysis_id: 24-char hex analysis id
2938
+ :type analysis_id: str
2939
+ :param filename: filename to download (get tar of all if empty)
2940
+ :type filename: str
2941
+ :param ticket: ticket id of the outputs to download
2942
+ :type ticket: str, optional
2943
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2944
+ :type info: bool, optional
2945
+ :param member: The filename of a zipfile member to download rather than the entire file
2946
+ :type member: str, optional
2947
+ :param view: feature flag for view/download, defaults to false
2948
+ :type view: bool, optional
2949
+ :param range: byte ranges to return
2950
+ :type range: str, optional
2951
+ :param x_accept_feature: redirect header, defaults to []
2952
+ :type x_accept_feature: list[str], optional
2953
+ :param async_: Perform the request asynchronously
2954
+ :type async_: bool, optional
2955
+ :rtype: FileZipInfo
2706
2956
  """
2707
2957
 
2708
2958
  all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2797,17 +3047,27 @@ class SubjectsApi(object):
2797
3047
 
2798
3048
  This method makes a synchronous HTTP request by default.
2799
3049
 
2800
- :param str subject_id: 24-character hex ID (required)
2801
- :param str analysis_id: 24-char hex analysis id (required)
2802
- :param str filename: filename to download (get tar of all if empty) (required)
2803
- :param str ticket: ticket id of the outputs to download
2804
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2805
- :param str member: The filename of a zipfile member to download rather than the entire file
2806
- :param bool view: feature flag for view/download
2807
- :param str range: byte ranges to return
2808
- :param list[str] x_accept_feature: redirect header
2809
- :param bool async_: Perform the request asynchronously
2810
- :return: union[DownloadTicketStub,ZipfileInfo]
3050
+ :param subject_id: 24-character hex ID
3051
+ :type subject_id: str
3052
+ :param analysis_id: 24-char hex analysis id
3053
+ :type analysis_id: str
3054
+ :param filename: filename to download (get tar of all if empty)
3055
+ :type filename: str
3056
+ :param ticket: ticket id of the outputs to download
3057
+ :type ticket: str, optional
3058
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3059
+ :type info: bool, optional
3060
+ :param member: The filename of a zipfile member to download rather than the entire file
3061
+ :type member: str, optional
3062
+ :param view: feature flag for view/download, defaults to false
3063
+ :type view: bool, optional
3064
+ :param range: byte ranges to return
3065
+ :type range: str, optional
3066
+ :param x_accept_feature: redirect header, defaults to []
3067
+ :type x_accept_feature: list[str], optional
3068
+ :param async_: Perform the request asynchronously
3069
+ :type async_: bool, optional
3070
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2811
3071
  """
2812
3072
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2813
3073
  kwargs['_return_http_data_only'] = True
@@ -2830,17 +3090,27 @@ class SubjectsApi(object):
2830
3090
 
2831
3091
  This method makes a synchronous HTTP request by default.
2832
3092
 
2833
- :param str subject_id: 24-character hex ID (required)
2834
- :param str analysis_id: 24-char hex analysis id (required)
2835
- :param str filename: filename to download (get tar of all if empty) (required)
2836
- :param str ticket: ticket id of the outputs to download
2837
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2838
- :param str member: The filename of a zipfile member to download rather than the entire file
2839
- :param bool view: feature flag for view/download
2840
- :param str range: byte ranges to return
2841
- :param list[str] x_accept_feature: redirect header
2842
- :param bool async_: Perform the request asynchronously
2843
- :return: union[DownloadTicketStub,ZipfileInfo]
3093
+ :param subject_id: 24-character hex ID
3094
+ :type subject_id: str
3095
+ :param analysis_id: 24-char hex analysis id
3096
+ :type analysis_id: str
3097
+ :param filename: filename to download (get tar of all if empty)
3098
+ :type filename: str
3099
+ :param ticket: ticket id of the outputs to download
3100
+ :type ticket: str, optional
3101
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3102
+ :type info: bool, optional
3103
+ :param member: The filename of a zipfile member to download rather than the entire file
3104
+ :type member: str, optional
3105
+ :param view: feature flag for view/download, defaults to false
3106
+ :type view: bool, optional
3107
+ :param range: byte ranges to return
3108
+ :type range: str, optional
3109
+ :param x_accept_feature: redirect header, defaults to []
3110
+ :type x_accept_feature: list[str], optional
3111
+ :param async_: Perform the request asynchronously
3112
+ :type async_: bool, optional
3113
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2844
3114
  """
2845
3115
 
2846
3116
  all_params = ['subject_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2934,19 +3204,31 @@ class SubjectsApi(object):
2934
3204
  Get a list of subjects
2935
3205
  This method makes a synchronous HTTP request by default.
2936
3206
 
2937
- :param bool exhaustive: Set to return a complete list regardless of permissions
2938
- :param JoinType join: join file origins
2939
- :param bool join_avatars: add name and avatar to notes
2940
- :param bool include_all_info: Include all info in returned objects
2941
- :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)
2942
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2943
- :param int limit: The maximum number of entries to return.
2944
- :param int skip: The number of entries to skip.
2945
- :param int page: The page number (i.e. skip limit*page entries)
2946
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2947
- :param list[union[HeaderFeature,str]] x_accept_feature:
2948
- :param bool async_: Perform the request asynchronously
2949
- :return: union[Page,list[SubjectOutputForList]]
3207
+ :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
3208
+ :type exhaustive: bool, optional
3209
+ :param join: join file origins
3210
+ :type join: JoinType, optional
3211
+ :param join_avatars: add name and avatar to notes, defaults to false
3212
+ :type join_avatars: bool, optional
3213
+ :param include_all_info: Include all info in returned objects, defaults to false
3214
+ :type include_all_info: bool, optional
3215
+ :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)
3216
+ :type filter: str, optional
3217
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3218
+ :type sort: str, optional
3219
+ :param limit: The maximum number of entries to return.
3220
+ :type limit: int, optional
3221
+ :param skip: The number of entries to skip., defaults to 0
3222
+ :type skip: int, optional
3223
+ :param page: The page number (i.e. skip limit*page entries)
3224
+ :type page: int, optional
3225
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3226
+ :type after_id: str, optional
3227
+ :param x_accept_feature:, defaults to []
3228
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3229
+ :param async_: Perform the request asynchronously
3230
+ :type async_: bool, optional
3231
+ :rtype: union[Page,list[SubjectOutputForList]]
2950
3232
  """
2951
3233
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2952
3234
  kwargs['_return_http_data_only'] = True
@@ -2970,19 +3252,31 @@ class SubjectsApi(object):
2970
3252
  Get a list of subjects
2971
3253
  This method makes a synchronous HTTP request by default.
2972
3254
 
2973
- :param bool exhaustive: Set to return a complete list regardless of permissions
2974
- :param JoinType join: join file origins
2975
- :param bool join_avatars: add name and avatar to notes
2976
- :param bool include_all_info: Include all info in returned objects
2977
- :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)
2978
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2979
- :param int limit: The maximum number of entries to return.
2980
- :param int skip: The number of entries to skip.
2981
- :param int page: The page number (i.e. skip limit*page entries)
2982
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2983
- :param list[union[HeaderFeature,str]] x_accept_feature:
2984
- :param bool async_: Perform the request asynchronously
2985
- :return: union[Page,list[SubjectOutputForList]]
3255
+ :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
3256
+ :type exhaustive: bool, optional
3257
+ :param join: join file origins
3258
+ :type join: JoinType, optional
3259
+ :param join_avatars: add name and avatar to notes, defaults to false
3260
+ :type join_avatars: bool, optional
3261
+ :param include_all_info: Include all info in returned objects, defaults to false
3262
+ :type include_all_info: bool, optional
3263
+ :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)
3264
+ :type filter: str, optional
3265
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3266
+ :type sort: str, optional
3267
+ :param limit: The maximum number of entries to return.
3268
+ :type limit: int, optional
3269
+ :param skip: The number of entries to skip., defaults to 0
3270
+ :type skip: int, optional
3271
+ :param page: The page number (i.e. skip limit*page entries)
3272
+ :type page: int, optional
3273
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3274
+ :type after_id: str, optional
3275
+ :param x_accept_feature:, defaults to []
3276
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3277
+ :param async_: Perform the request asynchronously
3278
+ :type async_: bool, optional
3279
+ :rtype: union[Page,list[SubjectOutputForList]]
2986
3280
  """
2987
3281
 
2988
3282
  all_params = ['exhaustive','join','join_avatars','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3068,12 +3362,17 @@ class SubjectsApi(object):
3068
3362
  Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput
3069
3363
  This method makes a synchronous HTTP request by default.
3070
3364
 
3071
- :param str subject_id: 24-char hex subject id (required)
3072
- :param JoinType join: join file origins
3073
- :param bool join_avatars: add name and avatar to notes
3074
- :param list[union[HeaderFeature,str]] x_accept_feature:
3075
- :param bool async_: Perform the request asynchronously
3076
- :return: SubjectOutput
3365
+ :param subject_id: 24-char hex subject id
3366
+ :type subject_id: str
3367
+ :param join: join file origins
3368
+ :type join: JoinType, optional
3369
+ :param join_avatars: add name and avatar to notes, defaults to false
3370
+ :type join_avatars: bool, optional
3371
+ :param x_accept_feature:, defaults to []
3372
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3373
+ :param async_: Perform the request asynchronously
3374
+ :type async_: bool, optional
3375
+ :rtype: SubjectOutput
3077
3376
  """
3078
3377
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3079
3378
  kwargs['_return_http_data_only'] = True
@@ -3097,12 +3396,17 @@ class SubjectsApi(object):
3097
3396
  Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput
3098
3397
  This method makes a synchronous HTTP request by default.
3099
3398
 
3100
- :param str subject_id: 24-char hex subject id (required)
3101
- :param JoinType join: join file origins
3102
- :param bool join_avatars: add name and avatar to notes
3103
- :param list[union[HeaderFeature,str]] x_accept_feature:
3104
- :param bool async_: Perform the request asynchronously
3105
- :return: SubjectOutput
3399
+ :param subject_id: 24-char hex subject id
3400
+ :type subject_id: str
3401
+ :param join: join file origins
3402
+ :type join: JoinType, optional
3403
+ :param join_avatars: add name and avatar to notes, defaults to false
3404
+ :type join_avatars: bool, optional
3405
+ :param x_accept_feature:, defaults to []
3406
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3407
+ :param async_: Perform the request asynchronously
3408
+ :type async_: bool, optional
3409
+ :rtype: SubjectOutput
3106
3410
  """
3107
3411
 
3108
3412
  all_params = ['subject_id','join','join_avatars','x_accept_feature',] # noqa: E501
@@ -3178,20 +3482,33 @@ class SubjectsApi(object):
3178
3482
  Returns analyses that directly belong to this resource.
3179
3483
  This method makes a synchronous HTTP request by default.
3180
3484
 
3181
- :param str cid: (required)
3182
- :param bool inflate_job:
3183
- :param bool join_avatars:
3184
- :param JoinType join:
3185
- :param bool include_all_info: Include all info in returned objects
3186
- :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)
3187
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3188
- :param int limit: The maximum number of entries to return.
3189
- :param int skip: The number of entries to skip.
3190
- :param int page: The page number (i.e. skip limit*page entries)
3191
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3192
- :param list[str] x_accept_feature:
3193
- :param bool async_: Perform the request asynchronously
3194
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3485
+ :param cid:
3486
+ :type cid: str
3487
+ :param inflate_job:, defaults to false
3488
+ :type inflate_job: bool, optional
3489
+ :param join_avatars:, defaults to false
3490
+ :type join_avatars: bool, optional
3491
+ :param join:
3492
+ :type join: JoinType, optional
3493
+ :param include_all_info: Include all info in returned objects, defaults to false
3494
+ :type include_all_info: bool, optional
3495
+ :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)
3496
+ :type filter: str, optional
3497
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3498
+ :type sort: str, optional
3499
+ :param limit: The maximum number of entries to return.
3500
+ :type limit: int, optional
3501
+ :param skip: The number of entries to skip., defaults to 0
3502
+ :type skip: int, optional
3503
+ :param page: The page number (i.e. skip limit*page entries)
3504
+ :type page: int, optional
3505
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3506
+ :type after_id: str, optional
3507
+ :param x_accept_feature:, defaults to []
3508
+ :type x_accept_feature: list[str], optional
3509
+ :param async_: Perform the request asynchronously
3510
+ :type async_: bool, optional
3511
+ :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3195
3512
  """
3196
3513
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3197
3514
  kwargs['_return_http_data_only'] = True
@@ -3215,20 +3532,33 @@ class SubjectsApi(object):
3215
3532
  Returns analyses that directly belong to this resource.
3216
3533
  This method makes a synchronous HTTP request by default.
3217
3534
 
3218
- :param str cid: (required)
3219
- :param bool inflate_job:
3220
- :param bool join_avatars:
3221
- :param JoinType join:
3222
- :param bool include_all_info: Include all info in returned objects
3223
- :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)
3224
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3225
- :param int limit: The maximum number of entries to return.
3226
- :param int skip: The number of entries to skip.
3227
- :param int page: The page number (i.e. skip limit*page entries)
3228
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3229
- :param list[str] x_accept_feature:
3230
- :param bool async_: Perform the request asynchronously
3231
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3535
+ :param cid:
3536
+ :type cid: str
3537
+ :param inflate_job:, defaults to false
3538
+ :type inflate_job: bool, optional
3539
+ :param join_avatars:, defaults to false
3540
+ :type join_avatars: bool, optional
3541
+ :param join:
3542
+ :type join: JoinType, optional
3543
+ :param include_all_info: Include all info in returned objects, defaults to false
3544
+ :type include_all_info: bool, optional
3545
+ :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)
3546
+ :type filter: str, optional
3547
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3548
+ :type sort: str, optional
3549
+ :param limit: The maximum number of entries to return.
3550
+ :type limit: int, optional
3551
+ :param skip: The number of entries to skip., defaults to 0
3552
+ :type skip: int, optional
3553
+ :param page: The page number (i.e. skip limit*page entries)
3554
+ :type page: int, optional
3555
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3556
+ :type after_id: str, optional
3557
+ :param x_accept_feature:, defaults to []
3558
+ :type x_accept_feature: list[str], optional
3559
+ :param async_: Perform the request asynchronously
3560
+ :type async_: bool, optional
3561
+ :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
3232
3562
  """
3233
3563
 
3234
3564
  all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3320,13 +3650,19 @@ class SubjectsApi(object):
3320
3650
  Get an analysis.
3321
3651
  This method makes a synchronous HTTP request by default.
3322
3652
 
3323
- :param str cid: (required)
3324
- :param str analysis_id: (required)
3325
- :param bool inflate_job: Return job as an object instead of an id
3326
- :param bool join_avatars:
3327
- :param JoinType join:
3328
- :param bool async_: Perform the request asynchronously
3329
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
3653
+ :param cid:
3654
+ :type cid: str
3655
+ :param analysis_id:
3656
+ :type analysis_id: str
3657
+ :param inflate_job: Return job as an object instead of an id, defaults to false
3658
+ :type inflate_job: bool, optional
3659
+ :param join_avatars:, defaults to false
3660
+ :type join_avatars: bool, optional
3661
+ :param join:
3662
+ :type join: JoinType, optional
3663
+ :param async_: Perform the request asynchronously
3664
+ :type async_: bool, optional
3665
+ :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
3330
3666
  """
3331
3667
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3332
3668
  kwargs['_return_http_data_only'] = True
@@ -3350,13 +3686,19 @@ class SubjectsApi(object):
3350
3686
  Get an analysis.
3351
3687
  This method makes a synchronous HTTP request by default.
3352
3688
 
3353
- :param str cid: (required)
3354
- :param str analysis_id: (required)
3355
- :param bool inflate_job: Return job as an object instead of an id
3356
- :param bool join_avatars:
3357
- :param JoinType join:
3358
- :param bool async_: Perform the request asynchronously
3359
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
3689
+ :param cid:
3690
+ :type cid: str
3691
+ :param analysis_id:
3692
+ :type analysis_id: str
3693
+ :param inflate_job: Return job as an object instead of an id, defaults to false
3694
+ :type inflate_job: bool, optional
3695
+ :param join_avatars:, defaults to false
3696
+ :type join_avatars: bool, optional
3697
+ :param join:
3698
+ :type join: JoinType, optional
3699
+ :param async_: Perform the request asynchronously
3700
+ :type async_: bool, optional
3701
+ :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
3360
3702
  """
3361
3703
 
3362
3704
  all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
@@ -3437,10 +3779,13 @@ class SubjectsApi(object):
3437
3779
  Get info for a particular file.
3438
3780
  This method makes a synchronous HTTP request by default.
3439
3781
 
3440
- :param str cid: Container Id (required)
3441
- :param str filename: (required)
3442
- :param bool async_: Perform the request asynchronously
3443
- :return: FileOutput
3782
+ :param cid: Container Id
3783
+ :type cid: str
3784
+ :param filename:
3785
+ :type filename: str
3786
+ :param async_: Perform the request asynchronously
3787
+ :type async_: bool, optional
3788
+ :rtype: FileOutput
3444
3789
  """
3445
3790
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3446
3791
  kwargs['_return_http_data_only'] = True
@@ -3464,10 +3809,13 @@ class SubjectsApi(object):
3464
3809
  Get info for a particular file.
3465
3810
  This method makes a synchronous HTTP request by default.
3466
3811
 
3467
- :param str cid: Container Id (required)
3468
- :param str filename: (required)
3469
- :param bool async_: Perform the request asynchronously
3470
- :return: FileOutput
3812
+ :param cid: Container Id
3813
+ :type cid: str
3814
+ :param filename:
3815
+ :type filename: str
3816
+ :param async_: Perform the request asynchronously
3817
+ :type async_: bool, optional
3818
+ :rtype: FileOutput
3471
3819
  """
3472
3820
 
3473
3821
  all_params = ['cid','filename',] # noqa: E501
@@ -3542,10 +3890,13 @@ class SubjectsApi(object):
3542
3890
  Get a note of a(n) subject
3543
3891
  This method makes a synchronous HTTP request by default.
3544
3892
 
3545
- :param str cid: (required)
3546
- :param str note_id: (required)
3547
- :param bool async_: Perform the request asynchronously
3548
- :return: Note
3893
+ :param cid:
3894
+ :type cid: str
3895
+ :param note_id:
3896
+ :type note_id: str
3897
+ :param async_: Perform the request asynchronously
3898
+ :type async_: bool, optional
3899
+ :rtype: Note
3549
3900
  """
3550
3901
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3551
3902
  kwargs['_return_http_data_only'] = True
@@ -3569,10 +3920,13 @@ class SubjectsApi(object):
3569
3920
  Get a note of a(n) subject
3570
3921
  This method makes a synchronous HTTP request by default.
3571
3922
 
3572
- :param str cid: (required)
3573
- :param str note_id: (required)
3574
- :param bool async_: Perform the request asynchronously
3575
- :return: Note
3923
+ :param cid:
3924
+ :type cid: str
3925
+ :param note_id:
3926
+ :type note_id: str
3927
+ :param async_: Perform the request asynchronously
3928
+ :type async_: bool, optional
3929
+ :rtype: Note
3576
3930
  """
3577
3931
 
3578
3932
  all_params = ['cid','note_id',] # noqa: E501
@@ -3647,18 +4001,29 @@ class SubjectsApi(object):
3647
4001
  List sessions of a subject
3648
4002
  This method makes a synchronous HTTP request by default.
3649
4003
 
3650
- :param str subject_id: 24-char hex subject id (required)
3651
- :param JoinType join: join file origins
3652
- :param bool include_all_info: Include all info in returned objects
3653
- :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)
3654
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3655
- :param int limit: The maximum number of entries to return.
3656
- :param int skip: The number of entries to skip.
3657
- :param int page: The page number (i.e. skip limit*page entries)
3658
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3659
- :param list[union[HeaderFeature,str]] x_accept_feature:
3660
- :param bool async_: Perform the request asynchronously
3661
- :return: union[Page,list[SessionListOutput]]
4004
+ :param subject_id: 24-char hex subject id
4005
+ :type subject_id: str
4006
+ :param join: join file origins
4007
+ :type join: JoinType, optional
4008
+ :param include_all_info: Include all info in returned objects, defaults to false
4009
+ :type include_all_info: bool, optional
4010
+ :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)
4011
+ :type filter: str, optional
4012
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4013
+ :type sort: str, optional
4014
+ :param limit: The maximum number of entries to return.
4015
+ :type limit: int, optional
4016
+ :param skip: The number of entries to skip., defaults to 0
4017
+ :type skip: int, optional
4018
+ :param page: The page number (i.e. skip limit*page entries)
4019
+ :type page: int, optional
4020
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4021
+ :type after_id: str, optional
4022
+ :param x_accept_feature:, defaults to []
4023
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
4024
+ :param async_: Perform the request asynchronously
4025
+ :type async_: bool, optional
4026
+ :rtype: union[Page,list[SessionListOutput]]
3662
4027
  """
3663
4028
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3664
4029
  kwargs['_return_http_data_only'] = True
@@ -3682,18 +4047,29 @@ class SubjectsApi(object):
3682
4047
  List sessions of a subject
3683
4048
  This method makes a synchronous HTTP request by default.
3684
4049
 
3685
- :param str subject_id: 24-char hex subject id (required)
3686
- :param JoinType join: join file origins
3687
- :param bool include_all_info: Include all info in returned objects
3688
- :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)
3689
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3690
- :param int limit: The maximum number of entries to return.
3691
- :param int skip: The number of entries to skip.
3692
- :param int page: The page number (i.e. skip limit*page entries)
3693
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3694
- :param list[union[HeaderFeature,str]] x_accept_feature:
3695
- :param bool async_: Perform the request asynchronously
3696
- :return: union[Page,list[SessionListOutput]]
4050
+ :param subject_id: 24-char hex subject id
4051
+ :type subject_id: str
4052
+ :param join: join file origins
4053
+ :type join: JoinType, optional
4054
+ :param include_all_info: Include all info in returned objects, defaults to false
4055
+ :type include_all_info: bool, optional
4056
+ :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)
4057
+ :type filter: str, optional
4058
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4059
+ :type sort: str, optional
4060
+ :param limit: The maximum number of entries to return.
4061
+ :type limit: int, optional
4062
+ :param skip: The number of entries to skip., defaults to 0
4063
+ :type skip: int, optional
4064
+ :param page: The page number (i.e. skip limit*page entries)
4065
+ :type page: int, optional
4066
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4067
+ :type after_id: str, optional
4068
+ :param x_accept_feature:, defaults to []
4069
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
4070
+ :param async_: Perform the request asynchronously
4071
+ :type async_: bool, optional
4072
+ :rtype: union[Page,list[SessionListOutput]]
3697
4073
  """
3698
4074
 
3699
4075
  all_params = ['subject_id','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3781,10 +4157,13 @@ class SubjectsApi(object):
3781
4157
  Get the value of a tag, by name
3782
4158
  This method makes a synchronous HTTP request by default.
3783
4159
 
3784
- :param str cid: (required)
3785
- :param str value: The tag to interact with (required)
3786
- :param bool async_: Perform the request asynchronously
3787
- :return: str
4160
+ :param cid:
4161
+ :type cid: str
4162
+ :param value: The tag to interact with
4163
+ :type value: str
4164
+ :param async_: Perform the request asynchronously
4165
+ :type async_: bool, optional
4166
+ :rtype: str
3788
4167
  """
3789
4168
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3790
4169
  kwargs['_return_http_data_only'] = True
@@ -3808,10 +4187,13 @@ class SubjectsApi(object):
3808
4187
  Get the value of a tag, by name
3809
4188
  This method makes a synchronous HTTP request by default.
3810
4189
 
3811
- :param str cid: (required)
3812
- :param str value: The tag to interact with (required)
3813
- :param bool async_: Perform the request asynchronously
3814
- :return: str
4190
+ :param cid:
4191
+ :type cid: str
4192
+ :param value: The tag to interact with
4193
+ :type value: str
4194
+ :param async_: Perform the request asynchronously
4195
+ :type async_: bool, optional
4196
+ :rtype: str
3815
4197
  """
3816
4198
 
3817
4199
  all_params = ['cid','value',] # noqa: E501
@@ -3886,10 +4268,13 @@ class SubjectsApi(object):
3886
4268
  Update a subject
3887
4269
  This method makes a synchronous HTTP request by default.
3888
4270
 
3889
- :param str subject_id: 24-char hex subject id (required)
3890
- :param SubjectModify body: (required)
3891
- :param bool async_: Perform the request asynchronously
3892
- :return: ModifiedResult
4271
+ :param subject_id: 24-char hex subject id
4272
+ :type subject_id: str
4273
+ :param body:
4274
+ :type body: SubjectModify
4275
+ :param async_: Perform the request asynchronously
4276
+ :type async_: bool, optional
4277
+ :rtype: ModifiedResult
3893
4278
  """
3894
4279
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3895
4280
  kwargs['_return_http_data_only'] = True
@@ -3913,10 +4298,13 @@ class SubjectsApi(object):
3913
4298
  Update a subject
3914
4299
  This method makes a synchronous HTTP request by default.
3915
4300
 
3916
- :param str subject_id: 24-char hex subject id (required)
3917
- :param SubjectModify body: (required)
3918
- :param bool async_: Perform the request asynchronously
3919
- :return: ModifiedResult
4301
+ :param subject_id: 24-char hex subject id
4302
+ :type subject_id: str
4303
+ :param body:
4304
+ :type body: SubjectModify
4305
+ :param async_: Perform the request asynchronously
4306
+ :type async_: bool, optional
4307
+ :rtype: ModifiedResult
3920
4308
  """
3921
4309
 
3922
4310
  all_params = ['subject_id','body',] # noqa: E501
@@ -4002,11 +4390,15 @@ class SubjectsApi(object):
4002
4390
  Modify an analysis.
4003
4391
  This method makes a synchronous HTTP request by default.
4004
4392
 
4005
- :param str cid: (required)
4006
- :param str analysis_id: (required)
4007
- :param AnalysisModifyInput body: (required)
4008
- :param bool async_: Perform the request asynchronously
4009
- :return: ModifiedResult
4393
+ :param cid:
4394
+ :type cid: str
4395
+ :param analysis_id:
4396
+ :type analysis_id: str
4397
+ :param body:
4398
+ :type body: AnalysisModifyInput
4399
+ :param async_: Perform the request asynchronously
4400
+ :type async_: bool, optional
4401
+ :rtype: ModifiedResult
4010
4402
  """
4011
4403
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4012
4404
  kwargs['_return_http_data_only'] = True
@@ -4030,11 +4422,15 @@ class SubjectsApi(object):
4030
4422
  Modify an analysis.
4031
4423
  This method makes a synchronous HTTP request by default.
4032
4424
 
4033
- :param str cid: (required)
4034
- :param str analysis_id: (required)
4035
- :param AnalysisModifyInput body: (required)
4036
- :param bool async_: Perform the request asynchronously
4037
- :return: ModifiedResult
4425
+ :param cid:
4426
+ :type cid: str
4427
+ :param analysis_id:
4428
+ :type analysis_id: str
4429
+ :param body:
4430
+ :type body: AnalysisModifyInput
4431
+ :param async_: Perform the request asynchronously
4432
+ :type async_: bool, optional
4433
+ :rtype: ModifiedResult
4038
4434
  """
4039
4435
 
4040
4436
  all_params = ['cid','analysis_id','body',] # noqa: E501
@@ -4126,11 +4522,15 @@ class SubjectsApi(object):
4126
4522
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
4127
4523
  This method makes a synchronous HTTP request by default.
4128
4524
 
4129
- :param str cid: (required)
4130
- :param str filename: (required)
4131
- :param FileModifyInput body: (required)
4132
- :param bool async_: Perform the request asynchronously
4133
- :return: ModifiedResult
4525
+ :param cid:
4526
+ :type cid: str
4527
+ :param filename:
4528
+ :type filename: str
4529
+ :param body:
4530
+ :type body: FileModifyInput
4531
+ :param async_: Perform the request asynchronously
4532
+ :type async_: bool, optional
4533
+ :rtype: ModifiedResult
4134
4534
  """
4135
4535
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4136
4536
  kwargs['_return_http_data_only'] = True
@@ -4154,11 +4554,15 @@ class SubjectsApi(object):
4154
4554
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
4155
4555
  This method makes a synchronous HTTP request by default.
4156
4556
 
4157
- :param str cid: (required)
4158
- :param str filename: (required)
4159
- :param FileModifyInput body: (required)
4160
- :param bool async_: Perform the request asynchronously
4161
- :return: ModifiedResult
4557
+ :param cid:
4558
+ :type cid: str
4559
+ :param filename:
4560
+ :type filename: str
4561
+ :param body:
4562
+ :type body: FileModifyInput
4563
+ :param async_: Perform the request asynchronously
4564
+ :type async_: bool, optional
4565
+ :rtype: ModifiedResult
4162
4566
  """
4163
4567
 
4164
4568
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4250,11 +4654,15 @@ class SubjectsApi(object):
4250
4654
  If replacing a file's classification, the modality can optionally be modified as well.
4251
4655
  This method makes a synchronous HTTP request by default.
4252
4656
 
4253
- :param str cid: (required)
4254
- :param str filename: (required)
4255
- :param FileClassificationDelta body: (required)
4256
- :param bool async_: Perform the request asynchronously
4257
- :return: ModifiedResult
4657
+ :param cid:
4658
+ :type cid: str
4659
+ :param filename:
4660
+ :type filename: str
4661
+ :param body:
4662
+ :type body: FileClassificationDelta
4663
+ :param async_: Perform the request asynchronously
4664
+ :type async_: bool, optional
4665
+ :rtype: ModifiedResult
4258
4666
  """
4259
4667
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4260
4668
  kwargs['_return_http_data_only'] = True
@@ -4278,11 +4686,15 @@ class SubjectsApi(object):
4278
4686
  If replacing a file's classification, the modality can optionally be modified as well.
4279
4687
  This method makes a synchronous HTTP request by default.
4280
4688
 
4281
- :param str cid: (required)
4282
- :param str filename: (required)
4283
- :param FileClassificationDelta body: (required)
4284
- :param bool async_: Perform the request asynchronously
4285
- :return: ModifiedResult
4689
+ :param cid:
4690
+ :type cid: str
4691
+ :param filename:
4692
+ :type filename: str
4693
+ :param body:
4694
+ :type body: FileClassificationDelta
4695
+ :param async_: Perform the request asynchronously
4696
+ :type async_: bool, optional
4697
+ :rtype: ModifiedResult
4286
4698
  """
4287
4699
 
4288
4700
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4374,11 +4786,15 @@ class SubjectsApi(object):
4374
4786
  Modify and return the file 'info' field
4375
4787
  This method makes a synchronous HTTP request by default.
4376
4788
 
4377
- :param str cid: (required)
4378
- :param str filename: (required)
4379
- :param Info body: (required)
4380
- :param bool async_: Perform the request asynchronously
4381
- :return: ModifiedResult
4789
+ :param cid:
4790
+ :type cid: str
4791
+ :param filename:
4792
+ :type filename: str
4793
+ :param body:
4794
+ :type body: Info
4795
+ :param async_: Perform the request asynchronously
4796
+ :type async_: bool, optional
4797
+ :rtype: ModifiedResult
4382
4798
  """
4383
4799
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4384
4800
  kwargs['_return_http_data_only'] = True
@@ -4402,11 +4818,15 @@ class SubjectsApi(object):
4402
4818
  Modify and return the file 'info' field
4403
4819
  This method makes a synchronous HTTP request by default.
4404
4820
 
4405
- :param str cid: (required)
4406
- :param str filename: (required)
4407
- :param Info body: (required)
4408
- :param bool async_: Perform the request asynchronously
4409
- :return: ModifiedResult
4821
+ :param cid:
4822
+ :type cid: str
4823
+ :param filename:
4824
+ :type filename: str
4825
+ :param body:
4826
+ :type body: Info
4827
+ :param async_: Perform the request asynchronously
4828
+ :type async_: bool, optional
4829
+ :rtype: ModifiedResult
4410
4830
  """
4411
4831
 
4412
4832
  all_params = ['cid','filename','body',] # noqa: E501
@@ -4498,10 +4918,13 @@ class SubjectsApi(object):
4498
4918
  Update or replace info for a(n) subject. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4499
4919
  This method makes a synchronous HTTP request by default.
4500
4920
 
4501
- :param str cid: (required)
4502
- :param Info body: (required)
4503
- :param bool async_: Perform the request asynchronously
4504
- :return: ModifiedResult
4921
+ :param cid:
4922
+ :type cid: str
4923
+ :param body:
4924
+ :type body: Info
4925
+ :param async_: Perform the request asynchronously
4926
+ :type async_: bool, optional
4927
+ :rtype: ModifiedResult
4505
4928
  """
4506
4929
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4507
4930
  kwargs['_return_http_data_only'] = True
@@ -4525,10 +4948,13 @@ class SubjectsApi(object):
4525
4948
  Update or replace info for a(n) subject. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
4526
4949
  This method makes a synchronous HTTP request by default.
4527
4950
 
4528
- :param str cid: (required)
4529
- :param Info body: (required)
4530
- :param bool async_: Perform the request asynchronously
4531
- :return: ModifiedResult
4951
+ :param cid:
4952
+ :type cid: str
4953
+ :param body:
4954
+ :type body: Info
4955
+ :param async_: Perform the request asynchronously
4956
+ :type async_: bool, optional
4957
+ :rtype: ModifiedResult
4532
4958
  """
4533
4959
 
4534
4960
  all_params = ['cid','body',] # noqa: E501
@@ -4614,11 +5040,15 @@ class SubjectsApi(object):
4614
5040
  Update a note of a(n) subject
4615
5041
  This method makes a synchronous HTTP request by default.
4616
5042
 
4617
- :param str cid: (required)
4618
- :param str note_id: (required)
4619
- :param NoteInput body: (required)
4620
- :param bool async_: Perform the request asynchronously
4621
- :return: int
5043
+ :param cid:
5044
+ :type cid: str
5045
+ :param note_id:
5046
+ :type note_id: str
5047
+ :param body:
5048
+ :type body: NoteInput
5049
+ :param async_: Perform the request asynchronously
5050
+ :type async_: bool, optional
5051
+ :rtype: int
4622
5052
  """
4623
5053
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4624
5054
  kwargs['_return_http_data_only'] = True
@@ -4642,11 +5072,15 @@ class SubjectsApi(object):
4642
5072
  Update a note of a(n) subject
4643
5073
  This method makes a synchronous HTTP request by default.
4644
5074
 
4645
- :param str cid: (required)
4646
- :param str note_id: (required)
4647
- :param NoteInput body: (required)
4648
- :param bool async_: Perform the request asynchronously
4649
- :return: int
5075
+ :param cid:
5076
+ :type cid: str
5077
+ :param note_id:
5078
+ :type note_id: str
5079
+ :param body:
5080
+ :type body: NoteInput
5081
+ :param async_: Perform the request asynchronously
5082
+ :type async_: bool, optional
5083
+ :rtype: int
4650
5084
  """
4651
5085
 
4652
5086
  all_params = ['cid','note_id','body',] # noqa: E501
@@ -4738,11 +5172,15 @@ class SubjectsApi(object):
4738
5172
  Rename a tag
4739
5173
  This method makes a synchronous HTTP request by default.
4740
5174
 
4741
- :param str cid: (required)
4742
- :param str value: The tag to interact with (required)
4743
- :param Tag body: (required)
4744
- :param bool async_: Perform the request asynchronously
4745
- :return: str
5175
+ :param cid:
5176
+ :type cid: str
5177
+ :param value: The tag to interact with
5178
+ :type value: str
5179
+ :param body:
5180
+ :type body: Tag
5181
+ :param async_: Perform the request asynchronously
5182
+ :type async_: bool, optional
5183
+ :rtype: str
4746
5184
  """
4747
5185
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4748
5186
  kwargs['_return_http_data_only'] = True
@@ -4766,11 +5204,15 @@ class SubjectsApi(object):
4766
5204
  Rename a tag
4767
5205
  This method makes a synchronous HTTP request by default.
4768
5206
 
4769
- :param str cid: (required)
4770
- :param str value: The tag to interact with (required)
4771
- :param Tag body: (required)
4772
- :param bool async_: Perform the request asynchronously
4773
- :return: str
5207
+ :param cid:
5208
+ :type cid: str
5209
+ :param value: The tag to interact with
5210
+ :type value: str
5211
+ :param body:
5212
+ :type body: Tag
5213
+ :param async_: Perform the request asynchronously
5214
+ :type async_: bool, optional
5215
+ :rtype: str
4774
5216
  """
4775
5217
 
4776
5218
  all_params = ['cid','value','body',] # noqa: E501
@@ -4862,10 +5304,13 @@ class SubjectsApi(object):
4862
5304
  Smart copy a subject
4863
5305
  This method makes a synchronous HTTP request by default.
4864
5306
 
4865
- :param str subject_id: (required)
4866
- :param SubjectCopyInput body: (required)
4867
- :param bool async_: Perform the request asynchronously
4868
- :return: Subject
5307
+ :param subject_id:
5308
+ :type subject_id: str
5309
+ :param body:
5310
+ :type body: SubjectCopyInput
5311
+ :param async_: Perform the request asynchronously
5312
+ :type async_: bool, optional
5313
+ :rtype: Subject
4869
5314
  """
4870
5315
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4871
5316
  kwargs['_return_http_data_only'] = True
@@ -4889,10 +5334,13 @@ class SubjectsApi(object):
4889
5334
  Smart copy a subject
4890
5335
  This method makes a synchronous HTTP request by default.
4891
5336
 
4892
- :param str subject_id: (required)
4893
- :param SubjectCopyInput body: (required)
4894
- :param bool async_: Perform the request asynchronously
4895
- :return: Subject
5337
+ :param subject_id:
5338
+ :type subject_id: str
5339
+ :param body:
5340
+ :type body: SubjectCopyInput
5341
+ :param async_: Perform the request asynchronously
5342
+ :type async_: bool, optional
5343
+ :rtype: Subject
4896
5344
  """
4897
5345
 
4898
5346
  all_params = ['subject_id','body',] # noqa: E501
@@ -4978,18 +5426,29 @@ class SubjectsApi(object):
4978
5426
  Upload a file to a(n) subject.
4979
5427
  This method makes a synchronous HTTP request by default.
4980
5428
 
4981
- :param str container_id: (required)
4982
- :param str file: The file to upload (required)
4983
- :param bool preserve_metadata:
4984
- :param str ticket:
4985
- :param str id:
4986
- :param ContainerType level:
4987
- :param str job:
4988
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
4989
- :param list[str] x_accept_feature: redirect header
4990
- :param str content_type:
4991
- :param bool async_: Perform the request asynchronously
4992
- :return: union[list[FileOutput],UploadTicketOutput]
5429
+ :param container_id:
5430
+ :type container_id: str
5431
+ :param file: The file to upload
5432
+ :type file: str
5433
+ :param preserve_metadata:, defaults to false
5434
+ :type preserve_metadata: bool, optional
5435
+ :param ticket:
5436
+ :type ticket: str, optional
5437
+ :param id:
5438
+ :type id: str, optional
5439
+ :param level:
5440
+ :type level: ContainerType, optional
5441
+ :param job:
5442
+ :type job: str, optional
5443
+ :param metadata: Dictionary of file metadata (type, modality, info, etc.)
5444
+ :type metadata: object, optional
5445
+ :param x_accept_feature: redirect header, defaults to []
5446
+ :type x_accept_feature: list[str], optional
5447
+ :param content_type:
5448
+ :type content_type: str, optional
5449
+ :param async_: Perform the request asynchronously
5450
+ :type async_: bool, optional
5451
+ :rtype: union[list[FileOutput],UploadTicketOutput]
4993
5452
  """
4994
5453
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4995
5454
  kwargs['_return_http_data_only'] = True
@@ -5013,18 +5472,29 @@ class SubjectsApi(object):
5013
5472
  Upload a file to a(n) subject.
5014
5473
  This method makes a synchronous HTTP request by default.
5015
5474
 
5016
- :param str container_id: (required)
5017
- :param str file: The file to upload (required)
5018
- :param bool preserve_metadata:
5019
- :param str ticket:
5020
- :param str id:
5021
- :param ContainerType level:
5022
- :param str job:
5023
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
5024
- :param list[str] x_accept_feature: redirect header
5025
- :param str content_type:
5026
- :param bool async_: Perform the request asynchronously
5027
- :return: union[list[FileOutput],UploadTicketOutput]
5475
+ :param container_id:
5476
+ :type container_id: str
5477
+ :param file: The file to upload
5478
+ :type file: str
5479
+ :param preserve_metadata:, defaults to false
5480
+ :type preserve_metadata: bool, optional
5481
+ :param ticket:
5482
+ :type ticket: str, optional
5483
+ :param id:
5484
+ :type id: str, optional
5485
+ :param level:
5486
+ :type level: ContainerType, optional
5487
+ :param job:
5488
+ :type job: str, optional
5489
+ :param metadata: Dictionary of file metadata (type, modality, info, etc.)
5490
+ :type metadata: object, optional
5491
+ :param x_accept_feature: redirect header, defaults to []
5492
+ :type x_accept_feature: list[str], optional
5493
+ :param content_type:
5494
+ :type content_type: str, optional
5495
+ :param async_: Perform the request asynchronously
5496
+ :type async_: bool, optional
5497
+ :rtype: union[list[FileOutput],UploadTicketOutput]
5028
5498
  """
5029
5499
 
5030
5500
  all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
@@ -5120,16 +5590,25 @@ class SubjectsApi(object):
5120
5590
  Upload an output file to an analysis
5121
5591
  This method makes a synchronous HTTP request by default.
5122
5592
 
5123
- :param str cid: (required)
5124
- :param str analysis_id: (required)
5125
- :param str file: The file to upload (required)
5126
- :param str ticket:
5127
- :param str id:
5128
- :param ContainerType level:
5129
- :param str job:
5130
- :param str content_type:
5131
- :param bool async_: Perform the request asynchronously
5132
- :return: list[FileOutput]
5593
+ :param cid:
5594
+ :type cid: str
5595
+ :param analysis_id:
5596
+ :type analysis_id: str
5597
+ :param file: The file to upload
5598
+ :type file: str
5599
+ :param ticket:
5600
+ :type ticket: str, optional
5601
+ :param id:
5602
+ :type id: str, optional
5603
+ :param level:
5604
+ :type level: ContainerType, optional
5605
+ :param job:
5606
+ :type job: str, optional
5607
+ :param content_type:
5608
+ :type content_type: str, optional
5609
+ :param async_: Perform the request asynchronously
5610
+ :type async_: bool, optional
5611
+ :rtype: list[FileOutput]
5133
5612
  """
5134
5613
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5135
5614
  kwargs['_return_http_data_only'] = True
@@ -5153,16 +5632,25 @@ class SubjectsApi(object):
5153
5632
  Upload an output file to an analysis
5154
5633
  This method makes a synchronous HTTP request by default.
5155
5634
 
5156
- :param str cid: (required)
5157
- :param str analysis_id: (required)
5158
- :param str file: The file to upload (required)
5159
- :param str ticket:
5160
- :param str id:
5161
- :param ContainerType level:
5162
- :param str job:
5163
- :param str content_type:
5164
- :param bool async_: Perform the request asynchronously
5165
- :return: list[FileOutput]
5635
+ :param cid:
5636
+ :type cid: str
5637
+ :param analysis_id:
5638
+ :type analysis_id: str
5639
+ :param file: The file to upload
5640
+ :type file: str
5641
+ :param ticket:
5642
+ :type ticket: str, optional
5643
+ :param id:
5644
+ :type id: str, optional
5645
+ :param level:
5646
+ :type level: ContainerType, optional
5647
+ :param job:
5648
+ :type job: str, optional
5649
+ :param content_type:
5650
+ :type content_type: str, optional
5651
+ :param async_: Perform the request asynchronously
5652
+ :type async_: bool, optional
5653
+ :rtype: list[FileOutput]
5166
5654
  """
5167
5655
 
5168
5656
  all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501
@@ -5257,9 +5745,11 @@ class SubjectsApi(object):
5257
5745
  Verify that the given master subject code exists or not
5258
5746
  This method makes a synchronous HTTP request by default.
5259
5747
 
5260
- :param str code: code id (required)
5261
- :param bool async_: Perform the request asynchronously
5262
- :return: MasterSubjectCodeOutput
5748
+ :param code: code id
5749
+ :type code: str
5750
+ :param async_: Perform the request asynchronously
5751
+ :type async_: bool, optional
5752
+ :rtype: MasterSubjectCodeOutput
5263
5753
  """
5264
5754
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5265
5755
  kwargs['_return_http_data_only'] = True
@@ -5283,9 +5773,11 @@ class SubjectsApi(object):
5283
5773
  Verify that the given master subject code exists or not
5284
5774
  This method makes a synchronous HTTP request by default.
5285
5775
 
5286
- :param str code: code id (required)
5287
- :param bool async_: Perform the request asynchronously
5288
- :return: MasterSubjectCodeOutput
5776
+ :param code: code id
5777
+ :type code: str
5778
+ :param async_: Perform the request asynchronously
5779
+ :type async_: bool, optional
5780
+ :rtype: MasterSubjectCodeOutput
5289
5781
  """
5290
5782
 
5291
5783
  all_params = ['code',] # noqa: E501