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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (532) hide show
  1. flywheel/api/acquisitions_api.py +562 -1033
  2. flywheel/api/analyses_api.py +425 -786
  3. flywheel/api/audit_trail_api.py +44 -78
  4. flywheel/api/auth_api.py +4 -6
  5. flywheel/api/batch_api.py +36 -60
  6. flywheel/api/bulk_api.py +6 -10
  7. flywheel/api/change_log_api.py +22 -40
  8. flywheel/api/collections_api.py +403 -740
  9. flywheel/api/config_api.py +12 -18
  10. flywheel/api/container_tasks_api.py +8 -14
  11. flywheel/api/container_type_api.py +8 -14
  12. flywheel/api/containers_api.py +538 -989
  13. flywheel/api/custom_filters_api.py +36 -64
  14. flywheel/api/data_view_executions_api.py +52 -94
  15. flywheel/api/dataexplorer_api.py +90 -158
  16. flywheel/api/devices_api.py +76 -132
  17. flywheel/api/dimse_api.py +44 -72
  18. flywheel/api/download_api.py +25 -46
  19. flywheel/api/files_api.py +150 -266
  20. flywheel/api/form_responses_api.py +56 -100
  21. flywheel/api/gears_api.py +156 -278
  22. flywheel/api/groups_api.py +238 -426
  23. flywheel/api/jobs_api.py +166 -288
  24. flywheel/api/jupyterlab_servers_api.py +14 -24
  25. flywheel/api/modalities_api.py +44 -78
  26. flywheel/api/packfiles_api.py +4 -6
  27. flywheel/api/projects_api.py +854 -1565
  28. flywheel/api/protocols_api.py +54 -94
  29. flywheel/api/reports_api.py +108 -196
  30. flywheel/api/resolve_api.py +26 -48
  31. flywheel/api/roles_api.py +46 -82
  32. flywheel/api/sessions_api.py +616 -1137
  33. flywheel/api/site_api.py +106 -182
  34. flywheel/api/staffing_pools_api.py +50 -88
  35. flywheel/api/subjects_api.py +596 -1095
  36. flywheel/api/tasks_api.py +62 -108
  37. flywheel/api/tree_api.py +28 -52
  38. flywheel/api/uids_api.py +6 -10
  39. flywheel/api/upload_api.py +88 -162
  40. flywheel/api/users_api.py +228 -418
  41. flywheel/api/views_api.py +120 -222
  42. flywheel/api_client.py +1 -1
  43. flywheel/configuration.py +2 -2
  44. flywheel/flywheel.py +4422 -811
  45. flywheel/models/access_permission.py +7 -13
  46. flywheel/models/access_permission_output.py +7 -13
  47. flywheel/models/access_permission_update.py +4 -8
  48. flywheel/models/acquisition_copy_input.py +10 -18
  49. flywheel/models/acquisition_input.py +19 -33
  50. flywheel/models/acquisition_list_output.py +70 -118
  51. flywheel/models/acquisition_modify_input.py +19 -33
  52. flywheel/models/acquisition_output.py +70 -118
  53. flywheel/models/acquisition_parents.py +13 -23
  54. flywheel/models/acquisition_template_options.py +16 -28
  55. flywheel/models/acquisition_upsert_input.py +28 -48
  56. flywheel/models/acquisition_upsert_output.py +13 -23
  57. flywheel/models/adhoc_analysis_input.py +13 -23
  58. flywheel/models/analysis_files_create_ticket_output.py +13 -23
  59. flywheel/models/analysis_input.py +19 -33
  60. flywheel/models/analysis_list_output.py +61 -103
  61. flywheel/models/analysis_list_output_inflated_job.py +58 -98
  62. flywheel/models/analysis_modify_input.py +7 -13
  63. flywheel/models/analysis_output.py +61 -103
  64. flywheel/models/analysis_output_inflated_job.py +61 -103
  65. flywheel/models/analysis_parents.py +16 -28
  66. flywheel/models/api_key_input_with_optional_label.py +7 -13
  67. flywheel/models/api_key_output.py +19 -33
  68. flywheel/models/as_storage.py +19 -33
  69. flywheel/models/assignee.py +7 -13
  70. flywheel/models/audit_trail_report.py +40 -68
  71. flywheel/models/auth0_auth_out.py +22 -38
  72. flywheel/models/auth0_options_out.py +22 -38
  73. flywheel/models/auth_out.py +19 -33
  74. flywheel/models/auth_session_output.py +16 -28
  75. flywheel/models/avatars.py +10 -18
  76. flywheel/models/aws_creds.py +7 -13
  77. flywheel/models/aws_storage.py +25 -43
  78. flywheel/models/azure_creds.py +7 -13
  79. flywheel/models/base_aet.py +13 -23
  80. flywheel/models/base_compute.py +34 -58
  81. flywheel/models/batch.py +25 -43
  82. flywheel/models/batch_create_filters.py +10 -18
  83. flywheel/models/batch_job_analysis_input.py +16 -28
  84. flywheel/models/bookmark.py +7 -13
  85. flywheel/models/bulk_move_input.py +16 -28
  86. flywheel/models/cancelled_batch_output.py +4 -8
  87. flywheel/models/catalog_list_output.py +31 -53
  88. flywheel/models/central_out.py +19 -33
  89. flywheel/models/change.py +31 -53
  90. flywheel/models/change_log_document.py +13 -23
  91. flywheel/models/classic_batch_job_output.py +25 -43
  92. flywheel/models/classic_batch_job_output_inflated_jobs.py +28 -48
  93. flywheel/models/classic_batch_proposal_input.py +28 -48
  94. flywheel/models/classic_batch_proposal_output.py +37 -63
  95. flywheel/models/collection_input.py +10 -18
  96. flywheel/models/collection_input_with_contents.py +13 -23
  97. flywheel/models/collection_node.py +7 -13
  98. flywheel/models/collection_operation.py +7 -13
  99. flywheel/models/collection_output.py +55 -93
  100. flywheel/models/collection_with_stats.py +55 -93
  101. flywheel/models/column.py +16 -28
  102. flywheel/models/common_classification.py +1 -3
  103. flywheel/models/common_info.py +1 -3
  104. flywheel/models/complete_multipart_upload_output.py +7 -13
  105. flywheel/models/complete_s3_multipart_upload_input.py +13 -23
  106. flywheel/models/config_out.py +28 -48
  107. flywheel/models/container_filter.py +7 -13
  108. flywheel/models/container_id_view_input.py +43 -73
  109. flywheel/models/container_id_view_input_execute_and_save.py +19 -33
  110. flywheel/models/container_modify.py +43 -73
  111. flywheel/models/container_node_min.py +25 -43
  112. flywheel/models/container_output_with_files.py +16 -28
  113. flywheel/models/container_parents.py +19 -33
  114. flywheel/models/container_pipeline_input.py +43 -73
  115. flywheel/models/container_reference.py +7 -13
  116. flywheel/models/container_reference_with_label.py +10 -18
  117. flywheel/models/container_uidcheck.py +13 -23
  118. flywheel/models/container_update.py +1 -3
  119. flywheel/models/context_input.py +10 -18
  120. flywheel/models/copy_filter.py +19 -33
  121. flywheel/models/core_models_api_key_api_key_input.py +7 -13
  122. flywheel/models/core_models_audit_trail_create_report_input.py +16 -28
  123. flywheel/models/core_models_audit_trail_modify_report_input.py +4 -8
  124. flywheel/models/core_models_common_source.py +7 -13
  125. flywheel/models/core_models_jobs_api_key_input.py +7 -13
  126. flywheel/models/core_workflows_form_responses_models_form_parents.py +19 -33
  127. flywheel/models/core_workflows_form_responses_models_form_response_output.py +34 -58
  128. flywheel/models/core_workflows_reader_models_reader_task_parents.py +19 -33
  129. flywheel/models/creds.py +1 -3
  130. flywheel/models/curator.py +10 -18
  131. flywheel/models/current_user_output.py +64 -108
  132. flywheel/models/custom_field.py +34 -58
  133. flywheel/models/custom_form.py +13 -23
  134. flywheel/models/cvat_info.py +16 -28
  135. flywheel/models/cvat_settings.py +16 -28
  136. flywheel/models/cvat_settings_input.py +16 -28
  137. flywheel/models/daily_report_usage.py +46 -78
  138. flywheel/models/data_view_analysis_file_spec.py +10 -18
  139. flywheel/models/data_view_analysis_filter_spec.py +10 -18
  140. flywheel/models/data_view_column_alias.py +22 -38
  141. flywheel/models/data_view_column_spec.py +16 -28
  142. flywheel/models/data_view_execution.py +40 -68
  143. flywheel/models/data_view_file_spec.py +28 -48
  144. flywheel/models/data_view_group_by.py +4 -8
  145. flywheel/models/data_view_group_by_column.py +7 -13
  146. flywheel/models/data_view_name_filter_spec.py +7 -13
  147. flywheel/models/data_view_zip_filter_spec.py +10 -18
  148. flywheel/models/delete_by_search_query.py +13 -23
  149. flywheel/models/deleted_file.py +43 -73
  150. flywheel/models/deleted_result.py +10 -18
  151. flywheel/models/device.py +34 -58
  152. flywheel/models/device_admin_update.py +7 -13
  153. flywheel/models/device_create.py +10 -18
  154. flywheel/models/device_self_update.py +16 -28
  155. flywheel/models/device_status_entry.py +10 -18
  156. flywheel/models/device_storage_strategy_update.py +7 -13
  157. flywheel/models/download.py +13 -23
  158. flywheel/models/download_container_filter.py +4 -8
  159. flywheel/models/download_container_filter_definition.py +10 -18
  160. flywheel/models/download_filter.py +10 -18
  161. flywheel/models/download_filter_definition.py +7 -13
  162. flywheel/models/download_node.py +7 -13
  163. flywheel/models/download_ticket_stub.py +13 -23
  164. flywheel/models/e_signature.py +13 -23
  165. flywheel/models/edition.py +4 -8
  166. flywheel/models/egress_device.py +52 -88
  167. flywheel/models/egress_device_page.py +10 -18
  168. flywheel/models/egress_provider.py +31 -53
  169. flywheel/models/egress_provider_id.py +4 -8
  170. flywheel/models/exchange_storage.py +13 -23
  171. flywheel/models/executor_info.py +25 -43
  172. flywheel/models/export_templates.py +7 -13
  173. flywheel/models/features.py +193 -323
  174. flywheel/models/field_change.py +16 -28
  175. flywheel/models/field_change_log_document.py +13 -23
  176. flywheel/models/file.py +112 -188
  177. flywheel/models/file_classification_delta.py +13 -23
  178. flywheel/models/file_entry.py +64 -108
  179. flywheel/models/file_export_templates.py +16 -28
  180. flywheel/models/file_gear_info.py +10 -18
  181. flywheel/models/file_list_output.py +109 -183
  182. flywheel/models/file_modify_input.py +7 -13
  183. flywheel/models/file_move_input.py +10 -18
  184. flywheel/models/file_node.py +112 -188
  185. flywheel/models/file_node_min.py +22 -38
  186. flywheel/models/file_origin.py +16 -28
  187. flywheel/models/file_output.py +109 -183
  188. flywheel/models/file_parents.py +19 -33
  189. flywheel/models/file_reference.py +10 -18
  190. flywheel/models/file_suggestion.py +13 -23
  191. flywheel/models/file_template_options.py +19 -33
  192. flywheel/models/file_upsert_input.py +52 -88
  193. flywheel/models/file_upsert_output.py +112 -188
  194. flywheel/models/file_version.py +7 -13
  195. flywheel/models/file_version_copy_of.py +16 -28
  196. flywheel/models/file_version_output.py +22 -38
  197. flywheel/models/file_via.py +13 -23
  198. flywheel/models/filter.py +25 -43
  199. flywheel/models/filter_input.py +10 -18
  200. flywheel/models/filter_values.py +7 -13
  201. flywheel/models/fixed_file_version_input.py +10 -18
  202. flywheel/models/fixed_input.py +19 -33
  203. flywheel/models/form_definition.py +4 -8
  204. flywheel/models/form_response_base.py +19 -33
  205. flywheel/models/form_response_create.py +7 -13
  206. flywheel/models/gcp_creds.py +31 -53
  207. flywheel/models/gcp_storage.py +19 -33
  208. flywheel/models/gear.py +52 -88
  209. flywheel/models/gear_config.py +1 -3
  210. flywheel/models/gear_context_input.py +4 -8
  211. flywheel/models/gear_context_value_output.py +16 -28
  212. flywheel/models/gear_context_value_output_unfound.py +4 -8
  213. flywheel/models/gear_custom.py +1 -3
  214. flywheel/models/gear_directive.py +1 -3
  215. flywheel/models/gear_document.py +22 -38
  216. flywheel/models/gear_document_input.py +19 -33
  217. flywheel/models/gear_document_legacy_input.py +19 -33
  218. flywheel/models/gear_environment.py +1 -3
  219. flywheel/models/gear_exchange.py +10 -18
  220. flywheel/models/gear_file_input.py +7 -13
  221. flywheel/models/gear_id_output.py +4 -8
  222. flywheel/models/gear_info.py +13 -23
  223. flywheel/models/gear_input_item.py +10 -18
  224. flywheel/models/gear_inputs.py +1 -3
  225. flywheel/models/gear_key_input.py +7 -13
  226. flywheel/models/gear_manifest.py +55 -93
  227. flywheel/models/gear_node.py +25 -43
  228. flywheel/models/gear_output_configuration.py +4 -8
  229. flywheel/models/gear_permissions.py +7 -13
  230. flywheel/models/gear_permissions_input.py +4 -8
  231. flywheel/models/gear_rule.py +61 -103
  232. flywheel/models/gear_rule_condition.py +10 -18
  233. flywheel/models/gear_rule_input.py +46 -78
  234. flywheel/models/gear_rule_modify_input.py +43 -73
  235. flywheel/models/gear_rule_output.py +61 -103
  236. flywheel/models/gear_save_submission.py +10 -18
  237. flywheel/models/gear_series.py +19 -33
  238. flywheel/models/gear_series_update.py +4 -8
  239. flywheel/models/gear_suggestion_output.py +19 -33
  240. flywheel/models/gear_ticket.py +13 -23
  241. flywheel/models/gear_ticket_output.py +4 -8
  242. flywheel/models/graph_filter.py +22 -38
  243. flywheel/models/group_by.py +4 -8
  244. flywheel/models/group_input.py +13 -23
  245. flywheel/models/group_output.py +37 -63
  246. flywheel/models/group_report.py +10 -18
  247. flywheel/models/group_role.py +4 -8
  248. flywheel/models/group_settings_output.py +13 -23
  249. flywheel/models/group_update.py +13 -23
  250. flywheel/models/hierarchy_export_templates.py +16 -28
  251. flywheel/models/http_validation_error.py +4 -8
  252. flywheel/models/info.py +10 -18
  253. flywheel/models/ingress_provider.py +19 -33
  254. flywheel/models/ingress_providers.py +16 -28
  255. flywheel/models/ingress_site_settings.py +16 -28
  256. flywheel/models/ingress_update_provider.py +10 -18
  257. flywheel/models/inline_response200.py +4 -8
  258. flywheel/models/inline_response2001.py +4 -8
  259. flywheel/models/inline_response2002.py +4 -8
  260. flywheel/models/input_filter.py +10 -18
  261. flywheel/models/input_job.py +43 -73
  262. flywheel/models/input_job_profile.py +16 -28
  263. flywheel/models/inserted_id.py +4 -8
  264. flywheel/models/job.py +76 -128
  265. flywheel/models/job_analysis_input.py +16 -28
  266. flywheel/models/job_ask.py +19 -33
  267. flywheel/models/job_ask_response.py +7 -13
  268. flywheel/models/job_ask_response_job.py +94 -158
  269. flywheel/models/job_ask_return_criteria.py +13 -23
  270. flywheel/models/job_ask_state_response.py +4 -8
  271. flywheel/models/job_complete.py +10 -18
  272. flywheel/models/job_config.py +1 -3
  273. flywheel/models/job_config_input.py +16 -28
  274. flywheel/models/job_destination.py +7 -13
  275. flywheel/models/job_detail.py +88 -148
  276. flywheel/models/job_detail_container.py +7 -13
  277. flywheel/models/job_detail_file_entry.py +7 -13
  278. flywheel/models/job_detail_group.py +7 -13
  279. flywheel/models/job_detail_parent_info.py +19 -33
  280. flywheel/models/job_executor_info.py +25 -43
  281. flywheel/models/job_file_input.py +13 -23
  282. flywheel/models/job_file_input_list_output.py +13 -23
  283. flywheel/models/job_file_object.py +34 -58
  284. flywheel/models/job_file_object_list_output.py +31 -53
  285. flywheel/models/job_inputs_array_item.py +19 -33
  286. flywheel/models/job_inputs_item.py +13 -23
  287. flywheel/models/job_inputs_object.py +1 -3
  288. flywheel/models/job_list_output.py +94 -158
  289. flywheel/models/job_list_output_config.py +10 -18
  290. flywheel/models/job_log.py +7 -13
  291. flywheel/models/job_log_record.py +7 -13
  292. flywheel/models/job_modify.py +7 -13
  293. flywheel/models/job_origin.py +7 -13
  294. flywheel/models/job_output.py +97 -163
  295. flywheel/models/job_output_config.py +13 -23
  296. flywheel/models/job_parents.py +19 -33
  297. flywheel/models/job_priority_update.py +7 -13
  298. flywheel/models/job_profile.py +31 -53
  299. flywheel/models/job_request.py +10 -18
  300. flywheel/models/job_request_item.py +13 -23
  301. flywheel/models/job_request_target.py +16 -28
  302. flywheel/models/job_ticket_output.py +4 -8
  303. flywheel/models/job_transition_times.py +13 -23
  304. flywheel/models/job_version_info.py +1 -3
  305. flywheel/models/jobs_by_state.py +16 -28
  306. flywheel/models/jobs_list.py +4 -8
  307. flywheel/models/join_origin_device.py +4 -8
  308. flywheel/models/join_origin_job.py +10 -18
  309. flywheel/models/join_origin_user.py +7 -13
  310. flywheel/models/join_origins.py +10 -18
  311. flywheel/models/jupyterhub_workspace.py +4 -8
  312. flywheel/models/jupyterlab_server_modify.py +16 -28
  313. flywheel/models/jupyterlab_server_response.py +31 -53
  314. flywheel/models/ldap_sync_config.py +4 -8
  315. flywheel/models/ldap_sync_status.py +13 -23
  316. flywheel/models/legacy_api_key_output.py +16 -28
  317. flywheel/models/legacy_input.py +13 -23
  318. flywheel/models/legacy_usage_report.py +19 -33
  319. flywheel/models/legacys_usage_project_entry.py +7 -13
  320. flywheel/models/libs_viewer_config_models_viewer_config.py +7 -13
  321. flywheel/models/local_storage.py +10 -18
  322. flywheel/models/location.py +7 -13
  323. flywheel/models/locked.py +10 -18
  324. flywheel/models/master_subject_code_dob_input.py +16 -28
  325. flywheel/models/master_subject_code_input.py +16 -28
  326. flywheel/models/master_subject_code_output.py +4 -8
  327. flywheel/models/matched_acquisition_output.py +43 -73
  328. flywheel/models/measurement_config.py +10 -18
  329. flywheel/models/measurement_item_config.py +10 -18
  330. flywheel/models/mfa_settings.py +4 -8
  331. flywheel/models/ml_set_filter.py +7 -13
  332. flywheel/models/modality.py +13 -23
  333. flywheel/models/modality_input.py +13 -23
  334. flywheel/models/modality_modify.py +10 -18
  335. flywheel/models/modality_output.py +16 -28
  336. flywheel/models/modified_result.py +7 -13
  337. flywheel/models/modify_user_input.py +37 -63
  338. flywheel/models/move_conflict.py +19 -33
  339. flywheel/models/note.py +28 -48
  340. flywheel/models/note_input.py +4 -8
  341. flywheel/models/origin.py +7 -13
  342. flywheel/models/orphaned_count.py +4 -8
  343. flywheel/models/output_user_page.py +10 -18
  344. flywheel/models/packfile_cleanup_output.py +4 -8
  345. flywheel/models/packfile_removed_output.py +7 -13
  346. flywheel/models/page.py +10 -18
  347. flywheel/models/page_generic_file_output.py +10 -18
  348. flywheel/models/page_generic_filter.py +10 -18
  349. flywheel/models/page_generic_form_response_output.py +10 -18
  350. flywheel/models/page_generic_protocol.py +13 -23
  351. flywheel/models/page_generic_reader_task_output.py +13 -23
  352. flywheel/models/page_generic_staffing_pool.py +13 -23
  353. flywheel/models/parsed_query_response.py +7 -13
  354. flywheel/models/premade_jobs_batch_job_output.py +19 -33
  355. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +19 -33
  356. flywheel/models/premade_jobs_batch_proposal.py +22 -38
  357. flywheel/models/premade_jobs_batch_proposal_detail.py +4 -8
  358. flywheel/models/premade_jobs_batch_proposal_input.py +4 -8
  359. flywheel/models/project_aet.py +22 -38
  360. flywheel/models/project_aet_input.py +13 -23
  361. flywheel/models/project_contact.py +7 -13
  362. flywheel/models/project_copy_input.py +13 -23
  363. flywheel/models/project_copy_output.py +10 -18
  364. flywheel/models/project_counters.py +28 -48
  365. flywheel/models/project_delete_status_output.py +7 -13
  366. flywheel/models/project_group_info.py +7 -13
  367. flywheel/models/project_hierarchy_input.py +16 -28
  368. flywheel/models/project_hierarchy_output.py +10 -18
  369. flywheel/models/project_input.py +28 -48
  370. flywheel/models/project_institution.py +7 -13
  371. flywheel/models/project_list_output.py +94 -158
  372. flywheel/models/project_modify.py +37 -63
  373. flywheel/models/project_output.py +94 -158
  374. flywheel/models/project_parents.py +4 -8
  375. flywheel/models/project_report.py +37 -63
  376. flywheel/models/project_report_list.py +4 -8
  377. flywheel/models/project_settings_input.py +22 -38
  378. flywheel/models/project_settings_output.py +22 -38
  379. flywheel/models/project_settings_sharing.py +22 -38
  380. flywheel/models/project_settings_sharing_input.py +22 -38
  381. flywheel/models/project_settings_workspaces.py +4 -8
  382. flywheel/models/project_settings_workspaces_input.py +4 -8
  383. flywheel/models/project_stats.py +16 -28
  384. flywheel/models/project_template.py +7 -13
  385. flywheel/models/project_template_input.py +7 -13
  386. flywheel/models/project_template_list_input.py +4 -8
  387. flywheel/models/protocol.py +46 -78
  388. flywheel/models/protocol_e_signature_config.py +7 -13
  389. flywheel/models/protocol_input.py +25 -43
  390. flywheel/models/protocol_modify.py +16 -28
  391. flywheel/models/provider.py +37 -63
  392. flywheel/models/provider_deletion_status.py +7 -13
  393. flywheel/models/provider_links.py +16 -28
  394. flywheel/models/providers.py +16 -28
  395. flywheel/models/reader_batch_create.py +37 -63
  396. flywheel/models/reader_task.py +67 -113
  397. flywheel/models/reader_task_config.py +10 -18
  398. flywheel/models/reader_task_create.py +46 -78
  399. flywheel/models/reader_task_modify.py +19 -33
  400. flywheel/models/reader_task_output.py +70 -118
  401. flywheel/models/reader_task_parent_details.py +22 -38
  402. flywheel/models/report_access_log_context.py +19 -33
  403. flywheel/models/report_access_log_context_entry.py +7 -13
  404. flywheel/models/report_access_log_context_file_entry.py +4 -8
  405. flywheel/models/report_access_log_entry.py +52 -88
  406. flywheel/models/report_access_log_origin.py +7 -13
  407. flywheel/models/report_availability_list.py +4 -8
  408. flywheel/models/report_daily_usage_entry.py +40 -68
  409. flywheel/models/report_ethnicity_grid.py +13 -23
  410. flywheel/models/report_gender_count.py +10 -18
  411. flywheel/models/report_group_report.py +10 -18
  412. flywheel/models/report_site.py +7 -13
  413. flywheel/models/report_time_period.py +7 -13
  414. flywheel/models/report_usage.py +52 -88
  415. flywheel/models/resolve_input.py +4 -8
  416. flywheel/models/resolve_output.py +7 -13
  417. flywheel/models/resolver_node.py +4 -8
  418. flywheel/models/role_input.py +7 -13
  419. flywheel/models/role_output.py +16 -28
  420. flywheel/models/role_permission.py +7 -13
  421. flywheel/models/role_permission_output.py +7 -13
  422. flywheel/models/role_permission_update.py +4 -8
  423. flywheel/models/role_update.py +7 -13
  424. flywheel/models/roles_role_assignment.py +7 -13
  425. flywheel/models/rule.py +37 -63
  426. flywheel/models/rule_any.py +10 -18
  427. flywheel/models/s3_compat_storage.py +28 -48
  428. flywheel/models/save_search.py +19 -33
  429. flywheel/models/save_search_input.py +10 -18
  430. flywheel/models/save_search_output.py +19 -33
  431. flywheel/models/save_search_page.py +10 -18
  432. flywheel/models/save_search_parent.py +7 -13
  433. flywheel/models/save_search_update.py +7 -13
  434. flywheel/models/search_acquisition_response.py +13 -23
  435. flywheel/models/search_analysis_response.py +13 -23
  436. flywheel/models/search_collection_response.py +13 -23
  437. flywheel/models/search_file_response.py +19 -33
  438. flywheel/models/search_group_response.py +7 -13
  439. flywheel/models/search_parent_response.py +7 -13
  440. flywheel/models/search_parse_error.py +13 -23
  441. flywheel/models/search_project_response.py +7 -13
  442. flywheel/models/search_query.py +22 -38
  443. flywheel/models/search_response.py +34 -58
  444. flywheel/models/search_session_response.py +13 -23
  445. flywheel/models/search_status.py +4 -8
  446. flywheel/models/search_subject_response.py +10 -18
  447. flywheel/models/select_item.py +7 -13
  448. flywheel/models/server_state.py +19 -33
  449. flywheel/models/service_aet.py +19 -33
  450. flywheel/models/service_aet_input.py +16 -28
  451. flywheel/models/session_copy_input.py +13 -23
  452. flywheel/models/session_embedded_subject.py +19 -33
  453. flywheel/models/session_input.py +34 -58
  454. flywheel/models/session_list_output.py +85 -143
  455. flywheel/models/session_modify.py +37 -63
  456. flywheel/models/session_output.py +85 -143
  457. flywheel/models/session_parents.py +10 -18
  458. flywheel/models/session_template_options.py +10 -18
  459. flywheel/models/session_template_recalc_output.py +4 -8
  460. flywheel/models/session_upsert_input.py +37 -63
  461. flywheel/models/session_upsert_output.py +13 -23
  462. flywheel/models/sharing_filter_options.py +25 -43
  463. flywheel/models/signed_fs_upload_output.py +7 -13
  464. flywheel/models/signed_url_cleanup_input.py +7 -13
  465. flywheel/models/signed_url_upload_input.py +7 -13
  466. flywheel/models/signed_url_upload_output.py +25 -43
  467. flywheel/models/site.py +55 -93
  468. flywheel/models/site_report.py +7 -13
  469. flywheel/models/site_settings.py +28 -48
  470. flywheel/models/sort.py +7 -13
  471. flywheel/models/staffing_pool.py +22 -38
  472. flywheel/models/staffing_pool_create.py +10 -18
  473. flywheel/models/staffing_pool_list.py +4 -8
  474. flywheel/models/staffing_pool_modify.py +10 -18
  475. flywheel/models/static_compute.py +10 -18
  476. flywheel/models/status_transitions.py +13 -23
  477. flywheel/models/storage_strategy_config.py +7 -13
  478. flywheel/models/structured_query.py +4 -8
  479. flywheel/models/structured_query_suggestions.py +7 -13
  480. flywheel/models/structured_query_value_suggestion.py +13 -23
  481. flywheel/models/subject_copy_input.py +10 -18
  482. flywheel/models/subject_input.py +55 -93
  483. flywheel/models/subject_modify.py +61 -103
  484. flywheel/models/subject_output.py +97 -163
  485. flywheel/models/subject_output_for_list.py +97 -163
  486. flywheel/models/subject_parents.py +7 -13
  487. flywheel/models/subject_role_permission.py +7 -13
  488. flywheel/models/subject_template_options.py +7 -13
  489. flywheel/models/subject_upsert_input.py +49 -83
  490. flywheel/models/subject_upsert_output.py +10 -18
  491. flywheel/models/sync_user_input.py +22 -38
  492. flywheel/models/tag.py +4 -8
  493. flywheel/models/task_assign.py +7 -13
  494. flywheel/models/task_parent_ref.py +13 -23
  495. flywheel/models/task_parent_ref_input.py +10 -18
  496. flywheel/models/task_submission.py +7 -13
  497. flywheel/models/toolbar_config.py +4 -8
  498. flywheel/models/transitions.py +16 -28
  499. flywheel/models/tree_container_request_spec.py +16 -28
  500. flywheel/models/tree_graph.py +1 -3
  501. flywheel/models/tree_graph_connection.py +13 -23
  502. flywheel/models/tree_graph_connections.py +1 -3
  503. flywheel/models/tree_graph_node.py +4 -8
  504. flywheel/models/tree_response_item.py +1 -3
  505. flywheel/models/uid_check_input_acquisitions.py +13 -23
  506. flywheel/models/uid_check_input_sessions.py +13 -23
  507. flywheel/models/uid_check_output.py +7 -13
  508. flywheel/models/upload_ticket_output.py +10 -18
  509. flywheel/models/upload_token_output.py +4 -8
  510. flywheel/models/user.py +67 -113
  511. flywheel/models/user_api_key.py +10 -18
  512. flywheel/models/user_input.py +37 -63
  513. flywheel/models/user_jobs.py +10 -18
  514. flywheel/models/user_output_id.py +4 -8
  515. flywheel/models/user_preferences.py +1 -3
  516. flywheel/models/user_wechat.py +1 -3
  517. flywheel/models/validation_error.py +10 -18
  518. flywheel/models/validation_rule.py +7 -13
  519. flywheel/models/version.py +25 -43
  520. flywheel/models/view_id_output.py +4 -8
  521. flywheel/models/view_output.py +34 -58
  522. flywheel/models/viewer_app.py +28 -48
  523. flywheel/models/viewer_app_input.py +28 -48
  524. flywheel/models/virus_scan.py +4 -8
  525. flywheel/models/work_in_progress_features.py +1 -3
  526. flywheel/models/zipfile_info.py +7 -13
  527. flywheel/models/zipfile_member_info.py +13 -23
  528. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/METADATA +1 -1
  529. flywheel_sdk-21.4.0rc0.dist-info/RECORD +778 -0
  530. flywheel_sdk-21.4.0.dist-info/RECORD +0 -778
  531. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/WHEEL +0 -0
  532. {flywheel_sdk-21.4.0.dist-info → flywheel_sdk-21.4.0rc0.dist-info}/licenses/LICENSE.txt +0 -0
@@ -30,11 +30,9 @@ class CollectionsApi(object):
30
30
  Create a collection
31
31
  This method makes a synchronous HTTP request by default.
32
32
 
33
- :param body:
34
- :type body: CollectionInput
35
- :param async_: Perform the request asynchronously
36
- :type async_: bool, optional
37
- :rtype: InsertedId
33
+ :param CollectionInput body: (required)
34
+ :param bool async_: Perform the request asynchronously
35
+ :return: InsertedId
38
36
  """
39
37
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
40
38
  kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class CollectionsApi(object):
58
56
  Create a collection
59
57
  This method makes a synchronous HTTP request by default.
60
58
 
61
- :param body:
62
- :type body: CollectionInput
63
- :param async_: Perform the request asynchronously
64
- :type async_: bool, optional
65
- :rtype: InsertedId
59
+ :param CollectionInput body: (required)
60
+ :param bool async_: Perform the request asynchronously
61
+ :return: InsertedId
66
62
  """
67
63
 
68
64
  all_params = ['body',] # noqa: E501
@@ -142,13 +138,10 @@ class CollectionsApi(object):
142
138
  Add a note to a(n) collection.
143
139
  This method makes a synchronous HTTP request by default.
144
140
 
145
- :param container_id:
146
- :type container_id: str
147
- :param body:
148
- :type body: NoteInput
149
- :param async_: Perform the request asynchronously
150
- :type async_: bool, optional
151
- :rtype: Note
141
+ :param str container_id: (required)
142
+ :param NoteInput body: (required)
143
+ :param bool async_: Perform the request asynchronously
144
+ :return: Note
152
145
  """
153
146
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
154
147
  kwargs['_return_http_data_only'] = True
@@ -172,13 +165,10 @@ class CollectionsApi(object):
172
165
  Add a note to a(n) collection.
173
166
  This method makes a synchronous HTTP request by default.
174
167
 
175
- :param container_id:
176
- :type container_id: str
177
- :param body:
178
- :type body: NoteInput
179
- :param async_: Perform the request asynchronously
180
- :type async_: bool, optional
181
- :rtype: Note
168
+ :param str container_id: (required)
169
+ :param NoteInput body: (required)
170
+ :param bool async_: Perform the request asynchronously
171
+ :return: Note
182
172
  """
183
173
 
184
174
  all_params = ['container_id','body',] # noqa: E501
@@ -264,13 +254,10 @@ class CollectionsApi(object):
264
254
  Add a permission
265
255
  This method makes a synchronous HTTP request by default.
266
256
 
267
- :param collection_id:
268
- :type collection_id: str
269
- :param body:
270
- :type body: AccessPermission
271
- :param async_: Perform the request asynchronously
272
- :type async_: bool, optional
273
- :rtype: AccessPermissionOutput
257
+ :param str collection_id: (required)
258
+ :param AccessPermission body: (required)
259
+ :param bool async_: Perform the request asynchronously
260
+ :return: AccessPermissionOutput
274
261
  """
275
262
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
276
263
  kwargs['_return_http_data_only'] = True
@@ -294,13 +281,10 @@ class CollectionsApi(object):
294
281
  Add a permission
295
282
  This method makes a synchronous HTTP request by default.
296
283
 
297
- :param collection_id:
298
- :type collection_id: str
299
- :param body:
300
- :type body: AccessPermission
301
- :param async_: Perform the request asynchronously
302
- :type async_: bool, optional
303
- :rtype: AccessPermissionOutput
284
+ :param str collection_id: (required)
285
+ :param AccessPermission body: (required)
286
+ :param bool async_: Perform the request asynchronously
287
+ :return: AccessPermissionOutput
304
288
  """
305
289
 
306
290
  all_params = ['collection_id','body',] # noqa: E501
@@ -386,13 +370,10 @@ class CollectionsApi(object):
386
370
  Propagates changes to projects, sessions and acquisitions
387
371
  This method makes a synchronous HTTP request by default.
388
372
 
389
- :param cid:
390
- :type cid: str
391
- :param body:
392
- :type body: Tag
393
- :param async_: Perform the request asynchronously
394
- :type async_: bool, optional
395
- :rtype: ModifiedResult
373
+ :param str cid: (required)
374
+ :param Tag body: (required)
375
+ :param bool async_: Perform the request asynchronously
376
+ :return: ModifiedResult
396
377
  """
397
378
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
398
379
  kwargs['_return_http_data_only'] = True
@@ -416,13 +397,10 @@ class CollectionsApi(object):
416
397
  Propagates changes to projects, sessions and acquisitions
417
398
  This method makes a synchronous HTTP request by default.
418
399
 
419
- :param cid:
420
- :type cid: str
421
- :param body:
422
- :type body: Tag
423
- :param async_: Perform the request asynchronously
424
- :type async_: bool, optional
425
- :rtype: ModifiedResult
400
+ :param str cid: (required)
401
+ :param Tag body: (required)
402
+ :param bool async_: Perform the request asynchronously
403
+ :return: ModifiedResult
426
404
  """
427
405
 
428
406
  all_params = ['cid','body',] # noqa: E501
@@ -508,13 +486,10 @@ class CollectionsApi(object):
508
486
  Add multiple tags to a(n) collection
509
487
  This method makes a synchronous HTTP request by default.
510
488
 
511
- :param cid:
512
- :type cid: str
513
- :param body:
514
- :type body: list[str]
515
- :param async_: Perform the request asynchronously
516
- :type async_: bool, optional
517
- :rtype: None
489
+ :param str cid: (required)
490
+ :param list[str] body: (required)
491
+ :param bool async_: Perform the request asynchronously
492
+ :return: None
518
493
  """
519
494
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
520
495
  kwargs['_return_http_data_only'] = True
@@ -538,13 +513,10 @@ class CollectionsApi(object):
538
513
  Add multiple tags to a(n) collection
539
514
  This method makes a synchronous HTTP request by default.
540
515
 
541
- :param cid:
542
- :type cid: str
543
- :param body:
544
- :type body: list[str]
545
- :param async_: Perform the request asynchronously
546
- :type async_: bool, optional
547
- :rtype: None
516
+ :param str cid: (required)
517
+ :param list[str] body: (required)
518
+ :param bool async_: Perform the request asynchronously
519
+ :return: None
548
520
  """
549
521
 
550
522
  all_params = ['cid','body',] # noqa: E501
@@ -623,11 +595,9 @@ class CollectionsApi(object):
623
595
  Delete Collections.
624
596
  This method makes a synchronous HTTP request by default.
625
597
 
626
- :param collection_id:
627
- :type collection_id: str
628
- :param async_: Perform the request asynchronously
629
- :type async_: bool, optional
630
- :rtype: DeletedResult
598
+ :param str collection_id: (required)
599
+ :param bool async_: Perform the request asynchronously
600
+ :return: DeletedResult
631
601
  """
632
602
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
633
603
  kwargs['_return_http_data_only'] = True
@@ -651,11 +621,9 @@ class CollectionsApi(object):
651
621
  Delete Collections.
652
622
  This method makes a synchronous HTTP request by default.
653
623
 
654
- :param collection_id:
655
- :type collection_id: str
656
- :param async_: Perform the request asynchronously
657
- :type async_: bool, optional
658
- :rtype: DeletedResult
624
+ :param str collection_id: (required)
625
+ :param bool async_: Perform the request asynchronously
626
+ :return: DeletedResult
659
627
  """
660
628
 
661
629
  all_params = ['collection_id',] # noqa: E501
@@ -724,17 +692,12 @@ class CollectionsApi(object):
724
692
  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.
725
693
  This method makes a synchronous HTTP request by default.
726
694
 
727
- :param cid:
728
- :type cid: str
729
- :param filename:
730
- :type filename: str
731
- :param delete_reason: A reason for deletion when audit-trail is enabled
732
- :type delete_reason: ContainerDeleteReason, optional
733
- :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
734
- :type force: bool, optional
735
- :param async_: Perform the request asynchronously
736
- :type async_: bool, optional
737
- :rtype: DeletedResult
695
+ :param str cid: (required)
696
+ :param str filename: (required)
697
+ :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
698
+ :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
699
+ :param bool async_: Perform the request asynchronously
700
+ :return: DeletedResult
738
701
  """
739
702
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
740
703
  kwargs['_return_http_data_only'] = True
@@ -758,17 +721,12 @@ class CollectionsApi(object):
758
721
  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.
759
722
  This method makes a synchronous HTTP request by default.
760
723
 
761
- :param cid:
762
- :type cid: str
763
- :param filename:
764
- :type filename: str
765
- :param delete_reason: A reason for deletion when audit-trail is enabled
766
- :type delete_reason: ContainerDeleteReason, optional
767
- :param force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false
768
- :type force: bool, optional
769
- :param async_: Perform the request asynchronously
770
- :type async_: bool, optional
771
- :rtype: DeletedResult
724
+ :param str cid: (required)
725
+ :param str filename: (required)
726
+ :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
727
+ :param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
728
+ :param bool async_: Perform the request asynchronously
729
+ :return: DeletedResult
772
730
  """
773
731
 
774
732
  all_params = ['cid','filename','delete_reason','force',] # noqa: E501
@@ -847,13 +805,10 @@ class CollectionsApi(object):
847
805
  Remove a note from a(n) collection
848
806
  This method makes a synchronous HTTP request by default.
849
807
 
850
- :param cid:
851
- :type cid: str
852
- :param note_id:
853
- :type note_id: str
854
- :param async_: Perform the request asynchronously
855
- :type async_: bool, optional
856
- :rtype: DeletedResult
808
+ :param str cid: (required)
809
+ :param str note_id: (required)
810
+ :param bool async_: Perform the request asynchronously
811
+ :return: DeletedResult
857
812
  """
858
813
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
859
814
  kwargs['_return_http_data_only'] = True
@@ -877,13 +832,10 @@ class CollectionsApi(object):
877
832
  Remove a note from a(n) collection
878
833
  This method makes a synchronous HTTP request by default.
879
834
 
880
- :param cid:
881
- :type cid: str
882
- :param note_id:
883
- :type note_id: str
884
- :param async_: Perform the request asynchronously
885
- :type async_: bool, optional
886
- :rtype: DeletedResult
835
+ :param str cid: (required)
836
+ :param str note_id: (required)
837
+ :param bool async_: Perform the request asynchronously
838
+ :return: DeletedResult
887
839
  """
888
840
 
889
841
  all_params = ['cid','note_id',] # noqa: E501
@@ -958,13 +910,10 @@ class CollectionsApi(object):
958
910
  Delete a tag
959
911
  This method makes a synchronous HTTP request by default.
960
912
 
961
- :param cid:
962
- :type cid: str
963
- :param value: The tag to interact with
964
- :type value: str
965
- :param async_: Perform the request asynchronously
966
- :type async_: bool, optional
967
- :rtype: DeletedResult
913
+ :param str cid: (required)
914
+ :param str value: The tag to interact with (required)
915
+ :param bool async_: Perform the request asynchronously
916
+ :return: DeletedResult
968
917
  """
969
918
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
970
919
  kwargs['_return_http_data_only'] = True
@@ -988,13 +937,10 @@ class CollectionsApi(object):
988
937
  Delete a tag
989
938
  This method makes a synchronous HTTP request by default.
990
939
 
991
- :param cid:
992
- :type cid: str
993
- :param value: The tag to interact with
994
- :type value: str
995
- :param async_: Perform the request asynchronously
996
- :type async_: bool, optional
997
- :rtype: DeletedResult
940
+ :param str cid: (required)
941
+ :param str value: The tag to interact with (required)
942
+ :param bool async_: Perform the request asynchronously
943
+ :return: DeletedResult
998
944
  """
999
945
 
1000
946
  all_params = ['cid','value',] # noqa: E501
@@ -1069,13 +1015,10 @@ class CollectionsApi(object):
1069
1015
  Delete multiple tags from a(n) collection
1070
1016
  This method makes a synchronous HTTP request by default.
1071
1017
 
1072
- :param cid:
1073
- :type cid: str
1074
- :param body:
1075
- :type body: list[str]
1076
- :param async_: Perform the request asynchronously
1077
- :type async_: bool, optional
1078
- :rtype: None
1018
+ :param str cid: (required)
1019
+ :param list[str] body: (required)
1020
+ :param bool async_: Perform the request asynchronously
1021
+ :return: None
1079
1022
  """
1080
1023
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1081
1024
  kwargs['_return_http_data_only'] = True
@@ -1099,13 +1042,10 @@ class CollectionsApi(object):
1099
1042
  Delete multiple tags from a(n) collection
1100
1043
  This method makes a synchronous HTTP request by default.
1101
1044
 
1102
- :param cid:
1103
- :type cid: str
1104
- :param body:
1105
- :type body: list[str]
1106
- :param async_: Perform the request asynchronously
1107
- :type async_: bool, optional
1108
- :rtype: None
1045
+ :param str cid: (required)
1046
+ :param list[str] body: (required)
1047
+ :param bool async_: Perform the request asynchronously
1048
+ :return: None
1109
1049
  """
1110
1050
 
1111
1051
  all_params = ['cid','body',] # noqa: E501
@@ -1184,13 +1124,10 @@ class CollectionsApi(object):
1184
1124
  Delete a permission
1185
1125
  This method makes a synchronous HTTP request by default.
1186
1126
 
1187
- :param collection_id:
1188
- :type collection_id: str
1189
- :param user_id:
1190
- :type user_id: str
1191
- :param async_: Perform the request asynchronously
1192
- :type async_: bool, optional
1193
- :rtype: ModifiedResult
1127
+ :param str collection_id: (required)
1128
+ :param str user_id: (required)
1129
+ :param bool async_: Perform the request asynchronously
1130
+ :return: ModifiedResult
1194
1131
  """
1195
1132
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1196
1133
  kwargs['_return_http_data_only'] = True
@@ -1214,13 +1151,10 @@ class CollectionsApi(object):
1214
1151
  Delete a permission
1215
1152
  This method makes a synchronous HTTP request by default.
1216
1153
 
1217
- :param collection_id:
1218
- :type collection_id: str
1219
- :param user_id:
1220
- :type user_id: str
1221
- :param async_: Perform the request asynchronously
1222
- :type async_: bool, optional
1223
- :rtype: ModifiedResult
1154
+ :param str collection_id: (required)
1155
+ :param str user_id: (required)
1156
+ :param bool async_: Perform the request asynchronously
1157
+ :return: ModifiedResult
1224
1158
  """
1225
1159
 
1226
1160
  all_params = ['collection_id','user_id',] # noqa: E501
@@ -1295,13 +1229,10 @@ class CollectionsApi(object):
1295
1229
  Delete multiple collections by ID list
1296
1230
  This method makes a synchronous HTTP request by default.
1297
1231
 
1298
- :param body: List of IDs to delete
1299
- :type body: list[str]
1300
- :param delete_reason:
1301
- :type delete_reason: ContainerDeleteReason, optional
1302
- :param async_: Perform the request asynchronously
1303
- :type async_: bool, optional
1304
- :rtype: DeletedResult
1232
+ :param list[str] body: List of IDs to delete (required)
1233
+ :param ContainerDeleteReason delete_reason:
1234
+ :param bool async_: Perform the request asynchronously
1235
+ :return: DeletedResult
1305
1236
  """
1306
1237
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1307
1238
  kwargs['_return_http_data_only'] = True
@@ -1325,13 +1256,10 @@ class CollectionsApi(object):
1325
1256
  Delete multiple collections by ID list
1326
1257
  This method makes a synchronous HTTP request by default.
1327
1258
 
1328
- :param body: List of IDs to delete
1329
- :type body: list[str]
1330
- :param delete_reason:
1331
- :type delete_reason: ContainerDeleteReason, optional
1332
- :param async_: Perform the request asynchronously
1333
- :type async_: bool, optional
1334
- :rtype: DeletedResult
1259
+ :param list[str] body: List of IDs to delete (required)
1260
+ :param ContainerDeleteReason delete_reason:
1261
+ :param bool async_: Perform the request asynchronously
1262
+ :return: DeletedResult
1335
1263
  """
1336
1264
 
1337
1265
  all_params = ['body','delete_reason',] # noqa: E501
@@ -1406,29 +1334,18 @@ class CollectionsApi(object):
1406
1334
  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.
1407
1335
  This method makes a synchronous HTTP request by default.
1408
1336
 
1409
- :param collection_id: 24-character hex ID
1410
- :type collection_id: str
1411
- :param file_name: output file name
1412
- :type file_name: str
1413
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1414
- :type info: bool, optional
1415
- :param member: The filename of a zipfile member to download rather than the entire file
1416
- :type member: str, optional
1417
- :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
1418
- :type view: bool, optional
1419
- :param version: version of the file to download
1420
- :type version: int, optional
1421
- :param hash: file hash for comparison
1422
- :type hash: str, optional
1423
- :param range: byte ranges to return
1424
- :type range: str, optional
1425
- :param x_accept_feature: redirect header, defaults to []
1426
- :type x_accept_feature: list[str], optional
1427
- :param dest_file: Destination file path
1428
- :type dest_file: str
1429
- :param async_: Perform the request asynchronously
1430
- :type async_: bool, optional
1431
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1337
+ :param str collection_id: 24-character hex ID (required)
1338
+ :param str file_name: output file name (required)
1339
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1340
+ :param str member: The filename of a zipfile member to download rather than the entire file
1341
+ :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\"
1342
+ :param int version: version of the file to download
1343
+ :param str hash: file hash for comparison
1344
+ :param str range: byte ranges to return
1345
+ :param list[str] x_accept_feature: redirect header
1346
+ :param str dest_file: Destination file path
1347
+ :param bool async_: Perform the request asynchronously
1348
+ :return: union[DownloadTicketStub,ZipfileInfo]
1432
1349
  """
1433
1350
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1434
1351
  kwargs['_return_http_data_only'] = True
@@ -1451,27 +1368,17 @@ class CollectionsApi(object):
1451
1368
  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.
1452
1369
  This method makes a synchronous HTTP request by default.
1453
1370
 
1454
- :param collection_id: 24-character hex ID
1455
- :type collection_id: str
1456
- :param file_name: output file name
1457
- :type file_name: str
1458
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1459
- :type info: bool, optional
1460
- :param member: The filename of a zipfile member to download rather than the entire file
1461
- :type member: str, optional
1462
- :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
1463
- :type view: bool, optional
1464
- :param version: version of the file to download
1465
- :type version: int, optional
1466
- :param hash: file hash for comparison
1467
- :type hash: str, optional
1468
- :param range: byte ranges to return
1469
- :type range: str, optional
1470
- :param x_accept_feature: redirect header, defaults to []
1471
- :type x_accept_feature: list[str], optional
1472
- :param async_: Perform the request asynchronously
1473
- :type async_: bool, optional
1474
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1371
+ :param str collection_id: 24-character hex ID (required)
1372
+ :param str file_name: output file name (required)
1373
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1374
+ :param str member: The filename of a zipfile member to download rather than the entire file
1375
+ :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\"
1376
+ :param int version: version of the file to download
1377
+ :param str hash: file hash for comparison
1378
+ :param str range: byte ranges to return
1379
+ :param list[str] x_accept_feature: redirect header
1380
+ :param bool async_: Perform the request asynchronously
1381
+ :return: union[DownloadTicketStub,ZipfileInfo]
1475
1382
  """
1476
1383
 
1477
1384
  all_params = ['collection_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1561,29 +1468,18 @@ class CollectionsApi(object):
1561
1468
  Does not work on files whose names contain a forward slash.
1562
1469
  This method makes a synchronous HTTP request by default.
1563
1470
 
1564
- :param collection_id: 24-character hex ID
1565
- :type collection_id: str
1566
- :param file_name: output file name
1567
- :type file_name: str
1568
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1569
- :type ticket: str, optional
1570
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1571
- :type info: bool, optional
1572
- :param member: The filename of a zipfile member to download rather than the entire file
1573
- :type member: str, optional
1574
- :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
1575
- :type view: bool, optional
1576
- :param version: version of the file to download
1577
- :type version: int, optional
1578
- :param hash: file hash for comparison
1579
- :type hash: str, optional
1580
- :param range: byte ranges to return
1581
- :type range: str, optional
1582
- :param x_accept_feature: redirect header, defaults to []
1583
- :type x_accept_feature: list[str], optional
1584
- :param async_: Perform the request asynchronously
1585
- :type async_: bool, optional
1586
- :rtype: FileZipInfo
1471
+ :param str collection_id: 24-character hex ID (required)
1472
+ :param str file_name: output file name (required)
1473
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1474
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1475
+ :param str member: The filename of a zipfile member to download rather than the entire file
1476
+ :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\"
1477
+ :param int version: version of the file to download
1478
+ :param str hash: file hash for comparison
1479
+ :param str range: byte ranges to return
1480
+ :param list[str] x_accept_feature: redirect header
1481
+ :param bool async_: Perform the request asynchronously
1482
+ :return: FileZipInfo
1587
1483
  """
1588
1484
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1589
1485
  kwargs['_return_http_data_only'] = True
@@ -1607,29 +1503,18 @@ class CollectionsApi(object):
1607
1503
  Does not work on files whose names contain a forward slash.
1608
1504
  This method makes a synchronous HTTP request by default.
1609
1505
 
1610
- :param collection_id: 24-character hex ID
1611
- :type collection_id: str
1612
- :param file_name: output file name
1613
- :type file_name: str
1614
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1615
- :type ticket: str, optional
1616
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1617
- :type info: bool, optional
1618
- :param member: The filename of a zipfile member to download rather than the entire file
1619
- :type member: str, optional
1620
- :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
1621
- :type view: bool, optional
1622
- :param version: version of the file to download
1623
- :type version: int, optional
1624
- :param hash: file hash for comparison
1625
- :type hash: str, optional
1626
- :param range: byte ranges to return
1627
- :type range: str, optional
1628
- :param x_accept_feature: redirect header, defaults to []
1629
- :type x_accept_feature: list[str], optional
1630
- :param async_: Perform the request asynchronously
1631
- :type async_: bool, optional
1632
- :rtype: FileZipInfo
1506
+ :param str collection_id: 24-character hex ID (required)
1507
+ :param str file_name: output file name (required)
1508
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1509
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1510
+ :param str member: The filename of a zipfile member to download rather than the entire file
1511
+ :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\"
1512
+ :param int version: version of the file to download
1513
+ :param str hash: file hash for comparison
1514
+ :param str range: byte ranges to return
1515
+ :param list[str] x_accept_feature: redirect header
1516
+ :param bool async_: Perform the request asynchronously
1517
+ :return: FileZipInfo
1633
1518
  """
1634
1519
 
1635
1520
  all_params = ['collection_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1722,29 +1607,18 @@ class CollectionsApi(object):
1722
1607
 
1723
1608
  This method makes a synchronous HTTP request by default.
1724
1609
 
1725
- :param collection_id: 24-character hex ID
1726
- :type collection_id: str
1727
- :param file_name: output file name
1728
- :type file_name: str
1729
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1730
- :type ticket: str, optional
1731
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1732
- :type info: bool, optional
1733
- :param member: The filename of a zipfile member to download rather than the entire file
1734
- :type member: str, optional
1735
- :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
1736
- :type view: bool, optional
1737
- :param version: version of the file to download
1738
- :type version: int, optional
1739
- :param hash: file hash for comparison
1740
- :type hash: str, optional
1741
- :param range: byte ranges to return
1742
- :type range: str, optional
1743
- :param x_accept_feature: redirect header, defaults to []
1744
- :type x_accept_feature: list[str], optional
1745
- :param async_: Perform the request asynchronously
1746
- :type async_: bool, optional
1747
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1610
+ :param str collection_id: 24-character hex ID (required)
1611
+ :param str file_name: output file name (required)
1612
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1613
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1614
+ :param str member: The filename of a zipfile member to download rather than the entire file
1615
+ :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\"
1616
+ :param int version: version of the file to download
1617
+ :param str hash: file hash for comparison
1618
+ :param str range: byte ranges to return
1619
+ :param list[str] x_accept_feature: redirect header
1620
+ :param bool async_: Perform the request asynchronously
1621
+ :return: union[DownloadTicketStub,ZipfileInfo]
1748
1622
  """
1749
1623
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1750
1624
  kwargs['_return_http_data_only'] = True
@@ -1767,29 +1641,18 @@ class CollectionsApi(object):
1767
1641
 
1768
1642
  This method makes a synchronous HTTP request by default.
1769
1643
 
1770
- :param collection_id: 24-character hex ID
1771
- :type collection_id: str
1772
- :param file_name: output file name
1773
- :type file_name: str
1774
- :param ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1775
- :type ticket: str, optional
1776
- :param info: If the file is a zipfile, return a json response of zipfile member information, defaults to false
1777
- :type info: bool, optional
1778
- :param member: The filename of a zipfile member to download rather than the entire file
1779
- :type member: str, optional
1780
- :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
1781
- :type view: bool, optional
1782
- :param version: version of the file to download
1783
- :type version: int, optional
1784
- :param hash: file hash for comparison
1785
- :type hash: str, optional
1786
- :param range: byte ranges to return
1787
- :type range: str, optional
1788
- :param x_accept_feature: redirect header, defaults to []
1789
- :type x_accept_feature: list[str], optional
1790
- :param async_: Perform the request asynchronously
1791
- :type async_: bool, optional
1792
- :rtype: union[DownloadTicketStub,ZipfileInfo]
1644
+ :param str collection_id: 24-character hex ID (required)
1645
+ :param str file_name: output file name (required)
1646
+ :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
1647
+ :param bool info: If the file is a zipfile, return a json response of zipfile member information
1648
+ :param str member: The filename of a zipfile member to download rather than the entire file
1649
+ :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\"
1650
+ :param int version: version of the file to download
1651
+ :param str hash: file hash for comparison
1652
+ :param str range: byte ranges to return
1653
+ :param list[str] x_accept_feature: redirect header
1654
+ :param bool async_: Perform the request asynchronously
1655
+ :return: union[DownloadTicketStub,ZipfileInfo]
1793
1656
  """
1794
1657
 
1795
1658
  all_params = ['collection_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
@@ -1881,37 +1744,22 @@ class CollectionsApi(object):
1881
1744
  List all collections.
1882
1745
  This method makes a synchronous HTTP request by default.
1883
1746
 
1884
- :param exhaustive:, defaults to false
1885
- :type exhaustive: bool, optional
1886
- :param join_avatars: add name and avatar to notes, defaults to false
1887
- :type join_avatars: bool, optional
1888
- :param join_files:, defaults to true
1889
- :type join_files: bool, optional
1890
- :param join:
1891
- :type join: JoinType, optional
1892
- :param stats:, defaults to false
1893
- :type stats: bool, optional
1894
- :param include_all_info: Include all info in returned objects, defaults to false
1895
- :type include_all_info: bool, optional
1896
- :param user_id:
1897
- :type user_id: str, optional
1898
- :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)
1899
- :type filter: str, optional
1900
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1901
- :type sort: str, optional
1902
- :param limit: The maximum number of entries to return.
1903
- :type limit: int, optional
1904
- :param skip: The number of entries to skip., defaults to 0
1905
- :type skip: int, optional
1906
- :param page: The page number (i.e. skip limit*page entries)
1907
- :type page: int, optional
1908
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1909
- :type after_id: str, optional
1910
- :param x_accept_feature:, defaults to []
1911
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
1912
- :param async_: Perform the request asynchronously
1913
- :type async_: bool, optional
1914
- :rtype: union[Page,list[CollectionWithStats],list[CollectionOutput]]
1747
+ :param bool exhaustive:
1748
+ :param bool join_avatars: add name and avatar to notes
1749
+ :param bool join_files:
1750
+ :param JoinType join:
1751
+ :param bool stats:
1752
+ :param bool include_all_info: Include all info in returned objects
1753
+ :param str user_id:
1754
+ :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)
1755
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1756
+ :param int limit: The maximum number of entries to return.
1757
+ :param int skip: The number of entries to skip.
1758
+ :param int page: The page number (i.e. skip limit*page entries)
1759
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1760
+ :param list[union[HeaderFeature,str]] x_accept_feature:
1761
+ :param bool async_: Perform the request asynchronously
1762
+ :return: union[Page,list[CollectionWithStats],list[CollectionOutput]]
1915
1763
  """
1916
1764
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1917
1765
  kwargs['_return_http_data_only'] = True
@@ -1935,37 +1783,22 @@ class CollectionsApi(object):
1935
1783
  List all collections.
1936
1784
  This method makes a synchronous HTTP request by default.
1937
1785
 
1938
- :param exhaustive:, defaults to false
1939
- :type exhaustive: bool, optional
1940
- :param join_avatars: add name and avatar to notes, defaults to false
1941
- :type join_avatars: bool, optional
1942
- :param join_files:, defaults to true
1943
- :type join_files: bool, optional
1944
- :param join:
1945
- :type join: JoinType, optional
1946
- :param stats:, defaults to false
1947
- :type stats: bool, optional
1948
- :param include_all_info: Include all info in returned objects, defaults to false
1949
- :type include_all_info: bool, optional
1950
- :param user_id:
1951
- :type user_id: str, optional
1952
- :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)
1953
- :type filter: str, optional
1954
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1955
- :type sort: str, optional
1956
- :param limit: The maximum number of entries to return.
1957
- :type limit: int, optional
1958
- :param skip: The number of entries to skip., defaults to 0
1959
- :type skip: int, optional
1960
- :param page: The page number (i.e. skip limit*page entries)
1961
- :type page: int, optional
1962
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1963
- :type after_id: str, optional
1964
- :param x_accept_feature:, defaults to []
1965
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
1966
- :param async_: Perform the request asynchronously
1967
- :type async_: bool, optional
1968
- :rtype: union[Page,list[CollectionWithStats],list[CollectionOutput]]
1786
+ :param bool exhaustive:
1787
+ :param bool join_avatars: add name and avatar to notes
1788
+ :param bool join_files:
1789
+ :param JoinType join:
1790
+ :param bool stats:
1791
+ :param bool include_all_info: Include all info in returned objects
1792
+ :param str user_id:
1793
+ :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)
1794
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1795
+ :param int limit: The maximum number of entries to return.
1796
+ :param int skip: The number of entries to skip.
1797
+ :param int page: The page number (i.e. skip limit*page entries)
1798
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1799
+ :param list[union[HeaderFeature,str]] x_accept_feature:
1800
+ :param bool async_: Perform the request asynchronously
1801
+ :return: union[Page,list[CollectionWithStats],list[CollectionOutput]]
1969
1802
  """
1970
1803
 
1971
1804
  all_params = ['exhaustive','join_avatars','join_files','join','stats','include_all_info','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -2057,21 +1890,14 @@ class CollectionsApi(object):
2057
1890
  List all curators of collections
2058
1891
  This method makes a synchronous HTTP request by default.
2059
1892
 
2060
- :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)
2061
- :type filter: str, optional
2062
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2063
- :type sort: str, optional
2064
- :param limit: The maximum number of entries to return.
2065
- :type limit: int, optional
2066
- :param skip: The number of entries to skip., defaults to 0
2067
- :type skip: int, optional
2068
- :param page: The page number (i.e. skip limit*page entries)
2069
- :type page: int, optional
2070
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2071
- :type after_id: str, optional
2072
- :param async_: Perform the request asynchronously
2073
- :type async_: bool, optional
2074
- :rtype: list[Curator]
1893
+ :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)
1894
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1895
+ :param int limit: The maximum number of entries to return.
1896
+ :param int skip: The number of entries to skip.
1897
+ :param int page: The page number (i.e. skip limit*page entries)
1898
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1899
+ :param bool async_: Perform the request asynchronously
1900
+ :return: list[Curator]
2075
1901
  """
2076
1902
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2077
1903
  kwargs['_return_http_data_only'] = True
@@ -2095,21 +1921,14 @@ class CollectionsApi(object):
2095
1921
  List all curators of collections
2096
1922
  This method makes a synchronous HTTP request by default.
2097
1923
 
2098
- :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)
2099
- :type filter: str, optional
2100
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2101
- :type sort: str, optional
2102
- :param limit: The maximum number of entries to return.
2103
- :type limit: int, optional
2104
- :param skip: The number of entries to skip., defaults to 0
2105
- :type skip: int, optional
2106
- :param page: The page number (i.e. skip limit*page entries)
2107
- :type page: int, optional
2108
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2109
- :type after_id: str, optional
2110
- :param async_: Perform the request asynchronously
2111
- :type async_: bool, optional
2112
- :rtype: list[Curator]
1924
+ :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)
1925
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1926
+ :param int limit: The maximum number of entries to return.
1927
+ :param int skip: The number of entries to skip.
1928
+ :param int page: The page number (i.e. skip limit*page entries)
1929
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1930
+ :param bool async_: Perform the request asynchronously
1931
+ :return: list[Curator]
2113
1932
  """
2114
1933
 
2115
1934
  all_params = ['filter','sort','limit','skip','page','after_id',] # noqa: E501
@@ -2184,17 +2003,12 @@ class CollectionsApi(object):
2184
2003
  Retrieve a single collection
2185
2004
  This method makes a synchronous HTTP request by default.
2186
2005
 
2187
- :param collection_id:
2188
- :type collection_id: str
2189
- :param join_avatars: add name and avatar to notes, defaults to false
2190
- :type join_avatars: bool, optional
2191
- :param join:
2192
- :type join: JoinType, optional
2193
- :param x_accept_feature:, defaults to []
2194
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
2195
- :param async_: Perform the request asynchronously
2196
- :type async_: bool, optional
2197
- :rtype: CollectionOutput
2006
+ :param str collection_id: (required)
2007
+ :param bool join_avatars: add name and avatar to notes
2008
+ :param JoinType join:
2009
+ :param list[union[HeaderFeature,str]] x_accept_feature:
2010
+ :param bool async_: Perform the request asynchronously
2011
+ :return: CollectionOutput
2198
2012
  """
2199
2013
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2200
2014
  kwargs['_return_http_data_only'] = True
@@ -2218,17 +2032,12 @@ class CollectionsApi(object):
2218
2032
  Retrieve a single collection
2219
2033
  This method makes a synchronous HTTP request by default.
2220
2034
 
2221
- :param collection_id:
2222
- :type collection_id: str
2223
- :param join_avatars: add name and avatar to notes, defaults to false
2224
- :type join_avatars: bool, optional
2225
- :param join:
2226
- :type join: JoinType, optional
2227
- :param x_accept_feature:, defaults to []
2228
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
2229
- :param async_: Perform the request asynchronously
2230
- :type async_: bool, optional
2231
- :rtype: CollectionOutput
2035
+ :param str collection_id: (required)
2036
+ :param bool join_avatars: add name and avatar to notes
2037
+ :param JoinType join:
2038
+ :param list[union[HeaderFeature,str]] x_accept_feature:
2039
+ :param bool async_: Perform the request asynchronously
2040
+ :return: CollectionOutput
2232
2041
  """
2233
2042
 
2234
2043
  all_params = ['collection_id','join_avatars','join','x_accept_feature',] # noqa: E501
@@ -2304,27 +2113,17 @@ class CollectionsApi(object):
2304
2113
  List acquisitions in a collection
2305
2114
  This method makes a synchronous HTTP request by default.
2306
2115
 
2307
- :param collection_id:
2308
- :type collection_id: str
2309
- :param session: The id of a session, to which the acquisitions returned will be restricted
2310
- :type session: str, optional
2311
- :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)
2312
- :type filter: str, optional
2313
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2314
- :type sort: str, optional
2315
- :param limit: The maximum number of entries to return.
2316
- :type limit: int, optional
2317
- :param skip: The number of entries to skip., defaults to 0
2318
- :type skip: int, optional
2319
- :param page: The page number (i.e. skip limit*page entries)
2320
- :type page: int, optional
2321
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2322
- :type after_id: str, optional
2323
- :param x_accept_feature:, defaults to []
2324
- :type x_accept_feature: list[str], optional
2325
- :param async_: Perform the request asynchronously
2326
- :type async_: bool, optional
2327
- :rtype: union[list[AcquisitionListOutput],Page]
2116
+ :param str collection_id: (required)
2117
+ :param str session: The id of a session, to which the acquisitions returned will be restricted
2118
+ :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)
2119
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2120
+ :param int limit: The maximum number of entries to return.
2121
+ :param int skip: The number of entries to skip.
2122
+ :param int page: The page number (i.e. skip limit*page entries)
2123
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2124
+ :param list[str] x_accept_feature:
2125
+ :param bool async_: Perform the request asynchronously
2126
+ :return: union[list[AcquisitionListOutput],Page]
2328
2127
  """
2329
2128
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2330
2129
  kwargs['_return_http_data_only'] = True
@@ -2348,27 +2147,17 @@ class CollectionsApi(object):
2348
2147
  List acquisitions in a collection
2349
2148
  This method makes a synchronous HTTP request by default.
2350
2149
 
2351
- :param collection_id:
2352
- :type collection_id: str
2353
- :param session: The id of a session, to which the acquisitions returned will be restricted
2354
- :type session: str, optional
2355
- :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)
2356
- :type filter: str, optional
2357
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2358
- :type sort: str, optional
2359
- :param limit: The maximum number of entries to return.
2360
- :type limit: int, optional
2361
- :param skip: The number of entries to skip., defaults to 0
2362
- :type skip: int, optional
2363
- :param page: The page number (i.e. skip limit*page entries)
2364
- :type page: int, optional
2365
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2366
- :type after_id: str, optional
2367
- :param x_accept_feature:, defaults to []
2368
- :type x_accept_feature: list[str], optional
2369
- :param async_: Perform the request asynchronously
2370
- :type async_: bool, optional
2371
- :rtype: union[list[AcquisitionListOutput],Page]
2150
+ :param str collection_id: (required)
2151
+ :param str session: The id of a session, to which the acquisitions returned will be restricted
2152
+ :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)
2153
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2154
+ :param int limit: The maximum number of entries to return.
2155
+ :param int skip: The number of entries to skip.
2156
+ :param int page: The page number (i.e. skip limit*page entries)
2157
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2158
+ :param list[str] x_accept_feature:
2159
+ :param bool async_: Perform the request asynchronously
2160
+ :return: union[list[AcquisitionListOutput],Page]
2372
2161
  """
2373
2162
 
2374
2163
  all_params = ['collection_id','session','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -2454,13 +2243,10 @@ class CollectionsApi(object):
2454
2243
  Get info for a particular file.
2455
2244
  This method makes a synchronous HTTP request by default.
2456
2245
 
2457
- :param cid: Container Id
2458
- :type cid: str
2459
- :param filename:
2460
- :type filename: str
2461
- :param async_: Perform the request asynchronously
2462
- :type async_: bool, optional
2463
- :rtype: FileOutput
2246
+ :param str cid: Container Id (required)
2247
+ :param str filename: (required)
2248
+ :param bool async_: Perform the request asynchronously
2249
+ :return: FileOutput
2464
2250
  """
2465
2251
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2466
2252
  kwargs['_return_http_data_only'] = True
@@ -2484,13 +2270,10 @@ class CollectionsApi(object):
2484
2270
  Get info for a particular file.
2485
2271
  This method makes a synchronous HTTP request by default.
2486
2272
 
2487
- :param cid: Container Id
2488
- :type cid: str
2489
- :param filename:
2490
- :type filename: str
2491
- :param async_: Perform the request asynchronously
2492
- :type async_: bool, optional
2493
- :rtype: FileOutput
2273
+ :param str cid: Container Id (required)
2274
+ :param str filename: (required)
2275
+ :param bool async_: Perform the request asynchronously
2276
+ :return: FileOutput
2494
2277
  """
2495
2278
 
2496
2279
  all_params = ['cid','filename',] # noqa: E501
@@ -2565,13 +2348,10 @@ class CollectionsApi(object):
2565
2348
  Get a note of a(n) collection
2566
2349
  This method makes a synchronous HTTP request by default.
2567
2350
 
2568
- :param cid:
2569
- :type cid: str
2570
- :param note_id:
2571
- :type note_id: str
2572
- :param async_: Perform the request asynchronously
2573
- :type async_: bool, optional
2574
- :rtype: Note
2351
+ :param str cid: (required)
2352
+ :param str note_id: (required)
2353
+ :param bool async_: Perform the request asynchronously
2354
+ :return: Note
2575
2355
  """
2576
2356
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2577
2357
  kwargs['_return_http_data_only'] = True
@@ -2595,13 +2375,10 @@ class CollectionsApi(object):
2595
2375
  Get a note of a(n) collection
2596
2376
  This method makes a synchronous HTTP request by default.
2597
2377
 
2598
- :param cid:
2599
- :type cid: str
2600
- :param note_id:
2601
- :type note_id: str
2602
- :param async_: Perform the request asynchronously
2603
- :type async_: bool, optional
2604
- :rtype: Note
2378
+ :param str cid: (required)
2379
+ :param str note_id: (required)
2380
+ :param bool async_: Perform the request asynchronously
2381
+ :return: Note
2605
2382
  """
2606
2383
 
2607
2384
  all_params = ['cid','note_id',] # noqa: E501
@@ -2676,27 +2453,17 @@ class CollectionsApi(object):
2676
2453
  List sessions in a collection.
2677
2454
  This method makes a synchronous HTTP request by default.
2678
2455
 
2679
- :param collection_id:
2680
- :type collection_id: str
2681
- :param include_all_info: Include all info in returned objects, defaults to false
2682
- :type include_all_info: bool, optional
2683
- :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)
2684
- :type filter: str, optional
2685
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2686
- :type sort: str, optional
2687
- :param limit: The maximum number of entries to return.
2688
- :type limit: int, optional
2689
- :param skip: The number of entries to skip., defaults to 0
2690
- :type skip: int, optional
2691
- :param page: The page number (i.e. skip limit*page entries)
2692
- :type page: int, optional
2693
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2694
- :type after_id: str, optional
2695
- :param x_accept_feature:, defaults to []
2696
- :type x_accept_feature: list[str], optional
2697
- :param async_: Perform the request asynchronously
2698
- :type async_: bool, optional
2699
- :rtype: union[list[SessionListOutput],Page]
2456
+ :param str collection_id: (required)
2457
+ :param bool include_all_info: Include all info in returned objects
2458
+ :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)
2459
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2460
+ :param int limit: The maximum number of entries to return.
2461
+ :param int skip: The number of entries to skip.
2462
+ :param int page: The page number (i.e. skip limit*page entries)
2463
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2464
+ :param list[str] x_accept_feature:
2465
+ :param bool async_: Perform the request asynchronously
2466
+ :return: union[list[SessionListOutput],Page]
2700
2467
  """
2701
2468
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2702
2469
  kwargs['_return_http_data_only'] = True
@@ -2720,27 +2487,17 @@ class CollectionsApi(object):
2720
2487
  List sessions in a collection.
2721
2488
  This method makes a synchronous HTTP request by default.
2722
2489
 
2723
- :param collection_id:
2724
- :type collection_id: str
2725
- :param include_all_info: Include all info in returned objects, defaults to false
2726
- :type include_all_info: bool, optional
2727
- :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)
2728
- :type filter: str, optional
2729
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
2730
- :type sort: str, optional
2731
- :param limit: The maximum number of entries to return.
2732
- :type limit: int, optional
2733
- :param skip: The number of entries to skip., defaults to 0
2734
- :type skip: int, optional
2735
- :param page: The page number (i.e. skip limit*page entries)
2736
- :type page: int, optional
2737
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2738
- :type after_id: str, optional
2739
- :param x_accept_feature:, defaults to []
2740
- :type x_accept_feature: list[str], optional
2741
- :param async_: Perform the request asynchronously
2742
- :type async_: bool, optional
2743
- :rtype: union[list[SessionListOutput],Page]
2490
+ :param str collection_id: (required)
2491
+ :param bool include_all_info: Include all info in returned objects
2492
+ :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)
2493
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
2494
+ :param int limit: The maximum number of entries to return.
2495
+ :param int skip: The number of entries to skip.
2496
+ :param int page: The page number (i.e. skip limit*page entries)
2497
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
2498
+ :param list[str] x_accept_feature:
2499
+ :param bool async_: Perform the request asynchronously
2500
+ :return: union[list[SessionListOutput],Page]
2744
2501
  """
2745
2502
 
2746
2503
  all_params = ['collection_id','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -2826,13 +2583,10 @@ class CollectionsApi(object):
2826
2583
  Get the value of a tag, by name
2827
2584
  This method makes a synchronous HTTP request by default.
2828
2585
 
2829
- :param cid:
2830
- :type cid: str
2831
- :param value: The tag to interact with
2832
- :type value: str
2833
- :param async_: Perform the request asynchronously
2834
- :type async_: bool, optional
2835
- :rtype: str
2586
+ :param str cid: (required)
2587
+ :param str value: The tag to interact with (required)
2588
+ :param bool async_: Perform the request asynchronously
2589
+ :return: str
2836
2590
  """
2837
2591
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2838
2592
  kwargs['_return_http_data_only'] = True
@@ -2856,13 +2610,10 @@ class CollectionsApi(object):
2856
2610
  Get the value of a tag, by name
2857
2611
  This method makes a synchronous HTTP request by default.
2858
2612
 
2859
- :param cid:
2860
- :type cid: str
2861
- :param value: The tag to interact with
2862
- :type value: str
2863
- :param async_: Perform the request asynchronously
2864
- :type async_: bool, optional
2865
- :rtype: str
2613
+ :param str cid: (required)
2614
+ :param str value: The tag to interact with (required)
2615
+ :param bool async_: Perform the request asynchronously
2616
+ :return: str
2866
2617
  """
2867
2618
 
2868
2619
  all_params = ['cid','value',] # noqa: E501
@@ -2937,13 +2688,10 @@ class CollectionsApi(object):
2937
2688
  List a user's permissions for this group
2938
2689
  This method makes a synchronous HTTP request by default.
2939
2690
 
2940
- :param collection_id:
2941
- :type collection_id: str
2942
- :param user_id:
2943
- :type user_id: str
2944
- :param async_: Perform the request asynchronously
2945
- :type async_: bool, optional
2946
- :rtype: AccessPermissionOutput
2691
+ :param str collection_id: (required)
2692
+ :param str user_id: (required)
2693
+ :param bool async_: Perform the request asynchronously
2694
+ :return: AccessPermissionOutput
2947
2695
  """
2948
2696
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2949
2697
  kwargs['_return_http_data_only'] = True
@@ -2967,13 +2715,10 @@ class CollectionsApi(object):
2967
2715
  List a user's permissions for this group
2968
2716
  This method makes a synchronous HTTP request by default.
2969
2717
 
2970
- :param collection_id:
2971
- :type collection_id: str
2972
- :param user_id:
2973
- :type user_id: str
2974
- :param async_: Perform the request asynchronously
2975
- :type async_: bool, optional
2976
- :rtype: AccessPermissionOutput
2718
+ :param str collection_id: (required)
2719
+ :param str user_id: (required)
2720
+ :param bool async_: Perform the request asynchronously
2721
+ :return: AccessPermissionOutput
2977
2722
  """
2978
2723
 
2979
2724
  all_params = ['collection_id','user_id',] # noqa: E501
@@ -3048,13 +2793,10 @@ class CollectionsApi(object):
3048
2793
  Update a collection and its contents
3049
2794
  This method makes a synchronous HTTP request by default.
3050
2795
 
3051
- :param collection_id:
3052
- :type collection_id: str
3053
- :param body:
3054
- :type body: CollectionInputWithContents
3055
- :param async_: Perform the request asynchronously
3056
- :type async_: bool, optional
3057
- :rtype: ModifiedResult
2796
+ :param str collection_id: (required)
2797
+ :param CollectionInputWithContents body: (required)
2798
+ :param bool async_: Perform the request asynchronously
2799
+ :return: ModifiedResult
3058
2800
  """
3059
2801
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3060
2802
  kwargs['_return_http_data_only'] = True
@@ -3078,13 +2820,10 @@ class CollectionsApi(object):
3078
2820
  Update a collection and its contents
3079
2821
  This method makes a synchronous HTTP request by default.
3080
2822
 
3081
- :param collection_id:
3082
- :type collection_id: str
3083
- :param body:
3084
- :type body: CollectionInputWithContents
3085
- :param async_: Perform the request asynchronously
3086
- :type async_: bool, optional
3087
- :rtype: ModifiedResult
2823
+ :param str collection_id: (required)
2824
+ :param CollectionInputWithContents body: (required)
2825
+ :param bool async_: Perform the request asynchronously
2826
+ :return: ModifiedResult
3088
2827
  """
3089
2828
 
3090
2829
  all_params = ['collection_id','body',] # noqa: E501
@@ -3170,15 +2909,11 @@ class CollectionsApi(object):
3170
2909
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
3171
2910
  This method makes a synchronous HTTP request by default.
3172
2911
 
3173
- :param cid:
3174
- :type cid: str
3175
- :param filename:
3176
- :type filename: str
3177
- :param body:
3178
- :type body: FileModifyInput
3179
- :param async_: Perform the request asynchronously
3180
- :type async_: bool, optional
3181
- :rtype: ModifiedResult
2912
+ :param str cid: (required)
2913
+ :param str filename: (required)
2914
+ :param FileModifyInput body: (required)
2915
+ :param bool async_: Perform the request asynchronously
2916
+ :return: ModifiedResult
3182
2917
  """
3183
2918
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3184
2919
  kwargs['_return_http_data_only'] = True
@@ -3202,15 +2937,11 @@ class CollectionsApi(object):
3202
2937
  Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
3203
2938
  This method makes a synchronous HTTP request by default.
3204
2939
 
3205
- :param cid:
3206
- :type cid: str
3207
- :param filename:
3208
- :type filename: str
3209
- :param body:
3210
- :type body: FileModifyInput
3211
- :param async_: Perform the request asynchronously
3212
- :type async_: bool, optional
3213
- :rtype: ModifiedResult
2940
+ :param str cid: (required)
2941
+ :param str filename: (required)
2942
+ :param FileModifyInput body: (required)
2943
+ :param bool async_: Perform the request asynchronously
2944
+ :return: ModifiedResult
3214
2945
  """
3215
2946
 
3216
2947
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3302,15 +3033,11 @@ class CollectionsApi(object):
3302
3033
  If replacing a file's classification, the modality can optionally be modified as well.
3303
3034
  This method makes a synchronous HTTP request by default.
3304
3035
 
3305
- :param cid:
3306
- :type cid: str
3307
- :param filename:
3308
- :type filename: str
3309
- :param body:
3310
- :type body: FileClassificationDelta
3311
- :param async_: Perform the request asynchronously
3312
- :type async_: bool, optional
3313
- :rtype: ModifiedResult
3036
+ :param str cid: (required)
3037
+ :param str filename: (required)
3038
+ :param FileClassificationDelta body: (required)
3039
+ :param bool async_: Perform the request asynchronously
3040
+ :return: ModifiedResult
3314
3041
  """
3315
3042
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3316
3043
  kwargs['_return_http_data_only'] = True
@@ -3334,15 +3061,11 @@ class CollectionsApi(object):
3334
3061
  If replacing a file's classification, the modality can optionally be modified as well.
3335
3062
  This method makes a synchronous HTTP request by default.
3336
3063
 
3337
- :param cid:
3338
- :type cid: str
3339
- :param filename:
3340
- :type filename: str
3341
- :param body:
3342
- :type body: FileClassificationDelta
3343
- :param async_: Perform the request asynchronously
3344
- :type async_: bool, optional
3345
- :rtype: ModifiedResult
3064
+ :param str cid: (required)
3065
+ :param str filename: (required)
3066
+ :param FileClassificationDelta body: (required)
3067
+ :param bool async_: Perform the request asynchronously
3068
+ :return: ModifiedResult
3346
3069
  """
3347
3070
 
3348
3071
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3434,15 +3157,11 @@ class CollectionsApi(object):
3434
3157
  Modify and return the file 'info' field
3435
3158
  This method makes a synchronous HTTP request by default.
3436
3159
 
3437
- :param cid:
3438
- :type cid: str
3439
- :param filename:
3440
- :type filename: str
3441
- :param body:
3442
- :type body: Info
3443
- :param async_: Perform the request asynchronously
3444
- :type async_: bool, optional
3445
- :rtype: ModifiedResult
3160
+ :param str cid: (required)
3161
+ :param str filename: (required)
3162
+ :param Info body: (required)
3163
+ :param bool async_: Perform the request asynchronously
3164
+ :return: ModifiedResult
3446
3165
  """
3447
3166
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3448
3167
  kwargs['_return_http_data_only'] = True
@@ -3466,15 +3185,11 @@ class CollectionsApi(object):
3466
3185
  Modify and return the file 'info' field
3467
3186
  This method makes a synchronous HTTP request by default.
3468
3187
 
3469
- :param cid:
3470
- :type cid: str
3471
- :param filename:
3472
- :type filename: str
3473
- :param body:
3474
- :type body: Info
3475
- :param async_: Perform the request asynchronously
3476
- :type async_: bool, optional
3477
- :rtype: ModifiedResult
3188
+ :param str cid: (required)
3189
+ :param str filename: (required)
3190
+ :param Info body: (required)
3191
+ :param bool async_: Perform the request asynchronously
3192
+ :return: ModifiedResult
3478
3193
  """
3479
3194
 
3480
3195
  all_params = ['cid','filename','body',] # noqa: E501
@@ -3566,13 +3281,10 @@ class CollectionsApi(object):
3566
3281
  Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
3567
3282
  This method makes a synchronous HTTP request by default.
3568
3283
 
3569
- :param cid:
3570
- :type cid: str
3571
- :param body:
3572
- :type body: Info
3573
- :param async_: Perform the request asynchronously
3574
- :type async_: bool, optional
3575
- :rtype: ModifiedResult
3284
+ :param str cid: (required)
3285
+ :param Info body: (required)
3286
+ :param bool async_: Perform the request asynchronously
3287
+ :return: ModifiedResult
3576
3288
  """
3577
3289
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3578
3290
  kwargs['_return_http_data_only'] = True
@@ -3596,13 +3308,10 @@ class CollectionsApi(object):
3596
3308
  Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
3597
3309
  This method makes a synchronous HTTP request by default.
3598
3310
 
3599
- :param cid:
3600
- :type cid: str
3601
- :param body:
3602
- :type body: Info
3603
- :param async_: Perform the request asynchronously
3604
- :type async_: bool, optional
3605
- :rtype: ModifiedResult
3311
+ :param str cid: (required)
3312
+ :param Info body: (required)
3313
+ :param bool async_: Perform the request asynchronously
3314
+ :return: ModifiedResult
3606
3315
  """
3607
3316
 
3608
3317
  all_params = ['cid','body',] # noqa: E501
@@ -3688,15 +3397,11 @@ class CollectionsApi(object):
3688
3397
  Update a note of a(n) collection
3689
3398
  This method makes a synchronous HTTP request by default.
3690
3399
 
3691
- :param cid:
3692
- :type cid: str
3693
- :param note_id:
3694
- :type note_id: str
3695
- :param body:
3696
- :type body: NoteInput
3697
- :param async_: Perform the request asynchronously
3698
- :type async_: bool, optional
3699
- :rtype: int
3400
+ :param str cid: (required)
3401
+ :param str note_id: (required)
3402
+ :param NoteInput body: (required)
3403
+ :param bool async_: Perform the request asynchronously
3404
+ :return: int
3700
3405
  """
3701
3406
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3702
3407
  kwargs['_return_http_data_only'] = True
@@ -3720,15 +3425,11 @@ class CollectionsApi(object):
3720
3425
  Update a note of a(n) collection
3721
3426
  This method makes a synchronous HTTP request by default.
3722
3427
 
3723
- :param cid:
3724
- :type cid: str
3725
- :param note_id:
3726
- :type note_id: str
3727
- :param body:
3728
- :type body: NoteInput
3729
- :param async_: Perform the request asynchronously
3730
- :type async_: bool, optional
3731
- :rtype: int
3428
+ :param str cid: (required)
3429
+ :param str note_id: (required)
3430
+ :param NoteInput body: (required)
3431
+ :param bool async_: Perform the request asynchronously
3432
+ :return: int
3732
3433
  """
3733
3434
 
3734
3435
  all_params = ['cid','note_id','body',] # noqa: E501
@@ -3820,15 +3521,11 @@ class CollectionsApi(object):
3820
3521
  Update a users permission for this group
3821
3522
  This method makes a synchronous HTTP request by default.
3822
3523
 
3823
- :param collection_id:
3824
- :type collection_id: str
3825
- :param user_id:
3826
- :type user_id: str
3827
- :param body:
3828
- :type body: AccessPermissionUpdate
3829
- :param async_: Perform the request asynchronously
3830
- :type async_: bool, optional
3831
- :rtype: AccessPermissionOutput
3524
+ :param str collection_id: (required)
3525
+ :param str user_id: (required)
3526
+ :param AccessPermissionUpdate body: (required)
3527
+ :param bool async_: Perform the request asynchronously
3528
+ :return: AccessPermissionOutput
3832
3529
  """
3833
3530
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3834
3531
  kwargs['_return_http_data_only'] = True
@@ -3852,15 +3549,11 @@ class CollectionsApi(object):
3852
3549
  Update a users permission for this group
3853
3550
  This method makes a synchronous HTTP request by default.
3854
3551
 
3855
- :param collection_id:
3856
- :type collection_id: str
3857
- :param user_id:
3858
- :type user_id: str
3859
- :param body:
3860
- :type body: AccessPermissionUpdate
3861
- :param async_: Perform the request asynchronously
3862
- :type async_: bool, optional
3863
- :rtype: AccessPermissionOutput
3552
+ :param str collection_id: (required)
3553
+ :param str user_id: (required)
3554
+ :param AccessPermissionUpdate body: (required)
3555
+ :param bool async_: Perform the request asynchronously
3556
+ :return: AccessPermissionOutput
3864
3557
  """
3865
3558
 
3866
3559
  all_params = ['collection_id','user_id','body',] # noqa: E501
@@ -3952,15 +3645,11 @@ class CollectionsApi(object):
3952
3645
  Rename a tag
3953
3646
  This method makes a synchronous HTTP request by default.
3954
3647
 
3955
- :param cid:
3956
- :type cid: str
3957
- :param value: The tag to interact with
3958
- :type value: str
3959
- :param body:
3960
- :type body: Tag
3961
- :param async_: Perform the request asynchronously
3962
- :type async_: bool, optional
3963
- :rtype: str
3648
+ :param str cid: (required)
3649
+ :param str value: The tag to interact with (required)
3650
+ :param Tag body: (required)
3651
+ :param bool async_: Perform the request asynchronously
3652
+ :return: str
3964
3653
  """
3965
3654
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
3966
3655
  kwargs['_return_http_data_only'] = True
@@ -3984,15 +3673,11 @@ class CollectionsApi(object):
3984
3673
  Rename a tag
3985
3674
  This method makes a synchronous HTTP request by default.
3986
3675
 
3987
- :param cid:
3988
- :type cid: str
3989
- :param value: The tag to interact with
3990
- :type value: str
3991
- :param body:
3992
- :type body: Tag
3993
- :param async_: Perform the request asynchronously
3994
- :type async_: bool, optional
3995
- :rtype: str
3676
+ :param str cid: (required)
3677
+ :param str value: The tag to interact with (required)
3678
+ :param Tag body: (required)
3679
+ :param bool async_: Perform the request asynchronously
3680
+ :return: str
3996
3681
  """
3997
3682
 
3998
3683
  all_params = ['cid','value','body',] # noqa: E501
@@ -4084,29 +3769,18 @@ class CollectionsApi(object):
4084
3769
  Upload a file to a(n) collection.
4085
3770
  This method makes a synchronous HTTP request by default.
4086
3771
 
4087
- :param container_id:
4088
- :type container_id: str
4089
- :param file: The file to upload
4090
- :type file: str
4091
- :param preserve_metadata:, defaults to false
4092
- :type preserve_metadata: bool, optional
4093
- :param ticket:
4094
- :type ticket: str, optional
4095
- :param id:
4096
- :type id: str, optional
4097
- :param level:
4098
- :type level: ContainerType, optional
4099
- :param job:
4100
- :type job: str, optional
4101
- :param metadata: Dictionary of file metadata (type, modality, info, etc.)
4102
- :type metadata: object, optional
4103
- :param x_accept_feature: redirect header, defaults to []
4104
- :type x_accept_feature: list[str], optional
4105
- :param content_type:
4106
- :type content_type: str, optional
4107
- :param async_: Perform the request asynchronously
4108
- :type async_: bool, optional
4109
- :rtype: union[list[FileOutput],UploadTicketOutput]
3772
+ :param str container_id: (required)
3773
+ :param str file: The file to upload (required)
3774
+ :param bool preserve_metadata:
3775
+ :param str ticket:
3776
+ :param str id:
3777
+ :param ContainerType level:
3778
+ :param str job:
3779
+ :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
3780
+ :param list[str] x_accept_feature: redirect header
3781
+ :param str content_type:
3782
+ :param bool async_: Perform the request asynchronously
3783
+ :return: union[list[FileOutput],UploadTicketOutput]
4110
3784
  """
4111
3785
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
4112
3786
  kwargs['_return_http_data_only'] = True
@@ -4130,29 +3804,18 @@ class CollectionsApi(object):
4130
3804
  Upload a file to a(n) collection.
4131
3805
  This method makes a synchronous HTTP request by default.
4132
3806
 
4133
- :param container_id:
4134
- :type container_id: str
4135
- :param file: The file to upload
4136
- :type file: str
4137
- :param preserve_metadata:, defaults to false
4138
- :type preserve_metadata: bool, optional
4139
- :param ticket:
4140
- :type ticket: str, optional
4141
- :param id:
4142
- :type id: str, optional
4143
- :param level:
4144
- :type level: ContainerType, optional
4145
- :param job:
4146
- :type job: str, optional
4147
- :param metadata: Dictionary of file metadata (type, modality, info, etc.)
4148
- :type metadata: object, optional
4149
- :param x_accept_feature: redirect header, defaults to []
4150
- :type x_accept_feature: list[str], optional
4151
- :param content_type:
4152
- :type content_type: str, optional
4153
- :param async_: Perform the request asynchronously
4154
- :type async_: bool, optional
4155
- :rtype: union[list[FileOutput],UploadTicketOutput]
3807
+ :param str container_id: (required)
3808
+ :param str file: The file to upload (required)
3809
+ :param bool preserve_metadata:
3810
+ :param str ticket:
3811
+ :param str id:
3812
+ :param ContainerType level:
3813
+ :param str job:
3814
+ :param object metadata: Dictionary of file metadata (type, modality, info, etc.)
3815
+ :param list[str] x_accept_feature: redirect header
3816
+ :param str content_type:
3817
+ :param bool async_: Perform the request asynchronously
3818
+ :return: union[list[FileOutput],UploadTicketOutput]
4156
3819
  """
4157
3820
 
4158
3821
  all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501