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

flywheel/api/collections_api.py

@@ -1322,6 +1322,110 @@ class CollectionsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_collections_by_query(self, body, **kwargs):  # noqa: E501
+        """Delete multiple collections by query
+
+        Delete multiple collections 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_collections_by_query_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_collections_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_collections_by_query_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete multiple collections by query
+
+        Delete multiple collections 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_collections_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_collections_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(
+            '/collections/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_collection(self, collection_id, file_name, dest_file, **kwargs):  # noqa: E501
         """Download a file.
 
@@ -1456,9 +1560,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def get_collection_file_zip_info(self, collection_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 collection_id: 24-character hex ID (required)
@@ -1491,9 +1595,9 @@ class CollectionsApi(object):
 
 
     def get_collection_file_zip_info_with_http_info(self, collection_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 collection_id: 24-character hex ID (required)
@@ -1595,9 +1699,8 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def get_collection_download_ticket(self, collection_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 collection_id: 24-character hex ID (required)
@@ -1630,9 +1733,8 @@ class CollectionsApi(object):
 
 
     def get_collection_download_ticket_with_http_info(self, collection_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 collection_id: 24-character hex ID (required)
@@ -1742,6 +1844,7 @@ class CollectionsApi(object):
         :param bool join_files:
         :param JoinType join:
         :param bool stats:
+        :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)
@@ -1780,6 +1883,7 @@ class CollectionsApi(object):
         :param bool join_files:
         :param JoinType join:
         :param bool stats:
+        :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)
@@ -1792,7 +1896,7 @@ class CollectionsApi(object):
         :return: union[Page,list[CollectionWithStats],list[CollectionOutput]]
         """
 
-        all_params = ['exhaustive','join_avatars','join_files','join','stats','user_id','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
+        all_params = ['exhaustive','join_avatars','join_files','join','stats','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')
@@ -1824,6 +1928,8 @@ class CollectionsApi(object):
             query_params.append(('join', params['join']))  # noqa: E501
         if 'stats' in params:
             query_params.append(('stats', params['stats']))  # 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:
@@ -2437,6 +2543,7 @@ class CollectionsApi(object):
         This method makes a synchronous HTTP request by default.
 
         :param str collection_id: (required)
+        :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.
@@ -2470,6 +2577,7 @@ class CollectionsApi(object):
         This method makes a synchronous HTTP request by default.
 
         :param str collection_id: (required)
+        :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.
@@ -2481,7 +2589,7 @@ class CollectionsApi(object):
         :return: union[list[SessionListOutput],Page]
         """
 
-        all_params = ['collection_id','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
+        all_params = ['collection_id','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')
@@ -2509,6 +2617,8 @@ class CollectionsApi(object):
             path_params['collection_id'] = params['collection_id']  # noqa: E501
 
         query_params = []
+        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:
@@ -3250,7 +3360,7 @@ class CollectionsApi(object):
     def modify_collection_info(self, cid, body, **kwargs):  # noqa: E501
         """Update or replace info for a(n) collection.
 
-        Update or replace info for a(n) collection.
+        Update or replace info for a(n) collection. 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)
@@ -3277,7 +3387,7 @@ class CollectionsApi(object):
     def modify_collection_info_with_http_info(self, cid, body, **kwargs):  # noqa: E501
         """Update or replace info for a(n) collection.
 
-        Update or replace info for a(n) collection.
+        Update or replace info for a(n) collection. 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)

flywheel/api/containers_api.py

@@ -1613,9 +1613,9 @@ class ContainersApi(object):
             collection_formats=collection_formats)
 
     def get_container_file_zip_info(self, container_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 container_id: 24-character hex ID (required)
@@ -1648,9 +1648,9 @@ class ContainersApi(object):
 
 
     def get_container_file_zip_info_with_http_info(self, container_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 container_id: 24-character hex ID (required)
@@ -1752,9 +1752,8 @@ class ContainersApi(object):
             collection_formats=collection_formats)
 
     def get_container_download_ticket(self, container_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 container_id: 24-character hex ID (required)
@@ -1787,9 +1786,8 @@ class ContainersApi(object):
 
 
     def get_container_download_ticket_with_http_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2022,9 +2020,9 @@ class ContainersApi(object):
             collection_formats=collection_formats)
 
     def get_container_analysis_input_zip_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2056,9 +2054,9 @@ class ContainersApi(object):
 
 
     def get_container_analysis_input_zip_info_with_http_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2161,9 +2159,8 @@ class ContainersApi(object):
             collection_formats=collection_formats)
 
     def get_container_analysis_input_download_ticket(self, container_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 container_id: 24-character hex ID (required)
@@ -2195,9 +2192,8 @@ class ContainersApi(object):
 
 
     def get_container_analysis_input_download_ticket_with_http_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2431,9 +2427,9 @@ class ContainersApi(object):
             collection_formats=collection_formats)
 
     def get_container_analysis_output_zip_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2465,9 +2461,9 @@ class ContainersApi(object):
 
 
     def get_container_analysis_output_zip_info_with_http_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2570,9 +2566,8 @@ class ContainersApi(object):
             collection_formats=collection_formats)
 
     def get_container_analysis_output_download_ticket(self, container_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 container_id: 24-character hex ID (required)
@@ -2604,9 +2599,8 @@ class ContainersApi(object):
 
 
     def get_container_analysis_output_download_ticket_with_http_info(self, container_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 container_id: 24-character hex ID (required)
@@ -2826,6 +2820,7 @@ class ContainersApi(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]]]
@@ -2862,12 +2857,13 @@ class ContainersApi(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')
@@ -2913,6 +2909,8 @@ class ContainersApi(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:
@@ -4105,7 +4103,7 @@ class ContainersApi(object):
     def modify_container_info(self, cid, body, **kwargs):  # noqa: E501
         """Update or replace info for a(n) container.
 
-        Update or replace info for a(n) container.
+        Update or replace info for a(n) container. 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)
@@ -4132,7 +4130,7 @@ class ContainersApi(object):
     def modify_container_info_with_http_info(self, cid, body, **kwargs):  # noqa: E501
         """Update or replace info for a(n) container.
 
-        Update or replace info for a(n) container.
+        Update or replace info for a(n) container. 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)