flywheel-sdk 19.3.0rc1__py2.py3-none-any.whl → 19.4.0__py2.py3-none-any.whl

flywheel/api/sessions_api.py

@@ -1575,6 +1575,110 @@ class SessionsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_sessions_by_query(self, body, **kwargs):  # noqa: E501
+        """Delete multiple sessions by query
+
+        Delete multiple sessions by query
+        This method makes a synchronous HTTP request by default.
+
+        :param list[Filter] body: Query for containers 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_query_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_sessions_by_query_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_query_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete multiple sessions by query
+
+        Delete multiple sessions by query
+        This method makes a synchronous HTTP request by default.
+
+        :param list[Filter] body: Query for containers 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_query" % 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_query`")  # 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_by_query', '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.
 
@@ -1709,9 +1813,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_file_zip_info(self, session_id, file_name, **kwargs):  # noqa: E501
-        """Download a file.
+        """Retrieve the zip info of a child file by name.
 
-        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.
+        Does not work on files whose names contain a forward slash.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -1744,9 +1848,9 @@ class SessionsApi(object):
 
 
     def get_session_file_zip_info_with_http_info(self, session_id, file_name, **kwargs):  # noqa: E501
-        """Download a file.
+        """Retrieve the zip info of a child file by name.
 
-        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.
+        Does not work on files whose names contain a forward slash.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -1848,9 +1952,8 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_download_ticket(self, session_id, file_name, **kwargs):  # noqa: E501
-        """Download a file.
+        """Get a signed URL to download a named child 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-character hex ID (required)
@@ -1883,9 +1986,8 @@ class SessionsApi(object):
 
 
     def get_session_download_ticket_with_http_info(self, session_id, file_name, **kwargs):  # noqa: E501
-        """Download a file.
+        """Get a signed URL to download a named child 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-character hex ID (required)
@@ -2118,9 +2220,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_analysis_input_zip_info(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis inputs with filter.
+        """Retrieve the zip info of a child file by name.
 
-        If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
+        Does not work on files whose names contain a forward slash.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2152,9 +2254,9 @@ class SessionsApi(object):
 
 
     def get_session_analysis_input_zip_info_with_http_info(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis inputs with filter.
+        """Retrieve the zip info of a child file by name.
 
-        If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
+        Does not work on files whose names contain a forward slash.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2257,9 +2359,8 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_analysis_input_download_ticket(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis inputs with filter.
+        """Get a signed URL to download a named child file.
 
-        If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2291,9 +2392,8 @@ class SessionsApi(object):
 
 
     def get_session_analysis_input_download_ticket_with_http_info(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis inputs with filter.
+        """Get a signed URL to download a named child file.
 
-        If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2527,9 +2627,9 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_analysis_output_zip_info(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis outputs with filter.
+        """Retrieve the zip info of a child file by name.
 
-        If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
+        Does not work on files whose names contain a forward slash.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2561,9 +2661,9 @@ class SessionsApi(object):
 
 
     def get_session_analysis_output_zip_info_with_http_info(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis outputs with filter.
+        """Retrieve the zip info of a child file by name.
 
-        If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
+        Does not work on files whose names contain a forward slash.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2666,9 +2766,8 @@ class SessionsApi(object):
             collection_formats=collection_formats)
 
     def get_session_analysis_output_download_ticket(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis outputs with filter.
+        """Get a signed URL to download a named child file.
 
-        If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2700,9 +2799,8 @@ class SessionsApi(object):
 
 
     def get_session_analysis_output_download_ticket_with_http_info(self, session_id, analysis_id, filename, **kwargs):  # noqa: E501
-        """Download analysis outputs with filter.
+        """Get a signed URL to download a named child file.
 
-        If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
         This method makes a synchronous HTTP request by default.
 
         :param str session_id: 24-character hex ID (required)
@@ -2811,6 +2909,7 @@ class SessionsApi(object):
         :param bool exhaustive: Set to return a complete list regardless of permissions
         :param bool join_avatars: add name and avatar to notes
         :param JoinType join: join file origins
+        :param bool include_all_info: Include all info in returned objects
         :param str user_id:
         :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
         :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
@@ -2847,6 +2946,7 @@ class SessionsApi(object):
         :param bool exhaustive: Set to return a complete list regardless of permissions
         :param bool join_avatars: add name and avatar to notes
         :param JoinType join: join file origins
+        :param bool include_all_info: Include all info in returned objects
         :param str user_id:
         :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
         :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
@@ -2859,7 +2959,7 @@ class SessionsApi(object):
         :return: union[Page,list[SessionListOutput]]
         """
 
-        all_params = ['exhaustive','join_avatars','join','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
+        all_params = ['exhaustive','join_avatars','join','include_all_info','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -2887,6 +2987,8 @@ class SessionsApi(object):
             query_params.append(('join_avatars', params['join_avatars']))  # noqa: E501
         if 'join' in params:
             query_params.append(('join', params['join']))  # noqa: E501
+        if 'include_all_info' in params:
+            query_params.append(('include_all_info', params['include_all_info']))  # noqa: E501
         if 'user_id' in params:
             query_params.append(('user_id', params['user_id']))  # noqa: E501
         if 'filter' in params:
@@ -3054,6 +3156,7 @@ class SessionsApi(object):
         :param str collection_id:
         :param bool exhaustive:
         :param JoinType join:
+        :param bool include_all_info: Include all info in returned objects
         :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
         :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
         :param int limit: The maximum number of entries to return.
@@ -3090,6 +3193,7 @@ class SessionsApi(object):
         :param str collection_id:
         :param bool exhaustive:
         :param JoinType join:
+        :param bool include_all_info: Include all info in returned objects
         :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
         :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
         :param int limit: The maximum number of entries to return.
@@ -3101,7 +3205,7 @@ class SessionsApi(object):
         :return: union[list[AcquisitionListOutput],Page]
         """
 
-        all_params = ['session_id','collection_id','exhaustive','join','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
+        all_params = ['session_id','collection_id','exhaustive','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -3135,6 +3239,8 @@ class SessionsApi(object):
             query_params.append(('exhaustive', params['exhaustive']))  # noqa: E501
         if 'join' in params:
             query_params.append(('join', params['join']))  # noqa: E501
+        if 'include_all_info' in params:
+            query_params.append(('include_all_info', params['include_all_info']))  # noqa: E501
         if 'filter' in params:
             query_params.append(('filter', params['filter']))  # noqa: E501
         if 'sort' in params:
@@ -3197,6 +3303,7 @@ class SessionsApi(object):
         :param bool inflate_job:
         :param bool join_avatars:
         :param JoinType join:
+        :param bool include_all_info: Include all info in returned objects
         :param list[str] x_accept_feature:
         :param bool async_: Perform the request asynchronously
         :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
@@ -3233,12 +3340,13 @@ class SessionsApi(object):
         :param bool inflate_job:
         :param bool join_avatars:
         :param JoinType join:
+        :param bool include_all_info: Include all info in returned objects
         :param list[str] x_accept_feature:
         :param bool async_: Perform the request asynchronously
         :return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
         """
 
-        all_params = ['cid','filter','sort','limit','skip','page','after_id','inflate_job','join_avatars','join','x_accept_feature',]  # noqa: E501
+        all_params = ['cid','filter','sort','limit','skip','page','after_id','inflate_job','join_avatars','join','include_all_info','x_accept_feature',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -3284,6 +3392,8 @@ class SessionsApi(object):
             query_params.append(('join_avatars', params['join_avatars']))  # noqa: E501
         if 'join' in params:
             query_params.append(('join', params['join']))  # noqa: E501
+        if 'include_all_info' in params:
+            query_params.append(('include_all_info', params['include_all_info']))  # noqa: E501
 
         header_params = {}
         if 'x_accept_feature' in params:
@@ -3547,6 +3657,7 @@ class SessionsApi(object):
         :param str session_id: (required)
         :param list[str] states: filter results by job state
         :param list[str] tags: filter results by job tags
+        :param bool include_all_info: Include all info in returned objects
         :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
         :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
         :param int limit: The maximum number of entries to return.
@@ -3582,6 +3693,7 @@ class SessionsApi(object):
         :param str session_id: (required)
         :param list[str] states: filter results by job state
         :param list[str] tags: filter results by job tags
+        :param bool include_all_info: Include all info in returned objects
         :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
         :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
         :param int limit: The maximum number of entries to return.
@@ -3593,7 +3705,7 @@ class SessionsApi(object):
         :return: union[JobsList,Page]
         """
 
-        all_params = ['session_id','states','tags','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
+        all_params = ['session_id','states','tags','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -3627,6 +3739,8 @@ class SessionsApi(object):
         if 'tags' in params:
             query_params.append(('tags', params['tags']))  # noqa: E501
             collection_formats['tags'] = 'multi'  # noqa: E501
+        if 'include_all_info' in params:
+            query_params.append(('include_all_info', params['include_all_info']))  # noqa: E501
         if 'filter' in params:
             query_params.append(('filter', params['filter']))  # noqa: E501
         if 'sort' in params:
@@ -4491,7 +4605,7 @@ class SessionsApi(object):
     def modify_session_info(self, cid, body, **kwargs):  # noqa: E501
         """Update or replace info for a(n) session.
 
-        Update or replace info for a(n) session.
+        Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4518,7 +4632,7 @@ class SessionsApi(object):
     def modify_session_info_with_http_info(self, cid, body, **kwargs):  # noqa: E501
         """Update or replace info for a(n) session.
 
-        Update or replace info for a(n) session.
+        Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)