def retrieve_delivery_report_with_http_info(self, omnimessage_id,
**kwargs): # noqa: E501
"""Retrieves the delivery report for the Omnimessage # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.retrieve_delivery_report_with_http_info(omnimessage_id, async_req=True)
>>> result = thread.get()
:param omnimessage_id: UUID of the omnimessage to for which the delivery report is to be retrieved (required)
:type omnimessage_id: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(DeliveryReportResponse, status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = ['omnimessage_id']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout', '_request_auth'
])
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 retrieve_delivery_report" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'omnimessage_id' is set
if self.api_client.client_side_validation and (
'omnimessage_id' not in local_var_params or # noqa: E501
local_var_params['omnimessage_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `omnimessage_id` when calling `retrieve_delivery_report`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'omnimessage_id' in local_var_params:
path_params['omnimessageId'] = local_var_params[
'omnimessage_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
response_types_map = {
200: "DeliveryReportResponse",
404: "ErrorOmnichannel",
}
return self.api_client.call_api(
'/omnimessage/{omnimessageId}/status',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_types_map=response_types_map,
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,
_request_auth=local_var_params.get('_request_auth'))
def add_to_blacklist_with_http_info(self, number_to_blacklist, **kwargs): # noqa: E501
"""Adds a phone number to the blacklist # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_to_blacklist_with_http_info(number_to_blacklist, async_req=True)
>>> result = thread.get()
:param number_to_blacklist: Phone number to be blacklisted (required)
:type number_to_blacklist: NumberToBlacklist
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: None
"""
local_var_params = locals()
all_params = [
'number_to_blacklist'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth'
]
)
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 add_to_blacklist" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'number_to_blacklist' is set
if self.api_client.client_side_validation and ('number_to_blacklist' not in local_var_params or # noqa: E501
local_var_params['number_to_blacklist'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `number_to_blacklist` when calling `add_to_blacklist`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'number_to_blacklist' in local_var_params:
body_params = local_var_params['number_to_blacklist']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
response_types_map = {}
return self.api_client.call_api(
'/phonebook/blacklist', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_types_map=response_types_map,
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,
_request_auth=local_var_params.get('_request_auth'))
def remove_contact_from_group_with_http_info(self, group_id, phone,
**kwargs): # noqa: E501
"""Removes a contact from a group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_contact_from_group_with_http_info(group_id, phone, async_req=True)
>>> result = thread.get()
:param group_id: String in UUID format (required)
:type group_id: str
:param phone: A phone number (required)
:type phone: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: None
"""
local_var_params = locals()
all_params = ['group_id', 'phone']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout', '_request_auth'
])
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 remove_contact_from_group" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'group_id' is set
if self.api_client.client_side_validation and (
'group_id' not in local_var_params or # noqa: E501
local_var_params['group_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `group_id` when calling `remove_contact_from_group`"
) # noqa: E501
# verify the required parameter 'phone' is set
if self.api_client.client_side_validation and (
'phone' not in local_var_params or # noqa: E501
local_var_params['phone'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `phone` when calling `remove_contact_from_group`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'group_id' in local_var_params:
path_params['groupId'] = local_var_params['group_id'] # noqa: E501
if 'phone' in local_var_params:
path_params['phone'] = local_var_params['phone'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
response_types_map = {}
return self.api_client.call_api(
'/phonebook/groups/{groupId}/contacts/{phone}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_types_map=response_types_map,
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,
_request_auth=local_var_params.get('_request_auth'))
def fetch_blacklist_with_http_info(self, **kwargs): # noqa: E501
"""Returns all blacklisted phone numbers # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.fetch_blacklist_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(FetchBlacklistSuccess, status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = [
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth'
]
)
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 fetch_blacklist" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
response_types_map = {
200: "FetchBlacklistSuccess",
401: "ErrorPhonebook",
}
return self.api_client.call_api(
'/phonebook/blacklist', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_types_map=response_types_map,
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,
_request_auth=local_var_params.get('_request_auth'))
def update_contact_with_http_info(self, phone, contact_update_fields,
**kwargs): # noqa: E501
"""Updates a contact # 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_contact_with_http_info(phone, contact_update_fields, async_req=True)
>>> result = thread.get()
:param phone: A phone number (required)
:type phone: str
:param contact_update_fields: (required)
:type contact_update_fields: ContactUpdateFields
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(ContactEnvelope, status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = ['phone', 'contact_update_fields']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout', '_request_auth'
])
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_contact" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'phone' is set
if self.api_client.client_side_validation and (
'phone' not in local_var_params or # noqa: E501
local_var_params['phone'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `phone` when calling `update_contact`"
) # noqa: E501
# verify the required parameter 'contact_update_fields' is set
if self.api_client.client_side_validation and (
'contact_update_fields' not in local_var_params
or # noqa: E501
local_var_params['contact_update_fields'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `contact_update_fields` when calling `update_contact`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'phone' in local_var_params:
path_params['phone'] = local_var_params['phone'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'contact_update_fields' in local_var_params:
body_params = local_var_params['contact_update_fields']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
response_types_map = {
200: "ContactEnvelope",
400: "ErrorPhonebook",
401: "ErrorPhonebook",
404: "ErrorPhonebook",
}
return self.api_client.call_api(
'/phonebook/contacts/{phone}',
'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_types_map=response_types_map,
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,
_request_auth=local_var_params.get('_request_auth'))