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

flywheel/api/protocols_api.py

@@ -1,13 +1,6 @@
 # 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
 """
 
 
@@ -37,9 +30,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
 
         all_params = ['protocol_id',]  # noqa: E501
@@ -134,9 +131,11 @@ class ProtocolsApi(object):
         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
+        :param body:
+        :type body: ProtocolInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -160,9 +159,11 @@ class ProtocolsApi(object):
         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
+        :param body:
+        :type body: ProtocolInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
 
         all_params = ['body',]  # noqa: E501
@@ -242,9 +243,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -268,9 +271,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['protocol_id',]  # noqa: E501
@@ -339,14 +344,21 @@ class ProtocolsApi(object):
         Get a paginated list of protocols.
         This method makes a synchronous HTTP request by default.
 
-        :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
+        :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
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -370,14 +382,21 @@ class ProtocolsApi(object):
         Get a paginated list of protocols.
         This method makes a synchronous HTTP request by default.
 
-        :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
+        :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
         """
 
         all_params = ['filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -452,9 +471,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -478,9 +499,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
 
         all_params = ['protocol_id',]  # noqa: E501
@@ -549,10 +572,13 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param body:
+        :type body: ProtocolModify
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -576,10 +602,13 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param body:
+        :type body: ProtocolModify
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
 
         all_params = ['protocol_id','body',]  # noqa: E501
@@ -665,9 +694,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -691,9 +722,11 @@ class ProtocolsApi(object):
         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
+        :param protocol_id:
+        :type protocol_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Protocol
         """
 
         all_params = ['protocol_id',]  # noqa: E501