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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (773) hide show
  1. flywheel/__init__.py +7 -8
  2. flywheel/api/acquisitions_api.py +1033 -569
  3. flywheel/api/analyses_api.py +786 -432
  4. flywheel/api/audit_trail_api.py +78 -51
  5. flywheel/api/auth_api.py +6 -11
  6. flywheel/api/batch_api.py +60 -43
  7. flywheel/api/bulk_api.py +10 -13
  8. flywheel/api/change_log_api.py +40 -29
  9. flywheel/api/collections_api.py +740 -410
  10. flywheel/api/config_api.py +18 -19
  11. flywheel/api/container_tasks_api.py +14 -15
  12. flywheel/api/container_type_api.py +14 -15
  13. flywheel/api/containers_api.py +989 -545
  14. flywheel/api/custom_filters_api.py +64 -43
  15. flywheel/api/data_view_executions_api.py +94 -59
  16. flywheel/api/dataexplorer_api.py +158 -99
  17. flywheel/api/devices_api.py +132 -83
  18. flywheel/api/dimse_api.py +72 -51
  19. flywheel/api/download_api.py +46 -32
  20. flywheel/api/files_api.py +266 -157
  21. flywheel/api/form_responses_api.py +100 -63
  22. flywheel/api/gears_api.py +278 -163
  23. flywheel/api/groups_api.py +426 -245
  24. flywheel/api/jobs_api.py +288 -173
  25. flywheel/api/jupyterlab_servers_api.py +24 -21
  26. flywheel/api/modalities_api.py +78 -51
  27. flywheel/api/packfiles_api.py +6 -11
  28. flywheel/api/projects_api.py +1661 -856
  29. flywheel/api/protocols_api.py +94 -61
  30. flywheel/api/reports_api.py +196 -115
  31. flywheel/api/resolve_api.py +48 -33
  32. flywheel/api/roles_api.py +82 -53
  33. flywheel/api/sessions_api.py +1137 -623
  34. flywheel/api/site_api.py +182 -113
  35. flywheel/api/staffing_pools_api.py +88 -57
  36. flywheel/api/subjects_api.py +1095 -603
  37. flywheel/api/tasks_api.py +108 -69
  38. flywheel/api/tree_api.py +52 -35
  39. flywheel/api/uids_api.py +10 -13
  40. flywheel/api/upload_api.py +162 -95
  41. flywheel/api/users_api.py +418 -235
  42. flywheel/api/views_api.py +222 -127
  43. flywheel/api_client.py +19 -18
  44. flywheel/configuration.py +2 -9
  45. flywheel/file_spec.py +0 -7
  46. flywheel/flywheel.py +818 -4423
  47. flywheel/gear_context.py +10 -10
  48. flywheel/models/__init__.py +7 -8
  49. flywheel/models/access_level.py +0 -7
  50. flywheel/models/access_permission.py +13 -14
  51. flywheel/models/access_permission_output.py +13 -14
  52. flywheel/models/access_permission_update.py +8 -11
  53. flywheel/models/access_type.py +0 -7
  54. flywheel/models/accumulator.py +0 -7
  55. flywheel/models/acquisition.py +0 -7
  56. flywheel/models/acquisition_container_output.py +0 -7
  57. flywheel/models/acquisition_copy_input.py +18 -17
  58. flywheel/models/acquisition_input.py +33 -26
  59. flywheel/models/acquisition_list_output.py +118 -77
  60. flywheel/models/acquisition_modify_input.py +33 -26
  61. flywheel/models/acquisition_node.py +0 -7
  62. flywheel/models/acquisition_output.py +118 -77
  63. flywheel/models/acquisition_parents.py +23 -20
  64. flywheel/models/acquisition_template_options.py +28 -23
  65. flywheel/models/acquisition_upsert_input.py +48 -35
  66. flywheel/models/acquisition_upsert_output.py +23 -20
  67. flywheel/models/action.py +1 -7
  68. flywheel/models/adhoc_analysis_input.py +23 -20
  69. flywheel/models/analysis.py +0 -7
  70. flywheel/models/analysis_container_output.py +0 -7
  71. flywheel/models/analysis_files_create_ticket_output.py +23 -20
  72. flywheel/models/analysis_input.py +33 -26
  73. flywheel/models/analysis_input_legacy.py +0 -7
  74. flywheel/models/analysis_list_output.py +103 -68
  75. flywheel/models/analysis_list_output_inflated_job.py +98 -65
  76. flywheel/models/analysis_modify_input.py +13 -14
  77. flywheel/models/analysis_node.py +0 -7
  78. flywheel/models/analysis_output.py +103 -68
  79. flywheel/models/analysis_output_inflated_job.py +103 -68
  80. flywheel/models/analysis_parents.py +28 -23
  81. flywheel/models/analysis_update.py +0 -7
  82. flywheel/models/api_key_input_with_optional_label.py +13 -14
  83. flywheel/models/api_key_output.py +33 -26
  84. flywheel/models/as_storage.py +33 -26
  85. flywheel/models/assignee.py +13 -14
  86. flywheel/models/assignee_type.py +0 -7
  87. flywheel/models/audit_trail_report.py +68 -47
  88. flywheel/models/audit_trail_report_status.py +0 -7
  89. flywheel/models/auth0_auth_out.py +38 -29
  90. flywheel/models/auth0_options_out.py +38 -29
  91. flywheel/models/auth_out.py +34 -82
  92. flywheel/models/auth_session_output.py +28 -23
  93. flywheel/models/avatars.py +18 -17
  94. flywheel/models/aws_creds.py +13 -14
  95. flywheel/models/aws_storage.py +43 -32
  96. flywheel/models/azure_creds.py +13 -14
  97. flywheel/models/base_aet.py +23 -20
  98. flywheel/models/base_compute.py +58 -41
  99. flywheel/models/batch.py +43 -32
  100. flywheel/models/batch_cancel_output.py +0 -7
  101. flywheel/models/batch_create_filters.py +18 -17
  102. flywheel/models/batch_job_analysis_input.py +28 -23
  103. flywheel/models/batch_jobs_proposal_input.py +0 -7
  104. flywheel/models/batch_proposal.py +0 -7
  105. flywheel/models/batch_proposal_detail.py +0 -7
  106. flywheel/models/batch_proposal_input.py +0 -7
  107. flywheel/models/body.py +0 -7
  108. flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +0 -7
  109. flywheel/models/body_region.py +0 -7
  110. flywheel/models/bookmark.py +13 -14
  111. flywheel/models/bulk_move_input.py +28 -23
  112. flywheel/models/bulk_move_sessions.py +0 -7
  113. flywheel/models/callbacks_virus_scan_input.py +0 -7
  114. flywheel/models/cancelled_batch_output.py +8 -11
  115. flywheel/models/catalog_list_output.py +53 -38
  116. flywheel/models/central_out.py +33 -26
  117. flywheel/models/change.py +80 -39
  118. flywheel/models/change_log_container_type.py +0 -7
  119. flywheel/models/change_log_document.py +23 -20
  120. flywheel/models/change_method.py +1 -7
  121. flywheel/models/classic_batch_job_output.py +43 -32
  122. flywheel/models/classic_batch_job_output_inflated_jobs.py +48 -35
  123. flywheel/models/classic_batch_proposal_input.py +48 -35
  124. flywheel/models/classic_batch_proposal_output.py +63 -44
  125. flywheel/models/classification_add_delete.py +0 -7
  126. flywheel/models/classification_replace.py +0 -7
  127. flywheel/models/classification_update_input.py +0 -7
  128. flywheel/models/cohort.py +0 -7
  129. flywheel/models/collection.py +0 -7
  130. flywheel/models/collection_container_output.py +0 -7
  131. flywheel/models/collection_input.py +18 -17
  132. flywheel/models/collection_input_with_contents.py +23 -20
  133. flywheel/models/collection_node.py +13 -14
  134. flywheel/models/collection_node_level.py +0 -7
  135. flywheel/models/collection_operation.py +13 -14
  136. flywheel/models/collection_operation_type.py +0 -7
  137. flywheel/models/collection_output.py +93 -62
  138. flywheel/models/collection_with_stats.py +93 -62
  139. flywheel/models/column.py +28 -23
  140. flywheel/models/column_type.py +0 -7
  141. flywheel/models/common_classification.py +3 -8
  142. flywheel/models/common_deleted_count.py +0 -7
  143. flywheel/models/common_editions.py +0 -7
  144. flywheel/models/common_info.py +3 -8
  145. flywheel/models/common_join_origins.py +0 -7
  146. flywheel/models/common_key.py +0 -7
  147. flywheel/models/common_modified_count.py +0 -7
  148. flywheel/models/common_object_created.py +0 -7
  149. flywheel/models/common_project_settings.py +0 -7
  150. flywheel/models/common_settings.py +0 -7
  151. flywheel/models/complete_multipart_upload_output.py +13 -14
  152. flywheel/models/complete_s3_multipart_upload_input.py +23 -20
  153. flywheel/models/config_feature_map.py +0 -7
  154. flywheel/models/config_out.py +48 -35
  155. flywheel/models/config_output.py +0 -7
  156. flywheel/models/config_site_config_output.py +0 -7
  157. flywheel/models/config_site_settings.py +0 -7
  158. flywheel/models/config_site_settings_input.py +0 -7
  159. flywheel/models/conflict_types.py +0 -7
  160. flywheel/models/container_delete_reason.py +0 -7
  161. flywheel/models/container_filter.py +13 -14
  162. flywheel/models/container_id_view_input.py +73 -50
  163. flywheel/models/container_id_view_input_execute_and_save.py +33 -26
  164. flywheel/models/container_modify.py +73 -50
  165. flywheel/models/container_new_output.py +0 -7
  166. flywheel/models/container_node_min.py +43 -32
  167. flywheel/models/container_output.py +0 -7
  168. flywheel/models/container_output_with_files.py +28 -23
  169. flywheel/models/container_parents.py +33 -26
  170. flywheel/models/container_pipeline_input.py +73 -50
  171. flywheel/models/container_project_parents.py +0 -7
  172. flywheel/models/container_reference.py +13 -14
  173. flywheel/models/container_reference_with_label.py +18 -17
  174. flywheel/models/container_session_parents.py +0 -7
  175. flywheel/models/container_subject_parents.py +0 -7
  176. flywheel/models/container_type.py +2 -7
  177. flywheel/models/container_uidcheck.py +23 -20
  178. flywheel/models/container_update.py +3 -8
  179. flywheel/models/context_input.py +18 -17
  180. flywheel/models/copy_filter.py +33 -26
  181. flywheel/models/copy_status.py +0 -7
  182. flywheel/models/core_models_api_key_api_key_input.py +13 -14
  183. flywheel/models/core_models_audit_trail_create_report_input.py +28 -23
  184. flywheel/models/core_models_audit_trail_modify_report_input.py +8 -11
  185. flywheel/models/core_models_common_source.py +13 -14
  186. flywheel/models/core_models_jobs_api_key_input.py +13 -14
  187. flywheel/models/core_models_search_parent_type.py +0 -7
  188. flywheel/models/core_workflows_form_responses_models_form_parents.py +157 -15
  189. flywheel/models/core_workflows_form_responses_models_form_response_output.py +58 -41
  190. flywheel/models/core_workflows_reader_models_reader_task_parents.py +33 -26
  191. flywheel/models/creds.py +3 -8
  192. flywheel/models/curator.py +18 -17
  193. flywheel/models/current_user_output.py +108 -71
  194. flywheel/models/custom_field.py +61 -44
  195. flywheel/models/custom_form.py +23 -20
  196. flywheel/models/cvat_info.py +28 -23
  197. flywheel/models/cvat_settings.py +28 -23
  198. flywheel/models/cvat_settings_input.py +28 -23
  199. flywheel/models/cvat_sync_state.py +0 -7
  200. flywheel/models/daily_report_usage.py +78 -53
  201. flywheel/models/data_strategy.py +0 -7
  202. flywheel/models/data_view.py +0 -7
  203. flywheel/models/data_view_analysis_file_spec.py +18 -17
  204. flywheel/models/data_view_analysis_filter_spec.py +18 -17
  205. flywheel/models/data_view_column_alias.py +38 -29
  206. flywheel/models/data_view_column_spec.py +28 -23
  207. flywheel/models/data_view_execution.py +68 -47
  208. flywheel/models/data_view_execution_state.py +0 -7
  209. flywheel/models/data_view_file_spec.py +48 -35
  210. flywheel/models/data_view_group_by.py +8 -11
  211. flywheel/models/data_view_group_by_column.py +13 -14
  212. flywheel/models/data_view_name_filter_spec.py +13 -14
  213. flywheel/models/data_view_output.py +0 -7
  214. flywheel/models/data_view_save_data_view_input.py +0 -7
  215. flywheel/models/data_view_zip_filter_spec.py +18 -17
  216. flywheel/models/default_flywheel_role.py +0 -7
  217. flywheel/models/deid_log_skip_reason.py +0 -7
  218. flywheel/models/delete_by_search_query.py +23 -20
  219. flywheel/models/delete_status.py +25 -0
  220. flywheel/models/deleted_file.py +73 -50
  221. flywheel/models/deleted_result.py +50 -19
  222. flywheel/models/deprecated_action.py +0 -7
  223. flywheel/models/destination_container_type.py +0 -7
  224. flywheel/models/device.py +58 -41
  225. flywheel/models/device_admin_update.py +13 -14
  226. flywheel/models/device_create.py +18 -17
  227. flywheel/models/device_self_update.py +28 -23
  228. flywheel/models/device_status.py +0 -7
  229. flywheel/models/device_status_entry.py +18 -17
  230. flywheel/models/device_storage_strategy_update.py +13 -14
  231. flywheel/models/dimse_project_input.py +0 -7
  232. flywheel/models/dimse_project_output.py +0 -7
  233. flywheel/models/dimse_service_input.py +0 -7
  234. flywheel/models/dimse_service_output.py +0 -7
  235. flywheel/models/download.py +23 -20
  236. flywheel/models/download_container_filter.py +8 -11
  237. flywheel/models/download_container_filter_definition.py +18 -17
  238. flywheel/models/download_filter.py +18 -17
  239. flywheel/models/download_filter_definition.py +13 -14
  240. flywheel/models/download_format.py +0 -7
  241. flywheel/models/download_input.py +0 -7
  242. flywheel/models/download_node.py +13 -14
  243. flywheel/models/download_strategy.py +0 -7
  244. flywheel/models/download_ticket.py +0 -7
  245. flywheel/models/download_ticket_stub.py +23 -20
  246. flywheel/models/download_ticket_with_summary.py +0 -7
  247. flywheel/models/e_signature.py +23 -20
  248. flywheel/models/edition.py +8 -11
  249. flywheel/models/egress_device.py +88 -59
  250. flywheel/models/egress_device_page.py +18 -17
  251. flywheel/models/egress_provider.py +53 -38
  252. flywheel/models/egress_provider_id.py +8 -11
  253. flywheel/models/exchange_storage.py +23 -20
  254. flywheel/models/executor_info.py +43 -32
  255. flywheel/models/export_templates.py +13 -14
  256. flywheel/models/features.py +457 -307
  257. flywheel/models/field_change.py +28 -23
  258. flywheel/models/field_change_log_document.py +23 -20
  259. flywheel/models/field_type.py +0 -7
  260. flywheel/models/file.py +188 -119
  261. flywheel/models/file_classification_delta.py +23 -20
  262. flywheel/models/file_container_type.py +0 -7
  263. flywheel/models/file_entry.py +108 -71
  264. flywheel/models/file_export_templates.py +28 -23
  265. flywheel/models/file_format.py +0 -7
  266. flywheel/models/file_gear_info.py +18 -17
  267. flywheel/models/file_group.py +0 -7
  268. flywheel/models/file_list_output.py +183 -116
  269. flywheel/models/file_modify_input.py +13 -14
  270. flywheel/models/file_move_input.py +18 -17
  271. flywheel/models/file_node.py +188 -119
  272. flywheel/models/file_node_min.py +38 -29
  273. flywheel/models/file_origin.py +28 -23
  274. flywheel/models/file_output.py +183 -116
  275. flywheel/models/file_parents.py +33 -26
  276. flywheel/models/file_reference.py +18 -17
  277. flywheel/models/file_suggestion.py +23 -20
  278. flywheel/models/file_template_options.py +33 -26
  279. flywheel/models/file_upsert_input.py +88 -59
  280. flywheel/models/file_upsert_origin.py +0 -7
  281. flywheel/models/file_upsert_output.py +188 -119
  282. flywheel/models/file_version.py +13 -14
  283. flywheel/models/file_version_copy_of.py +28 -23
  284. flywheel/models/file_version_output.py +38 -29
  285. flywheel/models/file_via.py +23 -20
  286. flywheel/models/file_zip_entry.py +0 -7
  287. flywheel/models/file_zip_info.py +0 -7
  288. flywheel/models/filter.py +43 -32
  289. flywheel/models/filter_input.py +18 -17
  290. flywheel/models/filter_values.py +13 -14
  291. flywheel/models/filter_view.py +0 -7
  292. flywheel/models/fixed_file_version_input.py +18 -17
  293. flywheel/models/fixed_input.py +33 -26
  294. flywheel/models/form_definition.py +8 -11
  295. flywheel/models/form_response_base.py +33 -26
  296. flywheel/models/form_response_create.py +13 -14
  297. flywheel/models/gcp_creds.py +53 -38
  298. flywheel/models/gcp_storage.py +33 -26
  299. flywheel/models/gear.py +88 -59
  300. flywheel/models/gear_category.py +0 -7
  301. flywheel/models/gear_config.py +3 -8
  302. flywheel/models/gear_context_input.py +8 -11
  303. flywheel/models/gear_context_lookup.py +0 -7
  304. flywheel/models/gear_context_lookup_item.py +0 -7
  305. flywheel/models/gear_context_value_output.py +28 -23
  306. flywheel/models/gear_context_value_output_unfound.py +8 -11
  307. flywheel/models/gear_custom.py +3 -8
  308. flywheel/models/gear_directive.py +3 -8
  309. flywheel/models/gear_doc.py +0 -7
  310. flywheel/models/gear_document.py +38 -29
  311. flywheel/models/gear_document_input.py +33 -26
  312. flywheel/models/gear_document_legacy_input.py +33 -26
  313. flywheel/models/gear_environment.py +3 -8
  314. flywheel/models/gear_exchange.py +18 -17
  315. flywheel/models/gear_file_input.py +13 -14
  316. flywheel/models/gear_id_output.py +8 -11
  317. flywheel/models/gear_info.py +23 -20
  318. flywheel/models/gear_input_item.py +18 -17
  319. flywheel/models/gear_inputs.py +3 -8
  320. flywheel/models/gear_key_input.py +13 -14
  321. flywheel/models/gear_manifest.py +93 -62
  322. flywheel/models/gear_mixin.py +26 -6
  323. flywheel/models/gear_node.py +43 -32
  324. flywheel/models/gear_output_configuration.py +8 -11
  325. flywheel/models/gear_permissions.py +13 -14
  326. flywheel/models/gear_permissions_input.py +8 -11
  327. flywheel/models/gear_permissions_type.py +0 -7
  328. flywheel/models/gear_return_ticket.py +0 -7
  329. flywheel/models/gear_rule.py +133 -69
  330. flywheel/models/gear_rule_condition.py +18 -17
  331. flywheel/models/gear_rule_condition_type.py +0 -7
  332. flywheel/models/gear_rule_input.py +108 -54
  333. flywheel/models/gear_rule_modify_input.py +103 -51
  334. flywheel/models/gear_rule_output.py +133 -69
  335. flywheel/models/gear_save_submission.py +18 -17
  336. flywheel/models/gear_series.py +33 -26
  337. flywheel/models/gear_series_update.py +8 -11
  338. flywheel/models/gear_suggestion_output.py +33 -26
  339. flywheel/models/gear_ticket.py +23 -20
  340. flywheel/models/gear_ticket_output.py +8 -11
  341. flywheel/models/graph_filter.py +38 -29
  342. flywheel/models/group.py +0 -7
  343. flywheel/models/group_by.py +8 -11
  344. flywheel/models/group_by_column.py +0 -7
  345. flywheel/models/group_container_output.py +0 -7
  346. flywheel/models/group_input.py +23 -20
  347. flywheel/models/group_metadata_input.py +0 -7
  348. flywheel/models/group_node.py +0 -7
  349. flywheel/models/group_output.py +63 -44
  350. flywheel/models/group_report.py +18 -17
  351. flywheel/models/group_role.py +8 -11
  352. flywheel/models/group_settings_output.py +23 -20
  353. flywheel/models/group_update.py +23 -20
  354. flywheel/models/header_feature.py +0 -7
  355. flywheel/models/hierarchy_export_templates.py +28 -23
  356. flywheel/models/http_validation_error.py +8 -11
  357. flywheel/models/info.py +18 -17
  358. flywheel/models/info_add_remove.py +0 -7
  359. flywheel/models/info_container_type.py +0 -7
  360. flywheel/models/info_replace.py +0 -7
  361. flywheel/models/info_update_input.py +0 -7
  362. flywheel/models/ingress_provider.py +33 -26
  363. flywheel/models/ingress_providers.py +28 -23
  364. flywheel/models/ingress_site_settings.py +29 -52
  365. flywheel/models/ingress_update_provider.py +18 -17
  366. flywheel/models/inline_response200.py +8 -11
  367. flywheel/models/inline_response2001.py +8 -11
  368. flywheel/models/inline_response2002.py +8 -11
  369. flywheel/models/inline_response2003.py +0 -7
  370. flywheel/models/inline_response2005.py +0 -7
  371. flywheel/models/input_filter.py +18 -17
  372. flywheel/models/input_job.py +73 -50
  373. flywheel/models/input_job_profile.py +28 -23
  374. flywheel/models/inserted_id.py +8 -11
  375. flywheel/models/job.py +128 -83
  376. flywheel/models/job_analysis_input.py +28 -23
  377. flywheel/models/job_ask.py +33 -26
  378. flywheel/models/job_ask_response.py +13 -14
  379. flywheel/models/job_ask_response_job.py +158 -101
  380. flywheel/models/job_ask_return.py +0 -7
  381. flywheel/models/job_ask_return_criteria.py +23 -20
  382. flywheel/models/job_ask_state.py +0 -7
  383. flywheel/models/job_ask_state_response.py +8 -11
  384. flywheel/models/job_complete.py +18 -17
  385. flywheel/models/job_completion_input.py +0 -7
  386. flywheel/models/job_completion_ticket.py +0 -7
  387. flywheel/models/job_config.py +3 -8
  388. flywheel/models/job_config_input.py +28 -23
  389. flywheel/models/job_config_inputs.py +0 -7
  390. flywheel/models/job_config_output.py +0 -7
  391. flywheel/models/job_container_detail.py +0 -7
  392. flywheel/models/job_destination.py +13 -14
  393. flywheel/models/job_detail.py +148 -95
  394. flywheel/models/job_detail_container.py +13 -14
  395. flywheel/models/job_detail_file_entry.py +13 -14
  396. flywheel/models/job_detail_group.py +13 -14
  397. flywheel/models/job_detail_parent_info.py +33 -26
  398. flywheel/models/job_executor_info.py +43 -32
  399. flywheel/models/job_file_input.py +23 -20
  400. flywheel/models/job_file_input_list_output.py +23 -20
  401. flywheel/models/job_file_object.py +58 -41
  402. flywheel/models/job_file_object_list_output.py +53 -38
  403. flywheel/models/job_gear_match.py +0 -7
  404. flywheel/models/job_inputs_array_item.py +33 -26
  405. flywheel/models/job_inputs_item.py +23 -20
  406. flywheel/models/job_inputs_object.py +3 -8
  407. flywheel/models/job_list_entry.py +0 -7
  408. flywheel/models/job_list_output.py +158 -101
  409. flywheel/models/job_list_output_config.py +18 -17
  410. flywheel/models/job_log.py +13 -14
  411. flywheel/models/job_log_column.py +0 -7
  412. flywheel/models/job_log_record.py +13 -14
  413. flywheel/models/job_modify.py +13 -14
  414. flywheel/models/job_origin.py +13 -14
  415. flywheel/models/job_output.py +163 -104
  416. flywheel/models/job_output_config.py +23 -20
  417. flywheel/models/job_parents.py +33 -26
  418. flywheel/models/job_priority.py +0 -7
  419. flywheel/models/job_priority_update.py +13 -14
  420. flywheel/models/job_profile.py +53 -38
  421. flywheel/models/job_profile_input.py +0 -7
  422. flywheel/models/job_request.py +18 -17
  423. flywheel/models/job_request_item.py +23 -20
  424. flywheel/models/job_request_item_type.py +0 -7
  425. flywheel/models/job_request_target.py +28 -23
  426. flywheel/models/job_state.py +0 -7
  427. flywheel/models/job_state_counts.py +0 -7
  428. flywheel/models/job_stats_by_state.py +0 -7
  429. flywheel/models/job_ticket_output.py +8 -11
  430. flywheel/models/job_transition_times.py +23 -20
  431. flywheel/models/job_version_info.py +3 -8
  432. flywheel/models/jobs_by_state.py +28 -23
  433. flywheel/models/jobs_list.py +8 -11
  434. flywheel/models/join_origin_device.py +8 -11
  435. flywheel/models/join_origin_job.py +18 -17
  436. flywheel/models/join_origin_user.py +13 -14
  437. flywheel/models/join_origins.py +18 -17
  438. flywheel/models/join_type.py +0 -7
  439. flywheel/models/jupyterhub_workspace.py +8 -11
  440. flywheel/models/jupyterlab_server_modify.py +28 -23
  441. flywheel/models/jupyterlab_server_origin.py +0 -7
  442. flywheel/models/jupyterlab_server_output.py +0 -7
  443. flywheel/models/jupyterlab_server_response.py +53 -38
  444. flywheel/models/jupyterlab_server_update.py +0 -7
  445. flywheel/models/ldap_sync.py +0 -7
  446. flywheel/models/ldap_sync_config.py +8 -11
  447. flywheel/models/ldap_sync_input.py +0 -7
  448. flywheel/models/ldap_sync_status.py +23 -20
  449. flywheel/models/legacy_api_key_output.py +28 -23
  450. flywheel/models/legacy_input.py +23 -20
  451. flywheel/models/legacy_usage_report.py +33 -26
  452. flywheel/models/legacys_usage_project_entry.py +13 -14
  453. flywheel/models/libs_viewer_config_models_viewer_config.py +194 -0
  454. flywheel/models/libs_workflows_models_parent_type.py +0 -7
  455. flywheel/models/libs_workflows_models_task_status.py +0 -7
  456. flywheel/models/local_storage.py +18 -17
  457. flywheel/models/location.py +13 -14
  458. flywheel/models/locked.py +18 -17
  459. flywheel/models/master_subject_code_dob_input.py +28 -23
  460. flywheel/models/master_subject_code_input.py +28 -23
  461. flywheel/models/master_subject_code_output.py +8 -11
  462. flywheel/models/matched_acquisition_output.py +73 -50
  463. flywheel/models/measurement_config.py +222 -0
  464. flywheel/models/measurement_item_config.py +217 -0
  465. flywheel/models/mfa_channel.py +0 -7
  466. flywheel/models/mfa_settings.py +8 -11
  467. flywheel/models/ml_set_filter.py +13 -14
  468. flywheel/models/ml_type.py +0 -7
  469. flywheel/models/modality.py +23 -20
  470. flywheel/models/modality_input.py +23 -20
  471. flywheel/models/modality_modify.py +18 -17
  472. flywheel/models/modality_output.py +28 -23
  473. flywheel/models/modified_result.py +13 -14
  474. flywheel/models/modify_user_input.py +63 -44
  475. flywheel/models/move_conflict.py +33 -26
  476. flywheel/models/note.py +48 -35
  477. flywheel/models/note_input.py +8 -11
  478. flywheel/models/optional_input_policy.py +0 -7
  479. flywheel/models/order.py +0 -7
  480. flywheel/models/organ_system.py +0 -7
  481. flywheel/models/origin.py +13 -14
  482. flywheel/models/origin_type.py +0 -7
  483. flywheel/models/orphaned_count.py +8 -11
  484. flywheel/models/output_user_page.py +18 -17
  485. flywheel/models/packfile_cleanup_output.py +8 -11
  486. flywheel/models/packfile_removed_output.py +13 -14
  487. flywheel/models/page.py +18 -17
  488. flywheel/models/page_generic_file_output.py +18 -17
  489. flywheel/models/page_generic_filter.py +18 -17
  490. flywheel/models/page_generic_form_response_output.py +18 -17
  491. flywheel/models/page_generic_protocol.py +23 -20
  492. flywheel/models/page_generic_reader_task_output.py +23 -20
  493. flywheel/models/page_generic_staffing_pool.py +23 -20
  494. flywheel/models/parsed_query_response.py +13 -14
  495. flywheel/models/permission_access_permission.py +0 -7
  496. flywheel/models/premade_jobs_batch_job_output.py +33 -26
  497. flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +33 -26
  498. flywheel/models/premade_jobs_batch_proposal.py +38 -29
  499. flywheel/models/premade_jobs_batch_proposal_detail.py +8 -11
  500. flywheel/models/premade_jobs_batch_proposal_input.py +8 -11
  501. flywheel/models/project.py +0 -7
  502. flywheel/models/project_acquisition_upsert_input.py +0 -7
  503. flywheel/models/project_acquisition_upsert_output.py +0 -7
  504. flywheel/models/project_aet.py +38 -29
  505. flywheel/models/project_aet_input.py +23 -20
  506. flywheel/models/project_catalog_list_output.py +0 -7
  507. flywheel/models/project_contact.py +13 -14
  508. flywheel/models/project_container_output.py +2 -7
  509. flywheel/models/project_copy_input.py +23 -20
  510. flywheel/models/project_copy_output.py +18 -17
  511. flywheel/models/project_counters.py +76 -36
  512. flywheel/models/project_delete_status_output.py +192 -0
  513. flywheel/models/project_group_info.py +189 -0
  514. flywheel/models/project_hierarchy_input.py +28 -23
  515. flywheel/models/project_hierarchy_output.py +18 -17
  516. flywheel/models/project_hierarchy_upsert_input.py +0 -7
  517. flywheel/models/project_hierarchy_upsert_output.py +0 -7
  518. flywheel/models/project_input.py +48 -35
  519. flywheel/models/project_institution.py +13 -14
  520. flywheel/models/project_list_output.py +234 -93
  521. flywheel/models/project_locking_reason.py +0 -7
  522. flywheel/models/project_modify.py +116 -42
  523. flywheel/models/project_node.py +2 -7
  524. flywheel/models/project_output.py +235 -93
  525. flywheel/models/project_parents.py +8 -11
  526. flywheel/models/project_report.py +63 -44
  527. flywheel/models/project_report_list.py +8 -11
  528. flywheel/models/project_session_upsert_input.py +0 -7
  529. flywheel/models/project_session_upsert_output.py +0 -7
  530. flywheel/models/project_settings_input.py +38 -29
  531. flywheel/models/project_settings_output.py +38 -29
  532. flywheel/models/project_settings_sharing.py +38 -29
  533. flywheel/models/project_settings_sharing_input.py +38 -29
  534. flywheel/models/project_settings_workspaces.py +8 -11
  535. flywheel/models/project_settings_workspaces_input.py +8 -11
  536. flywheel/models/project_share_level.py +0 -7
  537. flywheel/models/project_sharing_settings_project_contact.py +0 -7
  538. flywheel/models/project_sharing_settings_project_counters.py +0 -7
  539. flywheel/models/project_sharing_settings_project_institution.py +0 -7
  540. flywheel/models/project_sharing_settings_project_settings_input.py +0 -7
  541. flywheel/models/project_sharing_settings_project_settings_output.py +0 -7
  542. flywheel/models/project_sharing_settings_project_settings_sharing.py +0 -7
  543. flywheel/models/project_sharing_settings_project_settings_sharing_input.py +0 -7
  544. flywheel/models/project_sharing_settings_project_stats.py +0 -7
  545. flywheel/models/project_stats.py +28 -23
  546. flywheel/models/project_subject_upsert_input.py +0 -7
  547. flywheel/models/project_subject_upsert_output.py +0 -7
  548. flywheel/models/project_template.py +13 -14
  549. flywheel/models/project_template_input.py +13 -14
  550. flywheel/models/project_template_list_input.py +8 -11
  551. flywheel/models/project_template_requirement.py +0 -7
  552. flywheel/models/project_template_session_template.py +0 -7
  553. flywheel/models/project_upsert_origin.py +0 -7
  554. flywheel/models/protocol.py +78 -53
  555. flywheel/models/protocol_e_signature_config.py +13 -14
  556. flywheel/models/protocol_input.py +43 -32
  557. flywheel/models/protocol_modify.py +28 -23
  558. flywheel/models/protocol_status.py +0 -7
  559. flywheel/models/provider.py +63 -44
  560. flywheel/models/provider_access_type.py +0 -7
  561. flywheel/models/provider_class.py +0 -7
  562. flywheel/models/provider_deletion_status.py +13 -14
  563. flywheel/models/provider_input.py +0 -7
  564. flywheel/models/provider_links.py +28 -23
  565. flywheel/models/provider_type.py +0 -7
  566. flywheel/models/providers.py +28 -23
  567. flywheel/models/reader_batch_create.py +63 -44
  568. flywheel/models/reader_task.py +113 -74
  569. flywheel/models/reader_task_config.py +49 -18
  570. flywheel/models/reader_task_create.py +78 -53
  571. flywheel/models/reader_task_modify.py +33 -26
  572. flywheel/models/reader_task_output.py +118 -77
  573. flywheel/models/reader_task_parent_details.py +38 -29
  574. flywheel/models/report_access_log_context.py +33 -26
  575. flywheel/models/report_access_log_context_entry.py +13 -14
  576. flywheel/models/report_access_log_context_file_entry.py +8 -11
  577. flywheel/models/report_access_log_entry.py +88 -59
  578. flywheel/models/report_access_log_origin.py +13 -14
  579. flywheel/models/report_availability_list.py +8 -11
  580. flywheel/models/report_daily_usage_entry.py +68 -47
  581. flywheel/models/report_demographics_grid.py +0 -7
  582. flywheel/models/report_ethnicity_grid.py +23 -20
  583. flywheel/models/report_gender_count.py +18 -17
  584. flywheel/models/report_group_report.py +18 -17
  585. flywheel/models/report_legacy_usage_entry.py +0 -7
  586. flywheel/models/report_legacy_usage_project_entry.py +0 -7
  587. flywheel/models/report_project.py +0 -7
  588. flywheel/models/report_site.py +13 -14
  589. flywheel/models/report_time_period.py +13 -14
  590. flywheel/models/report_usage.py +88 -59
  591. flywheel/models/report_usage_entry.py +0 -7
  592. flywheel/models/resolve_input.py +8 -11
  593. flywheel/models/resolve_output.py +13 -14
  594. flywheel/models/resolver_acquisition_node.py +0 -7
  595. flywheel/models/resolver_analysis_node.py +0 -7
  596. flywheel/models/resolver_file_node.py +0 -7
  597. flywheel/models/resolver_gear_node.py +0 -7
  598. flywheel/models/resolver_group_node.py +0 -7
  599. flywheel/models/resolver_input.py +0 -7
  600. flywheel/models/resolver_node.py +8 -11
  601. flywheel/models/resolver_output.py +0 -7
  602. flywheel/models/resolver_project_node.py +0 -7
  603. flywheel/models/resolver_session_node.py +0 -7
  604. flywheel/models/resolver_subject_node.py +0 -7
  605. flywheel/models/role_input.py +13 -14
  606. flywheel/models/role_output.py +28 -23
  607. flywheel/models/role_permission.py +13 -14
  608. flywheel/models/role_permission_output.py +13 -14
  609. flywheel/models/role_permission_update.py +8 -11
  610. flywheel/models/role_type.py +0 -7
  611. flywheel/models/role_update.py +13 -14
  612. flywheel/models/roles_backwards_compatible_role_assignment.py +0 -7
  613. flywheel/models/roles_group_role_pool_input.py +0 -7
  614. flywheel/models/roles_role.py +0 -7
  615. flywheel/models/roles_role_assignment.py +13 -14
  616. flywheel/models/roles_role_input.py +0 -7
  617. flywheel/models/rule.py +63 -44
  618. flywheel/models/rule_any.py +18 -17
  619. flywheel/models/s3_addressing_style.py +0 -7
  620. flywheel/models/s3_compat_storage.py +48 -35
  621. flywheel/models/save_search.py +33 -26
  622. flywheel/models/save_search_input.py +18 -17
  623. flywheel/models/save_search_output.py +33 -26
  624. flywheel/models/save_search_page.py +18 -17
  625. flywheel/models/save_search_parent.py +13 -14
  626. flywheel/models/save_search_update.py +13 -14
  627. flywheel/models/search_acquisition_response.py +23 -20
  628. flywheel/models/search_analysis_response.py +23 -20
  629. flywheel/models/search_collection_response.py +23 -20
  630. flywheel/models/search_file_response.py +33 -26
  631. flywheel/models/search_group_response.py +13 -14
  632. flywheel/models/search_parent_acquisition.py +0 -7
  633. flywheel/models/search_parent_analysis.py +0 -7
  634. flywheel/models/search_parent_collection.py +0 -7
  635. flywheel/models/search_parent_project.py +2 -7
  636. flywheel/models/search_parent_response.py +13 -14
  637. flywheel/models/search_parent_session.py +0 -7
  638. flywheel/models/search_parent_subject.py +0 -7
  639. flywheel/models/search_parse_error.py +23 -20
  640. flywheel/models/search_parse_search_query_result.py +0 -7
  641. flywheel/models/search_project_response.py +13 -14
  642. flywheel/models/search_query.py +38 -29
  643. flywheel/models/search_query_suggestions.py +0 -7
  644. flywheel/models/search_response.py +58 -41
  645. flywheel/models/search_return_type.py +0 -7
  646. flywheel/models/search_save_search.py +0 -7
  647. flywheel/models/search_save_search_input.py +0 -7
  648. flywheel/models/search_save_search_parent.py +0 -7
  649. flywheel/models/search_save_search_update.py +0 -7
  650. flywheel/models/search_session_response.py +23 -20
  651. flywheel/models/search_status.py +8 -11
  652. flywheel/models/search_structured_search_query.py +0 -7
  653. flywheel/models/search_subject_response.py +18 -17
  654. flywheel/models/search_suggestion.py +0 -7
  655. flywheel/models/select_item.py +13 -14
  656. flywheel/models/server_state.py +33 -26
  657. flywheel/models/service_aet.py +33 -26
  658. flywheel/models/service_aet_input.py +28 -23
  659. flywheel/models/session.py +0 -7
  660. flywheel/models/session_container_output.py +0 -7
  661. flywheel/models/session_copy_input.py +23 -20
  662. flywheel/models/session_embedded_subject.py +33 -26
  663. flywheel/models/session_input.py +58 -41
  664. flywheel/models/session_list_output.py +143 -92
  665. flywheel/models/session_metadata_input.py +0 -7
  666. flywheel/models/session_modify.py +63 -44
  667. flywheel/models/session_node.py +0 -7
  668. flywheel/models/session_output.py +143 -92
  669. flywheel/models/session_parents.py +18 -17
  670. flywheel/models/session_template_options.py +18 -17
  671. flywheel/models/session_template_recalc_output.py +8 -11
  672. flywheel/models/session_upsert_input.py +63 -44
  673. flywheel/models/session_upsert_output.py +23 -20
  674. flywheel/models/sharing_filter_options.py +43 -32
  675. flywheel/models/signed_fs_upload_output.py +13 -14
  676. flywheel/models/signed_url_cleanup_input.py +13 -14
  677. flywheel/models/signed_url_upload_input.py +13 -14
  678. flywheel/models/signed_url_upload_output.py +43 -32
  679. flywheel/models/site.py +93 -62
  680. flywheel/models/site_report.py +13 -14
  681. flywheel/models/site_settings.py +48 -35
  682. flywheel/models/sort.py +13 -14
  683. flywheel/models/stable_api_key_input.py +0 -7
  684. flywheel/models/staffing_pool.py +38 -29
  685. flywheel/models/staffing_pool_create.py +18 -17
  686. flywheel/models/staffing_pool_list.py +8 -11
  687. flywheel/models/staffing_pool_modify.py +18 -17
  688. flywheel/models/state.py +0 -7
  689. flywheel/models/static_compute.py +18 -17
  690. flywheel/models/status_transitions.py +23 -20
  691. flywheel/models/status_type.py +0 -7
  692. flywheel/models/status_value.py +0 -7
  693. flywheel/models/storage_strategy.py +0 -7
  694. flywheel/models/storage_strategy_config.py +13 -14
  695. flywheel/models/structured_query.py +8 -11
  696. flywheel/models/structured_query_suggestions.py +13 -14
  697. flywheel/models/structured_query_value_suggestion.py +23 -20
  698. flywheel/models/subject.py +0 -7
  699. flywheel/models/subject_container_output.py +0 -7
  700. flywheel/models/subject_copy_input.py +18 -17
  701. flywheel/models/subject_input.py +93 -62
  702. flywheel/models/subject_modify.py +103 -68
  703. flywheel/models/subject_node.py +0 -7
  704. flywheel/models/subject_output.py +163 -104
  705. flywheel/models/subject_output_for_list.py +163 -104
  706. flywheel/models/subject_parents.py +13 -14
  707. flywheel/models/subject_role_permission.py +13 -14
  708. flywheel/models/subject_state.py +0 -7
  709. flywheel/models/subject_template_options.py +13 -14
  710. flywheel/models/subject_upsert_input.py +83 -56
  711. flywheel/models/subject_upsert_output.py +18 -17
  712. flywheel/models/sync_user_input.py +38 -29
  713. flywheel/models/tag.py +8 -11
  714. flywheel/models/task_assign.py +13 -14
  715. flywheel/models/task_facet.py +0 -7
  716. flywheel/models/task_parent_ref.py +23 -20
  717. flywheel/models/task_parent_ref_input.py +18 -17
  718. flywheel/models/task_priority.py +0 -7
  719. flywheel/models/task_submission.py +13 -14
  720. flywheel/models/therapeutic_area.py +0 -7
  721. flywheel/models/toolbar_config.py +161 -0
  722. flywheel/models/transitions.py +28 -23
  723. flywheel/models/tree_container_request_spec.py +28 -23
  724. flywheel/models/tree_graph.py +3 -8
  725. flywheel/models/tree_graph_connection.py +23 -20
  726. flywheel/models/tree_graph_connections.py +3 -8
  727. flywheel/models/tree_graph_node.py +8 -11
  728. flywheel/models/tree_request.py +0 -7
  729. flywheel/models/tree_response_item.py +3 -8
  730. flywheel/models/type_str.py +0 -7
  731. flywheel/models/uid_check_input_acquisitions.py +23 -20
  732. flywheel/models/uid_check_input_sessions.py +23 -20
  733. flywheel/models/uid_check_output.py +13 -14
  734. flywheel/models/upload_complete_s3_multipart_input.py +0 -7
  735. flywheel/models/upload_complete_s3_multipart_output.py +0 -7
  736. flywheel/models/upload_signed_fs_file_upload_output.py +0 -7
  737. flywheel/models/upload_signed_upload_url_input.py +0 -7
  738. flywheel/models/upload_signed_upload_url_output.py +0 -7
  739. flywheel/models/upload_ticket_output.py +18 -17
  740. flywheel/models/upload_token_output.py +8 -11
  741. flywheel/models/upsert_result.py +0 -7
  742. flywheel/models/user.py +113 -74
  743. flywheel/models/user_api_key.py +18 -17
  744. flywheel/models/user_input.py +63 -44
  745. flywheel/models/user_jobs.py +18 -17
  746. flywheel/models/user_jobs_output.py +0 -7
  747. flywheel/models/user_output.py +0 -7
  748. flywheel/models/user_output_id.py +8 -11
  749. flywheel/models/user_preferences.py +3 -8
  750. flywheel/models/user_wechat.py +3 -8
  751. flywheel/models/validation_error.py +18 -17
  752. flywheel/models/validation_rule.py +13 -14
  753. flywheel/models/version.py +43 -32
  754. flywheel/models/version_output.py +0 -7
  755. flywheel/models/view_id_output.py +8 -11
  756. flywheel/models/view_output.py +58 -41
  757. flywheel/models/viewer_app.py +48 -35
  758. flywheel/models/viewer_app_input.py +48 -35
  759. flywheel/models/viewer_app_type.py +0 -7
  760. flywheel/models/virus_scan.py +8 -11
  761. flywheel/models/virus_scan_state.py +0 -7
  762. flywheel/models/work_in_progress_features.py +3 -8
  763. flywheel/models/zipfile_info.py +13 -14
  764. flywheel/models/zipfile_member_info.py +23 -20
  765. flywheel/partial_reader.py +0 -7
  766. flywheel/rest.py +0 -7
  767. flywheel/view_builder.py +2 -1
  768. {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/METADATA +1 -1
  769. flywheel_sdk-21.4.0.dist-info/RECORD +778 -0
  770. {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/WHEEL +1 -1
  771. flywheel/models/google_auth_out.py +0 -299
  772. flywheel_sdk-21.3.0rc0.dist-info/RECORD +0 -772
  773. {flywheel_sdk-21.3.0rc0.dist-info → flywheel_sdk-21.4.0.dist-info}/licenses/LICENSE.txt +0 -0
flywheel/api/users_api.py CHANGED
@@ -1,13 +1,6 @@
1
1
  # coding: utf-8
2
2
 
3
3
  """
4
- Flywheel
5
-
6
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
7
-
8
- OpenAPI spec version: 0.0.1
9
-
10
- Generated by: https://github.com/swagger-api/swagger-codegen.git
11
4
  """
12
5
 
13
6
 
@@ -37,9 +30,11 @@ class UsersApi(object):
37
30
  Add a new user
38
31
  This method makes a synchronous HTTP request by default.
39
32
 
40
- :param UserInput body: (required)
41
- :param bool async_: Perform the request asynchronously
42
- :return: UserOutputId
33
+ :param body:
34
+ :type body: UserInput
35
+ :param async_: Perform the request asynchronously
36
+ :type async_: bool, optional
37
+ :rtype: UserOutputId
43
38
  """
44
39
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
45
40
  kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ class UsersApi(object):
63
58
  Add a new user
64
59
  This method makes a synchronous HTTP request by default.
65
60
 
66
- :param UserInput body: (required)
67
- :param bool async_: Perform the request asynchronously
68
- :return: UserOutputId
61
+ :param body:
62
+ :type body: UserInput
63
+ :param async_: Perform the request asynchronously
64
+ :type async_: bool, optional
65
+ :rtype: UserOutputId
69
66
  """
70
67
 
71
68
  all_params = ['body',] # noqa: E501
@@ -145,9 +142,11 @@ class UsersApi(object):
145
142
  Delete a user
146
143
  This method makes a synchronous HTTP request by default.
147
144
 
148
- :param str user_id: (required)
149
- :param bool async_: Perform the request asynchronously
150
- :return: None
145
+ :param user_id:
146
+ :type user_id: str
147
+ :param async_: Perform the request asynchronously
148
+ :type async_: bool, optional
149
+ :rtype: None
151
150
  """
152
151
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
153
152
  kwargs['_return_http_data_only'] = True
@@ -171,9 +170,11 @@ class UsersApi(object):
171
170
  Delete a user
172
171
  This method makes a synchronous HTTP request by default.
173
172
 
174
- :param str user_id: (required)
175
- :param bool async_: Perform the request asynchronously
176
- :return: None
173
+ :param user_id:
174
+ :type user_id: str
175
+ :param async_: Perform the request asynchronously
176
+ :type async_: bool, optional
177
+ :rtype: None
177
178
  """
178
179
 
179
180
  all_params = ['user_id',] # noqa: E501
@@ -241,9 +242,11 @@ class UsersApi(object):
241
242
 
242
243
  This method makes a synchronous HTTP request by default.
243
244
 
244
- :param str id_: (required)
245
- :param bool async_: Perform the request asynchronously
246
- :return: None
245
+ :param id_:
246
+ :type id_: str
247
+ :param async_: Perform the request asynchronously
248
+ :type async_: bool, optional
249
+ :rtype: None
247
250
  """
248
251
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
249
252
  kwargs['_return_http_data_only'] = True
@@ -266,9 +269,11 @@ class UsersApi(object):
266
269
 
267
270
  This method makes a synchronous HTTP request by default.
268
271
 
269
- :param str id_: (required)
270
- :param bool async_: Perform the request asynchronously
271
- :return: None
272
+ :param id_:
273
+ :type id_: str
274
+ :param async_: Perform the request asynchronously
275
+ :type async_: bool, optional
276
+ :rtype: None
272
277
  """
273
278
 
274
279
  all_params = ['id_',] # noqa: E501
@@ -337,9 +342,11 @@ class UsersApi(object):
337
342
  Generate user api key for the current user.
338
343
  This method makes a synchronous HTTP request by default.
339
344
 
340
- :param CoreModelsApiKeyApiKeyInput body: (required)
341
- :param bool async_: Perform the request asynchronously
342
- :return: ApiKeyOutput
345
+ :param body:
346
+ :type body: CoreModelsApiKeyApiKeyInput
347
+ :param async_: Perform the request asynchronously
348
+ :type async_: bool, optional
349
+ :rtype: ApiKeyOutput
343
350
  """
344
351
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
345
352
  kwargs['_return_http_data_only'] = True
@@ -363,9 +370,11 @@ class UsersApi(object):
363
370
  Generate user api key for the current user.
364
371
  This method makes a synchronous HTTP request by default.
365
372
 
366
- :param CoreModelsApiKeyApiKeyInput body: (required)
367
- :param bool async_: Perform the request asynchronously
368
- :return: ApiKeyOutput
373
+ :param body:
374
+ :type body: CoreModelsApiKeyApiKeyInput
375
+ :param async_: Perform the request asynchronously
376
+ :type async_: bool, optional
377
+ :rtype: ApiKeyOutput
369
378
  """
370
379
 
371
380
  all_params = ['body',] # noqa: E501
@@ -445,15 +454,23 @@ class UsersApi(object):
445
454
  Gets all users with pagination Args:
446
455
  This method makes a synchronous HTTP request by default.
447
456
 
448
- :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)
449
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
450
- :param int limit: The maximum number of entries to return.
451
- :param int skip: The number of entries to skip.
452
- :param int page: The page number (i.e. skip limit*page entries)
453
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
454
- :param list[str] x_accept_feature:
455
- :param bool async_: Perform the request asynchronously
456
- :return: union[list[UserOutput],OutputUserPage]
457
+ :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)
458
+ :type filter: str, optional
459
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
460
+ :type sort: str, optional
461
+ :param limit: The maximum number of entries to return.
462
+ :type limit: int, optional
463
+ :param skip: The number of entries to skip., defaults to 0
464
+ :type skip: int, optional
465
+ :param page: The page number (i.e. skip limit*page entries)
466
+ :type page: int, optional
467
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
468
+ :type after_id: str, optional
469
+ :param x_accept_feature:, defaults to []
470
+ :type x_accept_feature: list[str], optional
471
+ :param async_: Perform the request asynchronously
472
+ :type async_: bool, optional
473
+ :rtype: union[list[UserOutput],OutputUserPage]
457
474
  """
458
475
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
459
476
  kwargs['_return_http_data_only'] = True
@@ -477,15 +494,23 @@ class UsersApi(object):
477
494
  Gets all users with pagination Args:
478
495
  This method makes a synchronous HTTP request by default.
479
496
 
480
- :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)
481
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
482
- :param int limit: The maximum number of entries to return.
483
- :param int skip: The number of entries to skip.
484
- :param int page: The page number (i.e. skip limit*page entries)
485
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
486
- :param list[str] x_accept_feature:
487
- :param bool async_: Perform the request asynchronously
488
- :return: union[list[UserOutput],OutputUserPage]
497
+ :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)
498
+ :type filter: str, optional
499
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
500
+ :type sort: str, optional
501
+ :param limit: The maximum number of entries to return.
502
+ :type limit: int, optional
503
+ :param skip: The number of entries to skip., defaults to 0
504
+ :type skip: int, optional
505
+ :param page: The page number (i.e. skip limit*page entries)
506
+ :type page: int, optional
507
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
508
+ :type after_id: str, optional
509
+ :param x_accept_feature:, defaults to []
510
+ :type x_accept_feature: list[str], optional
511
+ :param async_: Perform the request asynchronously
512
+ :type async_: bool, optional
513
+ :rtype: union[list[UserOutput],OutputUserPage]
489
514
  """
490
515
 
491
516
  all_params = ['filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -563,8 +588,9 @@ class UsersApi(object):
563
588
  Gets the current user Args: auth_session (AuthSession): session from incoming request Returns: CurrentUserOutput: Pydantic model for client side user data
564
589
  This method makes a synchronous HTTP request by default.
565
590
 
566
- :param bool async_: Perform the request asynchronously
567
- :return: CurrentUserOutput
591
+ :param async_: Perform the request asynchronously
592
+ :type async_: bool, optional
593
+ :rtype: CurrentUserOutput
568
594
  """
569
595
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
570
596
  kwargs['_return_http_data_only'] = True
@@ -588,8 +614,9 @@ class UsersApi(object):
588
614
  Gets the current user Args: auth_session (AuthSession): session from incoming request Returns: CurrentUserOutput: Pydantic model for client side user data
589
615
  This method makes a synchronous HTTP request by default.
590
616
 
591
- :param bool async_: Perform the request asynchronously
592
- :return: CurrentUserOutput
617
+ :param async_: Perform the request asynchronously
618
+ :type async_: bool, optional
619
+ :rtype: CurrentUserOutput
593
620
  """
594
621
 
595
622
  all_params = [] # noqa: E501
@@ -652,9 +679,11 @@ class UsersApi(object):
652
679
  Gets avatar of current user Args: auth_session (AuthSession): session from incoming request Returns: str: url of avatar
653
680
  This method makes a synchronous HTTP request by default.
654
681
 
655
- :param str default:
656
- :param bool async_: Perform the request asynchronously
657
- :return: None
682
+ :param default:
683
+ :type default: str, optional
684
+ :param async_: Perform the request asynchronously
685
+ :type async_: bool, optional
686
+ :rtype: None
658
687
  """
659
688
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
660
689
  kwargs['_return_http_data_only'] = True
@@ -678,9 +707,11 @@ class UsersApi(object):
678
707
  Gets avatar of current user Args: auth_session (AuthSession): session from incoming request Returns: str: url of avatar
679
708
  This method makes a synchronous HTTP request by default.
680
709
 
681
- :param str default:
682
- :param bool async_: Perform the request asynchronously
683
- :return: None
710
+ :param default:
711
+ :type default: str, optional
712
+ :param async_: Perform the request asynchronously
713
+ :type async_: bool, optional
714
+ :rtype: None
684
715
  """
685
716
 
686
717
  all_params = ['default',] # noqa: E501
@@ -745,9 +776,11 @@ class UsersApi(object):
745
776
  Gets user info fields. Args: fields (str): csv of arbitrary keys to look for in user info auth_session (AuthSession): session from incoming request Returns: dict: arbitrary data matching the provided csv values
746
777
  This method makes a synchronous HTTP request by default.
747
778
 
748
- :param str fields: Get only the specified fields from user's info. Accept multiple fields separated by comma.
749
- :param bool async_: Perform the request asynchronously
750
- :return: object
779
+ :param fields: Get only the specified fields from user's info. Accept multiple fields separated by comma.
780
+ :type fields: str, optional
781
+ :param async_: Perform the request asynchronously
782
+ :type async_: bool, optional
783
+ :rtype: object
751
784
  """
752
785
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
753
786
  kwargs['_return_http_data_only'] = True
@@ -771,9 +804,11 @@ class UsersApi(object):
771
804
  Gets user info fields. Args: fields (str): csv of arbitrary keys to look for in user info auth_session (AuthSession): session from incoming request Returns: dict: arbitrary data matching the provided csv values
772
805
  This method makes a synchronous HTTP request by default.
773
806
 
774
- :param str fields: Get only the specified fields from user's info. Accept multiple fields separated by comma.
775
- :param bool async_: Perform the request asynchronously
776
- :return: object
807
+ :param fields: Get only the specified fields from user's info. Accept multiple fields separated by comma.
808
+ :type fields: str, optional
809
+ :param async_: Perform the request asynchronously
810
+ :type async_: bool, optional
811
+ :rtype: object
777
812
  """
778
813
 
779
814
  all_params = ['fields',] # noqa: E501
@@ -838,17 +873,27 @@ class UsersApi(object):
838
873
  Gets jobs assigned to user with optional gear name regex Args: gear_name (str): name of gear to filter by auth_session (AuthSession): session from incoming request Returns: list: List of jobs linked to the user
839
874
  This method makes a synchronous HTTP request by default.
840
875
 
841
- :param str gear: Gear name. Get only the jobs which are related to a specific gear.
842
- :param bool exhaustive:
843
- :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)
844
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
845
- :param int limit: The maximum number of entries to return.
846
- :param int skip: The number of entries to skip.
847
- :param int page: The page number (i.e. skip limit*page entries)
848
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
849
- :param list[str] x_accept_feature:
850
- :param bool async_: Perform the request asynchronously
851
- :return: UserJobs
876
+ :param gear: Gear name. Get only the jobs which are related to a specific gear.
877
+ :type gear: str, optional
878
+ :param exhaustive:, defaults to false
879
+ :type exhaustive: bool, optional
880
+ :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)
881
+ :type filter: str, optional
882
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
883
+ :type sort: str, optional
884
+ :param limit: The maximum number of entries to return.
885
+ :type limit: int, optional
886
+ :param skip: The number of entries to skip., defaults to 0
887
+ :type skip: int, optional
888
+ :param page: The page number (i.e. skip limit*page entries)
889
+ :type page: int, optional
890
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
891
+ :type after_id: str, optional
892
+ :param x_accept_feature:, defaults to []
893
+ :type x_accept_feature: list[str], optional
894
+ :param async_: Perform the request asynchronously
895
+ :type async_: bool, optional
896
+ :rtype: UserJobs
852
897
  """
853
898
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
854
899
  kwargs['_return_http_data_only'] = True
@@ -872,17 +917,27 @@ class UsersApi(object):
872
917
  Gets jobs assigned to user with optional gear name regex Args: gear_name (str): name of gear to filter by auth_session (AuthSession): session from incoming request Returns: list: List of jobs linked to the user
873
918
  This method makes a synchronous HTTP request by default.
874
919
 
875
- :param str gear: Gear name. Get only the jobs which are related to a specific gear.
876
- :param bool exhaustive:
877
- :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)
878
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
879
- :param int limit: The maximum number of entries to return.
880
- :param int skip: The number of entries to skip.
881
- :param int page: The page number (i.e. skip limit*page entries)
882
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
883
- :param list[str] x_accept_feature:
884
- :param bool async_: Perform the request asynchronously
885
- :return: UserJobs
920
+ :param gear: Gear name. Get only the jobs which are related to a specific gear.
921
+ :type gear: str, optional
922
+ :param exhaustive:, defaults to false
923
+ :type exhaustive: bool, optional
924
+ :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)
925
+ :type filter: str, optional
926
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
927
+ :type sort: str, optional
928
+ :param limit: The maximum number of entries to return.
929
+ :type limit: int, optional
930
+ :param skip: The number of entries to skip., defaults to 0
931
+ :type skip: int, optional
932
+ :param page: The page number (i.e. skip limit*page entries)
933
+ :type page: int, optional
934
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
935
+ :type after_id: str, optional
936
+ :param x_accept_feature:, defaults to []
937
+ :type x_accept_feature: list[str], optional
938
+ :param async_: Perform the request asynchronously
939
+ :type async_: bool, optional
940
+ :rtype: UserJobs
886
941
  """
887
942
 
888
943
  all_params = ['gear','exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -964,10 +1019,13 @@ class UsersApi(object):
964
1019
  Get user by id Args: uid (str): string matching uid pattern Returns: UserOutput: Pydantic model for sending data to client
965
1020
  This method makes a synchronous HTTP request by default.
966
1021
 
967
- :param str user_id: (required)
968
- :param bool include_deleted:
969
- :param bool async_: Perform the request asynchronously
970
- :return: UserOutput
1022
+ :param user_id:
1023
+ :type user_id: str
1024
+ :param include_deleted:, defaults to false
1025
+ :type include_deleted: bool, optional
1026
+ :param async_: Perform the request asynchronously
1027
+ :type async_: bool, optional
1028
+ :rtype: UserOutput
971
1029
  """
972
1030
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
973
1031
  kwargs['_return_http_data_only'] = True
@@ -991,10 +1049,13 @@ class UsersApi(object):
991
1049
  Get user by id Args: uid (str): string matching uid pattern Returns: UserOutput: Pydantic model for sending data to client
992
1050
  This method makes a synchronous HTTP request by default.
993
1051
 
994
- :param str user_id: (required)
995
- :param bool include_deleted:
996
- :param bool async_: Perform the request asynchronously
997
- :return: UserOutput
1052
+ :param user_id:
1053
+ :type user_id: str
1054
+ :param include_deleted:, defaults to false
1055
+ :type include_deleted: bool, optional
1056
+ :param async_: Perform the request asynchronously
1057
+ :type async_: bool, optional
1058
+ :rtype: UserOutput
998
1059
  """
999
1060
 
1000
1061
  all_params = ['user_id','include_deleted',] # noqa: E501
@@ -1065,17 +1126,27 @@ class UsersApi(object):
1065
1126
  Get all acquisitions that belong to the given user.
1066
1127
  This method makes a synchronous HTTP request by default.
1067
1128
 
1068
- :param str uid: (required)
1069
- :param bool exhaustive: Set to return a complete list regardless of permissions
1070
- :param bool include_all_info: Include all info in returned objects
1071
- :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)
1072
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1073
- :param int limit: The maximum number of entries to return.
1074
- :param int skip: The number of entries to skip.
1075
- :param int page: The page number (i.e. skip limit*page entries)
1076
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1077
- :param bool async_: Perform the request asynchronously
1078
- :return: list[AcquisitionListOutput]
1129
+ :param uid:
1130
+ :type uid: str
1131
+ :param exhaustive: Set to return a complete list regardless of permissions
1132
+ :type exhaustive: bool, optional
1133
+ :param include_all_info: Include all info in returned objects, defaults to false
1134
+ :type include_all_info: bool, optional
1135
+ :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)
1136
+ :type filter: str, optional
1137
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1138
+ :type sort: str, optional
1139
+ :param limit: The maximum number of entries to return.
1140
+ :type limit: int, optional
1141
+ :param skip: The number of entries to skip., defaults to 0
1142
+ :type skip: int, optional
1143
+ :param page: The page number (i.e. skip limit*page entries)
1144
+ :type page: int, optional
1145
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1146
+ :type after_id: str, optional
1147
+ :param async_: Perform the request asynchronously
1148
+ :type async_: bool, optional
1149
+ :rtype: list[AcquisitionListOutput]
1079
1150
  """
1080
1151
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1081
1152
  kwargs['_return_http_data_only'] = True
@@ -1099,17 +1170,27 @@ class UsersApi(object):
1099
1170
  Get all acquisitions that belong to the given user.
1100
1171
  This method makes a synchronous HTTP request by default.
1101
1172
 
1102
- :param str uid: (required)
1103
- :param bool exhaustive: Set to return a complete list regardless of permissions
1104
- :param bool include_all_info: Include all info in returned objects
1105
- :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)
1106
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1107
- :param int limit: The maximum number of entries to return.
1108
- :param int skip: The number of entries to skip.
1109
- :param int page: The page number (i.e. skip limit*page entries)
1110
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1111
- :param bool async_: Perform the request asynchronously
1112
- :return: list[AcquisitionListOutput]
1173
+ :param uid:
1174
+ :type uid: str
1175
+ :param exhaustive: Set to return a complete list regardless of permissions
1176
+ :type exhaustive: bool, optional
1177
+ :param include_all_info: Include all info in returned objects, defaults to false
1178
+ :type include_all_info: bool, optional
1179
+ :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)
1180
+ :type filter: str, optional
1181
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1182
+ :type sort: str, optional
1183
+ :param limit: The maximum number of entries to return.
1184
+ :type limit: int, optional
1185
+ :param skip: The number of entries to skip., defaults to 0
1186
+ :type skip: int, optional
1187
+ :param page: The page number (i.e. skip limit*page entries)
1188
+ :type page: int, optional
1189
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1190
+ :type after_id: str, optional
1191
+ :param async_: Perform the request asynchronously
1192
+ :type async_: bool, optional
1193
+ :rtype: list[AcquisitionListOutput]
1113
1194
  """
1114
1195
 
1115
1196
  all_params = ['uid','exhaustive','include_all_info','filter','sort','limit','skip','page','after_id',] # noqa: E501
@@ -1194,10 +1275,13 @@ class UsersApi(object):
1194
1275
  gets avatar of user and redirects to it Args: user_id (str): user id matching user_id regex Returns: RedirectResponse: redirects user to avatar Raises (ResourceNotFound): Raises 404 if no user avatar
1195
1276
  This method makes a synchronous HTTP request by default.
1196
1277
 
1197
- :param str user_id: (required)
1198
- :param str default:
1199
- :param bool async_: Perform the request asynchronously
1200
- :return: None
1278
+ :param user_id:
1279
+ :type user_id: str
1280
+ :param default:
1281
+ :type default: str, optional
1282
+ :param async_: Perform the request asynchronously
1283
+ :type async_: bool, optional
1284
+ :rtype: None
1201
1285
  """
1202
1286
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1203
1287
  kwargs['_return_http_data_only'] = True
@@ -1221,10 +1305,13 @@ class UsersApi(object):
1221
1305
  gets avatar of user and redirects to it Args: user_id (str): user id matching user_id regex Returns: RedirectResponse: redirects user to avatar Raises (ResourceNotFound): Raises 404 if no user avatar
1222
1306
  This method makes a synchronous HTTP request by default.
1223
1307
 
1224
- :param str user_id: (required)
1225
- :param str default:
1226
- :param bool async_: Perform the request asynchronously
1227
- :return: None
1308
+ :param user_id:
1309
+ :type user_id: str
1310
+ :param default:
1311
+ :type default: str, optional
1312
+ :param async_: Perform the request asynchronously
1313
+ :type async_: bool, optional
1314
+ :rtype: None
1228
1315
  """
1229
1316
 
1230
1317
  all_params = ['user_id','default',] # noqa: E501
@@ -1294,16 +1381,25 @@ class UsersApi(object):
1294
1381
 
1295
1382
  This method makes a synchronous HTTP request by default.
1296
1383
 
1297
- :param str user_id: (required)
1298
- :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)
1299
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1300
- :param int limit: The maximum number of entries to return.
1301
- :param int skip: The number of entries to skip.
1302
- :param int page: The page number (i.e. skip limit*page entries)
1303
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1304
- :param list[str] x_accept_feature:
1305
- :param bool async_: Perform the request asynchronously
1306
- :return: union[list[CollectionWithStats],list[CollectionOutput],Page]
1384
+ :param user_id:
1385
+ :type user_id: str
1386
+ :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)
1387
+ :type filter: str, optional
1388
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1389
+ :type sort: str, optional
1390
+ :param limit: The maximum number of entries to return.
1391
+ :type limit: int, optional
1392
+ :param skip: The number of entries to skip., defaults to 0
1393
+ :type skip: int, optional
1394
+ :param page: The page number (i.e. skip limit*page entries)
1395
+ :type page: int, optional
1396
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1397
+ :type after_id: str, optional
1398
+ :param x_accept_feature:, defaults to []
1399
+ :type x_accept_feature: list[str], optional
1400
+ :param async_: Perform the request asynchronously
1401
+ :type async_: bool, optional
1402
+ :rtype: union[list[CollectionWithStats],list[CollectionOutput],Page]
1307
1403
  """
1308
1404
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1309
1405
  kwargs['_return_http_data_only'] = True
@@ -1326,16 +1422,25 @@ class UsersApi(object):
1326
1422
 
1327
1423
  This method makes a synchronous HTTP request by default.
1328
1424
 
1329
- :param str user_id: (required)
1330
- :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)
1331
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1332
- :param int limit: The maximum number of entries to return.
1333
- :param int skip: The number of entries to skip.
1334
- :param int page: The page number (i.e. skip limit*page entries)
1335
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1336
- :param list[str] x_accept_feature:
1337
- :param bool async_: Perform the request asynchronously
1338
- :return: union[list[CollectionWithStats],list[CollectionOutput],Page]
1425
+ :param user_id:
1426
+ :type user_id: str
1427
+ :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)
1428
+ :type filter: str, optional
1429
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1430
+ :type sort: str, optional
1431
+ :param limit: The maximum number of entries to return.
1432
+ :type limit: int, optional
1433
+ :param skip: The number of entries to skip., defaults to 0
1434
+ :type skip: int, optional
1435
+ :param page: The page number (i.e. skip limit*page entries)
1436
+ :type page: int, optional
1437
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1438
+ :type after_id: str, optional
1439
+ :param x_accept_feature:, defaults to []
1440
+ :type x_accept_feature: list[str], optional
1441
+ :param async_: Perform the request asynchronously
1442
+ :type async_: bool, optional
1443
+ :rtype: union[list[CollectionWithStats],list[CollectionOutput],Page]
1339
1444
  """
1340
1445
 
1341
1446
  all_params = ['user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -1418,17 +1523,27 @@ class UsersApi(object):
1418
1523
 
1419
1524
  This method makes a synchronous HTTP request by default.
1420
1525
 
1421
- :param str uid: (required)
1422
- :param bool exhaustive: Set to return a complete list regardless of permissions
1423
- :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)
1424
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1425
- :param int limit: The maximum number of entries to return.
1426
- :param int skip: The number of entries to skip.
1427
- :param int page: The page number (i.e. skip limit*page entries)
1428
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1429
- :param list[str] x_accept_feature: redirect header
1430
- :param bool async_: Perform the request asynchronously
1431
- :return: list[GroupOutput]
1526
+ :param uid:
1527
+ :type uid: str
1528
+ :param exhaustive: Set to return a complete list regardless of permissions
1529
+ :type exhaustive: bool, optional
1530
+ :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)
1531
+ :type filter: str, optional
1532
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1533
+ :type sort: str, optional
1534
+ :param limit: The maximum number of entries to return.
1535
+ :type limit: int, optional
1536
+ :param skip: The number of entries to skip., defaults to 0
1537
+ :type skip: int, optional
1538
+ :param page: The page number (i.e. skip limit*page entries)
1539
+ :type page: int, optional
1540
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1541
+ :type after_id: str, optional
1542
+ :param x_accept_feature: redirect header, defaults to []
1543
+ :type x_accept_feature: list[str], optional
1544
+ :param async_: Perform the request asynchronously
1545
+ :type async_: bool, optional
1546
+ :rtype: list[GroupOutput]
1432
1547
  """
1433
1548
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1434
1549
  kwargs['_return_http_data_only'] = True
@@ -1451,17 +1566,27 @@ class UsersApi(object):
1451
1566
 
1452
1567
  This method makes a synchronous HTTP request by default.
1453
1568
 
1454
- :param str uid: (required)
1455
- :param bool exhaustive: Set to return a complete list regardless of permissions
1456
- :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)
1457
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1458
- :param int limit: The maximum number of entries to return.
1459
- :param int skip: The number of entries to skip.
1460
- :param int page: The page number (i.e. skip limit*page entries)
1461
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1462
- :param list[str] x_accept_feature: redirect header
1463
- :param bool async_: Perform the request asynchronously
1464
- :return: list[GroupOutput]
1569
+ :param uid:
1570
+ :type uid: str
1571
+ :param exhaustive: Set to return a complete list regardless of permissions
1572
+ :type exhaustive: bool, optional
1573
+ :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)
1574
+ :type filter: str, optional
1575
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1576
+ :type sort: str, optional
1577
+ :param limit: The maximum number of entries to return.
1578
+ :type limit: int, optional
1579
+ :param skip: The number of entries to skip., defaults to 0
1580
+ :type skip: int, optional
1581
+ :param page: The page number (i.e. skip limit*page entries)
1582
+ :type page: int, optional
1583
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1584
+ :type after_id: str, optional
1585
+ :param x_accept_feature: redirect header, defaults to []
1586
+ :type x_accept_feature: list[str], optional
1587
+ :param async_: Perform the request asynchronously
1588
+ :type async_: bool, optional
1589
+ :rtype: list[GroupOutput]
1465
1590
  """
1466
1591
 
1467
1592
  all_params = ['uid','exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
@@ -1547,17 +1672,27 @@ class UsersApi(object):
1547
1672
  Get all projects that belong to the given user.
1548
1673
  This method makes a synchronous HTTP request by default.
1549
1674
 
1550
- :param str uid: (required)
1551
- :param bool exhaustive: Set to return a complete list regardless of permissions
1552
- :param bool include_all_info: Include all info in returned objects
1553
- :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)
1554
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1555
- :param int limit: The maximum number of entries to return.
1556
- :param int skip: The number of entries to skip.
1557
- :param int page: The page number (i.e. skip limit*page entries)
1558
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1559
- :param bool async_: Perform the request asynchronously
1560
- :return: list[ProjectListOutput]
1675
+ :param uid:
1676
+ :type uid: str
1677
+ :param exhaustive: Set to return a complete list regardless of permissions
1678
+ :type exhaustive: bool, optional
1679
+ :param include_all_info: Include all info in returned objects, defaults to false
1680
+ :type include_all_info: bool, optional
1681
+ :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)
1682
+ :type filter: str, optional
1683
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1684
+ :type sort: str, optional
1685
+ :param limit: The maximum number of entries to return.
1686
+ :type limit: int, optional
1687
+ :param skip: The number of entries to skip., defaults to 0
1688
+ :type skip: int, optional
1689
+ :param page: The page number (i.e. skip limit*page entries)
1690
+ :type page: int, optional
1691
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1692
+ :type after_id: str, optional
1693
+ :param async_: Perform the request asynchronously
1694
+ :type async_: bool, optional
1695
+ :rtype: list[ProjectListOutput]
1561
1696
  """
1562
1697
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1563
1698
  kwargs['_return_http_data_only'] = True
@@ -1581,17 +1716,27 @@ class UsersApi(object):
1581
1716
  Get all projects that belong to the given user.
1582
1717
  This method makes a synchronous HTTP request by default.
1583
1718
 
1584
- :param str uid: (required)
1585
- :param bool exhaustive: Set to return a complete list regardless of permissions
1586
- :param bool include_all_info: Include all info in returned objects
1587
- :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)
1588
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1589
- :param int limit: The maximum number of entries to return.
1590
- :param int skip: The number of entries to skip.
1591
- :param int page: The page number (i.e. skip limit*page entries)
1592
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1593
- :param bool async_: Perform the request asynchronously
1594
- :return: list[ProjectListOutput]
1719
+ :param uid:
1720
+ :type uid: str
1721
+ :param exhaustive: Set to return a complete list regardless of permissions
1722
+ :type exhaustive: bool, optional
1723
+ :param include_all_info: Include all info in returned objects, defaults to false
1724
+ :type include_all_info: bool, optional
1725
+ :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)
1726
+ :type filter: str, optional
1727
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1728
+ :type sort: str, optional
1729
+ :param limit: The maximum number of entries to return.
1730
+ :type limit: int, optional
1731
+ :param skip: The number of entries to skip., defaults to 0
1732
+ :type skip: int, optional
1733
+ :param page: The page number (i.e. skip limit*page entries)
1734
+ :type page: int, optional
1735
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1736
+ :type after_id: str, optional
1737
+ :param async_: Perform the request asynchronously
1738
+ :type async_: bool, optional
1739
+ :rtype: list[ProjectListOutput]
1595
1740
  """
1596
1741
 
1597
1742
  all_params = ['uid','exhaustive','include_all_info','filter','sort','limit','skip','page','after_id',] # noqa: E501
@@ -1676,17 +1821,27 @@ class UsersApi(object):
1676
1821
  Get all sessions that belong to the given user.
1677
1822
  This method makes a synchronous HTTP request by default.
1678
1823
 
1679
- :param str uid: (required)
1680
- :param bool exhaustive:
1681
- :param bool include_all_info: Include all info in returned objects
1682
- :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)
1683
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1684
- :param int limit: The maximum number of entries to return.
1685
- :param int skip: The number of entries to skip.
1686
- :param int page: The page number (i.e. skip limit*page entries)
1687
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1688
- :param bool async_: Perform the request asynchronously
1689
- :return: list[SessionListOutput]
1824
+ :param uid:
1825
+ :type uid: str
1826
+ :param exhaustive:
1827
+ :type exhaustive: bool, optional
1828
+ :param include_all_info: Include all info in returned objects, defaults to false
1829
+ :type include_all_info: bool, optional
1830
+ :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)
1831
+ :type filter: str, optional
1832
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1833
+ :type sort: str, optional
1834
+ :param limit: The maximum number of entries to return.
1835
+ :type limit: int, optional
1836
+ :param skip: The number of entries to skip., defaults to 0
1837
+ :type skip: int, optional
1838
+ :param page: The page number (i.e. skip limit*page entries)
1839
+ :type page: int, optional
1840
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1841
+ :type after_id: str, optional
1842
+ :param async_: Perform the request asynchronously
1843
+ :type async_: bool, optional
1844
+ :rtype: list[SessionListOutput]
1690
1845
  """
1691
1846
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1692
1847
  kwargs['_return_http_data_only'] = True
@@ -1710,17 +1865,27 @@ class UsersApi(object):
1710
1865
  Get all sessions that belong to the given user.
1711
1866
  This method makes a synchronous HTTP request by default.
1712
1867
 
1713
- :param str uid: (required)
1714
- :param bool exhaustive:
1715
- :param bool include_all_info: Include all info in returned objects
1716
- :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)
1717
- :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
1718
- :param int limit: The maximum number of entries to return.
1719
- :param int skip: The number of entries to skip.
1720
- :param int page: The page number (i.e. skip limit*page entries)
1721
- :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1722
- :param bool async_: Perform the request asynchronously
1723
- :return: list[SessionListOutput]
1868
+ :param uid:
1869
+ :type uid: str
1870
+ :param exhaustive:
1871
+ :type exhaustive: bool, optional
1872
+ :param include_all_info: Include all info in returned objects, defaults to false
1873
+ :type include_all_info: bool, optional
1874
+ :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)
1875
+ :type filter: str, optional
1876
+ :param sort: The sort fields and order. (e.g. label:asc,created:desc)
1877
+ :type sort: str, optional
1878
+ :param limit: The maximum number of entries to return.
1879
+ :type limit: int, optional
1880
+ :param skip: The number of entries to skip., defaults to 0
1881
+ :type skip: int, optional
1882
+ :param page: The page number (i.e. skip limit*page entries)
1883
+ :type page: int, optional
1884
+ :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
1885
+ :type after_id: str, optional
1886
+ :param async_: Perform the request asynchronously
1887
+ :type async_: bool, optional
1888
+ :rtype: list[SessionListOutput]
1724
1889
  """
1725
1890
 
1726
1891
  all_params = ['uid','exhaustive','include_all_info','filter','sort','limit','skip','page','after_id',] # noqa: E501
@@ -1805,9 +1970,11 @@ class UsersApi(object):
1805
1970
  Modifies user info fields Args: info (Info): Model representing arbitrary data auth_session (AuthSession): session from incoming request Returns: None
1806
1971
  This method makes a synchronous HTTP request by default.
1807
1972
 
1808
- :param Info body: (required)
1809
- :param bool async_: Perform the request asynchronously
1810
- :return: None
1973
+ :param body:
1974
+ :type body: Info
1975
+ :param async_: Perform the request asynchronously
1976
+ :type async_: bool, optional
1977
+ :rtype: None
1811
1978
  """
1812
1979
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1813
1980
  kwargs['_return_http_data_only'] = True
@@ -1831,9 +1998,11 @@ class UsersApi(object):
1831
1998
  Modifies user info fields Args: info (Info): Model representing arbitrary data auth_session (AuthSession): session from incoming request Returns: None
1832
1999
  This method makes a synchronous HTTP request by default.
1833
2000
 
1834
- :param Info body: (required)
1835
- :param bool async_: Perform the request asynchronously
1836
- :return: None
2001
+ :param body:
2002
+ :type body: Info
2003
+ :param async_: Perform the request asynchronously
2004
+ :type async_: bool, optional
2005
+ :rtype: None
1837
2006
  """
1838
2007
 
1839
2008
  all_params = ['body',] # noqa: E501
@@ -1913,11 +2082,15 @@ class UsersApi(object):
1913
2082
  Update the specified user
1914
2083
  This method makes a synchronous HTTP request by default.
1915
2084
 
1916
- :param str uid: (required)
1917
- :param ModifyUserInput body: (required)
1918
- :param bool clear_permissions:
1919
- :param bool async_: Perform the request asynchronously
1920
- :return: ModifiedResult
2085
+ :param uid:
2086
+ :type uid: str
2087
+ :param body:
2088
+ :type body: ModifyUserInput
2089
+ :param clear_permissions:, defaults to false
2090
+ :type clear_permissions: bool, optional
2091
+ :param async_: Perform the request asynchronously
2092
+ :type async_: bool, optional
2093
+ :rtype: ModifiedResult
1921
2094
  """
1922
2095
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1923
2096
  kwargs['_return_http_data_only'] = True
@@ -1941,11 +2114,15 @@ class UsersApi(object):
1941
2114
  Update the specified user
1942
2115
  This method makes a synchronous HTTP request by default.
1943
2116
 
1944
- :param str uid: (required)
1945
- :param ModifyUserInput body: (required)
1946
- :param bool clear_permissions:
1947
- :param bool async_: Perform the request asynchronously
1948
- :return: ModifiedResult
2117
+ :param uid:
2118
+ :type uid: str
2119
+ :param body:
2120
+ :type body: ModifyUserInput
2121
+ :param clear_permissions:, defaults to false
2122
+ :type clear_permissions: bool, optional
2123
+ :param async_: Perform the request asynchronously
2124
+ :type async_: bool, optional
2125
+ :rtype: ModifiedResult
1949
2126
  """
1950
2127
 
1951
2128
  all_params = ['uid','body','clear_permissions',] # noqa: E501
@@ -2032,10 +2209,13 @@ class UsersApi(object):
2032
2209
 
2033
2210
  This method makes a synchronous HTTP request by default.
2034
2211
 
2035
- :param str cid: (required)
2036
- :param SyncUserInput body: (required)
2037
- :param bool async_: Perform the request asynchronously
2038
- :return: None
2212
+ :param cid:
2213
+ :type cid: str
2214
+ :param body:
2215
+ :type body: SyncUserInput
2216
+ :param async_: Perform the request asynchronously
2217
+ :type async_: bool, optional
2218
+ :rtype: None
2039
2219
  """
2040
2220
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
2041
2221
  kwargs['_return_http_data_only'] = True
@@ -2058,10 +2238,13 @@ class UsersApi(object):
2058
2238
 
2059
2239
  This method makes a synchronous HTTP request by default.
2060
2240
 
2061
- :param str cid: (required)
2062
- :param SyncUserInput body: (required)
2063
- :param bool async_: Perform the request asynchronously
2064
- :return: None
2241
+ :param cid:
2242
+ :type cid: str
2243
+ :param body:
2244
+ :type body: SyncUserInput
2245
+ :param async_: Perform the request asynchronously
2246
+ :type async_: bool, optional
2247
+ :rtype: None
2065
2248
  """
2066
2249
 
2067
2250
  all_params = ['cid','body',] # noqa: E501