def clear_with_http_info(self, app_id, **kwargs): # noqa: E501
"""Clear webhook settings # noqa: E501
Resets webhook target URL to empty, and max concurrency limit to `0` for the given app. This will effectively pause all webhook subscriptions until new settings are provided. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.clear_with_http_info(app_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int app_id: The ID of the target app. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["app_id"]
all_params.extend(
[
"async_req",
"_return_http_data_only",
"_preload_content",
"_request_timeout",
]
)
for key, val in six.iteritems(local_var_params["kwargs"]):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'" " to method clear" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'app_id' is set
if self.api_client.client_side_validation and (
"app_id" not in local_var_params
or local_var_params["app_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `app_id` when calling `clear`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "app_id" in local_var_params:
path_params["appId"] = local_var_params["app_id"] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["*/*"]
) # noqa: E501
# Authentication setting
auth_settings = ["hapikey"] # noqa: E501
return self.api_client.call_api(
"/webhooks/v3/{appId}/settings",
"DELETE",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get("async_req"),
_return_http_data_only=local_var_params.get(
"_return_http_data_only"
), # noqa: E501
_preload_content=local_var_params.get("_preload_content", True),
_request_timeout=local_var_params.get("_request_timeout"),
collection_formats=collection_formats,
)
def configure_with_http_info(
self, app_id, settings_change_request, **kwargs
): # noqa: E501
"""Configure webhook settings # noqa: E501
Used to set the webhook target URL and max concurrency limit for the given app. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.configure_with_http_info(app_id, settings_change_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int app_id: The ID of the target app. (required)
:param SettingsChangeRequest settings_change_request: Settings state to create new with or replace existing settings with. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SettingsResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["app_id", "settings_change_request"]
all_params.extend(
[
"async_req",
"_return_http_data_only",
"_preload_content",
"_request_timeout",
]
)
for key, val in six.iteritems(local_var_params["kwargs"]):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method configure" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'app_id' is set
if self.api_client.client_side_validation and (
"app_id" not in local_var_params
or local_var_params["app_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `app_id` when calling `configure`"
) # noqa: E501
# verify the required parameter 'settings_change_request' is set
if self.api_client.client_side_validation and (
"settings_change_request" not in local_var_params
or local_var_params["settings_change_request"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `settings_change_request` when calling `configure`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "app_id" in local_var_params:
path_params["appId"] = local_var_params["app_id"] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if "settings_change_request" in local_var_params:
body_params = local_var_params["settings_change_request"]
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["application/json", "*/*"]
) # noqa: E501
# HTTP header `Content-Type`
header_params[
"Content-Type"
] = self.api_client.select_header_content_type( # noqa: E501
["application/json"]
) # noqa: E501
# Authentication setting
auth_settings = ["hapikey"] # noqa: E501
return self.api_client.call_api(
"/webhooks/v3/{appId}/settings",
"PUT",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="SettingsResponse", # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get("async_req"),
_return_http_data_only=local_var_params.get(
"_return_http_data_only"
), # noqa: E501
_preload_content=local_var_params.get("_preload_content", True),
_request_timeout=local_var_params.get("_request_timeout"),
collection_formats=collection_formats,
)
def get_settings_with_http_info(self, app_id, **kwargs): # noqa: E501
"""Get webhook settings # noqa: E501
Returns the current state of webhook settings for the given app. These settings include the app's configured target URL and max concurrency limit. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_settings_with_http_info(app_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int app_id: The ID of the target app. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SettingsResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['app_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_settings" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'app_id' is set
if self.api_client.client_side_validation and ('app_id' not in local_var_params or # noqa: E501
local_var_params['app_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `app_id` when calling `get_settings`") # noqa: E501
collection_formats = {}
path_params = {}
if 'app_id' in local_var_params:
path_params['appId'] = local_var_params['app_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', '*/*']) # noqa: E501
# Authentication setting
auth_settings = ['hapikey'] # noqa: E501
return self.api_client.call_api(
'/webhooks/v3/{appId}/settings', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SettingsResponse', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def update_batch_with_http_info(
self, app_id, batch_input_subscription_batch_update_request,
**kwargs): # noqa: E501
"""Batch update subscriptions # noqa: E501
Activates or deactivates specified subscriptions for the given app. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_batch_with_http_info(app_id, batch_input_subscription_batch_update_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int app_id: The ID of the target app. (required)
:param BatchInputSubscriptionBatchUpdateRequest batch_input_subscription_batch_update_request: Collection of updated details for the specified subscription. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(BatchResponseSubscriptionResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'app_id', 'batch_input_subscription_batch_update_request'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method update_batch" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'app_id' is set
if self.api_client.client_side_validation and (
'app_id' not in local_var_params or # noqa: E501
local_var_params['app_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `app_id` when calling `update_batch`"
) # noqa: E501
# verify the required parameter 'batch_input_subscription_batch_update_request' is set
if self.api_client.client_side_validation and (
'batch_input_subscription_batch_update_request'
not in local_var_params or # noqa: E501
local_var_params[
'batch_input_subscription_batch_update_request'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `batch_input_subscription_batch_update_request` when calling `update_batch`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'app_id' in local_var_params:
path_params['appId'] = local_var_params['app_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'batch_input_subscription_batch_update_request' in local_var_params:
body_params = local_var_params[
'batch_input_subscription_batch_update_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', '*/*']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['hapikey'] # noqa: E501
return self.api_client.call_api(
'/webhooks/v3/{appId}/subscriptions/batch/update',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='BatchResponseSubscriptionResponse', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def archive_with_http_info(self, subscription_id, app_id,
**kwargs): # noqa: E501
"""Delete a subscription # noqa: E501
Permanently deletes a subscription. This cannot be undone. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.archive_with_http_info(subscription_id, app_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int subscription_id: The ID of subscription to delete. (required)
:param int app_id: The ID of the target app. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['subscription_id', 'app_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method archive" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'subscription_id' is set
if self.api_client.client_side_validation and (
'subscription_id' not in local_var_params or # noqa: E501
local_var_params['subscription_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `subscription_id` when calling `archive`"
) # noqa: E501
# verify the required parameter 'app_id' is set
if self.api_client.client_side_validation and (
'app_id' not in local_var_params or # noqa: E501
local_var_params['app_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `app_id` when calling `archive`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'subscription_id' in local_var_params:
path_params['subscriptionId'] = local_var_params[
'subscription_id'] # noqa: E501
if 'app_id' in local_var_params:
path_params['appId'] = local_var_params['app_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # noqa: E501
# Authentication setting
auth_settings = ['hapikey'] # noqa: E501
return self.api_client.call_api(
'/webhooks/v3/{appId}/subscriptions/{subscriptionId}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_by_id_with_http_info(self, app_id, subscription_id,
**kwargs): # noqa: E501
"""Get subscription # noqa: E501
Returns details about a subscription. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_by_id_with_http_info(app_id, subscription_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int app_id: The ID of the target app. (required)
:param int subscription_id: The ID of the target subscription. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SubscriptionResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["app_id", "subscription_id"] # noqa: E501
all_params.append("async_req")
all_params.append("_return_http_data_only")
all_params.append("_preload_content")
all_params.append("_request_timeout")
for key, val in six.iteritems(local_var_params["kwargs"]):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method get_by_id" % key)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'app_id' is set
if self.api_client.client_side_validation and (
"app_id" not in local_var_params
or local_var_params["app_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `app_id` when calling `get_by_id`"
) # noqa: E501
# verify the required parameter 'subscription_id' is set
if self.api_client.client_side_validation and (
"subscription_id" not in local_var_params
or local_var_params["subscription_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `subscription_id` when calling `get_by_id`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "app_id" in local_var_params:
path_params["appId"] = local_var_params["app_id"] # noqa: E501
if "subscription_id" in local_var_params:
path_params["subscriptionId"] = local_var_params[
"subscription_id"] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["application/json", "*/*"]) # noqa: E501
# Authentication setting
auth_settings = ["hapikey"] # noqa: E501
return self.api_client.call_api(
"/webhooks/v3/{appId}/subscriptions/{subscriptionId}",
"GET",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="SubscriptionResponse", # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get("async_req"),
_return_http_data_only=local_var_params.get(
"_return_http_data_only"), # noqa: E501
_preload_content=local_var_params.get("_preload_content", True),
_request_timeout=local_var_params.get("_request_timeout"),
collection_formats=collection_formats,
)
