Module mailslurp_client.api.inbox_forwarder_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 InboxForwarderControllerApi(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_new_inbox_forwarder(self, inbox_id, create_inbox_forwarder_options, **kwargs): # noqa: E501
"""Create an inbox forwarder # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Inbox id to attach forwarder to (required)
:param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.create_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, **kwargs) # noqa: E501
def create_new_inbox_forwarder_with_http_info(self, inbox_id, create_inbox_forwarder_options, **kwargs): # noqa: E501
"""Create an inbox forwarder # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Inbox id to attach forwarder to (required)
:param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'create_inbox_forwarder_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_new_inbox_forwarder" % 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_new_inbox_forwarder`") # noqa: E501
# verify the required parameter 'create_inbox_forwarder_options' is set
if self.api_client.client_side_validation and ('create_inbox_forwarder_options' not in local_var_params or # noqa: E501
local_var_params['create_inbox_forwarder_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_inbox_forwarder_options` when calling `create_new_inbox_forwarder`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_inbox_forwarder_options' in local_var_params:
body_params = local_var_params['create_inbox_forwarder_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(
'/forwarders', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderDto', # 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_inbox_forwarder(self, id, **kwargs): # noqa: E501
"""Delete an inbox forwarder # noqa: E501
Delete inbox forwarder # 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_inbox_forwarder(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (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_inbox_forwarder_with_http_info(id, **kwargs) # noqa: E501
def delete_inbox_forwarder_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete an inbox forwarder # noqa: E501
Delete inbox forwarder # 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_inbox_forwarder_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (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 = [
'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_inbox_forwarder" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `delete_inbox_forwarder`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['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(
'/forwarders/{id}', '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_inbox_forwarders(self, **kwargs): # noqa: E501
"""Delete inbox forwarders # noqa: E501
Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Optional inbox id to attach forwarder to
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for 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_inbox_forwarders_with_http_info(**kwargs) # noqa: E501
def delete_inbox_forwarders_with_http_info(self, **kwargs): # noqa: E501
"""Delete inbox forwarders # noqa: E501
Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Optional inbox id to attach forwarder to
: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'
]
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_inbox_forwarders" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_KEY'] # noqa: E501
return self.api_client.call_api(
'/forwarders', '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_inbox_forwarder_events(self, **kwargs): # noqa: E501
"""Get all inbox forwarder events # noqa: E501
Get all inbox forwarder events # 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_inbox_forwarder_events(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in inbox forwarder event list pagination
:param int size: Optional page size in inbox forwarder event list pagination
:param str inbox_id: Optional inbox ID to filter for
:param str sort: Optional createdAt sort direction ASC or DESC
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageInboxForwarderEvents
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_all_inbox_forwarder_events_with_http_info(**kwargs) # noqa: E501
def get_all_inbox_forwarder_events_with_http_info(self, **kwargs): # noqa: E501
"""Get all inbox forwarder events # noqa: E501
Get all inbox forwarder events # 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_inbox_forwarder_events_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page: Optional page index in inbox forwarder event list pagination
:param int size: Optional page size in inbox forwarder event list pagination
:param str inbox_id: Optional inbox ID to filter for
:param str sort: Optional createdAt sort direction ASC or DESC
: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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page',
'size',
'inbox_id',
'sort'
]
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_inbox_forwarder_events" % 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 '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 '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
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(
'/forwarders/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxForwarderEvents', # 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_forwarder_event(self, event_id, **kwargs): # noqa: E501
"""Get a forwarder event # noqa: E501
Get forwarder 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_forwarder_event(event_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_forwarder_event_with_http_info(event_id, **kwargs) # noqa: E501
def get_forwarder_event_with_http_info(self, event_id, **kwargs): # noqa: E501
"""Get a forwarder event # noqa: E501
Get forwarder 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_forwarder_event_with_http_info(event_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'event_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_forwarder_event" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'event_id' is set
if self.api_client.client_side_validation and ('event_id' not in local_var_params or # noqa: E501
local_var_params['event_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `event_id` when calling `get_forwarder_event`") # noqa: E501
collection_formats = {}
path_params = {}
if 'event_id' in local_var_params:
path_params['eventId'] = local_var_params['event_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(
'/forwarders/events/{eventId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderEventDto', # 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_forwarder(self, id, **kwargs): # noqa: E501
"""Get an inbox forwarder # noqa: E501
Get inbox forwarder # 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_forwarder(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (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: InboxForwarderDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_forwarder_with_http_info(id, **kwargs) # noqa: E501
def get_inbox_forwarder_with_http_info(self, id, **kwargs): # noqa: E501
"""Get an inbox forwarder # noqa: E501
Get inbox forwarder # 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_forwarder_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'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_inbox_forwarder" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['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(
'/forwarders/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderDto', # 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_forwarder_event(self, id, event_id, **kwargs): # noqa: E501
"""Get an inbox forwarder event # noqa: E501
Get inbox forwarder 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_inbox_forwarder_event(id, event_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_forwarder_event_with_http_info(id, event_id, **kwargs) # noqa: E501
def get_inbox_forwarder_event_with_http_info(self, id, event_id, **kwargs): # noqa: E501
"""Get an inbox forwarder event # noqa: E501
Get inbox forwarder 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_inbox_forwarder_event_with_http_info(id, event_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'id',
'event_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_inbox_forwarder_event" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder_event`") # noqa: E501
# verify the required parameter 'event_id' is set
if self.api_client.client_side_validation and ('event_id' not in local_var_params or # noqa: E501
local_var_params['event_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `event_id` when calling `get_inbox_forwarder_event`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'event_id' in local_var_params:
path_params['eventId'] = local_var_params['event_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(
'/forwarders/{id}/events/{eventId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderEventDto', # 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_forwarder_events(self, id, **kwargs): # noqa: E501
"""Get an inbox forwarder event list # noqa: E501
Get inbox forwarder events # 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_forwarder_events(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param int page: Optional page index in inbox forwarder event list pagination
:param int size: Optional page size in inbox forwarder event list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: PageInboxForwarderEvents
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_forwarder_events_with_http_info(id, **kwargs) # noqa: E501
def get_inbox_forwarder_events_with_http_info(self, id, **kwargs): # noqa: E501
"""Get an inbox forwarder event list # noqa: E501
Get inbox forwarder events # 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_forwarder_events_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param int page: Optional page index in inbox forwarder event list pagination
:param int size: Optional page size in inbox forwarder event list pagination
:param str sort: Optional createdAt sort direction ASC or DESC
: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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'id',
'page',
'size',
'sort'
]
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_forwarder_events" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder_events`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['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
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(
'/forwarders/{id}/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxForwarderEvents', # 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_forwarders(self, **kwargs): # noqa: E501
"""List inbox forwarders # noqa: E501
List all forwarders attached to 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_forwarders(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Optional inbox id to get forwarders from
:param int page: Optional page index in inbox forwarder list pagination
:param int size: Optional page size in inbox forwarder 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: PageInboxForwarderDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_inbox_forwarders_with_http_info(**kwargs) # noqa: E501
def get_inbox_forwarders_with_http_info(self, **kwargs): # noqa: E501
"""List inbox forwarders # noqa: E501
List all forwarders attached to 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_forwarders_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: Optional inbox id to get forwarders from
:param int page: Optional page index in inbox forwarder list pagination
:param int size: Optional page size in inbox forwarder 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(PageInboxForwarderDto, 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_forwarders" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
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 '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(
'/forwarders', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PageInboxForwarderDto', # 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 test_inbox_forwarder(self, id, inbox_forwarder_test_options, **kwargs): # noqa: E501
"""Test an inbox forwarder # noqa: E501
Test an inbox forwarder # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_inbox_forwarder(id, inbox_forwarder_test_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, **kwargs) # noqa: E501
def test_inbox_forwarder_with_http_info(self, id, inbox_forwarder_test_options, **kwargs): # noqa: E501
"""Test an inbox forwarder # noqa: E501
Test an inbox forwarder # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'id',
'inbox_forwarder_test_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 test_inbox_forwarder" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `test_inbox_forwarder`") # noqa: E501
# verify the required parameter 'inbox_forwarder_test_options' is set
if self.api_client.client_side_validation and ('inbox_forwarder_test_options' not in local_var_params or # noqa: E501
local_var_params['inbox_forwarder_test_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_forwarder_test_options` when calling `test_inbox_forwarder`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'inbox_forwarder_test_options' in local_var_params:
body_params = local_var_params['inbox_forwarder_test_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(
'/forwarders/{id}/test', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderTestResult', # 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 test_inbox_forwarders_for_inbox(self, inbox_id, inbox_forwarder_test_options, **kwargs): # noqa: E501
"""Test inbox forwarders for inbox # noqa: E501
Test inbox forwarders for 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.test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of inbox (required)
:param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, **kwargs) # noqa: E501
def test_inbox_forwarders_for_inbox_with_http_info(self, inbox_id, inbox_forwarder_test_options, **kwargs): # noqa: E501
"""Test inbox forwarders for inbox # noqa: E501
Test inbox forwarders for 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.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str inbox_id: ID of inbox (required)
:param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'inbox_id',
'inbox_forwarder_test_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 test_inbox_forwarders_for_inbox" % 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 `test_inbox_forwarders_for_inbox`") # noqa: E501
# verify the required parameter 'inbox_forwarder_test_options' is set
if self.api_client.client_side_validation and ('inbox_forwarder_test_options' not in local_var_params or # noqa: E501
local_var_params['inbox_forwarder_test_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `inbox_forwarder_test_options` when calling `test_inbox_forwarders_for_inbox`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'inbox_forwarder_test_options' in local_var_params:
body_params = local_var_params['inbox_forwarder_test_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(
'/forwarders', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderTestResult', # 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 test_new_inbox_forwarder(self, test_new_inbox_forwarder_options, **kwargs): # noqa: E501
"""Test new inbox forwarder # noqa: E501
Test new inbox forwarder # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_new_inbox_forwarder(test_new_inbox_forwarder_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param TestNewInboxForwarderOptions test_new_inbox_forwarder_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: InboxForwarderTestResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, **kwargs) # noqa: E501
def test_new_inbox_forwarder_with_http_info(self, test_new_inbox_forwarder_options, **kwargs): # noqa: E501
"""Test new inbox forwarder # noqa: E501
Test new inbox forwarder # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param TestNewInboxForwarderOptions test_new_inbox_forwarder_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'test_new_inbox_forwarder_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 test_new_inbox_forwarder" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'test_new_inbox_forwarder_options' is set
if self.api_client.client_side_validation and ('test_new_inbox_forwarder_options' not in local_var_params or # noqa: E501
local_var_params['test_new_inbox_forwarder_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `test_new_inbox_forwarder_options` when calling `test_new_inbox_forwarder`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'test_new_inbox_forwarder_options' in local_var_params:
body_params = local_var_params['test_new_inbox_forwarder_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(
'/forwarders', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderTestResult', # 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_inbox_forwarder(self, id, create_inbox_forwarder_options, **kwargs): # noqa: E501
"""Update an inbox forwarder # noqa: E501
Update inbox forwarder # 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_inbox_forwarder(id, create_inbox_forwarder_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, **kwargs) # noqa: E501
def update_inbox_forwarder_with_http_info(self, id, create_inbox_forwarder_options, **kwargs): # noqa: E501
"""Update an inbox forwarder # noqa: E501
Update inbox forwarder # 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_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: ID of inbox forwarder (required)
:param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'id',
'create_inbox_forwarder_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 update_inbox_forwarder" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `update_inbox_forwarder`") # noqa: E501
# verify the required parameter 'create_inbox_forwarder_options' is set
if self.api_client.client_side_validation and ('create_inbox_forwarder_options' not in local_var_params or # noqa: E501
local_var_params['create_inbox_forwarder_options'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `create_inbox_forwarder_options` when calling `update_inbox_forwarder`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_inbox_forwarder_options' in local_var_params:
body_params = local_var_params['create_inbox_forwarder_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(
'/forwarders/{id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InboxForwarderDto', # 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 InboxForwarderControllerApi (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 InboxForwarderControllerApi(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_new_inbox_forwarder(self, inbox_id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Create an inbox forwarder # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox id to attach forwarder to (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, **kwargs) # noqa: E501 def create_new_inbox_forwarder_with_http_info(self, inbox_id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Create an inbox forwarder # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox id to attach forwarder to (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'create_inbox_forwarder_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_new_inbox_forwarder" % 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_new_inbox_forwarder`") # noqa: E501 # verify the required parameter 'create_inbox_forwarder_options' is set if self.api_client.client_side_validation and ('create_inbox_forwarder_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_forwarder_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_forwarder_options` when calling `create_new_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_forwarder_options' in local_var_params: body_params = local_var_params['create_inbox_forwarder_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( '/forwarders', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderDto', # 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_inbox_forwarder(self, id, **kwargs): # noqa: E501 """Delete an inbox forwarder # noqa: E501 Delete inbox forwarder # 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_inbox_forwarder(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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_inbox_forwarder_with_http_info(id, **kwargs) # noqa: E501 def delete_inbox_forwarder_with_http_info(self, id, **kwargs): # noqa: E501 """Delete an inbox forwarder # noqa: E501 Delete inbox forwarder # 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_inbox_forwarder_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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 = [ '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_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `delete_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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( '/forwarders/{id}', '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_inbox_forwarders(self, **kwargs): # noqa: E501 """Delete inbox forwarders # noqa: E501 Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach forwarder to :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_inbox_forwarders_with_http_info(**kwargs) # noqa: E501 def delete_inbox_forwarders_with_http_info(self, **kwargs): # noqa: E501 """Delete inbox forwarders # noqa: E501 Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach forwarder to :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' ] 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_inbox_forwarders" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/forwarders', '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_inbox_forwarder_events(self, **kwargs): # noqa: E501 """Get all inbox forwarder events # noqa: E501 Get all inbox forwarder events # 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_inbox_forwarder_events(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str inbox_id: Optional inbox ID to filter for :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxForwarderEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inbox_forwarder_events_with_http_info(**kwargs) # noqa: E501 def get_all_inbox_forwarder_events_with_http_info(self, **kwargs): # noqa: E501 """Get all inbox forwarder events # noqa: E501 Get all inbox forwarder events # 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_inbox_forwarder_events_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str inbox_id: Optional inbox ID to filter for :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'inbox_id', 'sort' ] 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_inbox_forwarder_events" % 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 '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 '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 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( '/forwarders/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxForwarderEvents', # 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_forwarder_event(self, event_id, **kwargs): # noqa: E501 """Get a forwarder event # noqa: E501 Get forwarder 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_forwarder_event(event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_forwarder_event_with_http_info(event_id, **kwargs) # noqa: E501 def get_forwarder_event_with_http_info(self, event_id, **kwargs): # noqa: E501 """Get a forwarder event # noqa: E501 Get forwarder 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_forwarder_event_with_http_info(event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'event_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_forwarder_event" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'event_id' is set if self.api_client.client_side_validation and ('event_id' not in local_var_params or # noqa: E501 local_var_params['event_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `event_id` when calling `get_forwarder_event`") # noqa: E501 collection_formats = {} path_params = {} if 'event_id' in local_var_params: path_params['eventId'] = local_var_params['event_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( '/forwarders/events/{eventId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderEventDto', # 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_forwarder(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder # noqa: E501 Get inbox forwarder # 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_forwarder(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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: InboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarder_with_http_info(id, **kwargs) # noqa: E501 def get_inbox_forwarder_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder # noqa: E501 Get inbox forwarder # 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_forwarder_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '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_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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( '/forwarders/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderDto', # 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_forwarder_event(self, id, event_id, **kwargs): # noqa: E501 """Get an inbox forwarder event # noqa: E501 Get inbox forwarder 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_inbox_forwarder_event(id, event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarder_event_with_http_info(id, event_id, **kwargs) # noqa: E501 def get_inbox_forwarder_event_with_http_info(self, id, event_id, **kwargs): # noqa: E501 """Get an inbox forwarder event # noqa: E501 Get inbox forwarder 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_inbox_forwarder_event_with_http_info(id, event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'event_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_inbox_forwarder_event" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder_event`") # noqa: E501 # verify the required parameter 'event_id' is set if self.api_client.client_side_validation and ('event_id' not in local_var_params or # noqa: E501 local_var_params['event_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `event_id` when calling `get_inbox_forwarder_event`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'event_id' in local_var_params: path_params['eventId'] = local_var_params['event_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( '/forwarders/{id}/events/{eventId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderEventDto', # 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_forwarder_events(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder event list # noqa: E501 Get inbox forwarder events # 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_forwarder_events(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxForwarderEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarder_events_with_http_info(id, **kwargs) # noqa: E501 def get_inbox_forwarder_events_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder event list # noqa: E501 Get inbox forwarder events # 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_forwarder_events_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'page', 'size', 'sort' ] 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_forwarder_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder_events`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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 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( '/forwarders/{id}/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxForwarderEvents', # 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_forwarders(self, **kwargs): # noqa: E501 """List inbox forwarders # noqa: E501 List all forwarders attached to 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_forwarders(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get forwarders from :param int page: Optional page index in inbox forwarder list pagination :param int size: Optional page size in inbox forwarder 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: PageInboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarders_with_http_info(**kwargs) # noqa: E501 def get_inbox_forwarders_with_http_info(self, **kwargs): # noqa: E501 """List inbox forwarders # noqa: E501 List all forwarders attached to 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_forwarders_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get forwarders from :param int page: Optional page index in inbox forwarder list pagination :param int size: Optional page size in inbox forwarder 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(PageInboxForwarderDto, 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_forwarders" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] 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 '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( '/forwarders', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxForwarderDto', # 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 test_inbox_forwarder(self, id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test an inbox forwarder # noqa: E501 Test an inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_inbox_forwarder(id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, **kwargs) # noqa: E501 def test_inbox_forwarder_with_http_info(self, id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test an inbox forwarder # noqa: E501 Test an inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'inbox_forwarder_test_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 test_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `test_inbox_forwarder`") # noqa: E501 # verify the required parameter 'inbox_forwarder_test_options' is set if self.api_client.client_side_validation and ('inbox_forwarder_test_options' not in local_var_params or # noqa: E501 local_var_params['inbox_forwarder_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_forwarder_test_options` when calling `test_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'inbox_forwarder_test_options' in local_var_params: body_params = local_var_params['inbox_forwarder_test_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( '/forwarders/{id}/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderTestResult', # 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 test_inbox_forwarders_for_inbox(self, inbox_id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test inbox forwarders for inbox # noqa: E501 Test inbox forwarders for 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.test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox (required) :param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, **kwargs) # noqa: E501 def test_inbox_forwarders_for_inbox_with_http_info(self, inbox_id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test inbox forwarders for inbox # noqa: E501 Test inbox forwarders for 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.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox (required) :param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'inbox_forwarder_test_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 test_inbox_forwarders_for_inbox" % 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 `test_inbox_forwarders_for_inbox`") # noqa: E501 # verify the required parameter 'inbox_forwarder_test_options' is set if self.api_client.client_side_validation and ('inbox_forwarder_test_options' not in local_var_params or # noqa: E501 local_var_params['inbox_forwarder_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_forwarder_test_options` when calling `test_inbox_forwarders_for_inbox`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None if 'inbox_forwarder_test_options' in local_var_params: body_params = local_var_params['inbox_forwarder_test_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( '/forwarders', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderTestResult', # 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 test_new_inbox_forwarder(self, test_new_inbox_forwarder_options, **kwargs): # noqa: E501 """Test new inbox forwarder # noqa: E501 Test new inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_new_inbox_forwarder(test_new_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TestNewInboxForwarderOptions test_new_inbox_forwarder_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, **kwargs) # noqa: E501 def test_new_inbox_forwarder_with_http_info(self, test_new_inbox_forwarder_options, **kwargs): # noqa: E501 """Test new inbox forwarder # noqa: E501 Test new inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TestNewInboxForwarderOptions test_new_inbox_forwarder_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'test_new_inbox_forwarder_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 test_new_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'test_new_inbox_forwarder_options' is set if self.api_client.client_side_validation and ('test_new_inbox_forwarder_options' not in local_var_params or # noqa: E501 local_var_params['test_new_inbox_forwarder_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `test_new_inbox_forwarder_options` when calling `test_new_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'test_new_inbox_forwarder_options' in local_var_params: body_params = local_var_params['test_new_inbox_forwarder_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( '/forwarders', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderTestResult', # 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_inbox_forwarder(self, id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Update an inbox forwarder # noqa: E501 Update inbox forwarder # 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_inbox_forwarder(id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, **kwargs) # noqa: E501 def update_inbox_forwarder_with_http_info(self, id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Update an inbox forwarder # noqa: E501 Update inbox forwarder # 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_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_inbox_forwarder_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 update_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `update_inbox_forwarder`") # noqa: E501 # verify the required parameter 'create_inbox_forwarder_options' is set if self.api_client.client_side_validation and ('create_inbox_forwarder_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_forwarder_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_forwarder_options` when calling `update_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_forwarder_options' in local_var_params: body_params = local_var_params['create_inbox_forwarder_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( '/forwarders/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderDto', # 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_new_inbox_forwarder(self, inbox_id, create_inbox_forwarder_options, **kwargs)
-
Create an inbox forwarder # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Inbox id to attach forwarder to (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto If the method is called asynchronously, returns the request thread.
Expand source code
def create_new_inbox_forwarder(self, inbox_id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Create an inbox forwarder # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox id to attach forwarder to (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, **kwargs) # noqa: E501
def create_new_inbox_forwarder_with_http_info(self, inbox_id, create_inbox_forwarder_options, **kwargs)
-
Create an inbox forwarder # noqa: E501
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Inbox id to attach forwarder to (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def create_new_inbox_forwarder_with_http_info(self, inbox_id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Create an inbox forwarder # noqa: E501 Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving # 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_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Inbox id to attach forwarder to (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'create_inbox_forwarder_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_new_inbox_forwarder" % 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_new_inbox_forwarder`") # noqa: E501 # verify the required parameter 'create_inbox_forwarder_options' is set if self.api_client.client_side_validation and ('create_inbox_forwarder_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_forwarder_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_forwarder_options` when calling `create_new_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_forwarder_options' in local_var_params: body_params = local_var_params['create_inbox_forwarder_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( '/forwarders', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderDto', # 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_inbox_forwarder(self, id, **kwargs)
-
Delete an inbox forwarder # noqa: E501
Delete inbox forwarder # 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_inbox_forwarder(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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_inbox_forwarder(self, id, **kwargs): # noqa: E501 """Delete an inbox forwarder # noqa: E501 Delete inbox forwarder # 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_inbox_forwarder(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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_inbox_forwarder_with_http_info(id, **kwargs) # noqa: E501
def delete_inbox_forwarder_with_http_info(self, id, **kwargs)
-
Delete an inbox forwarder # noqa: E501
Delete inbox forwarder # 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_inbox_forwarder_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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_inbox_forwarder_with_http_info(self, id, **kwargs): # noqa: E501 """Delete an inbox forwarder # noqa: E501 Delete inbox forwarder # 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_inbox_forwarder_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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 = [ '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_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `delete_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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( '/forwarders/{id}', '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_inbox_forwarders(self, **kwargs)
-
Delete inbox forwarders # noqa: E501
Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach forwarder to :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_inbox_forwarders(self, **kwargs): # noqa: E501 """Delete inbox forwarders # noqa: E501 Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach forwarder to :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for 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_inbox_forwarders_with_http_info(**kwargs) # noqa: E501
def delete_inbox_forwarders_with_http_info(self, **kwargs)
-
Delete inbox forwarders # noqa: E501
Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders_with_http_info(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach forwarder to :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_inbox_forwarders_with_http_info(self, **kwargs): # noqa: E501 """Delete inbox forwarders # noqa: E501 Delete inbox forwarders. Accepts optional inboxId filter. # 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_inbox_forwarders_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach forwarder to :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' ] 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_inbox_forwarders" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/forwarders', '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_inbox_forwarder_events(self, **kwargs)
-
Get all inbox forwarder events # noqa: E501
Get all inbox forwarder events # 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_inbox_forwarder_events(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str inbox_id: Optional inbox ID to filter for :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxForwarderEvents If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_inbox_forwarder_events(self, **kwargs): # noqa: E501 """Get all inbox forwarder events # noqa: E501 Get all inbox forwarder events # 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_inbox_forwarder_events(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str inbox_id: Optional inbox ID to filter for :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxForwarderEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inbox_forwarder_events_with_http_info(**kwargs) # noqa: E501
def get_all_inbox_forwarder_events_with_http_info(self, **kwargs)
-
Get all inbox forwarder events # noqa: E501
Get all inbox forwarder events # 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_inbox_forwarder_events_with_http_info(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str inbox_id: Optional inbox ID to filter for :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_all_inbox_forwarder_events_with_http_info(self, **kwargs): # noqa: E501 """Get all inbox forwarder events # noqa: E501 Get all inbox forwarder events # 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_inbox_forwarder_events_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str inbox_id: Optional inbox ID to filter for :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'inbox_id', 'sort' ] 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_inbox_forwarder_events" % 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 '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 '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 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( '/forwarders/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxForwarderEvents', # 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_forwarder_event(self, event_id, **kwargs)
-
Get a forwarder event # noqa: E501
Get forwarder 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_forwarder_event(event_id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_forwarder_event(self, event_id, **kwargs): # noqa: E501 """Get a forwarder event # noqa: E501 Get forwarder 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_forwarder_event(event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_forwarder_event_with_http_info(event_id, **kwargs) # noqa: E501
def get_forwarder_event_with_http_info(self, event_id, **kwargs)
-
Get a forwarder event # noqa: E501
Get forwarder 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_forwarder_event_with_http_info(event_id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_forwarder_event_with_http_info(self, event_id, **kwargs): # noqa: E501 """Get a forwarder event # noqa: E501 Get forwarder 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_forwarder_event_with_http_info(event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'event_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_forwarder_event" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'event_id' is set if self.api_client.client_side_validation and ('event_id' not in local_var_params or # noqa: E501 local_var_params['event_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `event_id` when calling `get_forwarder_event`") # noqa: E501 collection_formats = {} path_params = {} if 'event_id' in local_var_params: path_params['eventId'] = local_var_params['event_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( '/forwarders/events/{eventId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderEventDto', # 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_forwarder(self, id, **kwargs)
-
Get an inbox forwarder # noqa: E501
Get inbox forwarder # 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_forwarder(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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: InboxForwarderDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarder(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder # noqa: E501 Get inbox forwarder # 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_forwarder(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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: InboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarder_with_http_info(id, **kwargs) # noqa: E501
def get_inbox_forwarder_event(self, id, event_id, **kwargs)
-
Get an inbox forwarder event # noqa: E501
Get inbox forwarder 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_inbox_forwarder_event(id, event_id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarder_event(self, id, event_id, **kwargs): # noqa: E501 """Get an inbox forwarder event # noqa: E501 Get inbox forwarder 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_inbox_forwarder_event(id, event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param str event_id: ID of inbox forwarder 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: InboxForwarderEventDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarder_event_with_http_info(id, event_id, **kwargs) # noqa: E501
def get_inbox_forwarder_event_with_http_info(self, id, event_id, **kwargs)
-
Get an inbox forwarder event # noqa: E501
Get inbox forwarder 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_inbox_forwarder_event_with_http_info(id, event_id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarder_event_with_http_info(self, id, event_id, **kwargs): # noqa: E501 """Get an inbox forwarder event # noqa: E501 Get inbox forwarder 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_inbox_forwarder_event_with_http_info(id, event_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param str event_id: ID of inbox forwarder 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(InboxForwarderEventDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'event_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_inbox_forwarder_event" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder_event`") # noqa: E501 # verify the required parameter 'event_id' is set if self.api_client.client_side_validation and ('event_id' not in local_var_params or # noqa: E501 local_var_params['event_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `event_id` when calling `get_inbox_forwarder_event`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'event_id' in local_var_params: path_params['eventId'] = local_var_params['event_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( '/forwarders/{id}/events/{eventId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderEventDto', # 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_forwarder_events(self, id, **kwargs)
-
Get an inbox forwarder event list # noqa: E501
Get inbox forwarder events # 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_forwarder_events(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxForwarderEvents If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarder_events(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder event list # noqa: E501 Get inbox forwarder events # 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_forwarder_events(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageInboxForwarderEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarder_events_with_http_info(id, **kwargs) # noqa: E501
def get_inbox_forwarder_events_with_http_info(self, id, **kwargs)
-
Get an inbox forwarder event list # noqa: E501
Get inbox forwarder events # 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_forwarder_events_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarder_events_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder event list # noqa: E501 Get inbox forwarder events # 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_forwarder_events_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param int page: Optional page index in inbox forwarder event list pagination :param int size: Optional page size in inbox forwarder event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxForwarderEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'page', 'size', 'sort' ] 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_forwarder_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder_events`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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 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( '/forwarders/{id}/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxForwarderEvents', # 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_forwarder_with_http_info(self, id, **kwargs)
-
Get an inbox forwarder # noqa: E501
Get inbox forwarder # 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_forwarder_with_http_info(id, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarder_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox forwarder # noqa: E501 Get inbox forwarder # 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_forwarder_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '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_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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( '/forwarders/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderDto', # 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_forwarders(self, **kwargs)
-
List inbox forwarders # noqa: E501
List all forwarders attached to 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_forwarders(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get forwarders from :param int page: Optional page index in inbox forwarder list pagination :param int size: Optional page size in inbox forwarder 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: PageInboxForwarderDto If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarders(self, **kwargs): # noqa: E501 """List inbox forwarders # noqa: E501 List all forwarders attached to 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_forwarders(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get forwarders from :param int page: Optional page index in inbox forwarder list pagination :param int size: Optional page size in inbox forwarder 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: PageInboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_forwarders_with_http_info(**kwargs) # noqa: E501
def get_inbox_forwarders_with_http_info(self, **kwargs)
-
List inbox forwarders # noqa: E501
List all forwarders attached to 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_forwarders_with_http_info(async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get forwarders from :param int page: Optional page index in inbox forwarder list pagination :param int size: Optional page size in inbox forwarder 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(PageInboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def get_inbox_forwarders_with_http_info(self, **kwargs): # noqa: E501 """List inbox forwarders # noqa: E501 List all forwarders attached to 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_forwarders_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get forwarders from :param int page: Optional page index in inbox forwarder list pagination :param int size: Optional page size in inbox forwarder 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(PageInboxForwarderDto, 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_forwarders" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] 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 '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( '/forwarders', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxForwarderDto', # 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 test_inbox_forwarder(self, id, inbox_forwarder_test_options, **kwargs)
-
Test an inbox forwarder # noqa: E501
Test an inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_inbox_forwarder(id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread.
Expand source code
def test_inbox_forwarder(self, id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test an inbox forwarder # noqa: E501 Test an inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_inbox_forwarder(id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, **kwargs) # noqa: E501
def test_inbox_forwarder_with_http_info(self, id, inbox_forwarder_test_options, **kwargs)
-
Test an inbox forwarder # noqa: E501
Test an inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def test_inbox_forwarder_with_http_info(self, id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test an inbox forwarder # noqa: E501 Test an inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'inbox_forwarder_test_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 test_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `test_inbox_forwarder`") # noqa: E501 # verify the required parameter 'inbox_forwarder_test_options' is set if self.api_client.client_side_validation and ('inbox_forwarder_test_options' not in local_var_params or # noqa: E501 local_var_params['inbox_forwarder_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_forwarder_test_options` when calling `test_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'inbox_forwarder_test_options' in local_var_params: body_params = local_var_params['inbox_forwarder_test_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( '/forwarders/{id}/test', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderTestResult', # 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 test_inbox_forwarders_for_inbox(self, inbox_id, inbox_forwarder_test_options, **kwargs)
-
Test inbox forwarders for inbox # noqa: E501
Test inbox forwarders for 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.test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox (required) :param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread.
Expand source code
def test_inbox_forwarders_for_inbox(self, inbox_id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test inbox forwarders for inbox # noqa: E501 Test inbox forwarders for 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.test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox (required) :param InboxForwarderTestOptions inbox_forwarder_test_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, **kwargs) # noqa: E501
def test_inbox_forwarders_for_inbox_with_http_info(self, inbox_id, inbox_forwarder_test_options, **kwargs)
-
Test inbox forwarders for inbox # noqa: E501
Test inbox forwarders for 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.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox (required) :param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def test_inbox_forwarders_for_inbox_with_http_info(self, inbox_id, inbox_forwarder_test_options, **kwargs): # noqa: E501 """Test inbox forwarders for inbox # noqa: E501 Test inbox forwarders for 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.test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: ID of inbox (required) :param InboxForwarderTestOptions inbox_forwarder_test_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'inbox_forwarder_test_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 test_inbox_forwarders_for_inbox" % 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 `test_inbox_forwarders_for_inbox`") # noqa: E501 # verify the required parameter 'inbox_forwarder_test_options' is set if self.api_client.client_side_validation and ('inbox_forwarder_test_options' not in local_var_params or # noqa: E501 local_var_params['inbox_forwarder_test_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `inbox_forwarder_test_options` when calling `test_inbox_forwarders_for_inbox`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] 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 header_params = {} form_params = [] local_var_files = {} body_params = None if 'inbox_forwarder_test_options' in local_var_params: body_params = local_var_params['inbox_forwarder_test_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( '/forwarders', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderTestResult', # 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 test_new_inbox_forwarder(self, test_new_inbox_forwarder_options, **kwargs)
-
Test new inbox forwarder # noqa: E501
Test new inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_new_inbox_forwarder(test_new_inbox_forwarder_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param TestNewInboxForwarderOptions test_new_inbox_forwarder_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread.
Expand source code
def test_new_inbox_forwarder(self, test_new_inbox_forwarder_options, **kwargs): # noqa: E501 """Test new inbox forwarder # noqa: E501 Test new inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_new_inbox_forwarder(test_new_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TestNewInboxForwarderOptions test_new_inbox_forwarder_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: InboxForwarderTestResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, **kwargs) # noqa: E501
def test_new_inbox_forwarder_with_http_info(self, test_new_inbox_forwarder_options, **kwargs)
-
Test new inbox forwarder # noqa: E501
Test new inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param TestNewInboxForwarderOptions test_new_inbox_forwarder_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def test_new_inbox_forwarder_with_http_info(self, test_new_inbox_forwarder_options, **kwargs): # noqa: E501 """Test new inbox forwarder # noqa: E501 Test new inbox forwarder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TestNewInboxForwarderOptions test_new_inbox_forwarder_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(InboxForwarderTestResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'test_new_inbox_forwarder_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 test_new_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'test_new_inbox_forwarder_options' is set if self.api_client.client_side_validation and ('test_new_inbox_forwarder_options' not in local_var_params or # noqa: E501 local_var_params['test_new_inbox_forwarder_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `test_new_inbox_forwarder_options` when calling `test_new_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'test_new_inbox_forwarder_options' in local_var_params: body_params = local_var_params['test_new_inbox_forwarder_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( '/forwarders', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderTestResult', # 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_inbox_forwarder(self, id, create_inbox_forwarder_options, **kwargs)
-
Update an inbox forwarder # noqa: E501
Update inbox forwarder # 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_inbox_forwarder(id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto If the method is called asynchronously, returns the request thread.
Expand source code
def update_inbox_forwarder(self, id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Update an inbox forwarder # noqa: E501 Update inbox forwarder # 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_inbox_forwarder(id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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: InboxForwarderDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, **kwargs) # noqa: E501
def update_inbox_forwarder_with_http_info(self, id, create_inbox_forwarder_options, **kwargs)
-
Update an inbox forwarder # noqa: E501
Update inbox forwarder # 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_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get()
:param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code
def update_inbox_forwarder_with_http_info(self, id, create_inbox_forwarder_options, **kwargs): # noqa: E501 """Update an inbox forwarder # noqa: E501 Update inbox forwarder # 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_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox forwarder (required) :param CreateInboxForwarderOptions create_inbox_forwarder_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(InboxForwarderDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'create_inbox_forwarder_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 update_inbox_forwarder" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `update_inbox_forwarder`") # noqa: E501 # verify the required parameter 'create_inbox_forwarder_options' is set if self.api_client.client_side_validation and ('create_inbox_forwarder_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_forwarder_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_forwarder_options` when calling `update_inbox_forwarder`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_forwarder_options' in local_var_params: body_params = local_var_params['create_inbox_forwarder_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( '/forwarders/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxForwarderDto', # 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)