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
⌀ |
|---|---|---|---|---|---|
59,905 |
sib_api_v3_sdk.api.reseller_api
|
get_child_info
|
Get a child account's details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildInfo
If the method is called asynchronously,
returns the request thread.
|
def get_child_info(self, child_identifier, **kwargs): # noqa: E501
"""Get a child account's details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_child_info_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_child_info_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
|
(self, child_identifier, **kwargs)
|
59,906 |
sib_api_v3_sdk.api.reseller_api
|
get_child_info_with_http_info
|
Get a child account's details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_info_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildInfo
If the method is called asynchronously,
returns the request thread.
|
def get_child_info_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get a child account's details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_child_info_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetChildInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_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 get_child_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_child_info`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_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(
'/reseller/children/{childIdentifier}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildInfo', # 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, child_identifier, **kwargs)
|
59,907 |
sib_api_v3_sdk.api.reseller_api
|
get_reseller_childs
|
Get the list of all children accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_reseller_childs(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents for child accounts information per page
:param int offset: Index of the first document in the page
:return: GetChildrenList
If the method is called asynchronously,
returns the request thread.
|
def get_reseller_childs(self, **kwargs): # noqa: E501
"""Get the list of all children accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_reseller_childs(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents for child accounts information per page
:param int offset: Index of the first document in the page
:return: GetChildrenList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_reseller_childs_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_reseller_childs_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,908 |
sib_api_v3_sdk.api.reseller_api
|
get_reseller_childs_with_http_info
|
Get the list of all children accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_reseller_childs_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents for child accounts information per page
:param int offset: Index of the first document in the page
:return: GetChildrenList
If the method is called asynchronously,
returns the request thread.
|
def get_reseller_childs_with_http_info(self, **kwargs): # noqa: E501
"""Get the list of all children accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_reseller_childs_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents for child accounts information per page
:param int offset: Index of the first document in the page
:return: GetChildrenList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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_reseller_childs" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 20: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_reseller_childs`, must be a value less than or equal to `20`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_reseller_childs`, 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
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(
'/reseller/children', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetChildrenList', # 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)
|
59,909 |
sib_api_v3_sdk.api.reseller_api
|
get_sso_token
|
Get session token to access Sendinblue (SSO) # noqa: E501
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sso_token(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
|
def get_sso_token(self, child_identifier, **kwargs): # noqa: E501
"""Get session token to access Sendinblue (SSO) # noqa: E501
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sso_token(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_sso_token_with_http_info(child_identifier, **kwargs) # noqa: E501
else:
(data) = self.get_sso_token_with_http_info(child_identifier, **kwargs) # noqa: E501
return data
|
(self, child_identifier, **kwargs)
|
59,910 |
sib_api_v3_sdk.api.reseller_api
|
get_sso_token_with_http_info
|
Get session token to access Sendinblue (SSO) # noqa: E501
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sso_token_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
|
def get_sso_token_with_http_info(self, child_identifier, **kwargs): # noqa: E501
"""Get session token to access Sendinblue (SSO) # noqa: E501
It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sso_token_with_http_info(child_identifier, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:return: GetSsoToken
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_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 get_sso_token" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `get_sso_token`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_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(
'/reseller/children/{childIdentifier}/auth', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSsoToken', # 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, child_identifier, **kwargs)
|
59,911 |
sib_api_v3_sdk.api.reseller_api
|
remove_credits
|
Remove Email and/or SMS credits from a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_credits(child_identifier, remove_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
|
def remove_credits(self, child_identifier, remove_credits, **kwargs): # noqa: E501
"""Remove Email and/or SMS credits from a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_credits(child_identifier, remove_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.remove_credits_with_http_info(child_identifier, remove_credits, **kwargs) # noqa: E501
else:
(data) = self.remove_credits_with_http_info(child_identifier, remove_credits, **kwargs) # noqa: E501
return data
|
(self, child_identifier, remove_credits, **kwargs)
|
59,912 |
sib_api_v3_sdk.api.reseller_api
|
remove_credits_with_http_info
|
Remove Email and/or SMS credits from a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_credits_with_http_info(child_identifier, remove_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
|
def remove_credits_with_http_info(self, child_identifier, remove_credits, **kwargs): # noqa: E501
"""Remove Email and/or SMS credits from a specific child account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_credits_with_http_info(child_identifier, remove_credits, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param RemoveCredits remove_credits: Values to post to remove email or SMS credits from a specific child account (required)
:return: RemainingCreditModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'remove_credits'] # 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 remove_credits" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `remove_credits`") # noqa: E501
# verify the required parameter 'remove_credits' is set
if ('remove_credits' not in params or
params['remove_credits'] is None):
raise ValueError("Missing the required parameter `remove_credits` when calling `remove_credits`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'remove_credits' in params:
body_params = params['remove_credits']
# 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(
'/reseller/children/{childIdentifier}/credits/remove', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='RemainingCreditModel', # 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, child_identifier, remove_credits, **kwargs)
|
59,913 |
sib_api_v3_sdk.api.reseller_api
|
update_child_account_status
|
Update info of reseller's child account status based on the childIdentifier supplied # 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_child_account_status(child_identifier, update_child_account_status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_child_account_status(self, child_identifier, update_child_account_status, **kwargs): # noqa: E501
"""Update info of reseller's child account status based on the childIdentifier supplied # 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_child_account_status(child_identifier, update_child_account_status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChildAccountStatus update_child_account_status: values to update in child account status (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_child_account_status_with_http_info(child_identifier, update_child_account_status, **kwargs) # noqa: E501
else:
(data) = self.update_child_account_status_with_http_info(child_identifier, update_child_account_status, **kwargs) # noqa: E501
return data
|
(self, child_identifier, update_child_account_status, **kwargs)
|
59,914 |
sib_api_v3_sdk.api.reseller_api
|
update_child_account_status_with_http_info
|
Update info of reseller's child account status based on the childIdentifier supplied # 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_child_account_status_with_http_info(child_identifier, update_child_account_status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_child_account_status_with_http_info(self, child_identifier, update_child_account_status, **kwargs): # noqa: E501
"""Update info of reseller's child account status based on the childIdentifier supplied # 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_child_account_status_with_http_info(child_identifier, update_child_account_status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChildAccountStatus update_child_account_status: values to update in child account status (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'update_child_account_status'] # 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_child_account_status" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `update_child_account_status`") # noqa: E501
# verify the required parameter 'update_child_account_status' is set
if ('update_child_account_status' not in params or
params['update_child_account_status'] is None):
raise ValueError("Missing the required parameter `update_child_account_status` when calling `update_child_account_status`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_child_account_status' in params:
body_params = params['update_child_account_status']
# 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(
'/reseller/children/{childIdentifier}/accountStatus', '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, child_identifier, update_child_account_status, **kwargs)
|
59,915 |
sib_api_v3_sdk.api.reseller_api
|
update_child_domain
|
Update the sender domain of reseller's child based on the childIdentifier and domainName passed # 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_child_domain(child_identifier, domain_name, update_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be updated (required)
:param UpdateChildDomain update_child_domain: value to update for sender domain (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_child_domain(self, child_identifier, domain_name, update_child_domain, **kwargs): # noqa: E501
"""Update the sender domain of reseller's child based on the childIdentifier and domainName passed # 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_child_domain(child_identifier, domain_name, update_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be updated (required)
:param UpdateChildDomain update_child_domain: value to update for sender 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.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, **kwargs) # noqa: E501
else:
(data) = self.update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, **kwargs) # noqa: E501
return data
|
(self, child_identifier, domain_name, update_child_domain, **kwargs)
|
59,916 |
sib_api_v3_sdk.api.reseller_api
|
update_child_domain_with_http_info
|
Update the sender domain of reseller's child based on the childIdentifier and domainName passed # 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_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be updated (required)
:param UpdateChildDomain update_child_domain: value to update for sender domain (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_child_domain_with_http_info(self, child_identifier, domain_name, update_child_domain, **kwargs): # noqa: E501
"""Update the sender domain of reseller's child based on the childIdentifier and domainName passed # 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_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param str domain_name: Pass the existing domain that needs to be updated (required)
:param UpdateChildDomain update_child_domain: value to update for sender domain (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'domain_name', 'update_child_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 update_child_domain" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `update_child_domain`") # noqa: E501
# verify the required parameter 'domain_name' is set
if ('domain_name' not in params or
params['domain_name'] is None):
raise ValueError("Missing the required parameter `domain_name` when calling `update_child_domain`") # noqa: E501
# verify the required parameter 'update_child_domain' is set
if ('update_child_domain' not in params or
params['update_child_domain'] is None):
raise ValueError("Missing the required parameter `update_child_domain` when calling `update_child_domain`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
if 'domain_name' in params:
path_params['domainName'] = params['domain_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_child_domain' in params:
body_params = params['update_child_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(
'/reseller/children/{childIdentifier}/domains/{domainName}', '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, child_identifier, domain_name, update_child_domain, **kwargs)
|
59,917 |
sib_api_v3_sdk.api.reseller_api
|
update_reseller_child
|
Update info of reseller's child based on the child identifier supplied # 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_reseller_child(child_identifier, reseller_child, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChild reseller_child: values to update in child profile (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_reseller_child(self, child_identifier, reseller_child, **kwargs): # noqa: E501
"""Update info of reseller's child based on the child identifier supplied # 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_reseller_child(child_identifier, reseller_child, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChild reseller_child: values to update in child profile (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_reseller_child_with_http_info(child_identifier, reseller_child, **kwargs) # noqa: E501
else:
(data) = self.update_reseller_child_with_http_info(child_identifier, reseller_child, **kwargs) # noqa: E501
return data
|
(self, child_identifier, reseller_child, **kwargs)
|
59,918 |
sib_api_v3_sdk.api.reseller_api
|
update_reseller_child_with_http_info
|
Update info of reseller's child based on the child identifier supplied # 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_reseller_child_with_http_info(child_identifier, reseller_child, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChild reseller_child: values to update in child profile (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_reseller_child_with_http_info(self, child_identifier, reseller_child, **kwargs): # noqa: E501
"""Update info of reseller's child based on the child identifier supplied # 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_reseller_child_with_http_info(child_identifier, reseller_child, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str child_identifier: Either auth key or id of reseller's child (required)
:param UpdateChild reseller_child: values to update in child profile (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['child_identifier', 'reseller_child'] # 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_reseller_child" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'child_identifier' is set
if ('child_identifier' not in params or
params['child_identifier'] is None):
raise ValueError("Missing the required parameter `child_identifier` when calling `update_reseller_child`") # noqa: E501
# verify the required parameter 'reseller_child' is set
if ('reseller_child' not in params or
params['reseller_child'] is None):
raise ValueError("Missing the required parameter `reseller_child` when calling `update_reseller_child`") # noqa: E501
collection_formats = {}
path_params = {}
if 'child_identifier' in params:
path_params['childIdentifier'] = params['child_identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reseller_child' in params:
body_params = params['reseller_child']
# 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(
'/reseller/children/{childIdentifier}', '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, child_identifier, reseller_child, **kwargs)
|
59,919 |
sib_api_v3_sdk.api.sms_campaigns_api
|
SMSCampaignsApi
|
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 SMSCampaignsApi(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 create_sms_campaign(self, create_sms_campaign, **kwargs): # noqa: E501
"""Creates an SMS campaign # 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_sms_campaign(create_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmsCampaign create_sms_campaign: Values to create an SMS Campaign (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_sms_campaign_with_http_info(create_sms_campaign, **kwargs) # noqa: E501
else:
(data) = self.create_sms_campaign_with_http_info(create_sms_campaign, **kwargs) # noqa: E501
return data
def create_sms_campaign_with_http_info(self, create_sms_campaign, **kwargs): # noqa: E501
"""Creates an SMS campaign # 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_sms_campaign_with_http_info(create_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmsCampaign create_sms_campaign: Values to create an SMS Campaign (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_sms_campaign'] # 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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_sms_campaign' is set
if ('create_sms_campaign' not in params or
params['create_sms_campaign'] is None):
raise ValueError("Missing the required parameter `create_sms_campaign` when calling `create_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_sms_campaign' in params:
body_params = params['create_sms_campaign']
# 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(
'/smsCampaigns', '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_sms_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Delete an SMS campaign # 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_sms_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (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_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.delete_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def delete_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Delete an SMS campaign # 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_sms_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `delete_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_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(
'/smsCampaigns/{campaignId}', '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_sms_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Get an SMS campaign # noqa: 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_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: GetSmsCampaign
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_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get an SMS campaign # noqa: 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_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: GetSmsCampaign
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `get_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_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(
'/smsCampaigns/{campaignId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmsCampaign', # 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_sms_campaigns(self, **kwargs): # noqa: E501
"""Returns the information for all your created SMS campaigns # noqa: 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_campaigns(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str status: Status of campaign.
:param str start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsCampaigns
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_campaigns_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_sms_campaigns_with_http_info(**kwargs) # noqa: E501
return data
def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501
"""Returns the information for all your created SMS campaigns # noqa: 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_campaigns_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str status: Status of campaign.
:param str start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsCampaigns
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['status', 'start_date', 'end_date', '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_sms_campaigns" % 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_sms_campaigns`, 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_sms_campaigns`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'status' in params:
query_params.append(('status', params['status'])) # 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 '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(
'/smsCampaigns', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmsCampaigns', # 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 request_sms_recipient_export(self, campaign_id, **kwargs): # noqa: E501
"""Export an SMS campaign's recipients # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.request_sms_recipient_export(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param RequestSmsRecipientExport recipient_export: Values to send for a recipient export request
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.request_sms_recipient_export_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.request_sms_recipient_export_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def request_sms_recipient_export_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Export an SMS campaign's recipients # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.request_sms_recipient_export_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param RequestSmsRecipientExport recipient_export: Values to send for a recipient export request
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'recipient_export'] # 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 request_sms_recipient_export" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `request_sms_recipient_export`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'recipient_export' in params:
body_params = params['recipient_export']
# 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(
'/smsCampaigns/{campaignId}/exportRecipients', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreatedProcessId', # 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_sms_campaign_now(self, campaign_id, **kwargs): # noqa: E501
"""Send your SMS campaign immediately # 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_sms_campaign_now(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (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_sms_campaign_now_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.send_sms_campaign_now_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def send_sms_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Send your SMS campaign immediately # 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_sms_campaign_now_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_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 send_sms_campaign_now" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `send_sms_campaign_now`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_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(
'/smsCampaigns/{campaignId}/sendNow', '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_sms_report(self, campaign_id, send_report, **kwargs): # noqa: E501
"""Send an SMS campaign's report # noqa: E501
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # 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_sms_report(campaign_id, send_report, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param SendReport send_report: Values for send a report (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_sms_report_with_http_info(campaign_id, send_report, **kwargs) # noqa: E501
else:
(data) = self.send_sms_report_with_http_info(campaign_id, send_report, **kwargs) # noqa: E501
return data
def send_sms_report_with_http_info(self, campaign_id, send_report, **kwargs): # noqa: E501
"""Send an SMS campaign's report # noqa: E501
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # 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_sms_report_with_http_info(campaign_id, send_report, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param SendReport send_report: Values for send a report (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'send_report'] # 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_sms_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `send_sms_report`") # noqa: E501
# verify the required parameter 'send_report' is set
if ('send_report' not in params or
params['send_report'] is None):
raise ValueError("Missing the required parameter `send_report` when calling `send_sms_report`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_report' in params:
body_params = params['send_report']
# 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(
'/smsCampaigns/{campaignId}/sendReport', '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_test_sms(self, campaign_id, phone_number, **kwargs): # noqa: E501
"""Send a test SMS campaign # 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_sms(campaign_id, phone_number, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: Id of the SMS campaign (required)
:param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (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_sms_with_http_info(campaign_id, phone_number, **kwargs) # noqa: E501
else:
(data) = self.send_test_sms_with_http_info(campaign_id, phone_number, **kwargs) # noqa: E501
return data
def send_test_sms_with_http_info(self, campaign_id, phone_number, **kwargs): # noqa: E501
"""Send a test SMS campaign # 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_sms_with_http_info(campaign_id, phone_number, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: Id of the SMS campaign (required)
:param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'phone_number'] # 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_sms" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `send_test_sms`") # noqa: E501
# verify the required parameter 'phone_number' is set
if ('phone_number' not in params or
params['phone_number'] is None):
raise ValueError("Missing the required parameter `phone_number` when calling `send_test_sms`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'phone_number' in params:
body_params = params['phone_number']
# 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(
'/smsCampaigns/{campaignId}/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 update_sms_campaign(self, campaign_id, update_sms_campaign, **kwargs): # noqa: E501
"""Update an SMS campaign # 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_sms_campaign(campaign_id, update_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:param UpdateSmsCampaign update_sms_campaign: Values to update an SMS Campaign (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_sms_campaign_with_http_info(campaign_id, update_sms_campaign, **kwargs) # noqa: E501
else:
(data) = self.update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, **kwargs) # noqa: E501
return data
def update_sms_campaign_with_http_info(self, campaign_id, update_sms_campaign, **kwargs): # noqa: E501
"""Update an SMS campaign # 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_sms_campaign_with_http_info(campaign_id, update_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:param UpdateSmsCampaign update_sms_campaign: Values to update an SMS Campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'update_sms_campaign'] # 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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `update_sms_campaign`") # noqa: E501
# verify the required parameter 'update_sms_campaign' is set
if ('update_sms_campaign' not in params or
params['update_sms_campaign'] is None):
raise ValueError("Missing the required parameter `update_sms_campaign` when calling `update_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_sms_campaign' in params:
body_params = params['update_sms_campaign']
# 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(
'/smsCampaigns/{campaignId}', '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)
def update_sms_campaign_status(self, campaign_id, status, **kwargs): # noqa: E501
"""Update a campaign's status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_sms_campaign_status(campaign_id, status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param UpdateCampaignStatus status: Status of the campaign. (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_sms_campaign_status_with_http_info(campaign_id, status, **kwargs) # noqa: E501
else:
(data) = self.update_sms_campaign_status_with_http_info(campaign_id, status, **kwargs) # noqa: E501
return data
def update_sms_campaign_status_with_http_info(self, campaign_id, status, **kwargs): # noqa: E501
"""Update a campaign's status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_sms_campaign_status_with_http_info(campaign_id, status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param UpdateCampaignStatus status: Status of the campaign. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'status'] # 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_sms_campaign_status" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `update_sms_campaign_status`") # noqa: E501
# verify the required parameter 'status' is set
if ('status' not in params or
params['status'] is None):
raise ValueError("Missing the required parameter `status` when calling `update_sms_campaign_status`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'status' in params:
body_params = params['status']
# 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(
'/smsCampaigns/{campaignId}/status', '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)
|
59,921 |
sib_api_v3_sdk.api.sms_campaigns_api
|
create_sms_campaign
|
Creates an SMS campaign # 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_sms_campaign(create_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmsCampaign create_sms_campaign: Values to create an SMS Campaign (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
|
def create_sms_campaign(self, create_sms_campaign, **kwargs): # noqa: E501
"""Creates an SMS campaign # 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_sms_campaign(create_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmsCampaign create_sms_campaign: Values to create an SMS Campaign (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_sms_campaign_with_http_info(create_sms_campaign, **kwargs) # noqa: E501
else:
(data) = self.create_sms_campaign_with_http_info(create_sms_campaign, **kwargs) # noqa: E501
return data
|
(self, create_sms_campaign, **kwargs)
|
59,922 |
sib_api_v3_sdk.api.sms_campaigns_api
|
create_sms_campaign_with_http_info
|
Creates an SMS campaign # 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_sms_campaign_with_http_info(create_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmsCampaign create_sms_campaign: Values to create an SMS Campaign (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
|
def create_sms_campaign_with_http_info(self, create_sms_campaign, **kwargs): # noqa: E501
"""Creates an SMS campaign # 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_sms_campaign_with_http_info(create_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateSmsCampaign create_sms_campaign: Values to create an SMS Campaign (required)
:return: CreateModel
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_sms_campaign'] # 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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_sms_campaign' is set
if ('create_sms_campaign' not in params or
params['create_sms_campaign'] is None):
raise ValueError("Missing the required parameter `create_sms_campaign` when calling `create_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_sms_campaign' in params:
body_params = params['create_sms_campaign']
# 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(
'/smsCampaigns', '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, create_sms_campaign, **kwargs)
|
59,923 |
sib_api_v3_sdk.api.sms_campaigns_api
|
delete_sms_campaign
|
Delete an SMS campaign # 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_sms_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_sms_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Delete an SMS campaign # 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_sms_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (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_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.delete_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
59,924 |
sib_api_v3_sdk.api.sms_campaigns_api
|
delete_sms_campaign_with_http_info
|
Delete an SMS campaign # 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_sms_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Delete an SMS campaign # 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_sms_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `delete_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_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(
'/smsCampaigns/{campaignId}', '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, campaign_id, **kwargs)
|
59,925 |
sib_api_v3_sdk.api.sms_campaigns_api
|
get_sms_campaign
|
Get an SMS campaign # noqa: 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_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: GetSmsCampaign
If the method is called asynchronously,
returns the request thread.
|
def get_sms_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Get an SMS campaign # noqa: 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_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: GetSmsCampaign
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_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
59,926 |
sib_api_v3_sdk.api.sms_campaigns_api
|
get_sms_campaign_with_http_info
|
Get an SMS campaign # noqa: 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_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: GetSmsCampaign
If the method is called asynchronously,
returns the request thread.
|
def get_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get an SMS campaign # noqa: 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_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:return: GetSmsCampaign
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `get_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_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(
'/smsCampaigns/{campaignId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmsCampaign', # 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, campaign_id, **kwargs)
|
59,927 |
sib_api_v3_sdk.api.sms_campaigns_api
|
get_sms_campaigns
|
Returns the information for all your created SMS campaigns # noqa: 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_campaigns(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str status: Status of campaign.
:param str start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsCampaigns
If the method is called asynchronously,
returns the request thread.
|
def get_sms_campaigns(self, **kwargs): # noqa: E501
"""Returns the information for all your created SMS campaigns # noqa: 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_campaigns(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str status: Status of campaign.
:param str start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsCampaigns
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_campaigns_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_sms_campaigns_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
59,928 |
sib_api_v3_sdk.api.sms_campaigns_api
|
get_sms_campaigns_with_http_info
|
Returns the information for all your created SMS campaigns # noqa: 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_campaigns_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str status: Status of campaign.
:param str start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsCampaigns
If the method is called asynchronously,
returns the request thread.
|
def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501
"""Returns the information for all your created SMS campaigns # noqa: 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_campaigns_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str status: Status of campaign.
:param str start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param str end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetSmsCampaigns
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['status', 'start_date', 'end_date', '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_sms_campaigns" % 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_sms_campaigns`, 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_sms_campaigns`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'status' in params:
query_params.append(('status', params['status'])) # 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 '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(
'/smsCampaigns', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetSmsCampaigns', # 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)
|
59,929 |
sib_api_v3_sdk.api.sms_campaigns_api
|
request_sms_recipient_export
|
Export an SMS campaign's recipients # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.request_sms_recipient_export(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param RequestSmsRecipientExport recipient_export: Values to send for a recipient export request
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
|
def request_sms_recipient_export(self, campaign_id, **kwargs): # noqa: E501
"""Export an SMS campaign's recipients # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.request_sms_recipient_export(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param RequestSmsRecipientExport recipient_export: Values to send for a recipient export request
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.request_sms_recipient_export_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.request_sms_recipient_export_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
59,930 |
sib_api_v3_sdk.api.sms_campaigns_api
|
request_sms_recipient_export_with_http_info
|
Export an SMS campaign's recipients # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.request_sms_recipient_export_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param RequestSmsRecipientExport recipient_export: Values to send for a recipient export request
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
|
def request_sms_recipient_export_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Export an SMS campaign's recipients # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.request_sms_recipient_export_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param RequestSmsRecipientExport recipient_export: Values to send for a recipient export request
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'recipient_export'] # 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 request_sms_recipient_export" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `request_sms_recipient_export`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'recipient_export' in params:
body_params = params['recipient_export']
# 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(
'/smsCampaigns/{campaignId}/exportRecipients', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CreatedProcessId', # 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, campaign_id, **kwargs)
|
59,931 |
sib_api_v3_sdk.api.sms_campaigns_api
|
send_sms_campaign_now
|
Send your SMS campaign immediately # 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_sms_campaign_now(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_sms_campaign_now(self, campaign_id, **kwargs): # noqa: E501
"""Send your SMS campaign immediately # 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_sms_campaign_now(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (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_sms_campaign_now_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.send_sms_campaign_now_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
59,932 |
sib_api_v3_sdk.api.sms_campaigns_api
|
send_sms_campaign_now_with_http_info
|
Send your SMS campaign immediately # 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_sms_campaign_now_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_sms_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Send your SMS campaign immediately # 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_sms_campaign_now_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_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 send_sms_campaign_now" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `send_sms_campaign_now`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_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(
'/smsCampaigns/{campaignId}/sendNow', '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, campaign_id, **kwargs)
|
59,933 |
sib_api_v3_sdk.api.sms_campaigns_api
|
send_sms_report
|
Send an SMS campaign's report # noqa: E501
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # 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_sms_report(campaign_id, send_report, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param SendReport send_report: Values for send a report (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_sms_report(self, campaign_id, send_report, **kwargs): # noqa: E501
"""Send an SMS campaign's report # noqa: E501
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # 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_sms_report(campaign_id, send_report, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param SendReport send_report: Values for send a report (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_sms_report_with_http_info(campaign_id, send_report, **kwargs) # noqa: E501
else:
(data) = self.send_sms_report_with_http_info(campaign_id, send_report, **kwargs) # noqa: E501
return data
|
(self, campaign_id, send_report, **kwargs)
|
59,934 |
sib_api_v3_sdk.api.sms_campaigns_api
|
send_sms_report_with_http_info
|
Send an SMS campaign's report # noqa: E501
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # 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_sms_report_with_http_info(campaign_id, send_report, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param SendReport send_report: Values for send a report (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_sms_report_with_http_info(self, campaign_id, send_report, **kwargs): # noqa: E501
"""Send an SMS campaign's report # noqa: E501
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. # 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_sms_report_with_http_info(campaign_id, send_report, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param SendReport send_report: Values for send a report (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'send_report'] # 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_sms_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `send_sms_report`") # noqa: E501
# verify the required parameter 'send_report' is set
if ('send_report' not in params or
params['send_report'] is None):
raise ValueError("Missing the required parameter `send_report` when calling `send_sms_report`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'send_report' in params:
body_params = params['send_report']
# 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(
'/smsCampaigns/{campaignId}/sendReport', '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, campaign_id, send_report, **kwargs)
|
59,935 |
sib_api_v3_sdk.api.sms_campaigns_api
|
send_test_sms
|
Send a test SMS campaign # 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_sms(campaign_id, phone_number, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: Id of the SMS campaign (required)
:param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_test_sms(self, campaign_id, phone_number, **kwargs): # noqa: E501
"""Send a test SMS campaign # 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_sms(campaign_id, phone_number, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: Id of the SMS campaign (required)
:param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (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_sms_with_http_info(campaign_id, phone_number, **kwargs) # noqa: E501
else:
(data) = self.send_test_sms_with_http_info(campaign_id, phone_number, **kwargs) # noqa: E501
return data
|
(self, campaign_id, phone_number, **kwargs)
|
59,936 |
sib_api_v3_sdk.api.sms_campaigns_api
|
send_test_sms_with_http_info
|
Send a test SMS campaign # 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_sms_with_http_info(campaign_id, phone_number, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: Id of the SMS campaign (required)
:param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def send_test_sms_with_http_info(self, campaign_id, phone_number, **kwargs): # noqa: E501
"""Send a test SMS campaign # 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_sms_with_http_info(campaign_id, phone_number, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: Id of the SMS campaign (required)
:param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'phone_number'] # 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_sms" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `send_test_sms`") # noqa: E501
# verify the required parameter 'phone_number' is set
if ('phone_number' not in params or
params['phone_number'] is None):
raise ValueError("Missing the required parameter `phone_number` when calling `send_test_sms`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'phone_number' in params:
body_params = params['phone_number']
# 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(
'/smsCampaigns/{campaignId}/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, campaign_id, phone_number, **kwargs)
|
59,937 |
sib_api_v3_sdk.api.sms_campaigns_api
|
update_sms_campaign
|
Update an SMS campaign # 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_sms_campaign(campaign_id, update_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:param UpdateSmsCampaign update_sms_campaign: Values to update an SMS Campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_sms_campaign(self, campaign_id, update_sms_campaign, **kwargs): # noqa: E501
"""Update an SMS campaign # 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_sms_campaign(campaign_id, update_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:param UpdateSmsCampaign update_sms_campaign: Values to update an SMS Campaign (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_sms_campaign_with_http_info(campaign_id, update_sms_campaign, **kwargs) # noqa: E501
else:
(data) = self.update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, **kwargs) # noqa: E501
return data
|
(self, campaign_id, update_sms_campaign, **kwargs)
|
59,938 |
sib_api_v3_sdk.api.sms_campaigns_api
|
update_sms_campaign_status
|
Update a campaign's status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_sms_campaign_status(campaign_id, status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param UpdateCampaignStatus status: Status of the campaign. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_sms_campaign_status(self, campaign_id, status, **kwargs): # noqa: E501
"""Update a campaign's status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_sms_campaign_status(campaign_id, status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param UpdateCampaignStatus status: Status of the campaign. (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_sms_campaign_status_with_http_info(campaign_id, status, **kwargs) # noqa: E501
else:
(data) = self.update_sms_campaign_status_with_http_info(campaign_id, status, **kwargs) # noqa: E501
return data
|
(self, campaign_id, status, **kwargs)
|
59,939 |
sib_api_v3_sdk.api.sms_campaigns_api
|
update_sms_campaign_status_with_http_info
|
Update a campaign's status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_sms_campaign_status_with_http_info(campaign_id, status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param UpdateCampaignStatus status: Status of the campaign. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_sms_campaign_status_with_http_info(self, campaign_id, status, **kwargs): # noqa: E501
"""Update a campaign's status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_sms_campaign_status_with_http_info(campaign_id, status, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the campaign (required)
:param UpdateCampaignStatus status: Status of the campaign. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'status'] # 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_sms_campaign_status" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `update_sms_campaign_status`") # noqa: E501
# verify the required parameter 'status' is set
if ('status' not in params or
params['status'] is None):
raise ValueError("Missing the required parameter `status` when calling `update_sms_campaign_status`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'status' in params:
body_params = params['status']
# 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(
'/smsCampaigns/{campaignId}/status', '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, campaign_id, status, **kwargs)
|
59,940 |
sib_api_v3_sdk.api.sms_campaigns_api
|
update_sms_campaign_with_http_info
|
Update an SMS campaign # 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_sms_campaign_with_http_info(campaign_id, update_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:param UpdateSmsCampaign update_sms_campaign: Values to update an SMS Campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_sms_campaign_with_http_info(self, campaign_id, update_sms_campaign, **kwargs): # noqa: E501
"""Update an SMS campaign # 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_sms_campaign_with_http_info(campaign_id, update_sms_campaign, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int campaign_id: id of the SMS campaign (required)
:param UpdateSmsCampaign update_sms_campaign: Values to update an SMS Campaign (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'update_sms_campaign'] # 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_sms_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `update_sms_campaign`") # noqa: E501
# verify the required parameter 'update_sms_campaign' is set
if ('update_sms_campaign' not in params or
params['update_sms_campaign'] is None):
raise ValueError("Missing the required parameter `update_sms_campaign` when calling `update_sms_campaign`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaignId'] = params['campaign_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_sms_campaign' in params:
body_params = params['update_sms_campaign']
# 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(
'/smsCampaigns/{campaignId}', '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, campaign_id, update_sms_campaign, **kwargs)
|
59,941 |
sib_api_v3_sdk.models.schedule_smtp_email
|
ScheduleSmtpEmail
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class ScheduleSmtpEmail(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 = {
'message_id': 'str',
'message_ids': 'list[str]',
'batch_id': 'str'
}
attribute_map = {
'message_id': 'messageId',
'message_ids': 'messageIds',
'batch_id': 'batchId'
}
def __init__(self, message_id=None, message_ids=None, batch_id=None): # noqa: E501
"""ScheduleSmtpEmail - a model defined in Swagger""" # noqa: E501
self._message_id = None
self._message_ids = None
self._batch_id = None
self.discriminator = None
if message_id is not None:
self.message_id = message_id
if message_ids is not None:
self.message_ids = message_ids
if batch_id is not None:
self.batch_id = batch_id
@property
def message_id(self):
"""Gets the message_id of this ScheduleSmtpEmail. # noqa: E501
Message ID of the transactional email scheduled # noqa: E501
:return: The message_id of this ScheduleSmtpEmail. # noqa: E501
:rtype: str
"""
return self._message_id
@message_id.setter
def message_id(self, message_id):
"""Sets the message_id of this ScheduleSmtpEmail.
Message ID of the transactional email scheduled # noqa: E501
:param message_id: The message_id of this ScheduleSmtpEmail. # noqa: E501
:type: str
"""
self._message_id = message_id
@property
def message_ids(self):
"""Gets the message_ids of this ScheduleSmtpEmail. # noqa: E501
:return: The message_ids of this ScheduleSmtpEmail. # noqa: E501
:rtype: list[str]
"""
return self._message_ids
@message_ids.setter
def message_ids(self, message_ids):
"""Sets the message_ids of this ScheduleSmtpEmail.
:param message_ids: The message_ids of this ScheduleSmtpEmail. # noqa: E501
:type: list[str]
"""
self._message_ids = message_ids
@property
def batch_id(self):
"""Gets the batch_id of this ScheduleSmtpEmail. # noqa: E501
Batch ID of the batch transactional email scheduled # noqa: E501
:return: The batch_id of this ScheduleSmtpEmail. # noqa: E501
:rtype: str
"""
return self._batch_id
@batch_id.setter
def batch_id(self, batch_id):
"""Sets the batch_id of this ScheduleSmtpEmail.
Batch ID of the batch transactional email scheduled # noqa: E501
:param batch_id: The batch_id of this ScheduleSmtpEmail. # noqa: E501
:type: str
"""
self._batch_id = batch_id
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(ScheduleSmtpEmail, 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, ScheduleSmtpEmail):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(message_id=None, message_ids=None, batch_id=None)
|
59,942 |
sib_api_v3_sdk.models.schedule_smtp_email
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, ScheduleSmtpEmail):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,943 |
sib_api_v3_sdk.models.schedule_smtp_email
|
__init__
|
ScheduleSmtpEmail - a model defined in Swagger
|
def __init__(self, message_id=None, message_ids=None, batch_id=None): # noqa: E501
"""ScheduleSmtpEmail - a model defined in Swagger""" # noqa: E501
self._message_id = None
self._message_ids = None
self._batch_id = None
self.discriminator = None
if message_id is not None:
self.message_id = message_id
if message_ids is not None:
self.message_ids = message_ids
if batch_id is not None:
self.batch_id = batch_id
|
(self, message_id=None, message_ids=None, batch_id=None)
|
59,946 |
sib_api_v3_sdk.models.schedule_smtp_email
|
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(ScheduleSmtpEmail, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,948 |
sib_api_v3_sdk.models.send_report
|
SendReport
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendReport(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 = {
'language': 'str',
'email': 'SendReportEmail'
}
attribute_map = {
'language': 'language',
'email': 'email'
}
def __init__(self, language='fr', email=None): # noqa: E501
"""SendReport - a model defined in Swagger""" # noqa: E501
self._language = None
self._email = None
self.discriminator = None
if language is not None:
self.language = language
self.email = email
@property
def language(self):
"""Gets the language of this SendReport. # noqa: E501
Language of email content for campaign report sending. # noqa: E501
:return: The language of this SendReport. # noqa: E501
:rtype: str
"""
return self._language
@language.setter
def language(self, language):
"""Sets the language of this SendReport.
Language of email content for campaign report sending. # noqa: E501
:param language: The language of this SendReport. # noqa: E501
:type: str
"""
allowed_values = ["fr", "es", "pt", "it", "de", "en"] # noqa: E501
if language not in allowed_values:
raise ValueError(
"Invalid value for `language` ({0}), must be one of {1}" # noqa: E501
.format(language, allowed_values)
)
self._language = language
@property
def email(self):
"""Gets the email of this SendReport. # noqa: E501
:return: The email of this SendReport. # noqa: E501
:rtype: SendReportEmail
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendReport.
:param email: The email of this SendReport. # noqa: E501
:type: SendReportEmail
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
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(SendReport, 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, SendReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(language='fr', email=None)
|
59,949 |
sib_api_v3_sdk.models.send_report
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendReport):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,950 |
sib_api_v3_sdk.models.send_report
|
__init__
|
SendReport - a model defined in Swagger
|
def __init__(self, language='fr', email=None): # noqa: E501
"""SendReport - a model defined in Swagger""" # noqa: E501
self._language = None
self._email = None
self.discriminator = None
if language is not None:
self.language = language
self.email = email
|
(self, language='fr', email=None)
|
59,953 |
sib_api_v3_sdk.models.send_report
|
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(SendReport, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,955 |
sib_api_v3_sdk.models.send_report_email
|
SendReportEmail
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendReportEmail(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 = {
'to': 'list[str]',
'body': 'str'
}
attribute_map = {
'to': 'to',
'body': 'body'
}
def __init__(self, to=None, body=None): # noqa: E501
"""SendReportEmail - a model defined in Swagger""" # noqa: E501
self._to = None
self._body = None
self.discriminator = None
self.to = to
self.body = body
@property
def to(self):
"""Gets the to of this SendReportEmail. # noqa: E501
Email addresses of the recipients # noqa: E501
:return: The to of this SendReportEmail. # noqa: E501
:rtype: list[str]
"""
return self._to
@to.setter
def to(self, to):
"""Sets the to of this SendReportEmail.
Email addresses of the recipients # noqa: E501
:param to: The to of this SendReportEmail. # noqa: E501
:type: list[str]
"""
if to is None:
raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501
self._to = to
@property
def body(self):
"""Gets the body of this SendReportEmail. # noqa: E501
Custom text message to be presented in the report email. # noqa: E501
:return: The body of this SendReportEmail. # noqa: E501
:rtype: str
"""
return self._body
@body.setter
def body(self, body):
"""Sets the body of this SendReportEmail.
Custom text message to be presented in the report email. # noqa: E501
:param body: The body of this SendReportEmail. # noqa: E501
:type: str
"""
if body is None:
raise ValueError("Invalid value for `body`, must not be `None`") # noqa: E501
self._body = body
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(SendReportEmail, 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, SendReportEmail):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(to=None, body=None)
|
59,956 |
sib_api_v3_sdk.models.send_report_email
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendReportEmail):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,957 |
sib_api_v3_sdk.models.send_report_email
|
__init__
|
SendReportEmail - a model defined in Swagger
|
def __init__(self, to=None, body=None): # noqa: E501
"""SendReportEmail - a model defined in Swagger""" # noqa: E501
self._to = None
self._body = None
self.discriminator = None
self.to = to
self.body = body
|
(self, to=None, body=None)
|
59,960 |
sib_api_v3_sdk.models.send_report_email
|
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(SendReportEmail, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,962 |
sib_api_v3_sdk.models.send_sms
|
SendSms
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSms(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 = {
'reference': 'str',
'message_id': 'int',
'sms_count': 'int',
'used_credits': 'float',
'remaining_credits': 'float'
}
attribute_map = {
'reference': 'reference',
'message_id': 'messageId',
'sms_count': 'smsCount',
'used_credits': 'usedCredits',
'remaining_credits': 'remainingCredits'
}
def __init__(self, reference=None, message_id=None, sms_count=None, used_credits=None, remaining_credits=None): # noqa: E501
"""SendSms - a model defined in Swagger""" # noqa: E501
self._reference = None
self._message_id = None
self._sms_count = None
self._used_credits = None
self._remaining_credits = None
self.discriminator = None
self.reference = reference
self.message_id = message_id
if sms_count is not None:
self.sms_count = sms_count
if used_credits is not None:
self.used_credits = used_credits
if remaining_credits is not None:
self.remaining_credits = remaining_credits
@property
def reference(self):
"""Gets the reference of this SendSms. # noqa: E501
:return: The reference of this SendSms. # noqa: E501
:rtype: str
"""
return self._reference
@reference.setter
def reference(self, reference):
"""Sets the reference of this SendSms.
:param reference: The reference of this SendSms. # noqa: E501
:type: str
"""
if reference is None:
raise ValueError("Invalid value for `reference`, must not be `None`") # noqa: E501
self._reference = reference
@property
def message_id(self):
"""Gets the message_id of this SendSms. # noqa: E501
:return: The message_id of this SendSms. # noqa: E501
:rtype: int
"""
return self._message_id
@message_id.setter
def message_id(self, message_id):
"""Sets the message_id of this SendSms.
:param message_id: The message_id of this SendSms. # noqa: E501
:type: int
"""
if message_id is None:
raise ValueError("Invalid value for `message_id`, must not be `None`") # noqa: E501
self._message_id = message_id
@property
def sms_count(self):
"""Gets the sms_count of this SendSms. # noqa: E501
Count of SMS's to send multiple text messages # noqa: E501
:return: The sms_count of this SendSms. # noqa: E501
:rtype: int
"""
return self._sms_count
@sms_count.setter
def sms_count(self, sms_count):
"""Sets the sms_count of this SendSms.
Count of SMS's to send multiple text messages # noqa: E501
:param sms_count: The sms_count of this SendSms. # noqa: E501
:type: int
"""
self._sms_count = sms_count
@property
def used_credits(self):
"""Gets the used_credits of this SendSms. # noqa: E501
SMS credits used per text message # noqa: E501
:return: The used_credits of this SendSms. # noqa: E501
:rtype: float
"""
return self._used_credits
@used_credits.setter
def used_credits(self, used_credits):
"""Sets the used_credits of this SendSms.
SMS credits used per text message # noqa: E501
:param used_credits: The used_credits of this SendSms. # noqa: E501
:type: float
"""
self._used_credits = used_credits
@property
def remaining_credits(self):
"""Gets the remaining_credits of this SendSms. # noqa: E501
Remaining SMS credits of the user # noqa: E501
:return: The remaining_credits of this SendSms. # noqa: E501
:rtype: float
"""
return self._remaining_credits
@remaining_credits.setter
def remaining_credits(self, remaining_credits):
"""Sets the remaining_credits of this SendSms.
Remaining SMS credits of the user # noqa: E501
:param remaining_credits: The remaining_credits of this SendSms. # noqa: E501
:type: float
"""
self._remaining_credits = remaining_credits
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(SendSms, 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, SendSms):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(reference=None, message_id=None, sms_count=None, used_credits=None, remaining_credits=None)
|
59,963 |
sib_api_v3_sdk.models.send_sms
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSms):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,964 |
sib_api_v3_sdk.models.send_sms
|
__init__
|
SendSms - a model defined in Swagger
|
def __init__(self, reference=None, message_id=None, sms_count=None, used_credits=None, remaining_credits=None): # noqa: E501
"""SendSms - a model defined in Swagger""" # noqa: E501
self._reference = None
self._message_id = None
self._sms_count = None
self._used_credits = None
self._remaining_credits = None
self.discriminator = None
self.reference = reference
self.message_id = message_id
if sms_count is not None:
self.sms_count = sms_count
if used_credits is not None:
self.used_credits = used_credits
if remaining_credits is not None:
self.remaining_credits = remaining_credits
|
(self, reference=None, message_id=None, sms_count=None, used_credits=None, remaining_credits=None)
|
59,967 |
sib_api_v3_sdk.models.send_sms
|
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(SendSms, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,969 |
sib_api_v3_sdk.models.send_smtp_email
|
SendSmtpEmail
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmail(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 = {
'sender': 'SendSmtpEmailSender',
'to': 'list[SendSmtpEmailTo]',
'bcc': 'list[SendSmtpEmailBcc]',
'cc': 'list[SendSmtpEmailCc]',
'html_content': 'str',
'text_content': 'str',
'subject': 'str',
'reply_to': 'SendSmtpEmailReplyTo',
'attachment': 'list[SendSmtpEmailAttachment]',
'headers': 'object',
'template_id': 'int',
'params': 'object',
'message_versions': 'list[SendSmtpEmailMessageVersions]',
'tags': 'list[str]',
'scheduled_at': 'datetime',
'batch_id': 'str'
}
attribute_map = {
'sender': 'sender',
'to': 'to',
'bcc': 'bcc',
'cc': 'cc',
'html_content': 'htmlContent',
'text_content': 'textContent',
'subject': 'subject',
'reply_to': 'replyTo',
'attachment': 'attachment',
'headers': 'headers',
'template_id': 'templateId',
'params': 'params',
'message_versions': 'messageVersions',
'tags': 'tags',
'scheduled_at': 'scheduledAt',
'batch_id': 'batchId'
}
def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None, scheduled_at=None, batch_id=None): # noqa: E501
"""SendSmtpEmail - a model defined in Swagger""" # noqa: E501
self._sender = None
self._to = None
self._bcc = None
self._cc = None
self._html_content = None
self._text_content = None
self._subject = None
self._reply_to = None
self._attachment = None
self._headers = None
self._template_id = None
self._params = None
self._message_versions = None
self._tags = None
self._scheduled_at = None
self._batch_id = None
self.discriminator = None
if sender is not None:
self.sender = sender
if to is not None:
self.to = to
if bcc is not None:
self.bcc = bcc
if cc is not None:
self.cc = cc
if html_content is not None:
self.html_content = html_content
if text_content is not None:
self.text_content = text_content
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if attachment is not None:
self.attachment = attachment
if headers is not None:
self.headers = headers
if template_id is not None:
self.template_id = template_id
if params is not None:
self.params = params
if message_versions is not None:
self.message_versions = message_versions
if tags is not None:
self.tags = tags
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if batch_id is not None:
self.batch_id = batch_id
@property
def sender(self):
"""Gets the sender of this SendSmtpEmail. # noqa: E501
:return: The sender of this SendSmtpEmail. # noqa: E501
:rtype: SendSmtpEmailSender
"""
return self._sender
@sender.setter
def sender(self, sender):
"""Sets the sender of this SendSmtpEmail.
:param sender: The sender of this SendSmtpEmail. # noqa: E501
:type: SendSmtpEmailSender
"""
self._sender = sender
@property
def to(self):
"""Gets the to of this SendSmtpEmail. # noqa: E501
Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"[email protected]\"}, {\"name\":\"Joe\", \"email\":\"[email protected]\"}] # noqa: E501
:return: The to of this SendSmtpEmail. # noqa: E501
:rtype: list[SendSmtpEmailTo]
"""
return self._to
@to.setter
def to(self, to):
"""Sets the to of this SendSmtpEmail.
Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"[email protected]\"}, {\"name\":\"Joe\", \"email\":\"[email protected]\"}] # noqa: E501
:param to: The to of this SendSmtpEmail. # noqa: E501
:type: list[SendSmtpEmailTo]
"""
self._to = to
@property
def bcc(self):
"""Gets the bcc of this SendSmtpEmail. # noqa: E501
List of email addresses and names (optional) of the recipients in bcc # noqa: E501
:return: The bcc of this SendSmtpEmail. # noqa: E501
:rtype: list[SendSmtpEmailBcc]
"""
return self._bcc
@bcc.setter
def bcc(self, bcc):
"""Sets the bcc of this SendSmtpEmail.
List of email addresses and names (optional) of the recipients in bcc # noqa: E501
:param bcc: The bcc of this SendSmtpEmail. # noqa: E501
:type: list[SendSmtpEmailBcc]
"""
self._bcc = bcc
@property
def cc(self):
"""Gets the cc of this SendSmtpEmail. # noqa: E501
List of email addresses and names (optional) of the recipients in cc # noqa: E501
:return: The cc of this SendSmtpEmail. # noqa: E501
:rtype: list[SendSmtpEmailCc]
"""
return self._cc
@cc.setter
def cc(self, cc):
"""Sets the cc of this SendSmtpEmail.
List of email addresses and names (optional) of the recipients in cc # noqa: E501
:param cc: The cc of this SendSmtpEmail. # noqa: E501
:type: list[SendSmtpEmailCc]
"""
self._cc = cc
@property
def html_content(self):
"""Gets the html_content of this SendSmtpEmail. # noqa: E501
HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) # noqa: E501
:return: The html_content of this SendSmtpEmail. # noqa: E501
:rtype: str
"""
return self._html_content
@html_content.setter
def html_content(self, html_content):
"""Sets the html_content of this SendSmtpEmail.
HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) # noqa: E501
:param html_content: The html_content of this SendSmtpEmail. # noqa: E501
:type: str
"""
self._html_content = html_content
@property
def text_content(self):
"""Gets the text_content of this SendSmtpEmail. # noqa: E501
Plain Text body of the message ( Ignored if 'templateId' is passed ) # noqa: E501
:return: The text_content of this SendSmtpEmail. # noqa: E501
:rtype: str
"""
return self._text_content
@text_content.setter
def text_content(self, text_content):
"""Sets the text_content of this SendSmtpEmail.
Plain Text body of the message ( Ignored if 'templateId' is passed ) # noqa: E501
:param text_content: The text_content of this SendSmtpEmail. # noqa: E501
:type: str
"""
self._text_content = text_content
@property
def subject(self):
"""Gets the subject of this SendSmtpEmail. # noqa: E501
Subject of the message. Mandatory if 'templateId' is not passed # noqa: E501
:return: The subject of this SendSmtpEmail. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this SendSmtpEmail.
Subject of the message. Mandatory if 'templateId' is not passed # noqa: E501
:param subject: The subject of this SendSmtpEmail. # noqa: E501
:type: str
"""
self._subject = subject
@property
def reply_to(self):
"""Gets the reply_to of this SendSmtpEmail. # noqa: E501
:return: The reply_to of this SendSmtpEmail. # noqa: E501
:rtype: SendSmtpEmailReplyTo
"""
return self._reply_to
@reply_to.setter
def reply_to(self, reply_to):
"""Sets the reply_to of this SendSmtpEmail.
:param reply_to: The reply_to of this SendSmtpEmail. # noqa: E501
:type: SendSmtpEmailReplyTo
"""
self._reply_to = reply_to
@property
def attachment(self):
"""Gets the attachment of this SendSmtpEmail. # noqa: E501
Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) # noqa: E501
:return: The attachment of this SendSmtpEmail. # noqa: E501
:rtype: list[SendSmtpEmailAttachment]
"""
return self._attachment
@attachment.setter
def attachment(self, attachment):
"""Sets the attachment of this SendSmtpEmail.
Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) # noqa: E501
:param attachment: The attachment of this SendSmtpEmail. # noqa: E501
:type: list[SendSmtpEmailAttachment]
"""
self._attachment = attachment
@property
def headers(self):
"""Gets the headers of this SendSmtpEmail. # noqa: E501
Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. # noqa: E501
:return: The headers of this SendSmtpEmail. # noqa: E501
:rtype: object
"""
return self._headers
@headers.setter
def headers(self, headers):
"""Sets the headers of this SendSmtpEmail.
Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. # noqa: E501
:param headers: The headers of this SendSmtpEmail. # noqa: E501
:type: object
"""
self._headers = headers
@property
def template_id(self):
"""Gets the template_id of this SendSmtpEmail. # noqa: E501
Id of the template. # noqa: E501
:return: The template_id of this SendSmtpEmail. # noqa: E501
:rtype: int
"""
return self._template_id
@template_id.setter
def template_id(self, template_id):
"""Sets the template_id of this SendSmtpEmail.
Id of the template. # noqa: E501
:param template_id: The template_id of this SendSmtpEmail. # noqa: E501
:type: int
"""
self._template_id = template_id
@property
def params(self):
"""Gets the params of this SendSmtpEmail. # noqa: E501
Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. # noqa: E501
:return: The params of this SendSmtpEmail. # noqa: E501
:rtype: object
"""
return self._params
@params.setter
def params(self, params):
"""Sets the params of this SendSmtpEmail.
Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. # noqa: E501
:param params: The params of this SendSmtpEmail. # noqa: E501
:type: object
"""
self._params = params
@property
def message_versions(self):
"""Gets the message_versions of this SendSmtpEmail. # noqa: E501
You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails # noqa: E501
:return: The message_versions of this SendSmtpEmail. # noqa: E501
:rtype: list[SendSmtpEmailMessageVersions]
"""
return self._message_versions
@message_versions.setter
def message_versions(self, message_versions):
"""Sets the message_versions of this SendSmtpEmail.
You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails # noqa: E501
:param message_versions: The message_versions of this SendSmtpEmail. # noqa: E501
:type: list[SendSmtpEmailMessageVersions]
"""
self._message_versions = message_versions
@property
def tags(self):
"""Gets the tags of this SendSmtpEmail. # noqa: E501
Tag your emails to find them more easily # noqa: E501
:return: The tags of this SendSmtpEmail. # noqa: E501
:rtype: list[str]
"""
return self._tags
@tags.setter
def tags(self, tags):
"""Sets the tags of this SendSmtpEmail.
Tag your emails to find them more easily # noqa: E501
:param tags: The tags of this SendSmtpEmail. # noqa: E501
:type: list[str]
"""
self._tags = tags
@property
def scheduled_at(self):
"""Gets the scheduled_at of this SendSmtpEmail. # noqa: E501
UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. # noqa: E501
:return: The scheduled_at of this SendSmtpEmail. # noqa: E501
:rtype: datetime
"""
return self._scheduled_at
@scheduled_at.setter
def scheduled_at(self, scheduled_at):
"""Sets the scheduled_at of this SendSmtpEmail.
UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. # noqa: E501
:param scheduled_at: The scheduled_at of this SendSmtpEmail. # noqa: E501
:type: datetime
"""
self._scheduled_at = scheduled_at
@property
def batch_id(self):
"""Gets the batch_id of this SendSmtpEmail. # noqa: E501
Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. # noqa: E501
:return: The batch_id of this SendSmtpEmail. # noqa: E501
:rtype: str
"""
return self._batch_id
@batch_id.setter
def batch_id(self, batch_id):
"""Sets the batch_id of this SendSmtpEmail.
Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. # noqa: E501
:param batch_id: The batch_id of this SendSmtpEmail. # noqa: E501
:type: str
"""
self._batch_id = batch_id
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(SendSmtpEmail, 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, SendSmtpEmail):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None, scheduled_at=None, batch_id=None)
|
59,970 |
sib_api_v3_sdk.models.send_smtp_email
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmail):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,971 |
sib_api_v3_sdk.models.send_smtp_email
|
__init__
|
SendSmtpEmail - a model defined in Swagger
|
def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None, scheduled_at=None, batch_id=None): # noqa: E501
"""SendSmtpEmail - a model defined in Swagger""" # noqa: E501
self._sender = None
self._to = None
self._bcc = None
self._cc = None
self._html_content = None
self._text_content = None
self._subject = None
self._reply_to = None
self._attachment = None
self._headers = None
self._template_id = None
self._params = None
self._message_versions = None
self._tags = None
self._scheduled_at = None
self._batch_id = None
self.discriminator = None
if sender is not None:
self.sender = sender
if to is not None:
self.to = to
if bcc is not None:
self.bcc = bcc
if cc is not None:
self.cc = cc
if html_content is not None:
self.html_content = html_content
if text_content is not None:
self.text_content = text_content
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if attachment is not None:
self.attachment = attachment
if headers is not None:
self.headers = headers
if template_id is not None:
self.template_id = template_id
if params is not None:
self.params = params
if message_versions is not None:
self.message_versions = message_versions
if tags is not None:
self.tags = tags
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if batch_id is not None:
self.batch_id = batch_id
|
(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None, scheduled_at=None, batch_id=None)
|
59,974 |
sib_api_v3_sdk.models.send_smtp_email
|
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(SendSmtpEmail, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,976 |
sib_api_v3_sdk.models.send_smtp_email_attachment
|
SendSmtpEmailAttachment
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailAttachment(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 = {
'url': 'str',
'content': 'str',
'name': 'str'
}
attribute_map = {
'url': 'url',
'content': 'content',
'name': 'name'
}
def __init__(self, url=None, content=None, name=None): # noqa: E501
"""SendSmtpEmailAttachment - a model defined in Swagger""" # noqa: E501
self._url = None
self._content = None
self._name = None
self.discriminator = None
if url is not None:
self.url = url
if content is not None:
self.content = content
if name is not None:
self.name = name
@property
def url(self):
"""Gets the url of this SendSmtpEmailAttachment. # noqa: E501
Absolute url of the attachment (no local file). # noqa: E501
:return: The url of this SendSmtpEmailAttachment. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this SendSmtpEmailAttachment.
Absolute url of the attachment (no local file). # noqa: E501
:param url: The url of this SendSmtpEmailAttachment. # noqa: E501
:type: str
"""
self._url = url
@property
def content(self):
"""Gets the content of this SendSmtpEmailAttachment. # noqa: E501
Base64 encoded chunk data of the attachment generated on the fly # noqa: E501
:return: The content of this SendSmtpEmailAttachment. # noqa: E501
:rtype: str
"""
return self._content
@content.setter
def content(self, content):
"""Sets the content of this SendSmtpEmailAttachment.
Base64 encoded chunk data of the attachment generated on the fly # noqa: E501
:param content: The content of this SendSmtpEmailAttachment. # noqa: E501
:type: str
"""
if content is not None and not re.search(r'^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$', content): # noqa: E501
raise ValueError(r"Invalid value for `content`, must be a follow pattern or equal to `/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/`") # noqa: E501
self._content = content
@property
def name(self):
"""Gets the name of this SendSmtpEmailAttachment. # noqa: E501
Required if content is passed. Name of the attachment # noqa: E501
:return: The name of this SendSmtpEmailAttachment. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailAttachment.
Required if content is passed. Name of the attachment # noqa: E501
:param name: The name of this SendSmtpEmailAttachment. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailAttachment, 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, SendSmtpEmailAttachment):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(url=None, content=None, name=None)
|
59,977 |
sib_api_v3_sdk.models.send_smtp_email_attachment
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailAttachment):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,978 |
sib_api_v3_sdk.models.send_smtp_email_attachment
|
__init__
|
SendSmtpEmailAttachment - a model defined in Swagger
|
def __init__(self, url=None, content=None, name=None): # noqa: E501
"""SendSmtpEmailAttachment - a model defined in Swagger""" # noqa: E501
self._url = None
self._content = None
self._name = None
self.discriminator = None
if url is not None:
self.url = url
if content is not None:
self.content = content
if name is not None:
self.name = name
|
(self, url=None, content=None, name=None)
|
59,981 |
sib_api_v3_sdk.models.send_smtp_email_attachment
|
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(SendSmtpEmailAttachment, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,983 |
sib_api_v3_sdk.models.send_smtp_email_bcc
|
SendSmtpEmailBcc
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailBcc(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',
'name': 'str'
}
attribute_map = {
'email': 'email',
'name': 'name'
}
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailBcc - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailBcc. # noqa: E501
Email address of the recipient in bcc # noqa: E501
:return: The email of this SendSmtpEmailBcc. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailBcc.
Email address of the recipient in bcc # noqa: E501
:param email: The email of this SendSmtpEmailBcc. # noqa: E501
:type: str
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
@property
def name(self):
"""Gets the name of this SendSmtpEmailBcc. # noqa: E501
Name of the recipient in bcc. Maximum allowed characters are 70. # noqa: E501
:return: The name of this SendSmtpEmailBcc. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailBcc.
Name of the recipient in bcc. Maximum allowed characters are 70. # noqa: E501
:param name: The name of this SendSmtpEmailBcc. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailBcc, 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, SendSmtpEmailBcc):
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, name=None)
|
59,984 |
sib_api_v3_sdk.models.send_smtp_email_bcc
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailBcc):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,985 |
sib_api_v3_sdk.models.send_smtp_email_bcc
|
__init__
|
SendSmtpEmailBcc - a model defined in Swagger
|
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailBcc - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
|
(self, email=None, name=None)
|
59,988 |
sib_api_v3_sdk.models.send_smtp_email_bcc
|
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(SendSmtpEmailBcc, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,990 |
sib_api_v3_sdk.models.send_smtp_email_cc
|
SendSmtpEmailCc
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailCc(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',
'name': 'str'
}
attribute_map = {
'email': 'email',
'name': 'name'
}
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailCc - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailCc. # noqa: E501
Email address of the recipient in cc # noqa: E501
:return: The email of this SendSmtpEmailCc. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailCc.
Email address of the recipient in cc # noqa: E501
:param email: The email of this SendSmtpEmailCc. # noqa: E501
:type: str
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
@property
def name(self):
"""Gets the name of this SendSmtpEmailCc. # noqa: E501
Name of the recipient in cc. Maximum allowed characters are 70. # noqa: E501
:return: The name of this SendSmtpEmailCc. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailCc.
Name of the recipient in cc. Maximum allowed characters are 70. # noqa: E501
:param name: The name of this SendSmtpEmailCc. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailCc, 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, SendSmtpEmailCc):
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, name=None)
|
59,991 |
sib_api_v3_sdk.models.send_smtp_email_cc
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailCc):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,992 |
sib_api_v3_sdk.models.send_smtp_email_cc
|
__init__
|
SendSmtpEmailCc - a model defined in Swagger
|
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailCc - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
|
(self, email=None, name=None)
|
59,995 |
sib_api_v3_sdk.models.send_smtp_email_cc
|
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(SendSmtpEmailCc, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
59,997 |
sib_api_v3_sdk.models.send_smtp_email_message_versions
|
SendSmtpEmailMessageVersions
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailMessageVersions(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 = {
'to': 'list[SendSmtpEmailTo1]',
'params': 'dict(str, object)',
'bcc': 'list[SendSmtpEmailBcc]',
'cc': 'list[SendSmtpEmailCc]',
'reply_to': 'SendSmtpEmailReplyTo1',
'subject': 'str'
}
attribute_map = {
'to': 'to',
'params': 'params',
'bcc': 'bcc',
'cc': 'cc',
'reply_to': 'replyTo',
'subject': 'subject'
}
def __init__(self, to=None, params=None, bcc=None, cc=None, reply_to=None, subject=None): # noqa: E501
"""SendSmtpEmailMessageVersions - a model defined in Swagger""" # noqa: E501
self._to = None
self._params = None
self._bcc = None
self._cc = None
self._reply_to = None
self._subject = None
self.discriminator = None
self.to = to
if params is not None:
self.params = params
if bcc is not None:
self.bcc = bcc
if cc is not None:
self.cc = cc
if reply_to is not None:
self.reply_to = reply_to
if subject is not None:
self.subject = subject
@property
def to(self):
"""Gets the to of this SendSmtpEmailMessageVersions. # noqa: E501
List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"[email protected]\"}, {\"name\":\"Joe\", \"email\":\"[email protected]\"}] # noqa: E501
:return: The to of this SendSmtpEmailMessageVersions. # noqa: E501
:rtype: list[SendSmtpEmailTo1]
"""
return self._to
@to.setter
def to(self, to):
"""Sets the to of this SendSmtpEmailMessageVersions.
List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"[email protected]\"}, {\"name\":\"Joe\", \"email\":\"[email protected]\"}] # noqa: E501
:param to: The to of this SendSmtpEmailMessageVersions. # noqa: E501
:type: list[SendSmtpEmailTo1]
"""
if to is None:
raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501
self._to = to
@property
def params(self):
"""Gets the params of this SendSmtpEmailMessageVersions. # noqa: E501
Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. # noqa: E501
:return: The params of this SendSmtpEmailMessageVersions. # noqa: E501
:rtype: dict(str, object)
"""
return self._params
@params.setter
def params(self, params):
"""Sets the params of this SendSmtpEmailMessageVersions.
Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. # noqa: E501
:param params: The params of this SendSmtpEmailMessageVersions. # noqa: E501
:type: dict(str, object)
"""
self._params = params
@property
def bcc(self):
"""Gets the bcc of this SendSmtpEmailMessageVersions. # noqa: E501
List of email addresses and names (optional) of the recipients in bcc # noqa: E501
:return: The bcc of this SendSmtpEmailMessageVersions. # noqa: E501
:rtype: list[SendSmtpEmailBcc]
"""
return self._bcc
@bcc.setter
def bcc(self, bcc):
"""Sets the bcc of this SendSmtpEmailMessageVersions.
List of email addresses and names (optional) of the recipients in bcc # noqa: E501
:param bcc: The bcc of this SendSmtpEmailMessageVersions. # noqa: E501
:type: list[SendSmtpEmailBcc]
"""
self._bcc = bcc
@property
def cc(self):
"""Gets the cc of this SendSmtpEmailMessageVersions. # noqa: E501
List of email addresses and names (optional) of the recipients in cc # noqa: E501
:return: The cc of this SendSmtpEmailMessageVersions. # noqa: E501
:rtype: list[SendSmtpEmailCc]
"""
return self._cc
@cc.setter
def cc(self, cc):
"""Sets the cc of this SendSmtpEmailMessageVersions.
List of email addresses and names (optional) of the recipients in cc # noqa: E501
:param cc: The cc of this SendSmtpEmailMessageVersions. # noqa: E501
:type: list[SendSmtpEmailCc]
"""
self._cc = cc
@property
def reply_to(self):
"""Gets the reply_to of this SendSmtpEmailMessageVersions. # noqa: E501
:return: The reply_to of this SendSmtpEmailMessageVersions. # noqa: E501
:rtype: SendSmtpEmailReplyTo1
"""
return self._reply_to
@reply_to.setter
def reply_to(self, reply_to):
"""Sets the reply_to of this SendSmtpEmailMessageVersions.
:param reply_to: The reply_to of this SendSmtpEmailMessageVersions. # noqa: E501
:type: SendSmtpEmailReplyTo1
"""
self._reply_to = reply_to
@property
def subject(self):
"""Gets the subject of this SendSmtpEmailMessageVersions. # noqa: E501
Custom subject specific to message version # noqa: E501
:return: The subject of this SendSmtpEmailMessageVersions. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this SendSmtpEmailMessageVersions.
Custom subject specific to message version # noqa: E501
:param subject: The subject of this SendSmtpEmailMessageVersions. # noqa: E501
:type: str
"""
self._subject = subject
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(SendSmtpEmailMessageVersions, 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, SendSmtpEmailMessageVersions):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(to=None, params=None, bcc=None, cc=None, reply_to=None, subject=None)
|
59,998 |
sib_api_v3_sdk.models.send_smtp_email_message_versions
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailMessageVersions):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
59,999 |
sib_api_v3_sdk.models.send_smtp_email_message_versions
|
__init__
|
SendSmtpEmailMessageVersions - a model defined in Swagger
|
def __init__(self, to=None, params=None, bcc=None, cc=None, reply_to=None, subject=None): # noqa: E501
"""SendSmtpEmailMessageVersions - a model defined in Swagger""" # noqa: E501
self._to = None
self._params = None
self._bcc = None
self._cc = None
self._reply_to = None
self._subject = None
self.discriminator = None
self.to = to
if params is not None:
self.params = params
if bcc is not None:
self.bcc = bcc
if cc is not None:
self.cc = cc
if reply_to is not None:
self.reply_to = reply_to
if subject is not None:
self.subject = subject
|
(self, to=None, params=None, bcc=None, cc=None, reply_to=None, subject=None)
|
60,002 |
sib_api_v3_sdk.models.send_smtp_email_message_versions
|
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(SendSmtpEmailMessageVersions, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,004 |
sib_api_v3_sdk.models.send_smtp_email_reply_to
|
SendSmtpEmailReplyTo
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailReplyTo(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',
'name': 'str'
}
attribute_map = {
'email': 'email',
'name': 'name'
}
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailReplyTo - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailReplyTo. # noqa: E501
Email address in reply to # noqa: E501
:return: The email of this SendSmtpEmailReplyTo. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailReplyTo.
Email address in reply to # noqa: E501
:param email: The email of this SendSmtpEmailReplyTo. # noqa: E501
:type: str
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
@property
def name(self):
"""Gets the name of this SendSmtpEmailReplyTo. # noqa: E501
Name in reply to. Maximum allowed characters are 70. # noqa: E501
:return: The name of this SendSmtpEmailReplyTo. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailReplyTo.
Name in reply to. Maximum allowed characters are 70. # noqa: E501
:param name: The name of this SendSmtpEmailReplyTo. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailReplyTo, 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, SendSmtpEmailReplyTo):
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, name=None)
|
60,005 |
sib_api_v3_sdk.models.send_smtp_email_reply_to
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailReplyTo):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,006 |
sib_api_v3_sdk.models.send_smtp_email_reply_to
|
__init__
|
SendSmtpEmailReplyTo - a model defined in Swagger
|
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailReplyTo - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
|
(self, email=None, name=None)
|
60,009 |
sib_api_v3_sdk.models.send_smtp_email_reply_to
|
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(SendSmtpEmailReplyTo, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,011 |
sib_api_v3_sdk.models.send_smtp_email_reply_to1
|
SendSmtpEmailReplyTo1
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailReplyTo1(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',
'name': 'str'
}
attribute_map = {
'email': 'email',
'name': 'name'
}
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailReplyTo1 - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailReplyTo1. # noqa: E501
Email address in reply to # noqa: E501
:return: The email of this SendSmtpEmailReplyTo1. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailReplyTo1.
Email address in reply to # noqa: E501
:param email: The email of this SendSmtpEmailReplyTo1. # noqa: E501
:type: str
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
@property
def name(self):
"""Gets the name of this SendSmtpEmailReplyTo1. # noqa: E501
Name in reply to. Maximum allowed characters are 70. # noqa: E501
:return: The name of this SendSmtpEmailReplyTo1. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailReplyTo1.
Name in reply to. Maximum allowed characters are 70. # noqa: E501
:param name: The name of this SendSmtpEmailReplyTo1. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailReplyTo1, 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, SendSmtpEmailReplyTo1):
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, name=None)
|
60,012 |
sib_api_v3_sdk.models.send_smtp_email_reply_to1
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailReplyTo1):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,013 |
sib_api_v3_sdk.models.send_smtp_email_reply_to1
|
__init__
|
SendSmtpEmailReplyTo1 - a model defined in Swagger
|
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailReplyTo1 - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
|
(self, email=None, name=None)
|
60,016 |
sib_api_v3_sdk.models.send_smtp_email_reply_to1
|
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(SendSmtpEmailReplyTo1, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,018 |
sib_api_v3_sdk.models.send_smtp_email_sender
|
SendSmtpEmailSender
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailSender(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 = {
'name': 'str',
'email': 'str',
'id': 'int'
}
attribute_map = {
'name': 'name',
'email': 'email',
'id': 'id'
}
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""SendSmtpEmailSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._id = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if id is not None:
self.id = id
@property
def name(self):
"""Gets the name of this SendSmtpEmailSender. # noqa: E501
Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. # noqa: E501
:return: The name of this SendSmtpEmailSender. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailSender.
Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. # noqa: E501
:param name: The name of this SendSmtpEmailSender. # noqa: E501
:type: str
"""
self._name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailSender. # noqa: E501
Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. # noqa: E501
:return: The email of this SendSmtpEmailSender. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailSender.
Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. # noqa: E501
:param email: The email of this SendSmtpEmailSender. # noqa: E501
:type: str
"""
self._email = email
@property
def id(self):
"""Gets the id of this SendSmtpEmailSender. # noqa: E501
Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. # noqa: E501
:return: The id of this SendSmtpEmailSender. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this SendSmtpEmailSender.
Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. # noqa: E501
:param id: The id of this SendSmtpEmailSender. # noqa: E501
:type: int
"""
self._id = id
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(SendSmtpEmailSender, 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, SendSmtpEmailSender):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(name=None, email=None, id=None)
|
60,019 |
sib_api_v3_sdk.models.send_smtp_email_sender
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailSender):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,020 |
sib_api_v3_sdk.models.send_smtp_email_sender
|
__init__
|
SendSmtpEmailSender - a model defined in Swagger
|
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""SendSmtpEmailSender - a model defined in Swagger""" # noqa: E501
self._name = None
self._email = None
self._id = None
self.discriminator = None
if name is not None:
self.name = name
if email is not None:
self.email = email
if id is not None:
self.id = id
|
(self, name=None, email=None, id=None)
|
60,023 |
sib_api_v3_sdk.models.send_smtp_email_sender
|
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(SendSmtpEmailSender, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,025 |
sib_api_v3_sdk.models.send_smtp_email_to
|
SendSmtpEmailTo
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailTo(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',
'name': 'str'
}
attribute_map = {
'email': 'email',
'name': 'name'
}
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailTo - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailTo. # noqa: E501
Email address of the recipient # noqa: E501
:return: The email of this SendSmtpEmailTo. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailTo.
Email address of the recipient # noqa: E501
:param email: The email of this SendSmtpEmailTo. # noqa: E501
:type: str
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
@property
def name(self):
"""Gets the name of this SendSmtpEmailTo. # noqa: E501
Name of the recipient. Maximum allowed characters are 70. # noqa: E501
:return: The name of this SendSmtpEmailTo. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailTo.
Name of the recipient. Maximum allowed characters are 70. # noqa: E501
:param name: The name of this SendSmtpEmailTo. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailTo, 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, SendSmtpEmailTo):
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, name=None)
|
60,026 |
sib_api_v3_sdk.models.send_smtp_email_to
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailTo):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,027 |
sib_api_v3_sdk.models.send_smtp_email_to
|
__init__
|
SendSmtpEmailTo - a model defined in Swagger
|
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailTo - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
|
(self, email=None, name=None)
|
60,030 |
sib_api_v3_sdk.models.send_smtp_email_to
|
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(SendSmtpEmailTo, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,032 |
sib_api_v3_sdk.models.send_smtp_email_to1
|
SendSmtpEmailTo1
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendSmtpEmailTo1(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',
'name': 'str'
}
attribute_map = {
'email': 'email',
'name': 'name'
}
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailTo1 - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
@property
def email(self):
"""Gets the email of this SendSmtpEmailTo1. # noqa: E501
Email address of the recipient # noqa: E501
:return: The email of this SendSmtpEmailTo1. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this SendSmtpEmailTo1.
Email address of the recipient # noqa: E501
:param email: The email of this SendSmtpEmailTo1. # noqa: E501
:type: str
"""
if email is None:
raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501
self._email = email
@property
def name(self):
"""Gets the name of this SendSmtpEmailTo1. # noqa: E501
Name of the recipient. **Maximum allowed characters are 70**. # noqa: E501
:return: The name of this SendSmtpEmailTo1. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this SendSmtpEmailTo1.
Name of the recipient. **Maximum allowed characters are 70**. # noqa: E501
:param name: The name of this SendSmtpEmailTo1. # noqa: E501
:type: str
"""
self._name = name
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(SendSmtpEmailTo1, 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, SendSmtpEmailTo1):
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, name=None)
|
60,033 |
sib_api_v3_sdk.models.send_smtp_email_to1
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendSmtpEmailTo1):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,034 |
sib_api_v3_sdk.models.send_smtp_email_to1
|
__init__
|
SendSmtpEmailTo1 - a model defined in Swagger
|
def __init__(self, email=None, name=None): # noqa: E501
"""SendSmtpEmailTo1 - a model defined in Swagger""" # noqa: E501
self._email = None
self._name = None
self.discriminator = None
self.email = email
if name is not None:
self.name = name
|
(self, email=None, name=None)
|
60,037 |
sib_api_v3_sdk.models.send_smtp_email_to1
|
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(SendSmtpEmailTo1, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,039 |
sib_api_v3_sdk.models.send_test_email
|
SendTestEmail
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendTestEmail(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_to': 'list[str]'
}
attribute_map = {
'email_to': 'emailTo'
}
def __init__(self, email_to=None): # noqa: E501
"""SendTestEmail - a model defined in Swagger""" # noqa: E501
self._email_to = None
self.discriminator = None
if email_to is not None:
self.email_to = email_to
@property
def email_to(self):
"""Gets the email_to of this SendTestEmail. # noqa: E501
List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. # noqa: E501
:return: The email_to of this SendTestEmail. # noqa: E501
:rtype: list[str]
"""
return self._email_to
@email_to.setter
def email_to(self, email_to):
"""Sets the email_to of this SendTestEmail.
List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. # noqa: E501
:param email_to: The email_to of this SendTestEmail. # noqa: E501
:type: list[str]
"""
self._email_to = email_to
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(SendTestEmail, 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, SendTestEmail):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(email_to=None)
|
60,040 |
sib_api_v3_sdk.models.send_test_email
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendTestEmail):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,041 |
sib_api_v3_sdk.models.send_test_email
|
__init__
|
SendTestEmail - a model defined in Swagger
|
def __init__(self, email_to=None): # noqa: E501
"""SendTestEmail - a model defined in Swagger""" # noqa: E501
self._email_to = None
self.discriminator = None
if email_to is not None:
self.email_to = email_to
|
(self, email_to=None)
|
60,044 |
sib_api_v3_sdk.models.send_test_email
|
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(SendTestEmail, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,046 |
sib_api_v3_sdk.models.send_test_sms
|
SendTestSms
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendTestSms(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 = {
'phone_number': 'str'
}
attribute_map = {
'phone_number': 'phoneNumber'
}
def __init__(self, phone_number=None): # noqa: E501
"""SendTestSms - a model defined in Swagger""" # noqa: E501
self._phone_number = None
self.discriminator = None
if phone_number is not None:
self.phone_number = phone_number
@property
def phone_number(self):
"""Gets the phone_number of this SendTestSms. # noqa: E501
Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted # noqa: E501
:return: The phone_number of this SendTestSms. # noqa: E501
:rtype: str
"""
return self._phone_number
@phone_number.setter
def phone_number(self, phone_number):
"""Sets the phone_number of this SendTestSms.
Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted # noqa: E501
:param phone_number: The phone_number of this SendTestSms. # noqa: E501
:type: str
"""
self._phone_number = phone_number
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(SendTestSms, 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, SendTestSms):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(phone_number=None)
|
60,047 |
sib_api_v3_sdk.models.send_test_sms
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, SendTestSms):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
60,048 |
sib_api_v3_sdk.models.send_test_sms
|
__init__
|
SendTestSms - a model defined in Swagger
|
def __init__(self, phone_number=None): # noqa: E501
"""SendTestSms - a model defined in Swagger""" # noqa: E501
self._phone_number = None
self.discriminator = None
if phone_number is not None:
self.phone_number = phone_number
|
(self, phone_number=None)
|
60,051 |
sib_api_v3_sdk.models.send_test_sms
|
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(SendTestSms, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
60,053 |
sib_api_v3_sdk.models.send_transac_sms
|
SendTransacSms
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class SendTransacSms(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 = {
'sender': 'str',
'recipient': 'str',
'content': 'str',
'type': 'str',
'tag': 'str',
'web_url': 'str',
'unicode_enabled': 'bool',
'organisation_prefix': 'str'
}
attribute_map = {
'sender': 'sender',
'recipient': 'recipient',
'content': 'content',
'type': 'type',
'tag': 'tag',
'web_url': 'webUrl',
'unicode_enabled': 'unicodeEnabled',
'organisation_prefix': 'organisationPrefix'
}
def __init__(self, sender=None, recipient=None, content=None, type='transactional', tag=None, web_url=None, unicode_enabled=False, organisation_prefix=None): # noqa: E501
"""SendTransacSms - a model defined in Swagger""" # noqa: E501
self._sender = None
self._recipient = None
self._content = None
self._type = None
self._tag = None
self._web_url = None
self._unicode_enabled = None
self._organisation_prefix = None
self.discriminator = None
self.sender = sender
self.recipient = recipient
self.content = content
if type is not None:
self.type = type
if tag is not None:
self.tag = tag
if web_url is not None:
self.web_url = web_url
if unicode_enabled is not None:
self.unicode_enabled = unicode_enabled
if organisation_prefix is not None:
self.organisation_prefix = organisation_prefix
@property
def sender(self):
"""Gets the sender of this SendTransacSms. # noqa: E501
Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** # noqa: E501
:return: The sender of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._sender
@sender.setter
def sender(self, sender):
"""Sets the sender of this SendTransacSms.
Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** # noqa: E501
:param sender: The sender of this SendTransacSms. # noqa: E501
:type: str
"""
if sender is None:
raise ValueError("Invalid value for `sender`, must not be `None`") # noqa: E501
if sender is not None and len(sender) > 15:
raise ValueError("Invalid value for `sender`, length must be less than or equal to `15`") # noqa: E501
self._sender = sender
@property
def recipient(self):
"""Gets the recipient of this SendTransacSms. # noqa: E501
Mobile number to send SMS with the country code # noqa: E501
:return: The recipient of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._recipient
@recipient.setter
def recipient(self, recipient):
"""Sets the recipient of this SendTransacSms.
Mobile number to send SMS with the country code # noqa: E501
:param recipient: The recipient of this SendTransacSms. # noqa: E501
:type: str
"""
if recipient is None:
raise ValueError("Invalid value for `recipient`, must not be `None`") # noqa: E501
self._recipient = recipient
@property
def content(self):
"""Gets the content of this SendTransacSms. # noqa: E501
Content of the message. If more than 160 characters long, will be sent as multiple text messages # noqa: E501
:return: The content of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._content
@content.setter
def content(self, content):
"""Sets the content of this SendTransacSms.
Content of the message. If more than 160 characters long, will be sent as multiple text messages # noqa: E501
:param content: The content of this SendTransacSms. # noqa: E501
:type: str
"""
if content is None:
raise ValueError("Invalid value for `content`, must not be `None`") # noqa: E501
self._content = content
@property
def type(self):
"""Gets the type of this SendTransacSms. # noqa: E501
Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. # noqa: E501
:return: The type of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""Sets the type of this SendTransacSms.
Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. # noqa: E501
:param type: The type of this SendTransacSms. # noqa: E501
:type: str
"""
allowed_values = ["transactional", "marketing"] # noqa: E501
if type not in allowed_values:
raise ValueError(
"Invalid value for `type` ({0}), must be one of {1}" # noqa: E501
.format(type, allowed_values)
)
self._type = type
@property
def tag(self):
"""Gets the tag of this SendTransacSms. # noqa: E501
Tag of the message # noqa: E501
:return: The tag of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._tag
@tag.setter
def tag(self, tag):
"""Sets the tag of this SendTransacSms.
Tag of the message # noqa: E501
:param tag: The tag of this SendTransacSms. # noqa: E501
:type: str
"""
self._tag = tag
@property
def web_url(self):
"""Gets the web_url of this SendTransacSms. # noqa: E501
Webhook to call for each event triggered by the message (delivered etc.) # noqa: E501
:return: The web_url of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._web_url
@web_url.setter
def web_url(self, web_url):
"""Sets the web_url of this SendTransacSms.
Webhook to call for each event triggered by the message (delivered etc.) # noqa: E501
:param web_url: The web_url of this SendTransacSms. # noqa: E501
:type: str
"""
self._web_url = web_url
@property
def unicode_enabled(self):
"""Gets the unicode_enabled of this SendTransacSms. # noqa: E501
Format of the message. It indicates whether the content should be treated as unicode or not. # noqa: E501
:return: The unicode_enabled of this SendTransacSms. # noqa: E501
:rtype: bool
"""
return self._unicode_enabled
@unicode_enabled.setter
def unicode_enabled(self, unicode_enabled):
"""Sets the unicode_enabled of this SendTransacSms.
Format of the message. It indicates whether the content should be treated as unicode or not. # noqa: E501
:param unicode_enabled: The unicode_enabled of this SendTransacSms. # noqa: E501
:type: bool
"""
self._unicode_enabled = unicode_enabled
@property
def organisation_prefix(self):
"""Gets the organisation_prefix of this SendTransacSms. # noqa: E501
A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** # noqa: E501
:return: The organisation_prefix of this SendTransacSms. # noqa: E501
:rtype: str
"""
return self._organisation_prefix
@organisation_prefix.setter
def organisation_prefix(self, organisation_prefix):
"""Sets the organisation_prefix of this SendTransacSms.
A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** # noqa: E501
:param organisation_prefix: The organisation_prefix of this SendTransacSms. # noqa: E501
:type: str
"""
self._organisation_prefix = organisation_prefix
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(SendTransacSms, 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, SendTransacSms):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(sender=None, recipient=None, content=None, type='transactional', tag=None, web_url=None, unicode_enabled=False, organisation_prefix=None)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.