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

flywheel/__init__.py

@@ -3,13 +3,6 @@
 # flake8: noqa
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -243,6 +236,7 @@ from flywheel.models.data_view_zip_filter_spec import DataViewZipFilterSpec
 from flywheel.models.default_flywheel_role import DefaultFlywheelRole
 from flywheel.models.deid_log_skip_reason import DeidLogSkipReason
 from flywheel.models.delete_by_search_query import DeleteBySearchQuery
+from flywheel.models.delete_status import DeleteStatus
 from flywheel.models.deleted_file import DeletedFile
 from flywheel.models.deleted_result import DeletedResult
 from flywheel.models.deprecated_action import DeprecatedAction
@@ -363,7 +357,6 @@ from flywheel.models.gear_series_update import GearSeriesUpdate
 from flywheel.models.gear_suggestion_output import GearSuggestionOutput
 from flywheel.models.gear_ticket import GearTicket
 from flywheel.models.gear_ticket_output import GearTicketOutput
-from flywheel.models.google_auth_out import GoogleAuthOut
 from flywheel.models.graph_filter import GraphFilter
 from flywheel.models.group import Group
 from flywheel.models.group_by import GroupBy
@@ -476,6 +469,7 @@ from flywheel.models.legacy_api_key_output import LegacyApiKeyOutput
 from flywheel.models.legacy_input import LegacyInput
 from flywheel.models.legacy_usage_report import LegacyUsageReport
 from flywheel.models.legacys_usage_project_entry import LegacysUsageProjectEntry
+from flywheel.models.libs_viewer_config_models_viewer_config import LibsViewerConfigModelsViewerConfig
 from flywheel.models.libs_workflows_models_parent_type import LibsWorkflowsModelsParentType
 from flywheel.models.libs_workflows_models_task_status import LibsWorkflowsModelsTaskStatus
 from flywheel.models.local_storage import LocalStorage
@@ -489,6 +483,8 @@ from flywheel.models.master_subject_code_dob_input import MasterSubjectCodeDobIn
 from flywheel.models.master_subject_code_input import MasterSubjectCodeInput
 from flywheel.models.master_subject_code_output import MasterSubjectCodeOutput
 from flywheel.models.matched_acquisition_output import MatchedAcquisitionOutput
+from flywheel.models.measurement_config import MeasurementConfig
+from flywheel.models.measurement_item_config import MeasurementItemConfig
 from flywheel.models.modality import Modality
 from flywheel.models.modality_input import ModalityInput
 from flywheel.models.modality_modify import ModalityModify
@@ -532,6 +528,8 @@ from flywheel.models.project_container_output import ProjectContainerOutput
 from flywheel.models.project_copy_input import ProjectCopyInput
 from flywheel.models.project_copy_output import ProjectCopyOutput
 from flywheel.models.project_counters import ProjectCounters
+from flywheel.models.project_delete_status_output import ProjectDeleteStatusOutput
+from flywheel.models.project_group_info import ProjectGroupInfo
 from flywheel.models.project_hierarchy_input import ProjectHierarchyInput
 from flywheel.models.project_hierarchy_output import ProjectHierarchyOutput
 from flywheel.models.project_hierarchy_upsert_input import ProjectHierarchyUpsertInput
@@ -739,6 +737,7 @@ from flywheel.models.task_parent_ref_input import TaskParentRefInput
 from flywheel.models.task_priority import TaskPriority
 from flywheel.models.task_submission import TaskSubmission
 from flywheel.models.therapeutic_area import TherapeuticArea
+from flywheel.models.toolbar_config import ToolbarConfig
 from flywheel.models.transitions import Transitions
 from flywheel.models.tree_container_request_spec import TreeContainerRequestSpec
 from flywheel.models.tree_graph import TreeGraph

flywheel/api/acquisitions_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/analyses_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/audit_trail_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/auth_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/batch_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/bulk_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/change_log_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/collections_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/config_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/container_tasks_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/container_type_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/containers_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/custom_filters_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/data_view_executions_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/dataexplorer_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -1072,7 +1065,7 @@ class DataexplorerApi(object):
 
         :param SearchQuery body: (required)
         :param bool simple: Unwrap result documents into a list.
-        :param int size: The maximum number of results to return.
+        :param int size: The maximum number of results to return. DEPRECATED: use body parameter instead.
         :param bool facets: Include additional statistics about the search results. Internal use only.
         :param bool csv: Format the response as a CSV file
         :param bool async_: Perform the request asynchronously
@@ -1101,7 +1094,7 @@ class DataexplorerApi(object):
 
         :param SearchQuery body: (required)
         :param bool simple: Unwrap result documents into a list.
-        :param int size: The maximum number of results to return.
+        :param int size: The maximum number of results to return. DEPRECATED: use body parameter instead.
         :param bool facets: Include additional statistics about the search results. Internal use only.
         :param bool csv: Format the response as a CSV file
         :param bool async_: Perform the request asynchronously
@@ -1141,8 +1134,6 @@ class DataexplorerApi(object):
             query_params.append(('simple', 'true'))
         if 'size' in params:
             query_params.append(('size', params['size']))  # noqa: E501
-        else:
-            query_params.append(('size', '100'))
         if 'facets' in params:
             query_params.append(('facets', params['facets']))  # noqa: E501
         if 'csv' in params:

flywheel/api/devices_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/dimse_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/download_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/files_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/form_responses_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/gears_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/groups_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/jobs_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/jupyterlab_servers_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/modalities_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/packfiles_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/projects_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -1090,11 +1083,12 @@ class ProjectsApi(object):
     def delete_project(self, project_id, **kwargs):  # noqa: E501
         """Delete a project
 
-        Only site admins and users with \"admin\" project permissions may delete a project
+        Delete a project.  Only site admins and users with \"admin\" project permissions may delete a project.  When background=true, the deletion is performed asynchronously in the background (returns 202). Use GET /{project_id}/delete-status to check the deletion progress.  When background=false, the deletion is performed synchronously (returns 200).
         This method makes a synchronous HTTP request by default.
 
         :param str project_id: (required)
         :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
+        :param bool background: Perform deletion in the background
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
         """
@@ -1117,16 +1111,17 @@ class ProjectsApi(object):
     def delete_project_with_http_info(self, project_id, **kwargs):  # noqa: E501
         """Delete a project
 
-        Only site admins and users with \"admin\" project permissions may delete a project
+        Delete a project.  Only site admins and users with \"admin\" project permissions may delete a project.  When background=true, the deletion is performed asynchronously in the background (returns 202). Use GET /{project_id}/delete-status to check the deletion progress.  When background=false, the deletion is performed synchronously (returns 200).
         This method makes a synchronous HTTP request by default.
 
         :param str project_id: (required)
         :param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
+        :param bool background: Perform deletion in the background
         :param bool async_: Perform the request asynchronously
         :return: DeletedResult
         """
 
-        all_params = ['project_id','delete_reason',]  # noqa: E501
+        all_params = ['project_id','delete_reason','background',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -1157,6 +1152,8 @@ class ProjectsApi(object):
         query_params = []
         if 'delete_reason' in params:
             query_params.append(('delete_reason', params['delete_reason']))  # noqa: E501
+        if 'background' in params:
+            query_params.append(('background', params['background']))  # noqa: E501
 
         header_params = {}
 
@@ -4258,6 +4255,103 @@ class ProjectsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def get_project_delete_status(self, project_id, **kwargs):  # noqa: E501
+        """Get project deletion status
+
+        Get the status of a project deletion running in the background.  Returns the current deletion status and any failure reason if the deletion failed.
+        This method makes a synchronous HTTP request by default.
+
+        :param str project_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ProjectDeleteStatusOutput
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_project_delete_status_with_http_info(project_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_project_delete_status_with_http_info(project_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def get_project_delete_status_with_http_info(self, project_id, **kwargs):  # noqa: E501
+        """Get project deletion status
+
+        Get the status of a project deletion running in the background.  Returns the current deletion status and any failure reason if the deletion failed.
+        This method makes a synchronous HTTP request by default.
+
+        :param str project_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ProjectDeleteStatusOutput
+        """
+
+        all_params = ['project_id',]  # noqa: E501
+        all_params.append('async_')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_request_out')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_project_delete_status" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'project_id' is set
+        if ('project_id' not in params or
+                params['project_id'] is None):
+            raise ValueError("Missing the required parameter `project_id` when calling `get_project_delete_status`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'project_id' in params:
+            path_params['project_id'] = params['project_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/projects/{project_id}/delete-status', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ProjectDeleteStatusOutput',  # noqa: E501
+            auth_settings=auth_settings,
+            async_=params.get('async_'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            _request_out=params.get('_request_out'),
+            collection_formats=collection_formats)
+
     def get_project_file_info(self, cid, filename, **kwargs):  # noqa: E501
         """Get info for a particular file.
 

flywheel/api/protocols_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/api/reports_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """