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
 
@@ -36,10 +29,13 @@ class ProjectsApi(object):
36
29
 
37
30
  This method makes a synchronous HTTP request by default.
38
31
 
39
- :param ProjectInput body: (required)
40
- :param bool inherit: Inherit permissions from the group permission template
41
- :param bool async_: Perform the request asynchronously
42
- :return: InsertedId
32
+ :param body:
33
+ :type body: ProjectInput
34
+ :param inherit: Inherit permissions from the group permission template, defaults to false
35
+ :type inherit: bool, optional
36
+ :param async_: Perform the request asynchronously
37
+ :type async_: bool, optional
38
+ :rtype: InsertedId
43
39
  """
44
40
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
45
41
  kwargs['_return_http_data_only'] = True
@@ -62,10 +58,13 @@ class ProjectsApi(object):
62
58
 
63
59
  This method makes a synchronous HTTP request by default.
64
60
 
65
- :param ProjectInput body: (required)
66
- :param bool inherit: Inherit permissions from the group permission template
67
- :param bool async_: Perform the request asynchronously
68
- :return: InsertedId
61
+ :param body:
62
+ :type body: ProjectInput
63
+ :param inherit: Inherit permissions from the group permission template, defaults to false
64
+ :type inherit: bool, optional
65
+ :param async_: Perform the request asynchronously
66
+ :type async_: bool, optional
67
+ :rtype: InsertedId
69
68
  """
70
69
 
71
70
  all_params = ['body','inherit',] # noqa: E501
@@ -147,12 +146,15 @@ class ProjectsApi(object):
147
146
  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.
148
147
  This method makes a synchronous HTTP request by default.
149
148
 
150
- :param str cid: (required)
151
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
152
- :param bool job: returns job_id instead of analysis.id
153
- :param bool job: returns job_id instead of analysis.id
154
- :param bool async_: Perform the request asynchronously
155
- :return: InsertedId
149
+ :param cid:
150
+ :type cid: str
151
+ :param body:
152
+ :type body: union[AdhocAnalysisInput,JobAnalysisInput]
153
+ :param job: returns job_id instead of analysis.id, defaults to false
154
+ :type job: bool, optional
155
+ :param async_: Perform the request asynchronously
156
+ :type async_: bool, optional
157
+ :rtype: InsertedId
156
158
  """
157
159
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
158
160
  kwargs['_return_http_data_only'] = True
@@ -176,15 +178,18 @@ class ProjectsApi(object):
176
178
  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.
177
179
  This method makes a synchronous HTTP request by default.
178
180
 
179
- :param str cid: (required)
180
- :param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
181
- :param bool job: returns job_id instead of analysis.id
182
- :param bool job: returns job_id instead of analysis.id
183
- :param bool async_: Perform the request asynchronously
184
- :return: InsertedId
181
+ :param cid:
182
+ :type cid: str
183
+ :param body:
184
+ :type body: union[AdhocAnalysisInput,JobAnalysisInput]
185
+ :param job: returns job_id instead of analysis.id, defaults to false
186
+ :type job: bool, optional
187
+ :param async_: Perform the request asynchronously
188
+ :type async_: bool, optional
189
+ :rtype: InsertedId
185
190
  """
186
191
 
187
- all_params = ['cid','body','job','job',] # noqa: E501
192
+ all_params = ['cid','body','job',] # noqa: E501
188
193
  all_params.append('async_')
189
194
  all_params.append('_return_http_data_only')
190
195
  all_params.append('_preload_content')
@@ -217,8 +222,6 @@ class ProjectsApi(object):
217
222
  path_params['cid'] = params['cid'] # noqa: E501
218
223
 
219
224
  query_params = []
220
- if 'job' in params:
221
- query_params.append(('job', params['job'])) # noqa: E501
222
225
  if 'job' in params:
223
226
  query_params.append(('job', params['job'])) # noqa: E501
224
227
  else:
@@ -273,11 +276,15 @@ class ProjectsApi(object):
273
276
  Add a note to a(n) project analysis.
274
277
  This method makes a synchronous HTTP request by default.
275
278
 
276
- :param str container_id: 24-char hex id (required)
277
- :param str analysis_id: 24-char hex analysis id (required)
278
- :param NoteInput body: (required)
279
- :param bool async_: Perform the request asynchronously
280
- :return: Note
279
+ :param container_id: 24-char hex id
280
+ :type container_id: str
281
+ :param analysis_id: 24-char hex analysis id
282
+ :type analysis_id: str
283
+ :param body:
284
+ :type body: NoteInput
285
+ :param async_: Perform the request asynchronously
286
+ :type async_: bool, optional
287
+ :rtype: Note
281
288
  """
282
289
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
283
290
  kwargs['_return_http_data_only'] = True
@@ -301,11 +308,15 @@ class ProjectsApi(object):
301
308
  Add a note to a(n) project analysis.
302
309
  This method makes a synchronous HTTP request by default.
303
310
 
304
- :param str container_id: 24-char hex id (required)
305
- :param str analysis_id: 24-char hex analysis id (required)
306
- :param NoteInput body: (required)
307
- :param bool async_: Perform the request asynchronously
308
- :return: Note
311
+ :param container_id: 24-char hex id
312
+ :type container_id: str
313
+ :param analysis_id: 24-char hex analysis id
314
+ :type analysis_id: str
315
+ :param body:
316
+ :type body: NoteInput
317
+ :param async_: Perform the request asynchronously
318
+ :type async_: bool, optional
319
+ :rtype: Note
309
320
  """
310
321
 
311
322
  all_params = ['container_id','analysis_id','body',] # noqa: E501
@@ -397,10 +408,13 @@ class ProjectsApi(object):
397
408
  Add a note to a(n) project.
398
409
  This method makes a synchronous HTTP request by default.
399
410
 
400
- :param str container_id: (required)
401
- :param NoteInput body: (required)
402
- :param bool async_: Perform the request asynchronously
403
- :return: Note
411
+ :param container_id:
412
+ :type container_id: str
413
+ :param body:
414
+ :type body: NoteInput
415
+ :param async_: Perform the request asynchronously
416
+ :type async_: bool, optional
417
+ :rtype: Note
404
418
  """
405
419
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
406
420
  kwargs['_return_http_data_only'] = True
@@ -424,10 +438,13 @@ class ProjectsApi(object):
424
438
  Add a note to a(n) project.
425
439
  This method makes a synchronous HTTP request by default.
426
440
 
427
- :param str container_id: (required)
428
- :param NoteInput body: (required)
429
- :param bool async_: Perform the request asynchronously
430
- :return: Note
441
+ :param container_id:
442
+ :type container_id: str
443
+ :param body:
444
+ :type body: NoteInput
445
+ :param async_: Perform the request asynchronously
446
+ :type async_: bool, optional
447
+ :rtype: Note
431
448
  """
432
449
 
433
450
  all_params = ['container_id','body',] # noqa: E501
@@ -513,11 +530,15 @@ class ProjectsApi(object):
513
530
  Add user to a project Args: project_id: The id of the project permission: The permission to add auth_session: The auth session Returns: RolePermissionOutput: The added permission
514
531
  This method makes a synchronous HTTP request by default.
515
532
 
516
- :param str project_id: (required)
517
- :param RolePermission body: (required)
518
- :param list[union[HeaderFeature,str]] x_accept_feature:
519
- :param bool async_: Perform the request asynchronously
520
- :return: RolePermissionOutput
533
+ :param project_id:
534
+ :type project_id: str
535
+ :param body:
536
+ :type body: RolePermission
537
+ :param x_accept_feature:, defaults to []
538
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
539
+ :param async_: Perform the request asynchronously
540
+ :type async_: bool, optional
541
+ :rtype: RolePermissionOutput
521
542
  """
522
543
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
523
544
  kwargs['_return_http_data_only'] = True
@@ -541,11 +562,15 @@ class ProjectsApi(object):
541
562
  Add user to a project Args: project_id: The id of the project permission: The permission to add auth_session: The auth session Returns: RolePermissionOutput: The added permission
542
563
  This method makes a synchronous HTTP request by default.
543
564
 
544
- :param str project_id: (required)
545
- :param RolePermission body: (required)
546
- :param list[union[HeaderFeature,str]] x_accept_feature:
547
- :param bool async_: Perform the request asynchronously
548
- :return: RolePermissionOutput
565
+ :param project_id:
566
+ :type project_id: str
567
+ :param body:
568
+ :type body: RolePermission
569
+ :param x_accept_feature:, defaults to []
570
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
571
+ :param async_: Perform the request asynchronously
572
+ :type async_: bool, optional
573
+ :rtype: RolePermissionOutput
549
574
  """
550
575
 
551
576
  all_params = ['project_id','body','x_accept_feature',] # noqa: E501
@@ -633,10 +658,13 @@ class ProjectsApi(object):
633
658
 
634
659
  This method makes a synchronous HTTP request by default.
635
660
 
636
- :param str project_id: (required)
637
- :param GearRuleInput body: (required)
638
- :param bool async_: Perform the request asynchronously
639
- :return: GearRuleOutput
661
+ :param project_id:
662
+ :type project_id: str
663
+ :param body:
664
+ :type body: GearRuleInput
665
+ :param async_: Perform the request asynchronously
666
+ :type async_: bool, optional
667
+ :rtype: GearRuleOutput
640
668
  """
641
669
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
642
670
  kwargs['_return_http_data_only'] = True
@@ -659,10 +687,13 @@ class ProjectsApi(object):
659
687
 
660
688
  This method makes a synchronous HTTP request by default.
661
689
 
662
- :param str project_id: (required)
663
- :param GearRuleInput body: (required)
664
- :param bool async_: Perform the request asynchronously
665
- :return: GearRuleOutput
690
+ :param project_id:
691
+ :type project_id: str
692
+ :param body:
693
+ :type body: GearRuleInput
694
+ :param async_: Perform the request asynchronously
695
+ :type async_: bool, optional
696
+ :rtype: GearRuleOutput
666
697
  """
667
698
 
668
699
  all_params = ['project_id','body',] # noqa: E501
@@ -748,10 +779,13 @@ class ProjectsApi(object):
748
779
  Propagates changes to projects, sessions and acquisitions
749
780
  This method makes a synchronous HTTP request by default.
750
781
 
751
- :param str cid: (required)
752
- :param Tag body: (required)
753
- :param bool async_: Perform the request asynchronously
754
- :return: ModifiedResult
782
+ :param cid:
783
+ :type cid: str
784
+ :param body:
785
+ :type body: Tag
786
+ :param async_: Perform the request asynchronously
787
+ :type async_: bool, optional
788
+ :rtype: ModifiedResult
755
789
  """
756
790
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
757
791
  kwargs['_return_http_data_only'] = True
@@ -775,10 +809,13 @@ class ProjectsApi(object):
775
809
  Propagates changes to projects, sessions and acquisitions
776
810
  This method makes a synchronous HTTP request by default.
777
811
 
778
- :param str cid: (required)
779
- :param Tag body: (required)
780
- :param bool async_: Perform the request asynchronously
781
- :return: ModifiedResult
812
+ :param cid:
813
+ :type cid: str
814
+ :param body:
815
+ :type body: Tag
816
+ :param async_: Perform the request asynchronously
817
+ :type async_: bool, optional
818
+ :rtype: ModifiedResult
782
819
  """
783
820
 
784
821
  all_params = ['cid','body',] # noqa: E501
@@ -864,10 +901,13 @@ class ProjectsApi(object):
864
901
  Add multiple tags to a(n) project
865
902
  This method makes a synchronous HTTP request by default.
866
903
 
867
- :param str cid: (required)
868
- :param list[str] body: (required)
869
- :param bool async_: Perform the request asynchronously
870
- :return: None
904
+ :param cid:
905
+ :type cid: str
906
+ :param body:
907
+ :type body: list[str]
908
+ :param async_: Perform the request asynchronously
909
+ :type async_: bool, optional
910
+ :rtype: None
871
911
  """
872
912
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
873
913
  kwargs['_return_http_data_only'] = True
@@ -891,10 +931,13 @@ class ProjectsApi(object):
891
931
  Add multiple tags to a(n) project
892
932
  This method makes a synchronous HTTP request by default.
893
933
 
894
- :param str cid: (required)
895
- :param list[str] body: (required)
896
- :param bool async_: Perform the request asynchronously
897
- :return: None
934
+ :param cid:
935
+ :type cid: str
936
+ :param body:
937
+ :type body: list[str]
938
+ :param async_: Perform the request asynchronously
939
+ :type async_: bool, optional
940
+ :rtype: None
898
941
  """
899
942
 
900
943
  all_params = ['cid','body',] # noqa: E501
@@ -972,16 +1015,25 @@ class ProjectsApi(object):
972
1015
 
973
1016
  This method makes a synchronous HTTP request by default.
974
1017
 
975
- :param str search_string: Include only results containing the search string
976
- :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)
977
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
978
- :param int limit: The maximum number of entries to return.
979
- :param int skip: The number of entries to skip.
980
- :param int page: The page number (i.e. skip limit*page entries)
981
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
982
- :param list[union[HeaderFeature,str]] x_accept_feature:
983
- :param bool async_: Perform the request asynchronously
984
- :return: union[list[CatalogListOutput],Page]
1018
+ :param search_string: Include only results containing the search string
1019
+ :type search_string: str, optional
1020
+ :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)
1021
+ :type filter: str, optional
1022
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1023
+ :type sort: str, optional
1024
+ :param limit: The maximum number of entries to return.
1025
+ :type limit: int, optional
1026
+ :param skip: The number of entries to skip., defaults to 0
1027
+ :type skip: int, optional
1028
+ :param page: The page number (i.e. skip limit*page entries)
1029
+ :type page: int, optional
1030
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1031
+ :type after_id: str, optional
1032
+ :param x_accept_feature:, defaults to []
1033
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
1034
+ :param async_: Perform the request asynchronously
1035
+ :type async_: bool, optional
1036
+ :rtype: union[list[CatalogListOutput],Page]
985
1037
  """
986
1038
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
987
1039
  kwargs['_return_http_data_only'] = True
@@ -1004,16 +1056,25 @@ class ProjectsApi(object):
1004
1056
 
1005
1057
  This method makes a synchronous HTTP request by default.
1006
1058
 
1007
- :param str search_string: Include only results containing the search string
1008
- :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)
1009
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1010
- :param int limit: The maximum number of entries to return.
1011
- :param int skip: The number of entries to skip.
1012
- :param int page: The page number (i.e. skip limit*page entries)
1013
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1014
- :param list[union[HeaderFeature,str]] x_accept_feature:
1015
- :param bool async_: Perform the request asynchronously
1016
- :return: union[list[CatalogListOutput],Page]
1059
+ :param search_string: Include only results containing the search string
1060
+ :type search_string: str, optional
1061
+ :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)
1062
+ :type filter: str, optional
1063
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1064
+ :type sort: str, optional
1065
+ :param limit: The maximum number of entries to return.
1066
+ :type limit: int, optional
1067
+ :param skip: The number of entries to skip., defaults to 0
1068
+ :type skip: int, optional
1069
+ :param page: The page number (i.e. skip limit*page entries)
1070
+ :type page: int, optional
1071
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1072
+ :type after_id: str, optional
1073
+ :param x_accept_feature:, defaults to []
1074
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
1075
+ :param async_: Perform the request asynchronously
1076
+ :type async_: bool, optional
1077
+ :rtype: union[list[CatalogListOutput],Page]
1017
1078
  """
1018
1079
 
1019
1080
  all_params = ['search_string','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -1090,13 +1151,18 @@ class ProjectsApi(object):
1090
1151
  def delete_project(self, project_id, **kwargs): # noqa: E501
1091
1152
  """Delete a project
1092
1153
 
1093
- Only site admins and users with \"admin\" project permissions may delete a project
1154
+ Delete a project. Only site admins and users with \"admin\" project permissions may delete a project. When background=true, the deletion is performed asynchronously in the background (returns 202). Use GET /{project_id}/delete-status to check the deletion progress. When background=false, the deletion is performed synchronously (returns 200).
1094
1155
  This method makes a synchronous HTTP request by default.
1095
1156
 
1096
- :param str project_id: (required)
1097
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1098
- :param bool async_: Perform the request asynchronously
1099
- :return: DeletedResult
1157
+ :param project_id:
1158
+ :type project_id: str
1159
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1160
+ :type delete_reason: ContainerDeleteReason, optional
1161
+ :param background: Perform deletion in the background, defaults to false
1162
+ :type background: bool, optional
1163
+ :param async_: Perform the request asynchronously
1164
+ :type async_: bool, optional
1165
+ :rtype: DeletedResult
1100
1166
  """
1101
1167
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1102
1168
  kwargs['_return_http_data_only'] = True
@@ -1117,16 +1183,21 @@ class ProjectsApi(object):
1117
1183
  def delete_project_with_http_info(self, project_id, **kwargs): # noqa: E501
1118
1184
  """Delete a project
1119
1185
 
1120
- Only site admins and users with \"admin\" project permissions may delete a project
1186
+ Delete a project. Only site admins and users with \"admin\" project permissions may delete a project. When background=true, the deletion is performed asynchronously in the background (returns 202). Use GET /{project_id}/delete-status to check the deletion progress. When background=false, the deletion is performed synchronously (returns 200).
1121
1187
  This method makes a synchronous HTTP request by default.
1122
1188
 
1123
- :param str project_id: (required)
1124
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1125
- :param bool async_: Perform the request asynchronously
1126
- :return: DeletedResult
1189
+ :param project_id:
1190
+ :type project_id: str
1191
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1192
+ :type delete_reason: ContainerDeleteReason, optional
1193
+ :param background: Perform deletion in the background, defaults to false
1194
+ :type background: bool, optional
1195
+ :param async_: Perform the request asynchronously
1196
+ :type async_: bool, optional
1197
+ :rtype: DeletedResult
1127
1198
  """
1128
1199
 
1129
- all_params = ['project_id','delete_reason',] # noqa: E501
1200
+ all_params = ['project_id','delete_reason','background',] # noqa: E501
1130
1201
  all_params.append('async_')
1131
1202
  all_params.append('_return_http_data_only')
1132
1203
  all_params.append('_preload_content')
@@ -1157,6 +1228,8 @@ class ProjectsApi(object):
1157
1228
  query_params = []
1158
1229
  if 'delete_reason' in params:
1159
1230
  query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
1231
+ if 'background' in params:
1232
+ query_params.append(('background', params['background'])) # noqa: E501
1160
1233
 
1161
1234
  header_params = {}
1162
1235
 
@@ -1194,11 +1267,15 @@ class ProjectsApi(object):
1194
1267
  Delete an analysis for a container.
1195
1268
  This method makes a synchronous HTTP request by default.
1196
1269
 
1197
- :param str cid: (required)
1198
- :param str analysis_id: (required)
1199
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
1200
- :param bool async_: Perform the request asynchronously
1201
- :return: DeletedResult
1270
+ :param cid:
1271
+ :type cid: str
1272
+ :param analysis_id:
1273
+ :type analysis_id: str
1274
+ :param delete_reason: Provide a reason for the deletion
1275
+ :type delete_reason: ContainerDeleteReason, optional
1276
+ :param async_: Perform the request asynchronously
1277
+ :type async_: bool, optional
1278
+ :rtype: DeletedResult
1202
1279
  """
1203
1280
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1204
1281
  kwargs['_return_http_data_only'] = True
@@ -1222,11 +1299,15 @@ class ProjectsApi(object):
1222
1299
  Delete an analysis for a container.
1223
1300
  This method makes a synchronous HTTP request by default.
1224
1301
 
1225
- :param str cid: (required)
1226
- :param str analysis_id: (required)
1227
- :param ContainerDeleteReason delete_reason: Provide a reason for the deletion
1228
- :param bool async_: Perform the request asynchronously
1229
- :return: DeletedResult
1302
+ :param cid:
1303
+ :type cid: str
1304
+ :param analysis_id:
1305
+ :type analysis_id: str
1306
+ :param delete_reason: Provide a reason for the deletion
1307
+ :type delete_reason: ContainerDeleteReason, optional
1308
+ :param async_: Perform the request asynchronously
1309
+ :type async_: bool, optional
1310
+ :rtype: DeletedResult
1230
1311
  """
1231
1312
 
1232
1313
  all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
@@ -1303,11 +1384,15 @@ class ProjectsApi(object):
1303
1384
  Remove a note from a(n) project analysis.
1304
1385
  This method makes a synchronous HTTP request by default.
1305
1386
 
1306
- :param str cid: 24-char hex id (required)
1307
- :param str analysis_id: 24-char hex analysis id (required)
1308
- :param str note_id: 24-char hex note id (required)
1309
- :param bool async_: Perform the request asynchronously
1310
- :return: DeletedResult
1387
+ :param cid: 24-char hex id
1388
+ :type cid: str
1389
+ :param analysis_id: 24-char hex analysis id
1390
+ :type analysis_id: str
1391
+ :param note_id: 24-char hex note id
1392
+ :type note_id: str
1393
+ :param async_: Perform the request asynchronously
1394
+ :type async_: bool, optional
1395
+ :rtype: DeletedResult
1311
1396
  """
1312
1397
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1313
1398
  kwargs['_return_http_data_only'] = True
@@ -1331,11 +1416,15 @@ class ProjectsApi(object):
1331
1416
  Remove a note from a(n) project analysis.
1332
1417
  This method makes a synchronous HTTP request by default.
1333
1418
 
1334
- :param str cid: 24-char hex id (required)
1335
- :param str analysis_id: 24-char hex analysis id (required)
1336
- :param str note_id: 24-char hex note id (required)
1337
- :param bool async_: Perform the request asynchronously
1338
- :return: DeletedResult
1419
+ :param cid: 24-char hex id
1420
+ :type cid: str
1421
+ :param analysis_id: 24-char hex analysis id
1422
+ :type analysis_id: str
1423
+ :param note_id: 24-char hex note id
1424
+ :type note_id: str
1425
+ :param async_: Perform the request asynchronously
1426
+ :type async_: bool, optional
1427
+ :rtype: DeletedResult
1339
1428
  """
1340
1429
 
1341
1430
  all_params = ['cid','analysis_id','note_id',] # noqa: E501
@@ -1416,12 +1505,17 @@ class ProjectsApi(object):
1416
1505
  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.
1417
1506
  This method makes a synchronous HTTP request by default.
1418
1507
 
1419
- :param str cid: (required)
1420
- :param str filename: (required)
1421
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1422
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1423
- :param bool async_: Perform the request asynchronously
1424
- :return: DeletedResult
1508
+ :param cid:
1509
+ :type cid: str
1510
+ :param filename:
1511
+ :type filename: str
1512
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1513
+ :type delete_reason: ContainerDeleteReason, optional
1514
+ :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1515
+ :type force: bool, optional
1516
+ :param async_: Perform the request asynchronously
1517
+ :type async_: bool, optional
1518
+ :rtype: DeletedResult
1425
1519
  """
1426
1520
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1427
1521
  kwargs['_return_http_data_only'] = True
@@ -1445,12 +1539,17 @@ class ProjectsApi(object):
1445
1539
  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.
1446
1540
  This method makes a synchronous HTTP request by default.
1447
1541
 
1448
- :param str cid: (required)
1449
- :param str filename: (required)
1450
- :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
1451
- :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
1452
- :param bool async_: Perform the request asynchronously
1453
- :return: DeletedResult
1542
+ :param cid:
1543
+ :type cid: str
1544
+ :param filename:
1545
+ :type filename: str
1546
+ :param delete_reason: A reason for deletion when audit-trail is enabled
1547
+ :type delete_reason: ContainerDeleteReason, optional
1548
+ :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
1549
+ :type force: bool, optional
1550
+ :param async_: Perform the request asynchronously
1551
+ :type async_: bool, optional
1552
+ :rtype: DeletedResult
1454
1553
  """
1455
1554
 
1456
1555
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -1529,10 +1628,13 @@ class ProjectsApi(object):
1529
1628
  Remove a note from a(n) project
1530
1629
  This method makes a synchronous HTTP request by default.
1531
1630
 
1532
- :param str cid: (required)
1533
- :param str note_id: (required)
1534
- :param bool async_: Perform the request asynchronously
1535
- :return: DeletedResult
1631
+ :param cid:
1632
+ :type cid: str
1633
+ :param note_id:
1634
+ :type note_id: str
1635
+ :param async_: Perform the request asynchronously
1636
+ :type async_: bool, optional
1637
+ :rtype: DeletedResult
1536
1638
  """
1537
1639
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1538
1640
  kwargs['_return_http_data_only'] = True
@@ -1556,10 +1658,13 @@ class ProjectsApi(object):
1556
1658
  Remove a note from a(n) project
1557
1659
  This method makes a synchronous HTTP request by default.
1558
1660
 
1559
- :param str cid: (required)
1560
- :param str note_id: (required)
1561
- :param bool async_: Perform the request asynchronously
1562
- :return: DeletedResult
1661
+ :param cid:
1662
+ :type cid: str
1663
+ :param note_id:
1664
+ :type note_id: str
1665
+ :param async_: Perform the request asynchronously
1666
+ :type async_: bool, optional
1667
+ :rtype: DeletedResult
1563
1668
  """
1564
1669
 
1565
1670
  all_params = ['cid','note_id',] # noqa: E501
@@ -1634,10 +1739,13 @@ class ProjectsApi(object):
1634
1739
  Delete a tag
1635
1740
  This method makes a synchronous HTTP request by default.
1636
1741
 
1637
- :param str cid: (required)
1638
- :param str value: The tag to interact with (required)
1639
- :param bool async_: Perform the request asynchronously
1640
- :return: DeletedResult
1742
+ :param cid:
1743
+ :type cid: str
1744
+ :param value: The tag to interact with
1745
+ :type value: str
1746
+ :param async_: Perform the request asynchronously
1747
+ :type async_: bool, optional
1748
+ :rtype: DeletedResult
1641
1749
  """
1642
1750
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1643
1751
  kwargs['_return_http_data_only'] = True
@@ -1661,10 +1769,13 @@ class ProjectsApi(object):
1661
1769
  Delete a tag
1662
1770
  This method makes a synchronous HTTP request by default.
1663
1771
 
1664
- :param str cid: (required)
1665
- :param str value: The tag to interact with (required)
1666
- :param bool async_: Perform the request asynchronously
1667
- :return: DeletedResult
1772
+ :param cid:
1773
+ :type cid: str
1774
+ :param value: The tag to interact with
1775
+ :type value: str
1776
+ :param async_: Perform the request asynchronously
1777
+ :type async_: bool, optional
1778
+ :rtype: DeletedResult
1668
1779
  """
1669
1780
 
1670
1781
  all_params = ['cid','value',] # noqa: E501
@@ -1739,10 +1850,13 @@ class ProjectsApi(object):
1739
1850
  Delete multiple tags from a(n) project
1740
1851
  This method makes a synchronous HTTP request by default.
1741
1852
 
1742
- :param str cid: (required)
1743
- :param list[str] body: (required)
1744
- :param bool async_: Perform the request asynchronously
1745
- :return: None
1853
+ :param cid:
1854
+ :type cid: str
1855
+ :param body:
1856
+ :type body: list[str]
1857
+ :param async_: Perform the request asynchronously
1858
+ :type async_: bool, optional
1859
+ :rtype: None
1746
1860
  """
1747
1861
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1748
1862
  kwargs['_return_http_data_only'] = True
@@ -1766,10 +1880,13 @@ class ProjectsApi(object):
1766
1880
  Delete multiple tags from a(n) project
1767
1881
  This method makes a synchronous HTTP request by default.
1768
1882
 
1769
- :param str cid: (required)
1770
- :param list[str] body: (required)
1771
- :param bool async_: Perform the request asynchronously
1772
- :return: None
1883
+ :param cid:
1884
+ :type cid: str
1885
+ :param body:
1886
+ :type body: list[str]
1887
+ :param async_: Perform the request asynchronously
1888
+ :type async_: bool, optional
1889
+ :rtype: None
1773
1890
  """
1774
1891
 
1775
1892
  all_params = ['cid','body',] # noqa: E501
@@ -1847,11 +1964,15 @@ class ProjectsApi(object):
1847
1964
 
1848
1965
  This method makes a synchronous HTTP request by default.
1849
1966
 
1850
- :param str project_id: (required)
1851
- :param str uid: (required)
1852
- :param list[union[HeaderFeature,str]] x_accept_feature:
1853
- :param bool async_: Perform the request asynchronously
1854
- :return: ModifiedResult
1967
+ :param project_id:
1968
+ :type project_id: str
1969
+ :param uid:
1970
+ :type uid: str
1971
+ :param x_accept_feature:, defaults to []
1972
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
1973
+ :param async_: Perform the request asynchronously
1974
+ :type async_: bool, optional
1975
+ :rtype: ModifiedResult
1855
1976
  """
1856
1977
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1857
1978
  kwargs['_return_http_data_only'] = True
@@ -1874,11 +1995,15 @@ class ProjectsApi(object):
1874
1995
 
1875
1996
  This method makes a synchronous HTTP request by default.
1876
1997
 
1877
- :param str project_id: (required)
1878
- :param str uid: (required)
1879
- :param list[union[HeaderFeature,str]] x_accept_feature:
1880
- :param bool async_: Perform the request asynchronously
1881
- :return: ModifiedResult
1998
+ :param project_id:
1999
+ :type project_id: str
2000
+ :param uid:
2001
+ :type uid: str
2002
+ :param x_accept_feature:, defaults to []
2003
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
2004
+ :param async_: Perform the request asynchronously
2005
+ :type async_: bool, optional
2006
+ :rtype: ModifiedResult
1882
2007
  """
1883
2008
 
1884
2009
  all_params = ['project_id','uid','x_accept_feature',] # noqa: E501
@@ -1956,10 +2081,13 @@ class ProjectsApi(object):
1956
2081
  Delete multiple projects by ID list
1957
2082
  This method makes a synchronous HTTP request by default.
1958
2083
 
1959
- :param list[str] body: List of IDs to delete (required)
1960
- :param ContainerDeleteReason delete_reason:
1961
- :param bool async_: Perform the request asynchronously
1962
- :return: DeletedResult
2084
+ :param body: List of IDs to delete
2085
+ :type body: list[str]
2086
+ :param delete_reason:
2087
+ :type delete_reason: ContainerDeleteReason, optional
2088
+ :param async_: Perform the request asynchronously
2089
+ :type async_: bool, optional
2090
+ :rtype: DeletedResult
1963
2091
  """
1964
2092
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1965
2093
  kwargs['_return_http_data_only'] = True
@@ -1983,10 +2111,13 @@ class ProjectsApi(object):
1983
2111
  Delete multiple projects by ID list
1984
2112
  This method makes a synchronous HTTP request by default.
1985
2113
 
1986
- :param list[str] body: List of IDs to delete (required)
1987
- :param ContainerDeleteReason delete_reason:
1988
- :param bool async_: Perform the request asynchronously
1989
- :return: DeletedResult
2114
+ :param body: List of IDs to delete
2115
+ :type body: list[str]
2116
+ :param delete_reason:
2117
+ :type delete_reason: ContainerDeleteReason, optional
2118
+ :param async_: Perform the request asynchronously
2119
+ :type async_: bool, optional
2120
+ :rtype: DeletedResult
1990
2121
  """
1991
2122
 
1992
2123
  all_params = ['body','delete_reason',] # noqa: E501
@@ -2061,18 +2192,29 @@ class ProjectsApi(object):
2061
2192
  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.
2062
2193
  This method makes a synchronous HTTP request by default.
2063
2194
 
2064
- :param str project_id: 24-character hex ID (required)
2065
- :param str file_name: output file name (required)
2066
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2067
- :param str member: The filename of a zipfile member to download rather than the entire file
2068
- :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\"
2069
- :param int version: version of the file to download
2070
- :param str hash: file hash for comparison
2071
- :param str range: byte ranges to return
2072
- :param list[str] x_accept_feature: redirect header
2073
- :param str dest_file: Destination file path
2074
- :param bool async_: Perform the request asynchronously
2075
- :return: union[DownloadTicketStub,ZipfileInfo]
2195
+ :param project_id: 24-character hex ID
2196
+ :type project_id: str
2197
+ :param file_name: output file name
2198
+ :type file_name: str
2199
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2200
+ :type info: bool, optional
2201
+ :param member: The filename of a zipfile member to download rather than the entire file
2202
+ :type member: str, optional
2203
+ :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
2204
+ :type view: bool, optional
2205
+ :param version: version of the file to download
2206
+ :type version: int, optional
2207
+ :param hash: file hash for comparison
2208
+ :type hash: str, optional
2209
+ :param range: byte ranges to return
2210
+ :type range: str, optional
2211
+ :param x_accept_feature: redirect header, defaults to []
2212
+ :type x_accept_feature: list[str], optional
2213
+ :param dest_file: Destination file path
2214
+ :type dest_file: str
2215
+ :param async_: Perform the request asynchronously
2216
+ :type async_: bool, optional
2217
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2076
2218
  """
2077
2219
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2078
2220
  kwargs['_return_http_data_only'] = True
@@ -2095,17 +2237,27 @@ class ProjectsApi(object):
2095
2237
  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.
2096
2238
  This method makes a synchronous HTTP request by default.
2097
2239
 
2098
- :param str project_id: 24-character hex ID (required)
2099
- :param str file_name: output file name (required)
2100
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2101
- :param str member: The filename of a zipfile member to download rather than the entire file
2102
- :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\"
2103
- :param int version: version of the file to download
2104
- :param str hash: file hash for comparison
2105
- :param str range: byte ranges to return
2106
- :param list[str] x_accept_feature: redirect header
2107
- :param bool async_: Perform the request asynchronously
2108
- :return: union[DownloadTicketStub,ZipfileInfo]
2240
+ :param project_id: 24-character hex ID
2241
+ :type project_id: str
2242
+ :param file_name: output file name
2243
+ :type file_name: str
2244
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2245
+ :type info: bool, optional
2246
+ :param member: The filename of a zipfile member to download rather than the entire file
2247
+ :type member: str, optional
2248
+ :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
2249
+ :type view: bool, optional
2250
+ :param version: version of the file to download
2251
+ :type version: int, optional
2252
+ :param hash: file hash for comparison
2253
+ :type hash: str, optional
2254
+ :param range: byte ranges to return
2255
+ :type range: str, optional
2256
+ :param x_accept_feature: redirect header, defaults to []
2257
+ :type x_accept_feature: list[str], optional
2258
+ :param async_: Perform the request asynchronously
2259
+ :type async_: bool, optional
2260
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2109
2261
  """
2110
2262
 
2111
2263
  all_params = ['project_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2195,18 +2347,29 @@ class ProjectsApi(object):
2195
2347
  Does not work on files whose names contain a forward slash.
2196
2348
  This method makes a synchronous HTTP request by default.
2197
2349
 
2198
- :param str project_id: 24-character hex ID (required)
2199
- :param str file_name: output file name (required)
2200
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2201
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2202
- :param str member: The filename of a zipfile member to download rather than the entire file
2203
- :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\"
2204
- :param int version: version of the file to download
2205
- :param str hash: file hash for comparison
2206
- :param str range: byte ranges to return
2207
- :param list[str] x_accept_feature: redirect header
2208
- :param bool async_: Perform the request asynchronously
2209
- :return: FileZipInfo
2350
+ :param project_id: 24-character hex ID
2351
+ :type project_id: str
2352
+ :param file_name: output file name
2353
+ :type file_name: str
2354
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2355
+ :type ticket: str, optional
2356
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2357
+ :type info: bool, optional
2358
+ :param member: The filename of a zipfile member to download rather than the entire file
2359
+ :type member: str, optional
2360
+ :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
2361
+ :type view: bool, optional
2362
+ :param version: version of the file to download
2363
+ :type version: int, optional
2364
+ :param hash: file hash for comparison
2365
+ :type hash: str, optional
2366
+ :param range: byte ranges to return
2367
+ :type range: str, optional
2368
+ :param x_accept_feature: redirect header, defaults to []
2369
+ :type x_accept_feature: list[str], optional
2370
+ :param async_: Perform the request asynchronously
2371
+ :type async_: bool, optional
2372
+ :rtype: FileZipInfo
2210
2373
  """
2211
2374
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2212
2375
  kwargs['_return_http_data_only'] = True
@@ -2230,18 +2393,29 @@ class ProjectsApi(object):
2230
2393
  Does not work on files whose names contain a forward slash.
2231
2394
  This method makes a synchronous HTTP request by default.
2232
2395
 
2233
- :param str project_id: 24-character hex ID (required)
2234
- :param str file_name: output file name (required)
2235
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2236
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2237
- :param str member: The filename of a zipfile member to download rather than the entire file
2238
- :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\"
2239
- :param int version: version of the file to download
2240
- :param str hash: file hash for comparison
2241
- :param str range: byte ranges to return
2242
- :param list[str] x_accept_feature: redirect header
2243
- :param bool async_: Perform the request asynchronously
2244
- :return: FileZipInfo
2396
+ :param project_id: 24-character hex ID
2397
+ :type project_id: str
2398
+ :param file_name: output file name
2399
+ :type file_name: str
2400
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2401
+ :type ticket: str, optional
2402
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2403
+ :type info: bool, optional
2404
+ :param member: The filename of a zipfile member to download rather than the entire file
2405
+ :type member: str, optional
2406
+ :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
2407
+ :type view: bool, optional
2408
+ :param version: version of the file to download
2409
+ :type version: int, optional
2410
+ :param hash: file hash for comparison
2411
+ :type hash: str, optional
2412
+ :param range: byte ranges to return
2413
+ :type range: str, optional
2414
+ :param x_accept_feature: redirect header, defaults to []
2415
+ :type x_accept_feature: list[str], optional
2416
+ :param async_: Perform the request asynchronously
2417
+ :type async_: bool, optional
2418
+ :rtype: FileZipInfo
2245
2419
  """
2246
2420
 
2247
2421
  all_params = ['project_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2334,18 +2508,29 @@ class ProjectsApi(object):
2334
2508
 
2335
2509
  This method makes a synchronous HTTP request by default.
2336
2510
 
2337
- :param str project_id: 24-character hex ID (required)
2338
- :param str file_name: output file name (required)
2339
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2340
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2341
- :param str member: The filename of a zipfile member to download rather than the entire file
2342
- :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\"
2343
- :param int version: version of the file to download
2344
- :param str hash: file hash for comparison
2345
- :param str range: byte ranges to return
2346
- :param list[str] x_accept_feature: redirect header
2347
- :param bool async_: Perform the request asynchronously
2348
- :return: union[DownloadTicketStub,ZipfileInfo]
2511
+ :param project_id: 24-character hex ID
2512
+ :type project_id: str
2513
+ :param file_name: output file name
2514
+ :type file_name: str
2515
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2516
+ :type ticket: str, optional
2517
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2518
+ :type info: bool, optional
2519
+ :param member: The filename of a zipfile member to download rather than the entire file
2520
+ :type member: str, optional
2521
+ :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
2522
+ :type view: bool, optional
2523
+ :param version: version of the file to download
2524
+ :type version: int, optional
2525
+ :param hash: file hash for comparison
2526
+ :type hash: str, optional
2527
+ :param range: byte ranges to return
2528
+ :type range: str, optional
2529
+ :param x_accept_feature: redirect header, defaults to []
2530
+ :type x_accept_feature: list[str], optional
2531
+ :param async_: Perform the request asynchronously
2532
+ :type async_: bool, optional
2533
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2349
2534
  """
2350
2535
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2351
2536
  kwargs['_return_http_data_only'] = True
@@ -2368,18 +2553,29 @@ class ProjectsApi(object):
2368
2553
 
2369
2554
  This method makes a synchronous HTTP request by default.
2370
2555
 
2371
- :param str project_id: 24-character hex ID (required)
2372
- :param str file_name: output file name (required)
2373
- :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2374
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2375
- :param str member: The filename of a zipfile member to download rather than the entire file
2376
- :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\"
2377
- :param int version: version of the file to download
2378
- :param str hash: file hash for comparison
2379
- :param str range: byte ranges to return
2380
- :param list[str] x_accept_feature: redirect header
2381
- :param bool async_: Perform the request asynchronously
2382
- :return: union[DownloadTicketStub,ZipfileInfo]
2556
+ :param project_id: 24-character hex ID
2557
+ :type project_id: str
2558
+ :param file_name: output file name
2559
+ :type file_name: str
2560
+ :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
2561
+ :type ticket: str, optional
2562
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
2563
+ :type info: bool, optional
2564
+ :param member: The filename of a zipfile member to download rather than the entire file
2565
+ :type member: str, optional
2566
+ :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
2567
+ :type view: bool, optional
2568
+ :param version: version of the file to download
2569
+ :type version: int, optional
2570
+ :param hash: file hash for comparison
2571
+ :type hash: str, optional
2572
+ :param range: byte ranges to return
2573
+ :type range: str, optional
2574
+ :param x_accept_feature: redirect header, defaults to []
2575
+ :type x_accept_feature: list[str], optional
2576
+ :param async_: Perform the request asynchronously
2577
+ :type async_: bool, optional
2578
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2383
2579
  """
2384
2580
 
2385
2581
  all_params = ['project_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -2471,17 +2667,27 @@ class ProjectsApi(object):
2471
2667
  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.
2472
2668
  This method makes a synchronous HTTP request by default.
2473
2669
 
2474
- :param str project_id: 24-character hex ID (required)
2475
- :param str analysis_id: 24-char hex analysis id (required)
2476
- :param str filename: filename to download (get tar of all if empty) (required)
2477
- :param bool info: get file info only
2478
- :param str member: get zipfile member
2479
- :param bool view: feature flag for view/download
2480
- :param str range: byte ranges to return
2481
- :param list[str] x_accept_feature: redirect header
2482
- :param str dest_file: Destination file path
2483
- :param bool async_: Perform the request asynchronously
2484
- :return: union[DownloadTicketStub,ZipfileInfo]
2670
+ :param project_id: 24-character hex ID
2671
+ :type project_id: str
2672
+ :param analysis_id: 24-char hex analysis id
2673
+ :type analysis_id: str
2674
+ :param filename: filename to download (get tar of all if empty)
2675
+ :type filename: str
2676
+ :param info: get file info only, defaults to false
2677
+ :type info: bool, optional
2678
+ :param member: get zipfile member
2679
+ :type member: str, optional
2680
+ :param view: feature flag for view/download, defaults to false
2681
+ :type view: bool, optional
2682
+ :param range: byte ranges to return
2683
+ :type range: str, optional
2684
+ :param x_accept_feature: redirect header, defaults to []
2685
+ :type x_accept_feature: list[str], optional
2686
+ :param dest_file: Destination file path
2687
+ :type dest_file: str
2688
+ :param async_: Perform the request asynchronously
2689
+ :type async_: bool, optional
2690
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2485
2691
  """
2486
2692
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2487
2693
  kwargs['_return_http_data_only'] = True
@@ -2504,16 +2710,25 @@ class ProjectsApi(object):
2504
2710
  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.
2505
2711
  This method makes a synchronous HTTP request by default.
2506
2712
 
2507
- :param str project_id: 24-character hex ID (required)
2508
- :param str analysis_id: 24-char hex analysis id (required)
2509
- :param str filename: filename to download (get tar of all if empty) (required)
2510
- :param bool info: get file info only
2511
- :param str member: get zipfile member
2512
- :param bool view: feature flag for view/download
2513
- :param str range: byte ranges to return
2514
- :param list[str] x_accept_feature: redirect header
2515
- :param bool async_: Perform the request asynchronously
2516
- :return: union[DownloadTicketStub,ZipfileInfo]
2713
+ :param project_id: 24-character hex ID
2714
+ :type project_id: str
2715
+ :param analysis_id: 24-char hex analysis id
2716
+ :type analysis_id: str
2717
+ :param filename: filename to download (get tar of all if empty)
2718
+ :type filename: str
2719
+ :param info: get file info only, defaults to false
2720
+ :type info: bool, optional
2721
+ :param member: get zipfile member
2722
+ :type member: str, optional
2723
+ :param view: feature flag for view/download, defaults to false
2724
+ :type view: bool, optional
2725
+ :param range: byte ranges to return
2726
+ :type range: str, optional
2727
+ :param x_accept_feature: redirect header, defaults to []
2728
+ :type x_accept_feature: list[str], optional
2729
+ :param async_: Perform the request asynchronously
2730
+ :type async_: bool, optional
2731
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2517
2732
  """
2518
2733
 
2519
2734
  all_params = ['project_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2605,17 +2820,27 @@ class ProjectsApi(object):
2605
2820
  Does not work on files whose names contain a forward slash.
2606
2821
  This method makes a synchronous HTTP request by default.
2607
2822
 
2608
- :param str project_id: 24-character hex ID (required)
2609
- :param str analysis_id: 24-char hex analysis id (required)
2610
- :param str filename: filename to download (get tar of all if empty) (required)
2611
- :param str ticket: 24-char hex ticket id
2612
- :param bool info: get file info only
2613
- :param str member: get zipfile member
2614
- :param bool view: feature flag for view/download
2615
- :param str range: byte ranges to return
2616
- :param list[str] x_accept_feature: redirect header
2617
- :param bool async_: Perform the request asynchronously
2618
- :return: FileZipInfo
2823
+ :param project_id: 24-character hex ID
2824
+ :type project_id: str
2825
+ :param analysis_id: 24-char hex analysis id
2826
+ :type analysis_id: str
2827
+ :param filename: filename to download (get tar of all if empty)
2828
+ :type filename: str
2829
+ :param ticket: 24-char hex ticket id
2830
+ :type ticket: str, optional
2831
+ :param info: get file info only, defaults to false
2832
+ :type info: bool, optional
2833
+ :param member: get zipfile member
2834
+ :type member: str, optional
2835
+ :param view: feature flag for view/download, defaults to false
2836
+ :type view: bool, optional
2837
+ :param range: byte ranges to return
2838
+ :type range: str, optional
2839
+ :param x_accept_feature: redirect header, defaults to []
2840
+ :type x_accept_feature: list[str], optional
2841
+ :param async_: Perform the request asynchronously
2842
+ :type async_: bool, optional
2843
+ :rtype: FileZipInfo
2619
2844
  """
2620
2845
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2621
2846
  kwargs['_return_http_data_only'] = True
@@ -2639,17 +2864,27 @@ class ProjectsApi(object):
2639
2864
  Does not work on files whose names contain a forward slash.
2640
2865
  This method makes a synchronous HTTP request by default.
2641
2866
 
2642
- :param str project_id: 24-character hex ID (required)
2643
- :param str analysis_id: 24-char hex analysis id (required)
2644
- :param str filename: filename to download (get tar of all if empty) (required)
2645
- :param str ticket: 24-char hex ticket id
2646
- :param bool info: get file info only
2647
- :param str member: get zipfile member
2648
- :param bool view: feature flag for view/download
2649
- :param str range: byte ranges to return
2650
- :param list[str] x_accept_feature: redirect header
2651
- :param bool async_: Perform the request asynchronously
2652
- :return: FileZipInfo
2867
+ :param project_id: 24-character hex ID
2868
+ :type project_id: str
2869
+ :param analysis_id: 24-char hex analysis id
2870
+ :type analysis_id: str
2871
+ :param filename: filename to download (get tar of all if empty)
2872
+ :type filename: str
2873
+ :param ticket: 24-char hex ticket id
2874
+ :type ticket: str, optional
2875
+ :param info: get file info only, defaults to false
2876
+ :type info: bool, optional
2877
+ :param member: get zipfile member
2878
+ :type member: str, optional
2879
+ :param view: feature flag for view/download, defaults to false
2880
+ :type view: bool, optional
2881
+ :param range: byte ranges to return
2882
+ :type range: str, optional
2883
+ :param x_accept_feature: redirect header, defaults to []
2884
+ :type x_accept_feature: list[str], optional
2885
+ :param async_: Perform the request asynchronously
2886
+ :type async_: bool, optional
2887
+ :rtype: FileZipInfo
2653
2888
  """
2654
2889
 
2655
2890
  all_params = ['project_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2744,17 +2979,27 @@ class ProjectsApi(object):
2744
2979
 
2745
2980
  This method makes a synchronous HTTP request by default.
2746
2981
 
2747
- :param str project_id: 24-character hex ID (required)
2748
- :param str analysis_id: 24-char hex analysis id (required)
2749
- :param str filename: filename to download (get tar of all if empty) (required)
2750
- :param str ticket: 24-char hex ticket id
2751
- :param bool info: get file info only
2752
- :param str member: get zipfile member
2753
- :param bool view: feature flag for view/download
2754
- :param str range: byte ranges to return
2755
- :param list[str] x_accept_feature: redirect header
2756
- :param bool async_: Perform the request asynchronously
2757
- :return: union[DownloadTicketStub,ZipfileInfo]
2982
+ :param project_id: 24-character hex ID
2983
+ :type project_id: str
2984
+ :param analysis_id: 24-char hex analysis id
2985
+ :type analysis_id: str
2986
+ :param filename: filename to download (get tar of all if empty)
2987
+ :type filename: str
2988
+ :param ticket: 24-char hex ticket id
2989
+ :type ticket: str, optional
2990
+ :param info: get file info only, defaults to false
2991
+ :type info: bool, optional
2992
+ :param member: get zipfile member
2993
+ :type member: str, optional
2994
+ :param view: feature flag for view/download, defaults to false
2995
+ :type view: bool, optional
2996
+ :param range: byte ranges to return
2997
+ :type range: str, optional
2998
+ :param x_accept_feature: redirect header, defaults to []
2999
+ :type x_accept_feature: list[str], optional
3000
+ :param async_: Perform the request asynchronously
3001
+ :type async_: bool, optional
3002
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2758
3003
  """
2759
3004
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2760
3005
  kwargs['_return_http_data_only'] = True
@@ -2777,17 +3022,27 @@ class ProjectsApi(object):
2777
3022
 
2778
3023
  This method makes a synchronous HTTP request by default.
2779
3024
 
2780
- :param str project_id: 24-character hex ID (required)
2781
- :param str analysis_id: 24-char hex analysis id (required)
2782
- :param str filename: filename to download (get tar of all if empty) (required)
2783
- :param str ticket: 24-char hex ticket id
2784
- :param bool info: get file info only
2785
- :param str member: get zipfile member
2786
- :param bool view: feature flag for view/download
2787
- :param str range: byte ranges to return
2788
- :param list[str] x_accept_feature: redirect header
2789
- :param bool async_: Perform the request asynchronously
2790
- :return: union[DownloadTicketStub,ZipfileInfo]
3025
+ :param project_id: 24-character hex ID
3026
+ :type project_id: str
3027
+ :param analysis_id: 24-char hex analysis id
3028
+ :type analysis_id: str
3029
+ :param filename: filename to download (get tar of all if empty)
3030
+ :type filename: str
3031
+ :param ticket: 24-char hex ticket id
3032
+ :type ticket: str, optional
3033
+ :param info: get file info only, defaults to false
3034
+ :type info: bool, optional
3035
+ :param member: get zipfile member
3036
+ :type member: str, optional
3037
+ :param view: feature flag for view/download, defaults to false
3038
+ :type view: bool, optional
3039
+ :param range: byte ranges to return
3040
+ :type range: str, optional
3041
+ :param x_accept_feature: redirect header, defaults to []
3042
+ :type x_accept_feature: list[str], optional
3043
+ :param async_: Perform the request asynchronously
3044
+ :type async_: bool, optional
3045
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2791
3046
  """
2792
3047
 
2793
3048
  all_params = ['project_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -2881,17 +3136,27 @@ class ProjectsApi(object):
2881
3136
  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.
2882
3137
  This method makes a synchronous HTTP request by default.
2883
3138
 
2884
- :param str project_id: 24-character hex ID (required)
2885
- :param str analysis_id: 24-char hex analysis id (required)
2886
- :param str filename: filename to download (get tar of all if empty) (required)
2887
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2888
- :param str member: The filename of a zipfile member to download rather than the entire file
2889
- :param bool view: feature flag for view/download
2890
- :param str range: byte ranges to return
2891
- :param list[str] x_accept_feature: redirect header
2892
- :param str dest_file: Destination file path
2893
- :param bool async_: Perform the request asynchronously
2894
- :return: union[DownloadTicketStub,ZipfileInfo]
3139
+ :param project_id: 24-character hex ID
3140
+ :type project_id: str
3141
+ :param analysis_id: 24-char hex analysis id
3142
+ :type analysis_id: str
3143
+ :param filename: filename to download (get tar of all if empty)
3144
+ :type filename: str
3145
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3146
+ :type info: bool, optional
3147
+ :param member: The filename of a zipfile member to download rather than the entire file
3148
+ :type member: str, optional
3149
+ :param view: feature flag for view/download, defaults to false
3150
+ :type view: bool, optional
3151
+ :param range: byte ranges to return
3152
+ :type range: str, optional
3153
+ :param x_accept_feature: redirect header, defaults to []
3154
+ :type x_accept_feature: list[str], optional
3155
+ :param dest_file: Destination file path
3156
+ :type dest_file: str
3157
+ :param async_: Perform the request asynchronously
3158
+ :type async_: bool, optional
3159
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2895
3160
  """
2896
3161
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2897
3162
  kwargs['_return_http_data_only'] = True
@@ -2914,16 +3179,25 @@ class ProjectsApi(object):
2914
3179
  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.
2915
3180
  This method makes a synchronous HTTP request by default.
2916
3181
 
2917
- :param str project_id: 24-character hex ID (required)
2918
- :param str analysis_id: 24-char hex analysis id (required)
2919
- :param str filename: filename to download (get tar of all if empty) (required)
2920
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
2921
- :param str member: The filename of a zipfile member to download rather than the entire file
2922
- :param bool view: feature flag for view/download
2923
- :param str range: byte ranges to return
2924
- :param list[str] x_accept_feature: redirect header
2925
- :param bool async_: Perform the request asynchronously
2926
- :return: union[DownloadTicketStub,ZipfileInfo]
3182
+ :param project_id: 24-character hex ID
3183
+ :type project_id: str
3184
+ :param analysis_id: 24-char hex analysis id
3185
+ :type analysis_id: str
3186
+ :param filename: filename to download (get tar of all if empty)
3187
+ :type filename: str
3188
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3189
+ :type info: bool, optional
3190
+ :param member: The filename of a zipfile member to download rather than the entire file
3191
+ :type member: str, optional
3192
+ :param view: feature flag for view/download, defaults to false
3193
+ :type view: bool, optional
3194
+ :param range: byte ranges to return
3195
+ :type range: str, optional
3196
+ :param x_accept_feature: redirect header, defaults to []
3197
+ :type x_accept_feature: list[str], optional
3198
+ :param async_: Perform the request asynchronously
3199
+ :type async_: bool, optional
3200
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
2927
3201
  """
2928
3202
 
2929
3203
  all_params = ['project_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -3015,17 +3289,27 @@ class ProjectsApi(object):
3015
3289
  Does not work on files whose names contain a forward slash.
3016
3290
  This method makes a synchronous HTTP request by default.
3017
3291
 
3018
- :param str project_id: 24-character hex ID (required)
3019
- :param str analysis_id: 24-char hex analysis id (required)
3020
- :param str filename: filename to download (get tar of all if empty) (required)
3021
- :param str ticket: ticket id of the outputs to download
3022
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
3023
- :param str member: The filename of a zipfile member to download rather than the entire file
3024
- :param bool view: feature flag for view/download
3025
- :param str range: byte ranges to return
3026
- :param list[str] x_accept_feature: redirect header
3027
- :param bool async_: Perform the request asynchronously
3028
- :return: FileZipInfo
3292
+ :param project_id: 24-character hex ID
3293
+ :type project_id: str
3294
+ :param analysis_id: 24-char hex analysis id
3295
+ :type analysis_id: str
3296
+ :param filename: filename to download (get tar of all if empty)
3297
+ :type filename: str
3298
+ :param ticket: ticket id of the outputs to download
3299
+ :type ticket: str, optional
3300
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3301
+ :type info: bool, optional
3302
+ :param member: The filename of a zipfile member to download rather than the entire file
3303
+ :type member: str, optional
3304
+ :param view: feature flag for view/download, defaults to false
3305
+ :type view: bool, optional
3306
+ :param range: byte ranges to return
3307
+ :type range: str, optional
3308
+ :param x_accept_feature: redirect header, defaults to []
3309
+ :type x_accept_feature: list[str], optional
3310
+ :param async_: Perform the request asynchronously
3311
+ :type async_: bool, optional
3312
+ :rtype: FileZipInfo
3029
3313
  """
3030
3314
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3031
3315
  kwargs['_return_http_data_only'] = True
@@ -3049,17 +3333,27 @@ class ProjectsApi(object):
3049
3333
  Does not work on files whose names contain a forward slash.
3050
3334
  This method makes a synchronous HTTP request by default.
3051
3335
 
3052
- :param str project_id: 24-character hex ID (required)
3053
- :param str analysis_id: 24-char hex analysis id (required)
3054
- :param str filename: filename to download (get tar of all if empty) (required)
3055
- :param str ticket: ticket id of the outputs to download
3056
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
3057
- :param str member: The filename of a zipfile member to download rather than the entire file
3058
- :param bool view: feature flag for view/download
3059
- :param str range: byte ranges to return
3060
- :param list[str] x_accept_feature: redirect header
3061
- :param bool async_: Perform the request asynchronously
3062
- :return: FileZipInfo
3336
+ :param project_id: 24-character hex ID
3337
+ :type project_id: str
3338
+ :param analysis_id: 24-char hex analysis id
3339
+ :type analysis_id: str
3340
+ :param filename: filename to download (get tar of all if empty)
3341
+ :type filename: str
3342
+ :param ticket: ticket id of the outputs to download
3343
+ :type ticket: str, optional
3344
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3345
+ :type info: bool, optional
3346
+ :param member: The filename of a zipfile member to download rather than the entire file
3347
+ :type member: str, optional
3348
+ :param view: feature flag for view/download, defaults to false
3349
+ :type view: bool, optional
3350
+ :param range: byte ranges to return
3351
+ :type range: str, optional
3352
+ :param x_accept_feature: redirect header, defaults to []
3353
+ :type x_accept_feature: list[str], optional
3354
+ :param async_: Perform the request asynchronously
3355
+ :type async_: bool, optional
3356
+ :rtype: FileZipInfo
3063
3357
  """
3064
3358
 
3065
3359
  all_params = ['project_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -3154,17 +3448,27 @@ class ProjectsApi(object):
3154
3448
 
3155
3449
  This method makes a synchronous HTTP request by default.
3156
3450
 
3157
- :param str project_id: 24-character hex ID (required)
3158
- :param str analysis_id: 24-char hex analysis id (required)
3159
- :param str filename: filename to download (get tar of all if empty) (required)
3160
- :param str ticket: ticket id of the outputs to download
3161
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
3162
- :param str member: The filename of a zipfile member to download rather than the entire file
3163
- :param bool view: feature flag for view/download
3164
- :param str range: byte ranges to return
3165
- :param list[str] x_accept_feature: redirect header
3166
- :param bool async_: Perform the request asynchronously
3167
- :return: union[DownloadTicketStub,ZipfileInfo]
3451
+ :param project_id: 24-character hex ID
3452
+ :type project_id: str
3453
+ :param analysis_id: 24-char hex analysis id
3454
+ :type analysis_id: str
3455
+ :param filename: filename to download (get tar of all if empty)
3456
+ :type filename: str
3457
+ :param ticket: ticket id of the outputs to download
3458
+ :type ticket: str, optional
3459
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3460
+ :type info: bool, optional
3461
+ :param member: The filename of a zipfile member to download rather than the entire file
3462
+ :type member: str, optional
3463
+ :param view: feature flag for view/download, defaults to false
3464
+ :type view: bool, optional
3465
+ :param range: byte ranges to return
3466
+ :type range: str, optional
3467
+ :param x_accept_feature: redirect header, defaults to []
3468
+ :type x_accept_feature: list[str], optional
3469
+ :param async_: Perform the request asynchronously
3470
+ :type async_: bool, optional
3471
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
3168
3472
  """
3169
3473
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3170
3474
  kwargs['_return_http_data_only'] = True
@@ -3187,17 +3491,27 @@ class ProjectsApi(object):
3187
3491
 
3188
3492
  This method makes a synchronous HTTP request by default.
3189
3493
 
3190
- :param str project_id: 24-character hex ID (required)
3191
- :param str analysis_id: 24-char hex analysis id (required)
3192
- :param str filename: filename to download (get tar of all if empty) (required)
3193
- :param str ticket: ticket id of the outputs to download
3194
- :param bool info: If the file is a zipfile, return a json response of zipfile member information
3195
- :param str member: The filename of a zipfile member to download rather than the entire file
3196
- :param bool view: feature flag for view/download
3197
- :param str range: byte ranges to return
3198
- :param list[str] x_accept_feature: redirect header
3199
- :param bool async_: Perform the request asynchronously
3200
- :return: union[DownloadTicketStub,ZipfileInfo]
3494
+ :param project_id: 24-character hex ID
3495
+ :type project_id: str
3496
+ :param analysis_id: 24-char hex analysis id
3497
+ :type analysis_id: str
3498
+ :param filename: filename to download (get tar of all if empty)
3499
+ :type filename: str
3500
+ :param ticket: ticket id of the outputs to download
3501
+ :type ticket: str, optional
3502
+ :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
3503
+ :type info: bool, optional
3504
+ :param member: The filename of a zipfile member to download rather than the entire file
3505
+ :type member: str, optional
3506
+ :param view: feature flag for view/download, defaults to false
3507
+ :type view: bool, optional
3508
+ :param range: byte ranges to return
3509
+ :type range: str, optional
3510
+ :param x_accept_feature: redirect header, defaults to []
3511
+ :type x_accept_feature: list[str], optional
3512
+ :param async_: Perform the request asynchronously
3513
+ :type async_: bool, optional
3514
+ :rtype: union[DownloadTicketStub,ZipfileInfo]
3201
3515
  """
3202
3516
 
3203
3517
  all_params = ['project_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
@@ -3290,12 +3604,17 @@ class ProjectsApi(object):
3290
3604
 
3291
3605
  This method makes a synchronous HTTP request by default.
3292
3606
 
3293
- :param str token: (required)
3294
- :param str metadata: Metadata object as a JSON-encoded string (required)
3295
- :param int file_count: Number of files uploaded into this packfile. (required)
3296
- :param str project_id: (required)
3297
- :param bool async_: Perform the request asynchronously
3298
- :return: None
3607
+ :param token:
3608
+ :type token: str
3609
+ :param metadata: Metadata object as a JSON-encoded string
3610
+ :type metadata: str
3611
+ :param file_count: Number of files uploaded into this packfile.
3612
+ :type file_count: int
3613
+ :param project_id:
3614
+ :type project_id: str
3615
+ :param async_: Perform the request asynchronously
3616
+ :type async_: bool, optional
3617
+ :rtype: None
3299
3618
  """
3300
3619
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3301
3620
  kwargs['_return_http_data_only'] = True
@@ -3318,12 +3637,17 @@ class ProjectsApi(object):
3318
3637
 
3319
3638
  This method makes a synchronous HTTP request by default.
3320
3639
 
3321
- :param str token: (required)
3322
- :param str metadata: Metadata object as a JSON-encoded string (required)
3323
- :param int file_count: Number of files uploaded into this packfile. (required)
3324
- :param str project_id: (required)
3325
- :param bool async_: Perform the request asynchronously
3326
- :return: None
3640
+ :param token:
3641
+ :type token: str
3642
+ :param metadata: Metadata object as a JSON-encoded string
3643
+ :type metadata: str
3644
+ :param file_count: Number of files uploaded into this packfile.
3645
+ :type file_count: int
3646
+ :param project_id:
3647
+ :type project_id: str
3648
+ :param async_: Perform the request asynchronously
3649
+ :type async_: bool, optional
3650
+ :rtype: None
3327
3651
  """
3328
3652
 
3329
3653
  all_params = ['token','metadata','file_count','project_id',] # noqa: E501
@@ -3409,21 +3733,35 @@ class ProjectsApi(object):
3409
3733
 
3410
3734
  This method makes a synchronous HTTP request by default.
3411
3735
 
3412
- :param bool counts: Append the count of subjects in each project
3413
- :param bool stats: Return the status of subjects and sessions in each project
3414
- :param bool join_avatars: Return the joined avatars of the permissions
3415
- :param JoinType join:
3416
- :param bool exhaustive: Set to return a complete list regardless of permissions
3417
- :param bool include_all_info: Include all info in returned objects
3418
- :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)
3419
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3420
- :param int limit: The maximum number of entries to return.
3421
- :param int skip: The number of entries to skip.
3422
- :param int page: The page number (i.e. skip limit*page entries)
3423
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3424
- :param list[union[HeaderFeature,str]] x_accept_feature:
3425
- :param bool async_: Perform the request asynchronously
3426
- :return: union[list[ProjectListOutput],Page]
3736
+ :param counts: Append the count of subjects in each project, defaults to false
3737
+ :type counts: bool, optional
3738
+ :param stats: Return the status of subjects and sessions in each project, defaults to false
3739
+ :type stats: bool, optional
3740
+ :param join_avatars: Return the joined avatars of the permissions, defaults to false
3741
+ :type join_avatars: bool, optional
3742
+ :param join:
3743
+ :type join: JoinType, optional
3744
+ :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
3745
+ :type exhaustive: bool, optional
3746
+ :param include_all_info: Include all info in returned objects, defaults to false
3747
+ :type include_all_info: bool, optional
3748
+ :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)
3749
+ :type filter: str, optional
3750
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3751
+ :type sort: str, optional
3752
+ :param limit: The maximum number of entries to return.
3753
+ :type limit: int, optional
3754
+ :param skip: The number of entries to skip., defaults to 0
3755
+ :type skip: int, optional
3756
+ :param page: The page number (i.e. skip limit*page entries)
3757
+ :type page: int, optional
3758
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3759
+ :type after_id: str, optional
3760
+ :param x_accept_feature:, defaults to []
3761
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3762
+ :param async_: Perform the request asynchronously
3763
+ :type async_: bool, optional
3764
+ :rtype: union[list[ProjectListOutput],Page]
3427
3765
  """
3428
3766
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3429
3767
  kwargs['_return_http_data_only'] = True
@@ -3446,21 +3784,35 @@ class ProjectsApi(object):
3446
3784
 
3447
3785
  This method makes a synchronous HTTP request by default.
3448
3786
 
3449
- :param bool counts: Append the count of subjects in each project
3450
- :param bool stats: Return the status of subjects and sessions in each project
3451
- :param bool join_avatars: Return the joined avatars of the permissions
3452
- :param JoinType join:
3453
- :param bool exhaustive: Set to return a complete list regardless of permissions
3454
- :param bool include_all_info: Include all info in returned objects
3455
- :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)
3456
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3457
- :param int limit: The maximum number of entries to return.
3458
- :param int skip: The number of entries to skip.
3459
- :param int page: The page number (i.e. skip limit*page entries)
3460
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3461
- :param list[union[HeaderFeature,str]] x_accept_feature:
3462
- :param bool async_: Perform the request asynchronously
3463
- :return: union[list[ProjectListOutput],Page]
3787
+ :param counts: Append the count of subjects in each project, defaults to false
3788
+ :type counts: bool, optional
3789
+ :param stats: Return the status of subjects and sessions in each project, defaults to false
3790
+ :type stats: bool, optional
3791
+ :param join_avatars: Return the joined avatars of the permissions, defaults to false
3792
+ :type join_avatars: bool, optional
3793
+ :param join:
3794
+ :type join: JoinType, optional
3795
+ :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
3796
+ :type exhaustive: bool, optional
3797
+ :param include_all_info: Include all info in returned objects, defaults to false
3798
+ :type include_all_info: bool, optional
3799
+ :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)
3800
+ :type filter: str, optional
3801
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3802
+ :type sort: str, optional
3803
+ :param limit: The maximum number of entries to return.
3804
+ :type limit: int, optional
3805
+ :param skip: The number of entries to skip., defaults to 0
3806
+ :type skip: int, optional
3807
+ :param page: The page number (i.e. skip limit*page entries)
3808
+ :type page: int, optional
3809
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3810
+ :type after_id: str, optional
3811
+ :param x_accept_feature:, defaults to []
3812
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
3813
+ :param async_: Perform the request asynchronously
3814
+ :type async_: bool, optional
3815
+ :rtype: union[list[ProjectListOutput],Page]
3464
3816
  """
3465
3817
 
3466
3818
  all_params = ['counts','stats','join_avatars','join','exhaustive','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3549,16 +3901,25 @@ class ProjectsApi(object):
3549
3901
 
3550
3902
  This method makes a synchronous HTTP request by default.
3551
3903
 
3552
- :param bool exhaustive: returns exhaustive list if correct permissions
3553
- :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)
3554
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3555
- :param int limit: The maximum number of entries to return.
3556
- :param int skip: The number of entries to skip.
3557
- :param int page: The page number (i.e. skip limit*page entries)
3558
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3559
- :param list[str] x_accept_feature:
3560
- :param bool async_: Perform the request asynchronously
3561
- :return: list[GroupOutput]
3904
+ :param exhaustive: returns exhaustive list if correct permissions, defaults to false
3905
+ :type exhaustive: bool, optional
3906
+ :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)
3907
+ :type filter: str, optional
3908
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3909
+ :type sort: str, optional
3910
+ :param limit: The maximum number of entries to return.
3911
+ :type limit: int, optional
3912
+ :param skip: The number of entries to skip., defaults to 0
3913
+ :type skip: int, optional
3914
+ :param page: The page number (i.e. skip limit*page entries)
3915
+ :type page: int, optional
3916
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3917
+ :type after_id: str, optional
3918
+ :param x_accept_feature:, defaults to []
3919
+ :type x_accept_feature: list[str], optional
3920
+ :param async_: Perform the request asynchronously
3921
+ :type async_: bool, optional
3922
+ :rtype: list[GroupOutput]
3562
3923
  """
3563
3924
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3564
3925
  kwargs['_return_http_data_only'] = True
@@ -3581,16 +3942,25 @@ class ProjectsApi(object):
3581
3942
 
3582
3943
  This method makes a synchronous HTTP request by default.
3583
3944
 
3584
- :param bool exhaustive: returns exhaustive list if correct permissions
3585
- :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)
3586
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3587
- :param int limit: The maximum number of entries to return.
3588
- :param int skip: The number of entries to skip.
3589
- :param int page: The page number (i.e. skip limit*page entries)
3590
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3591
- :param list[str] x_accept_feature:
3592
- :param bool async_: Perform the request asynchronously
3593
- :return: list[GroupOutput]
3945
+ :param exhaustive: returns exhaustive list if correct permissions, defaults to false
3946
+ :type exhaustive: bool, optional
3947
+ :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)
3948
+ :type filter: str, optional
3949
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
3950
+ :type sort: str, optional
3951
+ :param limit: The maximum number of entries to return.
3952
+ :type limit: int, optional
3953
+ :param skip: The number of entries to skip., defaults to 0
3954
+ :type skip: int, optional
3955
+ :param page: The page number (i.e. skip limit*page entries)
3956
+ :type page: int, optional
3957
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3958
+ :type after_id: str, optional
3959
+ :param x_accept_feature:, defaults to []
3960
+ :type x_accept_feature: list[str], optional
3961
+ :param async_: Perform the request asynchronously
3962
+ :type async_: bool, optional
3963
+ :rtype: list[GroupOutput]
3594
3964
  """
3595
3965
 
3596
3966
  all_params = ['exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -3669,8 +4039,9 @@ class ProjectsApi(object):
3669
4039
 
3670
4040
  This method makes a synchronous HTTP request by default.
3671
4041
 
3672
- :param bool async_: Perform the request asynchronously
3673
- :return: SharingFilterOptions
4042
+ :param async_: Perform the request asynchronously
4043
+ :type async_: bool, optional
4044
+ :rtype: SharingFilterOptions
3674
4045
  """
3675
4046
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3676
4047
  kwargs['_return_http_data_only'] = True
@@ -3693,8 +4064,9 @@ class ProjectsApi(object):
3693
4064
 
3694
4065
  This method makes a synchronous HTTP request by default.
3695
4066
 
3696
- :param bool async_: Perform the request asynchronously
3697
- :return: SharingFilterOptions
4067
+ :param async_: Perform the request asynchronously
4068
+ :type async_: bool, optional
4069
+ :rtype: SharingFilterOptions
3698
4070
  """
3699
4071
 
3700
4072
  all_params = [] # noqa: E501
@@ -3756,12 +4128,17 @@ class ProjectsApi(object):
3756
4128
 
3757
4129
  This method makes a synchronous HTTP request by default.
3758
4130
 
3759
- :param str project_id: (required)
3760
- :param JoinType join:
3761
- :param bool join_avatars: add name and avatar to notes
3762
- :param list[union[HeaderFeature,str]] x_accept_feature:
3763
- :param bool async_: Perform the request asynchronously
3764
- :return: ProjectOutput
4131
+ :param project_id:
4132
+ :type project_id: str
4133
+ :param join:
4134
+ :type join: JoinType, optional
4135
+ :param join_avatars: add name and avatar to notes, defaults to false
4136
+ :type join_avatars: bool, optional
4137
+ :param x_accept_feature:, defaults to []
4138
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
4139
+ :param async_: Perform the request asynchronously
4140
+ :type async_: bool, optional
4141
+ :rtype: ProjectOutput
3765
4142
  """
3766
4143
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3767
4144
  kwargs['_return_http_data_only'] = True
@@ -3784,12 +4161,17 @@ class ProjectsApi(object):
3784
4161
 
3785
4162
  This method makes a synchronous HTTP request by default.
3786
4163
 
3787
- :param str project_id: (required)
3788
- :param JoinType join:
3789
- :param bool join_avatars: add name and avatar to notes
3790
- :param list[union[HeaderFeature,str]] x_accept_feature:
3791
- :param bool async_: Perform the request asynchronously
3792
- :return: ProjectOutput
4164
+ :param project_id:
4165
+ :type project_id: str
4166
+ :param join:
4167
+ :type join: JoinType, optional
4168
+ :param join_avatars: add name and avatar to notes, defaults to false
4169
+ :type join_avatars: bool, optional
4170
+ :param x_accept_feature:, defaults to []
4171
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
4172
+ :param async_: Perform the request asynchronously
4173
+ :type async_: bool, optional
4174
+ :rtype: ProjectOutput
3793
4175
  """
3794
4176
 
3795
4177
  all_params = ['project_id','join','join_avatars','x_accept_feature',] # noqa: E501
@@ -3864,20 +4246,33 @@ class ProjectsApi(object):
3864
4246
 
3865
4247
  This method makes a synchronous HTTP request by default.
3866
4248
 
3867
- :param str project_id: (required)
3868
- :param str collection_id:
3869
- :param bool exhaustive:
3870
- :param JoinType join:
3871
- :param bool include_all_info: Include all info in returned objects
3872
- :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)
3873
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3874
- :param int limit: The maximum number of entries to return.
3875
- :param int skip: The number of entries to skip.
3876
- :param int page: The page number (i.e. skip limit*page entries)
3877
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3878
- :param list[str] x_accept_feature:
3879
- :param bool async_: Perform the request asynchronously
3880
- :return: union[list[AcquisitionListOutput],Page]
4249
+ :param project_id:
4250
+ :type project_id: str
4251
+ :param collection_id:
4252
+ :type collection_id: str, optional
4253
+ :param exhaustive:, defaults to false
4254
+ :type exhaustive: bool, optional
4255
+ :param join:
4256
+ :type join: JoinType, optional
4257
+ :param include_all_info: Include all info in returned objects, defaults to false
4258
+ :type include_all_info: bool, optional
4259
+ :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)
4260
+ :type filter: str, optional
4261
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4262
+ :type sort: str, optional
4263
+ :param limit: The maximum number of entries to return.
4264
+ :type limit: int, optional
4265
+ :param skip: The number of entries to skip., defaults to 0
4266
+ :type skip: int, optional
4267
+ :param page: The page number (i.e. skip limit*page entries)
4268
+ :type page: int, optional
4269
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4270
+ :type after_id: str, optional
4271
+ :param x_accept_feature:, defaults to []
4272
+ :type x_accept_feature: list[str], optional
4273
+ :param async_: Perform the request asynchronously
4274
+ :type async_: bool, optional
4275
+ :rtype: union[list[AcquisitionListOutput],Page]
3881
4276
  """
3882
4277
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3883
4278
  kwargs['_return_http_data_only'] = True
@@ -3900,20 +4295,33 @@ class ProjectsApi(object):
3900
4295
 
3901
4296
  This method makes a synchronous HTTP request by default.
3902
4297
 
3903
- :param str project_id: (required)
3904
- :param str collection_id:
3905
- :param bool exhaustive:
3906
- :param JoinType join:
3907
- :param bool include_all_info: Include all info in returned objects
3908
- :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)
3909
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
3910
- :param int limit: The maximum number of entries to return.
3911
- :param int skip: The number of entries to skip.
3912
- :param int page: The page number (i.e. skip limit*page entries)
3913
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
3914
- :param list[str] x_accept_feature:
3915
- :param bool async_: Perform the request asynchronously
3916
- :return: union[list[AcquisitionListOutput],Page]
4298
+ :param project_id:
4299
+ :type project_id: str
4300
+ :param collection_id:
4301
+ :type collection_id: str, optional
4302
+ :param exhaustive:, defaults to false
4303
+ :type exhaustive: bool, optional
4304
+ :param join:
4305
+ :type join: JoinType, optional
4306
+ :param include_all_info: Include all info in returned objects, defaults to false
4307
+ :type include_all_info: bool, optional
4308
+ :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)
4309
+ :type filter: str, optional
4310
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4311
+ :type sort: str, optional
4312
+ :param limit: The maximum number of entries to return.
4313
+ :type limit: int, optional
4314
+ :param skip: The number of entries to skip., defaults to 0
4315
+ :type skip: int, optional
4316
+ :param page: The page number (i.e. skip limit*page entries)
4317
+ :type page: int, optional
4318
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4319
+ :type after_id: str, optional
4320
+ :param x_accept_feature:, defaults to []
4321
+ :type x_accept_feature: list[str], optional
4322
+ :param async_: Perform the request asynchronously
4323
+ :type async_: bool, optional
4324
+ :rtype: union[list[AcquisitionListOutput],Page]
3917
4325
  """
3918
4326
 
3919
4327
  all_params = ['project_id','collection_id','exhaustive','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -4005,20 +4413,33 @@ class ProjectsApi(object):
4005
4413
  Returns analyses that directly belong to this resource.
4006
4414
  This method makes a synchronous HTTP request by default.
4007
4415
 
4008
- :param str cid: (required)
4009
- :param bool inflate_job:
4010
- :param bool join_avatars:
4011
- :param JoinType join:
4012
- :param bool include_all_info: Include all info in returned objects
4013
- :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)
4014
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
4015
- :param int limit: The maximum number of entries to return.
4016
- :param int skip: The number of entries to skip.
4017
- :param int page: The page number (i.e. skip limit*page entries)
4018
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4019
- :param list[str] x_accept_feature:
4020
- :param bool async_: Perform the request asynchronously
4021
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
4416
+ :param cid:
4417
+ :type cid: str
4418
+ :param inflate_job:, defaults to false
4419
+ :type inflate_job: bool, optional
4420
+ :param join_avatars:, defaults to false
4421
+ :type join_avatars: bool, optional
4422
+ :param join:
4423
+ :type join: JoinType, optional
4424
+ :param include_all_info: Include all info in returned objects, defaults to false
4425
+ :type include_all_info: bool, optional
4426
+ :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)
4427
+ :type filter: str, optional
4428
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4429
+ :type sort: str, optional
4430
+ :param limit: The maximum number of entries to return.
4431
+ :type limit: int, optional
4432
+ :param skip: The number of entries to skip., defaults to 0
4433
+ :type skip: int, optional
4434
+ :param page: The page number (i.e. skip limit*page entries)
4435
+ :type page: int, optional
4436
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4437
+ :type after_id: str, optional
4438
+ :param x_accept_feature:, defaults to []
4439
+ :type x_accept_feature: list[str], optional
4440
+ :param async_: Perform the request asynchronously
4441
+ :type async_: bool, optional
4442
+ :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
4022
4443
  """
4023
4444
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4024
4445
  kwargs['_return_http_data_only'] = True
@@ -4042,20 +4463,33 @@ class ProjectsApi(object):
4042
4463
  Returns analyses that directly belong to this resource.
4043
4464
  This method makes a synchronous HTTP request by default.
4044
4465
 
4045
- :param str cid: (required)
4046
- :param bool inflate_job:
4047
- :param bool join_avatars:
4048
- :param JoinType join:
4049
- :param bool include_all_info: Include all info in returned objects
4050
- :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)
4051
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
4052
- :param int limit: The maximum number of entries to return.
4053
- :param int skip: The number of entries to skip.
4054
- :param int page: The page number (i.e. skip limit*page entries)
4055
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4056
- :param list[str] x_accept_feature:
4057
- :param bool async_: Perform the request asynchronously
4058
- :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
4466
+ :param cid:
4467
+ :type cid: str
4468
+ :param inflate_job:, defaults to false
4469
+ :type inflate_job: bool, optional
4470
+ :param join_avatars:, defaults to false
4471
+ :type join_avatars: bool, optional
4472
+ :param join:
4473
+ :type join: JoinType, optional
4474
+ :param include_all_info: Include all info in returned objects, defaults to false
4475
+ :type include_all_info: bool, optional
4476
+ :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)
4477
+ :type filter: str, optional
4478
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
4479
+ :type sort: str, optional
4480
+ :param limit: The maximum number of entries to return.
4481
+ :type limit: int, optional
4482
+ :param skip: The number of entries to skip., defaults to 0
4483
+ :type skip: int, optional
4484
+ :param page: The page number (i.e. skip limit*page entries)
4485
+ :type page: int, optional
4486
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4487
+ :type after_id: str, optional
4488
+ :param x_accept_feature:, defaults to []
4489
+ :type x_accept_feature: list[str], optional
4490
+ :param async_: Perform the request asynchronously
4491
+ :type async_: bool, optional
4492
+ :rtype: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
4059
4493
  """
4060
4494
 
4061
4495
  all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -4147,13 +4581,19 @@ class ProjectsApi(object):
4147
4581
  Get an analysis.
4148
4582
  This method makes a synchronous HTTP request by default.
4149
4583
 
4150
- :param str cid: (required)
4151
- :param str analysis_id: (required)
4152
- :param bool inflate_job: Return job as an object instead of an id
4153
- :param bool join_avatars:
4154
- :param JoinType join:
4155
- :param bool async_: Perform the request asynchronously
4156
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
4584
+ :param cid:
4585
+ :type cid: str
4586
+ :param analysis_id:
4587
+ :type analysis_id: str
4588
+ :param inflate_job: Return job as an object instead of an id, defaults to false
4589
+ :type inflate_job: bool, optional
4590
+ :param join_avatars:, defaults to false
4591
+ :type join_avatars: bool, optional
4592
+ :param join:
4593
+ :type join: JoinType, optional
4594
+ :param async_: Perform the request asynchronously
4595
+ :type async_: bool, optional
4596
+ :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
4157
4597
  """
4158
4598
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4159
4599
  kwargs['_return_http_data_only'] = True
@@ -4177,13 +4617,19 @@ class ProjectsApi(object):
4177
4617
  Get an analysis.
4178
4618
  This method makes a synchronous HTTP request by default.
4179
4619
 
4180
- :param str cid: (required)
4181
- :param str analysis_id: (required)
4182
- :param bool inflate_job: Return job as an object instead of an id
4183
- :param bool join_avatars:
4184
- :param JoinType join:
4185
- :param bool async_: Perform the request asynchronously
4186
- :return: union[AnalysisOutputInflatedJob,AnalysisOutput]
4620
+ :param cid:
4621
+ :type cid: str
4622
+ :param analysis_id:
4623
+ :type analysis_id: str
4624
+ :param inflate_job: Return job as an object instead of an id, defaults to false
4625
+ :type inflate_job: bool, optional
4626
+ :param join_avatars:, defaults to false
4627
+ :type join_avatars: bool, optional
4628
+ :param join:
4629
+ :type join: JoinType, optional
4630
+ :param async_: Perform the request asynchronously
4631
+ :type async_: bool, optional
4632
+ :rtype: union[AnalysisOutputInflatedJob,AnalysisOutput]
4187
4633
  """
4188
4634
 
4189
4635
  all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
@@ -4258,16 +4704,120 @@ class ProjectsApi(object):
4258
4704
  _request_out=params.get('_request_out'),
4259
4705
  collection_formats=collection_formats)
4260
4706
 
4707
+ def get_project_delete_status(self, project_id, **kwargs): # noqa: E501
4708
+ """Get project deletion status
4709
+
4710
+ Get the status of a project deletion running in the background. Returns the current deletion status and any failure reason if the deletion failed.
4711
+ This method makes a synchronous HTTP request by default.
4712
+
4713
+ :param project_id:
4714
+ :type project_id: str
4715
+ :param async_: Perform the request asynchronously
4716
+ :type async_: bool, optional
4717
+ :rtype: ProjectDeleteStatusOutput
4718
+ """
4719
+ ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4720
+ kwargs['_return_http_data_only'] = True
4721
+
4722
+ if kwargs.get('async_'):
4723
+ return self.get_project_delete_status_with_http_info(project_id, **kwargs) # noqa: E501
4724
+ else:
4725
+ (data) = self.get_project_delete_status_with_http_info(project_id, **kwargs) # noqa: E501
4726
+ if (
4727
+ data
4728
+ and hasattr(data, 'return_value')
4729
+ and not ignore_simplified_return_value
4730
+ ):
4731
+ return data.return_value()
4732
+ return data
4733
+
4734
+
4735
+ def get_project_delete_status_with_http_info(self, project_id, **kwargs): # noqa: E501
4736
+ """Get project deletion status
4737
+
4738
+ Get the status of a project deletion running in the background. Returns the current deletion status and any failure reason if the deletion failed.
4739
+ This method makes a synchronous HTTP request by default.
4740
+
4741
+ :param project_id:
4742
+ :type project_id: str
4743
+ :param async_: Perform the request asynchronously
4744
+ :type async_: bool, optional
4745
+ :rtype: ProjectDeleteStatusOutput
4746
+ """
4747
+
4748
+ all_params = ['project_id',] # noqa: E501
4749
+ all_params.append('async_')
4750
+ all_params.append('_return_http_data_only')
4751
+ all_params.append('_preload_content')
4752
+ all_params.append('_request_timeout')
4753
+ all_params.append('_request_out')
4754
+
4755
+ params = locals()
4756
+ for key, val in six.iteritems(params['kwargs']):
4757
+ if key not in all_params:
4758
+ raise TypeError(
4759
+ "Got an unexpected keyword argument '%s'"
4760
+ " to method get_project_delete_status" % key
4761
+ )
4762
+ params[key] = val
4763
+ del params['kwargs']
4764
+ # verify the required parameter 'project_id' is set
4765
+ if ('project_id' not in params or
4766
+ params['project_id'] is None):
4767
+ raise ValueError("Missing the required parameter `project_id` when calling `get_project_delete_status`") # noqa: E501
4768
+ check_filename_params(params)
4769
+
4770
+ collection_formats = {}
4771
+
4772
+ path_params = {}
4773
+ if 'project_id' in params:
4774
+ path_params['project_id'] = params['project_id'] # noqa: E501
4775
+
4776
+ query_params = []
4777
+
4778
+ header_params = {}
4779
+
4780
+ form_params = []
4781
+ local_var_files = {}
4782
+
4783
+ body_params = None
4784
+ # HTTP header `Accept`
4785
+ header_params['Accept'] = self.api_client.select_header_accept(
4786
+ ['application/json']) # noqa: E501
4787
+
4788
+ # Authentication setting
4789
+ auth_settings = ['ApiKey'] # noqa: E501
4790
+
4791
+ return self.api_client.call_api(
4792
+ '/projects/{project_id}/delete-status', 'GET',
4793
+ path_params,
4794
+ query_params,
4795
+ header_params,
4796
+ body=body_params,
4797
+ post_params=form_params,
4798
+ files=local_var_files,
4799
+ response_type='ProjectDeleteStatusOutput', # noqa: E501
4800
+ auth_settings=auth_settings,
4801
+ async_=params.get('async_'),
4802
+ _return_http_data_only=params.get('_return_http_data_only'),
4803
+ _preload_content=params.get('_preload_content', True),
4804
+ _request_timeout=params.get('_request_timeout'),
4805
+ _request_out=params.get('_request_out'),
4806
+ collection_formats=collection_formats)
4807
+
4261
4808
  def get_project_file_info(self, cid, filename, **kwargs): # noqa: E501
4262
4809
  """Get info for a particular file.
4263
4810
 
4264
4811
  Get info for a particular file.
4265
4812
  This method makes a synchronous HTTP request by default.
4266
4813
 
4267
- :param str cid: Container Id (required)
4268
- :param str filename: (required)
4269
- :param bool async_: Perform the request asynchronously
4270
- :return: FileOutput
4814
+ :param cid: Container Id
4815
+ :type cid: str
4816
+ :param filename:
4817
+ :type filename: str
4818
+ :param async_: Perform the request asynchronously
4819
+ :type async_: bool, optional
4820
+ :rtype: FileOutput
4271
4821
  """
4272
4822
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4273
4823
  kwargs['_return_http_data_only'] = True
@@ -4291,10 +4841,13 @@ class ProjectsApi(object):
4291
4841
  Get info for a particular file.
4292
4842
  This method makes a synchronous HTTP request by default.
4293
4843
 
4294
- :param str cid: Container Id (required)
4295
- :param str filename: (required)
4296
- :param bool async_: Perform the request asynchronously
4297
- :return: FileOutput
4844
+ :param cid: Container Id
4845
+ :type cid: str
4846
+ :param filename:
4847
+ :type filename: str
4848
+ :param async_: Perform the request asynchronously
4849
+ :type async_: bool, optional
4850
+ :rtype: FileOutput
4298
4851
  """
4299
4852
 
4300
4853
  all_params = ['cid','filename',] # noqa: E501
@@ -4369,10 +4922,13 @@ class ProjectsApi(object):
4369
4922
  Get a note of a(n) project
4370
4923
  This method makes a synchronous HTTP request by default.
4371
4924
 
4372
- :param str cid: (required)
4373
- :param str note_id: (required)
4374
- :param bool async_: Perform the request asynchronously
4375
- :return: Note
4925
+ :param cid:
4926
+ :type cid: str
4927
+ :param note_id:
4928
+ :type note_id: str
4929
+ :param async_: Perform the request asynchronously
4930
+ :type async_: bool, optional
4931
+ :rtype: Note
4376
4932
  """
4377
4933
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4378
4934
  kwargs['_return_http_data_only'] = True
@@ -4396,10 +4952,13 @@ class ProjectsApi(object):
4396
4952
  Get a note of a(n) project
4397
4953
  This method makes a synchronous HTTP request by default.
4398
4954
 
4399
- :param str cid: (required)
4400
- :param str note_id: (required)
4401
- :param bool async_: Perform the request asynchronously
4402
- :return: Note
4955
+ :param cid:
4956
+ :type cid: str
4957
+ :param note_id:
4958
+ :type note_id: str
4959
+ :param async_: Perform the request asynchronously
4960
+ :type async_: bool, optional
4961
+ :rtype: Note
4403
4962
  """
4404
4963
 
4405
4964
  all_params = ['cid','note_id',] # noqa: E501
@@ -4474,10 +5033,13 @@ class ProjectsApi(object):
4474
5033
  Get a project rule.
4475
5034
  This method makes a synchronous HTTP request by default.
4476
5035
 
4477
- :param str project_id: (required)
4478
- :param str rule_id: (required)
4479
- :param bool async_: Perform the request asynchronously
4480
- :return: GearRuleOutput
5036
+ :param project_id:
5037
+ :type project_id: str
5038
+ :param rule_id:
5039
+ :type rule_id: str
5040
+ :param async_: Perform the request asynchronously
5041
+ :type async_: bool, optional
5042
+ :rtype: GearRuleOutput
4481
5043
  """
4482
5044
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4483
5045
  kwargs['_return_http_data_only'] = True
@@ -4501,10 +5063,13 @@ class ProjectsApi(object):
4501
5063
  Get a project rule.
4502
5064
  This method makes a synchronous HTTP request by default.
4503
5065
 
4504
- :param str project_id: (required)
4505
- :param str rule_id: (required)
4506
- :param bool async_: Perform the request asynchronously
4507
- :return: GearRuleOutput
5066
+ :param project_id:
5067
+ :type project_id: str
5068
+ :param rule_id:
5069
+ :type rule_id: str
5070
+ :param async_: Perform the request asynchronously
5071
+ :type async_: bool, optional
5072
+ :rtype: GearRuleOutput
4508
5073
  """
4509
5074
 
4510
5075
  all_params = ['project_id','rule_id',] # noqa: E501
@@ -4578,9 +5143,11 @@ class ProjectsApi(object):
4578
5143
 
4579
5144
  This method makes a synchronous HTTP request by default.
4580
5145
 
4581
- :param str project_id: (required)
4582
- :param bool async_: Perform the request asynchronously
4583
- :return: list[GearRuleOutput]
5146
+ :param project_id:
5147
+ :type project_id: str
5148
+ :param async_: Perform the request asynchronously
5149
+ :type async_: bool, optional
5150
+ :rtype: list[GearRuleOutput]
4584
5151
  """
4585
5152
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4586
5153
  kwargs['_return_http_data_only'] = True
@@ -4603,9 +5170,11 @@ class ProjectsApi(object):
4603
5170
 
4604
5171
  This method makes a synchronous HTTP request by default.
4605
5172
 
4606
- :param str project_id: (required)
4607
- :param bool async_: Perform the request asynchronously
4608
- :return: list[GearRuleOutput]
5173
+ :param project_id:
5174
+ :type project_id: str
5175
+ :param async_: Perform the request asynchronously
5176
+ :type async_: bool, optional
5177
+ :rtype: list[GearRuleOutput]
4609
5178
  """
4610
5179
 
4611
5180
  all_params = ['project_id',] # noqa: E501
@@ -4674,18 +5243,29 @@ class ProjectsApi(object):
4674
5243
  Returns a page of sessions by their parent
4675
5244
  This method makes a synchronous HTTP request by default.
4676
5245
 
4677
- :param str project_id: 24-char hex subject id (required)
4678
- :param JoinType join: join file origins
4679
- :param bool include_all_info: Include all info in returned objects
4680
- :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)
4681
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
4682
- :param int limit: The maximum number of entries to return.
4683
- :param int skip: The number of entries to skip.
4684
- :param int page: The page number (i.e. skip limit*page entries)
4685
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4686
- :param list[union[HeaderFeature,str]] x_accept_feature:
4687
- :param bool async_: Perform the request asynchronously
4688
- :return: union[Page,list[SessionListOutput]]
5246
+ :param project_id: 24-char hex subject id
5247
+ :type project_id: str
5248
+ :param join: join file origins
5249
+ :type join: JoinType, optional
5250
+ :param include_all_info: Include all info in returned objects, defaults to false
5251
+ :type include_all_info: bool, optional
5252
+ :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)
5253
+ :type filter: str, optional
5254
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
5255
+ :type sort: str, optional
5256
+ :param limit: The maximum number of entries to return.
5257
+ :type limit: int, optional
5258
+ :param skip: The number of entries to skip., defaults to 0
5259
+ :type skip: int, optional
5260
+ :param page: The page number (i.e. skip limit*page entries)
5261
+ :type page: int, optional
5262
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
5263
+ :type after_id: str, optional
5264
+ :param x_accept_feature:, defaults to []
5265
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
5266
+ :param async_: Perform the request asynchronously
5267
+ :type async_: bool, optional
5268
+ :rtype: union[Page,list[SessionListOutput]]
4689
5269
  """
4690
5270
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4691
5271
  kwargs['_return_http_data_only'] = True
@@ -4709,18 +5289,29 @@ class ProjectsApi(object):
4709
5289
  Returns a page of sessions by their parent
4710
5290
  This method makes a synchronous HTTP request by default.
4711
5291
 
4712
- :param str project_id: 24-char hex subject id (required)
4713
- :param JoinType join: join file origins
4714
- :param bool include_all_info: Include all info in returned objects
4715
- :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)
4716
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
4717
- :param int limit: The maximum number of entries to return.
4718
- :param int skip: The number of entries to skip.
4719
- :param int page: The page number (i.e. skip limit*page entries)
4720
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4721
- :param list[union[HeaderFeature,str]] x_accept_feature:
4722
- :param bool async_: Perform the request asynchronously
4723
- :return: union[Page,list[SessionListOutput]]
5292
+ :param project_id: 24-char hex subject id
5293
+ :type project_id: str
5294
+ :param join: join file origins
5295
+ :type join: JoinType, optional
5296
+ :param include_all_info: Include all info in returned objects, defaults to false
5297
+ :type include_all_info: bool, optional
5298
+ :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)
5299
+ :type filter: str, optional
5300
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
5301
+ :type sort: str, optional
5302
+ :param limit: The maximum number of entries to return.
5303
+ :type limit: int, optional
5304
+ :param skip: The number of entries to skip., defaults to 0
5305
+ :type skip: int, optional
5306
+ :param page: The page number (i.e. skip limit*page entries)
5307
+ :type page: int, optional
5308
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
5309
+ :type after_id: str, optional
5310
+ :param x_accept_feature:, defaults to []
5311
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
5312
+ :param async_: Perform the request asynchronously
5313
+ :type async_: bool, optional
5314
+ :rtype: union[Page,list[SessionListOutput]]
4724
5315
  """
4725
5316
 
4726
5317
  all_params = ['project_id','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -4808,9 +5399,11 @@ class ProjectsApi(object):
4808
5399
  Route for getting settings from a a(n) project
4809
5400
  This method makes a synchronous HTTP request by default.
4810
5401
 
4811
- :param str project_id: (required)
4812
- :param bool async_: Perform the request asynchronously
4813
- :return: ProjectSettingsOutput
5402
+ :param project_id:
5403
+ :type project_id: str
5404
+ :param async_: Perform the request asynchronously
5405
+ :type async_: bool, optional
5406
+ :rtype: ProjectSettingsOutput
4814
5407
  """
4815
5408
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4816
5409
  kwargs['_return_http_data_only'] = True
@@ -4834,9 +5427,11 @@ class ProjectsApi(object):
4834
5427
  Route for getting settings from a a(n) project
4835
5428
  This method makes a synchronous HTTP request by default.
4836
5429
 
4837
- :param str project_id: (required)
4838
- :param bool async_: Perform the request asynchronously
4839
- :return: ProjectSettingsOutput
5430
+ :param project_id:
5431
+ :type project_id: str
5432
+ :param async_: Perform the request asynchronously
5433
+ :type async_: bool, optional
5434
+ :rtype: ProjectSettingsOutput
4840
5435
  """
4841
5436
 
4842
5437
  all_params = ['project_id',] # noqa: E501
@@ -4905,18 +5500,29 @@ class ProjectsApi(object):
4905
5500
  List all subjects for the given project.
4906
5501
  This method makes a synchronous HTTP request by default.
4907
5502
 
4908
- :param str project_id: (required)
4909
- :param JoinType join:
4910
- :param bool include_all_info: Include all info in returned objects
4911
- :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)
4912
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
4913
- :param int limit: The maximum number of entries to return.
4914
- :param int skip: The number of entries to skip.
4915
- :param int page: The page number (i.e. skip limit*page entries)
4916
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4917
- :param list[str] x_accept_feature:
4918
- :param bool async_: Perform the request asynchronously
4919
- :return: union[Page,list[SubjectOutputForList]]
5503
+ :param project_id:
5504
+ :type project_id: str
5505
+ :param join:
5506
+ :type join: JoinType, optional
5507
+ :param include_all_info: Include all info in returned objects, defaults to false
5508
+ :type include_all_info: bool, optional
5509
+ :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)
5510
+ :type filter: str, optional
5511
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
5512
+ :type sort: str, optional
5513
+ :param limit: The maximum number of entries to return.
5514
+ :type limit: int, optional
5515
+ :param skip: The number of entries to skip., defaults to 0
5516
+ :type skip: int, optional
5517
+ :param page: The page number (i.e. skip limit*page entries)
5518
+ :type page: int, optional
5519
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
5520
+ :type after_id: str, optional
5521
+ :param x_accept_feature:, defaults to []
5522
+ :type x_accept_feature: list[str], optional
5523
+ :param async_: Perform the request asynchronously
5524
+ :type async_: bool, optional
5525
+ :rtype: union[Page,list[SubjectOutputForList]]
4920
5526
  """
4921
5527
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4922
5528
  kwargs['_return_http_data_only'] = True
@@ -4940,18 +5546,29 @@ class ProjectsApi(object):
4940
5546
  List all subjects for the given project.
4941
5547
  This method makes a synchronous HTTP request by default.
4942
5548
 
4943
- :param str project_id: (required)
4944
- :param JoinType join:
4945
- :param bool include_all_info: Include all info in returned objects
4946
- :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)
4947
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
4948
- :param int limit: The maximum number of entries to return.
4949
- :param int skip: The number of entries to skip.
4950
- :param int page: The page number (i.e. skip limit*page entries)
4951
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
4952
- :param list[str] x_accept_feature:
4953
- :param bool async_: Perform the request asynchronously
4954
- :return: union[Page,list[SubjectOutputForList]]
5549
+ :param project_id:
5550
+ :type project_id: str
5551
+ :param join:
5552
+ :type join: JoinType, optional
5553
+ :param include_all_info: Include all info in returned objects, defaults to false
5554
+ :type include_all_info: bool, optional
5555
+ :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)
5556
+ :type filter: str, optional
5557
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
5558
+ :type sort: str, optional
5559
+ :param limit: The maximum number of entries to return.
5560
+ :type limit: int, optional
5561
+ :param skip: The number of entries to skip., defaults to 0
5562
+ :type skip: int, optional
5563
+ :param page: The page number (i.e. skip limit*page entries)
5564
+ :type page: int, optional
5565
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
5566
+ :type after_id: str, optional
5567
+ :param x_accept_feature:, defaults to []
5568
+ :type x_accept_feature: list[str], optional
5569
+ :param async_: Perform the request asynchronously
5570
+ :type async_: bool, optional
5571
+ :rtype: union[Page,list[SubjectOutputForList]]
4955
5572
  """
4956
5573
 
4957
5574
  all_params = ['project_id','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -5039,10 +5656,13 @@ class ProjectsApi(object):
5039
5656
  Get the value of a tag, by name
5040
5657
  This method makes a synchronous HTTP request by default.
5041
5658
 
5042
- :param str cid: (required)
5043
- :param str value: The tag to interact with (required)
5044
- :param bool async_: Perform the request asynchronously
5045
- :return: str
5659
+ :param cid:
5660
+ :type cid: str
5661
+ :param value: The tag to interact with
5662
+ :type value: str
5663
+ :param async_: Perform the request asynchronously
5664
+ :type async_: bool, optional
5665
+ :rtype: str
5046
5666
  """
5047
5667
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5048
5668
  kwargs['_return_http_data_only'] = True
@@ -5066,10 +5686,13 @@ class ProjectsApi(object):
5066
5686
  Get the value of a tag, by name
5067
5687
  This method makes a synchronous HTTP request by default.
5068
5688
 
5069
- :param str cid: (required)
5070
- :param str value: The tag to interact with (required)
5071
- :param bool async_: Perform the request asynchronously
5072
- :return: str
5689
+ :param cid:
5690
+ :type cid: str
5691
+ :param value: The tag to interact with
5692
+ :type value: str
5693
+ :param async_: Perform the request asynchronously
5694
+ :type async_: bool, optional
5695
+ :rtype: str
5073
5696
  """
5074
5697
 
5075
5698
  all_params = ['cid','value',] # noqa: E501
@@ -5144,10 +5767,13 @@ class ProjectsApi(object):
5144
5767
  Get a user's permission from a project Args: project_id: The id of the project uid: The id of the user auth_session: The auth session Returns: RolePermissionOutput: The permission
5145
5768
  This method makes a synchronous HTTP request by default.
5146
5769
 
5147
- :param str project_id: (required)
5148
- :param str uid: (required)
5149
- :param bool async_: Perform the request asynchronously
5150
- :return: RolePermissionOutput
5770
+ :param project_id:
5771
+ :type project_id: str
5772
+ :param uid:
5773
+ :type uid: str
5774
+ :param async_: Perform the request asynchronously
5775
+ :type async_: bool, optional
5776
+ :rtype: RolePermissionOutput
5151
5777
  """
5152
5778
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5153
5779
  kwargs['_return_http_data_only'] = True
@@ -5171,10 +5797,13 @@ class ProjectsApi(object):
5171
5797
  Get a user's permission from a project Args: project_id: The id of the project uid: The id of the user auth_session: The auth session Returns: RolePermissionOutput: The permission
5172
5798
  This method makes a synchronous HTTP request by default.
5173
5799
 
5174
- :param str project_id: (required)
5175
- :param str uid: (required)
5176
- :param bool async_: Perform the request asynchronously
5177
- :return: RolePermissionOutput
5800
+ :param project_id:
5801
+ :type project_id: str
5802
+ :param uid:
5803
+ :type uid: str
5804
+ :param async_: Perform the request asynchronously
5805
+ :type async_: bool, optional
5806
+ :rtype: RolePermissionOutput
5178
5807
  """
5179
5808
 
5180
5809
  all_params = ['project_id','uid',] # noqa: E501
@@ -5248,11 +5877,15 @@ class ProjectsApi(object):
5248
5877
 
5249
5878
  This method makes a synchronous HTTP request by default.
5250
5879
 
5251
- :param str project_id: (required)
5252
- :param ProjectModify body: (required)
5253
- :param list[union[HeaderFeature,str]] x_accept_feature:
5254
- :param bool async_: Perform the request asynchronously
5255
- :return: ModifiedResult
5880
+ :param project_id:
5881
+ :type project_id: str
5882
+ :param body:
5883
+ :type body: ProjectModify
5884
+ :param x_accept_feature:, defaults to []
5885
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
5886
+ :param async_: Perform the request asynchronously
5887
+ :type async_: bool, optional
5888
+ :rtype: ModifiedResult
5256
5889
  """
5257
5890
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5258
5891
  kwargs['_return_http_data_only'] = True
@@ -5275,11 +5908,15 @@ class ProjectsApi(object):
5275
5908
 
5276
5909
  This method makes a synchronous HTTP request by default.
5277
5910
 
5278
- :param str project_id: (required)
5279
- :param ProjectModify body: (required)
5280
- :param list[union[HeaderFeature,str]] x_accept_feature:
5281
- :param bool async_: Perform the request asynchronously
5282
- :return: ModifiedResult
5911
+ :param project_id:
5912
+ :type project_id: str
5913
+ :param body:
5914
+ :type body: ProjectModify
5915
+ :param x_accept_feature:, defaults to []
5916
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
5917
+ :param async_: Perform the request asynchronously
5918
+ :type async_: bool, optional
5919
+ :rtype: ModifiedResult
5283
5920
  """
5284
5921
 
5285
5922
  all_params = ['project_id','body','x_accept_feature',] # noqa: E501
@@ -5368,11 +6005,15 @@ class ProjectsApi(object):
5368
6005
  Modify an analysis.
5369
6006
  This method makes a synchronous HTTP request by default.
5370
6007
 
5371
- :param str cid: (required)
5372
- :param str analysis_id: (required)
5373
- :param AnalysisModifyInput body: (required)
5374
- :param bool async_: Perform the request asynchronously
5375
- :return: ModifiedResult
6008
+ :param cid:
6009
+ :type cid: str
6010
+ :param analysis_id:
6011
+ :type analysis_id: str
6012
+ :param body:
6013
+ :type body: AnalysisModifyInput
6014
+ :param async_: Perform the request asynchronously
6015
+ :type async_: bool, optional
6016
+ :rtype: ModifiedResult
5376
6017
  """
5377
6018
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5378
6019
  kwargs['_return_http_data_only'] = True
@@ -5396,11 +6037,15 @@ class ProjectsApi(object):
5396
6037
  Modify an analysis.
5397
6038
  This method makes a synchronous HTTP request by default.
5398
6039
 
5399
- :param str cid: (required)
5400
- :param str analysis_id: (required)
5401
- :param AnalysisModifyInput body: (required)
5402
- :param bool async_: Perform the request asynchronously
5403
- :return: ModifiedResult
6040
+ :param cid:
6041
+ :type cid: str
6042
+ :param analysis_id:
6043
+ :type analysis_id: str
6044
+ :param body:
6045
+ :type body: AnalysisModifyInput
6046
+ :param async_: Perform the request asynchronously
6047
+ :type async_: bool, optional
6048
+ :rtype: ModifiedResult
5404
6049
  """
5405
6050
 
5406
6051
  all_params = ['cid','analysis_id','body',] # noqa: E501
@@ -5492,11 +6137,15 @@ class ProjectsApi(object):
5492
6137
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
5493
6138
  This method makes a synchronous HTTP request by default.
5494
6139
 
5495
- :param str cid: (required)
5496
- :param str filename: (required)
5497
- :param FileModifyInput body: (required)
5498
- :param bool async_: Perform the request asynchronously
5499
- :return: ModifiedResult
6140
+ :param cid:
6141
+ :type cid: str
6142
+ :param filename:
6143
+ :type filename: str
6144
+ :param body:
6145
+ :type body: FileModifyInput
6146
+ :param async_: Perform the request asynchronously
6147
+ :type async_: bool, optional
6148
+ :rtype: ModifiedResult
5500
6149
  """
5501
6150
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5502
6151
  kwargs['_return_http_data_only'] = True
@@ -5520,11 +6169,15 @@ class ProjectsApi(object):
5520
6169
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
5521
6170
  This method makes a synchronous HTTP request by default.
5522
6171
 
5523
- :param str cid: (required)
5524
- :param str filename: (required)
5525
- :param FileModifyInput body: (required)
5526
- :param bool async_: Perform the request asynchronously
5527
- :return: ModifiedResult
6172
+ :param cid:
6173
+ :type cid: str
6174
+ :param filename:
6175
+ :type filename: str
6176
+ :param body:
6177
+ :type body: FileModifyInput
6178
+ :param async_: Perform the request asynchronously
6179
+ :type async_: bool, optional
6180
+ :rtype: ModifiedResult
5528
6181
  """
5529
6182
 
5530
6183
  all_params = ['cid','filename','body',] # noqa: E501
@@ -5616,11 +6269,15 @@ class ProjectsApi(object):
5616
6269
  If replacing a file's classification, the modality can optionally be modified as well.
5617
6270
  This method makes a synchronous HTTP request by default.
5618
6271
 
5619
- :param str cid: (required)
5620
- :param str filename: (required)
5621
- :param FileClassificationDelta body: (required)
5622
- :param bool async_: Perform the request asynchronously
5623
- :return: ModifiedResult
6272
+ :param cid:
6273
+ :type cid: str
6274
+ :param filename:
6275
+ :type filename: str
6276
+ :param body:
6277
+ :type body: FileClassificationDelta
6278
+ :param async_: Perform the request asynchronously
6279
+ :type async_: bool, optional
6280
+ :rtype: ModifiedResult
5624
6281
  """
5625
6282
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5626
6283
  kwargs['_return_http_data_only'] = True
@@ -5644,11 +6301,15 @@ class ProjectsApi(object):
5644
6301
  If replacing a file's classification, the modality can optionally be modified as well.
5645
6302
  This method makes a synchronous HTTP request by default.
5646
6303
 
5647
- :param str cid: (required)
5648
- :param str filename: (required)
5649
- :param FileClassificationDelta body: (required)
5650
- :param bool async_: Perform the request asynchronously
5651
- :return: ModifiedResult
6304
+ :param cid:
6305
+ :type cid: str
6306
+ :param filename:
6307
+ :type filename: str
6308
+ :param body:
6309
+ :type body: FileClassificationDelta
6310
+ :param async_: Perform the request asynchronously
6311
+ :type async_: bool, optional
6312
+ :rtype: ModifiedResult
5652
6313
  """
5653
6314
 
5654
6315
  all_params = ['cid','filename','body',] # noqa: E501
@@ -5740,11 +6401,15 @@ class ProjectsApi(object):
5740
6401
  Modify and return the file 'info' field
5741
6402
  This method makes a synchronous HTTP request by default.
5742
6403
 
5743
- :param str cid: (required)
5744
- :param str filename: (required)
5745
- :param Info body: (required)
5746
- :param bool async_: Perform the request asynchronously
5747
- :return: ModifiedResult
6404
+ :param cid:
6405
+ :type cid: str
6406
+ :param filename:
6407
+ :type filename: str
6408
+ :param body:
6409
+ :type body: Info
6410
+ :param async_: Perform the request asynchronously
6411
+ :type async_: bool, optional
6412
+ :rtype: ModifiedResult
5748
6413
  """
5749
6414
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5750
6415
  kwargs['_return_http_data_only'] = True
@@ -5768,11 +6433,15 @@ class ProjectsApi(object):
5768
6433
  Modify and return the file 'info' field
5769
6434
  This method makes a synchronous HTTP request by default.
5770
6435
 
5771
- :param str cid: (required)
5772
- :param str filename: (required)
5773
- :param Info body: (required)
5774
- :param bool async_: Perform the request asynchronously
5775
- :return: ModifiedResult
6436
+ :param cid:
6437
+ :type cid: str
6438
+ :param filename:
6439
+ :type filename: str
6440
+ :param body:
6441
+ :type body: Info
6442
+ :param async_: Perform the request asynchronously
6443
+ :type async_: bool, optional
6444
+ :rtype: ModifiedResult
5776
6445
  """
5777
6446
 
5778
6447
  all_params = ['cid','filename','body',] # noqa: E501
@@ -5864,10 +6533,13 @@ class ProjectsApi(object):
5864
6533
  Update or replace info for a(n) project. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
5865
6534
  This method makes a synchronous HTTP request by default.
5866
6535
 
5867
- :param str cid: (required)
5868
- :param Info body: (required)
5869
- :param bool async_: Perform the request asynchronously
5870
- :return: ModifiedResult
6536
+ :param cid:
6537
+ :type cid: str
6538
+ :param body:
6539
+ :type body: Info
6540
+ :param async_: Perform the request asynchronously
6541
+ :type async_: bool, optional
6542
+ :rtype: ModifiedResult
5871
6543
  """
5872
6544
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5873
6545
  kwargs['_return_http_data_only'] = True
@@ -5891,10 +6563,13 @@ class ProjectsApi(object):
5891
6563
  Update or replace info for a(n) project. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
5892
6564
  This method makes a synchronous HTTP request by default.
5893
6565
 
5894
- :param str cid: (required)
5895
- :param Info body: (required)
5896
- :param bool async_: Perform the request asynchronously
5897
- :return: ModifiedResult
6566
+ :param cid:
6567
+ :type cid: str
6568
+ :param body:
6569
+ :type body: Info
6570
+ :param async_: Perform the request asynchronously
6571
+ :type async_: bool, optional
6572
+ :rtype: ModifiedResult
5898
6573
  """
5899
6574
 
5900
6575
  all_params = ['cid','body',] # noqa: E501
@@ -5980,11 +6655,15 @@ class ProjectsApi(object):
5980
6655
  Update a note of a(n) project
5981
6656
  This method makes a synchronous HTTP request by default.
5982
6657
 
5983
- :param str cid: (required)
5984
- :param str note_id: (required)
5985
- :param NoteInput body: (required)
5986
- :param bool async_: Perform the request asynchronously
5987
- :return: int
6658
+ :param cid:
6659
+ :type cid: str
6660
+ :param note_id:
6661
+ :type note_id: str
6662
+ :param body:
6663
+ :type body: NoteInput
6664
+ :param async_: Perform the request asynchronously
6665
+ :type async_: bool, optional
6666
+ :rtype: int
5988
6667
  """
5989
6668
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
5990
6669
  kwargs['_return_http_data_only'] = True
@@ -6008,11 +6687,15 @@ class ProjectsApi(object):
6008
6687
  Update a note of a(n) project
6009
6688
  This method makes a synchronous HTTP request by default.
6010
6689
 
6011
- :param str cid: (required)
6012
- :param str note_id: (required)
6013
- :param NoteInput body: (required)
6014
- :param bool async_: Perform the request asynchronously
6015
- :return: int
6690
+ :param cid:
6691
+ :type cid: str
6692
+ :param note_id:
6693
+ :type note_id: str
6694
+ :param body:
6695
+ :type body: NoteInput
6696
+ :param async_: Perform the request asynchronously
6697
+ :type async_: bool, optional
6698
+ :rtype: int
6016
6699
  """
6017
6700
 
6018
6701
  all_params = ['cid','note_id','body',] # noqa: E501
@@ -6104,11 +6787,15 @@ class ProjectsApi(object):
6104
6787
  Update a rule on a project.
6105
6788
  This method makes a synchronous HTTP request by default.
6106
6789
 
6107
- :param str project_id: (required)
6108
- :param str rule_id: (required)
6109
- :param GearRuleModifyInput body: (required)
6110
- :param bool async_: Perform the request asynchronously
6111
- :return: GearRuleOutput
6790
+ :param project_id:
6791
+ :type project_id: str
6792
+ :param rule_id:
6793
+ :type rule_id: str
6794
+ :param body:
6795
+ :type body: GearRuleModifyInput
6796
+ :param async_: Perform the request asynchronously
6797
+ :type async_: bool, optional
6798
+ :rtype: GearRuleOutput
6112
6799
  """
6113
6800
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6114
6801
  kwargs['_return_http_data_only'] = True
@@ -6132,11 +6819,15 @@ class ProjectsApi(object):
6132
6819
  Update a rule on a project.
6133
6820
  This method makes a synchronous HTTP request by default.
6134
6821
 
6135
- :param str project_id: (required)
6136
- :param str rule_id: (required)
6137
- :param GearRuleModifyInput body: (required)
6138
- :param bool async_: Perform the request asynchronously
6139
- :return: GearRuleOutput
6822
+ :param project_id:
6823
+ :type project_id: str
6824
+ :param rule_id:
6825
+ :type rule_id: str
6826
+ :param body:
6827
+ :type body: GearRuleModifyInput
6828
+ :param async_: Perform the request asynchronously
6829
+ :type async_: bool, optional
6830
+ :rtype: GearRuleOutput
6140
6831
  """
6141
6832
 
6142
6833
  all_params = ['project_id','rule_id','body',] # noqa: E501
@@ -6228,11 +6919,15 @@ class ProjectsApi(object):
6228
6919
  Route for modifying settings for a a(n) project
6229
6920
  This method makes a synchronous HTTP request by default.
6230
6921
 
6231
- :param str project_id: (required)
6232
- :param ProjectSettingsInput body: (required)
6233
- :param list[union[HeaderFeature,str]] x_accept_feature:
6234
- :param bool async_: Perform the request asynchronously
6235
- :return: ProjectSettingsOutput
6922
+ :param project_id:
6923
+ :type project_id: str
6924
+ :param body:
6925
+ :type body: ProjectSettingsInput
6926
+ :param x_accept_feature:, defaults to []
6927
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
6928
+ :param async_: Perform the request asynchronously
6929
+ :type async_: bool, optional
6930
+ :rtype: ProjectSettingsOutput
6236
6931
  """
6237
6932
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6238
6933
  kwargs['_return_http_data_only'] = True
@@ -6256,11 +6951,15 @@ class ProjectsApi(object):
6256
6951
  Route for modifying settings for a a(n) project
6257
6952
  This method makes a synchronous HTTP request by default.
6258
6953
 
6259
- :param str project_id: (required)
6260
- :param ProjectSettingsInput body: (required)
6261
- :param list[union[HeaderFeature,str]] x_accept_feature:
6262
- :param bool async_: Perform the request asynchronously
6263
- :return: ProjectSettingsOutput
6954
+ :param project_id:
6955
+ :type project_id: str
6956
+ :param body:
6957
+ :type body: ProjectSettingsInput
6958
+ :param x_accept_feature:, defaults to []
6959
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
6960
+ :param async_: Perform the request asynchronously
6961
+ :type async_: bool, optional
6962
+ :rtype: ProjectSettingsOutput
6264
6963
  """
6265
6964
 
6266
6965
  all_params = ['project_id','body','x_accept_feature',] # noqa: E501
@@ -6349,12 +7048,17 @@ class ProjectsApi(object):
6349
7048
  Update a user's permission for this project.
6350
7049
  This method makes a synchronous HTTP request by default.
6351
7050
 
6352
- :param str project_id: (required)
6353
- :param str uid: (required)
6354
- :param RolePermissionUpdate body: (required)
6355
- :param list[union[HeaderFeature,str]] x_accept_feature:
6356
- :param bool async_: Perform the request asynchronously
6357
- :return: RolePermissionOutput
7051
+ :param project_id:
7052
+ :type project_id: str
7053
+ :param uid:
7054
+ :type uid: str
7055
+ :param body:
7056
+ :type body: RolePermissionUpdate
7057
+ :param x_accept_feature:, defaults to []
7058
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
7059
+ :param async_: Perform the request asynchronously
7060
+ :type async_: bool, optional
7061
+ :rtype: RolePermissionOutput
6358
7062
  """
6359
7063
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6360
7064
  kwargs['_return_http_data_only'] = True
@@ -6378,12 +7082,17 @@ class ProjectsApi(object):
6378
7082
  Update a user's permission for this project.
6379
7083
  This method makes a synchronous HTTP request by default.
6380
7084
 
6381
- :param str project_id: (required)
6382
- :param str uid: (required)
6383
- :param RolePermissionUpdate body: (required)
6384
- :param list[union[HeaderFeature,str]] x_accept_feature:
6385
- :param bool async_: Perform the request asynchronously
6386
- :return: RolePermissionOutput
7085
+ :param project_id:
7086
+ :type project_id: str
7087
+ :param uid:
7088
+ :type uid: str
7089
+ :param body:
7090
+ :type body: RolePermissionUpdate
7091
+ :param x_accept_feature:, defaults to []
7092
+ :type x_accept_feature: list[union[HeaderFeature,str]], optional
7093
+ :param async_: Perform the request asynchronously
7094
+ :type async_: bool, optional
7095
+ :rtype: RolePermissionOutput
6387
7096
  """
6388
7097
 
6389
7098
  all_params = ['project_id','uid','body','x_accept_feature',] # noqa: E501
@@ -6478,10 +7187,13 @@ class ProjectsApi(object):
6478
7187
  Copy a project and its descendants to a new project tree
6479
7188
  This method makes a synchronous HTTP request by default.
6480
7189
 
6481
- :param str project_id: (required)
6482
- :param ProjectCopyInput body: (required)
6483
- :param bool async_: Perform the request asynchronously
6484
- :return: ProjectCopyOutput
7190
+ :param project_id:
7191
+ :type project_id: str
7192
+ :param body:
7193
+ :type body: ProjectCopyInput
7194
+ :param async_: Perform the request asynchronously
7195
+ :type async_: bool, optional
7196
+ :rtype: ProjectCopyOutput
6485
7197
  """
6486
7198
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6487
7199
  kwargs['_return_http_data_only'] = True
@@ -6505,10 +7217,13 @@ class ProjectsApi(object):
6505
7217
  Copy a project and its descendants to a new project tree
6506
7218
  This method makes a synchronous HTTP request by default.
6507
7219
 
6508
- :param str project_id: (required)
6509
- :param ProjectCopyInput body: (required)
6510
- :param bool async_: Perform the request asynchronously
6511
- :return: ProjectCopyOutput
7220
+ :param project_id:
7221
+ :type project_id: str
7222
+ :param body:
7223
+ :type body: ProjectCopyInput
7224
+ :param async_: Perform the request asynchronously
7225
+ :type async_: bool, optional
7226
+ :rtype: ProjectCopyOutput
6512
7227
  """
6513
7228
 
6514
7229
  all_params = ['project_id','body',] # noqa: E501
@@ -6593,11 +7308,15 @@ class ProjectsApi(object):
6593
7308
 
6594
7309
  This method makes a synchronous HTTP request by default.
6595
7310
 
6596
- :param str project_id: (required)
6597
- :param str token: (required)
6598
- :param str file: (required)
6599
- :param bool async_: Perform the request asynchronously
6600
- :return: list[FileOutput]
7311
+ :param project_id:
7312
+ :type project_id: str
7313
+ :param token:
7314
+ :type token: str
7315
+ :param file:
7316
+ :type file: str
7317
+ :param async_: Perform the request asynchronously
7318
+ :type async_: bool, optional
7319
+ :rtype: list[FileOutput]
6601
7320
  """
6602
7321
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6603
7322
  kwargs['_return_http_data_only'] = True
@@ -6620,11 +7339,15 @@ class ProjectsApi(object):
6620
7339
 
6621
7340
  This method makes a synchronous HTTP request by default.
6622
7341
 
6623
- :param str project_id: (required)
6624
- :param str token: (required)
6625
- :param str file: (required)
6626
- :param bool async_: Perform the request asynchronously
6627
- :return: list[FileOutput]
7342
+ :param project_id:
7343
+ :type project_id: str
7344
+ :param token:
7345
+ :type token: str
7346
+ :param file:
7347
+ :type file: str
7348
+ :param async_: Perform the request asynchronously
7349
+ :type async_: bool, optional
7350
+ :rtype: list[FileOutput]
6628
7351
  """
6629
7352
 
6630
7353
  all_params = ['project_id','token','file',] # noqa: E501
@@ -6709,8 +7432,9 @@ class ProjectsApi(object):
6709
7432
  Iterates all projects that have a session template. Recalculate if projects' sessions satisfy the template. Returns list of modified session ids.
6710
7433
  This method makes a synchronous HTTP request by default.
6711
7434
 
6712
- :param bool async_: Perform the request asynchronously
6713
- :return: SessionTemplateRecalcOutput
7435
+ :param async_: Perform the request asynchronously
7436
+ :type async_: bool, optional
7437
+ :rtype: SessionTemplateRecalcOutput
6714
7438
  """
6715
7439
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6716
7440
  kwargs['_return_http_data_only'] = True
@@ -6734,8 +7458,9 @@ class ProjectsApi(object):
6734
7458
  Iterates all projects that have a session template. Recalculate if projects' sessions satisfy the template. Returns list of modified session ids.
6735
7459
  This method makes a synchronous HTTP request by default.
6736
7460
 
6737
- :param bool async_: Perform the request asynchronously
6738
- :return: SessionTemplateRecalcOutput
7461
+ :param async_: Perform the request asynchronously
7462
+ :type async_: bool, optional
7463
+ :rtype: SessionTemplateRecalcOutput
6739
7464
  """
6740
7465
 
6741
7466
  all_params = [] # noqa: E501
@@ -6798,9 +7523,11 @@ class ProjectsApi(object):
6798
7523
  Currently does nothing--will eventually calculate if sessions in the project satisfy the template.
6799
7524
  This method makes a synchronous HTTP request by default.
6800
7525
 
6801
- :param str project_id: (required)
6802
- :param bool async_: Perform the request asynchronously
6803
- :return: SessionTemplateRecalcOutput
7526
+ :param project_id:
7527
+ :type project_id: str
7528
+ :param async_: Perform the request asynchronously
7529
+ :type async_: bool, optional
7530
+ :rtype: SessionTemplateRecalcOutput
6804
7531
  """
6805
7532
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6806
7533
  kwargs['_return_http_data_only'] = True
@@ -6824,9 +7551,11 @@ class ProjectsApi(object):
6824
7551
  Currently does nothing--will eventually calculate if sessions in the project satisfy the template.
6825
7552
  This method makes a synchronous HTTP request by default.
6826
7553
 
6827
- :param str project_id: (required)
6828
- :param bool async_: Perform the request asynchronously
6829
- :return: SessionTemplateRecalcOutput
7554
+ :param project_id:
7555
+ :type project_id: str
7556
+ :param async_: Perform the request asynchronously
7557
+ :type async_: bool, optional
7558
+ :rtype: SessionTemplateRecalcOutput
6830
7559
  """
6831
7560
 
6832
7561
  all_params = ['project_id',] # noqa: E501
@@ -6894,10 +7623,13 @@ class ProjectsApi(object):
6894
7623
 
6895
7624
  This method makes a synchronous HTTP request by default.
6896
7625
 
6897
- :param str project_id: (required)
6898
- :param str rule_id: (required)
6899
- :param bool async_: Perform the request asynchronously
6900
- :return: None
7626
+ :param project_id:
7627
+ :type project_id: str
7628
+ :param rule_id:
7629
+ :type rule_id: str
7630
+ :param async_: Perform the request asynchronously
7631
+ :type async_: bool, optional
7632
+ :rtype: None
6901
7633
  """
6902
7634
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
6903
7635
  kwargs['_return_http_data_only'] = True
@@ -6920,10 +7652,13 @@ class ProjectsApi(object):
6920
7652
 
6921
7653
  This method makes a synchronous HTTP request by default.
6922
7654
 
6923
- :param str project_id: (required)
6924
- :param str rule_id: (required)
6925
- :param bool async_: Perform the request asynchronously
6926
- :return: None
7655
+ :param project_id:
7656
+ :type project_id: str
7657
+ :param rule_id:
7658
+ :type rule_id: str
7659
+ :param async_: Perform the request asynchronously
7660
+ :type async_: bool, optional
7661
+ :rtype: None
6927
7662
  """
6928
7663
 
6929
7664
  all_params = ['project_id','rule_id',] # noqa: E501
@@ -6997,9 +7732,11 @@ class ProjectsApi(object):
6997
7732
 
6998
7733
  This method makes a synchronous HTTP request by default.
6999
7734
 
7000
- :param str project_id: (required)
7001
- :param bool async_: Perform the request asynchronously
7002
- :return: DeletedResult
7735
+ :param project_id:
7736
+ :type project_id: str
7737
+ :param async_: Perform the request asynchronously
7738
+ :type async_: bool, optional
7739
+ :rtype: DeletedResult
7003
7740
  """
7004
7741
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7005
7742
  kwargs['_return_http_data_only'] = True
@@ -7022,9 +7759,11 @@ class ProjectsApi(object):
7022
7759
 
7023
7760
  This method makes a synchronous HTTP request by default.
7024
7761
 
7025
- :param str project_id: (required)
7026
- :param bool async_: Perform the request asynchronously
7027
- :return: DeletedResult
7762
+ :param project_id:
7763
+ :type project_id: str
7764
+ :param async_: Perform the request asynchronously
7765
+ :type async_: bool, optional
7766
+ :rtype: DeletedResult
7028
7767
  """
7029
7768
 
7030
7769
  all_params = ['project_id',] # noqa: E501
@@ -7093,11 +7832,15 @@ class ProjectsApi(object):
7093
7832
  Rename a tag
7094
7833
  This method makes a synchronous HTTP request by default.
7095
7834
 
7096
- :param str cid: (required)
7097
- :param str value: The tag to interact with (required)
7098
- :param Tag body: (required)
7099
- :param bool async_: Perform the request asynchronously
7100
- :return: str
7835
+ :param cid:
7836
+ :type cid: str
7837
+ :param value: The tag to interact with
7838
+ :type value: str
7839
+ :param body:
7840
+ :type body: Tag
7841
+ :param async_: Perform the request asynchronously
7842
+ :type async_: bool, optional
7843
+ :rtype: str
7101
7844
  """
7102
7845
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7103
7846
  kwargs['_return_http_data_only'] = True
@@ -7121,11 +7864,15 @@ class ProjectsApi(object):
7121
7864
  Rename a tag
7122
7865
  This method makes a synchronous HTTP request by default.
7123
7866
 
7124
- :param str cid: (required)
7125
- :param str value: The tag to interact with (required)
7126
- :param Tag body: (required)
7127
- :param bool async_: Perform the request asynchronously
7128
- :return: str
7867
+ :param cid:
7868
+ :type cid: str
7869
+ :param value: The tag to interact with
7870
+ :type value: str
7871
+ :param body:
7872
+ :type body: Tag
7873
+ :param async_: Perform the request asynchronously
7874
+ :type async_: bool, optional
7875
+ :rtype: str
7129
7876
  """
7130
7877
 
7131
7878
  all_params = ['cid','value','body',] # noqa: E501
@@ -7216,10 +7963,13 @@ class ProjectsApi(object):
7216
7963
 
7217
7964
  This method makes a synchronous HTTP request by default.
7218
7965
 
7219
- :param str project_id: (required)
7220
- :param ProjectTemplateListInput body: (required)
7221
- :param bool async_: Perform the request asynchronously
7222
- :return: ModifiedResult
7966
+ :param project_id:
7967
+ :type project_id: str
7968
+ :param body:
7969
+ :type body: ProjectTemplateListInput
7970
+ :param async_: Perform the request asynchronously
7971
+ :type async_: bool, optional
7972
+ :rtype: ModifiedResult
7223
7973
  """
7224
7974
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7225
7975
  kwargs['_return_http_data_only'] = True
@@ -7242,10 +7992,13 @@ class ProjectsApi(object):
7242
7992
 
7243
7993
  This method makes a synchronous HTTP request by default.
7244
7994
 
7245
- :param str project_id: (required)
7246
- :param ProjectTemplateListInput body: (required)
7247
- :param bool async_: Perform the request asynchronously
7248
- :return: ModifiedResult
7995
+ :param project_id:
7996
+ :type project_id: str
7997
+ :param body:
7998
+ :type body: ProjectTemplateListInput
7999
+ :param async_: Perform the request asynchronously
8000
+ :type async_: bool, optional
8001
+ :rtype: ModifiedResult
7249
8002
  """
7250
8003
 
7251
8004
  all_params = ['project_id','body',] # noqa: E501
@@ -7330,9 +8083,11 @@ class ProjectsApi(object):
7330
8083
 
7331
8084
  This method makes a synchronous HTTP request by default.
7332
8085
 
7333
- :param str project_id: (required)
7334
- :param bool async_: Perform the request asynchronously
7335
- :return: UploadTokenOutput
8086
+ :param project_id:
8087
+ :type project_id: str
8088
+ :param async_: Perform the request asynchronously
8089
+ :type async_: bool, optional
8090
+ :rtype: UploadTokenOutput
7336
8091
  """
7337
8092
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7338
8093
  kwargs['_return_http_data_only'] = True
@@ -7355,9 +8110,11 @@ class ProjectsApi(object):
7355
8110
 
7356
8111
  This method makes a synchronous HTTP request by default.
7357
8112
 
7358
- :param str project_id: (required)
7359
- :param bool async_: Perform the request asynchronously
7360
- :return: UploadTokenOutput
8113
+ :param project_id:
8114
+ :type project_id: str
8115
+ :param async_: Perform the request asynchronously
8116
+ :type async_: bool, optional
8117
+ :rtype: UploadTokenOutput
7361
8118
  """
7362
8119
 
7363
8120
  all_params = ['project_id',] # noqa: E501
@@ -7426,18 +8183,29 @@ class ProjectsApi(object):
7426
8183
  Upload a file to a(n) project.
7427
8184
  This method makes a synchronous HTTP request by default.
7428
8185
 
7429
- :param str container_id: (required)
7430
- :param str file: The file to upload (required)
7431
- :param bool preserve_metadata:
7432
- :param str ticket:
7433
- :param str id:
7434
- :param ContainerType level:
7435
- :param str job:
7436
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
7437
- :param list[str] x_accept_feature: redirect header
7438
- :param str content_type:
7439
- :param bool async_: Perform the request asynchronously
7440
- :return: union[list[FileOutput],UploadTicketOutput]
8186
+ :param container_id:
8187
+ :type container_id: str
8188
+ :param file: The file to upload
8189
+ :type file: str
8190
+ :param preserve_metadata:, defaults to false
8191
+ :type preserve_metadata: bool, optional
8192
+ :param ticket:
8193
+ :type ticket: str, optional
8194
+ :param id:
8195
+ :type id: str, optional
8196
+ :param level:
8197
+ :type level: ContainerType, optional
8198
+ :param job:
8199
+ :type job: str, optional
8200
+ :param metadata: Dictionary of file metadata (type, modality, info, etc.)
8201
+ :type metadata: object, optional
8202
+ :param x_accept_feature: redirect header, defaults to []
8203
+ :type x_accept_feature: list[str], optional
8204
+ :param content_type:
8205
+ :type content_type: str, optional
8206
+ :param async_: Perform the request asynchronously
8207
+ :type async_: bool, optional
8208
+ :rtype: union[list[FileOutput],UploadTicketOutput]
7441
8209
  """
7442
8210
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7443
8211
  kwargs['_return_http_data_only'] = True
@@ -7461,18 +8229,29 @@ class ProjectsApi(object):
7461
8229
  Upload a file to a(n) project.
7462
8230
  This method makes a synchronous HTTP request by default.
7463
8231
 
7464
- :param str container_id: (required)
7465
- :param str file: The file to upload (required)
7466
- :param bool preserve_metadata:
7467
- :param str ticket:
7468
- :param str id:
7469
- :param ContainerType level:
7470
- :param str job:
7471
- :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
7472
- :param list[str] x_accept_feature: redirect header
7473
- :param str content_type:
7474
- :param bool async_: Perform the request asynchronously
7475
- :return: union[list[FileOutput],UploadTicketOutput]
8232
+ :param container_id:
8233
+ :type container_id: str
8234
+ :param file: The file to upload
8235
+ :type file: str
8236
+ :param preserve_metadata:, defaults to false
8237
+ :type preserve_metadata: bool, optional
8238
+ :param ticket:
8239
+ :type ticket: str, optional
8240
+ :param id:
8241
+ :type id: str, optional
8242
+ :param level:
8243
+ :type level: ContainerType, optional
8244
+ :param job:
8245
+ :type job: str, optional
8246
+ :param metadata: Dictionary of file metadata (type, modality, info, etc.)
8247
+ :type metadata: object, optional
8248
+ :param x_accept_feature: redirect header, defaults to []
8249
+ :type x_accept_feature: list[str], optional
8250
+ :param content_type:
8251
+ :type content_type: str, optional
8252
+ :param async_: Perform the request asynchronously
8253
+ :type async_: bool, optional
8254
+ :rtype: union[list[FileOutput],UploadTicketOutput]
7476
8255
  """
7477
8256
 
7478
8257
  all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
@@ -7568,16 +8347,25 @@ class ProjectsApi(object):
7568
8347
  Upload an output file to an analysis
7569
8348
  This method makes a synchronous HTTP request by default.
7570
8349
 
7571
- :param str cid: (required)
7572
- :param str analysis_id: (required)
7573
- :param str file: The file to upload (required)
7574
- :param str ticket:
7575
- :param str id:
7576
- :param ContainerType level:
7577
- :param str job:
7578
- :param str content_type:
7579
- :param bool async_: Perform the request asynchronously
7580
- :return: list[FileOutput]
8350
+ :param cid:
8351
+ :type cid: str
8352
+ :param analysis_id:
8353
+ :type analysis_id: str
8354
+ :param file: The file to upload
8355
+ :type file: str
8356
+ :param ticket:
8357
+ :type ticket: str, optional
8358
+ :param id:
8359
+ :type id: str, optional
8360
+ :param level:
8361
+ :type level: ContainerType, optional
8362
+ :param job:
8363
+ :type job: str, optional
8364
+ :param content_type:
8365
+ :type content_type: str, optional
8366
+ :param async_: Perform the request asynchronously
8367
+ :type async_: bool, optional
8368
+ :rtype: list[FileOutput]
7581
8369
  """
7582
8370
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7583
8371
  kwargs['_return_http_data_only'] = True
@@ -7601,16 +8389,25 @@ class ProjectsApi(object):
7601
8389
  Upload an output file to an analysis
7602
8390
  This method makes a synchronous HTTP request by default.
7603
8391
 
7604
- :param str cid: (required)
7605
- :param str analysis_id: (required)
7606
- :param str file: The file to upload (required)
7607
- :param str ticket:
7608
- :param str id:
7609
- :param ContainerType level:
7610
- :param str job:
7611
- :param str content_type:
7612
- :param bool async_: Perform the request asynchronously
7613
- :return: list[FileOutput]
8392
+ :param cid:
8393
+ :type cid: str
8394
+ :param analysis_id:
8395
+ :type analysis_id: str
8396
+ :param file: The file to upload
8397
+ :type file: str
8398
+ :param ticket:
8399
+ :type ticket: str, optional
8400
+ :param id:
8401
+ :type id: str, optional
8402
+ :param level:
8403
+ :type level: ContainerType, optional
8404
+ :param job:
8405
+ :type job: str, optional
8406
+ :param content_type:
8407
+ :type content_type: str, optional
8408
+ :param async_: Perform the request asynchronously
8409
+ :type async_: bool, optional
8410
+ :rtype: list[FileOutput]
7614
8411
  """
7615
8412
 
7616
8413
  all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501
@@ -7705,11 +8502,15 @@ class ProjectsApi(object):
7705
8502
  Create, update or just return an existing container sub-hierarchy as-is for the given project. Useful for efficient and highly parallel automated imports using device authN, based on common routing fields such as id, uid and label.
7706
8503
  This method makes a synchronous HTTP request by default.
7707
8504
 
7708
- :param str project_id: (required)
7709
- :param ProjectHierarchyInput body: (required)
7710
- :param str uid_scope:
7711
- :param bool async_: Perform the request asynchronously
7712
- :return: ProjectHierarchyOutput
8505
+ :param project_id:
8506
+ :type project_id: str
8507
+ :param body:
8508
+ :type body: ProjectHierarchyInput
8509
+ :param uid_scope:
8510
+ :type uid_scope: str, optional
8511
+ :param async_: Perform the request asynchronously
8512
+ :type async_: bool, optional
8513
+ :rtype: ProjectHierarchyOutput
7713
8514
  """
7714
8515
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
7715
8516
  kwargs['_return_http_data_only'] = True
@@ -7733,11 +8534,15 @@ class ProjectsApi(object):
7733
8534
  Create, update or just return an existing container sub-hierarchy as-is for the given project. Useful for efficient and highly parallel automated imports using device authN, based on common routing fields such as id, uid and label.
7734
8535
  This method makes a synchronous HTTP request by default.
7735
8536
 
7736
- :param str project_id: (required)
7737
- :param ProjectHierarchyInput body: (required)
7738
- :param str uid_scope:
7739
- :param bool async_: Perform the request asynchronously
7740
- :return: ProjectHierarchyOutput
8537
+ :param project_id:
8538
+ :type project_id: str
8539
+ :param body:
8540
+ :type body: ProjectHierarchyInput
8541
+ :param uid_scope:
8542
+ :type uid_scope: str, optional
8543
+ :param async_: Perform the request asynchronously
8544
+ :type async_: bool, optional
8545
+ :rtype: ProjectHierarchyOutput
7741
8546
  """
7742
8547
 
7743
8548
  all_params = ['project_id','body','uid_scope',] # noqa: E501