Module mailslurp_client.api.webhook_controller_api
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Expand source code
# coding: utf-8
"""
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository # noqa: E501
The version of the OpenAPI document: 6.5.2
Contact: contact@mailslurp.dev
Generated by: https://openapi-generator.tech
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from mailslurp_client.api_client import ApiClient
from mailslurp_client.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
class WebhookControllerApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def create_account_webhook(self, create_webhook_options, **kwargs): # noqa: E501
"""Attach a WebHook URL to an inbox # noqa: E501
Get notified of account level events such as bounce and bounce recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_account_webhook(create_webhook_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CreateWebhookOptions create_webhook_options: (required)
: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: WebhookDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_account_webhook_with_http_info(create_webhook_options, **kwargs) # noqa: E501
def create_account_webhook_with_http_info(self, create_webhook_options, **kwargs): # noqa: E501
"""Attach a WebHook URL to an inbox # noqa: E501
Get notified of account level events such as bounce and bounce recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_account_webhook_with_http_info(create_webhook_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'create_webhook_options'
]
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 create_account_webhook" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'create_webhook_options' is set
if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501
local_var_params['create_webhook_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_account_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_webhook_options' in local_var_params:
body_params = local_var_params['create_webhook_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # 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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookDto', # 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 create_webhook(self, inbox_id, create_webhook_options, **kwargs): # noqa: E501
"""Attach a WebHook URL to an inbox # noqa: E501
Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook(inbox_id, create_webhook_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param CreateWebhookOptions create_webhook_options: (required)
: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: WebhookDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_webhook_with_http_info(inbox_id, create_webhook_options, **kwargs) # noqa: E501
def create_webhook_with_http_info(self, inbox_id, create_webhook_options, **kwargs): # noqa: E501
"""Attach a WebHook URL to an inbox # noqa: E501
Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook_with_http_info(inbox_id, create_webhook_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'create_webhook_options'
]
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 create_webhook" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `create_webhook`") # noqa: E501
# verify the required parameter 'create_webhook_options' is set
if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501
local_var_params['create_webhook_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_webhook_options' in local_var_params:
body_params = local_var_params['create_webhook_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # 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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/webhooks', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookDto', # 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 create_webhook_for_phone_number(self, phone_number_id, create_webhook_options, **kwargs): # noqa: E501
"""Attach a WebHook URL to a phone number # noqa: E501
Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook_for_phone_number(phone_number_id, create_webhook_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str phone_number_id: (required)
:param CreateWebhookOptions create_webhook_options: (required)
: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: WebhookDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, **kwargs) # noqa: E501
def create_webhook_for_phone_number_with_http_info(self, phone_number_id, create_webhook_options, **kwargs): # noqa: E501
"""Attach a WebHook URL to a phone number # noqa: E501
Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str phone_number_id: (required)
:param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'phone_number_id',
'create_webhook_options'
]
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 create_webhook_for_phone_number" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'phone_number_id' is set
if self.api_client.client_side_validation and ('phone_number_id' not in local_var_params or # noqa: E501
local_var_params['phone_number_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `phone_number_id` when calling `create_webhook_for_phone_number`") # noqa: E501
# verify the required parameter 'create_webhook_options' is set
if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501
local_var_params['create_webhook_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_webhook_for_phone_number`") # noqa: E501
collection_formats = {}
path_params = {}
if 'phone_number_id' in local_var_params:
path_params['phoneNumberId'] = local_var_params['phone_number_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_webhook_options' in local_var_params:
body_params = local_var_params['create_webhook_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # 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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/phone/numbers/{phoneNumberId}/webhooks', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookDto', # 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 delete_all_webhooks(self, **kwargs): # noqa: E501
"""Delete all webhooks # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_webhooks(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param datetime before: before
: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.
"""
kwargs['_return_http_data_only'] = True
return self.delete_all_webhooks_with_http_info(**kwargs) # noqa: E501
def delete_all_webhooks_with_http_info(self, **kwargs): # noqa: E501
"""Delete all webhooks # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_webhooks_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param datetime before: before
: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 = [
'before'
]
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 delete_all_webhooks" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks', '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 delete_webhook(self, inbox_id, webhook_id, **kwargs): # noqa: E501
"""Delete and disable a Webhook for an Inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook(inbox_id, webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param str webhook_id: (required)
: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.
"""
kwargs['_return_http_data_only'] = True
return self.delete_webhook_with_http_info(inbox_id, webhook_id, **kwargs) # noqa: E501
def delete_webhook_with_http_info(self, inbox_id, webhook_id, **kwargs): # noqa: E501
"""Delete and disable a Webhook for an Inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook_with_http_info(inbox_id, webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param str webhook_id: (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 = [
'inbox_id',
'webhook_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 delete_webhook" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `delete_webhook`") # noqa: E501
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `delete_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/webhooks/{webhookId}', '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 delete_webhook_by_id(self, webhook_id, **kwargs): # noqa: E501
"""Delete a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook_by_id(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
: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.
"""
kwargs['_return_http_data_only'] = True
return self.delete_webhook_by_id_with_http_info(webhook_id, **kwargs) # noqa: E501
def delete_webhook_by_id_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Delete a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook_by_id_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (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 = [
'webhook_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 delete_webhook_by_id" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `delete_webhook_by_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', '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_all_account_webhooks(self, **kwargs): # noqa: E501
"""List account webhooks Paginated # noqa: E501
List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size for paginated result list.
:param str sort: Optional createdAt sort direction ASC or DESC
:param str event_type: Optional event type
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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: PageWebhookProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_account_webhooks_with_http_info(**kwargs) # noqa: E501
def get_all_account_webhooks_with_http_info(self, **kwargs): # noqa: E501
"""List account webhooks Paginated # noqa: E501
List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size for paginated result list.
:param str sort: Optional createdAt sort direction ASC or DESC
:param str event_type: Optional event type
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'event_type',
'since',
'before'
]
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 get_all_account_webhooks" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] > 9223372036854775807: # noqa: E501
raise ApiValueError("Invalid value for parameter `page` when calling `get_all_account_webhooks`, must be a value less than or equal to `9223372036854775807`") # noqa: E501
if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501
raise ApiValueError("Invalid value for parameter `page` when calling `get_all_account_webhooks`, must be a value greater than or equal to `0`") # noqa: E501
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_all_account_webhooks`, must be a value less than or equal to `100`") # noqa: E501
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_all_account_webhooks`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'event_type' in local_var_params and local_var_params['event_type'] is not None: # noqa: E501
query_params.append(('eventType', local_var_params['event_type'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/account/paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageWebhookProjection', # 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_all_webhook_results(self, **kwargs): # noqa: E501
"""Get results for all webhooks # 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_all_webhook_results(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param bool unseen_only: Filter for unseen exceptions only
:param str result_type: Filter by result type
:param str event_name: Filter by event name
:param int min_status_code: Minimum response status
:param int max_status_code: Maximum response status
:param str inbox_id: Inbox ID
:param str sms_id: Sms ID
:param str attachment_id: Attachment ID
:param str email_id: Email ID
:param str phone_id: Phone ID
: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: PageWebhookResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_webhook_results_with_http_info(**kwargs) # noqa: E501
def get_all_webhook_results_with_http_info(self, **kwargs): # noqa: E501
"""Get results for all webhooks # 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_all_webhook_results_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param bool unseen_only: Filter for unseen exceptions only
:param str result_type: Filter by result type
:param str event_name: Filter by event name
:param int min_status_code: Minimum response status
:param int max_status_code: Maximum response status
:param str inbox_id: Inbox ID
:param str sms_id: Sms ID
:param str attachment_id: Attachment ID
:param str email_id: Email ID
:param str phone_id: Phone ID
: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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'search_filter',
'since',
'before',
'unseen_only',
'result_type',
'event_name',
'min_status_code',
'max_status_code',
'inbox_id',
'sms_id',
'attachment_id',
'email_id',
'phone_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 get_all_webhook_results" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
if 'unseen_only' in local_var_params and local_var_params['unseen_only'] is not None: # noqa: E501
query_params.append(('unseenOnly', local_var_params['unseen_only'])) # noqa: E501
if 'result_type' in local_var_params and local_var_params['result_type'] is not None: # noqa: E501
query_params.append(('resultType', local_var_params['result_type'])) # noqa: E501
if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501
query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501
if 'min_status_code' in local_var_params and local_var_params['min_status_code'] is not None: # noqa: E501
query_params.append(('minStatusCode', local_var_params['min_status_code'])) # noqa: E501
if 'max_status_code' in local_var_params and local_var_params['max_status_code'] is not None: # noqa: E501
query_params.append(('maxStatusCode', local_var_params['max_status_code'])) # noqa: E501
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501
query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501
if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501
query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501
if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501
query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501
if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501
query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/results', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageWebhookResult', # 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_all_webhooks(self, **kwargs): # noqa: E501
"""List Webhooks Paginated # noqa: E501
List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size for paginated result list.
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param str inbox_id: Filter by inboxId
:param str phone_id: Filter by phoneId
:param datetime before: Filter by created at before the given timestamp
: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: PageWebhookProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_webhooks_with_http_info(**kwargs) # noqa: E501
def get_all_webhooks_with_http_info(self, **kwargs): # noqa: E501
"""List Webhooks Paginated # noqa: E501
List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in list pagination
:param int size: Optional page size for paginated result list.
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param str inbox_id: Filter by inboxId
:param str phone_id: Filter by phoneId
:param datetime before: Filter by created at before the given timestamp
: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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'sort',
'search_filter',
'since',
'inbox_id',
'phone_id',
'before'
]
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 get_all_webhooks" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] > 9223372036854775807: # noqa: E501
raise ApiValueError("Invalid value for parameter `page` when calling `get_all_webhooks`, must be a value less than or equal to `9223372036854775807`") # noqa: E501
if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501
raise ApiValueError("Invalid value for parameter `page` when calling `get_all_webhooks`, must be a value greater than or equal to `0`") # noqa: E501
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_all_webhooks`, must be a value less than or equal to `100`") # noqa: E501
if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501
raise ApiValueError("Invalid value for parameter `size` when calling `get_all_webhooks`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501
query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageWebhookProjection', # 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_inbox_webhooks_paginated(self, inbox_id, **kwargs): # noqa: E501
"""Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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: PageWebhookProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_webhooks_paginated_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_inbox_webhooks_paginated_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'page',
'size',
'sort',
'search_filter',
'since',
'before'
]
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 get_inbox_webhooks_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_webhooks_paginated`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/webhooks/paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageWebhookProjection', # 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_json_schema_for_webhook_event(self, event, **kwargs): # noqa: E501
"""get_json_schema_for_webhook_event # noqa: E501
Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event(event, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str event: (required)
: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: JSONSchemaDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_json_schema_for_webhook_event_with_http_info(event, **kwargs) # noqa: E501
def get_json_schema_for_webhook_event_with_http_info(self, event, **kwargs): # noqa: E501
"""get_json_schema_for_webhook_event # noqa: E501
Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event_with_http_info(event, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str event: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'event'
]
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 get_json_schema_for_webhook_event" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'event' is set
if self.api_client.client_side_validation and ('event' not in local_var_params or # noqa: E501
local_var_params['event'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `event` when calling `get_json_schema_for_webhook_event`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'event' in local_var_params and local_var_params['event'] is not None: # noqa: E501
query_params.append(('event', local_var_params['event'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/schema', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='JSONSchemaDto', # 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_json_schema_for_webhook_payload(self, webhook_id, **kwargs): # noqa: E501
"""get_json_schema_for_webhook_payload # noqa: E501
Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
: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: JSONSchemaDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_json_schema_for_webhook_payload_with_http_info(webhook_id, **kwargs) # noqa: E501
def get_json_schema_for_webhook_payload_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""get_json_schema_for_webhook_payload # noqa: E501
Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_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 get_json_schema_for_webhook_payload" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_json_schema_for_webhook_payload`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/schema', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='JSONSchemaDto', # 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_phone_number_webhooks_paginated(self, phone_id, **kwargs): # noqa: E501
"""Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated(phone_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str phone_id: (required)
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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: PageWebhookProjection
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_phone_number_webhooks_paginated_with_http_info(phone_id, **kwargs) # noqa: E501
def get_phone_number_webhooks_paginated_with_http_info(self, phone_id, **kwargs): # noqa: E501
"""Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated_with_http_info(phone_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str phone_id: (required)
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
: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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'phone_id',
'page',
'size',
'sort',
'since',
'before'
]
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 get_phone_number_webhooks_paginated" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'phone_id' is set
if self.api_client.client_side_validation and ('phone_id' not in local_var_params or # noqa: E501
local_var_params['phone_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `phone_id` when calling `get_phone_number_webhooks_paginated`") # noqa: E501
collection_formats = {}
path_params = {}
if 'phone_id' in local_var_params:
path_params['phoneId'] = local_var_params['phone_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/phone/numbers/{phoneId}/webhooks/paginated', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageWebhookProjection', # 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_test_webhook_payload(self, **kwargs): # noqa: E501
"""get_test_webhook_payload # noqa: E501
Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. # 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_test_webhook_payload(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str event_name:
: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: AbstractWebhookPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_with_http_info(self, **kwargs): # noqa: E501
"""get_test_webhook_payload # noqa: E501
Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. # 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_test_webhook_payload_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str event_name:
: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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'event_name'
]
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 get_test_webhook_payload" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501
query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbstractWebhookPayload', # 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_test_webhook_payload_bounce(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_bounce # noqa: E501
Get webhook test payload for bounce # 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_test_webhook_payload_bounce(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookBouncePayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_bounce_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_bounce_with_http_info(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_bounce # noqa: E501
Get webhook test payload for bounce # 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_test_webhook_payload_bounce_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookBouncePayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_bounce" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/email-bounce-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookBouncePayload', # 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_test_webhook_payload_bounce_recipient(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_bounce_recipient # noqa: E501
Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookBounceRecipientPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_bounce_recipient_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_bounce_recipient_with_http_info(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_bounce_recipient # noqa: E501
Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookBounceRecipientPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_bounce_recipient" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/email-bounce-recipient-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookBounceRecipientPayload', # 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_test_webhook_payload_delivery_status(self, **kwargs): # noqa: E501
"""Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookDeliveryStatusPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_delivery_status_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_delivery_status_with_http_info(self, **kwargs): # noqa: E501
"""Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookDeliveryStatusPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_delivery_status" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/delivery-status-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookDeliveryStatusPayload', # 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_test_webhook_payload_email_opened(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_email_opened # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookEmailOpenedPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_email_opened_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_email_opened_with_http_info(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_email_opened # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookEmailOpenedPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_email_opened" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/email-opened-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookEmailOpenedPayload', # 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_test_webhook_payload_email_read(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_email_read # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_read(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookEmailReadPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_email_read_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_email_read_with_http_info(self, **kwargs): # noqa: E501
"""get_test_webhook_payload_email_read # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_read_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookEmailReadPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_email_read" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/email-read-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookEmailReadPayload', # 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_test_webhook_payload_for_webhook(self, webhook_id, **kwargs): # noqa: E501
"""get_test_webhook_payload_for_webhook # noqa: E501
Get example payload for webhook # 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_test_webhook_payload_for_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
: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: AbstractWebhookPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_for_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
def get_test_webhook_payload_for_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""get_test_webhook_payload_for_webhook # noqa: E501
Get example payload for webhook # 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_test_webhook_payload_for_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_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 get_test_webhook_payload_for_webhook" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_test_webhook_payload_for_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/example', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbstractWebhookPayload', # 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_test_webhook_payload_new_attachment(self, **kwargs): # noqa: E501
"""Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookNewAttachmentPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_new_attachment_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_new_attachment_with_http_info(self, **kwargs): # noqa: E501
"""Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookNewAttachmentPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_new_attachment" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/new-attachment-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookNewAttachmentPayload', # 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_test_webhook_payload_new_contact(self, **kwargs): # noqa: E501
"""Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookNewContactPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_new_contact_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_new_contact_with_http_info(self, **kwargs): # noqa: E501
"""Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookNewContactPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_new_contact" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/new-contact-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookNewContactPayload', # 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_test_webhook_payload_new_email(self, **kwargs): # noqa: E501
"""Get webhook test payload for new email event # 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_test_webhook_payload_new_email(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookNewEmailPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_new_email_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_new_email_with_http_info(self, **kwargs): # noqa: E501
"""Get webhook test payload for new email event # 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_test_webhook_payload_new_email_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookNewEmailPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_new_email" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/new-email-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookNewEmailPayload', # 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_test_webhook_payload_new_sms(self, **kwargs): # noqa: E501
"""Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookNewSmsPayload
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_test_webhook_payload_new_sms_with_http_info(**kwargs) # noqa: E501
def get_test_webhook_payload_new_sms_with_http_info(self, **kwargs): # noqa: E501
"""Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookNewSmsPayload, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_test_webhook_payload_new_sms" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/test/new-sms-payload', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookNewSmsPayload', # 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_webhook(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook # 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_webhook(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
: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: WebhookDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501
def get_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook # 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_webhook_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_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 get_webhook" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookDto', # 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_webhook_result(self, webhook_result_id, **kwargs): # noqa: E501
"""Get a webhook result for a webhook # 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_webhook_result(webhook_result_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_result_id: Webhook Result ID (required)
: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: WebhookResultDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_webhook_result_with_http_info(webhook_result_id, **kwargs) # noqa: E501
def get_webhook_result_with_http_info(self, webhook_result_id, **kwargs): # noqa: E501
"""Get a webhook result for a webhook # 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_webhook_result_with_http_info(webhook_result_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_result_id: Webhook Result ID (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(WebhookResultDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_result_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 get_webhook_result" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_result_id' is set
if self.api_client.client_side_validation and ('webhook_result_id' not in local_var_params or # noqa: E501
local_var_params['webhook_result_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_result_id` when calling `get_webhook_result`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_result_id' in local_var_params:
path_params['webhookResultId'] = local_var_params['webhook_result_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/results/{webhookResultId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookResultDto', # 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_webhook_results(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook results for a webhook # 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_webhook_results(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: ID of webhook to get results for (required)
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param bool unseen_only: Filter for unseen exceptions only
:param str result_type: Filter by result type
:param str event_name: Filter by event name
:param int min_status_code: Minimum response status
:param int max_status_code: Maximum response status
:param str inbox_id: Inbox ID
:param str sms_id: Sms ID
:param str attachment_id: Attachment ID
:param str email_id: Email ID
:param str phone_id: Phone ID
: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: PageWebhookResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_webhook_results_with_http_info(webhook_id, **kwargs) # noqa: E501
def get_webhook_results_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook results for a webhook # 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_webhook_results_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: ID of webhook to get results for (required)
:param int page: Optional page index in list pagination
:param int size: Optional page size in list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param str search_filter: Optional search filter
:param datetime since: Filter by created at after the given timestamp
:param datetime before: Filter by created at before the given timestamp
:param bool unseen_only: Filter for unseen exceptions only
:param str result_type: Filter by result type
:param str event_name: Filter by event name
:param int min_status_code: Minimum response status
:param int max_status_code: Maximum response status
:param str inbox_id: Inbox ID
:param str sms_id: Sms ID
:param str attachment_id: Attachment ID
:param str email_id: Email ID
:param str phone_id: Phone ID
: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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_id',
'page',
'size',
'sort',
'search_filter',
'since',
'before',
'unseen_only',
'result_type',
'event_name',
'min_status_code',
'max_status_code',
'inbox_id',
'sms_id',
'attachment_id',
'email_id',
'phone_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 get_webhook_results" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook_results`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501
query_params = []
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501
query_params.append(('size', local_var_params['size'])) # noqa: E501
if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # noqa: E501
if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501
query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501
if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501
query_params.append(('since', local_var_params['since'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
if 'unseen_only' in local_var_params and local_var_params['unseen_only'] is not None: # noqa: E501
query_params.append(('unseenOnly', local_var_params['unseen_only'])) # noqa: E501
if 'result_type' in local_var_params and local_var_params['result_type'] is not None: # noqa: E501
query_params.append(('resultType', local_var_params['result_type'])) # noqa: E501
if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501
query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501
if 'min_status_code' in local_var_params and local_var_params['min_status_code'] is not None: # noqa: E501
query_params.append(('minStatusCode', local_var_params['min_status_code'])) # noqa: E501
if 'max_status_code' in local_var_params and local_var_params['max_status_code'] is not None: # noqa: E501
query_params.append(('maxStatusCode', local_var_params['max_status_code'])) # noqa: E501
if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501
query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501
if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501
query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501
if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501
query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501
if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501
query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501
if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501
query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/results', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageWebhookResult', # 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_webhook_results_count(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook results count for a webhook # 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_webhook_results_count(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: ID of webhook to get results for (required)
: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: CountDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_webhook_results_count_with_http_info(webhook_id, **kwargs) # noqa: E501
def get_webhook_results_count_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Get a webhook results count for a webhook # 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_webhook_results_count_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: ID of webhook to get results for (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(CountDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_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 get_webhook_results_count" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook_results_count`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/results/count', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CountDto', # 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_webhook_results_unseen_error_count(self, **kwargs): # noqa: E501
"""Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: UnseenErrorCountDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_webhook_results_unseen_error_count_with_http_info(**kwargs) # noqa: E501
def get_webhook_results_unseen_error_count_with_http_info(self, **kwargs): # noqa: E501
"""Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(UnseenErrorCountDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 get_webhook_results_unseen_error_count" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/results/unseen-count', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UnseenErrorCountDto', # 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_webhooks(self, inbox_id, **kwargs): # noqa: E501
"""Get all webhooks for an Inbox # 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_webhooks(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (required)
: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: list[WebhookDto]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_webhooks_with_http_info(inbox_id, **kwargs) # noqa: E501
def get_webhooks_with_http_info(self, inbox_id, **kwargs): # noqa: E501
"""Get all webhooks for an Inbox # 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_webhooks_with_http_info(inbox_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: (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(list[WebhookDto], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_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 get_webhooks" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'inbox_id' is set
if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501
local_var_params['inbox_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_webhooks`") # noqa: E501
collection_formats = {}
path_params = {}
if 'inbox_id' in local_var_params:
path_params['inboxId'] = local_var_params['inbox_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/inboxes/{inboxId}/webhooks', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[WebhookDto]', # 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 redrive_all_webhook_results(self, **kwargs): # noqa: E501
"""Redrive all webhook results that have failed status # noqa: E501
Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_all_webhook_results(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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: WebhookRedriveAllResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.redrive_all_webhook_results_with_http_info(**kwargs) # noqa: E501
def redrive_all_webhook_results_with_http_info(self, **kwargs): # noqa: E501
"""Redrive all webhook results that have failed status # noqa: E501
Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_all_webhook_results_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(WebhookRedriveAllResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
]
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 redrive_all_webhook_results" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/results/redrive', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookRedriveAllResult', # 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 redrive_webhook_result(self, webhook_result_id, **kwargs): # noqa: E501
"""Get a webhook result and try to resend the original webhook payload # noqa: E501
Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_webhook_result(webhook_result_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_result_id: Webhook Result ID (required)
: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: WebhookRedriveResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.redrive_webhook_result_with_http_info(webhook_result_id, **kwargs) # noqa: E501
def redrive_webhook_result_with_http_info(self, webhook_result_id, **kwargs): # noqa: E501
"""Get a webhook result and try to resend the original webhook payload # noqa: E501
Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_webhook_result_with_http_info(webhook_result_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_result_id: Webhook Result ID (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(WebhookRedriveResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_result_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 redrive_webhook_result" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_result_id' is set
if self.api_client.client_side_validation and ('webhook_result_id' not in local_var_params or # noqa: E501
local_var_params['webhook_result_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_result_id` when calling `redrive_webhook_result`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_result_id' in local_var_params:
path_params['webhookResultId'] = local_var_params['webhook_result_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/results/{webhookResultId}/redrive', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookRedriveResult', # 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 send_test_data(self, webhook_id, **kwargs): # noqa: E501
"""Send webhook test data # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_data(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
: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: WebhookTestResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.send_test_data_with_http_info(webhook_id, **kwargs) # noqa: E501
def send_test_data_with_http_info(self, webhook_id, **kwargs): # noqa: E501
"""Send webhook test data # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_data_with_http_info(webhook_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (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(WebhookTestResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_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 send_test_data" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `send_test_data`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/test', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookTestResult', # 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_webhook_headers(self, webhook_id, webhook_headers, **kwargs): # noqa: E501
"""Update a webhook request headers # 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_webhook_headers(webhook_id, webhook_headers, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
:param WebhookHeaders webhook_headers: (required)
: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: WebhookDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.update_webhook_headers_with_http_info(webhook_id, webhook_headers, **kwargs) # noqa: E501
def update_webhook_headers_with_http_info(self, webhook_id, webhook_headers, **kwargs): # noqa: E501
"""Update a webhook request headers # 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_webhook_headers_with_http_info(webhook_id, webhook_headers, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: (required)
:param WebhookHeaders webhook_headers: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_id',
'webhook_headers'
]
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 update_webhook_headers" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `update_webhook_headers`") # noqa: E501
# verify the required parameter 'webhook_headers' is set
if self.api_client.client_side_validation and ('webhook_headers' not in local_var_params or # noqa: E501
local_var_params['webhook_headers'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_headers` when calling `update_webhook_headers`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'webhook_headers' in local_var_params:
body_params = local_var_params['webhook_headers']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # 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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/headers', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='WebhookDto', # 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 verify_webhook_signature(self, verify_webhook_signature_options, **kwargs): # noqa: E501
"""Verify a webhook payload signature # noqa: E501
Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.verify_webhook_signature(verify_webhook_signature_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param VerifyWebhookSignatureOptions verify_webhook_signature_options: (required)
: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: VerifyWebhookSignatureResults
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.verify_webhook_signature_with_http_info(verify_webhook_signature_options, **kwargs) # noqa: E501
def verify_webhook_signature_with_http_info(self, verify_webhook_signature_options, **kwargs): # noqa: E501
"""Verify a webhook payload signature # noqa: E501
Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.verify_webhook_signature_with_http_info(verify_webhook_signature_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param VerifyWebhookSignatureOptions verify_webhook_signature_options: (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(VerifyWebhookSignatureResults, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'verify_webhook_signature_options'
]
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 verify_webhook_signature" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'verify_webhook_signature_options' is set
if self.api_client.client_side_validation and ('verify_webhook_signature_options' not in local_var_params or # noqa: E501
local_var_params['verify_webhook_signature_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `verify_webhook_signature_options` when calling `verify_webhook_signature`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'verify_webhook_signature_options' in local_var_params:
body_params = local_var_params['verify_webhook_signature_options']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['*/*']) # 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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/verify', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='VerifyWebhookSignatureResults', # 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 wait_for_webhook_results(self, webhook_id, expected_count, timeout, **kwargs): # noqa: E501
"""Wait for webhook results for a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_webhook_results(webhook_id, expected_count, timeout, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: ID of webhook to get results for (required)
:param int expected_count: Expected result count (required)
:param int timeout: Max time to wait in milliseconds (required)
: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: list[WebhookResultDto]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, **kwargs) # noqa: E501
def wait_for_webhook_results_with_http_info(self, webhook_id, expected_count, timeout, **kwargs): # noqa: E501
"""Wait for webhook results for a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str webhook_id: ID of webhook to get results for (required)
:param int expected_count: Expected result count (required)
:param int timeout: Max time to wait in milliseconds (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(list[WebhookResultDto], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'webhook_id',
'expected_count',
'timeout'
]
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 wait_for_webhook_results" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'webhook_id' is set
if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501
local_var_params['webhook_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `webhook_id` when calling `wait_for_webhook_results`") # noqa: E501
# verify the required parameter 'expected_count' is set
if self.api_client.client_side_validation and ('expected_count' not in local_var_params or # noqa: E501
local_var_params['expected_count'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `expected_count` when calling `wait_for_webhook_results`") # noqa: E501
# verify the required parameter 'timeout' is set
if self.api_client.client_side_validation and ('timeout' not in local_var_params or # noqa: E501
local_var_params['timeout'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `timeout` when calling `wait_for_webhook_results`") # noqa: E501
if self.api_client.client_side_validation and 'expected_count' in local_var_params and local_var_params['expected_count'] > 100: # noqa: E501
raise ApiValueError("Invalid value for parameter `expected_count` when calling `wait_for_webhook_results`, must be a value less than or equal to `100`") # noqa: E501
if self.api_client.client_side_validation and 'timeout' in local_var_params and local_var_params['timeout'] > 300000: # noqa: E501
raise ApiValueError("Invalid value for parameter `timeout` when calling `wait_for_webhook_results`, must be a value less than or equal to `300000`") # noqa: E501
if self.api_client.client_side_validation and 'timeout' in local_var_params and local_var_params['timeout'] < 1000: # noqa: E501
raise ApiValueError("Invalid value for parameter `timeout` when calling `wait_for_webhook_results`, must be a value greater than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'webhook_id' in local_var_params:
path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501
query_params = []
if 'expected_count' in local_var_params and local_var_params['expected_count'] is not None: # noqa: E501
query_params.append(('expectedCount', local_var_params['expected_count'])) # noqa: E501
if 'timeout' in local_var_params and local_var_params['timeout'] is not None: # noqa: E501
query_params.append(('timeout', local_var_params['timeout'])) # noqa: E501
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 = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/webhooks/{webhookId}/wait', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[WebhookResultDto]', # 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)Classes
class WebhookControllerApi (api_client=None)-
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Expand source code
class WebhookControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def create_account_webhook(self, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified of account level events such as bounce and bounce recipient. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_account_webhook(create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_account_webhook_with_http_info(create_webhook_options, **kwargs) # noqa: E501 def create_account_webhook_with_http_info(self, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified of account level events such as bounce and bounce recipient. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_account_webhook_with_http_info(create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_webhook_options' ] 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 create_account_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_webhook_options' is set if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501 local_var_params['create_webhook_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_account_webhook`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_webhook_options' in local_var_params: body_params = local_var_params['create_webhook_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 create_webhook(self, inbox_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook(inbox_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_webhook_with_http_info(inbox_id, create_webhook_options, **kwargs) # noqa: E501 def create_webhook_with_http_info(self, inbox_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook_with_http_info(inbox_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'create_webhook_options' ] 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 create_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `create_webhook`") # noqa: E501 # verify the required parameter 'create_webhook_options' is set if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501 local_var_params['create_webhook_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_webhook_options' in local_var_params: body_params = local_var_params['create_webhook_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 create_webhook_for_phone_number(self, phone_number_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to a phone number # noqa: E501 Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook_for_phone_number(phone_number_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_number_id: (required) :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, **kwargs) # noqa: E501 def create_webhook_for_phone_number_with_http_info(self, phone_number_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to a phone number # noqa: E501 Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_number_id: (required) :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'phone_number_id', 'create_webhook_options' ] 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 create_webhook_for_phone_number" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'phone_number_id' is set if self.api_client.client_side_validation and ('phone_number_id' not in local_var_params or # noqa: E501 local_var_params['phone_number_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `phone_number_id` when calling `create_webhook_for_phone_number`") # noqa: E501 # verify the required parameter 'create_webhook_options' is set if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501 local_var_params['create_webhook_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_webhook_for_phone_number`") # noqa: E501 collection_formats = {} path_params = {} if 'phone_number_id' in local_var_params: path_params['phoneNumberId'] = local_var_params['phone_number_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_webhook_options' in local_var_params: body_params = local_var_params['create_webhook_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/phone/numbers/{phoneNumberId}/webhooks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 delete_all_webhooks(self, **kwargs): # noqa: E501 """Delete all webhooks # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_webhooks(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: before :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. """ kwargs['_return_http_data_only'] = True return self.delete_all_webhooks_with_http_info(**kwargs) # noqa: E501 def delete_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 """Delete all webhooks # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_webhooks_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: before :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 = [ 'before' ] 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 delete_all_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks', '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 delete_webhook(self, inbox_id, webhook_id, **kwargs): # noqa: E501 """Delete and disable a Webhook for an Inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook(inbox_id, webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param str webhook_id: (required) :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. """ kwargs['_return_http_data_only'] = True return self.delete_webhook_with_http_info(inbox_id, webhook_id, **kwargs) # noqa: E501 def delete_webhook_with_http_info(self, inbox_id, webhook_id, **kwargs): # noqa: E501 """Delete and disable a Webhook for an Inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook_with_http_info(inbox_id, webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param str webhook_id: (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 = [ 'inbox_id', 'webhook_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 delete_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `delete_webhook`") # noqa: E501 # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `delete_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks/{webhookId}', '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 delete_webhook_by_id(self, webhook_id, **kwargs): # noqa: E501 """Delete a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook_by_id(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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. """ kwargs['_return_http_data_only'] = True return self.delete_webhook_by_id_with_http_info(webhook_id, **kwargs) # noqa: E501 def delete_webhook_by_id_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Delete a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook_by_id_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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 = [ 'webhook_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 delete_webhook_by_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `delete_webhook_by_id`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', '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_all_account_webhooks(self, **kwargs): # noqa: E501 """List account webhooks Paginated # noqa: E501 List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str event_type: Optional event type :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_account_webhooks_with_http_info(**kwargs) # noqa: E501 def get_all_account_webhooks_with_http_info(self, **kwargs): # noqa: E501 """List account webhooks Paginated # noqa: E501 List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str event_type: Optional event type :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'event_type', 'since', 'before' ] 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 get_all_account_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] > 9223372036854775807: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_account_webhooks`, must be a value less than or equal to `9223372036854775807`") # noqa: E501 if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_account_webhooks`, must be a value greater than or equal to `0`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_account_webhooks`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_account_webhooks`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'event_type' in local_var_params and local_var_params['event_type'] is not None: # noqa: E501 query_params.append(('eventType', local_var_params['event_type'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/account/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_all_webhook_results(self, **kwargs): # noqa: E501 """Get results for all webhooks # 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_all_webhook_results(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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: PageWebhookResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_webhook_results_with_http_info(**kwargs) # noqa: E501 def get_all_webhook_results_with_http_info(self, **kwargs): # noqa: E501 """Get results for all webhooks # 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_all_webhook_results_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', 'since', 'before', 'unseen_only', 'result_type', 'event_name', 'min_status_code', 'max_status_code', 'inbox_id', 'sms_id', 'attachment_id', 'email_id', 'phone_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 get_all_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'unseen_only' in local_var_params and local_var_params['unseen_only'] is not None: # noqa: E501 query_params.append(('unseenOnly', local_var_params['unseen_only'])) # noqa: E501 if 'result_type' in local_var_params and local_var_params['result_type'] is not None: # noqa: E501 query_params.append(('resultType', local_var_params['result_type'])) # noqa: E501 if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501 query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501 if 'min_status_code' in local_var_params and local_var_params['min_status_code'] is not None: # noqa: E501 query_params.append(('minStatusCode', local_var_params['min_status_code'])) # noqa: E501 if 'max_status_code' in local_var_params and local_var_params['max_status_code'] is not None: # noqa: E501 query_params.append(('maxStatusCode', local_var_params['max_status_code'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookResult', # 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_all_webhooks(self, **kwargs): # noqa: E501 """List Webhooks Paginated # noqa: E501 List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param str inbox_id: Filter by inboxId :param str phone_id: Filter by phoneId :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_webhooks_with_http_info(**kwargs) # noqa: E501 def get_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 """List Webhooks Paginated # noqa: E501 List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param str inbox_id: Filter by inboxId :param str phone_id: Filter by phoneId :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', 'since', 'inbox_id', 'phone_id', 'before' ] 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 get_all_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] > 9223372036854775807: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_webhooks`, must be a value less than or equal to `9223372036854775807`") # noqa: E501 if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_webhooks`, must be a value greater than or equal to `0`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_webhooks`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_webhooks`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_inbox_webhooks_paginated(self, inbox_id, **kwargs): # noqa: E501 """Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_webhooks_paginated_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_webhooks_paginated_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] 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 get_inbox_webhooks_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_webhooks_paginated`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_json_schema_for_webhook_event(self, event, **kwargs): # noqa: E501 """get_json_schema_for_webhook_event # noqa: E501 Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event(event, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event: (required) :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: JSONSchemaDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_json_schema_for_webhook_event_with_http_info(event, **kwargs) # noqa: E501 def get_json_schema_for_webhook_event_with_http_info(self, event, **kwargs): # noqa: E501 """get_json_schema_for_webhook_event # noqa: E501 Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event_with_http_info(event, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'event' ] 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 get_json_schema_for_webhook_event" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'event' is set if self.api_client.client_side_validation and ('event' not in local_var_params or # noqa: E501 local_var_params['event'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `event` when calling `get_json_schema_for_webhook_event`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'event' in local_var_params and local_var_params['event'] is not None: # noqa: E501 query_params.append(('event', local_var_params['event'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/schema', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='JSONSchemaDto', # 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_json_schema_for_webhook_payload(self, webhook_id, **kwargs): # noqa: E501 """get_json_schema_for_webhook_payload # noqa: E501 Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: JSONSchemaDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_json_schema_for_webhook_payload_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_json_schema_for_webhook_payload_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """get_json_schema_for_webhook_payload # noqa: E501 Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_json_schema_for_webhook_payload" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_json_schema_for_webhook_payload`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/schema', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='JSONSchemaDto', # 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_phone_number_webhooks_paginated(self, phone_id, **kwargs): # noqa: E501 """Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated(phone_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_phone_number_webhooks_paginated_with_http_info(phone_id, **kwargs) # noqa: E501 def get_phone_number_webhooks_paginated_with_http_info(self, phone_id, **kwargs): # noqa: E501 """Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated_with_http_info(phone_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'phone_id', 'page', 'size', 'sort', 'since', 'before' ] 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 get_phone_number_webhooks_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'phone_id' is set if self.api_client.client_side_validation and ('phone_id' not in local_var_params or # noqa: E501 local_var_params['phone_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `phone_id` when calling `get_phone_number_webhooks_paginated`") # noqa: E501 collection_formats = {} path_params = {} if 'phone_id' in local_var_params: path_params['phoneId'] = local_var_params['phone_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/phone/numbers/{phoneId}/webhooks/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_test_webhook_payload(self, **kwargs): # noqa: E501 """get_test_webhook_payload # noqa: E501 Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. # 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_test_webhook_payload(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_name: :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: AbstractWebhookPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload # noqa: E501 Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. # 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_test_webhook_payload_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_name: :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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'event_name' ] 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 get_test_webhook_payload" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501 query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AbstractWebhookPayload', # 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_test_webhook_payload_bounce(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce # noqa: E501 Get webhook test payload for bounce # 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_test_webhook_payload_bounce(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookBouncePayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_bounce_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_bounce_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce # noqa: E501 Get webhook test payload for bounce # 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_test_webhook_payload_bounce_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookBouncePayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_bounce" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-bounce-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookBouncePayload', # 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_test_webhook_payload_bounce_recipient(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce_recipient # noqa: E501 Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookBounceRecipientPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_bounce_recipient_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_bounce_recipient_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce_recipient # noqa: E501 Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookBounceRecipientPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_bounce_recipient" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-bounce-recipient-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookBounceRecipientPayload', # 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_test_webhook_payload_delivery_status(self, **kwargs): # noqa: E501 """Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookDeliveryStatusPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_delivery_status_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_delivery_status_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookDeliveryStatusPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_delivery_status" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/delivery-status-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDeliveryStatusPayload', # 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_test_webhook_payload_email_opened(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_opened # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookEmailOpenedPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_email_opened_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_email_opened_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_opened # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookEmailOpenedPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_email_opened" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-opened-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookEmailOpenedPayload', # 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_test_webhook_payload_email_read(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_read # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_read(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookEmailReadPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_email_read_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_email_read_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_read # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_read_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookEmailReadPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_email_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-read-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookEmailReadPayload', # 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_test_webhook_payload_for_webhook(self, webhook_id, **kwargs): # noqa: E501 """get_test_webhook_payload_for_webhook # noqa: E501 Get example payload for webhook # 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_test_webhook_payload_for_webhook(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: AbstractWebhookPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_for_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_test_webhook_payload_for_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """get_test_webhook_payload_for_webhook # noqa: E501 Get example payload for webhook # 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_test_webhook_payload_for_webhook_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_test_webhook_payload_for_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_test_webhook_payload_for_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/example', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AbstractWebhookPayload', # 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_test_webhook_payload_new_attachment(self, **kwargs): # noqa: E501 """Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewAttachmentPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_attachment_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_attachment_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewAttachmentPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_attachment" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-attachment-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewAttachmentPayload', # 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_test_webhook_payload_new_contact(self, **kwargs): # noqa: E501 """Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewContactPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_contact_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_contact_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewContactPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_contact" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-contact-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewContactPayload', # 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_test_webhook_payload_new_email(self, **kwargs): # noqa: E501 """Get webhook test payload for new email event # 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_test_webhook_payload_new_email(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewEmailPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_email_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_email_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new email event # 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_test_webhook_payload_new_email_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewEmailPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-email-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewEmailPayload', # 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_test_webhook_payload_new_sms(self, **kwargs): # noqa: E501 """Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewSmsPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_sms_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_sms_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewSmsPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_sms" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-sms-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewSmsPayload', # 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_webhook(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook # 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_webhook(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook # 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_webhook_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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_webhook_result(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result for a webhook # 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_webhook_result(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (required) :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: WebhookResultDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_result_with_http_info(webhook_result_id, **kwargs) # noqa: E501 def get_webhook_result_with_http_info(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result for a webhook # 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_webhook_result_with_http_info(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (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(WebhookResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_result_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 get_webhook_result" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_result_id' is set if self.api_client.client_side_validation and ('webhook_result_id' not in local_var_params or # noqa: E501 local_var_params['webhook_result_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_result_id` when calling `get_webhook_result`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_result_id' in local_var_params: path_params['webhookResultId'] = local_var_params['webhook_result_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/{webhookResultId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookResultDto', # 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_webhook_results(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results for a webhook # 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_webhook_results(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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: PageWebhookResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_results_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_webhook_results_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results for a webhook # 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_webhook_results_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before', 'unseen_only', 'result_type', 'event_name', 'min_status_code', 'max_status_code', 'inbox_id', 'sms_id', 'attachment_id', 'email_id', 'phone_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 get_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook_results`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'unseen_only' in local_var_params and local_var_params['unseen_only'] is not None: # noqa: E501 query_params.append(('unseenOnly', local_var_params['unseen_only'])) # noqa: E501 if 'result_type' in local_var_params and local_var_params['result_type'] is not None: # noqa: E501 query_params.append(('resultType', local_var_params['result_type'])) # noqa: E501 if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501 query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501 if 'min_status_code' in local_var_params and local_var_params['min_status_code'] is not None: # noqa: E501 query_params.append(('minStatusCode', local_var_params['min_status_code'])) # noqa: E501 if 'max_status_code' in local_var_params and local_var_params['max_status_code'] is not None: # noqa: E501 query_params.append(('maxStatusCode', local_var_params['max_status_code'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookResult', # 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_webhook_results_count(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results count for a webhook # 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_webhook_results_count(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :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: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_results_count_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_webhook_results_count_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results count for a webhook # 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_webhook_results_count_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (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(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_webhook_results_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook_results_count`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/results/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # 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_webhook_results_unseen_error_count(self, **kwargs): # noqa: E501 """Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: UnseenErrorCountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_results_unseen_error_count_with_http_info(**kwargs) # noqa: E501 def get_webhook_results_unseen_error_count_with_http_info(self, **kwargs): # noqa: E501 """Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(UnseenErrorCountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_webhook_results_unseen_error_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/unseen-count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='UnseenErrorCountDto', # 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_webhooks(self, inbox_id, **kwargs): # noqa: E501 """Get all webhooks for an Inbox # 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_webhooks(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :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: list[WebhookDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhooks_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_webhooks_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get all webhooks for an Inbox # 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_webhooks_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (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(list[WebhookDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_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 get_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_webhooks`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[WebhookDto]', # 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 redrive_all_webhook_results(self, **kwargs): # noqa: E501 """Redrive all webhook results that have failed status # noqa: E501 Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_all_webhook_results(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookRedriveAllResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.redrive_all_webhook_results_with_http_info(**kwargs) # noqa: E501 def redrive_all_webhook_results_with_http_info(self, **kwargs): # noqa: E501 """Redrive all webhook results that have failed status # noqa: E501 Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_all_webhook_results_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookRedriveAllResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 redrive_all_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/redrive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookRedriveAllResult', # 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 redrive_webhook_result(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result and try to resend the original webhook payload # noqa: E501 Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_webhook_result(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (required) :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: WebhookRedriveResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.redrive_webhook_result_with_http_info(webhook_result_id, **kwargs) # noqa: E501 def redrive_webhook_result_with_http_info(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result and try to resend the original webhook payload # noqa: E501 Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_webhook_result_with_http_info(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (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(WebhookRedriveResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_result_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 redrive_webhook_result" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_result_id' is set if self.api_client.client_side_validation and ('webhook_result_id' not in local_var_params or # noqa: E501 local_var_params['webhook_result_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_result_id` when calling `redrive_webhook_result`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_result_id' in local_var_params: path_params['webhookResultId'] = local_var_params['webhook_result_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/{webhookResultId}/redrive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookRedriveResult', # 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 send_test_data(self, webhook_id, **kwargs): # noqa: E501 """Send webhook test data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_test_data(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: WebhookTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_test_data_with_http_info(webhook_id, **kwargs) # noqa: E501 def send_test_data_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Send webhook test data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_test_data_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(WebhookTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 send_test_data" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `send_test_data`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookTestResult', # 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_webhook_headers(self, webhook_id, webhook_headers, **kwargs): # noqa: E501 """Update a webhook request headers # 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_webhook_headers(webhook_id, webhook_headers, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :param WebhookHeaders webhook_headers: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_webhook_headers_with_http_info(webhook_id, webhook_headers, **kwargs) # noqa: E501 def update_webhook_headers_with_http_info(self, webhook_id, webhook_headers, **kwargs): # noqa: E501 """Update a webhook request headers # 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_webhook_headers_with_http_info(webhook_id, webhook_headers, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :param WebhookHeaders webhook_headers: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_id', 'webhook_headers' ] 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 update_webhook_headers" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `update_webhook_headers`") # noqa: E501 # verify the required parameter 'webhook_headers' is set if self.api_client.client_side_validation and ('webhook_headers' not in local_var_params or # noqa: E501 local_var_params['webhook_headers'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_headers` when calling `update_webhook_headers`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'webhook_headers' in local_var_params: body_params = local_var_params['webhook_headers'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/headers', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 verify_webhook_signature(self, verify_webhook_signature_options, **kwargs): # noqa: E501 """Verify a webhook payload signature # noqa: E501 Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.verify_webhook_signature(verify_webhook_signature_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param VerifyWebhookSignatureOptions verify_webhook_signature_options: (required) :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: VerifyWebhookSignatureResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.verify_webhook_signature_with_http_info(verify_webhook_signature_options, **kwargs) # noqa: E501 def verify_webhook_signature_with_http_info(self, verify_webhook_signature_options, **kwargs): # noqa: E501 """Verify a webhook payload signature # noqa: E501 Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.verify_webhook_signature_with_http_info(verify_webhook_signature_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param VerifyWebhookSignatureOptions verify_webhook_signature_options: (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(VerifyWebhookSignatureResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'verify_webhook_signature_options' ] 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 verify_webhook_signature" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'verify_webhook_signature_options' is set if self.api_client.client_side_validation and ('verify_webhook_signature_options' not in local_var_params or # noqa: E501 local_var_params['verify_webhook_signature_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `verify_webhook_signature_options` when calling `verify_webhook_signature`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'verify_webhook_signature_options' in local_var_params: body_params = local_var_params['verify_webhook_signature_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/verify', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='VerifyWebhookSignatureResults', # 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 wait_for_webhook_results(self, webhook_id, expected_count, timeout, **kwargs): # noqa: E501 """Wait for webhook results for a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_webhook_results(webhook_id, expected_count, timeout, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int expected_count: Expected result count (required) :param int timeout: Max time to wait in milliseconds (required) :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: list[WebhookResultDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, **kwargs) # noqa: E501 def wait_for_webhook_results_with_http_info(self, webhook_id, expected_count, timeout, **kwargs): # noqa: E501 """Wait for webhook results for a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int expected_count: Expected result count (required) :param int timeout: Max time to wait in milliseconds (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(list[WebhookResultDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_id', 'expected_count', 'timeout' ] 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 wait_for_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `wait_for_webhook_results`") # noqa: E501 # verify the required parameter 'expected_count' is set if self.api_client.client_side_validation and ('expected_count' not in local_var_params or # noqa: E501 local_var_params['expected_count'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `expected_count` when calling `wait_for_webhook_results`") # noqa: E501 # verify the required parameter 'timeout' is set if self.api_client.client_side_validation and ('timeout' not in local_var_params or # noqa: E501 local_var_params['timeout'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `timeout` when calling `wait_for_webhook_results`") # noqa: E501 if self.api_client.client_side_validation and 'expected_count' in local_var_params and local_var_params['expected_count'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `expected_count` when calling `wait_for_webhook_results`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'timeout' in local_var_params and local_var_params['timeout'] > 300000: # noqa: E501 raise ApiValueError("Invalid value for parameter `timeout` when calling `wait_for_webhook_results`, must be a value less than or equal to `300000`") # noqa: E501 if self.api_client.client_side_validation and 'timeout' in local_var_params and local_var_params['timeout'] < 1000: # noqa: E501 raise ApiValueError("Invalid value for parameter `timeout` when calling `wait_for_webhook_results`, must be a value greater than or equal to `1000`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] if 'expected_count' in local_var_params and local_var_params['expected_count'] is not None: # noqa: E501 query_params.append(('expectedCount', local_var_params['expected_count'])) # noqa: E501 if 'timeout' in local_var_params and local_var_params['timeout'] is not None: # noqa: E501 query_params.append(('timeout', local_var_params['timeout'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/wait', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[WebhookResultDto]', # 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)Methods
def create_account_webhook(self, create_webhook_options, **kwargs)-
Attach a WebHook URL to an inbox # noqa: E501
Get notified of account level events such as bounce and bounce recipient. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_account_webhook(create_webhook_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_account_webhook(self, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified of account level events such as bounce and bounce recipient. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_account_webhook(create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_account_webhook_with_http_info(create_webhook_options, **kwargs) # noqa: E501 def create_account_webhook_with_http_info(self, create_webhook_options, **kwargs)-
Attach a WebHook URL to an inbox # noqa: E501
Get notified of account level events such as bounce and bounce recipient. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_account_webhook_with_http_info(create_webhook_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_account_webhook_with_http_info(self, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified of account level events such as bounce and bounce recipient. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_account_webhook_with_http_info(create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_webhook_options' ] 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 create_account_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_webhook_options' is set if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501 local_var_params['create_webhook_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_account_webhook`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_webhook_options' in local_var_params: body_params = local_var_params['create_webhook_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 create_webhook(self, inbox_id, create_webhook_options, **kwargs)-
Attach a WebHook URL to an inbox # noqa: E501
Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook(inbox_id, create_webhook_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_webhook(self, inbox_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook(inbox_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_webhook_with_http_info(inbox_id, create_webhook_options, **kwargs) # noqa: E501 def create_webhook_for_phone_number(self, phone_number_id, create_webhook_options, **kwargs)-
Attach a WebHook URL to a phone number # noqa: E501
Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook_for_phone_number(phone_number_id, create_webhook_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str phone_number_id: (required) :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_webhook_for_phone_number(self, phone_number_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to a phone number # noqa: E501 Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook_for_phone_number(phone_number_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_number_id: (required) :param CreateWebhookOptions create_webhook_options: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, **kwargs) # noqa: E501 def create_webhook_for_phone_number_with_http_info(self, phone_number_id, create_webhook_options, **kwargs)-
Attach a WebHook URL to a phone number # noqa: E501
Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str phone_number_id: (required) :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_webhook_for_phone_number_with_http_info(self, phone_number_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to a phone number # noqa: E501 Get notified whenever a phone number receives an SMS via a WebHook URL. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook_for_phone_number_with_http_info(phone_number_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_number_id: (required) :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'phone_number_id', 'create_webhook_options' ] 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 create_webhook_for_phone_number" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'phone_number_id' is set if self.api_client.client_side_validation and ('phone_number_id' not in local_var_params or # noqa: E501 local_var_params['phone_number_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `phone_number_id` when calling `create_webhook_for_phone_number`") # noqa: E501 # verify the required parameter 'create_webhook_options' is set if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501 local_var_params['create_webhook_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_webhook_for_phone_number`") # noqa: E501 collection_formats = {} path_params = {} if 'phone_number_id' in local_var_params: path_params['phoneNumberId'] = local_var_params['phone_number_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_webhook_options' in local_var_params: body_params = local_var_params['create_webhook_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/phone/numbers/{phoneNumberId}/webhooks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 create_webhook_with_http_info(self, inbox_id, create_webhook_options, **kwargs)-
Attach a WebHook URL to an inbox # noqa: E501
Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_webhook_with_http_info(inbox_id, create_webhook_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_webhook_with_http_info(self, inbox_id, create_webhook_options, **kwargs): # noqa: E501 """Attach a WebHook URL to an inbox # noqa: E501 Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_webhook_with_http_info(inbox_id, create_webhook_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param CreateWebhookOptions create_webhook_options: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'create_webhook_options' ] 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 create_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `create_webhook`") # noqa: E501 # verify the required parameter 'create_webhook_options' is set if self.api_client.client_side_validation and ('create_webhook_options' not in local_var_params or # noqa: E501 local_var_params['create_webhook_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_webhook_options` when calling `create_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_webhook_options' in local_var_params: body_params = local_var_params['create_webhook_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 delete_all_webhooks(self, **kwargs)-
Delete all webhooks # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_webhooks(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param datetime before: before :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.
Expand source code
def delete_all_webhooks(self, **kwargs): # noqa: E501 """Delete all webhooks # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_webhooks(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: before :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. """ kwargs['_return_http_data_only'] = True return self.delete_all_webhooks_with_http_info(**kwargs) # noqa: E501 def delete_all_webhooks_with_http_info(self, **kwargs)-
Delete all webhooks # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_webhooks_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param datetime before: before :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.
Expand source code
def delete_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 """Delete all webhooks # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_webhooks_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param datetime before: before :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 = [ 'before' ] 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 delete_all_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks', '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 delete_webhook(self, inbox_id, webhook_id, **kwargs)-
Delete and disable a Webhook for an Inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook(inbox_id, webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param str webhook_id: (required) :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.
Expand source code
def delete_webhook(self, inbox_id, webhook_id, **kwargs): # noqa: E501 """Delete and disable a Webhook for an Inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook(inbox_id, webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param str webhook_id: (required) :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. """ kwargs['_return_http_data_only'] = True return self.delete_webhook_with_http_info(inbox_id, webhook_id, **kwargs) # noqa: E501 def delete_webhook_by_id(self, webhook_id, **kwargs)-
Delete a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook_by_id(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :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.
Expand source code
def delete_webhook_by_id(self, webhook_id, **kwargs): # noqa: E501 """Delete a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook_by_id(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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. """ kwargs['_return_http_data_only'] = True return self.delete_webhook_by_id_with_http_info(webhook_id, **kwargs) # noqa: E501 def delete_webhook_by_id_with_http_info(self, webhook_id, **kwargs)-
Delete a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook_by_id_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (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.
Expand source code
def delete_webhook_by_id_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Delete a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook_by_id_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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 = [ 'webhook_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 delete_webhook_by_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `delete_webhook_by_id`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', '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 delete_webhook_with_http_info(self, inbox_id, webhook_id, **kwargs)-
Delete and disable a Webhook for an Inbox # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_webhook_with_http_info(inbox_id, webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param str webhook_id: (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.
Expand source code
def delete_webhook_with_http_info(self, inbox_id, webhook_id, **kwargs): # noqa: E501 """Delete and disable a Webhook for an Inbox # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_webhook_with_http_info(inbox_id, webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param str webhook_id: (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 = [ 'inbox_id', 'webhook_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 delete_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `delete_webhook`") # noqa: E501 # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `delete_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks/{webhookId}', '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_all_account_webhooks(self, **kwargs)-
List account webhooks Paginated # noqa: E501
List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str event_type: Optional event type :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_account_webhooks(self, **kwargs): # noqa: E501 """List account webhooks Paginated # noqa: E501 List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str event_type: Optional event type :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_account_webhooks_with_http_info(**kwargs) # noqa: E501 def get_all_account_webhooks_with_http_info(self, **kwargs)-
List account webhooks Paginated # noqa: E501
List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str event_type: Optional event type :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_account_webhooks_with_http_info(self, **kwargs): # noqa: E501 """List account webhooks Paginated # noqa: E501 List account webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_account_webhooks_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str event_type: Optional event type :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'event_type', 'since', 'before' ] 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 get_all_account_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] > 9223372036854775807: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_account_webhooks`, must be a value less than or equal to `9223372036854775807`") # noqa: E501 if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_account_webhooks`, must be a value greater than or equal to `0`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_account_webhooks`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_account_webhooks`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'event_type' in local_var_params and local_var_params['event_type'] is not None: # noqa: E501 query_params.append(('eventType', local_var_params['event_type'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/account/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_all_webhook_results(self, **kwargs)-
Get results for all webhooks # 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_all_webhook_results(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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: PageWebhookResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_webhook_results(self, **kwargs): # noqa: E501 """Get results for all webhooks # 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_all_webhook_results(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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: PageWebhookResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_webhook_results_with_http_info(**kwargs) # noqa: E501 def get_all_webhook_results_with_http_info(self, **kwargs)-
Get results for all webhooks # 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_all_webhook_results_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_webhook_results_with_http_info(self, **kwargs): # noqa: E501 """Get results for all webhooks # 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_all_webhook_results_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', 'since', 'before', 'unseen_only', 'result_type', 'event_name', 'min_status_code', 'max_status_code', 'inbox_id', 'sms_id', 'attachment_id', 'email_id', 'phone_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 get_all_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'unseen_only' in local_var_params and local_var_params['unseen_only'] is not None: # noqa: E501 query_params.append(('unseenOnly', local_var_params['unseen_only'])) # noqa: E501 if 'result_type' in local_var_params and local_var_params['result_type'] is not None: # noqa: E501 query_params.append(('resultType', local_var_params['result_type'])) # noqa: E501 if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501 query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501 if 'min_status_code' in local_var_params and local_var_params['min_status_code'] is not None: # noqa: E501 query_params.append(('minStatusCode', local_var_params['min_status_code'])) # noqa: E501 if 'max_status_code' in local_var_params and local_var_params['max_status_code'] is not None: # noqa: E501 query_params.append(('maxStatusCode', local_var_params['max_status_code'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookResult', # 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_all_webhooks(self, **kwargs)-
List Webhooks Paginated # noqa: E501
List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param str inbox_id: Filter by inboxId :param str phone_id: Filter by phoneId :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_webhooks(self, **kwargs): # noqa: E501 """List Webhooks Paginated # noqa: E501 List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param str inbox_id: Filter by inboxId :param str phone_id: Filter by phoneId :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_webhooks_with_http_info(**kwargs) # noqa: E501 def get_all_webhooks_with_http_info(self, **kwargs)-
List Webhooks Paginated # noqa: E501
List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param str inbox_id: Filter by inboxId :param str phone_id: Filter by phoneId :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 """List Webhooks Paginated # noqa: E501 List webhooks in paginated form. Allows for page index, page size, and sort direction. # 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_all_webhooks_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size for paginated result list. :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param str inbox_id: Filter by inboxId :param str phone_id: Filter by phoneId :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', 'since', 'inbox_id', 'phone_id', 'before' ] 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 get_all_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] > 9223372036854775807: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_webhooks`, must be a value less than or equal to `9223372036854775807`") # noqa: E501 if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_all_webhooks`, must be a value greater than or equal to `0`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_webhooks`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_all_webhooks`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_inbox_webhooks_paginated(self, inbox_id, **kwargs)-
Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_webhooks_paginated(self, inbox_id, **kwargs): # noqa: E501 """Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_webhooks_paginated_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_inbox_webhooks_paginated_with_http_info(self, inbox_id, **kwargs)-
Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_webhooks_paginated_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get paginated webhooks for an Inbox # 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_inbox_webhooks_paginated_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before' ] 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 get_inbox_webhooks_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_inbox_webhooks_paginated`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_json_schema_for_webhook_event(self, event, **kwargs)-
get_json_schema_for_webhook_event # noqa: E501
Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event(event, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str event: (required) :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: JSONSchemaDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_json_schema_for_webhook_event(self, event, **kwargs): # noqa: E501 """get_json_schema_for_webhook_event # noqa: E501 Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event(event, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event: (required) :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: JSONSchemaDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_json_schema_for_webhook_event_with_http_info(event, **kwargs) # noqa: E501 def get_json_schema_for_webhook_event_with_http_info(self, event, **kwargs)-
get_json_schema_for_webhook_event # noqa: E501
Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event_with_http_info(event, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str event: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_json_schema_for_webhook_event_with_http_info(self, event, **kwargs): # noqa: E501 """get_json_schema_for_webhook_event # noqa: E501 Get JSON Schema definition for webhook payload by event # 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_json_schema_for_webhook_event_with_http_info(event, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'event' ] 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 get_json_schema_for_webhook_event" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'event' is set if self.api_client.client_side_validation and ('event' not in local_var_params or # noqa: E501 local_var_params['event'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `event` when calling `get_json_schema_for_webhook_event`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'event' in local_var_params and local_var_params['event'] is not None: # noqa: E501 query_params.append(('event', local_var_params['event'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/schema', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='JSONSchemaDto', # 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_json_schema_for_webhook_payload(self, webhook_id, **kwargs)-
get_json_schema_for_webhook_payload # noqa: E501
Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: JSONSchemaDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_json_schema_for_webhook_payload(self, webhook_id, **kwargs): # noqa: E501 """get_json_schema_for_webhook_payload # noqa: E501 Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: JSONSchemaDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_json_schema_for_webhook_payload_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_json_schema_for_webhook_payload_with_http_info(self, webhook_id, **kwargs)-
get_json_schema_for_webhook_payload # noqa: E501
Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_json_schema_for_webhook_payload_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """get_json_schema_for_webhook_payload # noqa: E501 Get JSON Schema definition for webhook payload # 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_json_schema_for_webhook_payload_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(JSONSchemaDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_json_schema_for_webhook_payload" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_json_schema_for_webhook_payload`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/schema', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='JSONSchemaDto', # 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_phone_number_webhooks_paginated(self, phone_id, **kwargs)-
Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated(phone_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str phone_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread.
Expand source code
def get_phone_number_webhooks_paginated(self, phone_id, **kwargs): # noqa: E501 """Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated(phone_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageWebhookProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_phone_number_webhooks_paginated_with_http_info(phone_id, **kwargs) # noqa: E501 def get_phone_number_webhooks_paginated_with_http_info(self, phone_id, **kwargs)-
Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated_with_http_info(phone_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str phone_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_phone_number_webhooks_paginated_with_http_info(self, phone_id, **kwargs): # noqa: E501 """Get paginated webhooks for a phone number # 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_phone_number_webhooks_paginated_with_http_info(phone_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str phone_id: (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageWebhookProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'phone_id', 'page', 'size', 'sort', 'since', 'before' ] 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 get_phone_number_webhooks_paginated" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'phone_id' is set if self.api_client.client_side_validation and ('phone_id' not in local_var_params or # noqa: E501 local_var_params['phone_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `phone_id` when calling `get_phone_number_webhooks_paginated`") # noqa: E501 collection_formats = {} path_params = {} if 'phone_id' in local_var_params: path_params['phoneId'] = local_var_params['phone_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/phone/numbers/{phoneId}/webhooks/paginated', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookProjection', # 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_test_webhook_payload(self, **kwargs)-
get_test_webhook_payload # noqa: E501
Get test webhook payload example. Response content depends on eventName passed. Uses
EMAIL_RECEIVEDas default. # 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_test_webhook_payload(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str event_name: :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: AbstractWebhookPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload(self, **kwargs): # noqa: E501 """get_test_webhook_payload # noqa: E501 Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. # 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_test_webhook_payload(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_name: :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: AbstractWebhookPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_bounce(self, **kwargs)-
get_test_webhook_payload_bounce # noqa: E501
Get webhook test payload for bounce # 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_test_webhook_payload_bounce(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookBouncePayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_bounce(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce # noqa: E501 Get webhook test payload for bounce # 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_test_webhook_payload_bounce(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookBouncePayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_bounce_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_bounce_recipient(self, **kwargs)-
get_test_webhook_payload_bounce_recipient # noqa: E501
Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookBounceRecipientPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_bounce_recipient(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce_recipient # noqa: E501 Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookBounceRecipientPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_bounce_recipient_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_bounce_recipient_with_http_info(self, **kwargs)-
get_test_webhook_payload_bounce_recipient # noqa: E501
Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookBounceRecipientPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_bounce_recipient_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce_recipient # noqa: E501 Get webhook test payload for bounce recipient # 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_test_webhook_payload_bounce_recipient_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookBounceRecipientPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_bounce_recipient" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-bounce-recipient-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookBounceRecipientPayload', # 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_test_webhook_payload_bounce_with_http_info(self, **kwargs)-
get_test_webhook_payload_bounce # noqa: E501
Get webhook test payload for bounce # 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_test_webhook_payload_bounce_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookBouncePayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_bounce_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_bounce # noqa: E501 Get webhook test payload for bounce # 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_test_webhook_payload_bounce_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookBouncePayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_bounce" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-bounce-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookBouncePayload', # 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_test_webhook_payload_delivery_status(self, **kwargs)-
Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookDeliveryStatusPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_delivery_status(self, **kwargs): # noqa: E501 """Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookDeliveryStatusPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_delivery_status_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_delivery_status_with_http_info(self, **kwargs)-
Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookDeliveryStatusPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_delivery_status_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for delivery status event # 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_test_webhook_payload_delivery_status_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookDeliveryStatusPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_delivery_status" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/delivery-status-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDeliveryStatusPayload', # 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_test_webhook_payload_email_opened(self, **kwargs)-
get_test_webhook_payload_email_opened # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookEmailOpenedPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_email_opened(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_opened # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookEmailOpenedPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_email_opened_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_email_opened_with_http_info(self, **kwargs)-
get_test_webhook_payload_email_opened # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookEmailOpenedPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_email_opened_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_opened # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_opened_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookEmailOpenedPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_email_opened" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-opened-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookEmailOpenedPayload', # 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_test_webhook_payload_email_read(self, **kwargs)-
get_test_webhook_payload_email_read # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_read(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookEmailReadPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_email_read(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_read # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_read(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookEmailReadPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_email_read_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_email_read_with_http_info(self, **kwargs)-
get_test_webhook_payload_email_read # noqa: E501
Get webhook test payload for email opened event # 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_test_webhook_payload_email_read_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookEmailReadPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_email_read_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload_email_read # noqa: E501 Get webhook test payload for email opened event # 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_test_webhook_payload_email_read_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookEmailReadPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_email_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/email-read-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookEmailReadPayload', # 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_test_webhook_payload_for_webhook(self, webhook_id, **kwargs)-
get_test_webhook_payload_for_webhook # noqa: E501
Get example payload for webhook # 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_test_webhook_payload_for_webhook(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: AbstractWebhookPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_for_webhook(self, webhook_id, **kwargs): # noqa: E501 """get_test_webhook_payload_for_webhook # noqa: E501 Get example payload for webhook # 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_test_webhook_payload_for_webhook(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: AbstractWebhookPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_for_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_test_webhook_payload_for_webhook_with_http_info(self, webhook_id, **kwargs)-
get_test_webhook_payload_for_webhook # noqa: E501
Get example payload for webhook # 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_test_webhook_payload_for_webhook_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_for_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """get_test_webhook_payload_for_webhook # noqa: E501 Get example payload for webhook # 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_test_webhook_payload_for_webhook_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_test_webhook_payload_for_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_test_webhook_payload_for_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/example', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AbstractWebhookPayload', # 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_test_webhook_payload_new_attachment(self, **kwargs)-
Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookNewAttachmentPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_attachment(self, **kwargs): # noqa: E501 """Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewAttachmentPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_attachment_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_attachment_with_http_info(self, **kwargs)-
Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookNewAttachmentPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_attachment_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new attachment event # 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_test_webhook_payload_new_attachment_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewAttachmentPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_attachment" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-attachment-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewAttachmentPayload', # 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_test_webhook_payload_new_contact(self, **kwargs)-
Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookNewContactPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_contact(self, **kwargs): # noqa: E501 """Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewContactPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_contact_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_contact_with_http_info(self, **kwargs)-
Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookNewContactPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_contact_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new contact event # 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_test_webhook_payload_new_contact_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewContactPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_contact" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-contact-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewContactPayload', # 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_test_webhook_payload_new_email(self, **kwargs)-
Get webhook test payload for new email event # 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_test_webhook_payload_new_email(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookNewEmailPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_email(self, **kwargs): # noqa: E501 """Get webhook test payload for new email event # 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_test_webhook_payload_new_email(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewEmailPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_email_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_email_with_http_info(self, **kwargs)-
Get webhook test payload for new email event # 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_test_webhook_payload_new_email_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookNewEmailPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_email_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new email event # 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_test_webhook_payload_new_email_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewEmailPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-email-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewEmailPayload', # 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_test_webhook_payload_new_sms(self, **kwargs)-
Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookNewSmsPayload If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_sms(self, **kwargs): # noqa: E501 """Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookNewSmsPayload If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_test_webhook_payload_new_sms_with_http_info(**kwargs) # noqa: E501 def get_test_webhook_payload_new_sms_with_http_info(self, **kwargs)-
Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookNewSmsPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_new_sms_with_http_info(self, **kwargs): # noqa: E501 """Get webhook test payload for new sms event # 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_test_webhook_payload_new_sms_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookNewSmsPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_test_webhook_payload_new_sms" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test/new-sms-payload', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookNewSmsPayload', # 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_test_webhook_payload_with_http_info(self, **kwargs)-
get_test_webhook_payload # noqa: E501
Get test webhook payload example. Response content depends on eventName passed. Uses
EMAIL_RECEIVEDas default. # 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_test_webhook_payload_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str event_name: :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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_test_webhook_payload_with_http_info(self, **kwargs): # noqa: E501 """get_test_webhook_payload # noqa: E501 Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. # 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_test_webhook_payload_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_name: :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(AbstractWebhookPayload, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'event_name' ] 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 get_test_webhook_payload" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501 query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/test', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AbstractWebhookPayload', # 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_webhook(self, webhook_id, **kwargs)-
Get a webhook # 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_webhook(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook # 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_webhook(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_webhook_result(self, webhook_result_id, **kwargs)-
Get a webhook result for a webhook # 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_webhook_result(webhook_result_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (required) :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: WebhookResultDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_result(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result for a webhook # 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_webhook_result(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (required) :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: WebhookResultDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_result_with_http_info(webhook_result_id, **kwargs) # noqa: E501 def get_webhook_result_with_http_info(self, webhook_result_id, **kwargs)-
Get a webhook result for a webhook # 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_webhook_result_with_http_info(webhook_result_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (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(WebhookResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_result_with_http_info(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result for a webhook # 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_webhook_result_with_http_info(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (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(WebhookResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_result_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 get_webhook_result" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_result_id' is set if self.api_client.client_side_validation and ('webhook_result_id' not in local_var_params or # noqa: E501 local_var_params['webhook_result_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_result_id` when calling `get_webhook_result`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_result_id' in local_var_params: path_params['webhookResultId'] = local_var_params['webhook_result_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/{webhookResultId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookResultDto', # 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_webhook_results(self, webhook_id, **kwargs)-
Get a webhook results for a webhook # 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_webhook_results(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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: PageWebhookResult If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_results(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results for a webhook # 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_webhook_results(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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: PageWebhookResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_results_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_webhook_results_count(self, webhook_id, **kwargs)-
Get a webhook results count for a webhook # 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_webhook_results_count(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :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: CountDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_results_count(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results count for a webhook # 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_webhook_results_count(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :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: CountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_results_count_with_http_info(webhook_id, **kwargs) # noqa: E501 def get_webhook_results_count_with_http_info(self, webhook_id, **kwargs)-
Get a webhook results count for a webhook # 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_webhook_results_count_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (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(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_results_count_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results count for a webhook # 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_webhook_results_count_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (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(CountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_webhook_results_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook_results_count`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/results/count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CountDto', # 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_webhook_results_unseen_error_count(self, **kwargs)-
Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: UnseenErrorCountDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_results_unseen_error_count(self, **kwargs): # noqa: E501 """Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: UnseenErrorCountDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhook_results_unseen_error_count_with_http_info(**kwargs) # noqa: E501 def get_webhook_results_unseen_error_count_with_http_info(self, **kwargs)-
Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(UnseenErrorCountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_results_unseen_error_count_with_http_info(self, **kwargs): # noqa: E501 """Get count of unseen webhook results with error status # 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_webhook_results_unseen_error_count_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(UnseenErrorCountDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 get_webhook_results_unseen_error_count" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/unseen-count', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='UnseenErrorCountDto', # 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_webhook_results_with_http_info(self, webhook_id, **kwargs)-
Get a webhook results for a webhook # 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_webhook_results_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_results_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook results for a webhook # 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_webhook_results_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param bool unseen_only: Filter for unseen exceptions only :param str result_type: Filter by result type :param str event_name: Filter by event name :param int min_status_code: Minimum response status :param int max_status_code: Maximum response status :param str inbox_id: Inbox ID :param str sms_id: Sms ID :param str attachment_id: Attachment ID :param str email_id: Email ID :param str phone_id: Phone ID :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(PageWebhookResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_id', 'page', 'size', 'sort', 'search_filter', 'since', 'before', 'unseen_only', 'result_type', 'event_name', 'min_status_code', 'max_status_code', 'inbox_id', 'sms_id', 'attachment_id', 'email_id', 'phone_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 get_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook_results`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'unseen_only' in local_var_params and local_var_params['unseen_only'] is not None: # noqa: E501 query_params.append(('unseenOnly', local_var_params['unseen_only'])) # noqa: E501 if 'result_type' in local_var_params and local_var_params['result_type'] is not None: # noqa: E501 query_params.append(('resultType', local_var_params['result_type'])) # noqa: E501 if 'event_name' in local_var_params and local_var_params['event_name'] is not None: # noqa: E501 query_params.append(('eventName', local_var_params['event_name'])) # noqa: E501 if 'min_status_code' in local_var_params and local_var_params['min_status_code'] is not None: # noqa: E501 query_params.append(('minStatusCode', local_var_params['min_status_code'])) # noqa: E501 if 'max_status_code' in local_var_params and local_var_params['max_status_code'] is not None: # noqa: E501 query_params.append(('maxStatusCode', local_var_params['max_status_code'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageWebhookResult', # 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_webhook_with_http_info(self, webhook_id, **kwargs)-
Get a webhook # 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_webhook_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Get a webhook # 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_webhook_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 get_webhook" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `get_webhook`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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_webhooks(self, inbox_id, **kwargs)-
Get all webhooks for an Inbox # 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_webhooks(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (required) :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: list[WebhookDto] If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhooks(self, inbox_id, **kwargs): # noqa: E501 """Get all webhooks for an Inbox # 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_webhooks(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (required) :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: list[WebhookDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_webhooks_with_http_info(inbox_id, **kwargs) # noqa: E501 def get_webhooks_with_http_info(self, inbox_id, **kwargs)-
Get all webhooks for an Inbox # 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_webhooks_with_http_info(inbox_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: (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(list[WebhookDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_webhooks_with_http_info(self, inbox_id, **kwargs): # noqa: E501 """Get all webhooks for an Inbox # 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_webhooks_with_http_info(inbox_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: (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(list[WebhookDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_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 get_webhooks" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'inbox_id' is set if self.api_client.client_side_validation and ('inbox_id' not in local_var_params or # noqa: E501 local_var_params['inbox_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_id` when calling `get_webhooks`") # noqa: E501 collection_formats = {} path_params = {} if 'inbox_id' in local_var_params: path_params['inboxId'] = local_var_params['inbox_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inboxes/{inboxId}/webhooks', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[WebhookDto]', # 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 redrive_all_webhook_results(self, **kwargs)-
Redrive all webhook results that have failed status # noqa: E501
Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_all_webhook_results(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: WebhookRedriveAllResult If the method is called asynchronously, returns the request thread.
Expand source code
def redrive_all_webhook_results(self, **kwargs): # noqa: E501 """Redrive all webhook results that have failed status # noqa: E501 Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_all_webhook_results(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: WebhookRedriveAllResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.redrive_all_webhook_results_with_http_info(**kwargs) # noqa: E501 def redrive_all_webhook_results_with_http_info(self, **kwargs)-
Redrive all webhook results that have failed status # noqa: E501
Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_all_webhook_results_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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(WebhookRedriveAllResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def redrive_all_webhook_results_with_http_info(self, **kwargs): # noqa: E501 """Redrive all webhook results that have failed status # noqa: E501 Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_all_webhook_results_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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(WebhookRedriveAllResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 redrive_all_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/redrive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookRedriveAllResult', # 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 redrive_webhook_result(self, webhook_result_id, **kwargs)-
Get a webhook result and try to resend the original webhook payload # noqa: E501
Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_webhook_result(webhook_result_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (required) :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: WebhookRedriveResult If the method is called asynchronously, returns the request thread.
Expand source code
def redrive_webhook_result(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result and try to resend the original webhook payload # noqa: E501 Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_webhook_result(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (required) :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: WebhookRedriveResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.redrive_webhook_result_with_http_info(webhook_result_id, **kwargs) # noqa: E501 def redrive_webhook_result_with_http_info(self, webhook_result_id, **kwargs)-
Get a webhook result and try to resend the original webhook payload # noqa: E501
Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.redrive_webhook_result_with_http_info(webhook_result_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (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(WebhookRedriveResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def redrive_webhook_result_with_http_info(self, webhook_result_id, **kwargs): # noqa: E501 """Get a webhook result and try to resend the original webhook payload # noqa: E501 Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.redrive_webhook_result_with_http_info(webhook_result_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_result_id: Webhook Result ID (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(WebhookRedriveResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_result_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 redrive_webhook_result" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_result_id' is set if self.api_client.client_side_validation and ('webhook_result_id' not in local_var_params or # noqa: E501 local_var_params['webhook_result_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_result_id` when calling `redrive_webhook_result`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_result_id' in local_var_params: path_params['webhookResultId'] = local_var_params['webhook_result_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/results/{webhookResultId}/redrive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookRedriveResult', # 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 send_test_data(self, webhook_id, **kwargs)-
Send webhook test data # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_data(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: WebhookTestResult If the method is called asynchronously, returns the request thread.
Expand source code
def send_test_data(self, webhook_id, **kwargs): # noqa: E501 """Send webhook test data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_test_data(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :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: WebhookTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.send_test_data_with_http_info(webhook_id, **kwargs) # noqa: E501 def send_test_data_with_http_info(self, webhook_id, **kwargs)-
Send webhook test data # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_data_with_http_info(webhook_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (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(WebhookTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def send_test_data_with_http_info(self, webhook_id, **kwargs): # noqa: E501 """Send webhook test data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_test_data_with_http_info(webhook_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (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(WebhookTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_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 send_test_data" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `send_test_data`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookTestResult', # 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_webhook_headers(self, webhook_id, webhook_headers, **kwargs)-
Update a webhook request headers # 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_webhook_headers(webhook_id, webhook_headers, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :param WebhookHeaders webhook_headers: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread.
Expand source code
def update_webhook_headers(self, webhook_id, webhook_headers, **kwargs): # noqa: E501 """Update a webhook request headers # 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_webhook_headers(webhook_id, webhook_headers, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :param WebhookHeaders webhook_headers: (required) :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: WebhookDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_webhook_headers_with_http_info(webhook_id, webhook_headers, **kwargs) # noqa: E501 def update_webhook_headers_with_http_info(self, webhook_id, webhook_headers, **kwargs)-
Update a webhook request headers # 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_webhook_headers_with_http_info(webhook_id, webhook_headers, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: (required) :param WebhookHeaders webhook_headers: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def update_webhook_headers_with_http_info(self, webhook_id, webhook_headers, **kwargs): # noqa: E501 """Update a webhook request headers # 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_webhook_headers_with_http_info(webhook_id, webhook_headers, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: (required) :param WebhookHeaders webhook_headers: (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(WebhookDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_id', 'webhook_headers' ] 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 update_webhook_headers" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `update_webhook_headers`") # noqa: E501 # verify the required parameter 'webhook_headers' is set if self.api_client.client_side_validation and ('webhook_headers' not in local_var_params or # noqa: E501 local_var_params['webhook_headers'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_headers` when calling `update_webhook_headers`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'webhook_headers' in local_var_params: body_params = local_var_params['webhook_headers'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/headers', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='WebhookDto', # 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 verify_webhook_signature(self, verify_webhook_signature_options, **kwargs)-
Verify a webhook payload signature # noqa: E501
Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.verify_webhook_signature(verify_webhook_signature_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param VerifyWebhookSignatureOptions verify_webhook_signature_options: (required) :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: VerifyWebhookSignatureResults If the method is called asynchronously, returns the request thread.
Expand source code
def verify_webhook_signature(self, verify_webhook_signature_options, **kwargs): # noqa: E501 """Verify a webhook payload signature # noqa: E501 Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.verify_webhook_signature(verify_webhook_signature_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param VerifyWebhookSignatureOptions verify_webhook_signature_options: (required) :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: VerifyWebhookSignatureResults If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.verify_webhook_signature_with_http_info(verify_webhook_signature_options, **kwargs) # noqa: E501 def verify_webhook_signature_with_http_info(self, verify_webhook_signature_options, **kwargs)-
Verify a webhook payload signature # noqa: E501
Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.verify_webhook_signature_with_http_info(verify_webhook_signature_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param VerifyWebhookSignatureOptions verify_webhook_signature_options: (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(VerifyWebhookSignatureResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def verify_webhook_signature_with_http_info(self, verify_webhook_signature_options, **kwargs): # noqa: E501 """Verify a webhook payload signature # noqa: E501 Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.verify_webhook_signature_with_http_info(verify_webhook_signature_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param VerifyWebhookSignatureOptions verify_webhook_signature_options: (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(VerifyWebhookSignatureResults, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'verify_webhook_signature_options' ] 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 verify_webhook_signature" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'verify_webhook_signature_options' is set if self.api_client.client_side_validation and ('verify_webhook_signature_options' not in local_var_params or # noqa: E501 local_var_params['verify_webhook_signature_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `verify_webhook_signature_options` when calling `verify_webhook_signature`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'verify_webhook_signature_options' in local_var_params: body_params = local_var_params['verify_webhook_signature_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/verify', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='VerifyWebhookSignatureResults', # 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 wait_for_webhook_results(self, webhook_id, expected_count, timeout, **kwargs)-
Wait for webhook results for a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_webhook_results(webhook_id, expected_count, timeout, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int expected_count: Expected result count (required) :param int timeout: Max time to wait in milliseconds (required) :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: list[WebhookResultDto] If the method is called asynchronously, returns the request thread.
Expand source code
def wait_for_webhook_results(self, webhook_id, expected_count, timeout, **kwargs): # noqa: E501 """Wait for webhook results for a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_webhook_results(webhook_id, expected_count, timeout, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int expected_count: Expected result count (required) :param int timeout: Max time to wait in milliseconds (required) :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: list[WebhookResultDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, **kwargs) # noqa: E501 def wait_for_webhook_results_with_http_info(self, webhook_id, expected_count, timeout, **kwargs)-
Wait for webhook results for a webhook # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int expected_count: Expected result count (required) :param int timeout: Max time to wait in milliseconds (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(list[WebhookResultDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def wait_for_webhook_results_with_http_info(self, webhook_id, expected_count, timeout, **kwargs): # noqa: E501 """Wait for webhook results for a webhook # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_webhook_results_with_http_info(webhook_id, expected_count, timeout, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str webhook_id: ID of webhook to get results for (required) :param int expected_count: Expected result count (required) :param int timeout: Max time to wait in milliseconds (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(list[WebhookResultDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'webhook_id', 'expected_count', 'timeout' ] 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 wait_for_webhook_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'webhook_id' is set if self.api_client.client_side_validation and ('webhook_id' not in local_var_params or # noqa: E501 local_var_params['webhook_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `webhook_id` when calling `wait_for_webhook_results`") # noqa: E501 # verify the required parameter 'expected_count' is set if self.api_client.client_side_validation and ('expected_count' not in local_var_params or # noqa: E501 local_var_params['expected_count'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `expected_count` when calling `wait_for_webhook_results`") # noqa: E501 # verify the required parameter 'timeout' is set if self.api_client.client_side_validation and ('timeout' not in local_var_params or # noqa: E501 local_var_params['timeout'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `timeout` when calling `wait_for_webhook_results`") # noqa: E501 if self.api_client.client_side_validation and 'expected_count' in local_var_params and local_var_params['expected_count'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `expected_count` when calling `wait_for_webhook_results`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'timeout' in local_var_params and local_var_params['timeout'] > 300000: # noqa: E501 raise ApiValueError("Invalid value for parameter `timeout` when calling `wait_for_webhook_results`, must be a value less than or equal to `300000`") # noqa: E501 if self.api_client.client_side_validation and 'timeout' in local_var_params and local_var_params['timeout'] < 1000: # noqa: E501 raise ApiValueError("Invalid value for parameter `timeout` when calling `wait_for_webhook_results`, must be a value greater than or equal to `1000`") # noqa: E501 collection_formats = {} path_params = {} if 'webhook_id' in local_var_params: path_params['webhookId'] = local_var_params['webhook_id'] # noqa: E501 query_params = [] if 'expected_count' in local_var_params and local_var_params['expected_count'] is not None: # noqa: E501 query_params.append(('expectedCount', local_var_params['expected_count'])) # noqa: E501 if 'timeout' in local_var_params and local_var_params['timeout'] is not None: # noqa: E501 query_params.append(('timeout', local_var_params['timeout'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}/wait', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[WebhookResultDto]', # 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)