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

flywheel/api/sessions_api.py

@@ -263,8 +263,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def add_session_analysis_note(self, container_id, analysis_id, body, **kwargs):  # noqa: E501
-        """Add a note to session analysis.
+        """Add a note to a(n) session analysis.
 
+        Add a note to a(n) session analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: 24-char hex id (required)
@@ -290,8 +291,9 @@ class SessionsApi(object):
 
 
     def add_session_analysis_note_with_http_info(self, container_id, analysis_id, body, **kwargs):  # noqa: E501
-        """Add a note to session analysis.
+        """Add a note to a(n) session analysis.
 
+        Add a note to a(n) session analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: 24-char hex id (required)
@@ -384,8 +386,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def add_session_note(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to session.
+        """Add a note to a(n) session.
 
+        Add a note to a(n) session.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -410,8 +413,9 @@ class SessionsApi(object):
 
 
     def add_session_note_with_http_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to session.
+        """Add a note to a(n) session.
 
+        Add a note to a(n) session.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -497,7 +501,7 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def add_session_tag(self, cid, body, **kwargs):  # noqa: E501
-        """Add a tag to session.
+        """Add a tag to a(n) session.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -524,7 +528,7 @@ class SessionsApi(object):
 
 
     def add_session_tag_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Add a tag to session.
+        """Add a tag to a(n) session.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -612,9 +616,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def add_session_tags(self, cid, body, **kwargs):  # noqa: E501
-        """Add multiple tags to session
+        """Add multiple tags to a(n) session
 
-        Add multiple tags to session
+        Add multiple tags to a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -639,9 +643,9 @@ class SessionsApi(object):
 
 
     def add_session_tags_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Add multiple tags to session
+        """Add multiple tags to a(n) session
 
-        Add multiple tags to session
+        Add multiple tags to a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -820,7 +824,7 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def delete_session_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
-        """Delete an anaylsis
+        """Delete an analysis
 
         Delete an analysis for a container.
         This method makes a synchronous HTTP request by default.
@@ -848,7 +852,7 @@ class SessionsApi(object):
 
 
     def delete_session_analysis_with_http_info(self, cid, analysis_id, **kwargs):  # noqa: E501
-        """Delete an anaylsis
+        """Delete an analysis
 
         Delete an analysis for a container.
         This method makes a synchronous HTTP request by default.
@@ -928,9 +932,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def delete_session_analysis_note(self, cid, analysis_id, note_id, **kwargs):  # noqa: E501
-        """Remove a note from session analysis.
+        """Remove a note from a(n) session analysis.
 
-        Remove a note from session analysis.
+        Remove a note from a(n) session analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: 24-char hex id (required)
@@ -956,9 +960,9 @@ class SessionsApi(object):
 
 
     def delete_session_analysis_note_with_http_info(self, cid, analysis_id, note_id, **kwargs):  # noqa: E501
-        """Remove a note from session analysis.
+        """Remove a note from a(n) session analysis.
 
-        Remove a note from session analysis.
+        Remove a note from a(n) session analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: 24-char hex id (required)
@@ -1152,9 +1156,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def delete_session_note(self, cid, note_id, **kwargs):  # noqa: E501
-        """Remove a note from session
+        """Remove a note from a(n) session
 
-        Remove a note from session
+        Remove a note from a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1179,9 +1183,9 @@ class SessionsApi(object):
 
 
     def delete_session_note_with_http_info(self, cid, note_id, **kwargs):  # noqa: E501
-        """Remove a note from session
+        """Remove a note from a(n) session
 
-        Remove a note from session
+        Remove a note from a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1360,9 +1364,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def delete_session_tags(self, cid, body, **kwargs):  # noqa: E501
-        """Delete multiple tags from session
+        """Delete multiple tags from a(n) session
 
-        Delete multiple tags from session
+        Delete multiple tags from a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1387,9 +1391,9 @@ class SessionsApi(object):
 
 
     def delete_session_tags_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Delete multiple tags from session
+        """Delete multiple tags from a(n) session
 
-        Delete multiple tags from session
+        Delete multiple tags from a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1467,13 +1471,117 @@ class SessionsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_sessions_by_ids(self, body, **kwargs):  # noqa: E501
+        """Delete multiple sessions by ID list
+
+        Delete multiple sessions by ID list
+        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_sessions_by_ids_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_sessions_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_sessions_by_ids_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete multiple sessions by ID list
+
+        Delete multiple sessions by ID list
+        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_sessions_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_sessions_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(
+            '/sessions', '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 download_file_from_session(self, session_id, file_name, dest_file, **kwargs):  # noqa: E501
         """Download a file.
 
         Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id.  To generate a ticket:   - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id.   - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required.  When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.  When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
         This method makes a synchronous HTTP request by default.
 
-        :param str session_id: 24-char hex id (required)
+        :param str session_id: 24-character hex ID (required)
         :param str file_name: output file name (required)
         :param bool info: If the file is a zipfile, return a json response of zipfile member information
         :param str member: The filename of a zipfile member to download rather than the entire file
@@ -1507,7 +1615,7 @@ class SessionsApi(object):
         Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id.  To generate a ticket:   - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id.   - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required.  When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.  When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
         This method makes a synchronous HTTP request by default.
 
-        :param str session_id: 24-char hex id (required)
+        :param str session_id: 24-character hex ID (required)
         :param str file_name: output file name (required)
         :param bool info: If the file is a zipfile, return a json response of zipfile member information
         :param str member: The filename of a zipfile member to download rather than the entire file
@@ -1606,7 +1714,7 @@ class SessionsApi(object):
         Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id.  To generate a ticket:   - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id.   - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required.  When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.  When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
         This method makes a synchronous HTTP request by default.
 
-        :param str session_id: 24-char hex id (required)
+        :param str session_id: 24-character hex ID (required)
         :param str file_name: output file name (required)
         :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
         :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -1641,7 +1749,7 @@ class SessionsApi(object):
         Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id.  To generate a ticket:   - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id.   - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required.  When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.  When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
         This method makes a synchronous HTTP request by default.
 
-        :param str session_id: 24-char hex id (required)
+        :param str session_id: 24-character hex ID (required)
         :param str file_name: output file name (required)
         :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
         :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -1745,7 +1853,7 @@ class SessionsApi(object):
         Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id.  To generate a ticket:   - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id.   - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required.  When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.  When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
         This method makes a synchronous HTTP request by default.
 
-        :param str session_id: 24-char hex id (required)
+        :param str session_id: 24-character hex ID (required)
         :param str file_name: output file name (required)
         :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
         :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -1780,7 +1888,7 @@ class SessionsApi(object):
         Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id.  To generate a ticket:   - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id.   - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required.  When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported.  When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
         This method makes a synchronous HTTP request by default.
 
-        :param str session_id: 24-char hex id (required)
+        :param str session_id: 24-character hex ID (required)
         :param str file_name: output file name (required)
         :param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
         :param bool info: If the file is a zipfile, return a json response of zipfile member information
@@ -3074,7 +3182,7 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_analyses(self, cid, **kwargs):  # noqa: E501
-        """Get analyses for session.
+        """Get analyses for a(n) session.
 
         Returns analyses that directly belong to this resource.
         This method makes a synchronous HTTP request by default.
@@ -3110,7 +3218,7 @@ class SessionsApi(object):
 
 
     def get_session_analyses_with_http_info(self, cid, **kwargs):  # noqa: E501
-        """Get analyses for session.
+        """Get analyses for a(n) session.
 
         Returns analyses that directly belong to this resource.
         This method makes a synchronous HTTP request by default.
@@ -3332,7 +3440,7 @@ class SessionsApi(object):
         Get info for a particular file.
         This method makes a synchronous HTTP request by default.
 
-        :param str cid: (required)
+        :param str cid: Container Id (required)
         :param str filename: (required)
         :param bool async_: Perform the request asynchronously
         :return: FileOutput
@@ -3359,7 +3467,7 @@ class SessionsApi(object):
         Get info for a particular file.
         This method makes a synchronous HTTP request by default.
 
-        :param str cid: (required)
+        :param str cid: Container Id (required)
         :param str filename: (required)
         :param bool async_: Perform the request asynchronously
         :return: FileOutput
@@ -3566,9 +3674,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_note(self, cid, note_id, **kwargs):  # noqa: E501
-        """Get a note on session.
+        """Get a note of a(n) session.
 
-        Get a note on session
+        Get a note of a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3593,9 +3701,9 @@ class SessionsApi(object):
 
 
     def get_session_note_with_http_info(self, cid, note_id, **kwargs):  # noqa: E501
-        """Get a note on session.
+        """Get a note of a(n) session.
 
-        Get a note on session
+        Get a note of a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4381,9 +4489,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def modify_session_info(self, cid, body, **kwargs):  # noqa: E501
-        """Update or replace info for a session.
+        """Update or replace info for a(n) session.
 
-        Update or replace info for a session.
+        Update or replace info for a(n) session.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4408,9 +4516,9 @@ class SessionsApi(object):
 
 
     def modify_session_info_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Update or replace info for a session.
+        """Update or replace info for a(n) session.
 
-        Update or replace info for a session.
+        Update or replace info for a(n) session.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4496,9 +4604,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def modify_session_note(self, cid, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on session.
+        """Update a note of a(n) session.
 
-        Update a note on session
+        Update a note of a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4524,9 +4632,9 @@ class SessionsApi(object):
 
 
     def modify_session_note_with_http_info(self, cid, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on session.
+        """Update a note of a(n) session.
 
-        Update a note on session
+        Update a note of a(n) session
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4742,8 +4850,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def upload_file_to_session(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload a file to session.
+        """Upload a file to a(n) session.
 
+        Upload a file to a(n) session.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -4776,8 +4885,9 @@ class SessionsApi(object):
 
 
     def upload_file_to_session_with_http_info(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload a file to session.
+        """Upload a file to a(n) session.
 
+        Upload a file to a(n) session.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -4881,9 +4991,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def upload_output_to_session_analysis(self, cid, analysis_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 cid: (required)
@@ -4914,9 +5024,9 @@ class SessionsApi(object):
 
 
     def upload_output_to_session_analysis_with_http_info(self, cid, analysis_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 cid: (required)