index
int64 0
731k
| package
stringlengths 2
98
⌀ | name
stringlengths 1
76
| docstring
stringlengths 0
281k
⌀ | code
stringlengths 4
1.07M
⌀ | signature
stringlengths 2
42.8k
⌀ |
|---|---|---|---|---|---|
60,216 |
sib_api_v3_sdk.api.tasks_api
|
crm_tasks_id_patch_with_http_info
|
Update a task # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasks_id_patch_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: (required)
:param Body7 body: Updated task details. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_tasks_id_patch_with_http_info(self, id, body, **kwargs): # noqa: E501
"""Update a task # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasks_id_patch_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: (required)
:param Body7 body: Updated task details. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method crm_tasks_id_patch" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `crm_tasks_id_patch`") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `crm_tasks_id_patch`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/crm/tasks/{id}', 'PATCH',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, body, **kwargs)
|
60,217 |
sib_api_v3_sdk.api.tasks_api
|
crm_tasks_post
|
Create a task # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasks_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body6 body: Task name. (required)
:return: InlineResponse2011
If the method is called asynchronously,
returns the request thread.
|
def crm_tasks_post(self, body, **kwargs): # noqa: E501
"""Create a task # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasks_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body6 body: Task name. (required)
:return: InlineResponse2011
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_tasks_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.crm_tasks_post_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body, **kwargs)
|
60,218 |
sib_api_v3_sdk.api.tasks_api
|
crm_tasks_post_with_http_info
|
Create a task # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasks_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body6 body: Task name. (required)
:return: InlineResponse2011
If the method is called asynchronously,
returns the request thread.
|
def crm_tasks_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Create a task # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasks_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body6 body: Task name. (required)
:return: InlineResponse2011
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method crm_tasks_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `crm_tasks_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/crm/tasks', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2011', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, body, **kwargs)
|
60,219 |
sib_api_v3_sdk.api.tasks_api
|
crm_tasktypes_get
|
Get all task types # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasktypes_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: TaskTypes
If the method is called asynchronously,
returns the request thread.
|
def crm_tasktypes_get(self, **kwargs): # noqa: E501
"""Get all task types # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasktypes_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: TaskTypes
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_tasktypes_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.crm_tasktypes_get_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,220 |
sib_api_v3_sdk.api.tasks_api
|
crm_tasktypes_get_with_http_info
|
Get all task types # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasktypes_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: TaskTypes
If the method is called asynchronously,
returns the request thread.
|
def crm_tasktypes_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all task types # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_tasktypes_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: TaskTypes
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method crm_tasktypes_get" % key
)
params[key] = val
del 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/crm/tasktypes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='TaskTypes', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,221 |
sib_api_v3_sdk.api.transactional_emails_api
|
TransactionalEmailsApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class TransactionalEmailsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def block_new_domain(self, block_domain, **kwargs): # noqa: E501
"""Add a new domain to the list of blocked domains # noqa: E501
Blocks a new domain in order to avoid messages being sent to the same # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.block_new_domain(block_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param BlockDomain block_domain: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.block_new_domain_with_http_info(block_domain, **kwargs) # noqa: E501
else:
(data) = self.block_new_domain_with_http_info(block_domain, **kwargs) # noqa: E501
return data
def block_new_domain_with_http_info(self, block_domain, **kwargs): # noqa: E501
"""Add a new domain to the list of blocked domains # noqa: E501
Blocks a new domain in order to avoid messages being sent to the same # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.block_new_domain_with_http_info(block_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param BlockDomain block_domain: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['block_domain'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method block_new_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'block_domain' is set
if ('block_domain' not in params or
params['block_domain'] is None):
raise ValueError("Missing the required parameter `block_domain` when calling `block_new_domain`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'block_domain' in params:
body_params = params['block_domain']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedDomains', 'POST',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def create_smtp_template(self, smtp_template, **kwargs): # noqa: E501
"""Create an email template # 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_smtp_template(smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_smtp_template_with_http_info(smtp_template, **kwargs) # noqa: E501
else:
(data) = self.create_smtp_template_with_http_info(smtp_template, **kwargs) # noqa: E501
return data
def create_smtp_template_with_http_info(self, smtp_template, **kwargs): # noqa: E501
"""Create an email template # 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_smtp_template_with_http_info(smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['smtp_template'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'smtp_template' is set
if ('smtp_template' not in params or
params['smtp_template'] is None):
raise ValueError("Missing the required parameter `smtp_template` when calling `create_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'smtp_template' in params:
body_params = params['smtp_template']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateModel', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_blocked_domain(self, domain, **kwargs): # noqa: E501
"""Unblock an existing domain from the list of blocked domains # noqa: E501
Unblocks an existing domain from the list of blocked domains # 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_blocked_domain(domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str domain: The name of the domain to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_blocked_domain_with_http_info(domain, **kwargs) # noqa: E501
else:
(data) = self.delete_blocked_domain_with_http_info(domain, **kwargs) # noqa: E501
return data
def delete_blocked_domain_with_http_info(self, domain, **kwargs): # noqa: E501
"""Unblock an existing domain from the list of blocked domains # noqa: E501
Unblocks an existing domain from the list of blocked domains # 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_blocked_domain_with_http_info(domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str domain: The name of the domain to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['domain'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_blocked_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'domain' is set
if ('domain' not in params or
params['domain'] is None):
raise ValueError("Missing the required parameter `domain` when calling `delete_blocked_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'domain' in params:
path_params['domain'] = params['domain'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedDomains/{domain}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_hardbounces(self, **kwargs): # noqa: E501
"""Delete hardbounces # noqa: E501
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) # 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_hardbounces(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DeleteHardbounces delete_hardbounces: values to delete hardbounces
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_hardbounces_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.delete_hardbounces_with_http_info(**kwargs) # noqa: E501
return data
def delete_hardbounces_with_http_info(self, **kwargs): # noqa: E501
"""Delete hardbounces # noqa: E501
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) # 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_hardbounces_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DeleteHardbounces delete_hardbounces: values to delete hardbounces
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['delete_hardbounces'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_hardbounces" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'delete_hardbounces' in params:
body_params = params['delete_hardbounces']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/deleteHardbounces', 'POST',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_scheduled_email_by_id(self, identifier, **kwargs): # noqa: E501
"""Delete scheduled emails by batchId or messageId # noqa: E501
Delete scheduled batch of emails by batchId or single scheduled email by messageId # 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_scheduled_email_by_id(identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_scheduled_email_by_id_with_http_info(identifier, **kwargs) # noqa: E501
else:
(data) = self.delete_scheduled_email_by_id_with_http_info(identifier, **kwargs) # noqa: E501
return data
def delete_scheduled_email_by_id_with_http_info(self, identifier, **kwargs): # noqa: E501
"""Delete scheduled emails by batchId or messageId # noqa: E501
Delete scheduled batch of emails by batchId or single scheduled email by messageId # 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_scheduled_email_by_id_with_http_info(identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['identifier'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_scheduled_email_by_id" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'identifier' is set
if ('identifier' not in params or
params['identifier'] is None):
raise ValueError("Missing the required parameter `identifier` when calling `delete_scheduled_email_by_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'identifier' in params:
path_params['identifier'] = params['identifier'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/email/{identifier}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def delete_smtp_template(self, template_id, **kwargs): # noqa: E501
"""Delete an inactive email template # 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_smtp_template(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
else:
(data) = self.delete_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
return data
def delete_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501
"""Delete an inactive email template # 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_smtp_template_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `delete_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_aggregated_smtp_report(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated over a period of time # noqa: E501
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_aggregated_smtp_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:return: GetAggregatedReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_aggregated_smtp_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_aggregated_smtp_report_with_http_info(**kwargs) # noqa: E501
return data
def get_aggregated_smtp_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated over a period of time # noqa: E501
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_aggregated_smtp_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:return: GetAggregatedReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'days', 'tag'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_aggregated_smtp_report" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/statistics/aggregatedReport', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetAggregatedReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_blocked_domains(self, **kwargs): # noqa: E501
"""Get the list of blocked domains # noqa: E501
Get the list of blocked domains # 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_blocked_domains(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: GetBlockedDomains
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_blocked_domains_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_blocked_domains_with_http_info(**kwargs) # noqa: E501
return data
def get_blocked_domains_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of blocked domains # noqa: E501
Get the list of blocked domains # 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_blocked_domains_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: GetBlockedDomains
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_blocked_domains" % key
)
params[key] = val
del 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedDomains', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetBlockedDomains', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_event_report(self, **kwargs): # noqa: E501
"""Get all your transactional email activity (unaggregated events) # noqa: E501
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_email_event_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str email: Filter the report for a specific email addresses
:param str event: Filter the report for a specific event type
:param str tags: Filter the report for tags (serialized and urlencoded array)
:param str message_id: Filter on a specific message id
:param int template_id: Filter on a specific template id
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetEmailEventReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_email_event_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_email_event_report_with_http_info(**kwargs) # noqa: E501
return data
def get_email_event_report_with_http_info(self, **kwargs): # noqa: E501
"""Get all your transactional email activity (unaggregated events) # noqa: E501
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_email_event_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str email: Filter the report for a specific email addresses
:param str event: Filter the report for a specific event type
:param str tags: Filter the report for tags (serialized and urlencoded array)
:param str message_id: Filter on a specific message id
:param int template_id: Filter on a specific template id
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetEmailEventReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset', 'start_date', 'end_date', 'days', 'email', 'event', 'tags', 'message_id', 'template_id', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_event_report" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 5000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_email_event_report`, must be a value less than or equal to `5000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_email_event_report`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'email' in params:
query_params.append(('email', params['email'])) # noqa: E501
if 'event' in params:
query_params.append(('event', params['event'])) # noqa: E501
if 'tags' in params:
query_params.append(('tags', params['tags'])) # noqa: E501
if 'message_id' in params:
query_params.append(('messageId', params['message_id'])) # noqa: E501
if 'template_id' in params:
query_params.append(('templateId', params['template_id'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/statistics/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetEmailEventReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_scheduled_email_by_batch_id(self, batch_id, **kwargs): # noqa: E501
"""Fetch scheduled emails by batchId # noqa: E501
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_batch_id(batch_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required)
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param str status: Filter the records by `status` of the scheduled email batch or message.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:return: GetScheduledEmailByBatchId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_scheduled_email_by_batch_id_with_http_info(batch_id, **kwargs) # noqa: E501
else:
(data) = self.get_scheduled_email_by_batch_id_with_http_info(batch_id, **kwargs) # noqa: E501
return data
def get_scheduled_email_by_batch_id_with_http_info(self, batch_id, **kwargs): # noqa: E501
"""Fetch scheduled emails by batchId # noqa: E501
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_batch_id_with_http_info(batch_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required)
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param str status: Filter the records by `status` of the scheduled email batch or message.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:return: GetScheduledEmailByBatchId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['batch_id', 'start_date', 'end_date', 'sort', 'status', 'limit', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_scheduled_email_by_batch_id" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'batch_id' is set
if ('batch_id' not in params or
params['batch_id'] is None):
raise ValueError("Missing the required parameter `batch_id` when calling `get_scheduled_email_by_batch_id`") # noqa: E501
if 'limit' in params and params['limit'] > 500: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_scheduled_email_by_batch_id`, must be a value less than or equal to `500`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_scheduled_email_by_batch_id`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
if 'batch_id' in params:
path_params['batchId'] = params['batch_id'] # noqa: E501
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
if 'status' in params:
query_params.append(('status', params['status'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emailStatus/{batchId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetScheduledEmailByBatchId', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_scheduled_email_by_message_id(self, message_id, **kwargs): # noqa: E501
"""Fetch scheduled email by messageId # noqa: E501
Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_message_id(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The messageId of scheduled email (required)
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:return: GetScheduledEmailByMessageId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_scheduled_email_by_message_id_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.get_scheduled_email_by_message_id_with_http_info(message_id, **kwargs) # noqa: E501
return data
def get_scheduled_email_by_message_id_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Fetch scheduled email by messageId # noqa: E501
Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_message_id_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The messageId of scheduled email (required)
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:return: GetScheduledEmailByMessageId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id', 'start_date', 'end_date'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_scheduled_email_by_message_id" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if ('message_id' not in params or
params['message_id'] is None):
raise ValueError("Missing the required parameter `message_id` when calling `get_scheduled_email_by_message_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['messageId'] = params['message_id'] # noqa: E501
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emailStatus/{messageId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetScheduledEmailByMessageId', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_smtp_report(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated per day # 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_smtp_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetReports
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_smtp_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_smtp_report_with_http_info(**kwargs) # noqa: E501
return data
def get_smtp_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated per day # 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_smtp_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetReports
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset', 'start_date', 'end_date', 'days', 'tag', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_smtp_report" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 30: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_report`, must be a value less than or equal to `30`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_report`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/statistics/reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetReports', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_smtp_template(self, template_id, **kwargs): # noqa: E501
"""Returns the template information # 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_smtp_template(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: GetSmtpTemplateOverview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
else:
(data) = self.get_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
return data
def get_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501
"""Returns the template information # 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_smtp_template_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: GetSmtpTemplateOverview
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `get_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmtpTemplateOverview', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_smtp_templates(self, **kwargs): # noqa: E501
"""Get the list of email templates # 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_smtp_templates(async_req=True)
>>> result = thread.get()
:param async_req bool
:param bool template_status: Filter on the status of the template. Active = true, inactive = false
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmtpTemplates
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_smtp_templates_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_smtp_templates_with_http_info(**kwargs) # noqa: E501
return data
def get_smtp_templates_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of email templates # 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_smtp_templates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param bool template_status: Filter on the status of the template. Active = true, inactive = false
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmtpTemplates
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_status', 'limit', 'offset', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_smtp_templates" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_templates`, must be a value less than or equal to `1000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_templates`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'template_status' in params:
query_params.append(('templateStatus', params['template_status'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmtpTemplates', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_transac_blocked_contacts(self, **kwargs): # noqa: E501
"""Get the list of blocked or unsubscribed transactional contacts # 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_transac_blocked_contacts(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacBlockedContacts
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_blocked_contacts_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_blocked_contacts_with_http_info(**kwargs) # noqa: E501
return data
def get_transac_blocked_contacts_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of blocked or unsubscribed transactional contacts # 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_transac_blocked_contacts_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacBlockedContacts
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'limit', 'offset', 'senders', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_blocked_contacts" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 100: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_blocked_contacts`, must be a value less than or equal to `100`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_blocked_contacts`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'senders' in params:
query_params.append(('senders', params['senders'])) # noqa: E501
collection_formats['senders'] = 'csv' # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedContacts', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacBlockedContacts', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_transac_email_content(self, uuid, **kwargs): # noqa: E501
"""Get the personalized content of a sent transactional email # 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_transac_email_content(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: Unique id of the transactional email that has been sent to a particular contact (required)
:return: GetTransacEmailContent
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_email_content_with_http_info(uuid, **kwargs) # noqa: E501
else:
(data) = self.get_transac_email_content_with_http_info(uuid, **kwargs) # noqa: E501
return data
def get_transac_email_content_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Get the personalized content of a sent transactional email # 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_transac_email_content_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: Unique id of the transactional email that has been sent to a particular contact (required)
:return: GetTransacEmailContent
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['uuid'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_email_content" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'uuid' is set
if ('uuid' not in params or
params['uuid'] is None):
raise ValueError("Missing the required parameter `uuid` when calling `get_transac_email_content`") # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in params:
path_params['uuid'] = params['uuid'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emails/{uuid}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacEmailContent', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_transac_emails_list(self, **kwargs): # noqa: E501
"""Get the list of transactional emails on the basis of allowed filters # noqa: E501
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. # 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_transac_emails_list(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
:param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
:param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:return: GetTransacEmailsList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_emails_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_emails_list_with_http_info(**kwargs) # noqa: E501
return data
def get_transac_emails_list_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of transactional emails on the basis of allowed filters # noqa: E501
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. # 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_transac_emails_list_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
:param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
:param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:return: GetTransacEmailsList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['email', 'template_id', 'message_id', 'start_date', 'end_date', 'sort', 'limit', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_emails_list" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_emails_list`, must be a value less than or equal to `1000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_emails_list`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'email' in params:
query_params.append(('email', params['email'])) # noqa: E501
if 'template_id' in params:
query_params.append(('templateId', params['template_id'])) # noqa: E501
if 'message_id' in params:
query_params.append(('messageId', params['message_id'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emails', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacEmailsList', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def send_test_template(self, template_id, send_test_email, **kwargs): # noqa: E501
"""Send a template to your test list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_template(template_id, send_test_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Id of the template (required)
:param SendTestEmail send_test_email: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_test_template_with_http_info(template_id, send_test_email, **kwargs) # noqa: E501
else:
(data) = self.send_test_template_with_http_info(template_id, send_test_email, **kwargs) # noqa: E501
return data
def send_test_template_with_http_info(self, template_id, send_test_email, **kwargs): # noqa: E501
"""Send a template to your test list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_template_with_http_info(template_id, send_test_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Id of the template (required)
:param SendTestEmail send_test_email: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id', 'send_test_email'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_test_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `send_test_template`") # noqa: E501
# verify the required parameter 'send_test_email' is set
if ('send_test_email' not in params or
params['send_test_email'] is None):
raise ValueError("Missing the required parameter `send_test_email` when calling `send_test_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_test_email' in params:
body_params = params['send_test_email']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}/sendTest', 'POST',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def send_transac_email(self, send_smtp_email, **kwargs): # noqa: E501
"""Send a transactional email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_email(send_smtp_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendSmtpEmail send_smtp_email: Values to send a transactional email (required)
:return: CreateSmtpEmail
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_transac_email_with_http_info(send_smtp_email, **kwargs) # noqa: E501
else:
(data) = self.send_transac_email_with_http_info(send_smtp_email, **kwargs) # noqa: E501
return data
def send_transac_email_with_http_info(self, send_smtp_email, **kwargs): # noqa: E501
"""Send a transactional email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_email_with_http_info(send_smtp_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendSmtpEmail send_smtp_email: Values to send a transactional email (required)
:return: CreateSmtpEmail
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['send_smtp_email'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_transac_email" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'send_smtp_email' is set
if ('send_smtp_email' not in params or
params['send_smtp_email'] is None):
raise ValueError("Missing the required parameter `send_smtp_email` when calling `send_transac_email`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_smtp_email' in params:
body_params = params['send_smtp_email']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/email', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateSmtpEmail', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def smtp_blocked_contacts_email_delete(self, email, **kwargs): # noqa: E501
"""Unblock or resubscribe a transactional 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.smtp_blocked_contacts_email_delete(email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: contact email (urlencoded) to unblock. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.smtp_blocked_contacts_email_delete_with_http_info(email, **kwargs) # noqa: E501
else:
(data) = self.smtp_blocked_contacts_email_delete_with_http_info(email, **kwargs) # noqa: E501
return data
def smtp_blocked_contacts_email_delete_with_http_info(self, email, **kwargs): # noqa: E501
"""Unblock or resubscribe a transactional 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.smtp_blocked_contacts_email_delete_with_http_info(email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: contact email (urlencoded) to unblock. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['email'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method smtp_blocked_contacts_email_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'email' is set
if ('email' not in params or
params['email'] is None):
raise ValueError("Missing the required parameter `email` when calling `smtp_blocked_contacts_email_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email' in params:
path_params['email'] = params['email'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedContacts/{email}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def smtp_log_message_id_delete(self, message_id, **kwargs): # noqa: E501
"""Delete an SMTP transactional log # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.smtp_log_message_id_delete(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: MessageId of the transactional log to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.smtp_log_message_id_delete_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.smtp_log_message_id_delete_with_http_info(message_id, **kwargs) # noqa: E501
return data
def smtp_log_message_id_delete_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Delete an SMTP transactional log # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.smtp_log_message_id_delete_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: MessageId of the transactional log to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method smtp_log_message_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if ('message_id' not in params or
params['message_id'] is None):
raise ValueError("Missing the required parameter `message_id` when calling `smtp_log_message_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['messageId'] = params['message_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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/log/{messageId}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def update_smtp_template(self, template_id, smtp_template, **kwargs): # noqa: E501
"""Update an email template # 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_smtp_template(template_id, smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:param UpdateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_smtp_template_with_http_info(template_id, smtp_template, **kwargs) # noqa: E501
else:
(data) = self.update_smtp_template_with_http_info(template_id, smtp_template, **kwargs) # noqa: E501
return data
def update_smtp_template_with_http_info(self, template_id, smtp_template, **kwargs): # noqa: E501
"""Update an email template # 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_smtp_template_with_http_info(template_id, smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:param UpdateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id', 'smtp_template'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `update_smtp_template`") # noqa: E501
# verify the required parameter 'smtp_template' is set
if ('smtp_template' not in params or
params['smtp_template'] is None):
raise ValueError("Missing the required parameter `smtp_template` when calling `update_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'smtp_template' in params:
body_params = params['smtp_template']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}', 'PUT',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client=None)
|
60,223 |
sib_api_v3_sdk.api.transactional_emails_api
|
block_new_domain
|
Add a new domain to the list of blocked domains # noqa: E501
Blocks a new domain in order to avoid messages being sent to the same # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.block_new_domain(block_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param BlockDomain block_domain: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def block_new_domain(self, block_domain, **kwargs): # noqa: E501
"""Add a new domain to the list of blocked domains # noqa: E501
Blocks a new domain in order to avoid messages being sent to the same # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.block_new_domain(block_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param BlockDomain block_domain: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.block_new_domain_with_http_info(block_domain, **kwargs) # noqa: E501
else:
(data) = self.block_new_domain_with_http_info(block_domain, **kwargs) # noqa: E501
return data
|
(self, block_domain, **kwargs)
|
60,224 |
sib_api_v3_sdk.api.transactional_emails_api
|
block_new_domain_with_http_info
|
Add a new domain to the list of blocked domains # noqa: E501
Blocks a new domain in order to avoid messages being sent to the same # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.block_new_domain_with_http_info(block_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param BlockDomain block_domain: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def block_new_domain_with_http_info(self, block_domain, **kwargs): # noqa: E501
"""Add a new domain to the list of blocked domains # noqa: E501
Blocks a new domain in order to avoid messages being sent to the same # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.block_new_domain_with_http_info(block_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param BlockDomain block_domain: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['block_domain'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method block_new_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'block_domain' is set
if ('block_domain' not in params or
params['block_domain'] is None):
raise ValueError("Missing the required parameter `block_domain` when calling `block_new_domain`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'block_domain' in params:
body_params = params['block_domain']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedDomains', 'POST',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, block_domain, **kwargs)
|
60,225 |
sib_api_v3_sdk.api.transactional_emails_api
|
create_smtp_template
|
Create an email template # 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_smtp_template(smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
|
def create_smtp_template(self, smtp_template, **kwargs): # noqa: E501
"""Create an email template # 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_smtp_template(smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_smtp_template_with_http_info(smtp_template, **kwargs) # noqa: E501
else:
(data) = self.create_smtp_template_with_http_info(smtp_template, **kwargs) # noqa: E501
return data
|
(self, smtp_template, **kwargs)
|
60,226 |
sib_api_v3_sdk.api.transactional_emails_api
|
create_smtp_template_with_http_info
|
Create an email template # 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_smtp_template_with_http_info(smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
|
def create_smtp_template_with_http_info(self, smtp_template, **kwargs): # noqa: E501
"""Create an email template # 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_smtp_template_with_http_info(smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['smtp_template'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'smtp_template' is set
if ('smtp_template' not in params or
params['smtp_template'] is None):
raise ValueError("Missing the required parameter `smtp_template` when calling `create_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'smtp_template' in params:
body_params = params['smtp_template']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateModel', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, smtp_template, **kwargs)
|
60,227 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_blocked_domain
|
Unblock an existing domain from the list of blocked domains # noqa: E501
Unblocks an existing domain from the list of blocked domains # 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_blocked_domain(domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str domain: The name of the domain to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_blocked_domain(self, domain, **kwargs): # noqa: E501
"""Unblock an existing domain from the list of blocked domains # noqa: E501
Unblocks an existing domain from the list of blocked domains # 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_blocked_domain(domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str domain: The name of the domain to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_blocked_domain_with_http_info(domain, **kwargs) # noqa: E501
else:
(data) = self.delete_blocked_domain_with_http_info(domain, **kwargs) # noqa: E501
return data
|
(self, domain, **kwargs)
|
60,228 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_blocked_domain_with_http_info
|
Unblock an existing domain from the list of blocked domains # noqa: E501
Unblocks an existing domain from the list of blocked domains # 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_blocked_domain_with_http_info(domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str domain: The name of the domain to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_blocked_domain_with_http_info(self, domain, **kwargs): # noqa: E501
"""Unblock an existing domain from the list of blocked domains # noqa: E501
Unblocks an existing domain from the list of blocked domains # 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_blocked_domain_with_http_info(domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str domain: The name of the domain to be deleted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['domain'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_blocked_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'domain' is set
if ('domain' not in params or
params['domain'] is None):
raise ValueError("Missing the required parameter `domain` when calling `delete_blocked_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'domain' in params:
path_params['domain'] = params['domain'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedDomains/{domain}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, domain, **kwargs)
|
60,229 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_hardbounces
|
Delete hardbounces # noqa: E501
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) # 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_hardbounces(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DeleteHardbounces delete_hardbounces: values to delete hardbounces
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_hardbounces(self, **kwargs): # noqa: E501
"""Delete hardbounces # noqa: E501
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) # 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_hardbounces(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DeleteHardbounces delete_hardbounces: values to delete hardbounces
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_hardbounces_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.delete_hardbounces_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,230 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_hardbounces_with_http_info
|
Delete hardbounces # noqa: E501
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) # 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_hardbounces_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DeleteHardbounces delete_hardbounces: values to delete hardbounces
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_hardbounces_with_http_info(self, **kwargs): # noqa: E501
"""Delete hardbounces # noqa: E501
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) # 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_hardbounces_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DeleteHardbounces delete_hardbounces: values to delete hardbounces
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['delete_hardbounces'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_hardbounces" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'delete_hardbounces' in params:
body_params = params['delete_hardbounces']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/deleteHardbounces', 'POST',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,231 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_scheduled_email_by_id
|
Delete scheduled emails by batchId or messageId # noqa: E501
Delete scheduled batch of emails by batchId or single scheduled email by messageId # 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_scheduled_email_by_id(identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_scheduled_email_by_id(self, identifier, **kwargs): # noqa: E501
"""Delete scheduled emails by batchId or messageId # noqa: E501
Delete scheduled batch of emails by batchId or single scheduled email by messageId # 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_scheduled_email_by_id(identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_scheduled_email_by_id_with_http_info(identifier, **kwargs) # noqa: E501
else:
(data) = self.delete_scheduled_email_by_id_with_http_info(identifier, **kwargs) # noqa: E501
return data
|
(self, identifier, **kwargs)
|
60,232 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_scheduled_email_by_id_with_http_info
|
Delete scheduled emails by batchId or messageId # noqa: E501
Delete scheduled batch of emails by batchId or single scheduled email by messageId # 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_scheduled_email_by_id_with_http_info(identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_scheduled_email_by_id_with_http_info(self, identifier, **kwargs): # noqa: E501
"""Delete scheduled emails by batchId or messageId # noqa: E501
Delete scheduled batch of emails by batchId or single scheduled email by messageId # 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_scheduled_email_by_id_with_http_info(identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['identifier'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_scheduled_email_by_id" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'identifier' is set
if ('identifier' not in params or
params['identifier'] is None):
raise ValueError("Missing the required parameter `identifier` when calling `delete_scheduled_email_by_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'identifier' in params:
path_params['identifier'] = params['identifier'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/email/{identifier}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, identifier, **kwargs)
|
60,233 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_smtp_template
|
Delete an inactive email template # 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_smtp_template(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_smtp_template(self, template_id, **kwargs): # noqa: E501
"""Delete an inactive email template # 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_smtp_template(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
else:
(data) = self.delete_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
return data
|
(self, template_id, **kwargs)
|
60,234 |
sib_api_v3_sdk.api.transactional_emails_api
|
delete_smtp_template_with_http_info
|
Delete an inactive email template # 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_smtp_template_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501
"""Delete an inactive email template # 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_smtp_template_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `delete_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, template_id, **kwargs)
|
60,235 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_aggregated_smtp_report
|
Get your transactional email activity aggregated over a period of time # noqa: E501
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_aggregated_smtp_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:return: GetAggregatedReport
If the method is called asynchronously,
returns the request thread.
|
def get_aggregated_smtp_report(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated over a period of time # noqa: E501
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_aggregated_smtp_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:return: GetAggregatedReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_aggregated_smtp_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_aggregated_smtp_report_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,236 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_aggregated_smtp_report_with_http_info
|
Get your transactional email activity aggregated over a period of time # noqa: E501
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_aggregated_smtp_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:return: GetAggregatedReport
If the method is called asynchronously,
returns the request thread.
|
def get_aggregated_smtp_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated over a period of time # noqa: E501
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_aggregated_smtp_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:return: GetAggregatedReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'days', 'tag'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_aggregated_smtp_report" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/statistics/aggregatedReport', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetAggregatedReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,237 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_blocked_domains
|
Get the list of blocked domains # noqa: E501
Get the list of blocked domains # 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_blocked_domains(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: GetBlockedDomains
If the method is called asynchronously,
returns the request thread.
|
def get_blocked_domains(self, **kwargs): # noqa: E501
"""Get the list of blocked domains # noqa: E501
Get the list of blocked domains # 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_blocked_domains(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: GetBlockedDomains
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_blocked_domains_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_blocked_domains_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,238 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_blocked_domains_with_http_info
|
Get the list of blocked domains # noqa: E501
Get the list of blocked domains # 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_blocked_domains_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: GetBlockedDomains
If the method is called asynchronously,
returns the request thread.
|
def get_blocked_domains_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of blocked domains # noqa: E501
Get the list of blocked domains # 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_blocked_domains_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: GetBlockedDomains
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_blocked_domains" % key
)
params[key] = val
del 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedDomains', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetBlockedDomains', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,239 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_email_event_report
|
Get all your transactional email activity (unaggregated events) # noqa: E501
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_email_event_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str email: Filter the report for a specific email addresses
:param str event: Filter the report for a specific event type
:param str tags: Filter the report for tags (serialized and urlencoded array)
:param str message_id: Filter on a specific message id
:param int template_id: Filter on a specific template id
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetEmailEventReport
If the method is called asynchronously,
returns the request thread.
|
def get_email_event_report(self, **kwargs): # noqa: E501
"""Get all your transactional email activity (unaggregated events) # noqa: E501
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_email_event_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str email: Filter the report for a specific email addresses
:param str event: Filter the report for a specific event type
:param str tags: Filter the report for tags (serialized and urlencoded array)
:param str message_id: Filter on a specific message id
:param int template_id: Filter on a specific template id
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetEmailEventReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_email_event_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_email_event_report_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,240 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_email_event_report_with_http_info
|
Get all your transactional email activity (unaggregated events) # noqa: E501
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_email_event_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str email: Filter the report for a specific email addresses
:param str event: Filter the report for a specific event type
:param str tags: Filter the report for tags (serialized and urlencoded array)
:param str message_id: Filter on a specific message id
:param int template_id: Filter on a specific template id
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetEmailEventReport
If the method is called asynchronously,
returns the request thread.
|
def get_email_event_report_with_http_info(self, **kwargs): # noqa: E501
"""Get all your transactional email activity (unaggregated events) # noqa: E501
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days # 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_email_event_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str email: Filter the report for a specific email addresses
:param str event: Filter the report for a specific event type
:param str tags: Filter the report for tags (serialized and urlencoded array)
:param str message_id: Filter on a specific message id
:param int template_id: Filter on a specific template id
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetEmailEventReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset', 'start_date', 'end_date', 'days', 'email', 'event', 'tags', 'message_id', 'template_id', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_event_report" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 5000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_email_event_report`, must be a value less than or equal to `5000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_email_event_report`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'email' in params:
query_params.append(('email', params['email'])) # noqa: E501
if 'event' in params:
query_params.append(('event', params['event'])) # noqa: E501
if 'tags' in params:
query_params.append(('tags', params['tags'])) # noqa: E501
if 'message_id' in params:
query_params.append(('messageId', params['message_id'])) # noqa: E501
if 'template_id' in params:
query_params.append(('templateId', params['template_id'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/statistics/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetEmailEventReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,241 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_scheduled_email_by_batch_id
|
Fetch scheduled emails by batchId # noqa: E501
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_batch_id(batch_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required)
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param str status: Filter the records by `status` of the scheduled email batch or message.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:return: GetScheduledEmailByBatchId
If the method is called asynchronously,
returns the request thread.
|
def get_scheduled_email_by_batch_id(self, batch_id, **kwargs): # noqa: E501
"""Fetch scheduled emails by batchId # noqa: E501
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_batch_id(batch_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required)
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param str status: Filter the records by `status` of the scheduled email batch or message.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:return: GetScheduledEmailByBatchId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_scheduled_email_by_batch_id_with_http_info(batch_id, **kwargs) # noqa: E501
else:
(data) = self.get_scheduled_email_by_batch_id_with_http_info(batch_id, **kwargs) # noqa: E501
return data
|
(self, batch_id, **kwargs)
|
60,242 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_scheduled_email_by_batch_id_with_http_info
|
Fetch scheduled emails by batchId # noqa: E501
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_batch_id_with_http_info(batch_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required)
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param str status: Filter the records by `status` of the scheduled email batch or message.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:return: GetScheduledEmailByBatchId
If the method is called asynchronously,
returns the request thread.
|
def get_scheduled_email_by_batch_id_with_http_info(self, batch_id, **kwargs): # noqa: E501
"""Fetch scheduled emails by batchId # noqa: E501
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_batch_id_with_http_info(batch_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str batch_id: The batchId of scheduled emails batch (Should be a valid UUIDv4) (required)
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param str status: Filter the records by `status` of the scheduled email batch or message.
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:return: GetScheduledEmailByBatchId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['batch_id', 'start_date', 'end_date', 'sort', 'status', 'limit', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_scheduled_email_by_batch_id" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'batch_id' is set
if ('batch_id' not in params or
params['batch_id'] is None):
raise ValueError("Missing the required parameter `batch_id` when calling `get_scheduled_email_by_batch_id`") # noqa: E501
if 'limit' in params and params['limit'] > 500: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_scheduled_email_by_batch_id`, must be a value less than or equal to `500`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_scheduled_email_by_batch_id`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
if 'batch_id' in params:
path_params['batchId'] = params['batch_id'] # noqa: E501
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
if 'status' in params:
query_params.append(('status', params['status'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emailStatus/{batchId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetScheduledEmailByBatchId', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, batch_id, **kwargs)
|
60,243 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_scheduled_email_by_message_id
|
Fetch scheduled email by messageId # noqa: E501
Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_message_id(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The messageId of scheduled email (required)
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:return: GetScheduledEmailByMessageId
If the method is called asynchronously,
returns the request thread.
|
def get_scheduled_email_by_message_id(self, message_id, **kwargs): # noqa: E501
"""Fetch scheduled email by messageId # noqa: E501
Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_message_id(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The messageId of scheduled email (required)
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:return: GetScheduledEmailByMessageId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_scheduled_email_by_message_id_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.get_scheduled_email_by_message_id_with_http_info(message_id, **kwargs) # noqa: E501
return data
|
(self, message_id, **kwargs)
|
60,244 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_scheduled_email_by_message_id_with_http_info
|
Fetch scheduled email by messageId # noqa: E501
Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_message_id_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The messageId of scheduled email (required)
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:return: GetScheduledEmailByMessageId
If the method is called asynchronously,
returns the request thread.
|
def get_scheduled_email_by_message_id_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Fetch scheduled email by messageId # noqa: E501
Fetch scheduled email by messageId (Can retrieve data upto 30 days old) # 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_scheduled_email_by_message_id_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The messageId of scheduled email (required)
:param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
:param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:return: GetScheduledEmailByMessageId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id', 'start_date', 'end_date'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_scheduled_email_by_message_id" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if ('message_id' not in params or
params['message_id'] is None):
raise ValueError("Missing the required parameter `message_id` when calling `get_scheduled_email_by_message_id`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['messageId'] = params['message_id'] # noqa: E501
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emailStatus/{messageId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetScheduledEmailByMessageId', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, message_id, **kwargs)
|
60,245 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_smtp_report
|
Get your transactional email activity aggregated per day # 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_smtp_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetReports
If the method is called asynchronously,
returns the request thread.
|
def get_smtp_report(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated per day # 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_smtp_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetReports
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_smtp_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_smtp_report_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,246 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_smtp_report_with_http_info
|
Get your transactional email activity aggregated per day # 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_smtp_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetReports
If the method is called asynchronously,
returns the request thread.
|
def get_smtp_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your transactional email activity aggregated per day # 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_smtp_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param str start_date: Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
:param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Tag of the emails
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetReports
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset', 'start_date', 'end_date', 'days', 'tag', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_smtp_report" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 30: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_report`, must be a value less than or equal to `30`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_report`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/statistics/reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetReports', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,247 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_smtp_template
|
Returns the template information # 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_smtp_template(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: GetSmtpTemplateOverview
If the method is called asynchronously,
returns the request thread.
|
def get_smtp_template(self, template_id, **kwargs): # noqa: E501
"""Returns the template information # 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_smtp_template(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: GetSmtpTemplateOverview
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
else:
(data) = self.get_smtp_template_with_http_info(template_id, **kwargs) # noqa: E501
return data
|
(self, template_id, **kwargs)
|
60,248 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_smtp_template_with_http_info
|
Returns the template information # 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_smtp_template_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: GetSmtpTemplateOverview
If the method is called asynchronously,
returns the request thread.
|
def get_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501
"""Returns the template information # 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_smtp_template_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:return: GetSmtpTemplateOverview
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `get_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmtpTemplateOverview', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, template_id, **kwargs)
|
60,249 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_smtp_templates
|
Get the list of email templates # 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_smtp_templates(async_req=True)
>>> result = thread.get()
:param async_req bool
:param bool template_status: Filter on the status of the template. Active = true, inactive = false
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmtpTemplates
If the method is called asynchronously,
returns the request thread.
|
def get_smtp_templates(self, **kwargs): # noqa: E501
"""Get the list of email templates # 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_smtp_templates(async_req=True)
>>> result = thread.get()
:param async_req bool
:param bool template_status: Filter on the status of the template. Active = true, inactive = false
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmtpTemplates
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_smtp_templates_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_smtp_templates_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,250 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_smtp_templates_with_http_info
|
Get the list of email templates # 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_smtp_templates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param bool template_status: Filter on the status of the template. Active = true, inactive = false
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmtpTemplates
If the method is called asynchronously,
returns the request thread.
|
def get_smtp_templates_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of email templates # 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_smtp_templates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param bool template_status: Filter on the status of the template. Active = true, inactive = false
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmtpTemplates
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_status', 'limit', 'offset', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_smtp_templates" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_templates`, must be a value less than or equal to `1000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_smtp_templates`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'template_status' in params:
query_params.append(('templateStatus', params['template_status'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmtpTemplates', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,251 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_transac_blocked_contacts
|
Get the list of blocked or unsubscribed transactional contacts # 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_transac_blocked_contacts(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacBlockedContacts
If the method is called asynchronously,
returns the request thread.
|
def get_transac_blocked_contacts(self, **kwargs): # noqa: E501
"""Get the list of blocked or unsubscribed transactional contacts # 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_transac_blocked_contacts(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacBlockedContacts
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_blocked_contacts_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_blocked_contacts_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,252 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_transac_blocked_contacts_with_http_info
|
Get the list of blocked or unsubscribed transactional contacts # 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_transac_blocked_contacts_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacBlockedContacts
If the method is called asynchronously,
returns the request thread.
|
def get_transac_blocked_contacts_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of blocked or unsubscribed transactional contacts # 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_transac_blocked_contacts_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
:param int limit: Number of documents returned per page
:param int offset: Index of the first document on the page
:param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacBlockedContacts
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'limit', 'offset', 'senders', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_blocked_contacts" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 100: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_blocked_contacts`, must be a value less than or equal to `100`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_blocked_contacts`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'senders' in params:
query_params.append(('senders', params['senders'])) # noqa: E501
collection_formats['senders'] = 'csv' # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedContacts', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacBlockedContacts', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,253 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_transac_email_content
|
Get the personalized content of a sent transactional email # 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_transac_email_content(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: Unique id of the transactional email that has been sent to a particular contact (required)
:return: GetTransacEmailContent
If the method is called asynchronously,
returns the request thread.
|
def get_transac_email_content(self, uuid, **kwargs): # noqa: E501
"""Get the personalized content of a sent transactional email # 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_transac_email_content(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: Unique id of the transactional email that has been sent to a particular contact (required)
:return: GetTransacEmailContent
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_email_content_with_http_info(uuid, **kwargs) # noqa: E501
else:
(data) = self.get_transac_email_content_with_http_info(uuid, **kwargs) # noqa: E501
return data
|
(self, uuid, **kwargs)
|
60,254 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_transac_email_content_with_http_info
|
Get the personalized content of a sent transactional email # 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_transac_email_content_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: Unique id of the transactional email that has been sent to a particular contact (required)
:return: GetTransacEmailContent
If the method is called asynchronously,
returns the request thread.
|
def get_transac_email_content_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Get the personalized content of a sent transactional email # 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_transac_email_content_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: Unique id of the transactional email that has been sent to a particular contact (required)
:return: GetTransacEmailContent
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['uuid'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_email_content" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'uuid' is set
if ('uuid' not in params or
params['uuid'] is None):
raise ValueError("Missing the required parameter `uuid` when calling `get_transac_email_content`") # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in params:
path_params['uuid'] = params['uuid'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emails/{uuid}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacEmailContent', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, uuid, **kwargs)
|
60,255 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_transac_emails_list
|
Get the list of transactional emails on the basis of allowed filters # noqa: E501
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. # 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_transac_emails_list(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
:param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
:param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:return: GetTransacEmailsList
If the method is called asynchronously,
returns the request thread.
|
def get_transac_emails_list(self, **kwargs): # noqa: E501
"""Get the list of transactional emails on the basis of allowed filters # noqa: E501
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. # 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_transac_emails_list(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
:param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
:param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:return: GetTransacEmailsList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_emails_list_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_emails_list_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,256 |
sib_api_v3_sdk.api.transactional_emails_api
|
get_transac_emails_list_with_http_info
|
Get the list of transactional emails on the basis of allowed filters # noqa: E501
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. # 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_transac_emails_list_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
:param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
:param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:return: GetTransacEmailsList
If the method is called asynchronously,
returns the request thread.
|
def get_transac_emails_list_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of transactional emails on the basis of allowed filters # noqa: E501
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. # 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_transac_emails_list_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
:param int template_id: Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
:param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:param int limit: Number of documents returned per page
:param int offset: Index of the first document in the page
:return: GetTransacEmailsList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['email', 'template_id', 'message_id', 'start_date', 'end_date', 'sort', 'limit', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_emails_list" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_emails_list`, must be a value less than or equal to `1000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_transac_emails_list`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'email' in params:
query_params.append(('email', params['email'])) # noqa: E501
if 'template_id' in params:
query_params.append(('templateId', params['template_id'])) # noqa: E501
if 'message_id' in params:
query_params.append(('messageId', params['message_id'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/emails', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacEmailsList', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,257 |
sib_api_v3_sdk.api.transactional_emails_api
|
send_test_template
|
Send a template to your test list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_template(template_id, send_test_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Id of the template (required)
:param SendTestEmail send_test_email: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_test_template(self, template_id, send_test_email, **kwargs): # noqa: E501
"""Send a template to your test list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_template(template_id, send_test_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Id of the template (required)
:param SendTestEmail send_test_email: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_test_template_with_http_info(template_id, send_test_email, **kwargs) # noqa: E501
else:
(data) = self.send_test_template_with_http_info(template_id, send_test_email, **kwargs) # noqa: E501
return data
|
(self, template_id, send_test_email, **kwargs)
|
60,258 |
sib_api_v3_sdk.api.transactional_emails_api
|
send_test_template_with_http_info
|
Send a template to your test list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_template_with_http_info(template_id, send_test_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Id of the template (required)
:param SendTestEmail send_test_email: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_test_template_with_http_info(self, template_id, send_test_email, **kwargs): # noqa: E501
"""Send a template to your test list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_test_template_with_http_info(template_id, send_test_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Id of the template (required)
:param SendTestEmail send_test_email: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id', 'send_test_email'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_test_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `send_test_template`") # noqa: E501
# verify the required parameter 'send_test_email' is set
if ('send_test_email' not in params or
params['send_test_email'] is None):
raise ValueError("Missing the required parameter `send_test_email` when calling `send_test_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_test_email' in params:
body_params = params['send_test_email']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}/sendTest', 'POST',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, template_id, send_test_email, **kwargs)
|
60,259 |
sib_api_v3_sdk.api.transactional_emails_api
|
send_transac_email
|
Send a transactional email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_email(send_smtp_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendSmtpEmail send_smtp_email: Values to send a transactional email (required)
:return: CreateSmtpEmail
If the method is called asynchronously,
returns the request thread.
|
def send_transac_email(self, send_smtp_email, **kwargs): # noqa: E501
"""Send a transactional email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_email(send_smtp_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendSmtpEmail send_smtp_email: Values to send a transactional email (required)
:return: CreateSmtpEmail
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_transac_email_with_http_info(send_smtp_email, **kwargs) # noqa: E501
else:
(data) = self.send_transac_email_with_http_info(send_smtp_email, **kwargs) # noqa: E501
return data
|
(self, send_smtp_email, **kwargs)
|
60,260 |
sib_api_v3_sdk.api.transactional_emails_api
|
send_transac_email_with_http_info
|
Send a transactional email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_email_with_http_info(send_smtp_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendSmtpEmail send_smtp_email: Values to send a transactional email (required)
:return: CreateSmtpEmail
If the method is called asynchronously,
returns the request thread.
|
def send_transac_email_with_http_info(self, send_smtp_email, **kwargs): # noqa: E501
"""Send a transactional email # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_email_with_http_info(send_smtp_email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendSmtpEmail send_smtp_email: Values to send a transactional email (required)
:return: CreateSmtpEmail
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['send_smtp_email'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_transac_email" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'send_smtp_email' is set
if ('send_smtp_email' not in params or
params['send_smtp_email'] is None):
raise ValueError("Missing the required parameter `send_smtp_email` when calling `send_transac_email`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_smtp_email' in params:
body_params = params['send_smtp_email']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/email', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreateSmtpEmail', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, send_smtp_email, **kwargs)
|
60,261 |
sib_api_v3_sdk.api.transactional_emails_api
|
smtp_blocked_contacts_email_delete
|
Unblock or resubscribe a transactional 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.smtp_blocked_contacts_email_delete(email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: contact email (urlencoded) to unblock. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def smtp_blocked_contacts_email_delete(self, email, **kwargs): # noqa: E501
"""Unblock or resubscribe a transactional 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.smtp_blocked_contacts_email_delete(email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: contact email (urlencoded) to unblock. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.smtp_blocked_contacts_email_delete_with_http_info(email, **kwargs) # noqa: E501
else:
(data) = self.smtp_blocked_contacts_email_delete_with_http_info(email, **kwargs) # noqa: E501
return data
|
(self, email, **kwargs)
|
60,262 |
sib_api_v3_sdk.api.transactional_emails_api
|
smtp_blocked_contacts_email_delete_with_http_info
|
Unblock or resubscribe a transactional 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.smtp_blocked_contacts_email_delete_with_http_info(email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: contact email (urlencoded) to unblock. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def smtp_blocked_contacts_email_delete_with_http_info(self, email, **kwargs): # noqa: E501
"""Unblock or resubscribe a transactional 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.smtp_blocked_contacts_email_delete_with_http_info(email, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str email: contact email (urlencoded) to unblock. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['email'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method smtp_blocked_contacts_email_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'email' is set
if ('email' not in params or
params['email'] is None):
raise ValueError("Missing the required parameter `email` when calling `smtp_blocked_contacts_email_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'email' in params:
path_params['email'] = params['email'] # 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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/blockedContacts/{email}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, email, **kwargs)
|
60,263 |
sib_api_v3_sdk.api.transactional_emails_api
|
smtp_log_message_id_delete
|
Delete an SMTP transactional log # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.smtp_log_message_id_delete(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: MessageId of the transactional log to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def smtp_log_message_id_delete(self, message_id, **kwargs): # noqa: E501
"""Delete an SMTP transactional log # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.smtp_log_message_id_delete(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: MessageId of the transactional log to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.smtp_log_message_id_delete_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.smtp_log_message_id_delete_with_http_info(message_id, **kwargs) # noqa: E501
return data
|
(self, message_id, **kwargs)
|
60,264 |
sib_api_v3_sdk.api.transactional_emails_api
|
smtp_log_message_id_delete_with_http_info
|
Delete an SMTP transactional log # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.smtp_log_message_id_delete_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: MessageId of the transactional log to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def smtp_log_message_id_delete_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Delete an SMTP transactional log # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.smtp_log_message_id_delete_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: MessageId of the transactional log to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method smtp_log_message_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if ('message_id' not in params or
params['message_id'] is None):
raise ValueError("Missing the required parameter `message_id` when calling `smtp_log_message_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['messageId'] = params['message_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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/log/{messageId}', '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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, message_id, **kwargs)
|
60,265 |
sib_api_v3_sdk.api.transactional_emails_api
|
update_smtp_template
|
Update an email template # 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_smtp_template(template_id, smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:param UpdateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_smtp_template(self, template_id, smtp_template, **kwargs): # noqa: E501
"""Update an email template # 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_smtp_template(template_id, smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:param UpdateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_smtp_template_with_http_info(template_id, smtp_template, **kwargs) # noqa: E501
else:
(data) = self.update_smtp_template_with_http_info(template_id, smtp_template, **kwargs) # noqa: E501
return data
|
(self, template_id, smtp_template, **kwargs)
|
60,266 |
sib_api_v3_sdk.api.transactional_emails_api
|
update_smtp_template_with_http_info
|
Update an email template # 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_smtp_template_with_http_info(template_id, smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:param UpdateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_smtp_template_with_http_info(self, template_id, smtp_template, **kwargs): # noqa: E501
"""Update an email template # 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_smtp_template_with_http_info(template_id, smtp_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: id of the template (required)
:param UpdateSmtpTemplate smtp_template: values to update in transactional email template (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id', 'smtp_template'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_smtp_template" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if ('template_id' not in params or
params['template_id'] is None):
raise ValueError("Missing the required parameter `template_id` when calling `update_smtp_template`") # noqa: E501
# verify the required parameter 'smtp_template' is set
if ('smtp_template' not in params or
params['smtp_template'] is None):
raise ValueError("Missing the required parameter `smtp_template` when calling `update_smtp_template`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['templateId'] = params['template_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'smtp_template' in params:
body_params = params['smtp_template']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/smtp/templates/{templateId}', 'PUT',
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=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, template_id, smtp_template, **kwargs)
|
60,267 |
sib_api_v3_sdk.api.transactional_sms_api
|
TransactionalSMSApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class TransactionalSMSApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def get_sms_events(self, **kwargs): # noqa: E501
"""Get all your SMS activity (unaggregated 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_sms_events(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int offset: Index of the first document of the page
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str phone_number: Filter the report for a specific phone number
:param str event: Filter the report for specific events
:param str tags: Filter the report for specific tags passed as a serialized urlencoded array
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsEventReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_sms_events_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_sms_events_with_http_info(**kwargs) # noqa: E501
return data
def get_sms_events_with_http_info(self, **kwargs): # noqa: E501
"""Get all your SMS activity (unaggregated 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_sms_events_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int offset: Index of the first document of the page
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str phone_number: Filter the report for a specific phone number
:param str event: Filter the report for specific events
:param str tags: Filter the report for specific tags passed as a serialized urlencoded array
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsEventReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'start_date', 'end_date', 'offset', 'days', 'phone_number', 'event', 'tags', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_sms_events" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 100: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_sms_events`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'phone_number' in params:
query_params.append(('phoneNumber', params['phone_number'])) # noqa: E501
if 'event' in params:
query_params.append(('event', params['event'])) # noqa: E501
if 'tags' in params:
query_params.append(('tags', params['tags'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/statistics/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmsEventReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_transac_aggregated_sms_report(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated over a period of time # 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_transac_aggregated_sms_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with startDate and endDate
:param str tag: Filter on a tag
:return: GetTransacAggregatedSmsReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_aggregated_sms_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_aggregated_sms_report_with_http_info(**kwargs) # noqa: E501
return data
def get_transac_aggregated_sms_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated over a period of time # 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_transac_aggregated_sms_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with startDate and endDate
:param str tag: Filter on a tag
:return: GetTransacAggregatedSmsReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'days', 'tag'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_aggregated_sms_report" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/statistics/aggregatedReport', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacAggregatedSmsReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_transac_sms_report(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated per day # 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_transac_sms_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Filter on a tag
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacSmsReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_sms_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_sms_report_with_http_info(**kwargs) # noqa: E501
return data
def get_transac_sms_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated per day # 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_transac_sms_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Filter on a tag
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacSmsReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'days', 'tag', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_sms_report" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/statistics/reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacSmsReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def send_transac_sms(self, send_transac_sms, **kwargs): # noqa: E501
"""Send SMS message to a mobile number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_sms(send_transac_sms, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendTransacSms send_transac_sms: Values to send a transactional SMS (required)
:return: SendSms
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_transac_sms_with_http_info(send_transac_sms, **kwargs) # noqa: E501
else:
(data) = self.send_transac_sms_with_http_info(send_transac_sms, **kwargs) # noqa: E501
return data
def send_transac_sms_with_http_info(self, send_transac_sms, **kwargs): # noqa: E501
"""Send SMS message to a mobile number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_sms_with_http_info(send_transac_sms, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendTransacSms send_transac_sms: Values to send a transactional SMS (required)
:return: SendSms
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['send_transac_sms'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_transac_sms" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'send_transac_sms' is set
if ('send_transac_sms' not in params or
params['send_transac_sms'] is None):
raise ValueError("Missing the required parameter `send_transac_sms` when calling `send_transac_sms`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_transac_sms' in params:
body_params = params['send_transac_sms']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/sms', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SendSms', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client=None)
|
60,269 |
sib_api_v3_sdk.api.transactional_sms_api
|
get_sms_events
|
Get all your SMS activity (unaggregated 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_sms_events(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int offset: Index of the first document of the page
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str phone_number: Filter the report for a specific phone number
:param str event: Filter the report for specific events
:param str tags: Filter the report for specific tags passed as a serialized urlencoded array
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsEventReport
If the method is called asynchronously,
returns the request thread.
|
def get_sms_events(self, **kwargs): # noqa: E501
"""Get all your SMS activity (unaggregated 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_sms_events(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int offset: Index of the first document of the page
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str phone_number: Filter the report for a specific phone number
:param str event: Filter the report for specific events
:param str tags: Filter the report for specific tags passed as a serialized urlencoded array
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsEventReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_sms_events_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_sms_events_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,270 |
sib_api_v3_sdk.api.transactional_sms_api
|
get_sms_events_with_http_info
|
Get all your SMS activity (unaggregated 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_sms_events_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int offset: Index of the first document of the page
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str phone_number: Filter the report for a specific phone number
:param str event: Filter the report for specific events
:param str tags: Filter the report for specific tags passed as a serialized urlencoded array
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsEventReport
If the method is called asynchronously,
returns the request thread.
|
def get_sms_events_with_http_info(self, **kwargs): # noqa: E501
"""Get all your SMS activity (unaggregated 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_sms_events_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int offset: Index of the first document of the page
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str phone_number: Filter the report for a specific phone number
:param str event: Filter the report for specific events
:param str tags: Filter the report for specific tags passed as a serialized urlencoded array
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsEventReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'start_date', 'end_date', 'offset', 'days', 'phone_number', 'event', 'tags', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_sms_events" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 100: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_sms_events`, must be a value less than or equal to `100`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'phone_number' in params:
query_params.append(('phoneNumber', params['phone_number'])) # noqa: E501
if 'event' in params:
query_params.append(('event', params['event'])) # noqa: E501
if 'tags' in params:
query_params.append(('tags', params['tags'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/statistics/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmsEventReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,271 |
sib_api_v3_sdk.api.transactional_sms_api
|
get_transac_aggregated_sms_report
|
Get your SMS activity aggregated over a period of time # 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_transac_aggregated_sms_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with startDate and endDate
:param str tag: Filter on a tag
:return: GetTransacAggregatedSmsReport
If the method is called asynchronously,
returns the request thread.
|
def get_transac_aggregated_sms_report(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated over a period of time # 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_transac_aggregated_sms_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with startDate and endDate
:param str tag: Filter on a tag
:return: GetTransacAggregatedSmsReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_aggregated_sms_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_aggregated_sms_report_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,272 |
sib_api_v3_sdk.api.transactional_sms_api
|
get_transac_aggregated_sms_report_with_http_info
|
Get your SMS activity aggregated over a period of time # 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_transac_aggregated_sms_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with startDate and endDate
:param str tag: Filter on a tag
:return: GetTransacAggregatedSmsReport
If the method is called asynchronously,
returns the request thread.
|
def get_transac_aggregated_sms_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated over a period of time # 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_transac_aggregated_sms_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with startDate and endDate
:param str tag: Filter on a tag
:return: GetTransacAggregatedSmsReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'days', 'tag'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_aggregated_sms_report" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
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
# 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', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/statistics/aggregatedReport', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacAggregatedSmsReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,273 |
sib_api_v3_sdk.api.transactional_sms_api
|
get_transac_sms_report
|
Get your SMS activity aggregated per day # 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_transac_sms_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Filter on a tag
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacSmsReport
If the method is called asynchronously,
returns the request thread.
|
def get_transac_sms_report(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated per day # 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_transac_sms_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Filter on a tag
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacSmsReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_transac_sms_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_transac_sms_report_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,274 |
sib_api_v3_sdk.api.transactional_sms_api
|
get_transac_sms_report_with_http_info
|
Get your SMS activity aggregated per day # 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_transac_sms_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Filter on a tag
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacSmsReport
If the method is called asynchronously,
returns the request thread.
|
def get_transac_sms_report_with_http_info(self, **kwargs): # noqa: E501
"""Get your SMS activity aggregated per day # 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_transac_sms_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
:param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
:param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
:param str tag: Filter on a tag
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetTransacSmsReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['start_date', 'end_date', 'days', 'tag', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_transac_sms_report" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'tag' in params:
query_params.append(('tag', params['tag'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/statistics/reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetTransacSmsReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,275 |
sib_api_v3_sdk.api.transactional_sms_api
|
send_transac_sms
|
Send SMS message to a mobile number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_sms(send_transac_sms, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendTransacSms send_transac_sms: Values to send a transactional SMS (required)
:return: SendSms
If the method is called asynchronously,
returns the request thread.
|
def send_transac_sms(self, send_transac_sms, **kwargs): # noqa: E501
"""Send SMS message to a mobile number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_sms(send_transac_sms, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendTransacSms send_transac_sms: Values to send a transactional SMS (required)
:return: SendSms
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_transac_sms_with_http_info(send_transac_sms, **kwargs) # noqa: E501
else:
(data) = self.send_transac_sms_with_http_info(send_transac_sms, **kwargs) # noqa: E501
return data
|
(self, send_transac_sms, **kwargs)
|
60,276 |
sib_api_v3_sdk.api.transactional_sms_api
|
send_transac_sms_with_http_info
|
Send SMS message to a mobile number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_sms_with_http_info(send_transac_sms, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendTransacSms send_transac_sms: Values to send a transactional SMS (required)
:return: SendSms
If the method is called asynchronously,
returns the request thread.
|
def send_transac_sms_with_http_info(self, send_transac_sms, **kwargs): # noqa: E501
"""Send SMS message to a mobile number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_transac_sms_with_http_info(send_transac_sms, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendTransacSms send_transac_sms: Values to send a transactional SMS (required)
:return: SendSms
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['send_transac_sms'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_transac_sms" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'send_transac_sms' is set
if ('send_transac_sms' not in params or
params['send_transac_sms'] is None):
raise ValueError("Missing the required parameter `send_transac_sms` when calling `send_transac_sms`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_transac_sms' in params:
body_params = params['send_transac_sms']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/transactionalSMS/sms', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SendSms', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, send_transac_sms, **kwargs)
|
60,277 |
sib_api_v3_sdk.api.transactional_whats_app_api
|
TransactionalWhatsAppApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class TransactionalWhatsAppApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def get_whatsapp_event_report(self, **kwargs): # noqa: E501
"""Get all your WhatsApp activity (unaggregated events) # noqa: E501
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) # 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_whatsapp_event_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from
:param str start_date: **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
:param str contact_number: Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
:param str event: Filter the report for a specific event type
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWhatsappEventReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_whatsapp_event_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_whatsapp_event_report_with_http_info(**kwargs) # noqa: E501
return data
def get_whatsapp_event_report_with_http_info(self, **kwargs): # noqa: E501
"""Get all your WhatsApp activity (unaggregated events) # noqa: E501
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) # 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_whatsapp_event_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from
:param str start_date: **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
:param str contact_number: Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
:param str event: Filter the report for a specific event type
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWhatsappEventReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset', 'start_date', 'end_date', 'days', 'contact_number', 'event', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_whatsapp_event_report" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 5000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_event_report`, must be a value less than or equal to `5000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_event_report`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'contact_number' in params:
query_params.append(('contactNumber', params['contact_number'])) # noqa: E501
if 'event' in params:
query_params.append(('event', params['event'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsapp/statistics/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWhatsappEventReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def send_whatsapp_message(self, send_whatsapp_message, **kwargs): # noqa: E501
"""Send a WhatsApp message # noqa: E501
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Sendinblue platform to fetch the Template ID.**) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_whatsapp_message(send_whatsapp_message, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendWhatsappMessage send_whatsapp_message: Values to send WhatsApp message (required)
:return: InlineResponse2012
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_whatsapp_message_with_http_info(send_whatsapp_message, **kwargs) # noqa: E501
else:
(data) = self.send_whatsapp_message_with_http_info(send_whatsapp_message, **kwargs) # noqa: E501
return data
def send_whatsapp_message_with_http_info(self, send_whatsapp_message, **kwargs): # noqa: E501
"""Send a WhatsApp message # noqa: E501
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Sendinblue platform to fetch the Template ID.**) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_whatsapp_message_with_http_info(send_whatsapp_message, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendWhatsappMessage send_whatsapp_message: Values to send WhatsApp message (required)
:return: InlineResponse2012
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['send_whatsapp_message'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_whatsapp_message" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'send_whatsapp_message' is set
if ('send_whatsapp_message' not in params or
params['send_whatsapp_message'] is None):
raise ValueError("Missing the required parameter `send_whatsapp_message` when calling `send_whatsapp_message`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_whatsapp_message' in params:
body_params = params['send_whatsapp_message']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsapp/sendMessage', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2012', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client=None)
|
60,279 |
sib_api_v3_sdk.api.transactional_whats_app_api
|
get_whatsapp_event_report
|
Get all your WhatsApp activity (unaggregated events) # noqa: E501
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) # 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_whatsapp_event_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from
:param str start_date: **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
:param str contact_number: Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
:param str event: Filter the report for a specific event type
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWhatsappEventReport
If the method is called asynchronously,
returns the request thread.
|
def get_whatsapp_event_report(self, **kwargs): # noqa: E501
"""Get all your WhatsApp activity (unaggregated events) # noqa: E501
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) # 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_whatsapp_event_report(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from
:param str start_date: **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
:param str contact_number: Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
:param str event: Filter the report for a specific event type
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWhatsappEventReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_whatsapp_event_report_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_whatsapp_event_report_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
60,280 |
sib_api_v3_sdk.api.transactional_whats_app_api
|
get_whatsapp_event_report_with_http_info
|
Get all your WhatsApp activity (unaggregated events) # noqa: E501
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) # 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_whatsapp_event_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from
:param str start_date: **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
:param str contact_number: Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
:param str event: Filter the report for a specific event type
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWhatsappEventReport
If the method is called asynchronously,
returns the request thread.
|
def get_whatsapp_event_report_with_http_info(self, **kwargs): # noqa: E501
"""Get all your WhatsApp activity (unaggregated events) # noqa: E501
This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) # 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_whatsapp_event_report_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from
:param str start_date: **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
:param str end_date: **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
:param int days: Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
:param str contact_number: Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
:param str event: Filter the report for a specific event type
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetWhatsappEventReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['limit', 'offset', 'start_date', 'end_date', 'days', 'contact_number', 'event', 'sort'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_whatsapp_event_report" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 5000: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_event_report`, must be a value less than or equal to `5000`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_whatsapp_event_report`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'days' in params:
query_params.append(('days', params['days'])) # noqa: E501
if 'contact_number' in params:
query_params.append(('contactNumber', params['contact_number'])) # noqa: E501
if 'event' in params:
query_params.append(('event', params['event'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', 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(
['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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsapp/statistics/events', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetWhatsappEventReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
60,281 |
sib_api_v3_sdk.api.transactional_whats_app_api
|
send_whatsapp_message
|
Send a WhatsApp message # noqa: E501
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Sendinblue platform to fetch the Template ID.**) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_whatsapp_message(send_whatsapp_message, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendWhatsappMessage send_whatsapp_message: Values to send WhatsApp message (required)
:return: InlineResponse2012
If the method is called asynchronously,
returns the request thread.
|
def send_whatsapp_message(self, send_whatsapp_message, **kwargs): # noqa: E501
"""Send a WhatsApp message # noqa: E501
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Sendinblue platform to fetch the Template ID.**) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_whatsapp_message(send_whatsapp_message, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendWhatsappMessage send_whatsapp_message: Values to send WhatsApp message (required)
:return: InlineResponse2012
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.send_whatsapp_message_with_http_info(send_whatsapp_message, **kwargs) # noqa: E501
else:
(data) = self.send_whatsapp_message_with_http_info(send_whatsapp_message, **kwargs) # noqa: E501
return data
|
(self, send_whatsapp_message, **kwargs)
|
60,282 |
sib_api_v3_sdk.api.transactional_whats_app_api
|
send_whatsapp_message_with_http_info
|
Send a WhatsApp message # noqa: E501
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Sendinblue platform to fetch the Template ID.**) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_whatsapp_message_with_http_info(send_whatsapp_message, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendWhatsappMessage send_whatsapp_message: Values to send WhatsApp message (required)
:return: InlineResponse2012
If the method is called asynchronously,
returns the request thread.
|
def send_whatsapp_message_with_http_info(self, send_whatsapp_message, **kwargs): # noqa: E501
"""Send a WhatsApp message # noqa: E501
This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Sendinblue platform to fetch the Template ID.**) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.send_whatsapp_message_with_http_info(send_whatsapp_message, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SendWhatsappMessage send_whatsapp_message: Values to send WhatsApp message (required)
:return: InlineResponse2012
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['send_whatsapp_message'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method send_whatsapp_message" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'send_whatsapp_message' is set
if ('send_whatsapp_message' not in params or
params['send_whatsapp_message'] is None):
raise ValueError("Missing the required parameter `send_whatsapp_message` when calling `send_whatsapp_message`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_whatsapp_message' in params:
body_params = params['send_whatsapp_message']
# 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 = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/whatsapp/sendMessage', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2012', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, send_whatsapp_message, **kwargs)
|
60,283 |
sib_api_v3_sdk.models.update_attribute
|
UpdateAttribute
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateAttribute(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'value': 'str',
'enumeration': 'list[UpdateAttributeEnumeration]'
}
attribute_map = {
'value': 'value',
'enumeration': 'enumeration'
}
def __init__(self, value=None, enumeration=None): # noqa: E501
"""UpdateAttribute - a model defined in Swagger""" # noqa: E501
self._value = None
self._enumeration = None
self.discriminator = None
if value is not None:
self.value = value
if enumeration is not None:
self.enumeration = enumeration
@property
def value(self):
"""Gets the value of this UpdateAttribute. # noqa: E501
Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' # noqa: E501
:return: The value of this UpdateAttribute. # noqa: E501
:rtype: str
"""
return self._value
@value.setter
def value(self, value):
"""Sets the value of this UpdateAttribute.
Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' # noqa: E501
:param value: The value of this UpdateAttribute. # noqa: E501
:type: str
"""
self._value = value
@property
def enumeration(self):
"""Gets the enumeration of this UpdateAttribute. # noqa: E501
List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501
:return: The enumeration of this UpdateAttribute. # noqa: E501
:rtype: list[UpdateAttributeEnumeration]
"""
return self._enumeration
@enumeration.setter
def enumeration(self, enumeration):
"""Sets the enumeration of this UpdateAttribute.
List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501
:param enumeration: The enumeration of this UpdateAttribute. # noqa: E501
:type: list[UpdateAttributeEnumeration]
"""
self._enumeration = enumeration
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateAttribute, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateAttribute):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(value=None, enumeration=None)
|
60,284 |
sib_api_v3_sdk.models.update_attribute
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateAttribute):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,285 |
sib_api_v3_sdk.models.update_attribute
|
__init__
|
UpdateAttribute - a model defined in Swagger
|
def __init__(self, value=None, enumeration=None): # noqa: E501
"""UpdateAttribute - a model defined in Swagger""" # noqa: E501
self._value = None
self._enumeration = None
self.discriminator = None
if value is not None:
self.value = value
if enumeration is not None:
self.enumeration = enumeration
|
(self, value=None, enumeration=None)
|
60,288 |
sib_api_v3_sdk.models.update_attribute
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateAttribute, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,290 |
sib_api_v3_sdk.models.update_attribute_enumeration
|
UpdateAttributeEnumeration
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateAttributeEnumeration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'value': 'int',
'label': 'str'
}
attribute_map = {
'value': 'value',
'label': 'label'
}
def __init__(self, value=None, label=None): # noqa: E501
"""UpdateAttributeEnumeration - a model defined in Swagger""" # noqa: E501
self._value = None
self._label = None
self.discriminator = None
self.value = value
self.label = label
@property
def value(self):
"""Gets the value of this UpdateAttributeEnumeration. # noqa: E501
Id of the value # noqa: E501
:return: The value of this UpdateAttributeEnumeration. # noqa: E501
:rtype: int
"""
return self._value
@value.setter
def value(self, value):
"""Sets the value of this UpdateAttributeEnumeration.
Id of the value # noqa: E501
:param value: The value of this UpdateAttributeEnumeration. # noqa: E501
:type: int
"""
if value is None:
raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501
self._value = value
@property
def label(self):
"""Gets the label of this UpdateAttributeEnumeration. # noqa: E501
Label of the value # noqa: E501
:return: The label of this UpdateAttributeEnumeration. # noqa: E501
:rtype: str
"""
return self._label
@label.setter
def label(self, label):
"""Sets the label of this UpdateAttributeEnumeration.
Label of the value # noqa: E501
:param label: The label of this UpdateAttributeEnumeration. # noqa: E501
:type: str
"""
if label is None:
raise ValueError("Invalid value for `label`, must not be `None`") # noqa: E501
self._label = label
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateAttributeEnumeration, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateAttributeEnumeration):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(value=None, label=None)
|
60,291 |
sib_api_v3_sdk.models.update_attribute_enumeration
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateAttributeEnumeration):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,292 |
sib_api_v3_sdk.models.update_attribute_enumeration
|
__init__
|
UpdateAttributeEnumeration - a model defined in Swagger
|
def __init__(self, value=None, label=None): # noqa: E501
"""UpdateAttributeEnumeration - a model defined in Swagger""" # noqa: E501
self._value = None
self._label = None
self.discriminator = None
self.value = value
self.label = label
|
(self, value=None, label=None)
|
60,295 |
sib_api_v3_sdk.models.update_attribute_enumeration
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateAttributeEnumeration, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,297 |
sib_api_v3_sdk.models.update_batch_contacts
|
UpdateBatchContacts
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateBatchContacts(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'contacts': 'list[UpdateBatchContactsContacts]'
}
attribute_map = {
'contacts': 'contacts'
}
def __init__(self, contacts=None): # noqa: E501
"""UpdateBatchContacts - a model defined in Swagger""" # noqa: E501
self._contacts = None
self.discriminator = None
if contacts is not None:
self.contacts = contacts
@property
def contacts(self):
"""Gets the contacts of this UpdateBatchContacts. # noqa: E501
List of contacts to be updated # noqa: E501
:return: The contacts of this UpdateBatchContacts. # noqa: E501
:rtype: list[UpdateBatchContactsContacts]
"""
return self._contacts
@contacts.setter
def contacts(self, contacts):
"""Sets the contacts of this UpdateBatchContacts.
List of contacts to be updated # noqa: E501
:param contacts: The contacts of this UpdateBatchContacts. # noqa: E501
:type: list[UpdateBatchContactsContacts]
"""
self._contacts = contacts
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateBatchContacts, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateBatchContacts):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(contacts=None)
|
60,298 |
sib_api_v3_sdk.models.update_batch_contacts
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateBatchContacts):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,299 |
sib_api_v3_sdk.models.update_batch_contacts
|
__init__
|
UpdateBatchContacts - a model defined in Swagger
|
def __init__(self, contacts=None): # noqa: E501
"""UpdateBatchContacts - a model defined in Swagger""" # noqa: E501
self._contacts = None
self.discriminator = None
if contacts is not None:
self.contacts = contacts
|
(self, contacts=None)
|
60,302 |
sib_api_v3_sdk.models.update_batch_contacts
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateBatchContacts, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,304 |
sib_api_v3_sdk.models.update_batch_contacts_contacts
|
UpdateBatchContactsContacts
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateBatchContactsContacts(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'email': 'str',
'id': 'int',
'sms': 'str',
'ext_id': 'str',
'attributes': 'dict(str, object)',
'email_blacklisted': 'bool',
'sms_blacklisted': 'bool',
'list_ids': 'list[int]',
'unlink_list_ids': 'list[int]',
'smtp_blacklist_sender': 'list[str]'
}
attribute_map = {
'email': 'email',
'id': 'id',
'sms': 'sms',
'ext_id': 'ext_id',
'attributes': 'attributes',
'email_blacklisted': 'emailBlacklisted',
'sms_blacklisted': 'smsBlacklisted',
'list_ids': 'listIds',
'unlink_list_ids': 'unlinkListIds',
'smtp_blacklist_sender': 'smtpBlacklistSender'
}
def __init__(self, email=None, id=None, sms=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None): # noqa: E501
"""UpdateBatchContactsContacts - a model defined in Swagger""" # noqa: E501
self._email = None
self._id = None
self._sms = None
self._ext_id = None
self._attributes = None
self._email_blacklisted = None
self._sms_blacklisted = None
self._list_ids = None
self._unlink_list_ids = None
self._smtp_blacklist_sender = None
self.discriminator = None
if email is not None:
self.email = email
if id is not None:
self.id = id
if sms is not None:
self.sms = sms
if ext_id is not None:
self.ext_id = ext_id
if attributes is not None:
self.attributes = attributes
if email_blacklisted is not None:
self.email_blacklisted = email_blacklisted
if sms_blacklisted is not None:
self.sms_blacklisted = sms_blacklisted
if list_ids is not None:
self.list_ids = list_ids
if unlink_list_ids is not None:
self.unlink_list_ids = unlink_list_ids
if smtp_blacklist_sender is not None:
self.smtp_blacklist_sender = smtp_blacklist_sender
@property
def email(self):
"""Gets the email of this UpdateBatchContactsContacts. # noqa: E501
Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) # noqa: E501
:return: The email of this UpdateBatchContactsContacts. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this UpdateBatchContactsContacts.
Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) # noqa: E501
:param email: The email of this UpdateBatchContactsContacts. # noqa: E501
:type: str
"""
self._email = email
@property
def id(self):
"""Gets the id of this UpdateBatchContactsContacts. # noqa: E501
id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) # noqa: E501
:return: The id of this UpdateBatchContactsContacts. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this UpdateBatchContactsContacts.
id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) # noqa: E501
:param id: The id of this UpdateBatchContactsContacts. # noqa: E501
:type: int
"""
self._id = id
@property
def sms(self):
"""Gets the sms of this UpdateBatchContactsContacts. # noqa: E501
SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) # noqa: E501
:return: The sms of this UpdateBatchContactsContacts. # noqa: E501
:rtype: str
"""
return self._sms
@sms.setter
def sms(self, sms):
"""Sets the sms of this UpdateBatchContactsContacts.
SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) # noqa: E501
:param sms: The sms of this UpdateBatchContactsContacts. # noqa: E501
:type: str
"""
self._sms = sms
@property
def ext_id(self):
"""Gets the ext_id of this UpdateBatchContactsContacts. # noqa: E501
Pass your own Id to update ext_id of a contact. # noqa: E501
:return: The ext_id of this UpdateBatchContactsContacts. # noqa: E501
:rtype: str
"""
return self._ext_id
@ext_id.setter
def ext_id(self, ext_id):
"""Sets the ext_id of this UpdateBatchContactsContacts.
Pass your own Id to update ext_id of a contact. # noqa: E501
:param ext_id: The ext_id of this UpdateBatchContactsContacts. # noqa: E501
:type: str
"""
self._ext_id = ext_id
@property
def attributes(self):
"""Gets the attributes of this UpdateBatchContactsContacts. # noqa: E501
Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"[email protected]\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}** # noqa: E501
:return: The attributes of this UpdateBatchContactsContacts. # noqa: E501
:rtype: dict(str, object)
"""
return self._attributes
@attributes.setter
def attributes(self, attributes):
"""Sets the attributes of this UpdateBatchContactsContacts.
Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"[email protected]\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}** # noqa: E501
:param attributes: The attributes of this UpdateBatchContactsContacts. # noqa: E501
:type: dict(str, object)
"""
self._attributes = attributes
@property
def email_blacklisted(self):
"""Gets the email_blacklisted of this UpdateBatchContactsContacts. # noqa: E501
Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) # noqa: E501
:return: The email_blacklisted of this UpdateBatchContactsContacts. # noqa: E501
:rtype: bool
"""
return self._email_blacklisted
@email_blacklisted.setter
def email_blacklisted(self, email_blacklisted):
"""Sets the email_blacklisted of this UpdateBatchContactsContacts.
Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) # noqa: E501
:param email_blacklisted: The email_blacklisted of this UpdateBatchContactsContacts. # noqa: E501
:type: bool
"""
self._email_blacklisted = email_blacklisted
@property
def sms_blacklisted(self):
"""Gets the sms_blacklisted of this UpdateBatchContactsContacts. # noqa: E501
Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) # noqa: E501
:return: The sms_blacklisted of this UpdateBatchContactsContacts. # noqa: E501
:rtype: bool
"""
return self._sms_blacklisted
@sms_blacklisted.setter
def sms_blacklisted(self, sms_blacklisted):
"""Sets the sms_blacklisted of this UpdateBatchContactsContacts.
Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) # noqa: E501
:param sms_blacklisted: The sms_blacklisted of this UpdateBatchContactsContacts. # noqa: E501
:type: bool
"""
self._sms_blacklisted = sms_blacklisted
@property
def list_ids(self):
"""Gets the list_ids of this UpdateBatchContactsContacts. # noqa: E501
Ids of the lists to add the contact to # noqa: E501
:return: The list_ids of this UpdateBatchContactsContacts. # noqa: E501
:rtype: list[int]
"""
return self._list_ids
@list_ids.setter
def list_ids(self, list_ids):
"""Sets the list_ids of this UpdateBatchContactsContacts.
Ids of the lists to add the contact to # noqa: E501
:param list_ids: The list_ids of this UpdateBatchContactsContacts. # noqa: E501
:type: list[int]
"""
self._list_ids = list_ids
@property
def unlink_list_ids(self):
"""Gets the unlink_list_ids of this UpdateBatchContactsContacts. # noqa: E501
Ids of the lists to remove the contact from # noqa: E501
:return: The unlink_list_ids of this UpdateBatchContactsContacts. # noqa: E501
:rtype: list[int]
"""
return self._unlink_list_ids
@unlink_list_ids.setter
def unlink_list_ids(self, unlink_list_ids):
"""Sets the unlink_list_ids of this UpdateBatchContactsContacts.
Ids of the lists to remove the contact from # noqa: E501
:param unlink_list_ids: The unlink_list_ids of this UpdateBatchContactsContacts. # noqa: E501
:type: list[int]
"""
self._unlink_list_ids = unlink_list_ids
@property
def smtp_blacklist_sender(self):
"""Gets the smtp_blacklist_sender of this UpdateBatchContactsContacts. # noqa: E501
transactional email forbidden sender for contact. Use only for email Contact # noqa: E501
:return: The smtp_blacklist_sender of this UpdateBatchContactsContacts. # noqa: E501
:rtype: list[str]
"""
return self._smtp_blacklist_sender
@smtp_blacklist_sender.setter
def smtp_blacklist_sender(self, smtp_blacklist_sender):
"""Sets the smtp_blacklist_sender of this UpdateBatchContactsContacts.
transactional email forbidden sender for contact. Use only for email Contact # noqa: E501
:param smtp_blacklist_sender: The smtp_blacklist_sender of this UpdateBatchContactsContacts. # noqa: E501
:type: list[str]
"""
self._smtp_blacklist_sender = smtp_blacklist_sender
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateBatchContactsContacts, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateBatchContactsContacts):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(email=None, id=None, sms=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None)
|
60,305 |
sib_api_v3_sdk.models.update_batch_contacts_contacts
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateBatchContactsContacts):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,306 |
sib_api_v3_sdk.models.update_batch_contacts_contacts
|
__init__
|
UpdateBatchContactsContacts - a model defined in Swagger
|
def __init__(self, email=None, id=None, sms=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None): # noqa: E501
"""UpdateBatchContactsContacts - a model defined in Swagger""" # noqa: E501
self._email = None
self._id = None
self._sms = None
self._ext_id = None
self._attributes = None
self._email_blacklisted = None
self._sms_blacklisted = None
self._list_ids = None
self._unlink_list_ids = None
self._smtp_blacklist_sender = None
self.discriminator = None
if email is not None:
self.email = email
if id is not None:
self.id = id
if sms is not None:
self.sms = sms
if ext_id is not None:
self.ext_id = ext_id
if attributes is not None:
self.attributes = attributes
if email_blacklisted is not None:
self.email_blacklisted = email_blacklisted
if sms_blacklisted is not None:
self.sms_blacklisted = sms_blacklisted
if list_ids is not None:
self.list_ids = list_ids
if unlink_list_ids is not None:
self.unlink_list_ids = unlink_list_ids
if smtp_blacklist_sender is not None:
self.smtp_blacklist_sender = smtp_blacklist_sender
|
(self, email=None, id=None, sms=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, unlink_list_ids=None, smtp_blacklist_sender=None)
|
60,309 |
sib_api_v3_sdk.models.update_batch_contacts_contacts
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateBatchContactsContacts, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,311 |
sib_api_v3_sdk.models.update_batch_contacts_model
|
UpdateBatchContactsModel
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateBatchContactsModel(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'success_ids': 'list[int]',
'failure_ids': 'list[int]'
}
attribute_map = {
'success_ids': 'successIds',
'failure_ids': 'failureIds'
}
def __init__(self, success_ids=None, failure_ids=None): # noqa: E501
"""UpdateBatchContactsModel - a model defined in Swagger""" # noqa: E501
self._success_ids = None
self._failure_ids = None
self.discriminator = None
if success_ids is not None:
self.success_ids = success_ids
if failure_ids is not None:
self.failure_ids = failure_ids
@property
def success_ids(self):
"""Gets the success_ids of this UpdateBatchContactsModel. # noqa: E501
:return: The success_ids of this UpdateBatchContactsModel. # noqa: E501
:rtype: list[int]
"""
return self._success_ids
@success_ids.setter
def success_ids(self, success_ids):
"""Sets the success_ids of this UpdateBatchContactsModel.
:param success_ids: The success_ids of this UpdateBatchContactsModel. # noqa: E501
:type: list[int]
"""
self._success_ids = success_ids
@property
def failure_ids(self):
"""Gets the failure_ids of this UpdateBatchContactsModel. # noqa: E501
:return: The failure_ids of this UpdateBatchContactsModel. # noqa: E501
:rtype: list[int]
"""
return self._failure_ids
@failure_ids.setter
def failure_ids(self, failure_ids):
"""Sets the failure_ids of this UpdateBatchContactsModel.
:param failure_ids: The failure_ids of this UpdateBatchContactsModel. # noqa: E501
:type: list[int]
"""
self._failure_ids = failure_ids
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateBatchContactsModel, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateBatchContactsModel):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(success_ids=None, failure_ids=None)
|
60,312 |
sib_api_v3_sdk.models.update_batch_contacts_model
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateBatchContactsModel):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,313 |
sib_api_v3_sdk.models.update_batch_contacts_model
|
__init__
|
UpdateBatchContactsModel - a model defined in Swagger
|
def __init__(self, success_ids=None, failure_ids=None): # noqa: E501
"""UpdateBatchContactsModel - a model defined in Swagger""" # noqa: E501
self._success_ids = None
self._failure_ids = None
self.discriminator = None
if success_ids is not None:
self.success_ids = success_ids
if failure_ids is not None:
self.failure_ids = failure_ids
|
(self, success_ids=None, failure_ids=None)
|
60,316 |
sib_api_v3_sdk.models.update_batch_contacts_model
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateBatchContactsModel, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,318 |
sib_api_v3_sdk.models.update_campaign_status
|
UpdateCampaignStatus
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateCampaignStatus(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'status': 'str'
}
attribute_map = {
'status': 'status'
}
def __init__(self, status=None): # noqa: E501
"""UpdateCampaignStatus - a model defined in Swagger""" # noqa: E501
self._status = None
self.discriminator = None
if status is not None:
self.status = status
@property
def status(self):
"""Gets the status of this UpdateCampaignStatus. # noqa: E501
Note:- replicateTemplate status will be available only for template type campaigns. # noqa: E501
:return: The status of this UpdateCampaignStatus. # noqa: E501
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""Sets the status of this UpdateCampaignStatus.
Note:- replicateTemplate status will be available only for template type campaigns. # noqa: E501
:param status: The status of this UpdateCampaignStatus. # noqa: E501
:type: str
"""
allowed_values = ["suspended", "archive", "darchive", "sent", "queued", "replicate", "replicateTemplate", "draft"] # noqa: E501
if status not in allowed_values:
raise ValueError(
"Invalid value for `status` ({0}), must be one of {1}" # noqa: E501
.format(status, allowed_values)
)
self._status = status
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateCampaignStatus, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateCampaignStatus):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(status=None)
|
60,319 |
sib_api_v3_sdk.models.update_campaign_status
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateCampaignStatus):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,320 |
sib_api_v3_sdk.models.update_campaign_status
|
__init__
|
UpdateCampaignStatus - a model defined in Swagger
|
def __init__(self, status=None): # noqa: E501
"""UpdateCampaignStatus - a model defined in Swagger""" # noqa: E501
self._status = None
self.discriminator = None
if status is not None:
self.status = status
|
(self, status=None)
|
60,323 |
sib_api_v3_sdk.models.update_campaign_status
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateCampaignStatus, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,325 |
sib_api_v3_sdk.models.update_child
|
UpdateChild
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateChild(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'email': 'str',
'first_name': 'str',
'last_name': 'str',
'company_name': 'str',
'password': 'str'
}
attribute_map = {
'email': 'email',
'first_name': 'firstName',
'last_name': 'lastName',
'company_name': 'companyName',
'password': 'password'
}
def __init__(self, email=None, first_name=None, last_name=None, company_name=None, password=None): # noqa: E501
"""UpdateChild - a model defined in Swagger""" # noqa: E501
self._email = None
self._first_name = None
self._last_name = None
self._company_name = None
self._password = None
self.discriminator = None
if email is not None:
self.email = email
if first_name is not None:
self.first_name = first_name
if last_name is not None:
self.last_name = last_name
if company_name is not None:
self.company_name = company_name
if password is not None:
self.password = password
@property
def email(self):
"""Gets the email of this UpdateChild. # noqa: E501
New Email address to update the child account # noqa: E501
:return: The email of this UpdateChild. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this UpdateChild.
New Email address to update the child account # noqa: E501
:param email: The email of this UpdateChild. # noqa: E501
:type: str
"""
self._email = email
@property
def first_name(self):
"""Gets the first_name of this UpdateChild. # noqa: E501
New First name to use to update the child account # noqa: E501
:return: The first_name of this UpdateChild. # noqa: E501
:rtype: str
"""
return self._first_name
@first_name.setter
def first_name(self, first_name):
"""Sets the first_name of this UpdateChild.
New First name to use to update the child account # noqa: E501
:param first_name: The first_name of this UpdateChild. # noqa: E501
:type: str
"""
self._first_name = first_name
@property
def last_name(self):
"""Gets the last_name of this UpdateChild. # noqa: E501
New Last name to use to update the child account # noqa: E501
:return: The last_name of this UpdateChild. # noqa: E501
:rtype: str
"""
return self._last_name
@last_name.setter
def last_name(self, last_name):
"""Sets the last_name of this UpdateChild.
New Last name to use to update the child account # noqa: E501
:param last_name: The last_name of this UpdateChild. # noqa: E501
:type: str
"""
self._last_name = last_name
@property
def company_name(self):
"""Gets the company_name of this UpdateChild. # noqa: E501
New Company name to use to update the child account # noqa: E501
:return: The company_name of this UpdateChild. # noqa: E501
:rtype: str
"""
return self._company_name
@company_name.setter
def company_name(self, company_name):
"""Sets the company_name of this UpdateChild.
New Company name to use to update the child account # noqa: E501
:param company_name: The company_name of this UpdateChild. # noqa: E501
:type: str
"""
self._company_name = company_name
@property
def password(self):
"""Gets the password of this UpdateChild. # noqa: E501
New password for the child account to login # noqa: E501
:return: The password of this UpdateChild. # noqa: E501
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""Sets the password of this UpdateChild.
New password for the child account to login # noqa: E501
:param password: The password of this UpdateChild. # noqa: E501
:type: str
"""
self._password = password
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateChild, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateChild):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(email=None, first_name=None, last_name=None, company_name=None, password=None)
|
60,326 |
sib_api_v3_sdk.models.update_child
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateChild):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,327 |
sib_api_v3_sdk.models.update_child
|
__init__
|
UpdateChild - a model defined in Swagger
|
def __init__(self, email=None, first_name=None, last_name=None, company_name=None, password=None): # noqa: E501
"""UpdateChild - a model defined in Swagger""" # noqa: E501
self._email = None
self._first_name = None
self._last_name = None
self._company_name = None
self._password = None
self.discriminator = None
if email is not None:
self.email = email
if first_name is not None:
self.first_name = first_name
if last_name is not None:
self.last_name = last_name
if company_name is not None:
self.company_name = company_name
if password is not None:
self.password = password
|
(self, email=None, first_name=None, last_name=None, company_name=None, password=None)
|
60,330 |
sib_api_v3_sdk.models.update_child
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateChild, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,332 |
sib_api_v3_sdk.models.update_child_account_status
|
UpdateChildAccountStatus
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateChildAccountStatus(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'transactional_email': 'bool',
'transactional_sms': 'bool',
'marketing_automation': 'bool',
'sms_campaign': 'bool'
}
attribute_map = {
'transactional_email': 'transactionalEmail',
'transactional_sms': 'transactionalSms',
'marketing_automation': 'marketingAutomation',
'sms_campaign': 'smsCampaign'
}
def __init__(self, transactional_email=None, transactional_sms=None, marketing_automation=None, sms_campaign=None): # noqa: E501
"""UpdateChildAccountStatus - a model defined in Swagger""" # noqa: E501
self._transactional_email = None
self._transactional_sms = None
self._marketing_automation = None
self._sms_campaign = None
self.discriminator = None
if transactional_email is not None:
self.transactional_email = transactional_email
if transactional_sms is not None:
self.transactional_sms = transactional_sms
if marketing_automation is not None:
self.marketing_automation = marketing_automation
if sms_campaign is not None:
self.sms_campaign = sms_campaign
@property
def transactional_email(self):
"""Gets the transactional_email of this UpdateChildAccountStatus. # noqa: E501
Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:return: The transactional_email of this UpdateChildAccountStatus. # noqa: E501
:rtype: bool
"""
return self._transactional_email
@transactional_email.setter
def transactional_email(self, transactional_email):
"""Sets the transactional_email of this UpdateChildAccountStatus.
Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:param transactional_email: The transactional_email of this UpdateChildAccountStatus. # noqa: E501
:type: bool
"""
self._transactional_email = transactional_email
@property
def transactional_sms(self):
"""Gets the transactional_sms of this UpdateChildAccountStatus. # noqa: E501
Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:return: The transactional_sms of this UpdateChildAccountStatus. # noqa: E501
:rtype: bool
"""
return self._transactional_sms
@transactional_sms.setter
def transactional_sms(self, transactional_sms):
"""Sets the transactional_sms of this UpdateChildAccountStatus.
Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:param transactional_sms: The transactional_sms of this UpdateChildAccountStatus. # noqa: E501
:type: bool
"""
self._transactional_sms = transactional_sms
@property
def marketing_automation(self):
"""Gets the marketing_automation of this UpdateChildAccountStatus. # noqa: E501
Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:return: The marketing_automation of this UpdateChildAccountStatus. # noqa: E501
:rtype: bool
"""
return self._marketing_automation
@marketing_automation.setter
def marketing_automation(self, marketing_automation):
"""Sets the marketing_automation of this UpdateChildAccountStatus.
Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:param marketing_automation: The marketing_automation of this UpdateChildAccountStatus. # noqa: E501
:type: bool
"""
self._marketing_automation = marketing_automation
@property
def sms_campaign(self):
"""Gets the sms_campaign of this UpdateChildAccountStatus. # noqa: E501
Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:return: The sms_campaign of this UpdateChildAccountStatus. # noqa: E501
:rtype: bool
"""
return self._sms_campaign
@sms_campaign.setter
def sms_campaign(self, sms_campaign):
"""Sets the sms_campaign of this UpdateChildAccountStatus.
Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) # noqa: E501
:param sms_campaign: The sms_campaign of this UpdateChildAccountStatus. # noqa: E501
:type: bool
"""
self._sms_campaign = sms_campaign
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateChildAccountStatus, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateChildAccountStatus):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(transactional_email=None, transactional_sms=None, marketing_automation=None, sms_campaign=None)
|
60,333 |
sib_api_v3_sdk.models.update_child_account_status
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateChildAccountStatus):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,334 |
sib_api_v3_sdk.models.update_child_account_status
|
__init__
|
UpdateChildAccountStatus - a model defined in Swagger
|
def __init__(self, transactional_email=None, transactional_sms=None, marketing_automation=None, sms_campaign=None): # noqa: E501
"""UpdateChildAccountStatus - a model defined in Swagger""" # noqa: E501
self._transactional_email = None
self._transactional_sms = None
self._marketing_automation = None
self._sms_campaign = None
self.discriminator = None
if transactional_email is not None:
self.transactional_email = transactional_email
if transactional_sms is not None:
self.transactional_sms = transactional_sms
if marketing_automation is not None:
self.marketing_automation = marketing_automation
if sms_campaign is not None:
self.sms_campaign = sms_campaign
|
(self, transactional_email=None, transactional_sms=None, marketing_automation=None, sms_campaign=None)
|
60,337 |
sib_api_v3_sdk.models.update_child_account_status
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateChildAccountStatus, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,339 |
sib_api_v3_sdk.models.update_child_domain
|
UpdateChildDomain
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class UpdateChildDomain(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'domain': 'str'
}
attribute_map = {
'domain': 'domain'
}
def __init__(self, domain=None): # noqa: E501
"""UpdateChildDomain - a model defined in Swagger""" # noqa: E501
self._domain = None
self.discriminator = None
if domain is not None:
self.domain = domain
@property
def domain(self):
"""Gets the domain of this UpdateChildDomain. # noqa: E501
Value for the sender domain that will replace the existing domain # noqa: E501
:return: The domain of this UpdateChildDomain. # noqa: E501
:rtype: str
"""
return self._domain
@domain.setter
def domain(self, domain):
"""Sets the domain of this UpdateChildDomain.
Value for the sender domain that will replace the existing domain # noqa: E501
:param domain: The domain of this UpdateChildDomain. # noqa: E501
:type: str
"""
self._domain = domain
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateChildDomain, dict):
for key, value in self.items():
result[key] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateChildDomain):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(domain=None)
|
60,340 |
sib_api_v3_sdk.models.update_child_domain
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, UpdateChildDomain):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,341 |
sib_api_v3_sdk.models.update_child_domain
|
__init__
|
UpdateChildDomain - a model defined in Swagger
|
def __init__(self, domain=None): # noqa: E501
"""UpdateChildDomain - a model defined in Swagger""" # noqa: E501
self._domain = None
self.discriminator = None
if domain is not None:
self.domain = domain
|
(self, domain=None)
|
60,344 |
sib_api_v3_sdk.models.update_child_domain
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(UpdateChildDomain, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.