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

flywheel/api/site_api.py

@@ -29,11 +29,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: IngressProvider
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressProviderId
+        :param IngressProvider body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressProviderId
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -56,11 +54,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: IngressProvider
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressProviderId
+        :param IngressProvider body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressProviderId
         """
 
         all_params = ['body',]  # noqa: E501
@@ -139,11 +135,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: GearRuleInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: GearRule
+        :param GearRuleInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: GearRule
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -166,11 +160,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: GearRuleInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: GearRule
+        :param GearRuleInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: GearRule
         """
 
         all_params = ['body',]  # noqa: E501
@@ -250,11 +242,9 @@ class SiteApi(object):
         Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the `get_provider` operation to check the deletion status.
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str provider_id: The ID of the provider (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
@@ -278,11 +268,9 @@ class SiteApi(object):
         Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the `get_provider` operation to check the deletion status.
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['provider_id',]  # noqa: E501
@@ -350,9 +338,8 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[Bookmark]
+        :param bool async_: Perform the request asynchronously
+        :return: list[Bookmark]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -375,9 +362,8 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[Bookmark]
+        :param bool async_: Perform the request asynchronously
+        :return: list[Bookmark]
         """
 
         all_params = []  # noqa: E501
@@ -440,11 +426,9 @@ class SiteApi(object):
         Return the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressProvider
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressProvider
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -468,11 +452,9 @@ class SiteApi(object):
         Return the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressProvider
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressProvider
         """
 
         all_params = ['provider_id',]  # noqa: E501
@@ -541,11 +523,9 @@ class SiteApi(object):
         The returned configuration will be redacted, with any privileged values replaced with null.
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: object
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: object
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -569,11 +549,9 @@ class SiteApi(object):
         The returned configuration will be redacted, with any privileged values replaced with null.
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: object
+        :param str provider_id: The ID of the provider (required)
+        :param bool async_: Perform the request asynchronously
+        :return: object
         """
 
         all_params = ['provider_id',]  # noqa: E501
@@ -642,23 +620,15 @@ class SiteApi(object):
         Return a list of all providers on the site
         This method makes a synchronous HTTP request by default.
 
-        :param _class: Limit the response to the given provider class
-        :type _class: ProviderClass, optional
-        :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: list[EgressProvider]
+        :param ProviderClass _class: Limit the response to the given provider class
+        :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: list[EgressProvider]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -682,23 +652,15 @@ class SiteApi(object):
         Return a list of all providers on the site
         This method makes a synchronous HTTP request by default.
 
-        :param _class: Limit the response to the given provider class
-        :type _class: ProviderClass, optional
-        :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: list[EgressProvider]
+        :param ProviderClass _class: Limit the response to the given provider class
+        :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: list[EgressProvider]
         """
 
         all_params = ['_class','filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -774,11 +736,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param rule_id:
-        :type rule_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: GearRule
+        :param str rule_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: GearRule
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -801,11 +761,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param rule_id:
-        :type rule_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: GearRule
+        :param str rule_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: GearRule
         """
 
         all_params = ['rule_id',]  # noqa: E501
@@ -873,15 +831,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param limit:
-        :type limit: int, optional
-        :param after_id:
-        :type after_id: str, optional
-        :param name:
-        :type name: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[GearRule]
+        :param int limit:
+        :param str after_id:
+        :param str name:
+        :param bool async_: Perform the request asynchronously
+        :return: list[GearRule]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -904,15 +858,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param limit:
-        :type limit: int, optional
-        :param after_id:
-        :type after_id: str, optional
-        :param name:
-        :type name: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[GearRule]
+        :param int limit:
+        :param str after_id:
+        :param str name:
+        :param bool async_: Perform the request asynchronously
+        :return: list[GearRule]
         """
 
         all_params = ['limit','after_id','name',]  # noqa: E501
@@ -981,9 +931,8 @@ class SiteApi(object):
         Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SiteSettings
+        :param bool async_: Perform the request asynchronously
+        :return: SiteSettings
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1007,9 +956,8 @@ class SiteApi(object):
         Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SiteSettings
+        :param bool async_: Perform the request asynchronously
+        :return: SiteSettings
         """
 
         all_params = []  # noqa: E501
@@ -1071,11 +1019,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: list[Bookmark]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[Bookmark]
+        :param list[Bookmark] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[Bookmark]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1098,11 +1044,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: list[Bookmark]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[Bookmark]
+        :param list[Bookmark] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: list[Bookmark]
         """
 
         all_params = ['body',]  # noqa: E501
@@ -1175,13 +1119,10 @@ class SiteApi(object):
         Update the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param body:
-        :type body: IngressUpdateProvider
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressProvider
+        :param str provider_id: The ID of the provider (required)
+        :param IngressUpdateProvider body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressProvider
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1205,13 +1146,10 @@ class SiteApi(object):
         Update the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param provider_id: The ID of the provider
-        :type provider_id: str
-        :param body:
-        :type body: IngressUpdateProvider
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressProvider
+        :param str provider_id: The ID of the provider (required)
+        :param IngressUpdateProvider body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressProvider
         """
 
         all_params = ['provider_id','body',]  # noqa: E501
@@ -1296,13 +1234,10 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param rule_id:
-        :type rule_id: str
-        :param body:
-        :type body: GearRuleModifyInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: GearRule
+        :param str rule_id: (required)
+        :param GearRuleModifyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: GearRule
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1325,13 +1260,10 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param rule_id:
-        :type rule_id: str
-        :param body:
-        :type body: GearRuleModifyInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: GearRule
+        :param str rule_id: (required)
+        :param GearRuleModifyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: GearRule
         """
 
         all_params = ['rule_id','body',]  # noqa: E501
@@ -1416,11 +1348,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: IngressSiteSettings
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SiteSettings
+        :param IngressSiteSettings body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: SiteSettings
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1443,11 +1373,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: IngressSiteSettings
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: SiteSettings
+        :param IngressSiteSettings body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: SiteSettings
         """
 
         all_params = ['body',]  # noqa: E501
@@ -1526,11 +1454,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param rule_id:
-        :type rule_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str rule_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
@@ -1553,11 +1479,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param rule_id:
-        :type rule_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str rule_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['rule_id',]  # noqa: E501