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

flywheel/api/site_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 SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param IngressProvider body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressProviderId
+        :param body:
+        :type body: IngressProvider
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressProviderId
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -61,9 +56,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param IngressProvider body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressProviderId
+        :param body:
+        :type body: IngressProvider
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressProviderId
         """
 
         all_params = ['body',]  # noqa: E501
@@ -142,9 +139,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param GearRuleInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: GearRule
+        :param body:
+        :type body: GearRuleInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: GearRule
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -167,9 +166,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param GearRuleInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: GearRule
+        :param body:
+        :type body: GearRuleInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: GearRule
         """
 
         all_params = ['body',]  # noqa: E501
@@ -249,9 +250,11 @@ 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 str provider_id: The ID of the provider (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param provider_id: The ID of the provider
+        :type provider_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
@@ -275,9 +278,11 @@ 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 str provider_id: The ID of the provider (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param provider_id: The ID of the provider
+        :type provider_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['provider_id',]  # noqa: E501
@@ -345,8 +350,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: list[Bookmark]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[Bookmark]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -369,8 +375,9 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: list[Bookmark]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[Bookmark]
         """
 
         all_params = []  # noqa: E501
@@ -433,9 +440,11 @@ class SiteApi(object):
         Return the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param str provider_id: The ID of the provider (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressProvider
+        :param provider_id: The ID of the provider
+        :type provider_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressProvider
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -459,9 +468,11 @@ class SiteApi(object):
         Return the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param str provider_id: The ID of the provider (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressProvider
+        :param provider_id: The ID of the provider
+        :type provider_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressProvider
         """
 
         all_params = ['provider_id',]  # noqa: E501
@@ -530,9 +541,11 @@ 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 str provider_id: The ID of the provider (required)
-        :param bool async_: Perform the request asynchronously
-        :return: object
+        :param provider_id: The ID of the provider
+        :type provider_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: object
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -556,9 +569,11 @@ 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 str provider_id: The ID of the provider (required)
-        :param bool async_: Perform the request asynchronously
-        :return: object
+        :param provider_id: The ID of the provider
+        :type provider_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: object
         """
 
         all_params = ['provider_id',]  # noqa: E501
@@ -627,15 +642,23 @@ class SiteApi(object):
         Return a list of all providers on the site
         This method makes a synchronous HTTP request by default.
 
-        :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]
+        :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]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -659,15 +682,23 @@ class SiteApi(object):
         Return a list of all providers on the site
         This method makes a synchronous HTTP request by default.
 
-        :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]
+        :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]
         """
 
         all_params = ['_class','filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -743,9 +774,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str rule_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: GearRule
+        :param rule_id:
+        :type rule_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: GearRule
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -768,9 +801,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str rule_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: GearRule
+        :param rule_id:
+        :type rule_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: GearRule
         """
 
         all_params = ['rule_id',]  # noqa: E501
@@ -838,11 +873,15 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param int limit:
-        :param str after_id:
-        :param str name:
-        :param bool async_: Perform the request asynchronously
-        :return: list[GearRule]
+        :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]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -865,11 +904,15 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param int limit:
-        :param str after_id:
-        :param str name:
-        :param bool async_: Perform the request asynchronously
-        :return: list[GearRule]
+        :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]
         """
 
         all_params = ['limit','after_id','name',]  # noqa: E501
@@ -938,8 +981,9 @@ 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 bool async_: Perform the request asynchronously
-        :return: SiteSettings
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SiteSettings
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -963,8 +1007,9 @@ 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 bool async_: Perform the request asynchronously
-        :return: SiteSettings
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SiteSettings
         """
 
         all_params = []  # noqa: E501
@@ -1026,9 +1071,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param list[Bookmark] body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: list[Bookmark]
+        :param body:
+        :type body: list[Bookmark]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[Bookmark]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1051,9 +1098,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param list[Bookmark] body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: list[Bookmark]
+        :param body:
+        :type body: list[Bookmark]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[Bookmark]
         """
 
         all_params = ['body',]  # noqa: E501
@@ -1126,10 +1175,13 @@ class SiteApi(object):
         Update the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param str provider_id: The ID of the provider (required)
-        :param IngressUpdateProvider body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressProvider
+        :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
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1153,10 +1205,13 @@ class SiteApi(object):
         Update the provider identified by ProviderId
         This method makes a synchronous HTTP request by default.
 
-        :param str provider_id: The ID of the provider (required)
-        :param IngressUpdateProvider body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressProvider
+        :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
         """
 
         all_params = ['provider_id','body',]  # noqa: E501
@@ -1241,10 +1296,13 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str rule_id: (required)
-        :param GearRuleModifyInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: GearRule
+        :param rule_id:
+        :type rule_id: str
+        :param body:
+        :type body: GearRuleModifyInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: GearRule
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1267,10 +1325,13 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str rule_id: (required)
-        :param GearRuleModifyInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: GearRule
+        :param rule_id:
+        :type rule_id: str
+        :param body:
+        :type body: GearRuleModifyInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: GearRule
         """
 
         all_params = ['rule_id','body',]  # noqa: E501
@@ -1355,9 +1416,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param IngressSiteSettings body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SiteSettings
+        :param body:
+        :type body: IngressSiteSettings
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SiteSettings
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1380,9 +1443,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param IngressSiteSettings body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: SiteSettings
+        :param body:
+        :type body: IngressSiteSettings
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: SiteSettings
         """
 
         all_params = ['body',]  # noqa: E501
@@ -1461,9 +1526,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str rule_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param rule_id:
+        :type rule_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
@@ -1486,9 +1553,11 @@ class SiteApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str rule_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param rule_id:
+        :type rule_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['rule_id',]  # noqa: E501