flywheel-sdk 21.0.0rc0__py2.py3-none-any.whl → 21.1.0__py2.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.
- flywheel/__init__.py +51 -3
- flywheel/api/__init__.py +5 -0
- flywheel/api/audit_trail_api.py +8 -8
- flywheel/api/container_tasks_api.py +137 -0
- flywheel/api/form_responses_api.py +579 -0
- flywheel/api/jobs_api.py +97 -0
- flywheel/api/protocols_api.py +757 -0
- flywheel/api/staffing_pools_api.py +677 -0
- flywheel/api/tasks_api.py +897 -0
- flywheel/api_client.py +1 -1
- flywheel/configuration.py +2 -2
- flywheel/flywheel.py +369 -3
- flywheel/models/__init__.py +47 -4
- flywheel/models/action.py +3 -0
- flywheel/models/assignee.py +190 -0
- flywheel/models/assignee_type.py +28 -0
- flywheel/models/batch_create_filters.py +218 -0
- flywheel/models/container_type.py +1 -0
- flywheel/models/{create_report_input.py → core_models_audit_trail_create_report_input.py} +24 -24
- flywheel/models/{modify_report_input.py → core_models_audit_trail_modify_report_input.py} +8 -8
- flywheel/models/{parent_type.py → core_models_search_parent_type.py} +1 -1
- flywheel/models/core_workflows_form_responses_models_form_parents.py +162 -0
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +438 -0
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +268 -0
- flywheel/models/current_user_output.py +31 -4
- flywheel/models/custom_field.py +404 -0
- flywheel/models/custom_form.py +242 -0
- flywheel/models/e_signature.py +241 -0
- flywheel/models/features.py +1 -28
- flywheel/models/field_type.py +35 -0
- flywheel/models/form_response_base.py +310 -0
- flywheel/models/form_response_create.py +192 -0
- flywheel/models/libs_workflows_models_parent_type.py +31 -0
- flywheel/models/libs_workflows_models_task_status.py +31 -0
- flywheel/models/modify_user_input.py +31 -4
- flywheel/models/page_generic_form_response_output.py +217 -0
- flywheel/models/page_generic_protocol.py +242 -0
- flywheel/models/page_generic_reader_task_output.py +242 -0
- flywheel/models/page_generic_staffing_pool.py +242 -0
- flywheel/models/protocol.py +511 -0
- flywheel/models/protocol_e_signature_config.py +190 -0
- flywheel/models/protocol_input.py +352 -0
- flywheel/models/protocol_modify.py +275 -0
- flywheel/models/protocol_status.py +29 -0
- flywheel/models/reader_batch_create.py +460 -0
- flywheel/models/reader_task.py +723 -0
- flywheel/models/reader_task_config.py +188 -0
- flywheel/models/reader_task_create.py +541 -0
- flywheel/models/reader_task_modify.py +274 -0
- flywheel/models/reader_task_output.py +750 -0
- flywheel/models/reader_task_parent_details.py +295 -0
- flywheel/models/save_search_parent.py +4 -4
- flywheel/models/select_item.py +189 -0
- flywheel/models/staffing_pool.py +322 -0
- flywheel/models/staffing_pool_create.py +215 -0
- flywheel/models/staffing_pool_list.py +163 -0
- flywheel/models/staffing_pool_modify.py +217 -0
- flywheel/models/status_transitions.py +244 -0
- flywheel/models/task_assign.py +192 -0
- flywheel/models/task_facet.py +28 -0
- flywheel/models/task_parent_ref.py +243 -0
- flywheel/models/task_parent_ref_input.py +217 -0
- flywheel/models/task_priority.py +30 -0
- flywheel/models/task_submission.py +188 -0
- flywheel/models/user_input.py +31 -4
- flywheel/models/validation_rule.py +189 -0
- {flywheel_sdk-21.0.0rc0.dist-info → flywheel_sdk-21.1.0.dist-info}/METADATA +1 -1
- {flywheel_sdk-21.0.0rc0.dist-info → flywheel_sdk-21.1.0.dist-info}/RECORD +71 -23
- {flywheel_sdk-21.0.0rc0.dist-info → flywheel_sdk-21.1.0.dist-info}/WHEEL +0 -0
- {flywheel_sdk-21.0.0rc0.dist-info → flywheel_sdk-21.1.0.dist-info}/licenses/LICENSE.txt +0 -0
- {flywheel_sdk-21.0.0rc0.dist-info → flywheel_sdk-21.1.0.dist-info}/top_level.txt +0 -0
flywheel/api_client.py
CHANGED
|
@@ -84,7 +84,7 @@ class ApiClient(object):
|
|
|
84
84
|
self.default_query_params = []
|
|
85
85
|
self.cookie = cookie
|
|
86
86
|
# Set default User-Agent.
|
|
87
|
-
self.user_agent = 'Swagger-Codegen/21.
|
|
87
|
+
self.user_agent = 'Swagger-Codegen/21.1.0/python'
|
|
88
88
|
self.last_response = None
|
|
89
89
|
self._version_check_fn = None
|
|
90
90
|
self._context = context
|
flywheel/configuration.py
CHANGED
|
@@ -253,8 +253,8 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
|
|
|
253
253
|
return "Python SDK Debug Report:\n"\
|
|
254
254
|
"OS: {env}\n"\
|
|
255
255
|
"Python Version: {pyversion}\n"\
|
|
256
|
-
"Version of the API: 21.
|
|
257
|
-
"SDK Package Version: 21.
|
|
256
|
+
"Version of the API: 21.1.0\n"\
|
|
257
|
+
"SDK Package Version: 21.1.0".\
|
|
258
258
|
format(env=sys.platform, pyversion=sys.version)
|
|
259
259
|
|
|
260
260
|
def enable_message_cutoff(self, message_cutoff):
|
flywheel/flywheel.py
CHANGED
|
@@ -40,7 +40,7 @@ from flywheel.view_builder import ViewBuilder
|
|
|
40
40
|
from flywheel.finder import Finder
|
|
41
41
|
import flywheel.api
|
|
42
42
|
|
|
43
|
-
SDK_VERSION = "21.
|
|
43
|
+
SDK_VERSION = "21.1.0"
|
|
44
44
|
|
|
45
45
|
def config_from_api_key(api_key):
|
|
46
46
|
parts = api_key.split(':')
|
|
@@ -143,6 +143,7 @@ class Flywheel:
|
|
|
143
143
|
self.change_log_api = flywheel.api.ChangeLogApi(self.api_client)
|
|
144
144
|
self.collections_api = flywheel.api.CollectionsApi(self.api_client)
|
|
145
145
|
self.config_api = flywheel.api.ConfigApi(self.api_client)
|
|
146
|
+
self.container_tasks_api = flywheel.api.ContainerTasksApi(self.api_client)
|
|
146
147
|
self.container_type_api = flywheel.api.ContainerTypeApi(self.api_client)
|
|
147
148
|
self.containers_api = flywheel.api.ContainersApi(self.api_client)
|
|
148
149
|
self.custom_filters_api = flywheel.api.CustomFiltersApi(self.api_client)
|
|
@@ -152,6 +153,7 @@ class Flywheel:
|
|
|
152
153
|
self.dimse_api = flywheel.api.DimseApi(self.api_client)
|
|
153
154
|
self.download_api = flywheel.api.DownloadApi(self.api_client)
|
|
154
155
|
self.files_api = flywheel.api.FilesApi(self.api_client)
|
|
156
|
+
self.form_responses_api = flywheel.api.FormResponsesApi(self.api_client)
|
|
155
157
|
self.gears_api = flywheel.api.GearsApi(self.api_client)
|
|
156
158
|
self.groups_api = flywheel.api.GroupsApi(self.api_client)
|
|
157
159
|
self.jobs_api = flywheel.api.JobsApi(self.api_client)
|
|
@@ -159,12 +161,15 @@ class Flywheel:
|
|
|
159
161
|
self.modalities_api = flywheel.api.ModalitiesApi(self.api_client)
|
|
160
162
|
self.packfiles_api = flywheel.api.PackfilesApi(self.api_client)
|
|
161
163
|
self.projects_api = flywheel.api.ProjectsApi(self.api_client)
|
|
164
|
+
self.protocols_api = flywheel.api.ProtocolsApi(self.api_client)
|
|
162
165
|
self.reports_api = flywheel.api.ReportsApi(self.api_client)
|
|
163
166
|
self.resolve_api = flywheel.api.ResolveApi(self.api_client)
|
|
164
167
|
self.roles_api = flywheel.api.RolesApi(self.api_client)
|
|
165
168
|
self.sessions_api = flywheel.api.SessionsApi(self.api_client)
|
|
166
169
|
self.site_api = flywheel.api.SiteApi(self.api_client)
|
|
170
|
+
self.staffing_pools_api = flywheel.api.StaffingPoolsApi(self.api_client)
|
|
167
171
|
self.subjects_api = flywheel.api.SubjectsApi(self.api_client)
|
|
172
|
+
self.tasks_api = flywheel.api.TasksApi(self.api_client)
|
|
168
173
|
self.tree_api = flywheel.api.TreeApi(self.api_client)
|
|
169
174
|
self.uids_api = flywheel.api.UidsApi(self.api_client)
|
|
170
175
|
self.upload_api = flywheel.api.UploadApi(self.api_client)
|
|
@@ -1397,7 +1402,7 @@ class Flywheel:
|
|
|
1397
1402
|
|
|
1398
1403
|
Start generation of a new Audit Trail Report.
|
|
1399
1404
|
|
|
1400
|
-
:param
|
|
1405
|
+
:param CoreModelsAuditTrailCreateReportInput body: (required)
|
|
1401
1406
|
:param bool async_: Perform the request asynchronously
|
|
1402
1407
|
:return: AuditTrailReport
|
|
1403
1408
|
"""
|
|
@@ -1452,7 +1457,7 @@ class Flywheel:
|
|
|
1452
1457
|
Modify an Audit Trail Report
|
|
1453
1458
|
|
|
1454
1459
|
:param str report_id: (required)
|
|
1455
|
-
:param
|
|
1460
|
+
:param CoreModelsAuditTrailModifyReportInput body: (required)
|
|
1456
1461
|
:param bool async_: Perform the request asynchronously
|
|
1457
1462
|
:return: AuditTrailReport
|
|
1458
1463
|
"""
|
|
@@ -2117,6 +2122,19 @@ class Flywheel:
|
|
|
2117
2122
|
return self.config_api.get_version(**kwargs)
|
|
2118
2123
|
|
|
2119
2124
|
|
|
2125
|
+
def get_task_parent_container_ids(self, ids, container_type, **kwargs): # noqa: E501
|
|
2126
|
+
"""Get Task Parent Container Ids
|
|
2127
|
+
|
|
2128
|
+
Get the list of container IDs that have tasks associated with them.
|
|
2129
|
+
|
|
2130
|
+
:param str ids: Comma separated list of container IDs (required)
|
|
2131
|
+
:param ContainerType container_type: (required)
|
|
2132
|
+
:param bool async_: Perform the request asynchronously
|
|
2133
|
+
:return: list[str]
|
|
2134
|
+
"""
|
|
2135
|
+
return self.container_tasks_api.get_task_parent_container_ids(ids, container_type, **kwargs)
|
|
2136
|
+
|
|
2137
|
+
|
|
2120
2138
|
def cleanup_info(self, container_type, path, **kwargs): # noqa: E501
|
|
2121
2139
|
"""Remove a custom field from all applicable containers
|
|
2122
2140
|
|
|
@@ -3487,6 +3505,74 @@ class Flywheel:
|
|
|
3487
3505
|
return self.files_api.upsert_file(body, **kwargs)
|
|
3488
3506
|
|
|
3489
3507
|
|
|
3508
|
+
def create_task_response(self, task_id, body, **kwargs): # noqa: E501
|
|
3509
|
+
"""Create a new response for a task using its protocol's form schema
|
|
3510
|
+
|
|
3511
|
+
Create a new response for a task using its protocol's form schema. Responses can be saved multiple times before submission. Each response is validated against the form schema defined in the protocol.
|
|
3512
|
+
|
|
3513
|
+
:param str task_id: (required)
|
|
3514
|
+
:param FormResponseCreate body: (required)
|
|
3515
|
+
:param bool async_: Perform the request asynchronously
|
|
3516
|
+
:return: CoreWorkflowsFormResponsesModelsFormResponseOutput
|
|
3517
|
+
"""
|
|
3518
|
+
return self.form_responses_api.create_task_response(task_id, body, **kwargs)
|
|
3519
|
+
|
|
3520
|
+
|
|
3521
|
+
def get_response(self, response_id, **kwargs): # noqa: E501
|
|
3522
|
+
"""Retrieve a specific response
|
|
3523
|
+
|
|
3524
|
+
Retrieve a specific response.
|
|
3525
|
+
|
|
3526
|
+
:param str response_id: (required)
|
|
3527
|
+
:param bool async_: Perform the request asynchronously
|
|
3528
|
+
:return: CoreWorkflowsFormResponsesModelsFormResponseOutput
|
|
3529
|
+
"""
|
|
3530
|
+
return self.form_responses_api.get_response(response_id, **kwargs)
|
|
3531
|
+
|
|
3532
|
+
|
|
3533
|
+
def list_task_responses(self, task_id, **kwargs): # noqa: E501
|
|
3534
|
+
"""List all responses for a given task
|
|
3535
|
+
|
|
3536
|
+
List all responses for a given task.
|
|
3537
|
+
|
|
3538
|
+
:param str task_id: (required)
|
|
3539
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3540
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3541
|
+
:param int limit: The maximum number of entries to return.
|
|
3542
|
+
:param int skip: The number of entries to skip.
|
|
3543
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3544
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3545
|
+
:param bool async_: Perform the request asynchronously
|
|
3546
|
+
:return: PageGenericFormResponseOutput
|
|
3547
|
+
"""
|
|
3548
|
+
return self.form_responses_api.list_task_responses(task_id, **kwargs)
|
|
3549
|
+
|
|
3550
|
+
|
|
3551
|
+
def submit_response(self, response_id, **kwargs): # noqa: E501
|
|
3552
|
+
"""Submit a response. Validate against form schema and lock it
|
|
3553
|
+
|
|
3554
|
+
Submit a response. Validate against form schema and lock it. Once submitted: - submitted flag is set to true - submitted_at timestamp is recorded - origin is set to the submitting user - further edits are disabled
|
|
3555
|
+
|
|
3556
|
+
:param str response_id: (required)
|
|
3557
|
+
:param bool async_: Perform the request asynchronously
|
|
3558
|
+
:return: CoreWorkflowsFormResponsesModelsFormResponseOutput
|
|
3559
|
+
"""
|
|
3560
|
+
return self.form_responses_api.submit_response(response_id, **kwargs)
|
|
3561
|
+
|
|
3562
|
+
|
|
3563
|
+
def update_response(self, response_id, body, **kwargs): # noqa: E501
|
|
3564
|
+
"""Update a response only if not submitted
|
|
3565
|
+
|
|
3566
|
+
Update a response only if not submitted. Responses can be saved multiple times before submission. Once submitted, further edits are disabled.
|
|
3567
|
+
|
|
3568
|
+
:param str response_id: (required)
|
|
3569
|
+
:param FormResponseBase body: (required)
|
|
3570
|
+
:param bool async_: Perform the request asynchronously
|
|
3571
|
+
:return: CoreWorkflowsFormResponsesModelsFormResponseOutput
|
|
3572
|
+
"""
|
|
3573
|
+
return self.form_responses_api.update_response(response_id, body, **kwargs)
|
|
3574
|
+
|
|
3575
|
+
|
|
3490
3576
|
def add_gear(self, gear_name, body, **kwargs): # noqa: E501
|
|
3491
3577
|
"""Create or update a gear.
|
|
3492
3578
|
|
|
@@ -4216,6 +4302,18 @@ class Flywheel:
|
|
|
4216
4302
|
return self.jobs_api.get_next_job(**kwargs)
|
|
4217
4303
|
|
|
4218
4304
|
|
|
4305
|
+
def heartbeat_job(self, job_id, **kwargs): # noqa: E501
|
|
4306
|
+
"""Heartbeat a running job to update its modified timestamp.
|
|
4307
|
+
|
|
4308
|
+
Updates the modified timestamp for a running job without changing its state. Used by engines to keep jobs alive.
|
|
4309
|
+
|
|
4310
|
+
:param str job_id: (required)
|
|
4311
|
+
:param bool async_: Perform the request asynchronously
|
|
4312
|
+
:return: ModifiedResult
|
|
4313
|
+
"""
|
|
4314
|
+
return self.jobs_api.heartbeat_job(job_id, **kwargs)
|
|
4315
|
+
|
|
4316
|
+
|
|
4219
4317
|
def modify_job(self, job_id, body, **kwargs): # noqa: E501
|
|
4220
4318
|
"""Update a job.
|
|
4221
4319
|
|
|
@@ -5384,6 +5482,96 @@ class Flywheel:
|
|
|
5384
5482
|
return self.projects_api.upsert_project_hierarchy(project_id, body, **kwargs)
|
|
5385
5483
|
|
|
5386
5484
|
|
|
5485
|
+
def archive_task_protocol(self, protocol_id, **kwargs): # noqa: E501
|
|
5486
|
+
"""Archive
|
|
5487
|
+
|
|
5488
|
+
Archive a protocol.
|
|
5489
|
+
|
|
5490
|
+
:param str protocol_id: (required)
|
|
5491
|
+
:param bool async_: Perform the request asynchronously
|
|
5492
|
+
:return: Protocol
|
|
5493
|
+
"""
|
|
5494
|
+
return self.protocols_api.archive_task_protocol(protocol_id, **kwargs)
|
|
5495
|
+
|
|
5496
|
+
|
|
5497
|
+
def create_task_protocol(self, body, **kwargs): # noqa: E501
|
|
5498
|
+
"""Create
|
|
5499
|
+
|
|
5500
|
+
Create a new protocol.
|
|
5501
|
+
|
|
5502
|
+
:param ProtocolInput body: (required)
|
|
5503
|
+
:param bool async_: Perform the request asynchronously
|
|
5504
|
+
:return: Protocol
|
|
5505
|
+
"""
|
|
5506
|
+
return self.protocols_api.create_task_protocol(body, **kwargs)
|
|
5507
|
+
|
|
5508
|
+
|
|
5509
|
+
def delete_task_protocol(self, protocol_id, **kwargs): # noqa: E501
|
|
5510
|
+
"""Delete
|
|
5511
|
+
|
|
5512
|
+
Delete a protocol
|
|
5513
|
+
|
|
5514
|
+
:param str protocol_id: (required)
|
|
5515
|
+
:param bool async_: Perform the request asynchronously
|
|
5516
|
+
:return: None
|
|
5517
|
+
"""
|
|
5518
|
+
return self.protocols_api.delete_task_protocol(protocol_id, **kwargs)
|
|
5519
|
+
|
|
5520
|
+
|
|
5521
|
+
def find_task_protocols(self, **kwargs): # noqa: E501
|
|
5522
|
+
"""Find All
|
|
5523
|
+
|
|
5524
|
+
Get a paginated list of protocols.
|
|
5525
|
+
|
|
5526
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
5527
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
5528
|
+
:param int limit: The maximum number of entries to return.
|
|
5529
|
+
:param int skip: The number of entries to skip.
|
|
5530
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
5531
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
5532
|
+
:param bool async_: Perform the request asynchronously
|
|
5533
|
+
:return: PageGenericProtocol
|
|
5534
|
+
"""
|
|
5535
|
+
return self.protocols_api.find_task_protocols(**kwargs)
|
|
5536
|
+
|
|
5537
|
+
|
|
5538
|
+
def get_task_protocol(self, protocol_id, **kwargs): # noqa: E501
|
|
5539
|
+
"""Get By Id
|
|
5540
|
+
|
|
5541
|
+
Get protocol by id.
|
|
5542
|
+
|
|
5543
|
+
:param str protocol_id: (required)
|
|
5544
|
+
:param bool async_: Perform the request asynchronously
|
|
5545
|
+
:return: Protocol
|
|
5546
|
+
"""
|
|
5547
|
+
return self.protocols_api.get_task_protocol(protocol_id, **kwargs)
|
|
5548
|
+
|
|
5549
|
+
|
|
5550
|
+
def modify_task_protocol(self, protocol_id, body, **kwargs): # noqa: E501
|
|
5551
|
+
"""Modify
|
|
5552
|
+
|
|
5553
|
+
Modify a protocol.
|
|
5554
|
+
|
|
5555
|
+
:param str protocol_id: (required)
|
|
5556
|
+
:param ProtocolModify body: (required)
|
|
5557
|
+
:param bool async_: Perform the request asynchronously
|
|
5558
|
+
:return: Protocol
|
|
5559
|
+
"""
|
|
5560
|
+
return self.protocols_api.modify_task_protocol(protocol_id, body, **kwargs)
|
|
5561
|
+
|
|
5562
|
+
|
|
5563
|
+
def publish_task_protocol(self, protocol_id, **kwargs): # noqa: E501
|
|
5564
|
+
"""Publish
|
|
5565
|
+
|
|
5566
|
+
Publish a protocol.
|
|
5567
|
+
|
|
5568
|
+
:param str protocol_id: (required)
|
|
5569
|
+
:param bool async_: Perform the request asynchronously
|
|
5570
|
+
:return: Protocol
|
|
5571
|
+
"""
|
|
5572
|
+
return self.protocols_api.publish_task_protocol(protocol_id, **kwargs)
|
|
5573
|
+
|
|
5574
|
+
|
|
5387
5575
|
def collect_usage(self, **kwargs): # noqa: E501
|
|
5388
5576
|
"""Collect daily usage statistics.
|
|
5389
5577
|
|
|
@@ -6493,6 +6681,83 @@ class Flywheel:
|
|
|
6493
6681
|
return self.site_api.remove_site_rule(rule_id, **kwargs)
|
|
6494
6682
|
|
|
6495
6683
|
|
|
6684
|
+
def create_staffing_pool(self, body, **kwargs): # noqa: E501
|
|
6685
|
+
"""Create
|
|
6686
|
+
|
|
6687
|
+
Create a staffing pool.
|
|
6688
|
+
|
|
6689
|
+
:param StaffingPoolCreate body: (required)
|
|
6690
|
+
:param bool async_: Perform the request asynchronously
|
|
6691
|
+
:return: StaffingPool
|
|
6692
|
+
"""
|
|
6693
|
+
return self.staffing_pools_api.create_staffing_pool(body, **kwargs)
|
|
6694
|
+
|
|
6695
|
+
|
|
6696
|
+
def delete_staffing_pool(self, pool_id, **kwargs): # noqa: E501
|
|
6697
|
+
"""Delete
|
|
6698
|
+
|
|
6699
|
+
Delete a staffing pool by id.
|
|
6700
|
+
|
|
6701
|
+
:param str pool_id: (required)
|
|
6702
|
+
:param bool async_: Perform the request asynchronously
|
|
6703
|
+
:return: DeletedResult
|
|
6704
|
+
"""
|
|
6705
|
+
return self.staffing_pools_api.delete_staffing_pool(pool_id, **kwargs)
|
|
6706
|
+
|
|
6707
|
+
|
|
6708
|
+
def find_all_api_staffing_pools_get(self, **kwargs): # noqa: E501
|
|
6709
|
+
"""Find All
|
|
6710
|
+
|
|
6711
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
6712
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
6713
|
+
:param int limit: The maximum number of entries to return.
|
|
6714
|
+
:param int skip: The number of entries to skip.
|
|
6715
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
6716
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
6717
|
+
:param bool async_: Perform the request asynchronously
|
|
6718
|
+
:return: PageGenericStaffingPool
|
|
6719
|
+
"""
|
|
6720
|
+
return self.staffing_pools_api.find_all_api_staffing_pools_get(**kwargs)
|
|
6721
|
+
|
|
6722
|
+
|
|
6723
|
+
def get_staffing_pool(self, pool_id, **kwargs): # noqa: E501
|
|
6724
|
+
"""Get By Id
|
|
6725
|
+
|
|
6726
|
+
Get a staffing pool by id.
|
|
6727
|
+
|
|
6728
|
+
:param str pool_id: (required)
|
|
6729
|
+
:param bool async_: Perform the request asynchronously
|
|
6730
|
+
:return: StaffingPool
|
|
6731
|
+
"""
|
|
6732
|
+
return self.staffing_pools_api.get_staffing_pool(pool_id, **kwargs)
|
|
6733
|
+
|
|
6734
|
+
|
|
6735
|
+
def modify_staffing_pool(self, pool_id, body, **kwargs): # noqa: E501
|
|
6736
|
+
"""Modify
|
|
6737
|
+
|
|
6738
|
+
Modify a staffing pool.
|
|
6739
|
+
|
|
6740
|
+
:param str pool_id: (required)
|
|
6741
|
+
:param StaffingPoolModify body: (required)
|
|
6742
|
+
:param bool async_: Perform the request asynchronously
|
|
6743
|
+
:return: StaffingPool
|
|
6744
|
+
"""
|
|
6745
|
+
return self.staffing_pools_api.modify_staffing_pool(pool_id, body, **kwargs)
|
|
6746
|
+
|
|
6747
|
+
|
|
6748
|
+
def set_user_staffing_pools(self, user_id, body, **kwargs): # noqa: E501
|
|
6749
|
+
"""Set User Staffing Pools
|
|
6750
|
+
|
|
6751
|
+
Add a user to multiple staffing pools.
|
|
6752
|
+
|
|
6753
|
+
:param str user_id: (required)
|
|
6754
|
+
:param StaffingPoolList body: (required)
|
|
6755
|
+
:param bool async_: Perform the request asynchronously
|
|
6756
|
+
:return: None
|
|
6757
|
+
"""
|
|
6758
|
+
return self.staffing_pools_api.set_user_staffing_pools(user_id, body, **kwargs)
|
|
6759
|
+
|
|
6760
|
+
|
|
6496
6761
|
def add_subject(self, body, **kwargs): # noqa: E501
|
|
6497
6762
|
"""Create a new subject
|
|
6498
6763
|
|
|
@@ -7206,6 +7471,107 @@ class Flywheel:
|
|
|
7206
7471
|
return self.subjects_api.verify_master_subject_code(code, **kwargs)
|
|
7207
7472
|
|
|
7208
7473
|
|
|
7474
|
+
def assign_reader_task(self, task_id, body, **kwargs): # noqa: E501
|
|
7475
|
+
"""Assign
|
|
7476
|
+
|
|
7477
|
+
Assign a user or staffing pool to reader task.
|
|
7478
|
+
|
|
7479
|
+
:param str task_id: (required)
|
|
7480
|
+
:param TaskAssign body: (required)
|
|
7481
|
+
:param bool async_: Perform the request asynchronously
|
|
7482
|
+
:return: ReaderTask
|
|
7483
|
+
"""
|
|
7484
|
+
return self.tasks_api.assign_reader_task(task_id, body, **kwargs)
|
|
7485
|
+
|
|
7486
|
+
|
|
7487
|
+
def batch_create_reader_task(self, body, **kwargs): # noqa: E501
|
|
7488
|
+
"""Create Batch
|
|
7489
|
+
|
|
7490
|
+
Create a reader task.
|
|
7491
|
+
|
|
7492
|
+
:param ReaderBatchCreate body: (required)
|
|
7493
|
+
:param bool async_: Perform the request asynchronously
|
|
7494
|
+
:return: list[ReaderTask]
|
|
7495
|
+
"""
|
|
7496
|
+
return self.tasks_api.batch_create_reader_task(body, **kwargs)
|
|
7497
|
+
|
|
7498
|
+
|
|
7499
|
+
def complete_reader_task(self, task_id, body, **kwargs): # noqa: E501
|
|
7500
|
+
"""Complete
|
|
7501
|
+
|
|
7502
|
+
Complete a reader task.
|
|
7503
|
+
|
|
7504
|
+
:param str task_id: (required)
|
|
7505
|
+
:param TaskSubmission body: (required)
|
|
7506
|
+
:param bool async_: Perform the request asynchronously
|
|
7507
|
+
:return: ReaderTask
|
|
7508
|
+
"""
|
|
7509
|
+
return self.tasks_api.complete_reader_task(task_id, body, **kwargs)
|
|
7510
|
+
|
|
7511
|
+
|
|
7512
|
+
def create_reader_task(self, body, **kwargs): # noqa: E501
|
|
7513
|
+
"""Create
|
|
7514
|
+
|
|
7515
|
+
Create a reader task.
|
|
7516
|
+
|
|
7517
|
+
:param ReaderTaskCreate body: (required)
|
|
7518
|
+
:param bool async_: Perform the request asynchronously
|
|
7519
|
+
:return: ReaderTask
|
|
7520
|
+
"""
|
|
7521
|
+
return self.tasks_api.create_reader_task(body, **kwargs)
|
|
7522
|
+
|
|
7523
|
+
|
|
7524
|
+
def find_all_api_tasks_reader_get(self, **kwargs): # noqa: E501
|
|
7525
|
+
"""Find All
|
|
7526
|
+
|
|
7527
|
+
:param int limit:
|
|
7528
|
+
:param int skip:
|
|
7529
|
+
:param str filter:
|
|
7530
|
+
:param str sort:
|
|
7531
|
+
:param bool async_: Perform the request asynchronously
|
|
7532
|
+
:return: PageGenericReaderTaskOutput
|
|
7533
|
+
"""
|
|
7534
|
+
return self.tasks_api.find_all_api_tasks_reader_get(**kwargs)
|
|
7535
|
+
|
|
7536
|
+
|
|
7537
|
+
def get_facets_api_tasks_reader_facets_facet_field_get(self, facet_field, **kwargs): # noqa: E501
|
|
7538
|
+
"""Get Facets
|
|
7539
|
+
|
|
7540
|
+
Get facet counts for a specific field in reader tasks.
|
|
7541
|
+
|
|
7542
|
+
:param TaskFacet facet_field: (required)
|
|
7543
|
+
:param str filter:
|
|
7544
|
+
:param bool async_: Perform the request asynchronously
|
|
7545
|
+
:return: dict(str, int)
|
|
7546
|
+
"""
|
|
7547
|
+
return self.tasks_api.get_facets_api_tasks_reader_facets_facet_field_get(facet_field, **kwargs)
|
|
7548
|
+
|
|
7549
|
+
|
|
7550
|
+
def get_reader_task(self, task_id, **kwargs): # noqa: E501
|
|
7551
|
+
"""Get By Id
|
|
7552
|
+
|
|
7553
|
+
Get reader task by id.
|
|
7554
|
+
|
|
7555
|
+
:param str task_id: (required)
|
|
7556
|
+
:param bool async_: Perform the request asynchronously
|
|
7557
|
+
:return: ReaderTaskOutput
|
|
7558
|
+
"""
|
|
7559
|
+
return self.tasks_api.get_reader_task(task_id, **kwargs)
|
|
7560
|
+
|
|
7561
|
+
|
|
7562
|
+
def modify_reader_task(self, task_id, body, **kwargs): # noqa: E501
|
|
7563
|
+
"""Modify
|
|
7564
|
+
|
|
7565
|
+
Modify a reader task.
|
|
7566
|
+
|
|
7567
|
+
:param str task_id: (required)
|
|
7568
|
+
:param ReaderTaskModify body: (required)
|
|
7569
|
+
:param bool async_: Perform the request asynchronously
|
|
7570
|
+
:return: ReaderTask
|
|
7571
|
+
"""
|
|
7572
|
+
return self.tasks_api.modify_reader_task(task_id, body, **kwargs)
|
|
7573
|
+
|
|
7574
|
+
|
|
7209
7575
|
def fetch_tree(self, body, **kwargs): # noqa: E501
|
|
7210
7576
|
"""Query a portion of the flywheel hierarchy, returning only the requested fields.
|
|
7211
7577
|
|
flywheel/models/__init__.py
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Flywheel: API for data import, automated curation, image processing, machine learning workflows, and secure collaboration. # noqa: E501
|
|
8
8
|
|
|
9
|
-
OpenAPI spec version: 21.
|
|
9
|
+
OpenAPI spec version: 21.1.0
|
|
10
10
|
|
|
11
11
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
"""
|
|
@@ -50,6 +50,8 @@ from flywheel.models.analysis_update import AnalysisUpdate
|
|
|
50
50
|
from flywheel.models.api_key_input_with_optional_label import ApiKeyInputWithOptionalLabel
|
|
51
51
|
from flywheel.models.api_key_output import ApiKeyOutput
|
|
52
52
|
from flywheel.models.as_storage import AsStorage
|
|
53
|
+
from flywheel.models.assignee import Assignee
|
|
54
|
+
from flywheel.models.assignee_type import AssigneeType
|
|
53
55
|
from flywheel.models.audit_trail_report import AuditTrailReport
|
|
54
56
|
from flywheel.models.audit_trail_report_status import AuditTrailReportStatus
|
|
55
57
|
from flywheel.models.auth0_auth_out import Auth0AuthOut
|
|
@@ -64,6 +66,7 @@ from flywheel.models.base_aet import BaseAET
|
|
|
64
66
|
from flywheel.models.base_compute import BaseCompute
|
|
65
67
|
from flywheel.models.batch import Batch
|
|
66
68
|
from flywheel.models.batch_cancel_output import BatchCancelOutput
|
|
69
|
+
from flywheel.models.batch_create_filters import BatchCreateFilters
|
|
67
70
|
from flywheel.models.batch_job_analysis_input import BatchJobAnalysisInput
|
|
68
71
|
from flywheel.models.batch_jobs_proposal_input import BatchJobsProposalInput
|
|
69
72
|
from flywheel.models.batch_proposal import BatchProposal
|
|
@@ -149,12 +152,19 @@ from flywheel.models.context_input import ContextInput
|
|
|
149
152
|
from flywheel.models.copy_filter import CopyFilter
|
|
150
153
|
from flywheel.models.copy_status import CopyStatus
|
|
151
154
|
from flywheel.models.core_models_api_key_api_key_input import CoreModelsApiKeyApiKeyInput
|
|
155
|
+
from flywheel.models.core_models_audit_trail_create_report_input import CoreModelsAuditTrailCreateReportInput
|
|
156
|
+
from flywheel.models.core_models_audit_trail_modify_report_input import CoreModelsAuditTrailModifyReportInput
|
|
152
157
|
from flywheel.models.core_models_common_source import CoreModelsCommonSource
|
|
153
158
|
from flywheel.models.core_models_jobs_api_key_input import CoreModelsJobsApiKeyInput
|
|
154
|
-
from flywheel.models.
|
|
159
|
+
from flywheel.models.core_models_search_parent_type import CoreModelsSearchParentType
|
|
160
|
+
from flywheel.models.core_workflows_form_responses_models_form_parents import CoreWorkflowsFormResponsesModelsFormParents
|
|
161
|
+
from flywheel.models.core_workflows_form_responses_models_form_response_output import CoreWorkflowsFormResponsesModelsFormResponseOutput
|
|
162
|
+
from flywheel.models.core_workflows_reader_models_reader_task_parents import CoreWorkflowsReaderModelsReaderTaskParents
|
|
155
163
|
from flywheel.models.creds import Creds
|
|
156
164
|
from flywheel.models.curator import Curator
|
|
157
165
|
from flywheel.models.current_user_output import CurrentUserOutput
|
|
166
|
+
from flywheel.models.custom_field import CustomField
|
|
167
|
+
from flywheel.models.custom_form import CustomForm
|
|
158
168
|
from flywheel.models.daily_report_usage import DailyReportUsage
|
|
159
169
|
from flywheel.models.data_strategy import DataStrategy
|
|
160
170
|
from flywheel.models.data_view import DataView
|
|
@@ -201,6 +211,7 @@ from flywheel.models.download_strategy import DownloadStrategy
|
|
|
201
211
|
from flywheel.models.download_ticket import DownloadTicket
|
|
202
212
|
from flywheel.models.download_ticket_stub import DownloadTicketStub
|
|
203
213
|
from flywheel.models.download_ticket_with_summary import DownloadTicketWithSummary
|
|
214
|
+
from flywheel.models.e_signature import ESignature
|
|
204
215
|
from flywheel.models.edition import Edition
|
|
205
216
|
from flywheel.models.egress_device import EgressDevice
|
|
206
217
|
from flywheel.models.egress_device_page import EgressDevicePage
|
|
@@ -212,6 +223,7 @@ from flywheel.models.export_templates import ExportTemplates
|
|
|
212
223
|
from flywheel.models.features import Features
|
|
213
224
|
from flywheel.models.field_change import FieldChange
|
|
214
225
|
from flywheel.models.field_change_log_document import FieldChangeLogDocument
|
|
226
|
+
from flywheel.models.field_type import FieldType
|
|
215
227
|
from flywheel.models.file import File
|
|
216
228
|
from flywheel.models.file_classification_delta import FileClassificationDelta
|
|
217
229
|
from flywheel.models.file_container_type import FileContainerType
|
|
@@ -247,6 +259,8 @@ from flywheel.models.filter_view import FilterView
|
|
|
247
259
|
from flywheel.models.fixed_file_version_input import FixedFileVersionInput
|
|
248
260
|
from flywheel.models.fixed_input import FixedInput
|
|
249
261
|
from flywheel.models.form_definition import FormDefinition
|
|
262
|
+
from flywheel.models.form_response_base import FormResponseBase
|
|
263
|
+
from flywheel.models.form_response_create import FormResponseCreate
|
|
250
264
|
from flywheel.models.gcp_creds import GcpCreds
|
|
251
265
|
from flywheel.models.gcp_storage import GcpStorage
|
|
252
266
|
from flywheel.models.gear import Gear
|
|
@@ -402,6 +416,8 @@ from flywheel.models.legacy_api_key_output import LegacyApiKeyOutput
|
|
|
402
416
|
from flywheel.models.legacy_input import LegacyInput
|
|
403
417
|
from flywheel.models.legacy_usage_report import LegacyUsageReport
|
|
404
418
|
from flywheel.models.legacys_usage_project_entry import LegacysUsageProjectEntry
|
|
419
|
+
from flywheel.models.libs_workflows_models_parent_type import LibsWorkflowsModelsParentType
|
|
420
|
+
from flywheel.models.libs_workflows_models_task_status import LibsWorkflowsModelsTaskStatus
|
|
405
421
|
from flywheel.models.local_storage import LocalStorage
|
|
406
422
|
from flywheel.models.location import Location
|
|
407
423
|
from flywheel.models.locked import Locked
|
|
@@ -418,7 +434,6 @@ from flywheel.models.modality_input import ModalityInput
|
|
|
418
434
|
from flywheel.models.modality_modify import ModalityModify
|
|
419
435
|
from flywheel.models.modality_output import ModalityOutput
|
|
420
436
|
from flywheel.models.modified_result import ModifiedResult
|
|
421
|
-
from flywheel.models.modify_report_input import ModifyReportInput
|
|
422
437
|
from flywheel.models.modify_user_input import ModifyUserInput
|
|
423
438
|
from flywheel.models.move_conflict import MoveConflict
|
|
424
439
|
from flywheel.models.note import Note
|
|
@@ -435,7 +450,10 @@ from flywheel.models.packfile_removed_output import PackfileRemovedOutput
|
|
|
435
450
|
from flywheel.models.page import Page
|
|
436
451
|
from flywheel.models.page_generic_file_output import PageGenericFileOutput
|
|
437
452
|
from flywheel.models.page_generic_filter import PageGenericFilter
|
|
438
|
-
from flywheel.models.
|
|
453
|
+
from flywheel.models.page_generic_form_response_output import PageGenericFormResponseOutput
|
|
454
|
+
from flywheel.models.page_generic_protocol import PageGenericProtocol
|
|
455
|
+
from flywheel.models.page_generic_reader_task_output import PageGenericReaderTaskOutput
|
|
456
|
+
from flywheel.models.page_generic_staffing_pool import PageGenericStaffingPool
|
|
439
457
|
from flywheel.models.parsed_query_response import ParsedQueryResponse
|
|
440
458
|
from flywheel.models.permission_access_permission import PermissionAccessPermission
|
|
441
459
|
from flywheel.models.premade_jobs_batch_job_output import PremadeJobsBatchJobOutput
|
|
@@ -494,6 +512,11 @@ from flywheel.models.project_template_list_input import ProjectTemplateListInput
|
|
|
494
512
|
from flywheel.models.project_template_requirement import ProjectTemplateRequirement
|
|
495
513
|
from flywheel.models.project_template_session_template import ProjectTemplateSessionTemplate
|
|
496
514
|
from flywheel.models.project_upsert_origin import ProjectUpsertOrigin
|
|
515
|
+
from flywheel.models.protocol import Protocol
|
|
516
|
+
from flywheel.models.protocol_e_signature_config import ProtocolESignatureConfig
|
|
517
|
+
from flywheel.models.protocol_input import ProtocolInput
|
|
518
|
+
from flywheel.models.protocol_modify import ProtocolModify
|
|
519
|
+
from flywheel.models.protocol_status import ProtocolStatus
|
|
497
520
|
from flywheel.models.provider import Provider
|
|
498
521
|
from flywheel.models.provider_access_type import ProviderAccessType
|
|
499
522
|
from flywheel.models.provider_class import ProviderClass
|
|
@@ -502,6 +525,13 @@ from flywheel.models.provider_input import ProviderInput
|
|
|
502
525
|
from flywheel.models.provider_links import ProviderLinks
|
|
503
526
|
from flywheel.models.provider_type import ProviderType
|
|
504
527
|
from flywheel.models.providers import Providers
|
|
528
|
+
from flywheel.models.reader_batch_create import ReaderBatchCreate
|
|
529
|
+
from flywheel.models.reader_task import ReaderTask
|
|
530
|
+
from flywheel.models.reader_task_config import ReaderTaskConfig
|
|
531
|
+
from flywheel.models.reader_task_create import ReaderTaskCreate
|
|
532
|
+
from flywheel.models.reader_task_modify import ReaderTaskModify
|
|
533
|
+
from flywheel.models.reader_task_output import ReaderTaskOutput
|
|
534
|
+
from flywheel.models.reader_task_parent_details import ReaderTaskParentDetails
|
|
505
535
|
from flywheel.models.report_access_log_context import ReportAccessLogContext
|
|
506
536
|
from flywheel.models.report_access_log_context_entry import ReportAccessLogContextEntry
|
|
507
537
|
from flywheel.models.report_access_log_context_file_entry import ReportAccessLogContextFileEntry
|
|
@@ -583,6 +613,7 @@ from flywheel.models.search_status import SearchStatus
|
|
|
583
613
|
from flywheel.models.search_structured_search_query import SearchStructuredSearchQuery
|
|
584
614
|
from flywheel.models.search_subject_response import SearchSubjectResponse
|
|
585
615
|
from flywheel.models.search_suggestion import SearchSuggestion
|
|
616
|
+
from flywheel.models.select_item import SelectItem
|
|
586
617
|
from flywheel.models.server_state import ServerState
|
|
587
618
|
from flywheel.models.service_aet import ServiceAET
|
|
588
619
|
from flywheel.models.service_aet_input import ServiceAETInput
|
|
@@ -611,8 +642,13 @@ from flywheel.models.site_report import SiteReport
|
|
|
611
642
|
from flywheel.models.site_settings import SiteSettings
|
|
612
643
|
from flywheel.models.sort import Sort
|
|
613
644
|
from flywheel.models.stable_api_key_input import StableApiKeyInput
|
|
645
|
+
from flywheel.models.staffing_pool import StaffingPool
|
|
646
|
+
from flywheel.models.staffing_pool_create import StaffingPoolCreate
|
|
647
|
+
from flywheel.models.staffing_pool_list import StaffingPoolList
|
|
648
|
+
from flywheel.models.staffing_pool_modify import StaffingPoolModify
|
|
614
649
|
from flywheel.models.state import State
|
|
615
650
|
from flywheel.models.static_compute import StaticCompute
|
|
651
|
+
from flywheel.models.status_transitions import StatusTransitions
|
|
616
652
|
from flywheel.models.status_type import StatusType
|
|
617
653
|
from flywheel.models.status_value import StatusValue
|
|
618
654
|
from flywheel.models.storage_strategy import StorageStrategy
|
|
@@ -636,6 +672,12 @@ from flywheel.models.subject_upsert_input import SubjectUpsertInput
|
|
|
636
672
|
from flywheel.models.subject_upsert_output import SubjectUpsertOutput
|
|
637
673
|
from flywheel.models.sync_user_input import SyncUserInput
|
|
638
674
|
from flywheel.models.tag import Tag
|
|
675
|
+
from flywheel.models.task_assign import TaskAssign
|
|
676
|
+
from flywheel.models.task_facet import TaskFacet
|
|
677
|
+
from flywheel.models.task_parent_ref import TaskParentRef
|
|
678
|
+
from flywheel.models.task_parent_ref_input import TaskParentRefInput
|
|
679
|
+
from flywheel.models.task_priority import TaskPriority
|
|
680
|
+
from flywheel.models.task_submission import TaskSubmission
|
|
639
681
|
from flywheel.models.therapeutic_area import TherapeuticArea
|
|
640
682
|
from flywheel.models.transitions import Transitions
|
|
641
683
|
from flywheel.models.tree_container_request_spec import TreeContainerRequestSpec
|
|
@@ -667,6 +709,7 @@ from flywheel.models.user_output_id import UserOutputId
|
|
|
667
709
|
from flywheel.models.user_preferences import UserPreferences
|
|
668
710
|
from flywheel.models.user_wechat import UserWechat
|
|
669
711
|
from flywheel.models.validation_error import ValidationError
|
|
712
|
+
from flywheel.models.validation_rule import ValidationRule
|
|
670
713
|
from flywheel.models.version import Version
|
|
671
714
|
from flywheel.models.version_output import VersionOutput
|
|
672
715
|
from flywheel.models.view_id_output import ViewIdOutput
|
flywheel/models/action.py
CHANGED
|
@@ -82,6 +82,9 @@ class Action(str, enum.Enum):
|
|
|
82
82
|
TASKS_CREATE = "tasks_create"
|
|
83
83
|
TASKS_MODIFY = "tasks_modify"
|
|
84
84
|
TASKS_ASSIGN = "tasks_assign"
|
|
85
|
+
TASKS_REPORT_CREATE = "tasks_report_create"
|
|
86
|
+
TASKS_REPORT_DELETE = "tasks_report_delete"
|
|
87
|
+
TASKS_REPORT_READ = "tasks_report_read"
|
|
85
88
|
|
|
86
89
|
def __str__(self):
|
|
87
90
|
return self.value
|