flywheel-sdk 21.0.0__py2.py3-none-any.whl → 21.1.0__py2.py3-none-any.whl

flywheel/api/protocols_api.py

@@ -0,0 +1,757 @@
+# 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 ProtocolsApi(object):
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def archive_task_protocol(self, protocol_id, **kwargs):  # noqa: E501
+        """Archive
+
+        Archive a protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.archive_task_protocol_with_http_info(protocol_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.archive_task_protocol_with_http_info(protocol_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def archive_task_protocol_with_http_info(self, protocol_id, **kwargs):  # noqa: E501
+        """Archive
+
+        Archive a protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+
+        all_params = ['protocol_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 archive_task_protocol" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'protocol_id' is set
+        if ('protocol_id' not in params or
+                params['protocol_id'] is None):
+            raise ValueError("Missing the required parameter `protocol_id` when calling `archive_task_protocol`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'protocol_id' in params:
+            path_params['protocol_id'] = params['protocol_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(
+            '/protocols/{protocol_id}/archive', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Protocol',  # 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 create_task_protocol(self, body, **kwargs):  # noqa: E501
+        """Create
+
+        Create a new protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param ProtocolInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.create_task_protocol_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.create_task_protocol_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 create_task_protocol_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Create
+
+        Create a new protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param ProtocolInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+
+        all_params = ['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 create_task_protocol" % 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 `create_task_protocol`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'ProtocolInput'.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.ProtocolInput.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(
+            '/protocols', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Protocol',  # 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 delete_task_protocol(self, protocol_id, **kwargs):  # noqa: E501
+        """Delete
+
+        Delete a protocol
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (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_task_protocol_with_http_info(protocol_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_task_protocol_with_http_info(protocol_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_task_protocol_with_http_info(self, protocol_id, **kwargs):  # noqa: E501
+        """Delete
+
+        Delete a protocol
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
+        """
+
+        all_params = ['protocol_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_task_protocol" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'protocol_id' is set
+        if ('protocol_id' not in params or
+                params['protocol_id'] is None):
+            raise ValueError("Missing the required parameter `protocol_id` when calling `delete_task_protocol`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'protocol_id' in params:
+            path_params['protocol_id'] = params['protocol_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(
+            '/protocols/{protocol_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 find_task_protocols(self, **kwargs):  # noqa: E501
+        """Find All
+
+        Get a paginated list of protocols.
+        This method makes a synchronous HTTP request by default.
+
+        :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param bool async_: Perform the request asynchronously
+        :return: PageGenericProtocol
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.find_task_protocols_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.find_task_protocols_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 find_task_protocols_with_http_info(self, **kwargs):  # noqa: E501
+        """Find All
+
+        Get a paginated list of protocols.
+        This method makes a synchronous HTTP request by default.
+
+        :param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param bool async_: Perform the request asynchronously
+        :return: PageGenericProtocol
+        """
+
+        all_params = ['filter','sort','limit','skip','page','after_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 find_task_protocols" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'filter' in params:
+            query_params.append(('filter', params['filter']))  # noqa: E501
+        if 'sort' in params:
+            query_params.append(('sort', params['sort']))  # noqa: E501
+        if 'limit' in params:
+            query_params.append(('limit', params['limit']))  # noqa: E501
+        if 'skip' in params:
+            query_params.append(('skip', params['skip']))  # noqa: E501
+        if 'page' in params:
+            query_params.append(('page', params['page']))  # noqa: E501
+        if 'after_id' in params:
+            query_params.append(('after_id', params['after_id']))  # 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(
+            '/protocols', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='PageGenericProtocol',  # 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_task_protocol(self, protocol_id, **kwargs):  # noqa: E501
+        """Get By Id
+
+        Get protocol by id.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+        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_protocol_with_http_info(protocol_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_task_protocol_with_http_info(protocol_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_task_protocol_with_http_info(self, protocol_id, **kwargs):  # noqa: E501
+        """Get By Id
+
+        Get protocol by id.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+
+        all_params = ['protocol_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 get_task_protocol" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'protocol_id' is set
+        if ('protocol_id' not in params or
+                params['protocol_id'] is None):
+            raise ValueError("Missing the required parameter `protocol_id` when calling `get_task_protocol`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'protocol_id' in params:
+            path_params['protocol_id'] = params['protocol_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(
+            '/protocols/{protocol_id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Protocol',  # 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_task_protocol(self, protocol_id, body, **kwargs):  # noqa: E501
+        """Modify
+
+        Modify a protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param ProtocolModify body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.modify_task_protocol_with_http_info(protocol_id, body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.modify_task_protocol_with_http_info(protocol_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_task_protocol_with_http_info(self, protocol_id, body, **kwargs):  # noqa: E501
+        """Modify
+
+        Modify a protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param ProtocolModify body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+
+        all_params = ['protocol_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_task_protocol" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'protocol_id' is set
+        if ('protocol_id' not in params or
+                params['protocol_id'] is None):
+            raise ValueError("Missing the required parameter `protocol_id` when calling `modify_task_protocol`")  # 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_task_protocol`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'protocol_id' in params:
+            path_params['protocol_id'] = params['protocol_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'ProtocolModify'.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.ProtocolModify.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(
+            '/protocols/{protocol_id}', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Protocol',  # 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 publish_task_protocol(self, protocol_id, **kwargs):  # noqa: E501
+        """Publish
+
+        Publish a protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.publish_task_protocol_with_http_info(protocol_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.publish_task_protocol_with_http_info(protocol_id, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def publish_task_protocol_with_http_info(self, protocol_id, **kwargs):  # noqa: E501
+        """Publish
+
+        Publish a protocol.
+        This method makes a synchronous HTTP request by default.
+
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
+        """
+
+        all_params = ['protocol_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 publish_task_protocol" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'protocol_id' is set
+        if ('protocol_id' not in params or
+                params['protocol_id'] is None):
+            raise ValueError("Missing the required parameter `protocol_id` when calling `publish_task_protocol`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'protocol_id' in params:
+            path_params['protocol_id'] = params['protocol_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(
+            '/protocols/{protocol_id}/publish', 'PUT',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Protocol',  # 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)