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

flywheel/api/projects_api.py

@@ -265,8 +265,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def add_project_analysis_note(self, container_id, analysis_id, body, **kwargs):  # noqa: E501
-        """Add a note to project analysis.
+        """Add a note to a(n) project analysis.
 
+        Add a note to a(n) project analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: 24-char hex id (required)
@@ -292,8 +293,9 @@ class ProjectsApi(object):
 
 
     def add_project_analysis_note_with_http_info(self, container_id, analysis_id, body, **kwargs):  # noqa: E501
-        """Add a note to project analysis.
+        """Add a note to a(n) project analysis.
 
+        Add a note to a(n) project analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: 24-char hex id (required)
@@ -386,8 +388,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def add_project_note(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to project.
+        """Add a note to a(n) project.
 
+        Add a note to a(n) project.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -412,8 +415,9 @@ class ProjectsApi(object):
 
 
     def add_project_note_with_http_info(self, container_id, body, **kwargs):  # noqa: E501
-        """Add a note to project.
+        """Add a note to a(n) project.
 
+        Add a note to a(n) project.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -732,7 +736,7 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def add_project_tag(self, cid, body, **kwargs):  # noqa: E501
-        """Add a tag to project.
+        """Add a tag to a(n) project.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -759,7 +763,7 @@ class ProjectsApi(object):
 
 
     def add_project_tag_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Add a tag to project.
+        """Add a tag to a(n) project.
 
         Propagates changes to projects, sessions and acquisitions
         This method makes a synchronous HTTP request by default.
@@ -847,9 +851,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def add_project_tags(self, cid, body, **kwargs):  # noqa: E501
-        """Add multiple tags to project
+        """Add multiple tags to a(n) project
 
-        Add multiple tags to project
+        Add multiple tags to a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -874,9 +878,9 @@ class ProjectsApi(object):
 
 
     def add_project_tags_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Add multiple tags to project
+        """Add multiple tags to a(n) project
 
-        Add multiple tags to project
+        Add multiple tags to a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1174,7 +1178,7 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def delete_project_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.
@@ -1202,7 +1206,7 @@ class ProjectsApi(object):
 
 
     def delete_project_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.
@@ -1282,9 +1286,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def delete_project_analysis_note(self, cid, analysis_id, note_id, **kwargs):  # noqa: E501
-        """Remove a note from project analysis.
+        """Remove a note from a(n) project analysis.
 
-        Remove a note from project analysis.
+        Remove a note from a(n) project analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: 24-char hex id (required)
@@ -1310,9 +1314,9 @@ class ProjectsApi(object):
 
 
     def delete_project_analysis_note_with_http_info(self, cid, analysis_id, note_id, **kwargs):  # noqa: E501
-        """Remove a note from project analysis.
+        """Remove a note from a(n) project analysis.
 
-        Remove a note from project analysis.
+        Remove a note from a(n) project analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: 24-char hex id (required)
@@ -1506,9 +1510,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def delete_project_note(self, cid, note_id, **kwargs):  # noqa: E501
-        """Remove a note from project
+        """Remove a note from a(n) project
 
-        Remove a note from project
+        Remove a note from a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1533,9 +1537,9 @@ class ProjectsApi(object):
 
 
     def delete_project_note_with_http_info(self, cid, note_id, **kwargs):  # noqa: E501
-        """Remove a note from project
+        """Remove a note from a(n) project
 
-        Remove a note from project
+        Remove a note from a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1714,9 +1718,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def delete_project_tags(self, cid, body, **kwargs):  # noqa: E501
-        """Delete multiple tags from project
+        """Delete multiple tags from a(n) project
 
-        Delete multiple tags from project
+        Delete multiple tags from a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1741,9 +1745,9 @@ class ProjectsApi(object):
 
 
     def delete_project_tags_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Delete multiple tags from project
+        """Delete multiple tags from a(n) project
 
-        Delete multiple tags from project
+        Delete multiple tags from a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -1928,13 +1932,117 @@ class ProjectsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_projects_by_ids(self, body, **kwargs):  # noqa: E501
+        """Delete multiple projects by ID list
+
+        Delete multiple projects 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_projects_by_ids_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_projects_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_projects_by_ids_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Delete multiple projects by ID list
+
+        Delete multiple projects 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_projects_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_projects_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(
+            '/projects', '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_project(self, project_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 project_id: 24-char hex id (required)
+        :param str project_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
@@ -1968,7 +2076,7 @@ class ProjectsApi(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 project_id: 24-char hex id (required)
+        :param str project_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
@@ -2067,7 +2175,7 @@ class ProjectsApi(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 project_id: 24-char hex id (required)
+        :param str project_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
@@ -2102,7 +2210,7 @@ class ProjectsApi(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 project_id: 24-char hex id (required)
+        :param str project_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
@@ -2206,7 +2314,7 @@ class ProjectsApi(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 project_id: 24-char hex id (required)
+        :param str project_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
@@ -2241,7 +2349,7 @@ class ProjectsApi(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 project_id: 24-char hex id (required)
+        :param str project_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
@@ -3856,7 +3964,7 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def get_project_analyses(self, cid, **kwargs):  # noqa: E501
-        """Get analyses for project.
+        """Get analyses for a(n) project.
 
         Returns analyses that directly belong to this resource.
         This method makes a synchronous HTTP request by default.
@@ -3892,7 +4000,7 @@ class ProjectsApi(object):
 
 
     def get_project_analyses_with_http_info(self, cid, **kwargs):  # noqa: E501
-        """Get analyses for project.
+        """Get analyses for a(n) project.
 
         Returns analyses that directly belong to this resource.
         This method makes a synchronous HTTP request by default.
@@ -4114,7 +4222,7 @@ class ProjectsApi(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
@@ -4141,7 +4249,7 @@ class ProjectsApi(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
@@ -4213,9 +4321,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def get_project_note(self, cid, note_id, **kwargs):  # noqa: E501
-        """Get a note on project.
+        """Get a note of a(n) project.
 
-        Get a note on project
+        Get a note of a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4240,9 +4348,9 @@ class ProjectsApi(object):
 
 
     def get_project_note_with_http_info(self, cid, note_id, **kwargs):  # noqa: E501
-        """Get a note on project.
+        """Get a note of a(n) project.
 
-        Get a note on project
+        Get a note of a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4644,9 +4752,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def get_project_settings(self, project_id, **kwargs):  # noqa: E501
-        """Get settings on project
+        """Get a(n) project settings
 
-        Get settings on project
+        Route for getting settings from a a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str project_id: (required)
@@ -4670,9 +4778,9 @@ class ProjectsApi(object):
 
 
     def get_project_settings_with_http_info(self, project_id, **kwargs):  # noqa: E501
-        """Get settings on project
+        """Get a(n) project settings
 
-        Get settings on project
+        Route for getting settings from a a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str project_id: (required)
@@ -5687,9 +5795,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def modify_project_info(self, cid, body, **kwargs):  # noqa: E501
-        """Update or replace info for a project.
+        """Update or replace info for a(n) project.
 
-        Update or replace info for a project.
+        Update or replace info for a(n) project.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -5714,9 +5822,9 @@ class ProjectsApi(object):
 
 
     def modify_project_info_with_http_info(self, cid, body, **kwargs):  # noqa: E501
-        """Update or replace info for a project.
+        """Update or replace info for a(n) project.
 
-        Update or replace info for a project.
+        Update or replace info for a(n) project.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -5802,9 +5910,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def modify_project_note(self, cid, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on project.
+        """Update a note of a(n) project.
 
-        Update a note on project
+        Update a note of a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -5830,9 +5938,9 @@ class ProjectsApi(object):
 
 
     def modify_project_note_with_http_info(self, cid, note_id, body, **kwargs):  # noqa: E501
-        """Update a note on project.
+        """Update a note of a(n) project.
 
-        Update a note on project
+        Update a note of a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -6048,9 +6156,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def modify_project_settings(self, project_id, body, **kwargs):  # noqa: E501
-        """Modify project settings
+        """Modify a(n) project settings
 
-        Modify project settings
+        Route for modifying settings for a a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str project_id: (required)
@@ -6076,9 +6184,9 @@ class ProjectsApi(object):
 
 
     def modify_project_settings_with_http_info(self, project_id, body, **kwargs):  # noqa: E501
-        """Modify project settings
+        """Modify a(n) project settings
 
-        Modify project settings
+        Route for modifying settings for a a(n) project
         This method makes a synchronous HTTP request by default.
 
         :param str project_id: (required)
@@ -7235,8 +7343,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def upload_file_to_project(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload a file to project.
+        """Upload a file to a(n) project.
 
+        Upload a file to a(n) project.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -7269,8 +7378,9 @@ class ProjectsApi(object):
 
 
     def upload_file_to_project_with_http_info(self, container_id, file, **kwargs):  # noqa: E501
-        """Upload a file to project.
+        """Upload a file to a(n) project.
 
+        Upload a file to a(n) project.
         This method makes a synchronous HTTP request by default.
 
         :param str container_id: (required)
@@ -7374,9 +7484,9 @@ class ProjectsApi(object):
             collection_formats=collection_formats)
 
     def upload_output_to_project_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)
@@ -7407,9 +7517,9 @@ class ProjectsApi(object):
 
 
     def upload_output_to_project_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)