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
⌀ |
---|---|---|---|---|---|
58,282 |
sib_api_v3_sdk.api.contacts_api
|
get_lists_with_http_info
|
Get all the lists # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_lists_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param int offset: Index of the first document of the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetLists
If the method is called asynchronously,
returns the request thread.
|
def get_lists_with_http_info(self, **kwargs): # noqa: E501
"""Get all the lists # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_lists_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int limit: Number of documents per page
:param int offset: Index of the first document of the page
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
:return: GetLists
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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_lists" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 50: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_lists`, must be a value less than or equal to `50`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_lists`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if '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(
'/contacts/lists', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetLists', # 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)
|
58,283 |
sib_api_v3_sdk.api.contacts_api
|
import_contacts
|
Import contacts # 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.import_contacts(request_contact_import, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactImport request_contact_import: Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
|
def import_contacts(self, request_contact_import, **kwargs): # noqa: E501
"""Import contacts # 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.import_contacts(request_contact_import, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactImport request_contact_import: Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)
: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.import_contacts_with_http_info(request_contact_import, **kwargs) # noqa: E501
else:
(data) = self.import_contacts_with_http_info(request_contact_import, **kwargs) # noqa: E501
return data
|
(self, request_contact_import, **kwargs)
|
58,284 |
sib_api_v3_sdk.api.contacts_api
|
import_contacts_with_http_info
|
Import contacts # 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.import_contacts_with_http_info(request_contact_import, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactImport request_contact_import: Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
|
def import_contacts_with_http_info(self, request_contact_import, **kwargs): # noqa: E501
"""Import contacts # 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.import_contacts_with_http_info(request_contact_import, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactImport request_contact_import: Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required)
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['request_contact_import'] # 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 import_contacts" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'request_contact_import' is set
if ('request_contact_import' not in params or
params['request_contact_import'] is None):
raise ValueError("Missing the required parameter `request_contact_import` when calling `import_contacts`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'request_contact_import' in params:
body_params = params['request_contact_import']
# 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(
'/contacts/import', '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, request_contact_import, **kwargs)
|
58,285 |
sib_api_v3_sdk.api.contacts_api
|
remove_contact_from_list
|
Delete a contact from a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_contact_from_list(list_id, contact_emails, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param RemoveContactFromList contact_emails: Emails addresses OR IDs of the contacts (required)
:return: PostContactInfo
If the method is called asynchronously,
returns the request thread.
|
def remove_contact_from_list(self, list_id, contact_emails, **kwargs): # noqa: E501
"""Delete a contact from a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_contact_from_list(list_id, contact_emails, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param RemoveContactFromList contact_emails: Emails addresses OR IDs of the contacts (required)
:return: PostContactInfo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.remove_contact_from_list_with_http_info(list_id, contact_emails, **kwargs) # noqa: E501
else:
(data) = self.remove_contact_from_list_with_http_info(list_id, contact_emails, **kwargs) # noqa: E501
return data
|
(self, list_id, contact_emails, **kwargs)
|
58,286 |
sib_api_v3_sdk.api.contacts_api
|
remove_contact_from_list_with_http_info
|
Delete a contact from a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_contact_from_list_with_http_info(list_id, contact_emails, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param RemoveContactFromList contact_emails: Emails addresses OR IDs of the contacts (required)
:return: PostContactInfo
If the method is called asynchronously,
returns the request thread.
|
def remove_contact_from_list_with_http_info(self, list_id, contact_emails, **kwargs): # noqa: E501
"""Delete a contact from a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.remove_contact_from_list_with_http_info(list_id, contact_emails, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param RemoveContactFromList contact_emails: Emails addresses OR IDs of the contacts (required)
:return: PostContactInfo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'contact_emails'] # 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_contact_from_list" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling `remove_contact_from_list`") # noqa: E501
# verify the required parameter 'contact_emails' is set
if ('contact_emails' not in params or
params['contact_emails'] is None):
raise ValueError("Missing the required parameter `contact_emails` when calling `remove_contact_from_list`") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['listId'] = params['list_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'contact_emails' in params:
body_params = params['contact_emails']
# 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(
'/contacts/lists/{listId}/contacts/remove', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PostContactInfo', # 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, list_id, contact_emails, **kwargs)
|
58,287 |
sib_api_v3_sdk.api.contacts_api
|
request_contact_export
|
Export contacts # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. # 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_contact_export(request_contact_export, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactExport request_contact_export: Values to request a contact export (required)
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
|
def request_contact_export(self, request_contact_export, **kwargs): # noqa: E501
"""Export contacts # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. # 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_contact_export(request_contact_export, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactExport request_contact_export: Values to request a contact export (required)
: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_contact_export_with_http_info(request_contact_export, **kwargs) # noqa: E501
else:
(data) = self.request_contact_export_with_http_info(request_contact_export, **kwargs) # noqa: E501
return data
|
(self, request_contact_export, **kwargs)
|
58,288 |
sib_api_v3_sdk.api.contacts_api
|
request_contact_export_with_http_info
|
Export contacts # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. # 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_contact_export_with_http_info(request_contact_export, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactExport request_contact_export: Values to request a contact export (required)
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
|
def request_contact_export_with_http_info(self, request_contact_export, **kwargs): # noqa: E501
"""Export contacts # noqa: E501
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. # 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_contact_export_with_http_info(request_contact_export, async_req=True)
>>> result = thread.get()
:param async_req bool
:param RequestContactExport request_contact_export: Values to request a contact export (required)
:return: CreatedProcessId
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['request_contact_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_contact_export" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'request_contact_export' is set
if ('request_contact_export' not in params or
params['request_contact_export'] is None):
raise ValueError("Missing the required parameter `request_contact_export` when calling `request_contact_export`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'request_contact_export' in params:
body_params = params['request_contact_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(
'/contacts/export', '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, request_contact_export, **kwargs)
|
58,289 |
sib_api_v3_sdk.api.contacts_api
|
update_attribute
|
Update contact attribute # 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_attribute(attribute_category, attribute_name, update_attribute, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str attribute_category: Category of the attribute (required)
:param str attribute_name: Name of the existing attribute (required)
:param UpdateAttribute update_attribute: Values to update an attribute (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_attribute(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501
"""Update contact attribute # 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_attribute(attribute_category, attribute_name, update_attribute, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str attribute_category: Category of the attribute (required)
:param str attribute_name: Name of the existing attribute (required)
:param UpdateAttribute update_attribute: Values to update an attribute (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_attribute_with_http_info(attribute_category, attribute_name, update_attribute, **kwargs) # noqa: E501
else:
(data) = self.update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, **kwargs) # noqa: E501
return data
|
(self, attribute_category, attribute_name, update_attribute, **kwargs)
|
58,290 |
sib_api_v3_sdk.api.contacts_api
|
update_attribute_with_http_info
|
Update contact attribute # 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_attribute_with_http_info(attribute_category, attribute_name, update_attribute, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str attribute_category: Category of the attribute (required)
:param str attribute_name: Name of the existing attribute (required)
:param UpdateAttribute update_attribute: Values to update an attribute (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_attribute_with_http_info(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501
"""Update contact attribute # 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_attribute_with_http_info(attribute_category, attribute_name, update_attribute, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str attribute_category: Category of the attribute (required)
:param str attribute_name: Name of the existing attribute (required)
:param UpdateAttribute update_attribute: Values to update an attribute (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['attribute_category', 'attribute_name', 'update_attribute'] # 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_attribute" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'attribute_category' is set
if ('attribute_category' not in params or
params['attribute_category'] is None):
raise ValueError("Missing the required parameter `attribute_category` when calling `update_attribute`") # noqa: E501
# verify the required parameter 'attribute_name' is set
if ('attribute_name' not in params or
params['attribute_name'] is None):
raise ValueError("Missing the required parameter `attribute_name` when calling `update_attribute`") # noqa: E501
# verify the required parameter 'update_attribute' is set
if ('update_attribute' not in params or
params['update_attribute'] is None):
raise ValueError("Missing the required parameter `update_attribute` when calling `update_attribute`") # noqa: E501
collection_formats = {}
path_params = {}
if 'attribute_category' in params:
path_params['attributeCategory'] = params['attribute_category'] # noqa: E501
if 'attribute_name' in params:
path_params['attributeName'] = params['attribute_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_attribute' in params:
body_params = params['update_attribute']
# 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(
'/contacts/attributes/{attributeCategory}/{attributeName}', '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, attribute_category, attribute_name, update_attribute, **kwargs)
|
58,291 |
sib_api_v3_sdk.api.contacts_api
|
update_batch_contacts
|
Update multiple contacts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_batch_contacts(update_batch_contacts, async_req=True)
>>> result = thread.get()
:param async_req bool
:param UpdateBatchContacts update_batch_contacts: Values to update multiple contacts (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_batch_contacts(self, update_batch_contacts, **kwargs): # noqa: E501
"""Update multiple contacts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_batch_contacts(update_batch_contacts, async_req=True)
>>> result = thread.get()
:param async_req bool
:param UpdateBatchContacts update_batch_contacts: Values to update multiple contacts (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_batch_contacts_with_http_info(update_batch_contacts, **kwargs) # noqa: E501
else:
(data) = self.update_batch_contacts_with_http_info(update_batch_contacts, **kwargs) # noqa: E501
return data
|
(self, update_batch_contacts, **kwargs)
|
58,292 |
sib_api_v3_sdk.api.contacts_api
|
update_batch_contacts_with_http_info
|
Update multiple contacts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_batch_contacts_with_http_info(update_batch_contacts, async_req=True)
>>> result = thread.get()
:param async_req bool
:param UpdateBatchContacts update_batch_contacts: Values to update multiple contacts (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_batch_contacts_with_http_info(self, update_batch_contacts, **kwargs): # noqa: E501
"""Update multiple contacts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_batch_contacts_with_http_info(update_batch_contacts, async_req=True)
>>> result = thread.get()
:param async_req bool
:param UpdateBatchContacts update_batch_contacts: Values to update multiple contacts (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['update_batch_contacts'] # 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_batch_contacts" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'update_batch_contacts' is set
if ('update_batch_contacts' not in params or
params['update_batch_contacts'] is None):
raise ValueError("Missing the required parameter `update_batch_contacts` when calling `update_batch_contacts`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_batch_contacts' in params:
body_params = params['update_batch_contacts']
# 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(
'/contacts/batch', '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, update_batch_contacts, **kwargs)
|
58,293 |
sib_api_v3_sdk.api.contacts_api
|
update_contact
|
Update a contact # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_contact(identifier, update_contact, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: Email (urlencoded) OR ID of the contact (required)
:param UpdateContact update_contact: Values to update a contact (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_contact(self, identifier, update_contact, **kwargs): # noqa: E501
"""Update a contact # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_contact(identifier, update_contact, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: Email (urlencoded) OR ID of the contact (required)
:param UpdateContact update_contact: Values to update a contact (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_contact_with_http_info(identifier, update_contact, **kwargs) # noqa: E501
else:
(data) = self.update_contact_with_http_info(identifier, update_contact, **kwargs) # noqa: E501
return data
|
(self, identifier, update_contact, **kwargs)
|
58,294 |
sib_api_v3_sdk.api.contacts_api
|
update_contact_with_http_info
|
Update a contact # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_contact_with_http_info(identifier, update_contact, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: Email (urlencoded) OR ID of the contact (required)
:param UpdateContact update_contact: Values to update a contact (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_contact_with_http_info(self, identifier, update_contact, **kwargs): # noqa: E501
"""Update a contact # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_contact_with_http_info(identifier, update_contact, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str identifier: Email (urlencoded) OR ID of the contact (required)
:param UpdateContact update_contact: Values to update a contact (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['identifier', 'update_contact'] # 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_contact" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'identifier' is set
if ('identifier' not in params or
params['identifier'] is None):
raise ValueError("Missing the required parameter `identifier` when calling `update_contact`") # noqa: E501
# verify the required parameter 'update_contact' is set
if ('update_contact' not in params or
params['update_contact'] is None):
raise ValueError("Missing the required parameter `update_contact` when calling `update_contact`") # noqa: E501
collection_formats = {}
path_params = {}
if 'identifier' in params:
path_params['identifier'] = params['identifier'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_contact' in params:
body_params = params['update_contact']
# 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(
'/contacts/{identifier}', '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, identifier, update_contact, **kwargs)
|
58,295 |
sib_api_v3_sdk.api.contacts_api
|
update_folder
|
Update a folder # 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_folder(folder_id, update_folder, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int folder_id: Id of the folder (required)
:param CreateUpdateFolder update_folder: Name of the folder (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_folder(self, folder_id, update_folder, **kwargs): # noqa: E501
"""Update a folder # 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_folder(folder_id, update_folder, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int folder_id: Id of the folder (required)
:param CreateUpdateFolder update_folder: Name of the folder (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_folder_with_http_info(folder_id, update_folder, **kwargs) # noqa: E501
else:
(data) = self.update_folder_with_http_info(folder_id, update_folder, **kwargs) # noqa: E501
return data
|
(self, folder_id, update_folder, **kwargs)
|
58,296 |
sib_api_v3_sdk.api.contacts_api
|
update_folder_with_http_info
|
Update a folder # 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_folder_with_http_info(folder_id, update_folder, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int folder_id: Id of the folder (required)
:param CreateUpdateFolder update_folder: Name of the folder (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_folder_with_http_info(self, folder_id, update_folder, **kwargs): # noqa: E501
"""Update a folder # 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_folder_with_http_info(folder_id, update_folder, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int folder_id: Id of the folder (required)
:param CreateUpdateFolder update_folder: Name of the folder (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['folder_id', 'update_folder'] # 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_folder" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'folder_id' is set
if ('folder_id' not in params or
params['folder_id'] is None):
raise ValueError("Missing the required parameter `folder_id` when calling `update_folder`") # noqa: E501
# verify the required parameter 'update_folder' is set
if ('update_folder' not in params or
params['update_folder'] is None):
raise ValueError("Missing the required parameter `update_folder` when calling `update_folder`") # noqa: E501
collection_formats = {}
path_params = {}
if 'folder_id' in params:
path_params['folderId'] = params['folder_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_folder' in params:
body_params = params['update_folder']
# 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(
'/contacts/folders/{folderId}', '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, folder_id, update_folder, **kwargs)
|
58,297 |
sib_api_v3_sdk.api.contacts_api
|
update_list
|
Update a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list(list_id, update_list, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param UpdateList update_list: Values to update a list (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_list(self, list_id, update_list, **kwargs): # noqa: E501
"""Update a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list(list_id, update_list, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param UpdateList update_list: Values to update a list (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_list_with_http_info(list_id, update_list, **kwargs) # noqa: E501
else:
(data) = self.update_list_with_http_info(list_id, update_list, **kwargs) # noqa: E501
return data
|
(self, list_id, update_list, **kwargs)
|
58,298 |
sib_api_v3_sdk.api.contacts_api
|
update_list_with_http_info
|
Update a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_with_http_info(list_id, update_list, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param UpdateList update_list: Values to update a list (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_list_with_http_info(self, list_id, update_list, **kwargs): # noqa: E501
"""Update a list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_with_http_info(list_id, update_list, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int list_id: Id of the list (required)
:param UpdateList update_list: Values to update a list (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'update_list'] # 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_list" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling `update_list`") # noqa: E501
# verify the required parameter 'update_list' is set
if ('update_list' not in params or
params['update_list'] is None):
raise ValueError("Missing the required parameter `update_list` when calling `update_list`") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['listId'] = params['list_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_list' in params:
body_params = params['update_list']
# 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(
'/contacts/lists/{listId}', '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, list_id, update_list, **kwargs)
|
58,299 |
sib_api_v3_sdk.api.conversations_api
|
ConversationsApi
|
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 ConversationsApi(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 conversations_agent_online_ping_post(self, body, **kwargs): # noqa: E501
"""Sets agent’s status to online for 2-3 minutes # noqa: E501
We recommend pinging this endpoint every minute for as long as the agent has to be considered online. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_agent_online_ping_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body12 body: Agent fields. (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.conversations_agent_online_ping_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.conversations_agent_online_ping_post_with_http_info(body, **kwargs) # noqa: E501
return data
def conversations_agent_online_ping_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Sets agent’s status to online for 2-3 minutes # noqa: E501
We recommend pinging this endpoint every minute for as long as the agent has to be considered online. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_agent_online_ping_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body12 body: Agent fields. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_agent_online_ping_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_agent_online_ping_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/agentOnlinePing', '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 conversations_messages_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a message sent by an agent # noqa: E501
Only agents’ messages can be deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (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.conversations_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
def conversations_messages_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a message sent by an agent # noqa: E501
Only agents’ messages can be deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_messages_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_messages_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/messages/{id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=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 conversations_messages_id_get(self, id, **kwargs): # noqa: E501
"""Get a message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
def conversations_messages_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get a message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_messages_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_messages_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/messages/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # 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 conversations_messages_id_put(self, id, **kwargs): # noqa: E501
"""Update a message sent by an agent # noqa: E501
Only agents’ messages can be edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_put(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body9 body:
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_messages_id_put_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_id_put_with_http_info(id, **kwargs) # noqa: E501
return data
def conversations_messages_id_put_with_http_info(self, id, **kwargs): # noqa: E501
"""Update a message sent by an agent # noqa: E501
Only agents’ messages can be edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_put_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body9 body:
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_messages_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_messages_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/messages/{id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # 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 conversations_messages_post(self, body, **kwargs): # noqa: E501
"""Send a message as an agent # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body8 body: Message fields. (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_messages_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_post_with_http_info(body, **kwargs) # noqa: E501
return data
def conversations_messages_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Send a message as an agent # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body8 body: Message fields. (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_messages_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_messages_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/messages', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # 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 conversations_pushed_messages_id_delete(self, id, **kwargs): # noqa: E501
"""Delete an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (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.conversations_pushed_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
def conversations_pushed_messages_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_pushed_messages_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_pushed_messages_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/pushedMessages/{id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=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 conversations_pushed_messages_id_get(self, id, **kwargs): # noqa: E501
"""Get an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message sent previously (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_pushed_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
def conversations_pushed_messages_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message sent previously (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_pushed_messages_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_pushed_messages_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/pushedMessages/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # 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 conversations_pushed_messages_id_put(self, id, body, **kwargs): # noqa: E501
"""Update an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_put(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body11 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_pushed_messages_id_put_with_http_info(id, body, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_id_put_with_http_info(id, body, **kwargs) # noqa: E501
return data
def conversations_pushed_messages_id_put_with_http_info(self, id, body, **kwargs): # noqa: E501
"""Update an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_put_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body11 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_pushed_messages_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_pushed_messages_id_put`") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_pushed_messages_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/pushedMessages/{id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # 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 conversations_pushed_messages_post(self, body, **kwargs): # noqa: E501
"""Send an automated message to a visitor # noqa: E501
Example of automated messages: order status, announce new features in your web app, etc. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body10 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_pushed_messages_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_post_with_http_info(body, **kwargs) # noqa: E501
return data
def conversations_pushed_messages_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Send an automated message to a visitor # noqa: E501
Example of automated messages: order status, announce new features in your web app, etc. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body10 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_pushed_messages_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_pushed_messages_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/pushedMessages', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # 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)
|
58,301 |
sib_api_v3_sdk.api.conversations_api
|
conversations_agent_online_ping_post
|
Sets agent’s status to online for 2-3 minutes # noqa: E501
We recommend pinging this endpoint every minute for as long as the agent has to be considered online. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_agent_online_ping_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body12 body: Agent fields. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def conversations_agent_online_ping_post(self, body, **kwargs): # noqa: E501
"""Sets agent’s status to online for 2-3 minutes # noqa: E501
We recommend pinging this endpoint every minute for as long as the agent has to be considered online. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_agent_online_ping_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body12 body: Agent fields. (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.conversations_agent_online_ping_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.conversations_agent_online_ping_post_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body, **kwargs)
|
58,302 |
sib_api_v3_sdk.api.conversations_api
|
conversations_agent_online_ping_post_with_http_info
|
Sets agent’s status to online for 2-3 minutes # noqa: E501
We recommend pinging this endpoint every minute for as long as the agent has to be considered online. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_agent_online_ping_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body12 body: Agent fields. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def conversations_agent_online_ping_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Sets agent’s status to online for 2-3 minutes # noqa: E501
We recommend pinging this endpoint every minute for as long as the agent has to be considered online. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_agent_online_ping_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body12 body: Agent fields. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_agent_online_ping_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_agent_online_ping_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/agentOnlinePing', '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, body, **kwargs)
|
58,303 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_id_delete
|
Delete a message sent by an agent # noqa: E501
Only agents’ messages can be deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a message sent by an agent # noqa: E501
Only agents’ messages can be deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (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.conversations_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,304 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_id_delete_with_http_info
|
Delete a message sent by an agent # noqa: E501
Only agents’ messages can be deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a message sent by an agent # noqa: E501
Only agents’ messages can be deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_messages_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_messages_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/messages/{id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, **kwargs)
|
58,305 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_id_get
|
Get a message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_id_get(self, id, **kwargs): # noqa: E501
"""Get a message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,306 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_id_get_with_http_info
|
Get a message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get a message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_messages_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_messages_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/messages/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, **kwargs)
|
58,307 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_id_put
|
Update a message sent by an agent # noqa: E501
Only agents’ messages can be edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_put(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body9 body:
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_id_put(self, id, **kwargs): # noqa: E501
"""Update a message sent by an agent # noqa: E501
Only agents’ messages can be edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_put(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body9 body:
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_messages_id_put_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_id_put_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,308 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_id_put_with_http_info
|
Update a message sent by an agent # noqa: E501
Only agents’ messages can be edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_put_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body9 body:
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_id_put_with_http_info(self, id, **kwargs): # noqa: E501
"""Update a message sent by an agent # noqa: E501
Only agents’ messages can be edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_id_put_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body9 body:
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_messages_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_messages_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/messages/{id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, **kwargs)
|
58,309 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_post
|
Send a message as an agent # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body8 body: Message fields. (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_post(self, body, **kwargs): # noqa: E501
"""Send a message as an agent # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body8 body: Message fields. (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_messages_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.conversations_messages_post_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body, **kwargs)
|
58,310 |
sib_api_v3_sdk.api.conversations_api
|
conversations_messages_post_with_http_info
|
Send a message as an agent # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body8 body: Message fields. (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_messages_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Send a message as an agent # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_messages_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body8 body: Message fields. (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_messages_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_messages_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/messages', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, body, **kwargs)
|
58,311 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_id_delete
|
Delete an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_id_delete(self, id, **kwargs): # noqa: E501
"""Delete an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (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.conversations_pushed_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,312 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_id_delete_with_http_info
|
Delete an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_pushed_messages_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_pushed_messages_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/pushedMessages/{id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, **kwargs)
|
58,313 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_id_get
|
Get an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message sent previously (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_id_get(self, id, **kwargs): # noqa: E501
"""Get an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message sent previously (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_pushed_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,314 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_id_get_with_http_info
|
Get an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message sent previously (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message sent previously (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['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 conversations_pushed_messages_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_pushed_messages_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# 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(
'/conversations/pushedMessages/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, **kwargs)
|
58,315 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_id_put
|
Update an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_put(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body11 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_id_put(self, id, body, **kwargs): # noqa: E501
"""Update an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_put(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body11 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_pushed_messages_id_put_with_http_info(id, body, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_id_put_with_http_info(id, body, **kwargs) # noqa: E501
return data
|
(self, id, body, **kwargs)
|
58,316 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_id_put_with_http_info
|
Update an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_put_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body11 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_id_put_with_http_info(self, id, body, **kwargs): # noqa: E501
"""Update an automated message # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_id_put_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: ID of the message (required)
:param Body11 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_pushed_messages_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in params or
params['id'] is None):
raise ValueError("Missing the required parameter `id` when calling `conversations_pushed_messages_id_put`") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_pushed_messages_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in params:
path_params['id'] = params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/pushedMessages/{id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, id, body, **kwargs)
|
58,317 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_post
|
Send an automated message to a visitor # noqa: E501
Example of automated messages: order status, announce new features in your web app, etc. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body10 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_post(self, body, **kwargs): # noqa: E501
"""Send an automated message to a visitor # noqa: E501
Example of automated messages: order status, announce new features in your web app, etc. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_post(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body10 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.conversations_pushed_messages_post_with_http_info(body, **kwargs) # noqa: E501
else:
(data) = self.conversations_pushed_messages_post_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body, **kwargs)
|
58,318 |
sib_api_v3_sdk.api.conversations_api
|
conversations_pushed_messages_post_with_http_info
|
Send an automated message to a visitor # noqa: E501
Example of automated messages: order status, announce new features in your web app, etc. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body10 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
|
def conversations_pushed_messages_post_with_http_info(self, body, **kwargs): # noqa: E501
"""Send an automated message to a visitor # noqa: E501
Example of automated messages: order status, announce new features in your web app, etc. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.conversations_pushed_messages_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Body10 body: (required)
:return: ConversationsMessage
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method conversations_pushed_messages_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `conversations_pushed_messages_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/conversations/pushedMessages', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConversationsMessage', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, body, **kwargs)
|
58,319 |
sib_api_v3_sdk.models.conversations_message
|
ConversationsMessage
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class ConversationsMessage(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 = {
'id': 'str',
'type': 'str',
'text': 'str',
'visitor_id': 'str',
'agent_id': 'str',
'agent_name': 'str',
'created_at': 'int',
'is_pushed': 'bool',
'received_from': 'str',
'file': 'ConversationsMessageFile'
}
attribute_map = {
'id': 'id',
'type': 'type',
'text': 'text',
'visitor_id': 'visitorId',
'agent_id': 'agentId',
'agent_name': 'agentName',
'created_at': 'createdAt',
'is_pushed': 'isPushed',
'received_from': 'receivedFrom',
'file': 'file'
}
def __init__(self, id=None, type=None, text=None, visitor_id=None, agent_id=None, agent_name=None, created_at=None, is_pushed=None, received_from=None, file=None): # noqa: E501
"""ConversationsMessage - a model defined in Swagger""" # noqa: E501
self._id = None
self._type = None
self._text = None
self._visitor_id = None
self._agent_id = None
self._agent_name = None
self._created_at = None
self._is_pushed = None
self._received_from = None
self._file = None
self.discriminator = None
if id is not None:
self.id = id
if type is not None:
self.type = type
if text is not None:
self.text = text
if visitor_id is not None:
self.visitor_id = visitor_id
if agent_id is not None:
self.agent_id = agent_id
if agent_name is not None:
self.agent_name = agent_name
if created_at is not None:
self.created_at = created_at
if is_pushed is not None:
self.is_pushed = is_pushed
if received_from is not None:
self.received_from = received_from
if file is not None:
self.file = file
@property
def id(self):
"""Gets the id of this ConversationsMessage. # noqa: E501
Message ID. It can be used for further manipulations with the message. # noqa: E501
:return: The id of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this ConversationsMessage.
Message ID. It can be used for further manipulations with the message. # noqa: E501
:param id: The id of this ConversationsMessage. # noqa: E501
:type: str
"""
self._id = id
@property
def type(self):
"""Gets the type of this ConversationsMessage. # noqa: E501
`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. # noqa: E501
:return: The type of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""Sets the type of this ConversationsMessage.
`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. # noqa: E501
:param type: The type of this ConversationsMessage. # noqa: E501
:type: str
"""
allowed_values = ["agent", "visitor"] # 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 text(self):
"""Gets the text of this ConversationsMessage. # noqa: E501
Message text or name of the attached file # noqa: E501
:return: The text of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._text
@text.setter
def text(self, text):
"""Sets the text of this ConversationsMessage.
Message text or name of the attached file # noqa: E501
:param text: The text of this ConversationsMessage. # noqa: E501
:type: str
"""
self._text = text
@property
def visitor_id(self):
"""Gets the visitor_id of this ConversationsMessage. # noqa: E501
visitor’s ID # noqa: E501
:return: The visitor_id of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._visitor_id
@visitor_id.setter
def visitor_id(self, visitor_id):
"""Sets the visitor_id of this ConversationsMessage.
visitor’s ID # noqa: E501
:param visitor_id: The visitor_id of this ConversationsMessage. # noqa: E501
:type: str
"""
self._visitor_id = visitor_id
@property
def agent_id(self):
"""Gets the agent_id of this ConversationsMessage. # noqa: E501
ID of the agent on whose behalf the message was sent (only in messages sent by an agent). # noqa: E501
:return: The agent_id of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._agent_id
@agent_id.setter
def agent_id(self, agent_id):
"""Sets the agent_id of this ConversationsMessage.
ID of the agent on whose behalf the message was sent (only in messages sent by an agent). # noqa: E501
:param agent_id: The agent_id of this ConversationsMessage. # noqa: E501
:type: str
"""
self._agent_id = agent_id
@property
def agent_name(self):
"""Gets the agent_name of this ConversationsMessage. # noqa: E501
Agent’s name as displayed to the visitor. Only in the messages sent by an agent. # noqa: E501
:return: The agent_name of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._agent_name
@agent_name.setter
def agent_name(self, agent_name):
"""Sets the agent_name of this ConversationsMessage.
Agent’s name as displayed to the visitor. Only in the messages sent by an agent. # noqa: E501
:param agent_name: The agent_name of this ConversationsMessage. # noqa: E501
:type: str
"""
self._agent_name = agent_name
@property
def created_at(self):
"""Gets the created_at of this ConversationsMessage. # noqa: E501
Timestamp in milliseconds. # noqa: E501
:return: The created_at of this ConversationsMessage. # noqa: E501
:rtype: int
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this ConversationsMessage.
Timestamp in milliseconds. # noqa: E501
:param created_at: The created_at of this ConversationsMessage. # noqa: E501
:type: int
"""
if created_at is not None and created_at < 0: # noqa: E501
raise ValueError("Invalid value for `created_at`, must be a value greater than or equal to `0`") # noqa: E501
self._created_at = created_at
@property
def is_pushed(self):
"""Gets the is_pushed of this ConversationsMessage. # noqa: E501
`true` for pushed messages # noqa: E501
:return: The is_pushed of this ConversationsMessage. # noqa: E501
:rtype: bool
"""
return self._is_pushed
@is_pushed.setter
def is_pushed(self, is_pushed):
"""Sets the is_pushed of this ConversationsMessage.
`true` for pushed messages # noqa: E501
:param is_pushed: The is_pushed of this ConversationsMessage. # noqa: E501
:type: bool
"""
self._is_pushed = is_pushed
@property
def received_from(self):
"""Gets the received_from of this ConversationsMessage. # noqa: E501
In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. # noqa: E501
:return: The received_from of this ConversationsMessage. # noqa: E501
:rtype: str
"""
return self._received_from
@received_from.setter
def received_from(self, received_from):
"""Sets the received_from of this ConversationsMessage.
In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. # noqa: E501
:param received_from: The received_from of this ConversationsMessage. # noqa: E501
:type: str
"""
self._received_from = received_from
@property
def file(self):
"""Gets the file of this ConversationsMessage. # noqa: E501
:return: The file of this ConversationsMessage. # noqa: E501
:rtype: ConversationsMessageFile
"""
return self._file
@file.setter
def file(self, file):
"""Sets the file of this ConversationsMessage.
:param file: The file of this ConversationsMessage. # noqa: E501
:type: ConversationsMessageFile
"""
self._file = file
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(ConversationsMessage, 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, ConversationsMessage):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(id=None, type=None, text=None, visitor_id=None, agent_id=None, agent_name=None, created_at=None, is_pushed=None, received_from=None, file=None)
|
58,320 |
sib_api_v3_sdk.models.conversations_message
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, ConversationsMessage):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,321 |
sib_api_v3_sdk.models.conversations_message
|
__init__
|
ConversationsMessage - a model defined in Swagger
|
def __init__(self, id=None, type=None, text=None, visitor_id=None, agent_id=None, agent_name=None, created_at=None, is_pushed=None, received_from=None, file=None): # noqa: E501
"""ConversationsMessage - a model defined in Swagger""" # noqa: E501
self._id = None
self._type = None
self._text = None
self._visitor_id = None
self._agent_id = None
self._agent_name = None
self._created_at = None
self._is_pushed = None
self._received_from = None
self._file = None
self.discriminator = None
if id is not None:
self.id = id
if type is not None:
self.type = type
if text is not None:
self.text = text
if visitor_id is not None:
self.visitor_id = visitor_id
if agent_id is not None:
self.agent_id = agent_id
if agent_name is not None:
self.agent_name = agent_name
if created_at is not None:
self.created_at = created_at
if is_pushed is not None:
self.is_pushed = is_pushed
if received_from is not None:
self.received_from = received_from
if file is not None:
self.file = file
|
(self, id=None, type=None, text=None, visitor_id=None, agent_id=None, agent_name=None, created_at=None, is_pushed=None, received_from=None, file=None)
|
58,324 |
sib_api_v3_sdk.models.conversations_message
|
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(ConversationsMessage, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,326 |
sib_api_v3_sdk.models.conversations_message_file
|
ConversationsMessageFile
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class ConversationsMessageFile(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 = {
'filename': 'str',
'size': 'int',
'is_image': 'bool',
'url': 'str',
'image_info': 'ConversationsMessageFileImageInfo'
}
attribute_map = {
'filename': 'filename',
'size': 'size',
'is_image': 'isImage',
'url': 'url',
'image_info': 'imageInfo'
}
def __init__(self, filename=None, size=None, is_image=None, url=None, image_info=None): # noqa: E501
"""ConversationsMessageFile - a model defined in Swagger""" # noqa: E501
self._filename = None
self._size = None
self._is_image = None
self._url = None
self._image_info = None
self.discriminator = None
if filename is not None:
self.filename = filename
if size is not None:
self.size = size
if is_image is not None:
self.is_image = is_image
if url is not None:
self.url = url
if image_info is not None:
self.image_info = image_info
@property
def filename(self):
"""Gets the filename of this ConversationsMessageFile. # noqa: E501
Name of the file # noqa: E501
:return: The filename of this ConversationsMessageFile. # noqa: E501
:rtype: str
"""
return self._filename
@filename.setter
def filename(self, filename):
"""Sets the filename of this ConversationsMessageFile.
Name of the file # noqa: E501
:param filename: The filename of this ConversationsMessageFile. # noqa: E501
:type: str
"""
self._filename = filename
@property
def size(self):
"""Gets the size of this ConversationsMessageFile. # noqa: E501
Size in bytes # noqa: E501
:return: The size of this ConversationsMessageFile. # noqa: E501
:rtype: int
"""
return self._size
@size.setter
def size(self, size):
"""Sets the size of this ConversationsMessageFile.
Size in bytes # noqa: E501
:param size: The size of this ConversationsMessageFile. # noqa: E501
:type: int
"""
if size is not None and size < 0: # noqa: E501
raise ValueError("Invalid value for `size`, must be a value greater than or equal to `0`") # noqa: E501
self._size = size
@property
def is_image(self):
"""Gets the is_image of this ConversationsMessageFile. # noqa: E501
Whether the file is an image # noqa: E501
:return: The is_image of this ConversationsMessageFile. # noqa: E501
:rtype: bool
"""
return self._is_image
@is_image.setter
def is_image(self, is_image):
"""Sets the is_image of this ConversationsMessageFile.
Whether the file is an image # noqa: E501
:param is_image: The is_image of this ConversationsMessageFile. # noqa: E501
:type: bool
"""
self._is_image = is_image
@property
def url(self):
"""Gets the url of this ConversationsMessageFile. # noqa: E501
URL of the file # noqa: E501
:return: The url of this ConversationsMessageFile. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this ConversationsMessageFile.
URL of the file # noqa: E501
:param url: The url of this ConversationsMessageFile. # noqa: E501
:type: str
"""
self._url = url
@property
def image_info(self):
"""Gets the image_info of this ConversationsMessageFile. # noqa: E501
:return: The image_info of this ConversationsMessageFile. # noqa: E501
:rtype: ConversationsMessageFileImageInfo
"""
return self._image_info
@image_info.setter
def image_info(self, image_info):
"""Sets the image_info of this ConversationsMessageFile.
:param image_info: The image_info of this ConversationsMessageFile. # noqa: E501
:type: ConversationsMessageFileImageInfo
"""
self._image_info = image_info
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(ConversationsMessageFile, 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, ConversationsMessageFile):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(filename=None, size=None, is_image=None, url=None, image_info=None)
|
58,327 |
sib_api_v3_sdk.models.conversations_message_file
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, ConversationsMessageFile):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,328 |
sib_api_v3_sdk.models.conversations_message_file
|
__init__
|
ConversationsMessageFile - a model defined in Swagger
|
def __init__(self, filename=None, size=None, is_image=None, url=None, image_info=None): # noqa: E501
"""ConversationsMessageFile - a model defined in Swagger""" # noqa: E501
self._filename = None
self._size = None
self._is_image = None
self._url = None
self._image_info = None
self.discriminator = None
if filename is not None:
self.filename = filename
if size is not None:
self.size = size
if is_image is not None:
self.is_image = is_image
if url is not None:
self.url = url
if image_info is not None:
self.image_info = image_info
|
(self, filename=None, size=None, is_image=None, url=None, image_info=None)
|
58,331 |
sib_api_v3_sdk.models.conversations_message_file
|
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(ConversationsMessageFile, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,333 |
sib_api_v3_sdk.models.conversations_message_file_image_info
|
ConversationsMessageFileImageInfo
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class ConversationsMessageFileImageInfo(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 = {
'width': 'int',
'height': 'int',
'preview_url': 'str'
}
attribute_map = {
'width': 'width',
'height': 'height',
'preview_url': 'previewUrl'
}
def __init__(self, width=None, height=None, preview_url=None): # noqa: E501
"""ConversationsMessageFileImageInfo - a model defined in Swagger""" # noqa: E501
self._width = None
self._height = None
self._preview_url = None
self.discriminator = None
if width is not None:
self.width = width
if height is not None:
self.height = height
if preview_url is not None:
self.preview_url = preview_url
@property
def width(self):
"""Gets the width of this ConversationsMessageFileImageInfo. # noqa: E501
Width of the image # noqa: E501
:return: The width of this ConversationsMessageFileImageInfo. # noqa: E501
:rtype: int
"""
return self._width
@width.setter
def width(self, width):
"""Sets the width of this ConversationsMessageFileImageInfo.
Width of the image # noqa: E501
:param width: The width of this ConversationsMessageFileImageInfo. # noqa: E501
:type: int
"""
if width is not None and width < 0: # noqa: E501
raise ValueError("Invalid value for `width`, must be a value greater than or equal to `0`") # noqa: E501
self._width = width
@property
def height(self):
"""Gets the height of this ConversationsMessageFileImageInfo. # noqa: E501
height of the image # noqa: E501
:return: The height of this ConversationsMessageFileImageInfo. # noqa: E501
:rtype: int
"""
return self._height
@height.setter
def height(self, height):
"""Sets the height of this ConversationsMessageFileImageInfo.
height of the image # noqa: E501
:param height: The height of this ConversationsMessageFileImageInfo. # noqa: E501
:type: int
"""
if height is not None and height < 0: # noqa: E501
raise ValueError("Invalid value for `height`, must be a value greater than or equal to `0`") # noqa: E501
self._height = height
@property
def preview_url(self):
"""Gets the preview_url of this ConversationsMessageFileImageInfo. # noqa: E501
URL of the preview # noqa: E501
:return: The preview_url of this ConversationsMessageFileImageInfo. # noqa: E501
:rtype: str
"""
return self._preview_url
@preview_url.setter
def preview_url(self, preview_url):
"""Sets the preview_url of this ConversationsMessageFileImageInfo.
URL of the preview # noqa: E501
:param preview_url: The preview_url of this ConversationsMessageFileImageInfo. # noqa: E501
:type: str
"""
self._preview_url = preview_url
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(ConversationsMessageFileImageInfo, 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, ConversationsMessageFileImageInfo):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(width=None, height=None, preview_url=None)
|
58,334 |
sib_api_v3_sdk.models.conversations_message_file_image_info
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, ConversationsMessageFileImageInfo):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,335 |
sib_api_v3_sdk.models.conversations_message_file_image_info
|
__init__
|
ConversationsMessageFileImageInfo - a model defined in Swagger
|
def __init__(self, width=None, height=None, preview_url=None): # noqa: E501
"""ConversationsMessageFileImageInfo - a model defined in Swagger""" # noqa: E501
self._width = None
self._height = None
self._preview_url = None
self.discriminator = None
if width is not None:
self.width = width
if height is not None:
self.height = height
if preview_url is not None:
self.preview_url = preview_url
|
(self, width=None, height=None, preview_url=None)
|
58,338 |
sib_api_v3_sdk.models.conversations_message_file_image_info
|
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(ConversationsMessageFileImageInfo, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,340 |
sib_api_v3_sdk.models.create_api_key_request
|
CreateApiKeyRequest
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateApiKeyRequest(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 = {
'id': 'int',
'name': 'str'
}
attribute_map = {
'id': 'id',
'name': 'name'
}
def __init__(self, id=None, name=None): # noqa: E501
"""CreateApiKeyRequest - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self.discriminator = None
self.id = id
if name is not None:
self.name = name
@property
def id(self):
"""Gets the id of this CreateApiKeyRequest. # noqa: E501
Id of the sub-account organization # noqa: E501
:return: The id of this CreateApiKeyRequest. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this CreateApiKeyRequest.
Id of the sub-account organization # noqa: E501
:param id: The id of this CreateApiKeyRequest. # noqa: E501
:type: int
"""
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@property
def name(self):
"""Gets the name of this CreateApiKeyRequest. # noqa: E501
Name of the API key # noqa: E501
:return: The name of this CreateApiKeyRequest. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this CreateApiKeyRequest.
Name of the API key # noqa: E501
:param name: The name of this CreateApiKeyRequest. # 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(CreateApiKeyRequest, 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, CreateApiKeyRequest):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(id=None, name=None)
|
58,341 |
sib_api_v3_sdk.models.create_api_key_request
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateApiKeyRequest):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,342 |
sib_api_v3_sdk.models.create_api_key_request
|
__init__
|
CreateApiKeyRequest - a model defined in Swagger
|
def __init__(self, id=None, name=None): # noqa: E501
"""CreateApiKeyRequest - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self.discriminator = None
self.id = id
if name is not None:
self.name = name
|
(self, id=None, name=None)
|
58,345 |
sib_api_v3_sdk.models.create_api_key_request
|
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(CreateApiKeyRequest, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,347 |
sib_api_v3_sdk.models.create_api_key_response
|
CreateApiKeyResponse
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateApiKeyResponse(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'status': 'str',
'key': 'str'
}
attribute_map = {
'status': 'status',
'key': 'key'
}
def __init__(self, status=None, key=None): # noqa: E501
"""CreateApiKeyResponse - a model defined in Swagger""" # noqa: E501
self._status = None
self._key = None
self.discriminator = None
if status is not None:
self.status = status
if key is not None:
self.key = key
@property
def status(self):
"""Gets the status of this CreateApiKeyResponse. # noqa: E501
Status of the API operation. # noqa: E501
:return: The status of this CreateApiKeyResponse. # noqa: E501
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""Sets the status of this CreateApiKeyResponse.
Status of the API operation. # noqa: E501
:param status: The status of this CreateApiKeyResponse. # noqa: E501
:type: str
"""
self._status = status
@property
def key(self):
"""Gets the key of this CreateApiKeyResponse. # noqa: E501
API Key # noqa: E501
:return: The key of this CreateApiKeyResponse. # noqa: E501
:rtype: str
"""
return self._key
@key.setter
def key(self, key):
"""Sets the key of this CreateApiKeyResponse.
API Key # noqa: E501
:param key: The key of this CreateApiKeyResponse. # noqa: E501
:type: str
"""
self._key = key
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(CreateApiKeyResponse, 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, CreateApiKeyResponse):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(status=None, key=None)
|
58,348 |
sib_api_v3_sdk.models.create_api_key_response
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateApiKeyResponse):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,349 |
sib_api_v3_sdk.models.create_api_key_response
|
__init__
|
CreateApiKeyResponse - a model defined in Swagger
|
def __init__(self, status=None, key=None): # noqa: E501
"""CreateApiKeyResponse - a model defined in Swagger""" # noqa: E501
self._status = None
self._key = None
self.discriminator = None
if status is not None:
self.status = status
if key is not None:
self.key = key
|
(self, status=None, key=None)
|
58,352 |
sib_api_v3_sdk.models.create_api_key_response
|
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(CreateApiKeyResponse, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,354 |
sib_api_v3_sdk.models.create_attribute
|
CreateAttribute
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateAttribute(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'value': 'str',
'is_recurring': 'bool',
'enumeration': 'list[CreateAttributeEnumeration]',
'type': 'str'
}
attribute_map = {
'value': 'value',
'is_recurring': 'isRecurring',
'enumeration': 'enumeration',
'type': 'type'
}
def __init__(self, value=None, is_recurring=None, enumeration=None, type=None): # noqa: E501
"""CreateAttribute - a model defined in Swagger""" # noqa: E501
self._value = None
self._is_recurring = None
self._enumeration = None
self._type = None
self.discriminator = None
if value is not None:
self.value = value
if is_recurring is not None:
self.is_recurring = is_recurring
if enumeration is not None:
self.enumeration = enumeration
if type is not None:
self.type = type
@property
def value(self):
"""Gets the value of this CreateAttribute. # noqa: E501
Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' # noqa: E501
:return: The value of this CreateAttribute. # noqa: E501
:rtype: str
"""
return self._value
@value.setter
def value(self, value):
"""Sets the value of this CreateAttribute.
Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' # noqa: E501
:param value: The value of this CreateAttribute. # noqa: E501
:type: str
"""
self._value = value
@property
def is_recurring(self):
"""Gets the is_recurring of this CreateAttribute. # noqa: E501
Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' # noqa: E501
:return: The is_recurring of this CreateAttribute. # noqa: E501
:rtype: bool
"""
return self._is_recurring
@is_recurring.setter
def is_recurring(self, is_recurring):
"""Sets the is_recurring of this CreateAttribute.
Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' # noqa: E501
:param is_recurring: The is_recurring of this CreateAttribute. # noqa: E501
:type: bool
"""
self._is_recurring = is_recurring
@property
def enumeration(self):
"""Gets the enumeration of this CreateAttribute. # noqa: E501
List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501
:return: The enumeration of this CreateAttribute. # noqa: E501
:rtype: list[CreateAttributeEnumeration]
"""
return self._enumeration
@enumeration.setter
def enumeration(self, enumeration):
"""Sets the enumeration of this CreateAttribute.
List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] # noqa: E501
:param enumeration: The enumeration of this CreateAttribute. # noqa: E501
:type: list[CreateAttributeEnumeration]
"""
self._enumeration = enumeration
@property
def type(self):
"""Gets the type of this CreateAttribute. # noqa: E501
Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) # noqa: E501
:return: The type of this CreateAttribute. # noqa: E501
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""Sets the type of this CreateAttribute.
Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) # noqa: E501
:param type: The type of this CreateAttribute. # noqa: E501
:type: str
"""
allowed_values = ["text", "date", "float", "boolean", "id", "category"] # 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
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(CreateAttribute, 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, CreateAttribute):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(value=None, is_recurring=None, enumeration=None, type=None)
|
58,355 |
sib_api_v3_sdk.models.create_attribute
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateAttribute):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,356 |
sib_api_v3_sdk.models.create_attribute
|
__init__
|
CreateAttribute - a model defined in Swagger
|
def __init__(self, value=None, is_recurring=None, enumeration=None, type=None): # noqa: E501
"""CreateAttribute - a model defined in Swagger""" # noqa: E501
self._value = None
self._is_recurring = None
self._enumeration = None
self._type = None
self.discriminator = None
if value is not None:
self.value = value
if is_recurring is not None:
self.is_recurring = is_recurring
if enumeration is not None:
self.enumeration = enumeration
if type is not None:
self.type = type
|
(self, value=None, is_recurring=None, enumeration=None, type=None)
|
58,359 |
sib_api_v3_sdk.models.create_attribute
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateAttribute, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,361 |
sib_api_v3_sdk.models.create_attribute_enumeration
|
CreateAttributeEnumeration
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateAttributeEnumeration(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'value': 'int',
'label': 'str'
}
attribute_map = {
'value': 'value',
'label': 'label'
}
def __init__(self, value=None, label=None): # noqa: E501
"""CreateAttributeEnumeration - a model defined in Swagger""" # noqa: E501
self._value = None
self._label = None
self.discriminator = None
self.value = value
self.label = label
@property
def value(self):
"""Gets the value of this CreateAttributeEnumeration. # noqa: E501
Id of the value # noqa: E501
:return: The value of this CreateAttributeEnumeration. # noqa: E501
:rtype: int
"""
return self._value
@value.setter
def value(self, value):
"""Sets the value of this CreateAttributeEnumeration.
Id of the value # noqa: E501
:param value: The value of this CreateAttributeEnumeration. # noqa: E501
:type: int
"""
if value is None:
raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501
self._value = value
@property
def label(self):
"""Gets the label of this CreateAttributeEnumeration. # noqa: E501
Label of the value # noqa: E501
:return: The label of this CreateAttributeEnumeration. # noqa: E501
:rtype: str
"""
return self._label
@label.setter
def label(self, label):
"""Sets the label of this CreateAttributeEnumeration.
Label of the value # noqa: E501
:param label: The label of this CreateAttributeEnumeration. # noqa: E501
:type: str
"""
if label is None:
raise ValueError("Invalid value for `label`, must not be `None`") # noqa: E501
self._label = label
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateAttributeEnumeration, 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, CreateAttributeEnumeration):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(value=None, label=None)
|
58,362 |
sib_api_v3_sdk.models.create_attribute_enumeration
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateAttributeEnumeration):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,363 |
sib_api_v3_sdk.models.create_attribute_enumeration
|
__init__
|
CreateAttributeEnumeration - a model defined in Swagger
|
def __init__(self, value=None, label=None): # noqa: E501
"""CreateAttributeEnumeration - a model defined in Swagger""" # noqa: E501
self._value = None
self._label = None
self.discriminator = None
self.value = value
self.label = label
|
(self, value=None, label=None)
|
58,366 |
sib_api_v3_sdk.models.create_attribute_enumeration
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateAttributeEnumeration, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,368 |
sib_api_v3_sdk.models.create_category_model
|
CreateCategoryModel
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateCategoryModel(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 = {
'id': 'int'
}
attribute_map = {
'id': 'id'
}
def __init__(self, id=None): # noqa: E501
"""CreateCategoryModel - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
if id is not None:
self.id = id
@property
def id(self):
"""Gets the id of this CreateCategoryModel. # noqa: E501
ID of the category when a new category is created # noqa: E501
:return: The id of this CreateCategoryModel. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this CreateCategoryModel.
ID of the category when a new category is created # noqa: E501
:param id: The id of this CreateCategoryModel. # 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(CreateCategoryModel, 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, CreateCategoryModel):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(id=None)
|
58,369 |
sib_api_v3_sdk.models.create_category_model
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateCategoryModel):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,370 |
sib_api_v3_sdk.models.create_category_model
|
__init__
|
CreateCategoryModel - a model defined in Swagger
|
def __init__(self, id=None): # noqa: E501
"""CreateCategoryModel - a model defined in Swagger""" # noqa: E501
self._id = None
self.discriminator = None
if id is not None:
self.id = id
|
(self, id=None)
|
58,373 |
sib_api_v3_sdk.models.create_category_model
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateCategoryModel, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,375 |
sib_api_v3_sdk.models.create_child
|
CreateChild
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateChild(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
"""
"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'email': 'str',
'first_name': 'str',
'last_name': 'str',
'company_name': 'str',
'password': 'str',
'language': 'str'
}
attribute_map = {
'email': 'email',
'first_name': 'firstName',
'last_name': 'lastName',
'company_name': 'companyName',
'password': 'password',
'language': 'language'
}
def __init__(self, email=None, first_name=None, last_name=None, company_name=None, password=None, language=None): # noqa: E501
"""CreateChild - a model defined in Swagger""" # noqa: E501
self._email = None
self._first_name = None
self._last_name = None
self._company_name = None
self._password = None
self._language = None
self.discriminator = None
self.email = email
self.first_name = first_name
self.last_name = last_name
self.company_name = company_name
self.password = password
if language is not None:
self.language = language
@property
def email(self):
"""Gets the email of this CreateChild. # noqa: E501
Email address to create the child account # noqa: E501
:return: The email of this CreateChild. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this CreateChild.
Email address to create the child account # noqa: E501
:param email: The email of this CreateChild. # 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 first_name(self):
"""Gets the first_name of this CreateChild. # noqa: E501
First name to use to create the child account # noqa: E501
:return: The first_name of this CreateChild. # noqa: E501
:rtype: str
"""
return self._first_name
@first_name.setter
def first_name(self, first_name):
"""Sets the first_name of this CreateChild.
First name to use to create the child account # noqa: E501
:param first_name: The first_name of this CreateChild. # noqa: E501
:type: str
"""
if first_name is None:
raise ValueError("Invalid value for `first_name`, must not be `None`") # noqa: E501
self._first_name = first_name
@property
def last_name(self):
"""Gets the last_name of this CreateChild. # noqa: E501
Last name to use to create the child account # noqa: E501
:return: The last_name of this CreateChild. # noqa: E501
:rtype: str
"""
return self._last_name
@last_name.setter
def last_name(self, last_name):
"""Sets the last_name of this CreateChild.
Last name to use to create the child account # noqa: E501
:param last_name: The last_name of this CreateChild. # noqa: E501
:type: str
"""
if last_name is None:
raise ValueError("Invalid value for `last_name`, must not be `None`") # noqa: E501
self._last_name = last_name
@property
def company_name(self):
"""Gets the company_name of this CreateChild. # noqa: E501
Company name to use to create the child account # noqa: E501
:return: The company_name of this CreateChild. # noqa: E501
:rtype: str
"""
return self._company_name
@company_name.setter
def company_name(self, company_name):
"""Sets the company_name of this CreateChild.
Company name to use to create the child account # noqa: E501
:param company_name: The company_name of this CreateChild. # noqa: E501
:type: str
"""
if company_name is None:
raise ValueError("Invalid value for `company_name`, must not be `None`") # noqa: E501
self._company_name = company_name
@property
def password(self):
"""Gets the password of this CreateChild. # noqa: E501
Password for the child account to login # noqa: E501
:return: The password of this CreateChild. # noqa: E501
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""Sets the password of this CreateChild.
Password for the child account to login # noqa: E501
:param password: The password of this CreateChild. # noqa: E501
:type: str
"""
if password is None:
raise ValueError("Invalid value for `password`, must not be `None`") # noqa: E501
self._password = password
@property
def language(self):
"""Gets the language of this CreateChild. # noqa: E501
Language of the child account # noqa: E501
:return: The language of this CreateChild. # noqa: E501
:rtype: str
"""
return self._language
@language.setter
def language(self, language):
"""Sets the language of this CreateChild.
Language of the child account # noqa: E501
:param language: The language of this CreateChild. # 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
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(CreateChild, 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, CreateChild):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(email=None, first_name=None, last_name=None, company_name=None, password=None, language=None)
|
58,376 |
sib_api_v3_sdk.models.create_child
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateChild):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,377 |
sib_api_v3_sdk.models.create_child
|
__init__
|
CreateChild - a model defined in Swagger
|
def __init__(self, email=None, first_name=None, last_name=None, company_name=None, password=None, language=None): # noqa: E501
"""CreateChild - a model defined in Swagger""" # noqa: E501
self._email = None
self._first_name = None
self._last_name = None
self._company_name = None
self._password = None
self._language = None
self.discriminator = None
self.email = email
self.first_name = first_name
self.last_name = last_name
self.company_name = company_name
self.password = password
if language is not None:
self.language = language
|
(self, email=None, first_name=None, last_name=None, company_name=None, password=None, language=None)
|
58,380 |
sib_api_v3_sdk.models.create_child
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateChild, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,382 |
sib_api_v3_sdk.models.create_contact
|
CreateContact
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateContact(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',
'ext_id': 'str',
'attributes': 'object',
'email_blacklisted': 'bool',
'sms_blacklisted': 'bool',
'list_ids': 'list[int]',
'update_enabled': 'bool',
'smtp_blacklist_sender': 'list[str]'
}
attribute_map = {
'email': 'email',
'ext_id': 'ext_id',
'attributes': 'attributes',
'email_blacklisted': 'emailBlacklisted',
'sms_blacklisted': 'smsBlacklisted',
'list_ids': 'listIds',
'update_enabled': 'updateEnabled',
'smtp_blacklist_sender': 'smtpBlacklistSender'
}
def __init__(self, email=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, update_enabled=False, smtp_blacklist_sender=None): # noqa: E501
"""CreateContact - a model defined in Swagger""" # noqa: E501
self._email = None
self._ext_id = None
self._attributes = None
self._email_blacklisted = None
self._sms_blacklisted = None
self._list_ids = None
self._update_enabled = None
self._smtp_blacklist_sender = None
self.discriminator = None
if email is not None:
self.email = email
if ext_id is not None:
self.ext_id = ext_id
if attributes is not None:
self.attributes = attributes
if email_blacklisted is not None:
self.email_blacklisted = email_blacklisted
if sms_blacklisted is not None:
self.sms_blacklisted = sms_blacklisted
if list_ids is not None:
self.list_ids = list_ids
if update_enabled is not None:
self.update_enabled = update_enabled
if smtp_blacklist_sender is not None:
self.smtp_blacklist_sender = smtp_blacklist_sender
@property
def email(self):
"""Gets the email of this CreateContact. # noqa: E501
Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501
:return: The email of this CreateContact. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this CreateContact.
Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} # noqa: E501
:param email: The email of this CreateContact. # noqa: E501
:type: str
"""
self._email = email
@property
def ext_id(self):
"""Gets the ext_id of this CreateContact. # noqa: E501
Pass your own Id to create a contact. # noqa: E501
:return: The ext_id of this CreateContact. # noqa: E501
:rtype: str
"""
return self._ext_id
@ext_id.setter
def ext_id(self, ext_id):
"""Sets the ext_id of this CreateContact.
Pass your own Id to create a contact. # noqa: E501
:param ext_id: The ext_id of this CreateContact. # noqa: E501
:type: str
"""
self._ext_id = ext_id
@property
def attributes(self):
"""Gets the attributes of this CreateContact. # noqa: E501
Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} # noqa: E501
:return: The attributes of this CreateContact. # noqa: E501
:rtype: object
"""
return self._attributes
@attributes.setter
def attributes(self, attributes):
"""Sets the attributes of this CreateContact.
Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} # noqa: E501
:param attributes: The attributes of this CreateContact. # noqa: E501
:type: object
"""
self._attributes = attributes
@property
def email_blacklisted(self):
"""Gets the email_blacklisted of this CreateContact. # noqa: E501
Set this field to blacklist the contact for emails (emailBlacklisted = true) # noqa: E501
:return: The email_blacklisted of this CreateContact. # noqa: E501
:rtype: bool
"""
return self._email_blacklisted
@email_blacklisted.setter
def email_blacklisted(self, email_blacklisted):
"""Sets the email_blacklisted of this CreateContact.
Set this field to blacklist the contact for emails (emailBlacklisted = true) # noqa: E501
:param email_blacklisted: The email_blacklisted of this CreateContact. # noqa: E501
:type: bool
"""
self._email_blacklisted = email_blacklisted
@property
def sms_blacklisted(self):
"""Gets the sms_blacklisted of this CreateContact. # noqa: E501
Set this field to blacklist the contact for SMS (smsBlacklisted = true) # noqa: E501
:return: The sms_blacklisted of this CreateContact. # noqa: E501
:rtype: bool
"""
return self._sms_blacklisted
@sms_blacklisted.setter
def sms_blacklisted(self, sms_blacklisted):
"""Sets the sms_blacklisted of this CreateContact.
Set this field to blacklist the contact for SMS (smsBlacklisted = true) # noqa: E501
:param sms_blacklisted: The sms_blacklisted of this CreateContact. # noqa: E501
:type: bool
"""
self._sms_blacklisted = sms_blacklisted
@property
def list_ids(self):
"""Gets the list_ids of this CreateContact. # noqa: E501
Ids of the lists to add the contact to # noqa: E501
:return: The list_ids of this CreateContact. # noqa: E501
:rtype: list[int]
"""
return self._list_ids
@list_ids.setter
def list_ids(self, list_ids):
"""Sets the list_ids of this CreateContact.
Ids of the lists to add the contact to # noqa: E501
:param list_ids: The list_ids of this CreateContact. # noqa: E501
:type: list[int]
"""
self._list_ids = list_ids
@property
def update_enabled(self):
"""Gets the update_enabled of this CreateContact. # noqa: E501
Facilitate to update the existing contact in the same request (updateEnabled = true) # noqa: E501
:return: The update_enabled of this CreateContact. # noqa: E501
:rtype: bool
"""
return self._update_enabled
@update_enabled.setter
def update_enabled(self, update_enabled):
"""Sets the update_enabled of this CreateContact.
Facilitate to update the existing contact in the same request (updateEnabled = true) # noqa: E501
:param update_enabled: The update_enabled of this CreateContact. # noqa: E501
:type: bool
"""
self._update_enabled = update_enabled
@property
def smtp_blacklist_sender(self):
"""Gets the smtp_blacklist_sender of this CreateContact. # noqa: E501
transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) # noqa: E501
:return: The smtp_blacklist_sender of this CreateContact. # noqa: E501
:rtype: list[str]
"""
return self._smtp_blacklist_sender
@smtp_blacklist_sender.setter
def smtp_blacklist_sender(self, smtp_blacklist_sender):
"""Sets the smtp_blacklist_sender of this CreateContact.
transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) # noqa: E501
:param smtp_blacklist_sender: The smtp_blacklist_sender of this CreateContact. # noqa: E501
:type: list[str]
"""
self._smtp_blacklist_sender = smtp_blacklist_sender
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateContact, 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, CreateContact):
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, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, update_enabled=False, smtp_blacklist_sender=None)
|
58,383 |
sib_api_v3_sdk.models.create_contact
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateContact):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,384 |
sib_api_v3_sdk.models.create_contact
|
__init__
|
CreateContact - a model defined in Swagger
|
def __init__(self, email=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, update_enabled=False, smtp_blacklist_sender=None): # noqa: E501
"""CreateContact - a model defined in Swagger""" # noqa: E501
self._email = None
self._ext_id = None
self._attributes = None
self._email_blacklisted = None
self._sms_blacklisted = None
self._list_ids = None
self._update_enabled = None
self._smtp_blacklist_sender = None
self.discriminator = None
if email is not None:
self.email = email
if ext_id is not None:
self.ext_id = ext_id
if attributes is not None:
self.attributes = attributes
if email_blacklisted is not None:
self.email_blacklisted = email_blacklisted
if sms_blacklisted is not None:
self.sms_blacklisted = sms_blacklisted
if list_ids is not None:
self.list_ids = list_ids
if update_enabled is not None:
self.update_enabled = update_enabled
if smtp_blacklist_sender is not None:
self.smtp_blacklist_sender = smtp_blacklist_sender
|
(self, email=None, ext_id=None, attributes=None, email_blacklisted=None, sms_blacklisted=None, list_ids=None, update_enabled=False, smtp_blacklist_sender=None)
|
58,387 |
sib_api_v3_sdk.models.create_contact
|
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(CreateContact, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,389 |
sib_api_v3_sdk.models.create_doi_contact
|
CreateDoiContact
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateDoiContact(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',
'attributes': 'object',
'include_list_ids': 'list[int]',
'exclude_list_ids': 'list[int]',
'template_id': 'int',
'redirection_url': 'str'
}
attribute_map = {
'email': 'email',
'attributes': 'attributes',
'include_list_ids': 'includeListIds',
'exclude_list_ids': 'excludeListIds',
'template_id': 'templateId',
'redirection_url': 'redirectionUrl'
}
def __init__(self, email=None, attributes=None, include_list_ids=None, exclude_list_ids=None, template_id=None, redirection_url=None): # noqa: E501
"""CreateDoiContact - a model defined in Swagger""" # noqa: E501
self._email = None
self._attributes = None
self._include_list_ids = None
self._exclude_list_ids = None
self._template_id = None
self._redirection_url = None
self.discriminator = None
self.email = email
if attributes is not None:
self.attributes = attributes
self.include_list_ids = include_list_ids
if exclude_list_ids is not None:
self.exclude_list_ids = exclude_list_ids
self.template_id = template_id
self.redirection_url = redirection_url
@property
def email(self):
"""Gets the email of this CreateDoiContact. # noqa: E501
Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. # noqa: E501
:return: The email of this CreateDoiContact. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this CreateDoiContact.
Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. # noqa: E501
:param email: The email of this CreateDoiContact. # 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 attributes(self):
"""Gets the attributes of this CreateDoiContact. # noqa: E501
Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} # noqa: E501
:return: The attributes of this CreateDoiContact. # noqa: E501
:rtype: object
"""
return self._attributes
@attributes.setter
def attributes(self, attributes):
"""Sets the attributes of this CreateDoiContact.
Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} # noqa: E501
:param attributes: The attributes of this CreateDoiContact. # noqa: E501
:type: object
"""
self._attributes = attributes
@property
def include_list_ids(self):
"""Gets the include_list_ids of this CreateDoiContact. # noqa: E501
Lists under user account where contact should be added # noqa: E501
:return: The include_list_ids of this CreateDoiContact. # noqa: E501
:rtype: list[int]
"""
return self._include_list_ids
@include_list_ids.setter
def include_list_ids(self, include_list_ids):
"""Sets the include_list_ids of this CreateDoiContact.
Lists under user account where contact should be added # noqa: E501
:param include_list_ids: The include_list_ids of this CreateDoiContact. # noqa: E501
:type: list[int]
"""
if include_list_ids is None:
raise ValueError("Invalid value for `include_list_ids`, must not be `None`") # noqa: E501
self._include_list_ids = include_list_ids
@property
def exclude_list_ids(self):
"""Gets the exclude_list_ids of this CreateDoiContact. # noqa: E501
Lists under user account where contact should not be added # noqa: E501
:return: The exclude_list_ids of this CreateDoiContact. # noqa: E501
:rtype: list[int]
"""
return self._exclude_list_ids
@exclude_list_ids.setter
def exclude_list_ids(self, exclude_list_ids):
"""Sets the exclude_list_ids of this CreateDoiContact.
Lists under user account where contact should not be added # noqa: E501
:param exclude_list_ids: The exclude_list_ids of this CreateDoiContact. # noqa: E501
:type: list[int]
"""
self._exclude_list_ids = exclude_list_ids
@property
def template_id(self):
"""Gets the template_id of this CreateDoiContact. # noqa: E501
Id of the Double opt-in (DOI) template # noqa: E501
:return: The template_id of this CreateDoiContact. # noqa: E501
:rtype: int
"""
return self._template_id
@template_id.setter
def template_id(self, template_id):
"""Sets the template_id of this CreateDoiContact.
Id of the Double opt-in (DOI) template # noqa: E501
:param template_id: The template_id of this CreateDoiContact. # noqa: E501
:type: int
"""
if template_id is None:
raise ValueError("Invalid value for `template_id`, must not be `None`") # noqa: E501
self._template_id = template_id
@property
def redirection_url(self):
"""Gets the redirection_url of this CreateDoiContact. # noqa: E501
URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. # noqa: E501
:return: The redirection_url of this CreateDoiContact. # noqa: E501
:rtype: str
"""
return self._redirection_url
@redirection_url.setter
def redirection_url(self, redirection_url):
"""Sets the redirection_url of this CreateDoiContact.
URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. # noqa: E501
:param redirection_url: The redirection_url of this CreateDoiContact. # noqa: E501
:type: str
"""
if redirection_url is None:
raise ValueError("Invalid value for `redirection_url`, must not be `None`") # noqa: E501
self._redirection_url = redirection_url
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(CreateDoiContact, 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, CreateDoiContact):
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, attributes=None, include_list_ids=None, exclude_list_ids=None, template_id=None, redirection_url=None)
|
58,390 |
sib_api_v3_sdk.models.create_doi_contact
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateDoiContact):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,391 |
sib_api_v3_sdk.models.create_doi_contact
|
__init__
|
CreateDoiContact - a model defined in Swagger
|
def __init__(self, email=None, attributes=None, include_list_ids=None, exclude_list_ids=None, template_id=None, redirection_url=None): # noqa: E501
"""CreateDoiContact - a model defined in Swagger""" # noqa: E501
self._email = None
self._attributes = None
self._include_list_ids = None
self._exclude_list_ids = None
self._template_id = None
self._redirection_url = None
self.discriminator = None
self.email = email
if attributes is not None:
self.attributes = attributes
self.include_list_ids = include_list_ids
if exclude_list_ids is not None:
self.exclude_list_ids = exclude_list_ids
self.template_id = template_id
self.redirection_url = redirection_url
|
(self, email=None, attributes=None, include_list_ids=None, exclude_list_ids=None, template_id=None, redirection_url=None)
|
58,394 |
sib_api_v3_sdk.models.create_doi_contact
|
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(CreateDoiContact, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,396 |
sib_api_v3_sdk.models.create_email_campaign
|
CreateEmailCampaign
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateEmailCampaign(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 = {
'tag': 'str',
'sender': 'CreateEmailCampaignSender',
'name': 'str',
'html_content': 'str',
'html_url': 'str',
'template_id': 'int',
'scheduled_at': 'str',
'subject': 'str',
'reply_to': 'str',
'to_field': 'str',
'recipients': 'CreateEmailCampaignRecipients',
'attachment_url': 'str',
'inline_image_activation': 'bool',
'mirror_active': 'bool',
'footer': 'str',
'header': 'str',
'utm_campaign': 'str',
'params': 'object',
'send_at_best_time': 'bool',
'ab_testing': 'bool',
'subject_a': 'str',
'subject_b': 'str',
'split_rule': 'int',
'winner_criteria': 'str',
'winner_delay': 'int',
'ip_warmup_enable': 'bool',
'initial_quota': 'int',
'increase_rate': 'int',
'unsubscription_page_id': 'str',
'update_form_id': 'str'
}
attribute_map = {
'tag': 'tag',
'sender': 'sender',
'name': 'name',
'html_content': 'htmlContent',
'html_url': 'htmlUrl',
'template_id': 'templateId',
'scheduled_at': 'scheduledAt',
'subject': 'subject',
'reply_to': 'replyTo',
'to_field': 'toField',
'recipients': 'recipients',
'attachment_url': 'attachmentUrl',
'inline_image_activation': 'inlineImageActivation',
'mirror_active': 'mirrorActive',
'footer': 'footer',
'header': 'header',
'utm_campaign': 'utmCampaign',
'params': 'params',
'send_at_best_time': 'sendAtBestTime',
'ab_testing': 'abTesting',
'subject_a': 'subjectA',
'subject_b': 'subjectB',
'split_rule': 'splitRule',
'winner_criteria': 'winnerCriteria',
'winner_delay': 'winnerDelay',
'ip_warmup_enable': 'ipWarmupEnable',
'initial_quota': 'initialQuota',
'increase_rate': 'increaseRate',
'unsubscription_page_id': 'unsubscriptionPageId',
'update_form_id': 'updateFormId'
}
def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None): # noqa: E501
"""CreateEmailCampaign - a model defined in Swagger""" # noqa: E501
self._tag = None
self._sender = None
self._name = None
self._html_content = None
self._html_url = None
self._template_id = None
self._scheduled_at = None
self._subject = None
self._reply_to = None
self._to_field = None
self._recipients = None
self._attachment_url = None
self._inline_image_activation = None
self._mirror_active = None
self._footer = None
self._header = None
self._utm_campaign = None
self._params = None
self._send_at_best_time = None
self._ab_testing = None
self._subject_a = None
self._subject_b = None
self._split_rule = None
self._winner_criteria = None
self._winner_delay = None
self._ip_warmup_enable = None
self._initial_quota = None
self._increase_rate = None
self._unsubscription_page_id = None
self._update_form_id = None
self.discriminator = None
if tag is not None:
self.tag = tag
self.sender = sender
self.name = name
if html_content is not None:
self.html_content = html_content
if html_url is not None:
self.html_url = html_url
if template_id is not None:
self.template_id = template_id
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if to_field is not None:
self.to_field = to_field
if recipients is not None:
self.recipients = recipients
if attachment_url is not None:
self.attachment_url = attachment_url
if inline_image_activation is not None:
self.inline_image_activation = inline_image_activation
if mirror_active is not None:
self.mirror_active = mirror_active
if footer is not None:
self.footer = footer
if header is not None:
self.header = header
if utm_campaign is not None:
self.utm_campaign = utm_campaign
if params is not None:
self.params = params
if send_at_best_time is not None:
self.send_at_best_time = send_at_best_time
if ab_testing is not None:
self.ab_testing = ab_testing
if subject_a is not None:
self.subject_a = subject_a
if subject_b is not None:
self.subject_b = subject_b
if split_rule is not None:
self.split_rule = split_rule
if winner_criteria is not None:
self.winner_criteria = winner_criteria
if winner_delay is not None:
self.winner_delay = winner_delay
if ip_warmup_enable is not None:
self.ip_warmup_enable = ip_warmup_enable
if initial_quota is not None:
self.initial_quota = initial_quota
if increase_rate is not None:
self.increase_rate = increase_rate
if unsubscription_page_id is not None:
self.unsubscription_page_id = unsubscription_page_id
if update_form_id is not None:
self.update_form_id = update_form_id
@property
def tag(self):
"""Gets the tag of this CreateEmailCampaign. # noqa: E501
Tag of the campaign # noqa: E501
:return: The tag of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._tag
@tag.setter
def tag(self, tag):
"""Sets the tag of this CreateEmailCampaign.
Tag of the campaign # noqa: E501
:param tag: The tag of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._tag = tag
@property
def sender(self):
"""Gets the sender of this CreateEmailCampaign. # noqa: E501
:return: The sender of this CreateEmailCampaign. # noqa: E501
:rtype: CreateEmailCampaignSender
"""
return self._sender
@sender.setter
def sender(self, sender):
"""Sets the sender of this CreateEmailCampaign.
:param sender: The sender of this CreateEmailCampaign. # noqa: E501
:type: CreateEmailCampaignSender
"""
if sender is None:
raise ValueError("Invalid value for `sender`, must not be `None`") # noqa: E501
self._sender = sender
@property
def name(self):
"""Gets the name of this CreateEmailCampaign. # noqa: E501
Name of the campaign # noqa: E501
:return: The name of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this CreateEmailCampaign.
Name of the campaign # noqa: E501
:param name: The name of this CreateEmailCampaign. # noqa: E501
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501
self._name = name
@property
def html_content(self):
"""Gets the html_content of this CreateEmailCampaign. # noqa: E501
Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) # noqa: E501
:return: The html_content of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._html_content
@html_content.setter
def html_content(self, html_content):
"""Sets the html_content of this CreateEmailCampaign.
Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) # noqa: E501
:param html_content: The html_content of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._html_content = html_content
@property
def html_url(self):
"""Gets the html_url of this CreateEmailCampaign. # noqa: E501
Mandatory if htmlContent and templateId are empty. Url to the message (HTML) # noqa: E501
:return: The html_url of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._html_url
@html_url.setter
def html_url(self, html_url):
"""Sets the html_url of this CreateEmailCampaign.
Mandatory if htmlContent and templateId are empty. Url to the message (HTML) # noqa: E501
:param html_url: The html_url of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._html_url = html_url
@property
def template_id(self):
"""Gets the template_id of this CreateEmailCampaign. # noqa: E501
Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. # noqa: E501
:return: The template_id of this CreateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._template_id
@template_id.setter
def template_id(self, template_id):
"""Sets the template_id of this CreateEmailCampaign.
Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. # noqa: E501
:param template_id: The template_id of this CreateEmailCampaign. # noqa: E501
:type: int
"""
self._template_id = template_id
@property
def scheduled_at(self):
"""Gets the scheduled_at of this CreateEmailCampaign. # noqa: E501
Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). # noqa: E501
:return: The scheduled_at of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._scheduled_at
@scheduled_at.setter
def scheduled_at(self, scheduled_at):
"""Sets the scheduled_at of this CreateEmailCampaign.
Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). # noqa: E501
:param scheduled_at: The scheduled_at of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._scheduled_at = scheduled_at
@property
def subject(self):
"""Gets the subject of this CreateEmailCampaign. # noqa: E501
Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. # noqa: E501
:return: The subject of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this CreateEmailCampaign.
Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. # noqa: E501
:param subject: The subject of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._subject = subject
@property
def reply_to(self):
"""Gets the reply_to of this CreateEmailCampaign. # noqa: E501
Email on which the campaign recipients will be able to reply to # noqa: E501
:return: The reply_to of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._reply_to
@reply_to.setter
def reply_to(self, reply_to):
"""Sets the reply_to of this CreateEmailCampaign.
Email on which the campaign recipients will be able to reply to # noqa: E501
:param reply_to: The reply_to of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._reply_to = reply_to
@property
def to_field(self):
"""Gets the to_field of this CreateEmailCampaign. # noqa: E501
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501
:return: The to_field of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._to_field
@to_field.setter
def to_field(self, to_field):
"""Sets the to_field of this CreateEmailCampaign.
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501
:param to_field: The to_field of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._to_field = to_field
@property
def recipients(self):
"""Gets the recipients of this CreateEmailCampaign. # noqa: E501
:return: The recipients of this CreateEmailCampaign. # noqa: E501
:rtype: CreateEmailCampaignRecipients
"""
return self._recipients
@recipients.setter
def recipients(self, recipients):
"""Sets the recipients of this CreateEmailCampaign.
:param recipients: The recipients of this CreateEmailCampaign. # noqa: E501
:type: CreateEmailCampaignRecipients
"""
self._recipients = recipients
@property
def attachment_url(self):
"""Gets the attachment_url of this CreateEmailCampaign. # noqa: E501
Absolute url of the attachment (no local file). Extension allowed: 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 and eps # noqa: E501
:return: The attachment_url of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._attachment_url
@attachment_url.setter
def attachment_url(self, attachment_url):
"""Sets the attachment_url of this CreateEmailCampaign.
Absolute url of the attachment (no local file). Extension allowed: 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 and eps # noqa: E501
:param attachment_url: The attachment_url of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._attachment_url = attachment_url
@property
def inline_image_activation(self):
"""Gets the inline_image_activation of this CreateEmailCampaign. # noqa: E501
Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts # noqa: E501
:return: The inline_image_activation of this CreateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._inline_image_activation
@inline_image_activation.setter
def inline_image_activation(self, inline_image_activation):
"""Sets the inline_image_activation of this CreateEmailCampaign.
Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts # noqa: E501
:param inline_image_activation: The inline_image_activation of this CreateEmailCampaign. # noqa: E501
:type: bool
"""
self._inline_image_activation = inline_image_activation
@property
def mirror_active(self):
"""Gets the mirror_active of this CreateEmailCampaign. # noqa: E501
Use true to enable the mirror link # noqa: E501
:return: The mirror_active of this CreateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._mirror_active
@mirror_active.setter
def mirror_active(self, mirror_active):
"""Sets the mirror_active of this CreateEmailCampaign.
Use true to enable the mirror link # noqa: E501
:param mirror_active: The mirror_active of this CreateEmailCampaign. # noqa: E501
:type: bool
"""
self._mirror_active = mirror_active
@property
def footer(self):
"""Gets the footer of this CreateEmailCampaign. # noqa: E501
Footer of the email campaign # noqa: E501
:return: The footer of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._footer
@footer.setter
def footer(self, footer):
"""Sets the footer of this CreateEmailCampaign.
Footer of the email campaign # noqa: E501
:param footer: The footer of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._footer = footer
@property
def header(self):
"""Gets the header of this CreateEmailCampaign. # noqa: E501
Header of the email campaign # noqa: E501
:return: The header of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._header
@header.setter
def header(self, header):
"""Sets the header of this CreateEmailCampaign.
Header of the email campaign # noqa: E501
:param header: The header of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._header = header
@property
def utm_campaign(self):
"""Gets the utm_campaign of this CreateEmailCampaign. # noqa: E501
Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed # noqa: E501
:return: The utm_campaign of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._utm_campaign
@utm_campaign.setter
def utm_campaign(self, utm_campaign):
"""Sets the utm_campaign of this CreateEmailCampaign.
Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed # noqa: E501
:param utm_campaign: The utm_campaign of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._utm_campaign = utm_campaign
@property
def params(self):
"""Gets the params of this CreateEmailCampaign. # noqa: E501
Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501
:return: The params of this CreateEmailCampaign. # noqa: E501
:rtype: object
"""
return self._params
@params.setter
def params(self, params):
"""Sets the params of this CreateEmailCampaign.
Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501
:param params: The params of this CreateEmailCampaign. # noqa: E501
:type: object
"""
self._params = params
@property
def send_at_best_time(self):
"""Gets the send_at_best_time of this CreateEmailCampaign. # noqa: E501
Set this to true if you want to send your campaign at best time. # noqa: E501
:return: The send_at_best_time of this CreateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._send_at_best_time
@send_at_best_time.setter
def send_at_best_time(self, send_at_best_time):
"""Sets the send_at_best_time of this CreateEmailCampaign.
Set this to true if you want to send your campaign at best time. # noqa: E501
:param send_at_best_time: The send_at_best_time of this CreateEmailCampaign. # noqa: E501
:type: bool
"""
self._send_at_best_time = send_at_best_time
@property
def ab_testing(self):
"""Gets the ab_testing of this CreateEmailCampaign. # noqa: E501
Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501
:return: The ab_testing of this CreateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._ab_testing
@ab_testing.setter
def ab_testing(self, ab_testing):
"""Sets the ab_testing of this CreateEmailCampaign.
Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501
:param ab_testing: The ab_testing of this CreateEmailCampaign. # noqa: E501
:type: bool
"""
self._ab_testing = ab_testing
@property
def subject_a(self):
"""Gets the subject_a of this CreateEmailCampaign. # noqa: E501
Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:return: The subject_a of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._subject_a
@subject_a.setter
def subject_a(self, subject_a):
"""Sets the subject_a of this CreateEmailCampaign.
Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:param subject_a: The subject_a of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._subject_a = subject_a
@property
def subject_b(self):
"""Gets the subject_b of this CreateEmailCampaign. # noqa: E501
Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:return: The subject_b of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._subject_b
@subject_b.setter
def subject_b(self, subject_b):
"""Sets the subject_b of this CreateEmailCampaign.
Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501
:param subject_b: The subject_b of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._subject_b = subject_b
@property
def split_rule(self):
"""Gets the split_rule of this CreateEmailCampaign. # noqa: E501
Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501
:return: The split_rule of this CreateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._split_rule
@split_rule.setter
def split_rule(self, split_rule):
"""Sets the split_rule of this CreateEmailCampaign.
Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501
:param split_rule: The split_rule of this CreateEmailCampaign. # noqa: E501
:type: int
"""
if split_rule is not None and split_rule > 50: # noqa: E501
raise ValueError("Invalid value for `split_rule`, must be a value less than or equal to `50`") # noqa: E501
if split_rule is not None and split_rule < 1: # noqa: E501
raise ValueError("Invalid value for `split_rule`, must be a value greater than or equal to `1`") # noqa: E501
self._split_rule = split_rule
@property
def winner_criteria(self):
"""Gets the winner_criteria of this CreateEmailCampaign. # noqa: E501
Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed # noqa: E501
:return: The winner_criteria of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._winner_criteria
@winner_criteria.setter
def winner_criteria(self, winner_criteria):
"""Sets the winner_criteria of this CreateEmailCampaign.
Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed # noqa: E501
:param winner_criteria: The winner_criteria of this CreateEmailCampaign. # noqa: E501
:type: str
"""
allowed_values = ["open", "click"] # noqa: E501
if winner_criteria not in allowed_values:
raise ValueError(
"Invalid value for `winner_criteria` ({0}), must be one of {1}" # noqa: E501
.format(winner_criteria, allowed_values)
)
self._winner_criteria = winner_criteria
@property
def winner_delay(self):
"""Gets the winner_delay of this CreateEmailCampaign. # noqa: E501
Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed # noqa: E501
:return: The winner_delay of this CreateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._winner_delay
@winner_delay.setter
def winner_delay(self, winner_delay):
"""Sets the winner_delay of this CreateEmailCampaign.
Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed # noqa: E501
:param winner_delay: The winner_delay of this CreateEmailCampaign. # noqa: E501
:type: int
"""
if winner_delay is not None and winner_delay > 168: # noqa: E501
raise ValueError("Invalid value for `winner_delay`, must be a value less than or equal to `168`") # noqa: E501
if winner_delay is not None and winner_delay < 1: # noqa: E501
raise ValueError("Invalid value for `winner_delay`, must be a value greater than or equal to `1`") # noqa: E501
self._winner_delay = winner_delay
@property
def ip_warmup_enable(self):
"""Gets the ip_warmup_enable of this CreateEmailCampaign. # noqa: E501
Available for dedicated ip clients. Set this to true if you wish to warm up your ip. # noqa: E501
:return: The ip_warmup_enable of this CreateEmailCampaign. # noqa: E501
:rtype: bool
"""
return self._ip_warmup_enable
@ip_warmup_enable.setter
def ip_warmup_enable(self, ip_warmup_enable):
"""Sets the ip_warmup_enable of this CreateEmailCampaign.
Available for dedicated ip clients. Set this to true if you wish to warm up your ip. # noqa: E501
:param ip_warmup_enable: The ip_warmup_enable of this CreateEmailCampaign. # noqa: E501
:type: bool
"""
self._ip_warmup_enable = ip_warmup_enable
@property
def initial_quota(self):
"""Gets the initial_quota of this CreateEmailCampaign. # noqa: E501
Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. # noqa: E501
:return: The initial_quota of this CreateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._initial_quota
@initial_quota.setter
def initial_quota(self, initial_quota):
"""Sets the initial_quota of this CreateEmailCampaign.
Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. # noqa: E501
:param initial_quota: The initial_quota of this CreateEmailCampaign. # noqa: E501
:type: int
"""
self._initial_quota = initial_quota
@property
def increase_rate(self):
"""Gets the increase_rate of this CreateEmailCampaign. # noqa: E501
Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. # noqa: E501
:return: The increase_rate of this CreateEmailCampaign. # noqa: E501
:rtype: int
"""
return self._increase_rate
@increase_rate.setter
def increase_rate(self, increase_rate):
"""Sets the increase_rate of this CreateEmailCampaign.
Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. # noqa: E501
:param increase_rate: The increase_rate of this CreateEmailCampaign. # noqa: E501
:type: int
"""
if increase_rate is not None and increase_rate > 100: # noqa: E501
raise ValueError("Invalid value for `increase_rate`, must be a value less than or equal to `100`") # noqa: E501
if increase_rate is not None and increase_rate < 0: # noqa: E501
raise ValueError("Invalid value for `increase_rate`, must be a value greater than or equal to `0`") # noqa: E501
self._increase_rate = increase_rate
@property
def unsubscription_page_id(self):
"""Gets the unsubscription_page_id of this CreateEmailCampaign. # noqa: E501
Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. # noqa: E501
:return: The unsubscription_page_id of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._unsubscription_page_id
@unsubscription_page_id.setter
def unsubscription_page_id(self, unsubscription_page_id):
"""Sets the unsubscription_page_id of this CreateEmailCampaign.
Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. # noqa: E501
:param unsubscription_page_id: The unsubscription_page_id of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._unsubscription_page_id = unsubscription_page_id
@property
def update_form_id(self):
"""Gets the update_form_id of this CreateEmailCampaign. # noqa: E501
Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. # noqa: E501
:return: The update_form_id of this CreateEmailCampaign. # noqa: E501
:rtype: str
"""
return self._update_form_id
@update_form_id.setter
def update_form_id(self, update_form_id):
"""Sets the update_form_id of this CreateEmailCampaign.
Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. # noqa: E501
:param update_form_id: The update_form_id of this CreateEmailCampaign. # noqa: E501
:type: str
"""
self._update_form_id = update_form_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(CreateEmailCampaign, 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, CreateEmailCampaign):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None)
|
58,397 |
sib_api_v3_sdk.models.create_email_campaign
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateEmailCampaign):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,398 |
sib_api_v3_sdk.models.create_email_campaign
|
__init__
|
CreateEmailCampaign - a model defined in Swagger
|
def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None): # noqa: E501
"""CreateEmailCampaign - a model defined in Swagger""" # noqa: E501
self._tag = None
self._sender = None
self._name = None
self._html_content = None
self._html_url = None
self._template_id = None
self._scheduled_at = None
self._subject = None
self._reply_to = None
self._to_field = None
self._recipients = None
self._attachment_url = None
self._inline_image_activation = None
self._mirror_active = None
self._footer = None
self._header = None
self._utm_campaign = None
self._params = None
self._send_at_best_time = None
self._ab_testing = None
self._subject_a = None
self._subject_b = None
self._split_rule = None
self._winner_criteria = None
self._winner_delay = None
self._ip_warmup_enable = None
self._initial_quota = None
self._increase_rate = None
self._unsubscription_page_id = None
self._update_form_id = None
self.discriminator = None
if tag is not None:
self.tag = tag
self.sender = sender
self.name = name
if html_content is not None:
self.html_content = html_content
if html_url is not None:
self.html_url = html_url
if template_id is not None:
self.template_id = template_id
if scheduled_at is not None:
self.scheduled_at = scheduled_at
if subject is not None:
self.subject = subject
if reply_to is not None:
self.reply_to = reply_to
if to_field is not None:
self.to_field = to_field
if recipients is not None:
self.recipients = recipients
if attachment_url is not None:
self.attachment_url = attachment_url
if inline_image_activation is not None:
self.inline_image_activation = inline_image_activation
if mirror_active is not None:
self.mirror_active = mirror_active
if footer is not None:
self.footer = footer
if header is not None:
self.header = header
if utm_campaign is not None:
self.utm_campaign = utm_campaign
if params is not None:
self.params = params
if send_at_best_time is not None:
self.send_at_best_time = send_at_best_time
if ab_testing is not None:
self.ab_testing = ab_testing
if subject_a is not None:
self.subject_a = subject_a
if subject_b is not None:
self.subject_b = subject_b
if split_rule is not None:
self.split_rule = split_rule
if winner_criteria is not None:
self.winner_criteria = winner_criteria
if winner_delay is not None:
self.winner_delay = winner_delay
if ip_warmup_enable is not None:
self.ip_warmup_enable = ip_warmup_enable
if initial_quota is not None:
self.initial_quota = initial_quota
if increase_rate is not None:
self.increase_rate = increase_rate
if unsubscription_page_id is not None:
self.unsubscription_page_id = unsubscription_page_id
if update_form_id is not None:
self.update_form_id = update_form_id
|
(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, ip_warmup_enable=False, initial_quota=None, increase_rate=None, unsubscription_page_id=None, update_form_id=None)
|
58,401 |
sib_api_v3_sdk.models.create_email_campaign
|
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(CreateEmailCampaign, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,403 |
sib_api_v3_sdk.models.create_email_campaign_recipients
|
CreateEmailCampaignRecipients
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateEmailCampaignRecipients(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 = {
'exclusion_list_ids': 'list[int]',
'list_ids': 'list[int]',
'segment_ids': 'list[int]'
}
attribute_map = {
'exclusion_list_ids': 'exclusionListIds',
'list_ids': 'listIds',
'segment_ids': 'segmentIds'
}
def __init__(self, exclusion_list_ids=None, list_ids=None, segment_ids=None): # noqa: E501
"""CreateEmailCampaignRecipients - a model defined in Swagger""" # noqa: E501
self._exclusion_list_ids = None
self._list_ids = None
self._segment_ids = None
self.discriminator = None
if exclusion_list_ids is not None:
self.exclusion_list_ids = exclusion_list_ids
if list_ids is not None:
self.list_ids = list_ids
if segment_ids is not None:
self.segment_ids = segment_ids
@property
def exclusion_list_ids(self):
"""Gets the exclusion_list_ids of this CreateEmailCampaignRecipients. # noqa: E501
List ids to exclude from the campaign # noqa: E501
:return: The exclusion_list_ids of this CreateEmailCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._exclusion_list_ids
@exclusion_list_ids.setter
def exclusion_list_ids(self, exclusion_list_ids):
"""Sets the exclusion_list_ids of this CreateEmailCampaignRecipients.
List ids to exclude from the campaign # noqa: E501
:param exclusion_list_ids: The exclusion_list_ids of this CreateEmailCampaignRecipients. # noqa: E501
:type: list[int]
"""
self._exclusion_list_ids = exclusion_list_ids
@property
def list_ids(self):
"""Gets the list_ids of this CreateEmailCampaignRecipients. # noqa: E501
Mandatory if scheduledAt is not empty. List Ids to send the campaign to # noqa: E501
:return: The list_ids of this CreateEmailCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._list_ids
@list_ids.setter
def list_ids(self, list_ids):
"""Sets the list_ids of this CreateEmailCampaignRecipients.
Mandatory if scheduledAt is not empty. List Ids to send the campaign to # noqa: E501
:param list_ids: The list_ids of this CreateEmailCampaignRecipients. # noqa: E501
:type: list[int]
"""
self._list_ids = list_ids
@property
def segment_ids(self):
"""Gets the segment_ids of this CreateEmailCampaignRecipients. # noqa: E501
Mandatory if listIds are not used. Segment ids to send the campaign to. # noqa: E501
:return: The segment_ids of this CreateEmailCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._segment_ids
@segment_ids.setter
def segment_ids(self, segment_ids):
"""Sets the segment_ids of this CreateEmailCampaignRecipients.
Mandatory if listIds are not used. Segment ids to send the campaign to. # noqa: E501
:param segment_ids: The segment_ids of this CreateEmailCampaignRecipients. # noqa: E501
:type: list[int]
"""
self._segment_ids = segment_ids
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(CreateEmailCampaignRecipients, 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, CreateEmailCampaignRecipients):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(exclusion_list_ids=None, list_ids=None, segment_ids=None)
|
58,404 |
sib_api_v3_sdk.models.create_email_campaign_recipients
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateEmailCampaignRecipients):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,405 |
sib_api_v3_sdk.models.create_email_campaign_recipients
|
__init__
|
CreateEmailCampaignRecipients - a model defined in Swagger
|
def __init__(self, exclusion_list_ids=None, list_ids=None, segment_ids=None): # noqa: E501
"""CreateEmailCampaignRecipients - a model defined in Swagger""" # noqa: E501
self._exclusion_list_ids = None
self._list_ids = None
self._segment_ids = None
self.discriminator = None
if exclusion_list_ids is not None:
self.exclusion_list_ids = exclusion_list_ids
if list_ids is not None:
self.list_ids = list_ids
if segment_ids is not None:
self.segment_ids = segment_ids
|
(self, exclusion_list_ids=None, list_ids=None, segment_ids=None)
|
58,408 |
sib_api_v3_sdk.models.create_email_campaign_recipients
|
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(CreateEmailCampaignRecipients, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,410 |
sib_api_v3_sdk.models.create_email_campaign_sender
|
CreateEmailCampaignSender
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateEmailCampaignSender(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
"""CreateEmailCampaignSender - 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
self.email = email
if id is not None:
self.id = id
@property
def name(self):
"""Gets the name of this CreateEmailCampaignSender. # noqa: E501
Sender Name # noqa: E501
:return: The name of this CreateEmailCampaignSender. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this CreateEmailCampaignSender.
Sender Name # noqa: E501
:param name: The name of this CreateEmailCampaignSender. # noqa: E501
:type: str
"""
self._name = name
@property
def email(self):
"""Gets the email of this CreateEmailCampaignSender. # noqa: E501
Sender email # noqa: E501
:return: The email of this CreateEmailCampaignSender. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this CreateEmailCampaignSender.
Sender email # noqa: E501
:param email: The email of this CreateEmailCampaignSender. # 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 id(self):
"""Gets the id of this CreateEmailCampaignSender. # noqa: E501
Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). # noqa: E501
:return: The id of this CreateEmailCampaignSender. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this CreateEmailCampaignSender.
Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). # noqa: E501
:param id: The id of this CreateEmailCampaignSender. # 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(CreateEmailCampaignSender, 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, CreateEmailCampaignSender):
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)
|
58,411 |
sib_api_v3_sdk.models.create_email_campaign_sender
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateEmailCampaignSender):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,412 |
sib_api_v3_sdk.models.create_email_campaign_sender
|
__init__
|
CreateEmailCampaignSender - a model defined in Swagger
|
def __init__(self, name=None, email=None, id=None): # noqa: E501
"""CreateEmailCampaignSender - 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
self.email = email
if id is not None:
self.id = id
|
(self, name=None, email=None, id=None)
|
58,415 |
sib_api_v3_sdk.models.create_email_campaign_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(CreateEmailCampaignSender, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,417 |
sib_api_v3_sdk.models.create_external_feed
|
CreateExternalFeed
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateExternalFeed(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',
'url': 'str',
'auth_type': 'str',
'username': 'str',
'password': 'str',
'token': 'str',
'headers': 'list[GetExternalFeedByUUIDHeaders]',
'max_retries': 'int',
'cache': 'bool'
}
attribute_map = {
'name': 'name',
'url': 'url',
'auth_type': 'authType',
'username': 'username',
'password': 'password',
'token': 'token',
'headers': 'headers',
'max_retries': 'maxRetries',
'cache': 'cache'
}
def __init__(self, name=None, url=None, auth_type='noAuth', username=None, password=None, token=None, headers=None, max_retries=None, cache=False): # noqa: E501
"""CreateExternalFeed - a model defined in Swagger""" # noqa: E501
self._name = None
self._url = None
self._auth_type = None
self._username = None
self._password = None
self._token = None
self._headers = None
self._max_retries = None
self._cache = None
self.discriminator = None
self.name = name
self.url = url
if auth_type is not None:
self.auth_type = auth_type
if username is not None:
self.username = username
if password is not None:
self.password = password
if token is not None:
self.token = token
if headers is not None:
self.headers = headers
if max_retries is not None:
self.max_retries = max_retries
if cache is not None:
self.cache = cache
@property
def name(self):
"""Gets the name of this CreateExternalFeed. # noqa: E501
Name of the feed # noqa: E501
:return: The name of this CreateExternalFeed. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this CreateExternalFeed.
Name of the feed # noqa: E501
:param name: The name of this CreateExternalFeed. # noqa: E501
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501
self._name = name
@property
def url(self):
"""Gets the url of this CreateExternalFeed. # noqa: E501
URL of the feed # noqa: E501
:return: The url of this CreateExternalFeed. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this CreateExternalFeed.
URL of the feed # noqa: E501
:param url: The url of this CreateExternalFeed. # noqa: E501
:type: str
"""
if url is None:
raise ValueError("Invalid value for `url`, must not be `None`") # noqa: E501
self._url = url
@property
def auth_type(self):
"""Gets the auth_type of this CreateExternalFeed. # noqa: E501
Auth type of the feed: * `basic` * `token` * `noAuth` # noqa: E501
:return: The auth_type of this CreateExternalFeed. # noqa: E501
:rtype: str
"""
return self._auth_type
@auth_type.setter
def auth_type(self, auth_type):
"""Sets the auth_type of this CreateExternalFeed.
Auth type of the feed: * `basic` * `token` * `noAuth` # noqa: E501
:param auth_type: The auth_type of this CreateExternalFeed. # noqa: E501
:type: str
"""
allowed_values = ["basic", "token", "noAuth"] # noqa: E501
if auth_type not in allowed_values:
raise ValueError(
"Invalid value for `auth_type` ({0}), must be one of {1}" # noqa: E501
.format(auth_type, allowed_values)
)
self._auth_type = auth_type
@property
def username(self):
"""Gets the username of this CreateExternalFeed. # noqa: E501
Username for authType `basic` # noqa: E501
:return: The username of this CreateExternalFeed. # noqa: E501
:rtype: str
"""
return self._username
@username.setter
def username(self, username):
"""Sets the username of this CreateExternalFeed.
Username for authType `basic` # noqa: E501
:param username: The username of this CreateExternalFeed. # noqa: E501
:type: str
"""
self._username = username
@property
def password(self):
"""Gets the password of this CreateExternalFeed. # noqa: E501
Password for authType `basic` # noqa: E501
:return: The password of this CreateExternalFeed. # noqa: E501
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""Sets the password of this CreateExternalFeed.
Password for authType `basic` # noqa: E501
:param password: The password of this CreateExternalFeed. # noqa: E501
:type: str
"""
self._password = password
@property
def token(self):
"""Gets the token of this CreateExternalFeed. # noqa: E501
Token for authType `token` # noqa: E501
:return: The token of this CreateExternalFeed. # noqa: E501
:rtype: str
"""
return self._token
@token.setter
def token(self, token):
"""Sets the token of this CreateExternalFeed.
Token for authType `token` # noqa: E501
:param token: The token of this CreateExternalFeed. # noqa: E501
:type: str
"""
self._token = token
@property
def headers(self):
"""Gets the headers of this CreateExternalFeed. # noqa: E501
Custom headers for the feed # noqa: E501
:return: The headers of this CreateExternalFeed. # noqa: E501
:rtype: list[GetExternalFeedByUUIDHeaders]
"""
return self._headers
@headers.setter
def headers(self, headers):
"""Sets the headers of this CreateExternalFeed.
Custom headers for the feed # noqa: E501
:param headers: The headers of this CreateExternalFeed. # noqa: E501
:type: list[GetExternalFeedByUUIDHeaders]
"""
self._headers = headers
@property
def max_retries(self):
"""Gets the max_retries of this CreateExternalFeed. # noqa: E501
Maximum number of retries on the feed url # noqa: E501
:return: The max_retries of this CreateExternalFeed. # noqa: E501
:rtype: int
"""
return self._max_retries
@max_retries.setter
def max_retries(self, max_retries):
"""Sets the max_retries of this CreateExternalFeed.
Maximum number of retries on the feed url # noqa: E501
:param max_retries: The max_retries of this CreateExternalFeed. # noqa: E501
:type: int
"""
if max_retries is not None and max_retries > 5: # noqa: E501
raise ValueError("Invalid value for `max_retries`, must be a value less than or equal to `5`") # noqa: E501
if max_retries is not None and max_retries < 0: # noqa: E501
raise ValueError("Invalid value for `max_retries`, must be a value greater than or equal to `0`") # noqa: E501
self._max_retries = max_retries
@property
def cache(self):
"""Gets the cache of this CreateExternalFeed. # noqa: E501
Toggle caching of feed url response # noqa: E501
:return: The cache of this CreateExternalFeed. # noqa: E501
:rtype: bool
"""
return self._cache
@cache.setter
def cache(self, cache):
"""Sets the cache of this CreateExternalFeed.
Toggle caching of feed url response # noqa: E501
:param cache: The cache of this CreateExternalFeed. # noqa: E501
:type: bool
"""
self._cache = cache
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(CreateExternalFeed, 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, CreateExternalFeed):
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, url=None, auth_type='noAuth', username=None, password=None, token=None, headers=None, max_retries=None, cache=False)
|
58,418 |
sib_api_v3_sdk.models.create_external_feed
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateExternalFeed):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,419 |
sib_api_v3_sdk.models.create_external_feed
|
__init__
|
CreateExternalFeed - a model defined in Swagger
|
def __init__(self, name=None, url=None, auth_type='noAuth', username=None, password=None, token=None, headers=None, max_retries=None, cache=False): # noqa: E501
"""CreateExternalFeed - a model defined in Swagger""" # noqa: E501
self._name = None
self._url = None
self._auth_type = None
self._username = None
self._password = None
self._token = None
self._headers = None
self._max_retries = None
self._cache = None
self.discriminator = None
self.name = name
self.url = url
if auth_type is not None:
self.auth_type = auth_type
if username is not None:
self.username = username
if password is not None:
self.password = password
if token is not None:
self.token = token
if headers is not None:
self.headers = headers
if max_retries is not None:
self.max_retries = max_retries
if cache is not None:
self.cache = cache
|
(self, name=None, url=None, auth_type='noAuth', username=None, password=None, token=None, headers=None, max_retries=None, cache=False)
|
58,422 |
sib_api_v3_sdk.models.create_external_feed
|
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(CreateExternalFeed, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,424 |
sib_api_v3_sdk.models.create_list
|
CreateList
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class CreateList(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',
'folder_id': 'int'
}
attribute_map = {
'name': 'name',
'folder_id': 'folderId'
}
def __init__(self, name=None, folder_id=None): # noqa: E501
"""CreateList - a model defined in Swagger""" # noqa: E501
self._name = None
self._folder_id = None
self.discriminator = None
self.name = name
self.folder_id = folder_id
@property
def name(self):
"""Gets the name of this CreateList. # noqa: E501
Name of the list # noqa: E501
:return: The name of this CreateList. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this CreateList.
Name of the list # noqa: E501
:param name: The name of this CreateList. # noqa: E501
:type: str
"""
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501
self._name = name
@property
def folder_id(self):
"""Gets the folder_id of this CreateList. # noqa: E501
Id of the parent folder in which this list is to be created # noqa: E501
:return: The folder_id of this CreateList. # noqa: E501
:rtype: int
"""
return self._folder_id
@folder_id.setter
def folder_id(self, folder_id):
"""Sets the folder_id of this CreateList.
Id of the parent folder in which this list is to be created # noqa: E501
:param folder_id: The folder_id of this CreateList. # noqa: E501
:type: int
"""
if folder_id is None:
raise ValueError("Invalid value for `folder_id`, must not be `None`") # noqa: E501
self._folder_id = folder_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(CreateList, 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, CreateList):
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, folder_id=None)
|
58,425 |
sib_api_v3_sdk.models.create_list
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, CreateList):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,426 |
sib_api_v3_sdk.models.create_list
|
__init__
|
CreateList - a model defined in Swagger
|
def __init__(self, name=None, folder_id=None): # noqa: E501
"""CreateList - a model defined in Swagger""" # noqa: E501
self._name = None
self._folder_id = None
self.discriminator = None
self.name = name
self.folder_id = folder_id
|
(self, name=None, folder_id=None)
|
58,429 |
sib_api_v3_sdk.models.create_list
|
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(CreateList, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.