flywheel-sdk 19.2.0rc0__py2.py3-none-any.whl → 19.3.0rc0__py2.py3-none-any.whl

flywheel/api/analyses_api.py

@@ -31,13 +31,13 @@ class AnalysesApi(object):
         self.api_client = api_client
 
     def add_analysis_note(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to analysis.
+        """Add a note to a(n) analysis.
 
-        Add a note to analysis.
+        Add a note to a(n) analysis.
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param NoteInput body: note content (required)
+        :param str container_id: (required)
+        :param NoteInput body: (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -58,13 +58,13 @@ class AnalysesApi(object):
 
 
     def add_analysis_note_with_http_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to analysis.
+        """Add a note to a(n) analysis.
 
-        Add a note to analysis.
+        Add a note to a(n) analysis.
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param NoteInput body: note content (required)
+        :param str container_id: (required)
+        :param NoteInput body: (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -146,7 +146,7 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def add_analysis_tag(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a tag to analysis.
+        """Add a tag to a(n) analysis.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -173,7 +173,7 @@ class AnalysesApi(object):
 
 
     def add_analysis_tag_with_http_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a tag to analysis.
+        """Add a tag to a(n) analysis.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -260,6 +260,110 @@ class AnalysesApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_analyses_by_ids(self, body, **kwargs):  # noqa: E501
+        """Delete multiple analyses by ID list
+
+        Delete analyses by id  Args:     analysis_ids: The ids of the analysis     auth_session: The auth session     delete_reason: The reason for deletion (required when audit-trail is enabled)
+        This method makes a synchronous HTTP request by default.
+
+        :param list[str] body: List of IDs to delete (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_analyses_by_ids_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_analyses_by_ids_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_analyses_by_ids_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete multiple analyses by ID list
+
+        Delete analyses by id  Args:     analysis_ids: The ids of the analysis     auth_session: The auth session     delete_reason: The reason for deletion (required when audit-trail is enabled)
+        This method makes a synchronous HTTP request by default.
+
+        :param list[str] body: List of IDs to delete (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_analyses_by_ids" % 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_analyses_by_ids`")  # 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:
+            body_params = 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(
+            '/analyses', '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_analysis(self, analysis_id, **kwargs):  # noqa: E501
         """Delete an analysis
 
@@ -361,15 +465,15 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def delete_analysis_note(self, container_id, note_id, **kwargs):  # noqa: E501
-        """Remove a note from analysis
+        """Remove a note from a(n) analysis
 
-        Remove a note from analysis
+        Remove a note from a(n) analysis
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str note_id: 24-char hex note id (required)
+        :param str container_id: (required)
+        :param str note_id: (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -388,15 +492,15 @@ class AnalysesApi(object):
 
 
     def delete_analysis_note_with_http_info(self, container_id, note_id, **kwargs):  # noqa: E501
-        """Remove a note from analysis
+        """Remove a note from a(n) analysis
 
-        Remove a note from analysis
+        Remove a note from a(n) analysis
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str note_id: 24-char hex note id (required)
+        :param str container_id: (required)
+        :param str note_id: (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: DeletedResult
         """
 
         all_params = ['container_id','note_id',]  # noqa: E501
@@ -455,7 +559,7 @@ class AnalysesApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type=None,  # noqa: E501
+            response_type='DeletedResult',  # noqa: E501
             auth_settings=auth_settings,
             async_=params.get('async_'),
             _return_http_data_only=params.get('_return_http_data_only'),
@@ -473,7 +577,7 @@ class AnalysesApi(object):
         :param str container_id: (required)
         :param str value: The tag to interact with (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -500,7 +604,7 @@ class AnalysesApi(object):
         :param str container_id: (required)
         :param str value: The tag to interact with (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: DeletedResult
         """
 
         all_params = ['container_id','value',]  # noqa: E501
@@ -559,7 +663,7 @@ class AnalysesApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type=None,  # noqa: E501
+            response_type='DeletedResult',  # noqa: E501
             auth_settings=auth_settings,
             async_=params.get('async_'),
             _return_http_data_only=params.get('_return_http_data_only'),
@@ -959,7 +1063,7 @@ class AnalysesApi(object):
         Get Output File
         This method makes a synchronous HTTP request by default.
 
-        :param str analysis_id: 24-character hex ID (required)
+        :param str analysis_id: Container ID (required)
         :param str filename: output file name (required)
         :param bool info: get file info only
         :param str member: get zipfile member
@@ -991,7 +1095,7 @@ class AnalysesApi(object):
         Get Output File
         This method makes a synchronous HTTP request by default.
 
-        :param str analysis_id: 24-character hex ID (required)
+        :param str analysis_id: Container ID (required)
         :param str filename: output file name (required)
         :param bool info: get file info only
         :param str member: get zipfile member
@@ -1084,7 +1188,7 @@ class AnalysesApi(object):
         Get Output File
         This method makes a synchronous HTTP request by default.
 
-        :param str analysis_id: 24-character hex ID (required)
+        :param str analysis_id: Container ID (required)
         :param str filename: output file name (required)
         :param str ticket: 24-char hex ticket id
         :param bool info: get file info only
@@ -1117,7 +1221,7 @@ class AnalysesApi(object):
         Get Output File
         This method makes a synchronous HTTP request by default.
 
-        :param str analysis_id: 24-character hex ID (required)
+        :param str analysis_id: Container ID (required)
         :param str filename: output file name (required)
         :param str ticket: 24-char hex ticket id
         :param bool info: get file info only
@@ -1215,7 +1319,7 @@ class AnalysesApi(object):
         Get Output File
         This method makes a synchronous HTTP request by default.
 
-        :param str analysis_id: 24-character hex ID (required)
+        :param str analysis_id: Container ID (required)
         :param str filename: output file name (required)
         :param str ticket: 24-char hex ticket id
         :param bool info: get file info only
@@ -1248,7 +1352,7 @@ class AnalysesApi(object):
         Get Output File
         This method makes a synchronous HTTP request by default.
 
-        :param str analysis_id: 24-character hex ID (required)
+        :param str analysis_id: Container ID (required)
         :param str filename: output file name (required)
         :param str ticket: 24-char hex ticket id
         :param bool info: get file info only
@@ -1687,8 +1791,8 @@ class AnalysesApi(object):
         Get info for a particular file.
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str filename: The name of the file (required)
+        :param str container_id: Container Id (required)
+        :param str filename: (required)
         :param bool async_: Perform the request asynchronously
         :return: FileOutput
         """
@@ -1714,8 +1818,8 @@ class AnalysesApi(object):
         Get info for a particular file.
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str filename: The name of the file (required)
+        :param str container_id: Container Id (required)
+        :param str filename: (required)
         :param bool async_: Perform the request asynchronously
         :return: FileOutput
         """
@@ -1786,13 +1890,13 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def get_analysis_note(self, container_id, note_id, **kwargs):  # noqa: E501
-        """Get a note on analysis.
+        """Get a note of a(n) analysis.
 
-        Get a note on analysis
+        Get a note of a(n) analysis
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str note_id: 24-char hex note id (required)
+        :param str container_id: (required)
+        :param str note_id: (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -1813,13 +1917,13 @@ class AnalysesApi(object):
 
 
     def get_analysis_note_with_http_info(self, container_id, note_id, **kwargs):  # noqa: E501
-        """Get a note on analysis.
+        """Get a note of a(n) analysis.
 
-        Get a note on analysis
+        Get a note of a(n) analysis
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str note_id: 24-char hex note id (required)
+        :param str container_id: (required)
+        :param str note_id: (required)
         :param bool async_: Perform the request asynchronously
         :return: Note
         """
@@ -2109,9 +2213,9 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def modify_analysis_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Update or replace info for a analysis.
+        """Update or replace info for a(n) analysis.
 
-        Update or replace info for a analysis.
+        Update or replace info for a(n) analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -2136,9 +2240,9 @@ class AnalysesApi(object):
 
 
     def modify_analysis_info_with_http_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Update or replace info for a analysis.
+        """Update or replace info for a(n) analysis.
 
-        Update or replace info for a analysis.
+        Update or replace info for a(n) analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -2224,14 +2328,14 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def modify_analysis_note(self, container_id, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on analysis.
+        """Update a note of a(n) analysis.
 
-        Update a note on analysis
+        Update a note of a(n) analysis
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str note_id: 24-char hex note id (required)
-        :param NoteInput body: note content (required)
+        :param str container_id: (required)
+        :param str note_id: (required)
+        :param NoteInput body: (required)
         :param bool async_: Perform the request asynchronously
         :return: int
         """
@@ -2252,14 +2356,14 @@ class AnalysesApi(object):
 
 
     def modify_analysis_note_with_http_info(self, container_id, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on analysis.
+        """Update a note of a(n) analysis.
 
-        Update a note on analysis
+        Update a note of a(n) analysis
         This method makes a synchronous HTTP request by default.
 
-        :param str container_id: Container id (required)
-        :param str note_id: 24-char hex note id (required)
-        :param NoteInput body: note content (required)
+        :param str container_id: (required)
+        :param str note_id: (required)
+        :param NoteInput body: (required)
         :param bool async_: Perform the request asynchronously
         :return: int
         """
@@ -2470,9 +2574,9 @@ class AnalysesApi(object):
             collection_formats=collection_formats)
 
     def upload_output_to_analysis(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload an output file to analysis.
+        """Upload an output file to an analysis.
 
-        Upload an output file to analysis
+        Upload an output file to an analysis
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -2504,9 +2608,9 @@ class AnalysesApi(object):
 
 
     def upload_output_to_analysis_with_http_info(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload an output file to analysis.
+        """Upload an output file to an analysis.
 
-        Upload an output file to analysis
+        Upload an output file to an analysis
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)