flywheel-sdk 18.1.0rc0__py2.py3-none-any.whl → 18.2.0__py2.py3-none-any.whl

flywheel/__init__.py

@@ -535,6 +535,7 @@ from flywheel.models.project_upsert_origin import ProjectUpsertOrigin
 from flywheel.models.provider import Provider
 from flywheel.models.provider_access_type import ProviderAccessType
 from flywheel.models.provider_class import ProviderClass
+from flywheel.models.provider_deletion_status import ProviderDeletionStatus
 from flywheel.models.provider_input import ProviderInput
 from flywheel.models.provider_links import ProviderLinks
 from flywheel.models.provider_type import ProviderType
@@ -584,6 +585,7 @@ from flywheel.models.roles_role_assignment import RolesRoleAssignment
 from flywheel.models.roles_role_input import RolesRoleInput
 from flywheel.models.rule import Rule
 from flywheel.models.rule_any import RuleAny
+from flywheel.models.s3_addressing_style import S3AddressingStyle
 from flywheel.models.s3_compat_storage import S3CompatStorage
 from flywheel.models.save_search import SaveSearch
 from flywheel.models.save_search_input import SaveSearchInput

flywheel/api/acquisitions_api.py

@@ -2939,7 +2939,7 @@ class AcquisitionsApi(object):
     def get_acquisition_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -2969,7 +2969,7 @@ class AcquisitionsApi(object):
     def get_acquisition_analysis_with_http_info(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)

flywheel/api/analyses_api.py

@@ -956,7 +956,7 @@ class AnalysesApi(object):
     def download_output_from_analysis(self, analysis_id, filename, dest_file, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-character hex ID (required)
@@ -988,7 +988,7 @@ class AnalysesApi(object):
     def download_output_from_analysis_with_http_info(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-character hex ID (required)
@@ -1081,7 +1081,7 @@ class AnalysesApi(object):
     def get_analysis_output_zip_info(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-character hex ID (required)
@@ -1114,7 +1114,7 @@ class AnalysesApi(object):
     def get_analysis_output_zip_info_with_http_info(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-character hex ID (required)
@@ -1212,7 +1212,7 @@ class AnalysesApi(object):
     def get_analysis_output_download_ticket(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-character hex ID (required)
@@ -1245,7 +1245,7 @@ class AnalysesApi(object):
     def get_analysis_output_download_ticket_with_http_info(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
         This method makes a synchronous HTTP request by default.
 
         :param str analysis_id: 24-character hex ID (required)

flywheel/api/containers_api.py

@@ -2942,7 +2942,7 @@ class ContainersApi(object):
     def get_container_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -2972,7 +2972,7 @@ class ContainersApi(object):
     def get_container_analysis_with_http_info(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)

flywheel/api/projects_api.py

@@ -3991,7 +3991,7 @@ class ProjectsApi(object):
     def get_project_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -4021,7 +4021,7 @@ class ProjectsApi(object):
     def get_project_analysis_with_http_info(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)

flywheel/api/sessions_api.py

@@ -3209,7 +3209,7 @@ class SessionsApi(object):
     def get_session_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3239,7 +3239,7 @@ class SessionsApi(object):
     def get_session_analysis_with_http_info(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)

flywheel/api/site_api.py

@@ -240,6 +240,102 @@ class SiteApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def delete_provider(self, provider_id, **kwargs):  # noqa: E501
+        """Delete the provider identified by ProviderId
+
+        Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the `get_provider` operation to check the deletion status.
+        This method makes a synchronous HTTP request by default.
+
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.delete_provider_with_http_info(provider_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_provider_with_http_info(provider_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def delete_provider_with_http_info(self, provider_id, **kwargs):  # noqa: E501
+        """Delete the provider identified by ProviderId
+
+        Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the `get_provider` operation to check the deletion status.
+        This method makes a synchronous HTTP request by default.
+
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
+        """
+
+        all_params = ['provider_id',]  # 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_provider" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'provider_id' is set
+        if ('provider_id' not in params or
+                params['provider_id'] is None):
+            raise ValueError("Missing the required parameter `provider_id` when calling `delete_provider`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'provider_id' in params:
+            path_params['provider_id'] = params['provider_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/site/providers/{provider_id}', 'DELETE',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # 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 get_bookmark_list(self, **kwargs):  # noqa: E501
         """Get Bookmark List
 

flywheel/api/subjects_api.py

@@ -3175,7 +3175,7 @@ class SubjectsApi(object):
     def get_subject_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)
@@ -3205,7 +3205,7 @@ class SubjectsApi(object):
     def get_subject_analysis_with_http_info(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
         This method makes a synchronous HTTP request by default.
 
         :param str cid: (required)

flywheel/api_client.py

@@ -81,7 +81,7 @@ class ApiClient(object):
         self.default_query_params = []
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/18.1.0-rc0/python'
+        self.user_agent = 'Swagger-Codegen/18.2.0/python'
         self.last_response = None
         self._version_check_fn = None
         self._context = context
@@ -364,7 +364,7 @@ class ApiClient(object):
                  _preload_content=True, _request_timeout=None, _request_out=None):
         """Makes the HTTP request (synchronous) and returns deserialized data.
 
-        To make an async request, set the async_ parameter.
+        To make an async request, set the ``async_`` parameter.
 
         :param resource_path: Path to method endpoint.
         :param method: Method to call.
@@ -392,10 +392,10 @@ class ApiClient(object):
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
         :return:
-            If async_ parameter is True,
+            If ``async_`` parameter is True,
             the request will be called asynchronously.
             The method will return the request thread.
-            If parameter async_ is False or missing,
+            If parameter ``async_`` is False or missing,
             then the method will return the response directly.
         """
         if not async_:

flywheel/client.py

@@ -234,7 +234,7 @@ class Client(object):
         return self._fw.data_view_executions
 
     def View(self, **kwargs):
-        """Short-hand for flywheel.ViewBuilder(**kwargs).build()
+        """Short-hand for ``flywheel.ViewBuilder(**kwargs).build()``
 
         :param kwargs: The arguments to pass directly to ViewBuilder
         :return: The built data view

flywheel/configuration.py

@@ -253,5 +253,5 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.0.1\n"\
-               "SDK Package Version: 18.1.0-rc0".\
+               "SDK Package Version: 18.2.0".\
                format(env=sys.platform, pyversion=sys.version)

flywheel/flywheel.py

@@ -39,7 +39,7 @@ from flywheel.view_builder import ViewBuilder
 from flywheel.finder import Finder
 import flywheel.api
 
-SDK_VERSION = "18.1.0-rc0"
+SDK_VERSION = "18.2.0"
 
 def config_from_api_key(api_key):
     parts = api_key.split(':')
@@ -573,7 +573,7 @@ class Flywheel:
     def get_acquisition_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
 
         :param str cid: (required)
         :param str analysis_id: (required)
@@ -935,7 +935,7 @@ class Flywheel:
     def download_output_from_analysis(self, analysis_id, filename, dest_file, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
 
         :param str analysis_id: 24-character hex ID (required)
         :param str filename: output file name (required)
@@ -954,7 +954,7 @@ class Flywheel:
     def get_analysis_output_zip_info(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
 
         :param str analysis_id: 24-character hex ID (required)
         :param str filename: output file name (required)
@@ -973,7 +973,7 @@ class Flywheel:
     def get_analysis_output_download_url(self, analysis_id, filename, **kwargs):  # noqa: E501
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
 
         :param str analysis_id: 24-character hex ID (required)
         :param str filename: output file name (required)
@@ -2280,7 +2280,7 @@ class Flywheel:
     def get_container_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
 
         :param str cid: (required)
         :param str analysis_id: (required)
@@ -4492,7 +4492,7 @@ class Flywheel:
     def get_project_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
 
         :param str cid: (required)
         :param str analysis_id: (required)
@@ -5606,7 +5606,7 @@ class Flywheel:
     def get_session_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
 
         :param str cid: (required)
         :param str analysis_id: (required)
@@ -5859,6 +5859,18 @@ class Flywheel:
         return self.site_api.add_site_rule(body, **kwargs)
 
 
+    def delete_provider(self, provider_id, **kwargs):  # noqa: E501
+        """Delete the provider identified by ProviderId
+
+        Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the `get_provider` operation to check the deletion status.
+
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
+        """
+        return self.site_api.delete_provider(provider_id, **kwargs)
+
+
     def get_bookmark_list(self, **kwargs):  # noqa: E501
         """Get Bookmark List
 
@@ -6447,7 +6459,7 @@ class Flywheel:
     def get_subject_analysis(self, cid, analysis_id, **kwargs):  # noqa: E501
         """Get an analysis.
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get an analysis.
 
         :param str cid: (required)
         :param str analysis_id: (required)
@@ -7681,7 +7693,7 @@ class Flywheel:
     def download_output_from_analysis_as_data(self, analysis_id, filename, **kwargs):
         """Get Output File
 
-        partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
+        Get Output File
 
         :param str analysis_id: 24-character hex ID (required)
         :param str filename: output file name (required)
@@ -8518,7 +8530,7 @@ class Flywheel:
 
 
     def View(self, **kwargs):
-        """Short-hand for flywheel.ViewBuilder(**kwargs).build()
+        """Short-hand for ``flywheel.ViewBuilder(**kwargs).build()``
 
         :param kwargs: The arguments to pass directly to ViewBuilder
         :return: The built data view

flywheel/gear_context.py

@@ -154,7 +154,7 @@ class GearContext(object):
 
         :param str name: The name of the input
         :param str mode: The open mode (default is 'r')
-        :param **kwargs: Additional args to pass to ``open``
+        :param ``**kwargs``: Additional args to pass to ``open``
         :return: The file object
         :rtype: file
         """
@@ -169,7 +169,7 @@ class GearContext(object):
 
         :param str name: The name of the output
         :param str mode: The open mode (default is 'w')
-        :param **kwargs: Additional args to pass to ``open``
+        :param ``**kwargs``: Additional args to pass to ``open``
         :return: The file object
         :rtype: file
         """
@@ -201,8 +201,8 @@ class GearContext(object):
         if using this as a context manager, when the context is exited.
 
         :param str container_type: The container type (e.g. session or acquisition)
-        :param *args: The optional update dictionary
-        :param **kwargs: The optional update key-value pairs
+        :param ``*args``: The optional update dictionary
+        :param ``**kwargs``: The optional update key-value pairs
         """
         update = self._create_update_dict(args, kwargs)
         self._update_metadata(container_type, update)
@@ -216,8 +216,8 @@ class GearContext(object):
         if using this as a context manager, when the context is exited.
 
         :param str file_name: The name of the file
-        :param *args: The optional update dictionary
-        :param **kwargs: The optional update key-value pairs
+        :param ``*args``: The optional update dictionary
+        :param ``**kwargs``: The optional update key-value pairs
         """
         container_type = self.destination["type"]
         update = self._create_update_dict(args, kwargs)
@@ -231,8 +231,8 @@ class GearContext(object):
         The metadata will be written when write_metadata() is called, or
         if using this as a context manager, when the context is exited.
 
-        :param *args: The optional update dictionary
-        :param **kwargs: The optional update key-value pairs
+        :param ``*args``: The optional update dictionary
+        :param ``**kwargs``: The optional update key-value pairs
         """
         container_type = self.destination["type"]
         update = self._create_update_dict(args, kwargs)
@@ -254,7 +254,7 @@ class GearContext(object):
         :param str target_dir: The destination directory (otherwise work/bids will be used)
         :param bool src_data: Whether or not to include src data (e.g. dicoms)
         :param list folders: The list of folders to include (otherwise all folders) e.g. ['anat', 'func']
-        :param **kwargs: Additional arguments to pass to download_bids_dir
+        :param ``**kwargs``: Additional arguments to pass to ``download_bids_dir``
         :return: The absolute path to the downloaded bids directory
         :rtype: str
         """
@@ -278,7 +278,7 @@ class GearContext(object):
         :param list subjects: The list of subjects to include (via subject code) otherwise all subjects
         :param list sessions: The list of sessions to include (via session label) otherwise all sessions
         :param list folders: The list of folders to include (otherwise all folders) e.g. ['anat', 'func']
-        :param **kwargs: Additional arguments to pass to download_bids_dir
+        :param ``**kwargs``: Additional arguments to pass to ``download_bids_dir``
         :return: The absolute path to the downloaded bids directory
         :rtype: str
         """

flywheel/models/__init__.py

@@ -483,6 +483,7 @@ from flywheel.models.project_upsert_origin import ProjectUpsertOrigin
 from flywheel.models.provider import Provider
 from flywheel.models.provider_access_type import ProviderAccessType
 from flywheel.models.provider_class import ProviderClass
+from flywheel.models.provider_deletion_status import ProviderDeletionStatus
 from flywheel.models.provider_input import ProviderInput
 from flywheel.models.provider_links import ProviderLinks
 from flywheel.models.provider_type import ProviderType
@@ -532,6 +533,7 @@ from flywheel.models.roles_role_assignment import RolesRoleAssignment
 from flywheel.models.roles_role_input import RolesRoleInput
 from flywheel.models.rule import Rule
 from flywheel.models.rule_any import RuleAny
+from flywheel.models.s3_addressing_style import S3AddressingStyle
 from flywheel.models.s3_compat_storage import S3CompatStorage
 from flywheel.models.save_search import SaveSearch
 from flywheel.models.save_search_input import SaveSearchInput

flywheel/models/auth0_auth_out.py

@@ -28,7 +28,8 @@ class Auth0AuthOut(object):
         'audience': 'list[str]',
         'claim_namespace': 'str',
         'jwks': 'dict(str, object)',
-        'options': 'Auth0OptionsOut'
+        'options': 'Auth0OptionsOut',
+        'cookie_domain': 'str'
     }
 
     attribute_map = {
@@ -37,7 +38,8 @@ class Auth0AuthOut(object):
         'audience': 'audience',
         'claim_namespace': 'claim_namespace',
         'jwks': 'jwks',
-        'options': 'options'
+        'options': 'options',
+        'cookie_domain': 'cookie_domain'
     }
 
     rattribute_map = {
@@ -46,10 +48,11 @@ class Auth0AuthOut(object):
         'audience': 'audience',
         'claim_namespace': 'claim_namespace',
         'jwks': 'jwks',
-        'options': 'options'
+        'options': 'options',
+        'cookie_domain': 'cookie_domain'
     }
 
-    def __init__(self, client_id=None, domain=None, audience=None, claim_namespace=None, jwks=None, options=None):  # noqa: E501
+    def __init__(self, client_id=None, domain=None, audience=None, claim_namespace=None, jwks=None, options=None, cookie_domain=None):  # noqa: E501
         """Auth0AuthOut - a model defined in Swagger"""
         super(Auth0AuthOut, self).__init__()
 
@@ -59,6 +62,7 @@ class Auth0AuthOut(object):
         self._claim_namespace = None
         self._jwks = None
         self._options = None
+        self._cookie_domain = None
         self.discriminator = None
         self.alt_discriminator = None
 
@@ -68,6 +72,8 @@ class Auth0AuthOut(object):
         self.claim_namespace = claim_namespace
         self.jwks = jwks
         self.options = options
+        if cookie_domain is not None:
+            self.cookie_domain = cookie_domain
 
     @property
     def client_id(self):
@@ -195,6 +201,27 @@ class Auth0AuthOut(object):
 
         self._options = options
 
+    @property
+    def cookie_domain(self):
+        """Gets the cookie_domain of this Auth0AuthOut.
+
+
+        :return: The cookie_domain of this Auth0AuthOut.
+        :rtype: str
+        """
+        return self._cookie_domain
+
+    @cookie_domain.setter
+    def cookie_domain(self, cookie_domain):
+        """Sets the cookie_domain of this Auth0AuthOut.
+
+
+        :param cookie_domain: The cookie_domain of this Auth0AuthOut.  # noqa: E501
+        :type: str
+        """
+
+        self._cookie_domain = cookie_domain
+
 
     @staticmethod
     def positional_to_model(value):