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
flywheel/api/gears_api.py CHANGED
@@ -30,13 +30,10 @@ class GearsApi(object):
30
30
  If no existing gear is found, one will be created Otherwise, the specified gear will be updated
31
31
  This method makes a synchronous HTTP request by default.
32
32
 
33
- :param gear_name: Name of the gear to interact with
34
- :type gear_name: str
35
- :param body:
36
- :type body: GearDocumentLegacyInput
37
- :param async_: Perform the request asynchronously
38
- :type async_: bool, optional
39
- :rtype: GearIdOutput
33
+ :param str gear_name: Name of the gear to interact with (required)
34
+ :param GearDocumentLegacyInput body: (required)
35
+ :param bool async_: Perform the request asynchronously
36
+ :return: GearIdOutput
40
37
  """
41
38
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
42
39
  kwargs['_return_http_data_only'] = True
@@ -60,13 +57,10 @@ class GearsApi(object):
60
57
  If no existing gear is found, one will be created Otherwise, the specified gear will be updated
61
58
  This method makes a synchronous HTTP request by default.
62
59
 
63
- :param gear_name: Name of the gear to interact with
64
- :type gear_name: str
65
- :param body:
66
- :type body: GearDocumentLegacyInput
67
- :param async_: Perform the request asynchronously
68
- :type async_: bool, optional
69
- :rtype: GearIdOutput
60
+ :param str gear_name: Name of the gear to interact with (required)
61
+ :param GearDocumentLegacyInput body: (required)
62
+ :param bool async_: Perform the request asynchronously
63
+ :return: GearIdOutput
70
64
  """
71
65
 
72
66
  all_params = ['gear_name','body',] # noqa: E501
@@ -151,15 +145,11 @@ class GearsApi(object):
151
145
 
152
146
  This method makes a synchronous HTTP request by default.
153
147
 
154
- :param gear_name: Name of the gear to interact with
155
- :type gear_name: str
156
- :param permission_type:
157
- :type permission_type: GearPermissionsType
158
- :param body:
159
- :type body: GearPermissionsInput
160
- :param async_: Perform the request asynchronously
161
- :type async_: bool, optional
162
- :rtype: GearSeries
148
+ :param str gear_name: Name of the gear to interact with (required)
149
+ :param GearPermissionsType permission_type: (required)
150
+ :param GearPermissionsInput body: (required)
151
+ :param bool async_: Perform the request asynchronously
152
+ :return: GearSeries
163
153
  """
164
154
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
165
155
  kwargs['_return_http_data_only'] = True
@@ -182,15 +172,11 @@ class GearsApi(object):
182
172
 
183
173
  This method makes a synchronous HTTP request by default.
184
174
 
185
- :param gear_name: Name of the gear to interact with
186
- :type gear_name: str
187
- :param permission_type:
188
- :type permission_type: GearPermissionsType
189
- :param body:
190
- :type body: GearPermissionsInput
191
- :param async_: Perform the request asynchronously
192
- :type async_: bool, optional
193
- :rtype: GearSeries
175
+ :param str gear_name: Name of the gear to interact with (required)
176
+ :param GearPermissionsType permission_type: (required)
177
+ :param GearPermissionsInput body: (required)
178
+ :param bool async_: Perform the request asynchronously
179
+ :return: GearSeries
194
180
  """
195
181
 
196
182
  all_params = ['gear_name','permission_type','body',] # noqa: E501
@@ -281,11 +267,9 @@ class GearsApi(object):
281
267
 
282
268
  This method makes a synchronous HTTP request by default.
283
269
 
284
- :param gear_id: Id of the gear to interact with
285
- :type gear_id: str
286
- :param async_: Perform the request asynchronously
287
- :type async_: bool, optional
288
- :rtype: None
270
+ :param str gear_id: Id of the gear to interact with (required)
271
+ :param bool async_: Perform the request asynchronously
272
+ :return: None
289
273
  """
290
274
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
291
275
  kwargs['_return_http_data_only'] = True
@@ -308,11 +292,9 @@ class GearsApi(object):
308
292
 
309
293
  This method makes a synchronous HTTP request by default.
310
294
 
311
- :param gear_id: Id of the gear to interact with
312
- :type gear_id: str
313
- :param async_: Perform the request asynchronously
314
- :type async_: bool, optional
315
- :rtype: None
295
+ :param str gear_id: Id of the gear to interact with (required)
296
+ :param bool async_: Perform the request asynchronously
297
+ :return: None
316
298
  """
317
299
 
318
300
  all_params = ['gear_id',] # noqa: E501
@@ -380,15 +362,11 @@ class GearsApi(object):
380
362
 
381
363
  This method makes a synchronous HTTP request by default.
382
364
 
383
- :param gear_name:
384
- :type gear_name: str
385
- :param permission_type:
386
- :type permission_type: GearPermissionsType
387
- :param permission_id:
388
- :type permission_id: str
389
- :param async_: Perform the request asynchronously
390
- :type async_: bool, optional
391
- :rtype: None
365
+ :param str gear_name: (required)
366
+ :param GearPermissionsType permission_type: (required)
367
+ :param str permission_id: (required)
368
+ :param bool async_: Perform the request asynchronously
369
+ :return: None
392
370
  """
393
371
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
394
372
  kwargs['_return_http_data_only'] = True
@@ -411,15 +389,11 @@ class GearsApi(object):
411
389
 
412
390
  This method makes a synchronous HTTP request by default.
413
391
 
414
- :param gear_name:
415
- :type gear_name: str
416
- :param permission_type:
417
- :type permission_type: GearPermissionsType
418
- :param permission_id:
419
- :type permission_id: str
420
- :param async_: Perform the request asynchronously
421
- :type async_: bool, optional
422
- :rtype: None
392
+ :param str gear_name: (required)
393
+ :param GearPermissionsType permission_type: (required)
394
+ :param str permission_id: (required)
395
+ :param bool async_: Perform the request asynchronously
396
+ :return: None
423
397
  """
424
398
 
425
399
  all_params = ['gear_name','permission_type','permission_id',] # noqa: E501
@@ -499,11 +473,9 @@ class GearsApi(object):
499
473
 
500
474
  This method makes a synchronous HTTP request by default.
501
475
 
502
- :param gear_name:
503
- :type gear_name: str
504
- :param async_: Perform the request asynchronously
505
- :type async_: bool, optional
506
- :rtype: None
476
+ :param str gear_name: (required)
477
+ :param bool async_: Perform the request asynchronously
478
+ :return: None
507
479
  """
508
480
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
509
481
  kwargs['_return_http_data_only'] = True
@@ -526,11 +498,9 @@ class GearsApi(object):
526
498
 
527
499
  This method makes a synchronous HTTP request by default.
528
500
 
529
- :param gear_name:
530
- :type gear_name: str
531
- :param async_: Perform the request asynchronously
532
- :type async_: bool, optional
533
- :rtype: None
501
+ :param str gear_name: (required)
502
+ :param bool async_: Perform the request asynchronously
503
+ :return: None
534
504
  """
535
505
 
536
506
  all_params = ['gear_name',] # noqa: E501
@@ -599,31 +569,19 @@ class GearsApi(object):
599
569
  List all gears
600
570
  This method makes a synchronous HTTP request by default.
601
571
 
602
- :param project_id:
603
- :type project_id: str, optional
604
- :param all_versions: return all versions of each gear, defaults to false
605
- :type all_versions: bool, optional
606
- :param include_invalid: return gears with the 'invalid' flag set, defaults to false
607
- :type include_invalid: bool, optional
608
- :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)
609
- :type filter: str, optional
610
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
611
- :type sort: str, optional
612
- :param limit: The maximum number of entries to return.
613
- :type limit: int, optional
614
- :param skip: The number of entries to skip.
615
- :type skip: int, optional
616
- :param page: The page number (i.e. skip limit*page entries)
617
- :type page: int, optional
618
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
619
- :type after_id: str, optional
620
- :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
621
- :type exhaustive: bool, optional
622
- :param x_accept_feature:, defaults to []
623
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
624
- :param async_: Perform the request asynchronously
625
- :type async_: bool, optional
626
- :rtype: union[list[GearDocument],Page]
572
+ :param str project_id:
573
+ :param bool all_versions: return all versions of each gear
574
+ :param bool include_invalid: return gears with the 'invalid' flag set
575
+ :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)
576
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
577
+ :param int limit: The maximum number of entries to return.
578
+ :param int skip: The number of entries to skip.
579
+ :param int page: The page number (i.e. skip limit*page entries)
580
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
581
+ :param bool exhaustive: Set to return a complete list regardless of permissions
582
+ :param list[union[HeaderFeature,str]] x_accept_feature:
583
+ :param bool async_: Perform the request asynchronously
584
+ :return: union[list[GearDocument],Page]
627
585
  """
628
586
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
629
587
  kwargs['_return_http_data_only'] = True
@@ -647,31 +605,19 @@ class GearsApi(object):
647
605
  List all gears
648
606
  This method makes a synchronous HTTP request by default.
649
607
 
650
- :param project_id:
651
- :type project_id: str, optional
652
- :param all_versions: return all versions of each gear, defaults to false
653
- :type all_versions: bool, optional
654
- :param include_invalid: return gears with the 'invalid' flag set, defaults to false
655
- :type include_invalid: bool, optional
656
- :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)
657
- :type filter: str, optional
658
- :param sort: The sort fields and order. (e.g. label:asc,created:desc)
659
- :type sort: str, optional
660
- :param limit: The maximum number of entries to return.
661
- :type limit: int, optional
662
- :param skip: The number of entries to skip.
663
- :type skip: int, optional
664
- :param page: The page number (i.e. skip limit*page entries)
665
- :type page: int, optional
666
- :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
667
- :type after_id: str, optional
668
- :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
669
- :type exhaustive: bool, optional
670
- :param x_accept_feature:, defaults to []
671
- :type x_accept_feature: list[union[HeaderFeature,str]], optional
672
- :param async_: Perform the request asynchronously
673
- :type async_: bool, optional
674
- :rtype: union[list[GearDocument],Page]
608
+ :param str project_id:
609
+ :param bool all_versions: return all versions of each gear
610
+ :param bool include_invalid: return gears with the 'invalid' flag set
611
+ :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)
612
+ :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
613
+ :param int limit: The maximum number of entries to return.
614
+ :param int skip: The number of entries to skip.
615
+ :param int page: The page number (i.e. skip limit*page entries)
616
+ :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
617
+ :param bool exhaustive: Set to return a complete list regardless of permissions
618
+ :param list[union[HeaderFeature,str]] x_accept_feature:
619
+ :param bool async_: Perform the request asynchronously
620
+ :return: union[list[GearDocument],Page]
675
621
  """
676
622
 
677
623
  all_params = ['project_id','all_versions','include_invalid','filter','sort','limit','skip','page','after_id','exhaustive','x_accept_feature',] # noqa: E501
@@ -757,11 +703,9 @@ class GearsApi(object):
757
703
  Retrieve details about a specific gear
758
704
  This method makes a synchronous HTTP request by default.
759
705
 
760
- :param gear_id:
761
- :type gear_id: str
762
- :param async_: Perform the request asynchronously
763
- :type async_: bool, optional
764
- :rtype: GearDocument
706
+ :param str gear_id: (required)
707
+ :param bool async_: Perform the request asynchronously
708
+ :return: GearDocument
765
709
  """
766
710
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
767
711
  kwargs['_return_http_data_only'] = True
@@ -785,11 +729,9 @@ class GearsApi(object):
785
729
  Retrieve details about a specific gear
786
730
  This method makes a synchronous HTTP request by default.
787
731
 
788
- :param gear_id:
789
- :type gear_id: str
790
- :param async_: Perform the request asynchronously
791
- :type async_: bool, optional
792
- :rtype: GearDocument
732
+ :param str gear_id: (required)
733
+ :param bool async_: Perform the request asynchronously
734
+ :return: GearDocument
793
735
  """
794
736
 
795
737
  all_params = ['gear_id',] # noqa: E501
@@ -858,15 +800,11 @@ class GearsApi(object):
858
800
  Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values
859
801
  This method makes a synchronous HTTP request by default.
860
802
 
861
- :param gear_id:
862
- :type gear_id: str
863
- :param container_name:
864
- :type container_name: str
865
- :param container_id:
866
- :type container_id: str
867
- :param async_: Perform the request asynchronously
868
- :type async_: bool, optional
869
- :rtype: dict(str, union[GearContextValueOutput,GearContextValueOutputUnfound])
803
+ :param str gear_id: (required)
804
+ :param str container_name: (required)
805
+ :param str container_id: (required)
806
+ :param bool async_: Perform the request asynchronously
807
+ :return: dict(str, union[GearContextValueOutput,GearContextValueOutputUnfound])
870
808
  """
871
809
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
872
810
  kwargs['_return_http_data_only'] = True
@@ -890,15 +828,11 @@ class GearsApi(object):
890
828
  Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values
891
829
  This method makes a synchronous HTTP request by default.
892
830
 
893
- :param gear_id:
894
- :type gear_id: str
895
- :param container_name:
896
- :type container_name: str
897
- :param container_id:
898
- :type container_id: str
899
- :param async_: Perform the request asynchronously
900
- :type async_: bool, optional
901
- :rtype: dict(str, union[GearContextValueOutput,GearContextValueOutputUnfound])
831
+ :param str gear_id: (required)
832
+ :param str container_name: (required)
833
+ :param str container_id: (required)
834
+ :param bool async_: Perform the request asynchronously
835
+ :return: dict(str, union[GearContextValueOutput,GearContextValueOutputUnfound])
902
836
  """
903
837
 
904
838
  all_params = ['gear_id','container_name','container_id',] # noqa: E501
@@ -979,11 +913,9 @@ class GearsApi(object):
979
913
  Get a schema for invoking a gear.
980
914
  This method makes a synchronous HTTP request by default.
981
915
 
982
- :param gear_id:
983
- :type gear_id: str
984
- :param async_: Perform the request asynchronously
985
- :type async_: bool, optional
986
- :rtype: object
916
+ :param str gear_id: (required)
917
+ :param bool async_: Perform the request asynchronously
918
+ :return: object
987
919
  """
988
920
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
989
921
  kwargs['_return_http_data_only'] = True
@@ -1007,11 +939,9 @@ class GearsApi(object):
1007
939
  Get a schema for invoking a gear.
1008
940
  This method makes a synchronous HTTP request by default.
1009
941
 
1010
- :param gear_id:
1011
- :type gear_id: str
1012
- :param async_: Perform the request asynchronously
1013
- :type async_: bool, optional
1014
- :rtype: object
942
+ :param str gear_id: (required)
943
+ :param bool async_: Perform the request asynchronously
944
+ :return: object
1015
945
  """
1016
946
 
1017
947
  all_params = ['gear_id',] # noqa: E501
@@ -1080,11 +1010,9 @@ class GearsApi(object):
1080
1010
  Gets the series for the gear by its name
1081
1011
  This method makes a synchronous HTTP request by default.
1082
1012
 
1083
- :param gear_name:
1084
- :type gear_name: str
1085
- :param async_: Perform the request asynchronously
1086
- :type async_: bool, optional
1087
- :rtype: GearSeries
1013
+ :param str gear_name: (required)
1014
+ :param bool async_: Perform the request asynchronously
1015
+ :return: GearSeries
1088
1016
  """
1089
1017
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1090
1018
  kwargs['_return_http_data_only'] = True
@@ -1108,11 +1036,9 @@ class GearsApi(object):
1108
1036
  Gets the series for the gear by its name
1109
1037
  This method makes a synchronous HTTP request by default.
1110
1038
 
1111
- :param gear_name:
1112
- :type gear_name: str
1113
- :param async_: Perform the request asynchronously
1114
- :type async_: bool, optional
1115
- :rtype: GearSeries
1039
+ :param str gear_name: (required)
1040
+ :param bool async_: Perform the request asynchronously
1041
+ :return: GearSeries
1116
1042
  """
1117
1043
 
1118
1044
  all_params = ['gear_name',] # noqa: E501
@@ -1180,29 +1106,18 @@ class GearsApi(object):
1180
1106
 
1181
1107
  This method makes a synchronous HTTP request by default.
1182
1108
 
1183
- :param gear_id: Id of the gear to interact with
1184
- :type gear_id: str
1185
- :param container_name: Type of the container to interact with
1186
- :type container_name: str
1187
- :param container_id: Id of the container to interact with
1188
- :type container_id: str
1189
- :param filter:
1190
- :type filter: str, optional
1191
- :param sort:
1192
- :type sort: str, optional
1193
- :param limit:, defaults to 100
1194
- :type limit: int, optional
1195
- :param skip:
1196
- :type skip: int, optional
1197
- :param page:
1198
- :type page: int, optional
1199
- :param include: Include only \"children\" or \"files\", defaults to ["children","files"]
1200
- :type include: list[str], optional
1201
- :param collection: Get suggestions for a collection
1202
- :type collection: str, optional
1203
- :param async_: Perform the request asynchronously
1204
- :type async_: bool, optional
1205
- :rtype: GearSuggestionOutput
1109
+ :param str gear_id: Id of the gear to interact with (required)
1110
+ :param str container_name: Type of the container to interact with (required)
1111
+ :param str container_id: Id of the container to interact with (required)
1112
+ :param str filter:
1113
+ :param str sort:
1114
+ :param int limit:
1115
+ :param int skip:
1116
+ :param int page:
1117
+ :param list[str] include: Include only \"children\" or \"files\"
1118
+ :param str collection: Get suggestions for a collection
1119
+ :param bool async_: Perform the request asynchronously
1120
+ :return: GearSuggestionOutput
1206
1121
  """
1207
1122
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1208
1123
  kwargs['_return_http_data_only'] = True
@@ -1225,29 +1140,18 @@ class GearsApi(object):
1225
1140
 
1226
1141
  This method makes a synchronous HTTP request by default.
1227
1142
 
1228
- :param gear_id: Id of the gear to interact with
1229
- :type gear_id: str
1230
- :param container_name: Type of the container to interact with
1231
- :type container_name: str
1232
- :param container_id: Id of the container to interact with
1233
- :type container_id: str
1234
- :param filter:
1235
- :type filter: str, optional
1236
- :param sort:
1237
- :type sort: str, optional
1238
- :param limit:, defaults to 100
1239
- :type limit: int, optional
1240
- :param skip:
1241
- :type skip: int, optional
1242
- :param page:
1243
- :type page: int, optional
1244
- :param include: Include only \"children\" or \"files\", defaults to ["children","files"]
1245
- :type include: list[str], optional
1246
- :param collection: Get suggestions for a collection
1247
- :type collection: str, optional
1248
- :param async_: Perform the request asynchronously
1249
- :type async_: bool, optional
1250
- :rtype: GearSuggestionOutput
1143
+ :param str gear_id: Id of the gear to interact with (required)
1144
+ :param str container_name: Type of the container to interact with (required)
1145
+ :param str container_id: Id of the container to interact with (required)
1146
+ :param str filter:
1147
+ :param str sort:
1148
+ :param int limit:
1149
+ :param int skip:
1150
+ :param int page:
1151
+ :param list[str] include: Include only \"children\" or \"files\"
1152
+ :param str collection: Get suggestions for a collection
1153
+ :param bool async_: Perform the request asynchronously
1154
+ :return: GearSuggestionOutput
1251
1155
  """
1252
1156
 
1253
1157
  all_params = ['gear_id','container_name','container_id','filter','sort','limit','skip','page','include','collection',] # noqa: E501
@@ -1342,11 +1246,9 @@ class GearsApi(object):
1342
1246
 
1343
1247
  This method makes a synchronous HTTP request by default.
1344
1248
 
1345
- :param ticket_id:
1346
- :type ticket_id: str
1347
- :param async_: Perform the request asynchronously
1348
- :type async_: bool, optional
1349
- :rtype: GearTicket
1249
+ :param str ticket_id: (required)
1250
+ :param bool async_: Perform the request asynchronously
1251
+ :return: GearTicket
1350
1252
  """
1351
1253
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1352
1254
  kwargs['_return_http_data_only'] = True
@@ -1369,11 +1271,9 @@ class GearsApi(object):
1369
1271
 
1370
1272
  This method makes a synchronous HTTP request by default.
1371
1273
 
1372
- :param ticket_id:
1373
- :type ticket_id: str
1374
- :param async_: Perform the request asynchronously
1375
- :type async_: bool, optional
1376
- :rtype: GearTicket
1274
+ :param str ticket_id: (required)
1275
+ :param bool async_: Perform the request asynchronously
1276
+ :return: GearTicket
1377
1277
  """
1378
1278
 
1379
1279
  all_params = ['ticket_id',] # noqa: E501
@@ -1441,9 +1341,8 @@ class GearsApi(object):
1441
1341
 
1442
1342
  This method makes a synchronous HTTP request by default.
1443
1343
 
1444
- :param async_: Perform the request asynchronously
1445
- :type async_: bool, optional
1446
- :rtype: list[str]
1344
+ :param bool async_: Perform the request asynchronously
1345
+ :return: list[str]
1447
1346
  """
1448
1347
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1449
1348
  kwargs['_return_http_data_only'] = True
@@ -1466,9 +1365,8 @@ class GearsApi(object):
1466
1365
 
1467
1366
  This method makes a synchronous HTTP request by default.
1468
1367
 
1469
- :param async_: Perform the request asynchronously
1470
- :type async_: bool, optional
1471
- :rtype: list[str]
1368
+ :param bool async_: Perform the request asynchronously
1369
+ :return: list[str]
1472
1370
  """
1473
1371
 
1474
1372
  all_params = [] # noqa: E501
@@ -1530,13 +1428,10 @@ class GearsApi(object):
1530
1428
 
1531
1429
  This method makes a synchronous HTTP request by default.
1532
1430
 
1533
- :param gear_name: Name of the gear series to modify
1534
- :type gear_name: str
1535
- :param body:
1536
- :type body: GearSeriesUpdate
1537
- :param async_: Perform the request asynchronously
1538
- :type async_: bool, optional
1539
- :rtype: GearSeries
1431
+ :param str gear_name: Name of the gear series to modify (required)
1432
+ :param GearSeriesUpdate body: (required)
1433
+ :param bool async_: Perform the request asynchronously
1434
+ :return: GearSeries
1540
1435
  """
1541
1436
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1542
1437
  kwargs['_return_http_data_only'] = True
@@ -1559,13 +1454,10 @@ class GearsApi(object):
1559
1454
 
1560
1455
  This method makes a synchronous HTTP request by default.
1561
1456
 
1562
- :param gear_name: Name of the gear series to modify
1563
- :type gear_name: str
1564
- :param body:
1565
- :type body: GearSeriesUpdate
1566
- :param async_: Perform the request asynchronously
1567
- :type async_: bool, optional
1568
- :rtype: GearSeries
1457
+ :param str gear_name: Name of the gear series to modify (required)
1458
+ :param GearSeriesUpdate body: (required)
1459
+ :param bool async_: Perform the request asynchronously
1460
+ :return: GearSeries
1569
1461
  """
1570
1462
 
1571
1463
  all_params = ['gear_name','body',] # noqa: E501
@@ -1651,11 +1543,9 @@ class GearsApi(object):
1651
1543
  Prepare a gear upload
1652
1544
  This method makes a synchronous HTTP request by default.
1653
1545
 
1654
- :param body:
1655
- :type body: GearDocumentInput
1656
- :param async_: Perform the request asynchronously
1657
- :type async_: bool, optional
1658
- :rtype: GearTicketOutput
1546
+ :param GearDocumentInput body: (required)
1547
+ :param bool async_: Perform the request asynchronously
1548
+ :return: GearTicketOutput
1659
1549
  """
1660
1550
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1661
1551
  kwargs['_return_http_data_only'] = True
@@ -1679,11 +1569,9 @@ class GearsApi(object):
1679
1569
  Prepare a gear upload
1680
1570
  This method makes a synchronous HTTP request by default.
1681
1571
 
1682
- :param body:
1683
- :type body: GearDocumentInput
1684
- :param async_: Perform the request asynchronously
1685
- :type async_: bool, optional
1686
- :rtype: GearTicketOutput
1572
+ :param GearDocumentInput body: (required)
1573
+ :param bool async_: Perform the request asynchronously
1574
+ :return: GearTicketOutput
1687
1575
  """
1688
1576
 
1689
1577
  all_params = ['body',] # noqa: E501
@@ -1762,13 +1650,10 @@ class GearsApi(object):
1762
1650
 
1763
1651
  This method makes a synchronous HTTP request by default.
1764
1652
 
1765
- :param gear_name: Name of the gear to interact with
1766
- :type gear_name: str
1767
- :param body:
1768
- :type body: GearPermissions
1769
- :param async_: Perform the request asynchronously
1770
- :type async_: bool, optional
1771
- :rtype: GearSeries
1653
+ :param str gear_name: Name of the gear to interact with (required)
1654
+ :param GearPermissions body: (required)
1655
+ :param bool async_: Perform the request asynchronously
1656
+ :return: GearSeries
1772
1657
  """
1773
1658
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1774
1659
  kwargs['_return_http_data_only'] = True
@@ -1791,13 +1676,10 @@ class GearsApi(object):
1791
1676
 
1792
1677
  This method makes a synchronous HTTP request by default.
1793
1678
 
1794
- :param gear_name: Name of the gear to interact with
1795
- :type gear_name: str
1796
- :param body:
1797
- :type body: GearPermissions
1798
- :param async_: Perform the request asynchronously
1799
- :type async_: bool, optional
1800
- :rtype: GearSeries
1679
+ :param str gear_name: Name of the gear to interact with (required)
1680
+ :param GearPermissions body: (required)
1681
+ :param bool async_: Perform the request asynchronously
1682
+ :return: GearSeries
1801
1683
  """
1802
1684
 
1803
1685
  all_params = ['gear_name','body',] # noqa: E501
@@ -1883,11 +1765,9 @@ class GearsApi(object):
1883
1765
  Report the result of a gear upload and save the ticket
1884
1766
  This method makes a synchronous HTTP request by default.
1885
1767
 
1886
- :param body:
1887
- :type body: GearSaveSubmission
1888
- :param async_: Perform the request asynchronously
1889
- :type async_: bool, optional
1890
- :rtype: GearDocument
1768
+ :param GearSaveSubmission body: (required)
1769
+ :param bool async_: Perform the request asynchronously
1770
+ :return: GearDocument
1891
1771
  """
1892
1772
  ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
1893
1773
  kwargs['_return_http_data_only'] = True
@@ -1911,11 +1791,9 @@ class GearsApi(object):
1911
1791
  Report the result of a gear upload and save the ticket
1912
1792
  This method makes a synchronous HTTP request by default.
1913
1793
 
1914
- :param body:
1915
- :type body: GearSaveSubmission
1916
- :param async_: Perform the request asynchronously
1917
- :type async_: bool, optional
1918
- :rtype: GearDocument
1794
+ :param GearSaveSubmission body: (required)
1795
+ :param bool async_: Perform the request asynchronously
1796
+ :return: GearDocument
1919
1797
  """
1920
1798
 
1921
1799
  all_params = ['body',] # noqa: E501