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

flywheel/api/staffing_pools_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 StaffingPoolsApi(object):
         Create a staffing pool.
         This method makes a synchronous HTTP request by default.
 
-        :param StaffingPoolCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StaffingPool
+        :param body:
+        :type body: StaffingPoolCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StaffingPool
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ class StaffingPoolsApi(object):
         Create a staffing pool.
         This method makes a synchronous HTTP request by default.
 
-        :param StaffingPoolCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StaffingPool
+        :param body:
+        :type body: StaffingPoolCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StaffingPool
         """
 
         all_params = ['body',]  # noqa: E501
@@ -145,9 +142,11 @@ class StaffingPoolsApi(object):
         Delete a staffing pool by id.
         This method makes a synchronous HTTP request by default.
 
-        :param str pool_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param pool_id:
+        :type pool_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -171,9 +170,11 @@ class StaffingPoolsApi(object):
         Delete a staffing pool by id.
         This method makes a synchronous HTTP request by default.
 
-        :param str pool_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param pool_id:
+        :type pool_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
 
         all_params = ['pool_id',]  # noqa: E501
@@ -241,14 +242,21 @@ class StaffingPoolsApi(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 bool async_: Perform the request asynchronously
-        :return: PageGenericStaffingPool
+        :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: PageGenericStaffingPool
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -271,14 +279,21 @@ class StaffingPoolsApi(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 bool async_: Perform the request asynchronously
-        :return: PageGenericStaffingPool
+        :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: PageGenericStaffingPool
         """
 
         all_params = ['filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -353,9 +368,11 @@ class StaffingPoolsApi(object):
         Get a staffing pool by id.
         This method makes a synchronous HTTP request by default.
 
-        :param str pool_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StaffingPool
+        :param pool_id:
+        :type pool_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StaffingPool
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -379,9 +396,11 @@ class StaffingPoolsApi(object):
         Get a staffing pool by id.
         This method makes a synchronous HTTP request by default.
 
-        :param str pool_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StaffingPool
+        :param pool_id:
+        :type pool_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StaffingPool
         """
 
         all_params = ['pool_id',]  # noqa: E501
@@ -450,10 +469,13 @@ class StaffingPoolsApi(object):
         Modify a staffing pool.
         This method makes a synchronous HTTP request by default.
 
-        :param str pool_id: (required)
-        :param StaffingPoolModify body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StaffingPool
+        :param pool_id:
+        :type pool_id: str
+        :param body:
+        :type body: StaffingPoolModify
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StaffingPool
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -477,10 +499,13 @@ class StaffingPoolsApi(object):
         Modify a staffing pool.
         This method makes a synchronous HTTP request by default.
 
-        :param str pool_id: (required)
-        :param StaffingPoolModify body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: StaffingPool
+        :param pool_id:
+        :type pool_id: str
+        :param body:
+        :type body: StaffingPoolModify
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: StaffingPool
         """
 
         all_params = ['pool_id','body',]  # noqa: E501
@@ -566,10 +591,13 @@ class StaffingPoolsApi(object):
         Add a user to multiple staffing pools.
         This method makes a synchronous HTTP request by default.
 
-        :param str user_id: (required)
-        :param StaffingPoolList body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param user_id:
+        :type user_id: str
+        :param body:
+        :type body: StaffingPoolList
+        :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
@@ -593,10 +621,13 @@ class StaffingPoolsApi(object):
         Add a user to multiple staffing pools.
         This method makes a synchronous HTTP request by default.
 
-        :param str user_id: (required)
-        :param StaffingPoolList body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param user_id:
+        :type user_id: str
+        :param body:
+        :type body: StaffingPoolList
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['user_id','body',]  # noqa: E501