flywheel-sdk 21.2.0__py3-none-any.whl

flywheel/api/config_api.py

@@ -0,0 +1,299 @@
+# 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
+from flywheel.util import check_filename_params
+
+# NOTE: This file is auto generated by the swagger code generator program.
+# Do not edit the class manually.
+
+class ConfigApi(object):
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_config(self, **kwargs):  # noqa: E501
+        """Get public configuration
+
+        return config dict
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async_: Perform the request asynchronously
+        :return: ConfigOut
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_config_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_config_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_config_with_http_info(self, **kwargs):  # noqa: E501
+        """Get public configuration
+
+        return config dict
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async_: Perform the request asynchronously
+        :return: ConfigOut
+        """
+
+        all_params = []  # 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_config" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+
+        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(
+            '/config', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ConfigOut',  # 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_config_js(self, **kwargs):  # noqa: E501
+        """Return public Scitran configuration information in javascript format.
+
+        return config as a JavaScript string assignment
+        This method makes a synchronous HTTP request by default.
+
+        :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_config_js_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_config_js_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_config_js_with_http_info(self, **kwargs):  # noqa: E501
+        """Return public Scitran configuration information in javascript format.
+
+        return config as a JavaScript string assignment
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async_: Perform the request asynchronously
+        :return: object
+        """
+
+        all_params = []  # 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_config_js" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+
+        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/javascript'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/config.js', '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_version(self, **kwargs):  # noqa: E501
+        """Get server and database schema version info
+
+        return database version dict
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async_: Perform the request asynchronously
+        :return: Version
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_version_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_version_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_version_with_http_info(self, **kwargs):  # noqa: E501
+        """Get server and database schema version info
+
+        return database version dict
+        This method makes a synchronous HTTP request by default.
+
+        :param bool async_: Perform the request asynchronously
+        :return: Version
+        """
+
+        all_params = []  # 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_version" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+
+        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(
+            '/version', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Version',  # 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/container_tasks_api.py

@@ -0,0 +1,137 @@
+# 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
+from flywheel.util import check_filename_params
+
+# NOTE: This file is auto generated by the swagger code generator program.
+# Do not edit the class manually.
+
+class ContainerTasksApi(object):
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_task_parent_container_ids(self, ids, container_type, **kwargs):  # noqa: E501
+        """Get Task Parent Container Ids
+
+        Get the list of container IDs that have tasks associated with them.
+        This method makes a synchronous HTTP request by default.
+
+        :param str ids: Comma separated list of container IDs (required)
+        :param ContainerType container_type: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[str]
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.get_task_parent_container_ids_with_http_info(ids, container_type, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_task_parent_container_ids_with_http_info(ids, container_type, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def get_task_parent_container_ids_with_http_info(self, ids, container_type, **kwargs):  # noqa: E501
+        """Get Task Parent Container Ids
+
+        Get the list of container IDs that have tasks associated with them.
+        This method makes a synchronous HTTP request by default.
+
+        :param str ids: Comma separated list of container IDs (required)
+        :param ContainerType container_type: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[str]
+        """
+
+        all_params = ['ids','container_type',]  # 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_task_parent_container_ids" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'ids' is set
+        if ('ids' not in params or
+                params['ids'] is None):
+            raise ValueError("Missing the required parameter `ids` when calling `get_task_parent_container_ids`")  # noqa: E501
+        # 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 `get_task_parent_container_ids`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'container_type' in params:
+            path_params['container_type'] = params['container_type']  # noqa: E501
+
+        query_params = []
+        if 'ids' in params:
+            query_params.append(('ids', params['ids']))  # 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(
+            '/tasks/{container_type}s/ids', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[str]',  # 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/container_type_api.py

@@ -0,0 +1,137 @@
+# 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
+from flywheel.util import check_filename_params
+
+# 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
+        check_filename_params(params)
+
+        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)