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

flywheel/api/roles_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
 """
 
 
@@ -36,9 +29,11 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param RoleInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: RoleOutput
+        :param body:
+        :type body: RoleInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: RoleOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -61,9 +56,11 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param RoleInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: RoleOutput
+        :param body:
+        :type body: RoleInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: RoleOutput
         """
 
         all_params = ['body',]  # noqa: E501
@@ -142,9 +139,11 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str role_id: The ID of the role (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param role_id: The ID of the role
+        :type role_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
@@ -167,9 +166,11 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str role_id: The ID of the role (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param role_id: The ID of the role
+        :type role_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['role_id',]  # noqa: E501
@@ -237,15 +238,23 @@ class RolesApi(object):
 
         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 list[str] x_accept_feature:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[RoleOutput],Page]
+        :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 x_accept_feature:, defaults to []
+        :type x_accept_feature: list[str], optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[RoleOutput],Page]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -268,15 +277,23 @@ class RolesApi(object):
 
         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 list[str] x_accept_feature:
-        :param bool async_: Perform the request asynchronously
-        :return: union[list[RoleOutput],Page]
+        :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 x_accept_feature:, defaults to []
+        :type x_accept_feature: list[str], optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[list[RoleOutput],Page]
         """
 
         all_params = ['filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -353,9 +370,11 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str role_id: The ID of the role (required)
-        :param bool async_: Perform the request asynchronously
-        :return: RoleOutput
+        :param role_id: The ID of the role
+        :type role_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: RoleOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -378,9 +397,11 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str role_id: The ID of the role (required)
-        :param bool async_: Perform the request asynchronously
-        :return: RoleOutput
+        :param role_id: The ID of the role
+        :type role_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: RoleOutput
         """
 
         all_params = ['role_id',]  # noqa: E501
@@ -448,11 +469,15 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str role_id: (required)
-        :param RoleUpdate body: (required)
-        :param list[union[HeaderFeature,str]] x_accept_feature:
-        :param bool async_: Perform the request asynchronously
-        :return: RoleOutput
+        :param role_id:
+        :type role_id: str
+        :param body:
+        :type body: RoleUpdate
+        :param x_accept_feature:, defaults to []
+        :type x_accept_feature: list[union[HeaderFeature,str]], optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: RoleOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -475,11 +500,15 @@ class RolesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str role_id: (required)
-        :param RoleUpdate body: (required)
-        :param list[union[HeaderFeature,str]] x_accept_feature:
-        :param bool async_: Perform the request asynchronously
-        :return: RoleOutput
+        :param role_id:
+        :type role_id: str
+        :param body:
+        :type body: RoleUpdate
+        :param x_accept_feature:, defaults to []
+        :type x_accept_feature: list[union[HeaderFeature,str]], optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: RoleOutput
         """
 
         all_params = ['role_id','body','x_accept_feature',]  # noqa: E501