flywheel-sdk 20.0.0rc0__py2.py3-none-any.whl → 20.1.0rc0__py2.py3-none-any.whl

flywheel/__init__.py

@@ -224,6 +224,7 @@ from flywheel.models.data_view_save_data_view_input import DataViewSaveDataViewI
 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.deleted_file import DeletedFile
 from flywheel.models.deleted_result import DeletedResult
 from flywheel.models.deprecated_action import DeprecatedAction

flywheel/api/acquisitions_api.py

@@ -1576,7 +1576,7 @@ class AcquisitionsApi(object):
             collection_formats=collection_formats)
 
     def delete_acquisitions_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple acquisitions by query
+        """*DEPRECATED* Delete multiple acquisitions by query
 
         Delete multiple acquisitions by query
         This method makes a synchronous HTTP request by default.
@@ -1603,7 +1603,7 @@ class AcquisitionsApi(object):
 
 
     def delete_acquisitions_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple acquisitions by query
+        """*DEPRECATED* Delete multiple acquisitions by query
 
         Delete multiple acquisitions by query
         This method makes a synchronous HTTP request by default.

flywheel/api/analyses_api.py

@@ -365,7 +365,7 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def delete_analyses_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple analyses by query
+        """*DEPRECATED* Delete multiple analyses by query
 
         Delete multiple analyses by query
         This method makes a synchronous HTTP request by default.
@@ -392,7 +392,7 @@ class AnalysesApi(object):
 
 
     def delete_analyses_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple analyses by query
+        """*DEPRECATED* Delete multiple analyses by query
 
         Delete multiple analyses by query
         This method makes a synchronous HTTP request by default.

flywheel/api/collections_api.py

@@ -1323,7 +1323,7 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def delete_collections_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple collections by query
+        """*DEPRECATED* Delete multiple collections by query
 
         Delete multiple collections by query
         This method makes a synchronous HTTP request by default.
@@ -1350,7 +1350,7 @@ class CollectionsApi(object):
 
 
     def delete_collections_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple collections by query
+        """*DEPRECATED* Delete multiple collections by query
 
         Delete multiple collections by query
         This method makes a synchronous HTTP request by default.

flywheel/api/dataexplorer_api.py

@@ -30,6 +30,115 @@ class DataexplorerApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
+    def delete_by_search(self, body, **kwargs):  # noqa: E501
+        """Delete containers by a search query
+
+        This method makes a synchronous HTTP request by default.
+
+        :param DeleteBySearchQuery body: (required)
+        :param ContainerDeleteReason delete_reason:
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.delete_by_search_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_by_search_with_http_info(body, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def delete_by_search_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete containers by a search query
+
+        This method makes a synchronous HTTP request by default.
+
+        :param DeleteBySearchQuery body: (required)
+        :param ContainerDeleteReason delete_reason:
+        :param bool async_: Perform the request asynchronously
+        :return: DeletedResult
+        """
+
+        all_params = ['body','delete_reason',]  # 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 delete_by_search" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `delete_by_search`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'delete_reason' in params:
+            query_params.append(('delete_reason', params['delete_reason']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'DeleteBySearchQuery'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.DeleteBySearchQuery.positional_to_model(params['body'])
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/dataexplorer/search', 'DELETE',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='DeletedResult',  # 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 delete_save_search(self, search_id, **kwargs):  # noqa: E501
         """Delete a saved search
 

flywheel/api/files_api.py

@@ -455,7 +455,7 @@ class FilesApi(object):
             collection_formats=collection_formats)
 
     def delete_files_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple files by query
+        """*DEPRECATED* Delete multiple files by query
 
         Delete multiple files by query
         This method makes a synchronous HTTP request by default.
@@ -482,7 +482,7 @@ class FilesApi(object):
 
 
     def delete_files_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple files by query
+        """*DEPRECATED* Delete multiple files by query
 
         Delete multiple files by query
         This method makes a synchronous HTTP request by default.

flywheel/api/groups_api.py

@@ -1344,7 +1344,7 @@ class GroupsApi(object):
             collection_formats=collection_formats)
 
     def delete_groups_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple groups by query
+        """*DEPRECATED* Delete multiple groups by query
 
         Delete multiple groups by query
         This method makes a synchronous HTTP request by default.
@@ -1371,7 +1371,7 @@ class GroupsApi(object):
 
 
     def delete_groups_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple groups by query
+        """*DEPRECATED* Delete multiple groups by query
 
         Delete multiple groups by query
         This method makes a synchronous HTTP request by default.

flywheel/api/jobs_api.py

@@ -687,6 +687,217 @@ class JobsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def engine_complete_job(self, job_id, body, **kwargs):  # noqa: E501
+        """Complete a job, with information.
+
+        This method makes a synchronous HTTP request by default.
+
+        :param str job_id: (required)
+        :param JobComplete body: (required)
+        :param str job_ticket_id: ticket id for job completion
+        :param bool async_: Perform the request asynchronously
+        :return: None
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.engine_complete_job_with_http_info(job_id, body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.engine_complete_job_with_http_info(job_id, body, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def engine_complete_job_with_http_info(self, job_id, body, **kwargs):  # noqa: E501
+        """Complete a job, with information.
+
+        This method makes a synchronous HTTP request by default.
+
+        :param str job_id: (required)
+        :param JobComplete body: (required)
+        :param str job_ticket_id: ticket id for job completion
+        :param bool async_: Perform the request asynchronously
+        :return: None
+        """
+
+        all_params = ['job_id','body','job_ticket_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 engine_complete_job" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'job_id' is set
+        if ('job_id' not in params or
+                params['job_id'] is None):
+            raise ValueError("Missing the required parameter `job_id` when calling `engine_complete_job`")  # noqa: E501
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `engine_complete_job`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'job_id' in params:
+            path_params['job_id'] = params['job_id']  # noqa: E501
+
+        query_params = []
+        if 'job_ticket_id' in params:
+            query_params.append(('job_ticket_id', params['job_ticket_id']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'JobComplete'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.JobComplete.positional_to_model(params['body'])
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/jobs/{job_id}/complete', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # 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 engine_prepare_complete_job(self, job_id, **kwargs):  # noqa: E501
+        """Create a ticket for completing a job, with id and status.
+
+        This method makes a synchronous HTTP request by default.
+
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobTicketOutput
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.engine_prepare_complete_job_with_http_info(job_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.engine_prepare_complete_job_with_http_info(job_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def engine_prepare_complete_job_with_http_info(self, job_id, **kwargs):  # noqa: E501
+        """Create a ticket for completing a job, with id and status.
+
+        This method makes a synchronous HTTP request by default.
+
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobTicketOutput
+        """
+
+        all_params = ['job_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 engine_prepare_complete_job" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'job_id' is set
+        if ('job_id' not in params or
+                params['job_id'] is None):
+            raise ValueError("Missing the required parameter `job_id` when calling `engine_prepare_complete_job`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'job_id' in params:
+            path_params['job_id'] = params['job_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(
+            '/jobs/{job_id}/prepare-complete', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='JobTicketOutput',  # 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_all_jobs(self, **kwargs):  # noqa: E501
         """Return all jobs
 

flywheel/api/projects_api.py

@@ -2037,7 +2037,7 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def delete_projects_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple projects by query
+        """*DEPRECATED* Delete multiple projects by query
 
         Delete multiple projects by query
         This method makes a synchronous HTTP request by default.
@@ -2064,7 +2064,7 @@ class ProjectsApi(object):
 
 
     def delete_projects_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple projects by query
+        """*DEPRECATED* Delete multiple projects by query
 
         Delete multiple projects by query
         This method makes a synchronous HTTP request by default.

flywheel/api/resolve_api.py

@@ -39,6 +39,7 @@ class ResolveApi(object):
         :param ResolveInput body: (required)
         :param bool full_tree:
         :param bool exhaustive:
+        :param bool include_all_info: Include all info in returned objects
         :param bool async_: Perform the request asynchronously
         :return: ResolverNode
         """
@@ -67,11 +68,12 @@ class ResolveApi(object):
         :param ResolveInput body: (required)
         :param bool full_tree:
         :param bool exhaustive:
+        :param bool include_all_info: Include all info in returned objects
         :param bool async_: Perform the request asynchronously
         :return: ResolverNode
         """
 
-        all_params = ['body','full_tree','exhaustive',]  # noqa: E501
+        all_params = ['body','full_tree','exhaustive','include_all_info',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -101,6 +103,8 @@ class ResolveApi(object):
             query_params.append(('full_tree', params['full_tree']))  # noqa: E501
         if 'exhaustive' in params:
             query_params.append(('exhaustive', params['exhaustive']))  # noqa: E501
+        if 'include_all_info' in params:
+            query_params.append(('include_all_info', params['include_all_info']))  # noqa: E501
 
         header_params = {}
 
@@ -155,6 +159,7 @@ class ResolveApi(object):
         :param bool full_tree: Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...)
         :param bool minattr: Return only minimal attributes
         :param bool exhaustive: Set to return a complete list regardless of permissions
+        :param bool include_all_info: Include all info in returned objects
         :param bool async_: Perform the request asynchronously
         :return: ResolveOutput
         """
@@ -184,11 +189,12 @@ class ResolveApi(object):
         :param bool full_tree: Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...)
         :param bool minattr: Return only minimal attributes
         :param bool exhaustive: Set to return a complete list regardless of permissions
+        :param bool include_all_info: Include all info in returned objects
         :param bool async_: Perform the request asynchronously
         :return: ResolveOutput
         """
 
-        all_params = ['body','full_tree','minattr','exhaustive',]  # noqa: E501
+        all_params = ['body','full_tree','minattr','exhaustive','include_all_info',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -220,6 +226,8 @@ class ResolveApi(object):
             query_params.append(('minattr', params['minattr']))  # noqa: E501
         if 'exhaustive' in params:
             query_params.append(('exhaustive', params['exhaustive']))  # noqa: E501
+        if 'include_all_info' in params:
+            query_params.append(('include_all_info', params['include_all_info']))  # noqa: E501
 
         header_params = {}
 

flywheel/api/sessions_api.py

@@ -1576,7 +1576,7 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def delete_sessions_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple sessions by query
+        """*DEPRECATED* Delete multiple sessions by query
 
         Delete multiple sessions by query
         This method makes a synchronous HTTP request by default.
@@ -1603,7 +1603,7 @@ class SessionsApi(object):
 
 
     def delete_sessions_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple sessions by query
+        """*DEPRECATED* Delete multiple sessions by query
 
         Delete multiple sessions by query
         This method makes a synchronous HTTP request by default.

flywheel/api/subjects_api.py

@@ -1683,7 +1683,7 @@ class SubjectsApi(object):
             collection_formats=collection_formats)
 
     def delete_subjects_by_query(self, body, **kwargs):  # noqa: E501
-        """Delete multiple subjects by query
+        """*DEPRECATED* Delete multiple subjects by query
 
         Delete multiple subjects by query
         This method makes a synchronous HTTP request by default.
@@ -1710,7 +1710,7 @@ class SubjectsApi(object):
 
 
     def delete_subjects_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
-        """Delete multiple subjects by query
+        """*DEPRECATED* Delete multiple subjects by query
 
         Delete multiple subjects by query
         This method makes a synchronous HTTP request by default.

flywheel/api_client.py

@@ -84,7 +84,7 @@ class ApiClient(object):
         self.default_query_params = []
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/20.0.0-rc0/python'
+        self.user_agent = 'Swagger-Codegen/20.1.0-rc0/python'
         self.last_response = None
         self._version_check_fn = None
         self._context = context

flywheel/configuration.py

@@ -252,6 +252,6 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 20.0.0-rc0\n"\
-               "SDK Package Version: 20.0.0-rc0".\
+               "Version of the API: 20.1.0-rc0\n"\
+               "SDK Package Version: 20.1.0-rc0".\
                format(env=sys.platform, pyversion=sys.version)