flywheel-sdk 20.1.0__py2.py3-none-any.whl → 20.2.0rc0__py2.py3-none-any.whl

flywheel/api/container_type_api.py

@@ -0,0 +1,135 @@
+# 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
+"""
+
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from flywheel.api_client import ApiClient
+import flywheel.models
+
+# NOTE: This file is auto generated by the swagger code generator program.
+# Do not edit the class manually.
+
+class ContainerTypeApi(object):
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def cleanup_info(self, container_type, path, **kwargs):  # noqa: E501
+        """Remove a custom field from all applicable containers
+
+        Clean up a custom field from all containers of a type.
+        This method makes a synchronous HTTP request by default.
+
+        :param InfoContainerType container_type: (required)
+        :param str path: The dot-separated custom field name to delete (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.cleanup_info_with_http_info(container_type, path, **kwargs)  # noqa: E501
+        else:
+            (data) = self.cleanup_info_with_http_info(container_type, path, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def cleanup_info_with_http_info(self, container_type, path, **kwargs):  # noqa: E501
+        """Remove a custom field from all applicable containers
+
+        Clean up a custom field from all containers of a type.
+        This method makes a synchronous HTTP request by default.
+
+        :param InfoContainerType container_type: (required)
+        :param str path: The dot-separated custom field name to delete (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
+        """
+
+        all_params = ['container_type','path',]  # 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 cleanup_info" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'container_type' is set
+        if ('container_type' not in params or
+                params['container_type'] is None):
+            raise ValueError("Missing the required parameter `container_type` when calling `cleanup_info`")  # noqa: E501
+        # verify the required parameter 'path' is set
+        if ('path' not in params or
+                params['path'] is None):
+            raise ValueError("Missing the required parameter `path` when calling `cleanup_info`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'container_type' in params:
+            path_params['container_type'] = params['container_type']  # noqa: E501
+        if 'path' in params:
+            path_params['path'] = params['path']  # 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(
+            '/{container_type}/info/cleanup/{path}', 'PATCH',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ModifiedResult',  # 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)

flywheel/api/dataexplorer_api.py

@@ -352,6 +352,96 @@ class DataexplorerApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def get_mapped_fields(self, **kwargs):  # noqa: E501
+        """Get fields mapped for search
+
+        This method makes a synchronous HTTP request by default.
+
+        :param str path: Dot-separated subfield to drill down to
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_mapped_fields_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_mapped_fields_with_http_info(**kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def get_mapped_fields_with_http_info(self, **kwargs):  # noqa: E501
+        """Get fields mapped for search
+
+        This method makes a synchronous HTTP request by default.
+
+        :param str path: Dot-separated subfield to drill down to
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+
+        all_params = ['path',]  # 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 get_mapped_fields" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'path' in params:
+            query_params.append(('path', params['path']))  # noqa: E501
+
+        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(
+            '/dataexplorer/mapped_fields', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='object',  # 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_saved_search(self, sid, **kwargs):  # noqa: E501
         """Return a saved search query
 

flywheel/api/files_api.py

@@ -770,6 +770,106 @@ class FilesApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def get_file_info(self, file_id, **kwargs):  # noqa: E501
+        """Get Info
+
+        Get info dict for any file version. Returns:     dict of key/value pairs
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param int version:
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_file_info_with_http_info(file_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_file_info_with_http_info(file_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def get_file_info_with_http_info(self, file_id, **kwargs):  # noqa: E501
+        """Get Info
+
+        Get info dict for any file version. Returns:     dict of key/value pairs
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param int version:
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+
+        all_params = ['file_id','version',]  # 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 get_file_info" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'file_id' is set
+        if ('file_id' not in params or
+                params['file_id'] is None):
+            raise ValueError("Missing the required parameter `file_id` when calling `get_file_info`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'file_id' in params:
+            path_params['file_id'] = params['file_id']  # noqa: E501
+
+        query_params = []
+        if 'version' in params:
+            query_params.append(('version', params['version']))  # noqa: E501
+
+        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(
+            '/files/{file_id}/info', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='object',  # 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_file_tags(self, file_id, **kwargs):  # noqa: E501
         """Return a file tags, from any version
 
@@ -1070,6 +1170,232 @@ class FilesApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def modify_file_classification(self, file_id, body, **kwargs):  # noqa: E501
+        """Modify Classification
+
+        Modify classification of most recent file version
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param FileClassificationDelta body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.modify_file_classification_with_http_info(file_id, body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.modify_file_classification_with_http_info(file_id, body, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def modify_file_classification_with_http_info(self, file_id, body, **kwargs):  # noqa: E501
+        """Modify Classification
+
+        Modify classification of most recent file version
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param FileClassificationDelta body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
+        """
+
+        all_params = ['file_id','body',]  # 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 modify_file_classification" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'file_id' is set
+        if ('file_id' not in params or
+                params['file_id'] is None):
+            raise ValueError("Missing the required parameter `file_id` when calling `modify_file_classification`")  # noqa: E501
+        # 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 `modify_file_classification`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'file_id' in params:
+            path_params['file_id'] = params['file_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'FileClassificationDelta'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.FileClassificationDelta.positional_to_model(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(
+            '/files/{file_id}/classification', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ModifiedResult',  # 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 modify_file_info(self, file_id, **kwargs):  # noqa: E501
+        """Modify Info
+
+        Add info to most recent file version, adding items or replacing some existing ones. Parameters:     info (dict) -- key/value pairs to add Returns:     dict added
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param object body:
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.modify_file_info_with_http_info(file_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.modify_file_info_with_http_info(file_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def modify_file_info_with_http_info(self, file_id, **kwargs):  # noqa: E501
+        """Modify Info
+
+        Add info to most recent file version, adding items or replacing some existing ones. Parameters:     info (dict) -- key/value pairs to add Returns:     dict added
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param object body:
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
+        """
+
+        all_params = ['file_id','body',]  # 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 modify_file_info" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'file_id' is set
+        if ('file_id' not in params or
+                params['file_id'] is None):
+            raise ValueError("Missing the required parameter `file_id` when calling `modify_file_info`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'file_id' in params:
+            path_params['file_id'] = params['file_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'object'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.object.positional_to_model(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(
+            '/files/{file_id}/info', 'PATCH',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ModifiedResult',  # 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 move_file(self, file_id, body, **kwargs):  # noqa: E501
         """Move and/or rename a file
 
@@ -1185,6 +1511,117 @@ class FilesApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def replace_file_info(self, file_id, **kwargs):  # noqa: E501
+        """Replace Info
+
+        Add info to most recent file version, replacing all existing values. Parameters:     info (dict) -- all key/value pairs to populate info Returns:     dict added
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param object body:
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.replace_file_info_with_http_info(file_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.replace_file_info_with_http_info(file_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def replace_file_info_with_http_info(self, file_id, **kwargs):  # noqa: E501
+        """Replace Info
+
+        Add info to most recent file version, replacing all existing values. Parameters:     info (dict) -- all key/value pairs to populate info Returns:     dict added
+        This method makes a synchronous HTTP request by default.
+
+        :param str file_id: (required)
+        :param object body:
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+
+        all_params = ['file_id','body',]  # 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 replace_file_info" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'file_id' is set
+        if ('file_id' not in params or
+                params['file_id'] is None):
+            raise ValueError("Missing the required parameter `file_id` when calling `replace_file_info`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'file_id' in params:
+            path_params['file_id'] = params['file_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'object'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.object.positional_to_model(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(
+            '/files/{file_id}/info', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='object',  # 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 restore_file(self, file_id, version, evaluate_gear_rules, **kwargs):  # noqa: E501
         """Restore a File