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

flywheel/api/protocols_api.py

@@ -30,11 +30,9 @@ class ProtocolsApi(object):
         Archive a protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :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
@@ -58,11 +56,9 @@ class ProtocolsApi(object):
         Archive a protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
         """
 
         all_params = ['protocol_id',]  # noqa: E501
@@ -131,11 +127,9 @@ class ProtocolsApi(object):
         Create a new protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ProtocolInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :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
@@ -159,11 +153,9 @@ class ProtocolsApi(object):
         Create a new protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ProtocolInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :param ProtocolInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
         """
 
         all_params = ['body',]  # noqa: E501
@@ -243,11 +235,9 @@ class ProtocolsApi(object):
         Delete a protocol
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :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
@@ -271,11 +261,9 @@ class ProtocolsApi(object):
         Delete a protocol
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['protocol_id',]  # noqa: E501
@@ -344,21 +332,14 @@ class ProtocolsApi(object):
         Get a paginated list of protocols.
         This method makes a synchronous HTTP request by default.
 
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: PageGenericProtocol
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (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
@@ -382,21 +363,14 @@ class ProtocolsApi(object):
         Get a paginated list of protocols.
         This method makes a synchronous HTTP request by default.
 
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: PageGenericProtocol
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (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
@@ -471,11 +445,9 @@ class ProtocolsApi(object):
         Get protocol by id.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :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
@@ -499,11 +471,9 @@ class ProtocolsApi(object):
         Get protocol by id.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
         """
 
         all_params = ['protocol_id',]  # noqa: E501
@@ -572,13 +542,10 @@ class ProtocolsApi(object):
         Modify a protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param body:
-        :type body: ProtocolModify
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :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
@@ -602,13 +569,10 @@ class ProtocolsApi(object):
         Modify a protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param body:
-        :type body: ProtocolModify
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :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
@@ -694,11 +658,9 @@ class ProtocolsApi(object):
         Publish a protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :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
@@ -722,11 +684,9 @@ class ProtocolsApi(object):
         Publish a protocol.
         This method makes a synchronous HTTP request by default.
 
-        :param protocol_id:
-        :type protocol_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Protocol
+        :param str protocol_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Protocol
         """
 
         all_params = ['protocol_id',]  # noqa: E501