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

flywheel/api/collections_api.py

@@ -138,8 +138,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def add_collection_note(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to collection.
+        """Add a note to a(n) collection.
 
+        Add a note to a(n) collection.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -164,8 +165,9 @@ class CollectionsApi(object):
 
 
     def add_collection_note_with_http_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to collection.
+        """Add a note to a(n) collection.
 
+        Add a note to a(n) collection.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -366,7 +368,7 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def add_collection_tag(self, cid, body, **kwargs):  # noqa: E501
-        """Add a tag to collection.
+        """Add a tag to a(n) collection.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -393,7 +395,7 @@ class CollectionsApi(object):
 
 
     def add_collection_tag_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Add a tag to collection.
+        """Add a tag to a(n) collection.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -481,9 +483,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def add_collection_tags(self, cid, body, **kwargs):  # noqa: E501
-        """Add multiple tags to collection
+        """Add multiple tags to a(n) collection
 
-        Add multiple tags to collection
+        Add multiple tags to a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -508,9 +510,9 @@ class CollectionsApi(object):
 
 
     def add_collection_tags_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Add multiple tags to collection
+        """Add multiple tags to a(n) collection
 
-        Add multiple tags to collection
+        Add multiple tags to a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -797,9 +799,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def delete_collection_note(self, cid, note_id, **kwargs):  # noqa: E501
-        """Remove a note from collection
+        """Remove a note from a(n) collection
 
-        Remove a note from collection
+        Remove a note from a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -824,9 +826,9 @@ class CollectionsApi(object):
 
 
     def delete_collection_note_with_http_info(self, cid, note_id, **kwargs):  # noqa: E501
-        """Remove a note from collection
+        """Remove a note from a(n) collection
 
-        Remove a note from collection
+        Remove a note from a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1005,9 +1007,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def delete_collection_tags(self, cid, body, **kwargs):  # noqa: E501
-        """Delete multiple tags from collection
+        """Delete multiple tags from a(n) collection
 
-        Delete multiple tags from collection
+        Delete multiple tags from a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1032,9 +1034,9 @@ class CollectionsApi(object):
 
 
     def delete_collection_tags_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Delete multiple tags from collection
+        """Delete multiple tags from a(n) collection
 
-        Delete multiple tags from collection
+        Delete multiple tags from a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1216,13 +1218,117 @@ class CollectionsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_collections_by_ids(self, body, **kwargs):  # noqa: E501
+        """Delete multiple collections by ID list
+
+        Delete multiple collections 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_collections_by_ids_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_collections_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_collections_by_ids_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete multiple collections by ID list
+
+        Delete multiple collections 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_collections_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_collections_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(
+            '/collections', '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.
 
         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-char hex id (required)
+        :param str collection_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
@@ -1256,7 +1362,7 @@ class CollectionsApi(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 collection_id: 24-char hex id (required)
+        :param str collection_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
@@ -1355,7 +1461,7 @@ class CollectionsApi(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 collection_id: 24-char hex id (required)
+        :param str collection_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
@@ -1390,7 +1496,7 @@ class CollectionsApi(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 collection_id: 24-char hex id (required)
+        :param str collection_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
@@ -1494,7 +1600,7 @@ class CollectionsApi(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 collection_id: 24-char hex id (required)
+        :param str collection_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
@@ -1529,7 +1635,7 @@ class CollectionsApi(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 collection_id: 24-char hex id (required)
+        :param str collection_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
@@ -2122,7 +2228,7 @@ class CollectionsApi(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
@@ -2149,7 +2255,7 @@ class CollectionsApi(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
@@ -2221,9 +2327,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def get_collection_note(self, cid, note_id, **kwargs):  # noqa: E501
-        """Get a note on collection.
+        """Get a note of a(n) collection.
 
-        Get a note on collection
+        Get a note of a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -2248,9 +2354,9 @@ class CollectionsApi(object):
 
 
     def get_collection_note_with_http_info(self, cid, note_id, **kwargs):  # noqa: E501
-        """Get a note on collection.
+        """Get a note of a(n) collection.
 
-        Get a note on collection
+        Get a note of a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3142,9 +3248,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def modify_collection_info(self, cid, body, **kwargs):  # noqa: E501
-        """Update or replace info for a collection.
+        """Update or replace info for a(n) collection.
 
-        Update or replace info for a collection.
+        Update or replace info for a(n) collection.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3169,9 +3275,9 @@ class CollectionsApi(object):
 
 
     def modify_collection_info_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Update or replace info for a collection.
+        """Update or replace info for a(n) collection.
 
-        Update or replace info for a collection.
+        Update or replace info for a(n) collection.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3257,9 +3363,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def modify_collection_note(self, cid, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on collection.
+        """Update a note of a(n) collection.
 
-        Update a note on collection
+        Update a note of a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3285,9 +3391,9 @@ class CollectionsApi(object):
 
 
     def modify_collection_note_with_http_info(self, cid, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on collection.
+        """Update a note of a(n) collection.
 
-        Update a note on collection
+        Update a note of a(n) collection
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3626,8 +3732,9 @@ class CollectionsApi(object):
             collection_formats=collection_formats)
 
     def upload_file_to_collection(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload a file to collection.
+        """Upload a file to a(n) collection.
 
+        Upload a file to a(n) collection.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -3660,8 +3767,9 @@ class CollectionsApi(object):
 
 
     def upload_file_to_collection_with_http_info(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload a file to collection.
+        """Upload a file to a(n) collection.
 
+        Upload a file to a(n) collection.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)