flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl

flywheel/api/download_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -37,14 +30,21 @@ class DownloadApi(object):
         Use filters in the payload to exclude/include files. To pass a single filter, each of its conditions should be satisfied. If a file pass at least one filter, it is included in the targets.
         This method makes a synchronous HTTP request by default.
 
-        :param DownloadInput body: (required)
-        :param DownloadStrategy type: The download type, one of: bulk, classic or full. Default is classic.
-        :param bool bulk:
-        :param bool metadata: For \"full\" download, whether or not to include metadata sidecars. Default is false.
-        :param bool analyses: For \"full\" download, whether or not to include analyses. Default is false.
-        :param str prefix: A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to \"scitran\".
-        :param bool async_: Perform the request asynchronously
-        :return: DownloadTicketStub
+        :param body:
+        :type body: DownloadInput
+        :param type: The download type, one of: bulk, classic or full. Default is classic.
+        :type type: DownloadStrategy, optional
+        :param bulk:, defaults to false
+        :type bulk: bool, optional
+        :param metadata: For \"full\" download, whether or not to include metadata sidecars. Default is false.
+        :type metadata: bool, optional
+        :param analyses: For \"full\" download, whether or not to include analyses. Default is false.
+        :type analyses: bool, optional
+        :param prefix: A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to \"scitran\".
+        :type prefix: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DownloadTicketStub
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -68,14 +68,21 @@ class DownloadApi(object):
         Use filters in the payload to exclude/include files. To pass a single filter, each of its conditions should be satisfied. If a file pass at least one filter, it is included in the targets.
         This method makes a synchronous HTTP request by default.
 
-        :param DownloadInput body: (required)
-        :param DownloadStrategy type: The download type, one of: bulk, classic or full. Default is classic.
-        :param bool bulk:
-        :param bool metadata: For \"full\" download, whether or not to include metadata sidecars. Default is false.
-        :param bool analyses: For \"full\" download, whether or not to include analyses. Default is false.
-        :param str prefix: A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to \"scitran\".
-        :param bool async_: Perform the request asynchronously
-        :return: DownloadTicketStub
+        :param body:
+        :type body: DownloadInput
+        :param type: The download type, one of: bulk, classic or full. Default is classic.
+        :type type: DownloadStrategy, optional
+        :param bulk:, defaults to false
+        :type bulk: bool, optional
+        :param metadata: For \"full\" download, whether or not to include metadata sidecars. Default is false.
+        :type metadata: bool, optional
+        :param analyses: For \"full\" download, whether or not to include analyses. Default is false.
+        :type analyses: bool, optional
+        :param prefix: A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to \"scitran\".
+        :type prefix: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DownloadTicketStub
         """
 
         all_params = ['body','type','bulk','metadata','analyses','prefix',]  # noqa: E501
@@ -165,11 +172,15 @@ class DownloadApi(object):
         You can use POST to create a download ticket The files listed in the ticket are put into a tar archive
         This method makes a synchronous HTTP request by default.
 
-        :param str ticket: ID of the download ticket (required)
-        :param DownloadFormat format:
-        :param str dest_file: Destination file path
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param ticket: ID of the download ticket
+        :type ticket: str
+        :param format:
+        :type format: DownloadFormat, optional
+        :param dest_file: Destination file path
+        :type dest_file: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -192,10 +203,13 @@ class DownloadApi(object):
         You can use POST to create a download ticket The files listed in the ticket are put into a tar archive
         This method makes a synchronous HTTP request by default.
 
-        :param str ticket: ID of the download ticket (required)
-        :param DownloadFormat format:
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param ticket: ID of the download ticket
+        :type ticket: str
+        :param format:
+        :type format: DownloadFormat, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['ticket','format',]  # noqa: E501