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,734 |
sib_api_v3_sdk.api.external_feeds_api
|
create_external_feed
|
Create an external feed # noqa: E501
This endpoint will create an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_external_feed(create_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateExternalFeed create_external_feed: Values to create a feed (required)
:return: InlineResponse2013
If the method is called asynchronously,
returns the request thread.
|
def create_external_feed(self, create_external_feed, **kwargs): # noqa: E501
"""Create an external feed # noqa: E501
This endpoint will create an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_external_feed(create_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateExternalFeed create_external_feed: Values to create a feed (required)
:return: InlineResponse2013
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.create_external_feed_with_http_info(create_external_feed, **kwargs) # noqa: E501
else:
(data) = self.create_external_feed_with_http_info(create_external_feed, **kwargs) # noqa: E501
return data
|
(self, create_external_feed, **kwargs)
|
58,735 |
sib_api_v3_sdk.api.external_feeds_api
|
create_external_feed_with_http_info
|
Create an external feed # noqa: E501
This endpoint will create an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_external_feed_with_http_info(create_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateExternalFeed create_external_feed: Values to create a feed (required)
:return: InlineResponse2013
If the method is called asynchronously,
returns the request thread.
|
def create_external_feed_with_http_info(self, create_external_feed, **kwargs): # noqa: E501
"""Create an external feed # noqa: E501
This endpoint will create an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_external_feed_with_http_info(create_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param CreateExternalFeed create_external_feed: Values to create a feed (required)
:return: InlineResponse2013
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['create_external_feed'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_external_feed" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'create_external_feed' is set
if ('create_external_feed' not in params or
params['create_external_feed'] is None):
raise ValueError("Missing the required parameter `create_external_feed` when calling `create_external_feed`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_external_feed' in params:
body_params = params['create_external_feed']
# 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(
'/feeds', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2013', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, create_external_feed, **kwargs)
|
58,736 |
sib_api_v3_sdk.api.external_feeds_api
|
delete_external_feed
|
Delete an external feed # noqa: E501
This endpoint will delete an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_external_feed(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_external_feed(self, uuid, **kwargs): # noqa: E501
"""Delete an external feed # noqa: E501
This endpoint will delete an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_external_feed(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.delete_external_feed_with_http_info(uuid, **kwargs) # noqa: E501
else:
(data) = self.delete_external_feed_with_http_info(uuid, **kwargs) # noqa: E501
return data
|
(self, uuid, **kwargs)
|
58,737 |
sib_api_v3_sdk.api.external_feeds_api
|
delete_external_feed_with_http_info
|
Delete an external feed # noqa: E501
This endpoint will delete an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_external_feed_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def delete_external_feed_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Delete an external feed # noqa: E501
This endpoint will delete an external feed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_external_feed_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to delete (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['uuid'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_external_feed" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'uuid' is set
if ('uuid' not in params or
params['uuid'] is None):
raise ValueError("Missing the required parameter `uuid` when calling `delete_external_feed`") # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in params:
path_params['uuid'] = params['uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/feeds/{uuid}', '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, uuid, **kwargs)
|
58,738 |
sib_api_v3_sdk.api.external_feeds_api
|
get_all_external_feeds
|
Fetch all external feeds # noqa: E501
This endpoint can fetch all created external feeds. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_external_feeds(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str search: Can be used to filter records by search keyword on feed name
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
:param str auth_type: Filter the records by `authType` of the feed.
:param int limit: Number of documents returned per page.
:param int offset: Index of the first document on the page.
:return: GetAllExternalFeeds
If the method is called asynchronously,
returns the request thread.
|
def get_all_external_feeds(self, **kwargs): # noqa: E501
"""Fetch all external feeds # noqa: E501
This endpoint can fetch all created external feeds. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_external_feeds(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str search: Can be used to filter records by search keyword on feed name
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
:param str auth_type: Filter the records by `authType` of the feed.
:param int limit: Number of documents returned per page.
:param int offset: Index of the first document on the page.
:return: GetAllExternalFeeds
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_all_external_feeds_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_external_feeds_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
58,739 |
sib_api_v3_sdk.api.external_feeds_api
|
get_all_external_feeds_with_http_info
|
Fetch all external feeds # noqa: E501
This endpoint can fetch all created external feeds. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_external_feeds_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str search: Can be used to filter records by search keyword on feed name
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
:param str auth_type: Filter the records by `authType` of the feed.
:param int limit: Number of documents returned per page.
:param int offset: Index of the first document on the page.
:return: GetAllExternalFeeds
If the method is called asynchronously,
returns the request thread.
|
def get_all_external_feeds_with_http_info(self, **kwargs): # noqa: E501
"""Fetch all external feeds # noqa: E501
This endpoint can fetch all created external feeds. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_external_feeds_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str search: Can be used to filter records by search keyword on feed name
:param date start_date: Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.
:param date end_date: Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
:param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.
:param str auth_type: Filter the records by `authType` of the feed.
:param int limit: Number of documents returned per page.
:param int offset: Index of the first document on the page.
:return: GetAllExternalFeeds
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['search', 'start_date', 'end_date', 'sort', 'auth_type', 'limit', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_external_feeds" % key
)
params[key] = val
del params['kwargs']
if 'limit' in params and params['limit'] > 500: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_all_external_feeds`, must be a value less than or equal to `500`") # noqa: E501
if 'limit' in params and params['limit'] < 0: # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `get_all_external_feeds`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'search' in params:
query_params.append(('search', params['search'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'sort' in params:
query_params.append(('sort', params['sort'])) # noqa: E501
if 'auth_type' in params:
query_params.append(('authType', params['auth_type'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/feeds', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetAllExternalFeeds', # 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,740 |
sib_api_v3_sdk.api.external_feeds_api
|
get_external_feed_by_uuid
|
Get an external feed by UUID # noqa: E501
This endpoint will update an external feed. # 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_external_feed_by_uuid(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to fetch (required)
:return: GetExternalFeedByUUID
If the method is called asynchronously,
returns the request thread.
|
def get_external_feed_by_uuid(self, uuid, **kwargs): # noqa: E501
"""Get an external feed by UUID # noqa: E501
This endpoint will update an external feed. # 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_external_feed_by_uuid(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to fetch (required)
:return: GetExternalFeedByUUID
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_external_feed_by_uuid_with_http_info(uuid, **kwargs) # noqa: E501
else:
(data) = self.get_external_feed_by_uuid_with_http_info(uuid, **kwargs) # noqa: E501
return data
|
(self, uuid, **kwargs)
|
58,741 |
sib_api_v3_sdk.api.external_feeds_api
|
get_external_feed_by_uuid_with_http_info
|
Get an external feed by UUID # noqa: E501
This endpoint will update an external feed. # 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_external_feed_by_uuid_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to fetch (required)
:return: GetExternalFeedByUUID
If the method is called asynchronously,
returns the request thread.
|
def get_external_feed_by_uuid_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Get an external feed by UUID # noqa: E501
This endpoint will update an external feed. # 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_external_feed_by_uuid_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to fetch (required)
:return: GetExternalFeedByUUID
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['uuid'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_external_feed_by_uuid" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'uuid' is set
if ('uuid' not in params or
params['uuid'] is None):
raise ValueError("Missing the required parameter `uuid` when calling `get_external_feed_by_uuid`") # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in params:
path_params['uuid'] = params['uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/feeds/{uuid}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GetExternalFeedByUUID', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, uuid, **kwargs)
|
58,742 |
sib_api_v3_sdk.api.external_feeds_api
|
update_external_feed
|
Update an external feed # noqa: E501
This endpoint will update an external feed. # 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_external_feed(uuid, update_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to update (required)
:param UpdateExternalFeed update_external_feed: Values to update a feed (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_external_feed(self, uuid, update_external_feed, **kwargs): # noqa: E501
"""Update an external feed # noqa: E501
This endpoint will update an external feed. # 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_external_feed(uuid, update_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to update (required)
:param UpdateExternalFeed update_external_feed: Values to update a feed (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_external_feed_with_http_info(uuid, update_external_feed, **kwargs) # noqa: E501
else:
(data) = self.update_external_feed_with_http_info(uuid, update_external_feed, **kwargs) # noqa: E501
return data
|
(self, uuid, update_external_feed, **kwargs)
|
58,743 |
sib_api_v3_sdk.api.external_feeds_api
|
update_external_feed_with_http_info
|
Update an external feed # noqa: E501
This endpoint will update an external feed. # 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_external_feed_with_http_info(uuid, update_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to update (required)
:param UpdateExternalFeed update_external_feed: Values to update a feed (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_external_feed_with_http_info(self, uuid, update_external_feed, **kwargs): # noqa: E501
"""Update an external feed # noqa: E501
This endpoint will update an external feed. # 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_external_feed_with_http_info(uuid, update_external_feed, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str uuid: UUID of the feed to update (required)
:param UpdateExternalFeed update_external_feed: Values to update a feed (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['uuid', 'update_external_feed'] # 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_external_feed" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'uuid' is set
if ('uuid' not in params or
params['uuid'] is None):
raise ValueError("Missing the required parameter `uuid` when calling `update_external_feed`") # noqa: E501
# verify the required parameter 'update_external_feed' is set
if ('update_external_feed' not in params or
params['update_external_feed'] is None):
raise ValueError("Missing the required parameter `update_external_feed` when calling `update_external_feed`") # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in params:
path_params['uuid'] = params['uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'update_external_feed' in params:
body_params = params['update_external_feed']
# 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(
'/feeds/{uuid}', '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, uuid, update_external_feed, **kwargs)
|
58,744 |
sib_api_v3_sdk.models.file_data
|
FileData
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class FileData(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',
'author_id': 'str',
'contact_id': 'int',
'deal_id': 'str',
'company_id': 'str',
'size': 'int',
'created_at': 'datetime'
}
attribute_map = {
'name': 'name',
'author_id': 'authorId',
'contact_id': 'contactId',
'deal_id': 'dealId',
'company_id': 'companyId',
'size': 'size',
'created_at': 'createdAt'
}
def __init__(self, name=None, author_id=None, contact_id=None, deal_id=None, company_id=None, size=None, created_at=None): # noqa: E501
"""FileData - a model defined in Swagger""" # noqa: E501
self._name = None
self._author_id = None
self._contact_id = None
self._deal_id = None
self._company_id = None
self._size = None
self._created_at = None
self.discriminator = None
if name is not None:
self.name = name
if author_id is not None:
self.author_id = author_id
if contact_id is not None:
self.contact_id = contact_id
if deal_id is not None:
self.deal_id = deal_id
if company_id is not None:
self.company_id = company_id
if size is not None:
self.size = size
if created_at is not None:
self.created_at = created_at
@property
def name(self):
"""Gets the name of this FileData. # noqa: E501
Name of uploaded file # noqa: E501
:return: The name of this FileData. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this FileData.
Name of uploaded file # noqa: E501
:param name: The name of this FileData. # noqa: E501
:type: str
"""
self._name = name
@property
def author_id(self):
"""Gets the author_id of this FileData. # noqa: E501
Account id of user which created the file # noqa: E501
:return: The author_id of this FileData. # noqa: E501
:rtype: str
"""
return self._author_id
@author_id.setter
def author_id(self, author_id):
"""Sets the author_id of this FileData.
Account id of user which created the file # noqa: E501
:param author_id: The author_id of this FileData. # noqa: E501
:type: str
"""
self._author_id = author_id
@property
def contact_id(self):
"""Gets the contact_id of this FileData. # noqa: E501
Contact id of contact on which file is uploaded # noqa: E501
:return: The contact_id of this FileData. # noqa: E501
:rtype: int
"""
return self._contact_id
@contact_id.setter
def contact_id(self, contact_id):
"""Sets the contact_id of this FileData.
Contact id of contact on which file is uploaded # noqa: E501
:param contact_id: The contact_id of this FileData. # noqa: E501
:type: int
"""
self._contact_id = contact_id
@property
def deal_id(self):
"""Gets the deal_id of this FileData. # noqa: E501
Deal id linked to a file # noqa: E501
:return: The deal_id of this FileData. # noqa: E501
:rtype: str
"""
return self._deal_id
@deal_id.setter
def deal_id(self, deal_id):
"""Sets the deal_id of this FileData.
Deal id linked to a file # noqa: E501
:param deal_id: The deal_id of this FileData. # noqa: E501
:type: str
"""
self._deal_id = deal_id
@property
def company_id(self):
"""Gets the company_id of this FileData. # noqa: E501
Company id linked to a file # noqa: E501
:return: The company_id of this FileData. # noqa: E501
:rtype: str
"""
return self._company_id
@company_id.setter
def company_id(self, company_id):
"""Sets the company_id of this FileData.
Company id linked to a file # noqa: E501
:param company_id: The company_id of this FileData. # noqa: E501
:type: str
"""
self._company_id = company_id
@property
def size(self):
"""Gets the size of this FileData. # noqa: E501
Size of file in bytes # noqa: E501
:return: The size of this FileData. # noqa: E501
:rtype: int
"""
return self._size
@size.setter
def size(self, size):
"""Sets the size of this FileData.
Size of file in bytes # noqa: E501
:param size: The size of this FileData. # noqa: E501
:type: int
"""
self._size = size
@property
def created_at(self):
"""Gets the created_at of this FileData. # noqa: E501
File created date/time # noqa: E501
:return: The created_at of this FileData. # noqa: E501
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this FileData.
File created date/time # noqa: E501
:param created_at: The created_at of this FileData. # noqa: E501
:type: datetime
"""
self._created_at = created_at
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(FileData, 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, FileData):
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, author_id=None, contact_id=None, deal_id=None, company_id=None, size=None, created_at=None)
|
58,745 |
sib_api_v3_sdk.models.file_data
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, FileData):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,746 |
sib_api_v3_sdk.models.file_data
|
__init__
|
FileData - a model defined in Swagger
|
def __init__(self, name=None, author_id=None, contact_id=None, deal_id=None, company_id=None, size=None, created_at=None): # noqa: E501
"""FileData - a model defined in Swagger""" # noqa: E501
self._name = None
self._author_id = None
self._contact_id = None
self._deal_id = None
self._company_id = None
self._size = None
self._created_at = None
self.discriminator = None
if name is not None:
self.name = name
if author_id is not None:
self.author_id = author_id
if contact_id is not None:
self.contact_id = contact_id
if deal_id is not None:
self.deal_id = deal_id
if company_id is not None:
self.company_id = company_id
if size is not None:
self.size = size
if created_at is not None:
self.created_at = created_at
|
(self, name=None, author_id=None, contact_id=None, deal_id=None, company_id=None, size=None, created_at=None)
|
58,749 |
sib_api_v3_sdk.models.file_data
|
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(FileData, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,751 |
sib_api_v3_sdk.models.file_downloadable_link
|
FileDownloadableLink
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class FileDownloadableLink(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 = {
'file_url': 'str'
}
attribute_map = {
'file_url': 'fileUrl'
}
def __init__(self, file_url=None): # noqa: E501
"""FileDownloadableLink - a model defined in Swagger""" # noqa: E501
self._file_url = None
self.discriminator = None
self.file_url = file_url
@property
def file_url(self):
"""Gets the file_url of this FileDownloadableLink. # noqa: E501
A unique link to download the requested file. # noqa: E501
:return: The file_url of this FileDownloadableLink. # noqa: E501
:rtype: str
"""
return self._file_url
@file_url.setter
def file_url(self, file_url):
"""Sets the file_url of this FileDownloadableLink.
A unique link to download the requested file. # noqa: E501
:param file_url: The file_url of this FileDownloadableLink. # noqa: E501
:type: str
"""
if file_url is None:
raise ValueError("Invalid value for `file_url`, must not be `None`") # noqa: E501
self._file_url = file_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(FileDownloadableLink, 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, FileDownloadableLink):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(file_url=None)
|
58,752 |
sib_api_v3_sdk.models.file_downloadable_link
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, FileDownloadableLink):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,753 |
sib_api_v3_sdk.models.file_downloadable_link
|
__init__
|
FileDownloadableLink - a model defined in Swagger
|
def __init__(self, file_url=None): # noqa: E501
"""FileDownloadableLink - a model defined in Swagger""" # noqa: E501
self._file_url = None
self.discriminator = None
self.file_url = file_url
|
(self, file_url=None)
|
58,756 |
sib_api_v3_sdk.models.file_downloadable_link
|
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(FileDownloadableLink, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,758 |
sib_api_v3_sdk.models.file_list
|
FileList
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class FileList(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 = {
}
attribute_map = {
}
def __init__(self): # noqa: E501
"""FileList - a model defined in Swagger""" # noqa: E501
self.discriminator = None
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(FileList, 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, FileList):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
()
|
58,759 |
sib_api_v3_sdk.models.file_list
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, FileList):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,760 |
sib_api_v3_sdk.models.file_list
|
__init__
|
FileList - a model defined in Swagger
|
def __init__(self): # noqa: E501
"""FileList - a model defined in Swagger""" # noqa: E501
self.discriminator = None
|
(self)
|
58,763 |
sib_api_v3_sdk.models.file_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(FileList, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,765 |
sib_api_v3_sdk.api.files_api
|
FilesApi
|
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 FilesApi(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 crm_files_get(self, **kwargs): # noqa: E501
"""Get all files # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by file entity type
:param str entity_ids: Filter by file entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: FileList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.crm_files_get_with_http_info(**kwargs) # noqa: E501
return data
def crm_files_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all files # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by file entity type
:param str entity_ids: Filter by file entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: FileList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['entity', 'entity_ids', 'date_from', 'date_to', 'offset', 'limit', '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 crm_files_get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'entity' in params:
query_params.append(('entity', params['entity'])) # noqa: E501
if 'entity_ids' in params:
query_params.append(('entityIds', params['entity_ids'])) # noqa: E501
if 'date_from' in params:
query_params.append(('dateFrom', params['date_from'])) # noqa: E501
if 'date_to' in params:
query_params.append(('dateTo', params['date_to'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # 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(
'/crm/files', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileList', # 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 crm_files_id_data_get(self, id, **kwargs): # noqa: E501
"""Get file details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_data_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to get file data. (required)
:return: FileData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_id_data_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_files_id_data_get_with_http_info(id, **kwargs) # noqa: E501
return data
def crm_files_id_data_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get file details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_data_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to get file data. (required)
:return: FileData
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 crm_files_id_data_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 `crm_files_id_data_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(
'/crm/files/{id}/data', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileData', # 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 crm_files_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to delete. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_files_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
def crm_files_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to delete. (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 crm_files_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 `crm_files_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(
'/crm/files/{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 crm_files_id_get(self, id, **kwargs): # noqa: E501
"""Download a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to download. (required)
:return: FileDownloadableLink
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_files_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
def crm_files_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Download a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to download. (required)
:return: FileDownloadableLink
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 crm_files_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 `crm_files_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(
'/crm/files/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileDownloadableLink', # 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 crm_files_post(self, file, **kwargs): # noqa: E501
"""Upload a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_post(file, async_req=True)
>>> result = thread.get()
:param async_req bool
:param file file: File data to create a file. (required)
:param str deal_id: Deal id linked to a file
:param int contact_id: Contact id linked to a file
:param str company_id: Company id linked to a file
:return: FileData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_post_with_http_info(file, **kwargs) # noqa: E501
else:
(data) = self.crm_files_post_with_http_info(file, **kwargs) # noqa: E501
return data
def crm_files_post_with_http_info(self, file, **kwargs): # noqa: E501
"""Upload a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_post_with_http_info(file, async_req=True)
>>> result = thread.get()
:param async_req bool
:param file file: File data to create a file. (required)
:param str deal_id: Deal id linked to a file
:param int contact_id: Contact id linked to a file
:param str company_id: Company id linked to a file
:return: FileData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['file', 'deal_id', 'contact_id', 'company_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 crm_files_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'file' is set
if ('file' not in params or
params['file'] is None):
raise ValueError("Missing the required parameter `file` when calling `crm_files_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
if 'file' in params:
local_var_files['file'] = params['file'] # noqa: E501
if 'deal_id' in params:
form_params.append(('dealId', params['deal_id'])) # noqa: E501
if 'contact_id' in params:
form_params.append(('contactId', params['contact_id'])) # noqa: E501
if 'company_id' in params:
form_params.append(('companyId', params['company_id'])) # noqa: E501
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
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/crm/files', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileData', # 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,767 |
sib_api_v3_sdk.api.files_api
|
crm_files_get
|
Get all files # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by file entity type
:param str entity_ids: Filter by file entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: FileList
If the method is called asynchronously,
returns the request thread.
|
def crm_files_get(self, **kwargs): # noqa: E501
"""Get all files # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by file entity type
:param str entity_ids: Filter by file entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: FileList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.crm_files_get_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
58,768 |
sib_api_v3_sdk.api.files_api
|
crm_files_get_with_http_info
|
Get all files # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by file entity type
:param str entity_ids: Filter by file entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: FileList
If the method is called asynchronously,
returns the request thread.
|
def crm_files_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all files # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str entity: Filter by file entity type
:param str entity_ids: Filter by file entity IDs
:param int date_from: dateFrom to date range filter type (timestamp in milliseconds)
:param int date_to: dateTo to date range filter type (timestamp in milliseconds)
:param int offset: Index of the first document of the page
:param int limit: Number of documents per page
:param str sort: Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
:return: FileList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['entity', 'entity_ids', 'date_from', 'date_to', 'offset', 'limit', '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 crm_files_get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'entity' in params:
query_params.append(('entity', params['entity'])) # noqa: E501
if 'entity_ids' in params:
query_params.append(('entityIds', params['entity_ids'])) # noqa: E501
if 'date_from' in params:
query_params.append(('dateFrom', params['date_from'])) # noqa: E501
if 'date_to' in params:
query_params.append(('dateTo', params['date_to'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # 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(
'/crm/files', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileList', # 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,769 |
sib_api_v3_sdk.api.files_api
|
crm_files_id_data_get
|
Get file details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_data_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to get file data. (required)
:return: FileData
If the method is called asynchronously,
returns the request thread.
|
def crm_files_id_data_get(self, id, **kwargs): # noqa: E501
"""Get file details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_data_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to get file data. (required)
:return: FileData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_id_data_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_files_id_data_get_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,770 |
sib_api_v3_sdk.api.files_api
|
crm_files_id_data_get_with_http_info
|
Get file details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_data_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to get file data. (required)
:return: FileData
If the method is called asynchronously,
returns the request thread.
|
def crm_files_id_data_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Get file details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_data_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to get file data. (required)
:return: FileData
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 crm_files_id_data_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 `crm_files_id_data_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(
'/crm/files/{id}/data', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileData', # 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,771 |
sib_api_v3_sdk.api.files_api
|
crm_files_id_delete
|
Delete a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to delete. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_files_id_delete(self, id, **kwargs): # noqa: E501
"""Delete a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to delete. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_id_delete_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_files_id_delete_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,772 |
sib_api_v3_sdk.api.files_api
|
crm_files_id_delete_with_http_info
|
Delete a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to delete. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def crm_files_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Delete a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to delete. (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 crm_files_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 `crm_files_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(
'/crm/files/{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,773 |
sib_api_v3_sdk.api.files_api
|
crm_files_id_get
|
Download a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to download. (required)
:return: FileDownloadableLink
If the method is called asynchronously,
returns the request thread.
|
def crm_files_id_get(self, id, **kwargs): # noqa: E501
"""Download a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to download. (required)
:return: FileDownloadableLink
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_id_get_with_http_info(id, **kwargs) # noqa: E501
else:
(data) = self.crm_files_id_get_with_http_info(id, **kwargs) # noqa: E501
return data
|
(self, id, **kwargs)
|
58,774 |
sib_api_v3_sdk.api.files_api
|
crm_files_id_get_with_http_info
|
Download a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to download. (required)
:return: FileDownloadableLink
If the method is called asynchronously,
returns the request thread.
|
def crm_files_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Download a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str id: File id to download. (required)
:return: FileDownloadableLink
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 crm_files_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 `crm_files_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(
'/crm/files/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileDownloadableLink', # 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,775 |
sib_api_v3_sdk.api.files_api
|
crm_files_post
|
Upload a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_post(file, async_req=True)
>>> result = thread.get()
:param async_req bool
:param file file: File data to create a file. (required)
:param str deal_id: Deal id linked to a file
:param int contact_id: Contact id linked to a file
:param str company_id: Company id linked to a file
:return: FileData
If the method is called asynchronously,
returns the request thread.
|
def crm_files_post(self, file, **kwargs): # noqa: E501
"""Upload a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_post(file, async_req=True)
>>> result = thread.get()
:param async_req bool
:param file file: File data to create a file. (required)
:param str deal_id: Deal id linked to a file
:param int contact_id: Contact id linked to a file
:param str company_id: Company id linked to a file
:return: FileData
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.crm_files_post_with_http_info(file, **kwargs) # noqa: E501
else:
(data) = self.crm_files_post_with_http_info(file, **kwargs) # noqa: E501
return data
|
(self, file, **kwargs)
|
58,776 |
sib_api_v3_sdk.api.files_api
|
crm_files_post_with_http_info
|
Upload a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_post_with_http_info(file, async_req=True)
>>> result = thread.get()
:param async_req bool
:param file file: File data to create a file. (required)
:param str deal_id: Deal id linked to a file
:param int contact_id: Contact id linked to a file
:param str company_id: Company id linked to a file
:return: FileData
If the method is called asynchronously,
returns the request thread.
|
def crm_files_post_with_http_info(self, file, **kwargs): # noqa: E501
"""Upload a file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.crm_files_post_with_http_info(file, async_req=True)
>>> result = thread.get()
:param async_req bool
:param file file: File data to create a file. (required)
:param str deal_id: Deal id linked to a file
:param int contact_id: Contact id linked to a file
:param str company_id: Company id linked to a file
:return: FileData
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['file', 'deal_id', 'contact_id', 'company_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 crm_files_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'file' is set
if ('file' not in params or
params['file'] is None):
raise ValueError("Missing the required parameter `file` when calling `crm_files_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
if 'file' in params:
local_var_files['file'] = params['file'] # noqa: E501
if 'deal_id' in params:
form_params.append(('dealId', params['deal_id'])) # noqa: E501
if 'contact_id' in params:
form_params.append(('contactId', params['contact_id'])) # noqa: E501
if 'company_id' in params:
form_params.append(('companyId', params['company_id'])) # noqa: E501
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
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['api-key', 'partner-key'] # noqa: E501
return self.api_client.call_api(
'/crm/files', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FileData', # 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, file, **kwargs)
|
58,777 |
sib_api_v3_sdk.models.get_account
|
GetAccount
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAccount(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',
'address': 'GetExtendedClientAddress',
'plan': 'list[GetAccountPlan]',
'relay': 'GetAccountRelay',
'marketing_automation': 'GetAccountMarketingAutomation'
}
attribute_map = {
'email': 'email',
'first_name': 'firstName',
'last_name': 'lastName',
'company_name': 'companyName',
'address': 'address',
'plan': 'plan',
'relay': 'relay',
'marketing_automation': 'marketingAutomation'
}
def __init__(self, email=None, first_name=None, last_name=None, company_name=None, address=None, plan=None, relay=None, marketing_automation=None): # noqa: E501
"""GetAccount - a model defined in Swagger""" # noqa: E501
self._email = None
self._first_name = None
self._last_name = None
self._company_name = None
self._address = None
self._plan = None
self._relay = None
self._marketing_automation = None
self.discriminator = None
self.email = email
self.first_name = first_name
self.last_name = last_name
self.company_name = company_name
self.address = address
self.plan = plan
self.relay = relay
if marketing_automation is not None:
self.marketing_automation = marketing_automation
@property
def email(self):
"""Gets the email of this GetAccount. # noqa: E501
Login Email # noqa: E501
:return: The email of this GetAccount. # noqa: E501
:rtype: str
"""
return self._email
@email.setter
def email(self, email):
"""Sets the email of this GetAccount.
Login Email # noqa: E501
:param email: The email of this GetAccount. # 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 GetAccount. # noqa: E501
First Name # noqa: E501
:return: The first_name of this GetAccount. # noqa: E501
:rtype: str
"""
return self._first_name
@first_name.setter
def first_name(self, first_name):
"""Sets the first_name of this GetAccount.
First Name # noqa: E501
:param first_name: The first_name of this GetAccount. # 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 GetAccount. # noqa: E501
Last Name # noqa: E501
:return: The last_name of this GetAccount. # noqa: E501
:rtype: str
"""
return self._last_name
@last_name.setter
def last_name(self, last_name):
"""Sets the last_name of this GetAccount.
Last Name # noqa: E501
:param last_name: The last_name of this GetAccount. # 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 GetAccount. # noqa: E501
Name of the company # noqa: E501
:return: The company_name of this GetAccount. # noqa: E501
:rtype: str
"""
return self._company_name
@company_name.setter
def company_name(self, company_name):
"""Sets the company_name of this GetAccount.
Name of the company # noqa: E501
:param company_name: The company_name of this GetAccount. # 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 address(self):
"""Gets the address of this GetAccount. # noqa: E501
:return: The address of this GetAccount. # noqa: E501
:rtype: GetExtendedClientAddress
"""
return self._address
@address.setter
def address(self, address):
"""Sets the address of this GetAccount.
:param address: The address of this GetAccount. # noqa: E501
:type: GetExtendedClientAddress
"""
if address is None:
raise ValueError("Invalid value for `address`, must not be `None`") # noqa: E501
self._address = address
@property
def plan(self):
"""Gets the plan of this GetAccount. # noqa: E501
Information about your plans and credits # noqa: E501
:return: The plan of this GetAccount. # noqa: E501
:rtype: list[GetAccountPlan]
"""
return self._plan
@plan.setter
def plan(self, plan):
"""Sets the plan of this GetAccount.
Information about your plans and credits # noqa: E501
:param plan: The plan of this GetAccount. # noqa: E501
:type: list[GetAccountPlan]
"""
if plan is None:
raise ValueError("Invalid value for `plan`, must not be `None`") # noqa: E501
self._plan = plan
@property
def relay(self):
"""Gets the relay of this GetAccount. # noqa: E501
:return: The relay of this GetAccount. # noqa: E501
:rtype: GetAccountRelay
"""
return self._relay
@relay.setter
def relay(self, relay):
"""Sets the relay of this GetAccount.
:param relay: The relay of this GetAccount. # noqa: E501
:type: GetAccountRelay
"""
if relay is None:
raise ValueError("Invalid value for `relay`, must not be `None`") # noqa: E501
self._relay = relay
@property
def marketing_automation(self):
"""Gets the marketing_automation of this GetAccount. # noqa: E501
:return: The marketing_automation of this GetAccount. # noqa: E501
:rtype: GetAccountMarketingAutomation
"""
return self._marketing_automation
@marketing_automation.setter
def marketing_automation(self, marketing_automation):
"""Sets the marketing_automation of this GetAccount.
:param marketing_automation: The marketing_automation of this GetAccount. # noqa: E501
:type: GetAccountMarketingAutomation
"""
self._marketing_automation = marketing_automation
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(GetAccount, 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, GetAccount):
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, address=None, plan=None, relay=None, marketing_automation=None)
|
58,778 |
sib_api_v3_sdk.models.get_account
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAccount):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,779 |
sib_api_v3_sdk.models.get_account
|
__init__
|
GetAccount - a model defined in Swagger
|
def __init__(self, email=None, first_name=None, last_name=None, company_name=None, address=None, plan=None, relay=None, marketing_automation=None): # noqa: E501
"""GetAccount - a model defined in Swagger""" # noqa: E501
self._email = None
self._first_name = None
self._last_name = None
self._company_name = None
self._address = None
self._plan = None
self._relay = None
self._marketing_automation = None
self.discriminator = None
self.email = email
self.first_name = first_name
self.last_name = last_name
self.company_name = company_name
self.address = address
self.plan = plan
self.relay = relay
if marketing_automation is not None:
self.marketing_automation = marketing_automation
|
(self, email=None, first_name=None, last_name=None, company_name=None, address=None, plan=None, relay=None, marketing_automation=None)
|
58,782 |
sib_api_v3_sdk.models.get_account
|
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(GetAccount, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,784 |
sib_api_v3_sdk.models.get_account_marketing_automation
|
GetAccountMarketingAutomation
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAccountMarketingAutomation(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 = {
'key': 'str',
'enabled': 'bool'
}
attribute_map = {
'key': 'key',
'enabled': 'enabled'
}
def __init__(self, key=None, enabled=None): # noqa: E501
"""GetAccountMarketingAutomation - a model defined in Swagger""" # noqa: E501
self._key = None
self._enabled = None
self.discriminator = None
if key is not None:
self.key = key
self.enabled = enabled
@property
def key(self):
"""Gets the key of this GetAccountMarketingAutomation. # noqa: E501
Marketing Automation Tracker ID # noqa: E501
:return: The key of this GetAccountMarketingAutomation. # noqa: E501
:rtype: str
"""
return self._key
@key.setter
def key(self, key):
"""Sets the key of this GetAccountMarketingAutomation.
Marketing Automation Tracker ID # noqa: E501
:param key: The key of this GetAccountMarketingAutomation. # noqa: E501
:type: str
"""
self._key = key
@property
def enabled(self):
"""Gets the enabled of this GetAccountMarketingAutomation. # noqa: E501
Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) # noqa: E501
:return: The enabled of this GetAccountMarketingAutomation. # noqa: E501
:rtype: bool
"""
return self._enabled
@enabled.setter
def enabled(self, enabled):
"""Sets the enabled of this GetAccountMarketingAutomation.
Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) # noqa: E501
:param enabled: The enabled of this GetAccountMarketingAutomation. # noqa: E501
:type: bool
"""
if enabled is None:
raise ValueError("Invalid value for `enabled`, must not be `None`") # noqa: E501
self._enabled = enabled
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(GetAccountMarketingAutomation, 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, GetAccountMarketingAutomation):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(key=None, enabled=None)
|
58,785 |
sib_api_v3_sdk.models.get_account_marketing_automation
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAccountMarketingAutomation):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,786 |
sib_api_v3_sdk.models.get_account_marketing_automation
|
__init__
|
GetAccountMarketingAutomation - a model defined in Swagger
|
def __init__(self, key=None, enabled=None): # noqa: E501
"""GetAccountMarketingAutomation - a model defined in Swagger""" # noqa: E501
self._key = None
self._enabled = None
self.discriminator = None
if key is not None:
self.key = key
self.enabled = enabled
|
(self, key=None, enabled=None)
|
58,789 |
sib_api_v3_sdk.models.get_account_marketing_automation
|
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(GetAccountMarketingAutomation, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,791 |
sib_api_v3_sdk.models.get_account_plan
|
GetAccountPlan
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAccountPlan(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 = {
'type': 'str',
'credits_type': 'str',
'credits': 'float',
'start_date': 'date',
'end_date': 'date',
'user_limit': 'int'
}
attribute_map = {
'type': 'type',
'credits_type': 'creditsType',
'credits': 'credits',
'start_date': 'startDate',
'end_date': 'endDate',
'user_limit': 'userLimit'
}
def __init__(self, type=None, credits_type=None, credits=None, start_date=None, end_date=None, user_limit=None): # noqa: E501
"""GetAccountPlan - a model defined in Swagger""" # noqa: E501
self._type = None
self._credits_type = None
self._credits = None
self._start_date = None
self._end_date = None
self._user_limit = None
self.discriminator = None
self.type = type
self.credits_type = credits_type
self.credits = credits
if start_date is not None:
self.start_date = start_date
if end_date is not None:
self.end_date = end_date
if user_limit is not None:
self.user_limit = user_limit
@property
def type(self):
"""Gets the type of this GetAccountPlan. # noqa: E501
Displays the plan type of the user # noqa: E501
:return: The type of this GetAccountPlan. # noqa: E501
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""Sets the type of this GetAccountPlan.
Displays the plan type of the user # noqa: E501
:param type: The type of this GetAccountPlan. # noqa: E501
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501
allowed_values = ["payAsYouGo", "free", "subscription", "sms", "reseller"] # 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 credits_type(self):
"""Gets the credits_type of this GetAccountPlan. # noqa: E501
This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. # noqa: E501
:return: The credits_type of this GetAccountPlan. # noqa: E501
:rtype: str
"""
return self._credits_type
@credits_type.setter
def credits_type(self, credits_type):
"""Sets the credits_type of this GetAccountPlan.
This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. # noqa: E501
:param credits_type: The credits_type of this GetAccountPlan. # noqa: E501
:type: str
"""
if credits_type is None:
raise ValueError("Invalid value for `credits_type`, must not be `None`") # noqa: E501
allowed_values = ["sendLimit"] # noqa: E501
if credits_type not in allowed_values:
raise ValueError(
"Invalid value for `credits_type` ({0}), must be one of {1}" # noqa: E501
.format(credits_type, allowed_values)
)
self._credits_type = credits_type
@property
def credits(self):
"""Gets the credits of this GetAccountPlan. # noqa: E501
Remaining credits of the user # noqa: E501
:return: The credits of this GetAccountPlan. # noqa: E501
:rtype: float
"""
return self._credits
@credits.setter
def credits(self, credits):
"""Sets the credits of this GetAccountPlan.
Remaining credits of the user # noqa: E501
:param credits: The credits of this GetAccountPlan. # noqa: E501
:type: float
"""
if credits is None:
raise ValueError("Invalid value for `credits`, must not be `None`") # noqa: E501
self._credits = credits
@property
def start_date(self):
"""Gets the start_date of this GetAccountPlan. # noqa: E501
Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) # noqa: E501
:return: The start_date of this GetAccountPlan. # noqa: E501
:rtype: date
"""
return self._start_date
@start_date.setter
def start_date(self, start_date):
"""Sets the start_date of this GetAccountPlan.
Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) # noqa: E501
:param start_date: The start_date of this GetAccountPlan. # noqa: E501
:type: date
"""
self._start_date = start_date
@property
def end_date(self):
"""Gets the end_date of this GetAccountPlan. # noqa: E501
Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) # noqa: E501
:return: The end_date of this GetAccountPlan. # noqa: E501
:rtype: date
"""
return self._end_date
@end_date.setter
def end_date(self, end_date):
"""Sets the end_date of this GetAccountPlan.
Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) # noqa: E501
:param end_date: The end_date of this GetAccountPlan. # noqa: E501
:type: date
"""
self._end_date = end_date
@property
def user_limit(self):
"""Gets the user_limit of this GetAccountPlan. # noqa: E501
Only in case of reseller account. It implies the total number of child accounts you can add to your account. # noqa: E501
:return: The user_limit of this GetAccountPlan. # noqa: E501
:rtype: int
"""
return self._user_limit
@user_limit.setter
def user_limit(self, user_limit):
"""Sets the user_limit of this GetAccountPlan.
Only in case of reseller account. It implies the total number of child accounts you can add to your account. # noqa: E501
:param user_limit: The user_limit of this GetAccountPlan. # noqa: E501
:type: int
"""
self._user_limit = user_limit
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(GetAccountPlan, 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, GetAccountPlan):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(type=None, credits_type=None, credits=None, start_date=None, end_date=None, user_limit=None)
|
58,792 |
sib_api_v3_sdk.models.get_account_plan
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAccountPlan):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,793 |
sib_api_v3_sdk.models.get_account_plan
|
__init__
|
GetAccountPlan - a model defined in Swagger
|
def __init__(self, type=None, credits_type=None, credits=None, start_date=None, end_date=None, user_limit=None): # noqa: E501
"""GetAccountPlan - a model defined in Swagger""" # noqa: E501
self._type = None
self._credits_type = None
self._credits = None
self._start_date = None
self._end_date = None
self._user_limit = None
self.discriminator = None
self.type = type
self.credits_type = credits_type
self.credits = credits
if start_date is not None:
self.start_date = start_date
if end_date is not None:
self.end_date = end_date
if user_limit is not None:
self.user_limit = user_limit
|
(self, type=None, credits_type=None, credits=None, start_date=None, end_date=None, user_limit=None)
|
58,796 |
sib_api_v3_sdk.models.get_account_plan
|
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(GetAccountPlan, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,798 |
sib_api_v3_sdk.models.get_account_relay
|
GetAccountRelay
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAccountRelay(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 = {
'enabled': 'bool',
'data': 'GetAccountRelayData'
}
attribute_map = {
'enabled': 'enabled',
'data': 'data'
}
def __init__(self, enabled=None, data=None): # noqa: E501
"""GetAccountRelay - a model defined in Swagger""" # noqa: E501
self._enabled = None
self._data = None
self.discriminator = None
self.enabled = enabled
self.data = data
@property
def enabled(self):
"""Gets the enabled of this GetAccountRelay. # noqa: E501
Status of your transactional email Account (true=Enabled, false=Disabled) # noqa: E501
:return: The enabled of this GetAccountRelay. # noqa: E501
:rtype: bool
"""
return self._enabled
@enabled.setter
def enabled(self, enabled):
"""Sets the enabled of this GetAccountRelay.
Status of your transactional email Account (true=Enabled, false=Disabled) # noqa: E501
:param enabled: The enabled of this GetAccountRelay. # noqa: E501
:type: bool
"""
if enabled is None:
raise ValueError("Invalid value for `enabled`, must not be `None`") # noqa: E501
self._enabled = enabled
@property
def data(self):
"""Gets the data of this GetAccountRelay. # noqa: E501
:return: The data of this GetAccountRelay. # noqa: E501
:rtype: GetAccountRelayData
"""
return self._data
@data.setter
def data(self, data):
"""Sets the data of this GetAccountRelay.
:param data: The data of this GetAccountRelay. # noqa: E501
:type: GetAccountRelayData
"""
if data is None:
raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501
self._data = data
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(GetAccountRelay, 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, GetAccountRelay):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(enabled=None, data=None)
|
58,799 |
sib_api_v3_sdk.models.get_account_relay
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAccountRelay):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,800 |
sib_api_v3_sdk.models.get_account_relay
|
__init__
|
GetAccountRelay - a model defined in Swagger
|
def __init__(self, enabled=None, data=None): # noqa: E501
"""GetAccountRelay - a model defined in Swagger""" # noqa: E501
self._enabled = None
self._data = None
self.discriminator = None
self.enabled = enabled
self.data = data
|
(self, enabled=None, data=None)
|
58,803 |
sib_api_v3_sdk.models.get_account_relay
|
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(GetAccountRelay, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,805 |
sib_api_v3_sdk.models.get_account_relay_data
|
GetAccountRelayData
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAccountRelayData(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 = {
'user_name': 'str',
'relay': 'str',
'port': 'int'
}
attribute_map = {
'user_name': 'userName',
'relay': 'relay',
'port': 'port'
}
def __init__(self, user_name=None, relay=None, port=None): # noqa: E501
"""GetAccountRelayData - a model defined in Swagger""" # noqa: E501
self._user_name = None
self._relay = None
self._port = None
self.discriminator = None
self.user_name = user_name
self.relay = relay
self.port = port
@property
def user_name(self):
"""Gets the user_name of this GetAccountRelayData. # noqa: E501
Email to use as login on transactional platform # noqa: E501
:return: The user_name of this GetAccountRelayData. # noqa: E501
:rtype: str
"""
return self._user_name
@user_name.setter
def user_name(self, user_name):
"""Sets the user_name of this GetAccountRelayData.
Email to use as login on transactional platform # noqa: E501
:param user_name: The user_name of this GetAccountRelayData. # noqa: E501
:type: str
"""
if user_name is None:
raise ValueError("Invalid value for `user_name`, must not be `None`") # noqa: E501
self._user_name = user_name
@property
def relay(self):
"""Gets the relay of this GetAccountRelayData. # noqa: E501
URL of the SMTP Relay # noqa: E501
:return: The relay of this GetAccountRelayData. # noqa: E501
:rtype: str
"""
return self._relay
@relay.setter
def relay(self, relay):
"""Sets the relay of this GetAccountRelayData.
URL of the SMTP Relay # noqa: E501
:param relay: The relay of this GetAccountRelayData. # noqa: E501
:type: str
"""
if relay is None:
raise ValueError("Invalid value for `relay`, must not be `None`") # noqa: E501
self._relay = relay
@property
def port(self):
"""Gets the port of this GetAccountRelayData. # noqa: E501
Port used for SMTP Relay # noqa: E501
:return: The port of this GetAccountRelayData. # noqa: E501
:rtype: int
"""
return self._port
@port.setter
def port(self, port):
"""Sets the port of this GetAccountRelayData.
Port used for SMTP Relay # noqa: E501
:param port: The port of this GetAccountRelayData. # noqa: E501
:type: int
"""
if port is None:
raise ValueError("Invalid value for `port`, must not be `None`") # noqa: E501
self._port = port
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(GetAccountRelayData, 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, GetAccountRelayData):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(user_name=None, relay=None, port=None)
|
58,806 |
sib_api_v3_sdk.models.get_account_relay_data
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAccountRelayData):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,807 |
sib_api_v3_sdk.models.get_account_relay_data
|
__init__
|
GetAccountRelayData - a model defined in Swagger
|
def __init__(self, user_name=None, relay=None, port=None): # noqa: E501
"""GetAccountRelayData - a model defined in Swagger""" # noqa: E501
self._user_name = None
self._relay = None
self._port = None
self.discriminator = None
self.user_name = user_name
self.relay = relay
self.port = port
|
(self, user_name=None, relay=None, port=None)
|
58,810 |
sib_api_v3_sdk.models.get_account_relay_data
|
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(GetAccountRelayData, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,812 |
sib_api_v3_sdk.models.get_aggregated_report
|
GetAggregatedReport
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAggregatedReport(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 = {
'range': 'str',
'requests': 'int',
'delivered': 'int',
'hard_bounces': 'int',
'soft_bounces': 'int',
'clicks': 'int',
'unique_clicks': 'int',
'opens': 'int',
'unique_opens': 'int',
'spam_reports': 'int',
'blocked': 'int',
'invalid': 'int',
'unsubscribed': 'int'
}
attribute_map = {
'range': 'range',
'requests': 'requests',
'delivered': 'delivered',
'hard_bounces': 'hardBounces',
'soft_bounces': 'softBounces',
'clicks': 'clicks',
'unique_clicks': 'uniqueClicks',
'opens': 'opens',
'unique_opens': 'uniqueOpens',
'spam_reports': 'spamReports',
'blocked': 'blocked',
'invalid': 'invalid',
'unsubscribed': 'unsubscribed'
}
def __init__(self, range=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None, unsubscribed=None): # noqa: E501
"""GetAggregatedReport - a model defined in Swagger""" # noqa: E501
self._range = None
self._requests = None
self._delivered = None
self._hard_bounces = None
self._soft_bounces = None
self._clicks = None
self._unique_clicks = None
self._opens = None
self._unique_opens = None
self._spam_reports = None
self._blocked = None
self._invalid = None
self._unsubscribed = None
self.discriminator = None
if range is not None:
self.range = range
if requests is not None:
self.requests = requests
if delivered is not None:
self.delivered = delivered
if hard_bounces is not None:
self.hard_bounces = hard_bounces
if soft_bounces is not None:
self.soft_bounces = soft_bounces
if clicks is not None:
self.clicks = clicks
if unique_clicks is not None:
self.unique_clicks = unique_clicks
if opens is not None:
self.opens = opens
if unique_opens is not None:
self.unique_opens = unique_opens
if spam_reports is not None:
self.spam_reports = spam_reports
if blocked is not None:
self.blocked = blocked
if invalid is not None:
self.invalid = invalid
if unsubscribed is not None:
self.unsubscribed = unsubscribed
@property
def range(self):
"""Gets the range of this GetAggregatedReport. # noqa: E501
Time frame of the report # noqa: E501
:return: The range of this GetAggregatedReport. # noqa: E501
:rtype: str
"""
return self._range
@range.setter
def range(self, range):
"""Sets the range of this GetAggregatedReport.
Time frame of the report # noqa: E501
:param range: The range of this GetAggregatedReport. # noqa: E501
:type: str
"""
self._range = range
@property
def requests(self):
"""Gets the requests of this GetAggregatedReport. # noqa: E501
Number of requests for the timeframe # noqa: E501
:return: The requests of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._requests
@requests.setter
def requests(self, requests):
"""Sets the requests of this GetAggregatedReport.
Number of requests for the timeframe # noqa: E501
:param requests: The requests of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._requests = requests
@property
def delivered(self):
"""Gets the delivered of this GetAggregatedReport. # noqa: E501
Number of delivered emails for the timeframe # noqa: E501
:return: The delivered of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._delivered
@delivered.setter
def delivered(self, delivered):
"""Sets the delivered of this GetAggregatedReport.
Number of delivered emails for the timeframe # noqa: E501
:param delivered: The delivered of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._delivered = delivered
@property
def hard_bounces(self):
"""Gets the hard_bounces of this GetAggregatedReport. # noqa: E501
Number of hardbounces for the timeframe # noqa: E501
:return: The hard_bounces of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._hard_bounces
@hard_bounces.setter
def hard_bounces(self, hard_bounces):
"""Sets the hard_bounces of this GetAggregatedReport.
Number of hardbounces for the timeframe # noqa: E501
:param hard_bounces: The hard_bounces of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._hard_bounces = hard_bounces
@property
def soft_bounces(self):
"""Gets the soft_bounces of this GetAggregatedReport. # noqa: E501
Number of softbounces for the timeframe # noqa: E501
:return: The soft_bounces of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._soft_bounces
@soft_bounces.setter
def soft_bounces(self, soft_bounces):
"""Sets the soft_bounces of this GetAggregatedReport.
Number of softbounces for the timeframe # noqa: E501
:param soft_bounces: The soft_bounces of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._soft_bounces = soft_bounces
@property
def clicks(self):
"""Gets the clicks of this GetAggregatedReport. # noqa: E501
Number of clicks for the timeframe # noqa: E501
:return: The clicks of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._clicks
@clicks.setter
def clicks(self, clicks):
"""Sets the clicks of this GetAggregatedReport.
Number of clicks for the timeframe # noqa: E501
:param clicks: The clicks of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._clicks = clicks
@property
def unique_clicks(self):
"""Gets the unique_clicks of this GetAggregatedReport. # noqa: E501
Number of unique clicks for the timeframe # noqa: E501
:return: The unique_clicks of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._unique_clicks
@unique_clicks.setter
def unique_clicks(self, unique_clicks):
"""Sets the unique_clicks of this GetAggregatedReport.
Number of unique clicks for the timeframe # noqa: E501
:param unique_clicks: The unique_clicks of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._unique_clicks = unique_clicks
@property
def opens(self):
"""Gets the opens of this GetAggregatedReport. # noqa: E501
Number of openings for the timeframe # noqa: E501
:return: The opens of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._opens
@opens.setter
def opens(self, opens):
"""Sets the opens of this GetAggregatedReport.
Number of openings for the timeframe # noqa: E501
:param opens: The opens of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._opens = opens
@property
def unique_opens(self):
"""Gets the unique_opens of this GetAggregatedReport. # noqa: E501
Number of unique openings for the timeframe # noqa: E501
:return: The unique_opens of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._unique_opens
@unique_opens.setter
def unique_opens(self, unique_opens):
"""Sets the unique_opens of this GetAggregatedReport.
Number of unique openings for the timeframe # noqa: E501
:param unique_opens: The unique_opens of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._unique_opens = unique_opens
@property
def spam_reports(self):
"""Gets the spam_reports of this GetAggregatedReport. # noqa: E501
Number of complaint (spam report) for the timeframe # noqa: E501
:return: The spam_reports of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._spam_reports
@spam_reports.setter
def spam_reports(self, spam_reports):
"""Sets the spam_reports of this GetAggregatedReport.
Number of complaint (spam report) for the timeframe # noqa: E501
:param spam_reports: The spam_reports of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._spam_reports = spam_reports
@property
def blocked(self):
"""Gets the blocked of this GetAggregatedReport. # noqa: E501
Number of blocked contact emails for the timeframe # noqa: E501
:return: The blocked of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._blocked
@blocked.setter
def blocked(self, blocked):
"""Sets the blocked of this GetAggregatedReport.
Number of blocked contact emails for the timeframe # noqa: E501
:param blocked: The blocked of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._blocked = blocked
@property
def invalid(self):
"""Gets the invalid of this GetAggregatedReport. # noqa: E501
Number of invalid emails for the timeframe # noqa: E501
:return: The invalid of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._invalid
@invalid.setter
def invalid(self, invalid):
"""Sets the invalid of this GetAggregatedReport.
Number of invalid emails for the timeframe # noqa: E501
:param invalid: The invalid of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._invalid = invalid
@property
def unsubscribed(self):
"""Gets the unsubscribed of this GetAggregatedReport. # noqa: E501
Number of unsubscribed emails for the timeframe # noqa: E501
:return: The unsubscribed of this GetAggregatedReport. # noqa: E501
:rtype: int
"""
return self._unsubscribed
@unsubscribed.setter
def unsubscribed(self, unsubscribed):
"""Sets the unsubscribed of this GetAggregatedReport.
Number of unsubscribed emails for the timeframe # noqa: E501
:param unsubscribed: The unsubscribed of this GetAggregatedReport. # noqa: E501
:type: int
"""
self._unsubscribed = unsubscribed
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(GetAggregatedReport, 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, GetAggregatedReport):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(range=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None, unsubscribed=None)
|
58,813 |
sib_api_v3_sdk.models.get_aggregated_report
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAggregatedReport):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,814 |
sib_api_v3_sdk.models.get_aggregated_report
|
__init__
|
GetAggregatedReport - a model defined in Swagger
|
def __init__(self, range=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None, unsubscribed=None): # noqa: E501
"""GetAggregatedReport - a model defined in Swagger""" # noqa: E501
self._range = None
self._requests = None
self._delivered = None
self._hard_bounces = None
self._soft_bounces = None
self._clicks = None
self._unique_clicks = None
self._opens = None
self._unique_opens = None
self._spam_reports = None
self._blocked = None
self._invalid = None
self._unsubscribed = None
self.discriminator = None
if range is not None:
self.range = range
if requests is not None:
self.requests = requests
if delivered is not None:
self.delivered = delivered
if hard_bounces is not None:
self.hard_bounces = hard_bounces
if soft_bounces is not None:
self.soft_bounces = soft_bounces
if clicks is not None:
self.clicks = clicks
if unique_clicks is not None:
self.unique_clicks = unique_clicks
if opens is not None:
self.opens = opens
if unique_opens is not None:
self.unique_opens = unique_opens
if spam_reports is not None:
self.spam_reports = spam_reports
if blocked is not None:
self.blocked = blocked
if invalid is not None:
self.invalid = invalid
if unsubscribed is not None:
self.unsubscribed = unsubscribed
|
(self, range=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None, unsubscribed=None)
|
58,817 |
sib_api_v3_sdk.models.get_aggregated_report
|
to_dict
|
Returns the model properties as a dict
|
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
if issubclass(GetAggregatedReport, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,819 |
sib_api_v3_sdk.models.get_all_external_feeds
|
GetAllExternalFeeds
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAllExternalFeeds(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 = {
'count': 'int',
'feeds': 'list[GetAllExternalFeedsFeeds]'
}
attribute_map = {
'count': 'count',
'feeds': 'feeds'
}
def __init__(self, count=None, feeds=None): # noqa: E501
"""GetAllExternalFeeds - a model defined in Swagger""" # noqa: E501
self._count = None
self._feeds = None
self.discriminator = None
if count is not None:
self.count = count
if feeds is not None:
self.feeds = feeds
@property
def count(self):
"""Gets the count of this GetAllExternalFeeds. # noqa: E501
Total number of batches # noqa: E501
:return: The count of this GetAllExternalFeeds. # noqa: E501
:rtype: int
"""
return self._count
@count.setter
def count(self, count):
"""Sets the count of this GetAllExternalFeeds.
Total number of batches # noqa: E501
:param count: The count of this GetAllExternalFeeds. # noqa: E501
:type: int
"""
self._count = count
@property
def feeds(self):
"""Gets the feeds of this GetAllExternalFeeds. # noqa: E501
:return: The feeds of this GetAllExternalFeeds. # noqa: E501
:rtype: list[GetAllExternalFeedsFeeds]
"""
return self._feeds
@feeds.setter
def feeds(self, feeds):
"""Sets the feeds of this GetAllExternalFeeds.
:param feeds: The feeds of this GetAllExternalFeeds. # noqa: E501
:type: list[GetAllExternalFeedsFeeds]
"""
self._feeds = feeds
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(GetAllExternalFeeds, 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, GetAllExternalFeeds):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(count=None, feeds=None)
|
58,820 |
sib_api_v3_sdk.models.get_all_external_feeds
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAllExternalFeeds):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,821 |
sib_api_v3_sdk.models.get_all_external_feeds
|
__init__
|
GetAllExternalFeeds - a model defined in Swagger
|
def __init__(self, count=None, feeds=None): # noqa: E501
"""GetAllExternalFeeds - a model defined in Swagger""" # noqa: E501
self._count = None
self._feeds = None
self.discriminator = None
if count is not None:
self.count = count
if feeds is not None:
self.feeds = feeds
|
(self, count=None, feeds=None)
|
58,824 |
sib_api_v3_sdk.models.get_all_external_feeds
|
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(GetAllExternalFeeds, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,826 |
sib_api_v3_sdk.models.get_all_external_feeds_feeds
|
GetAllExternalFeedsFeeds
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAllExternalFeedsFeeds(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',
'name': 'str',
'url': 'str',
'auth_type': 'str',
'username': 'str',
'password': 'str',
'token': 'str',
'headers': 'list[GetExternalFeedByUUIDHeaders]',
'max_retries': 'int',
'cache': 'bool',
'created_at': 'datetime',
'modified_at': 'datetime'
}
attribute_map = {
'id': 'id',
'name': 'name',
'url': 'url',
'auth_type': 'authType',
'username': 'username',
'password': 'password',
'token': 'token',
'headers': 'headers',
'max_retries': 'maxRetries',
'cache': 'cache',
'created_at': 'createdAt',
'modified_at': 'modifiedAt'
}
def __init__(self, id=None, name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=None, created_at=None, modified_at=None): # noqa: E501
"""GetAllExternalFeedsFeeds - a model defined in Swagger""" # noqa: E501
self._id = None
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._created_at = None
self._modified_at = None
self.discriminator = None
self.id = id
self.name = name
self.url = url
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
self.headers = headers
self.max_retries = max_retries
self.cache = cache
self.created_at = created_at
self.modified_at = modified_at
@property
def id(self):
"""Gets the id of this GetAllExternalFeedsFeeds. # noqa: E501
ID of the feed # noqa: E501
:return: The id of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this GetAllExternalFeedsFeeds.
ID of the feed # noqa: E501
:param id: The id of this GetAllExternalFeedsFeeds. # noqa: E501
:type: str
"""
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 GetAllExternalFeedsFeeds. # noqa: E501
Name of the feed # noqa: E501
:return: The name of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this GetAllExternalFeedsFeeds.
Name of the feed # noqa: E501
:param name: The name of this GetAllExternalFeedsFeeds. # 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 GetAllExternalFeedsFeeds. # noqa: E501
URL of the feed # noqa: E501
:return: The url of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this GetAllExternalFeedsFeeds.
URL of the feed # noqa: E501
:param url: The url of this GetAllExternalFeedsFeeds. # 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 GetAllExternalFeedsFeeds. # noqa: E501
Auth type of the feed: * `basic` * `token` * `noAuth` # noqa: E501
:return: The auth_type of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._auth_type
@auth_type.setter
def auth_type(self, auth_type):
"""Sets the auth_type of this GetAllExternalFeedsFeeds.
Auth type of the feed: * `basic` * `token` * `noAuth` # noqa: E501
:param auth_type: The auth_type of this GetAllExternalFeedsFeeds. # noqa: E501
:type: str
"""
if auth_type is None:
raise ValueError("Invalid value for `auth_type`, must not be `None`") # noqa: E501
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 GetAllExternalFeedsFeeds. # noqa: E501
Username for authType `basic` # noqa: E501
:return: The username of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._username
@username.setter
def username(self, username):
"""Sets the username of this GetAllExternalFeedsFeeds.
Username for authType `basic` # noqa: E501
:param username: The username of this GetAllExternalFeedsFeeds. # noqa: E501
:type: str
"""
self._username = username
@property
def password(self):
"""Gets the password of this GetAllExternalFeedsFeeds. # noqa: E501
Password for authType `basic` # noqa: E501
:return: The password of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""Sets the password of this GetAllExternalFeedsFeeds.
Password for authType `basic` # noqa: E501
:param password: The password of this GetAllExternalFeedsFeeds. # noqa: E501
:type: str
"""
self._password = password
@property
def token(self):
"""Gets the token of this GetAllExternalFeedsFeeds. # noqa: E501
Token for authType `token` # noqa: E501
:return: The token of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: str
"""
return self._token
@token.setter
def token(self, token):
"""Sets the token of this GetAllExternalFeedsFeeds.
Token for authType `token` # noqa: E501
:param token: The token of this GetAllExternalFeedsFeeds. # noqa: E501
:type: str
"""
self._token = token
@property
def headers(self):
"""Gets the headers of this GetAllExternalFeedsFeeds. # noqa: E501
Custom headers for the feed # noqa: E501
:return: The headers of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: list[GetExternalFeedByUUIDHeaders]
"""
return self._headers
@headers.setter
def headers(self, headers):
"""Sets the headers of this GetAllExternalFeedsFeeds.
Custom headers for the feed # noqa: E501
:param headers: The headers of this GetAllExternalFeedsFeeds. # noqa: E501
:type: list[GetExternalFeedByUUIDHeaders]
"""
if headers is None:
raise ValueError("Invalid value for `headers`, must not be `None`") # noqa: E501
self._headers = headers
@property
def max_retries(self):
"""Gets the max_retries of this GetAllExternalFeedsFeeds. # noqa: E501
Maximum number of retries on the feed url # noqa: E501
:return: The max_retries of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: int
"""
return self._max_retries
@max_retries.setter
def max_retries(self, max_retries):
"""Sets the max_retries of this GetAllExternalFeedsFeeds.
Maximum number of retries on the feed url # noqa: E501
:param max_retries: The max_retries of this GetAllExternalFeedsFeeds. # noqa: E501
:type: int
"""
if max_retries is None:
raise ValueError("Invalid value for `max_retries`, must not be `None`") # noqa: E501
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 GetAllExternalFeedsFeeds. # noqa: E501
Toggle caching of feed url response # noqa: E501
:return: The cache of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: bool
"""
return self._cache
@cache.setter
def cache(self, cache):
"""Sets the cache of this GetAllExternalFeedsFeeds.
Toggle caching of feed url response # noqa: E501
:param cache: The cache of this GetAllExternalFeedsFeeds. # noqa: E501
:type: bool
"""
if cache is None:
raise ValueError("Invalid value for `cache`, must not be `None`") # noqa: E501
self._cache = cache
@property
def created_at(self):
"""Gets the created_at of this GetAllExternalFeedsFeeds. # noqa: E501
Datetime on which the feed was created # noqa: E501
:return: The created_at of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this GetAllExternalFeedsFeeds.
Datetime on which the feed was created # noqa: E501
:param created_at: The created_at of this GetAllExternalFeedsFeeds. # noqa: E501
:type: datetime
"""
if created_at is None:
raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501
self._created_at = created_at
@property
def modified_at(self):
"""Gets the modified_at of this GetAllExternalFeedsFeeds. # noqa: E501
Datetime on which the feed was modified # noqa: E501
:return: The modified_at of this GetAllExternalFeedsFeeds. # noqa: E501
:rtype: datetime
"""
return self._modified_at
@modified_at.setter
def modified_at(self, modified_at):
"""Sets the modified_at of this GetAllExternalFeedsFeeds.
Datetime on which the feed was modified # noqa: E501
:param modified_at: The modified_at of this GetAllExternalFeedsFeeds. # noqa: E501
:type: datetime
"""
if modified_at is None:
raise ValueError("Invalid value for `modified_at`, must not be `None`") # noqa: E501
self._modified_at = modified_at
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(GetAllExternalFeedsFeeds, 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, GetAllExternalFeedsFeeds):
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, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=None, created_at=None, modified_at=None)
|
58,827 |
sib_api_v3_sdk.models.get_all_external_feeds_feeds
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAllExternalFeedsFeeds):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,828 |
sib_api_v3_sdk.models.get_all_external_feeds_feeds
|
__init__
|
GetAllExternalFeedsFeeds - a model defined in Swagger
|
def __init__(self, id=None, name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=None, created_at=None, modified_at=None): # noqa: E501
"""GetAllExternalFeedsFeeds - a model defined in Swagger""" # noqa: E501
self._id = None
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._created_at = None
self._modified_at = None
self.discriminator = None
self.id = id
self.name = name
self.url = url
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
self.headers = headers
self.max_retries = max_retries
self.cache = cache
self.created_at = created_at
self.modified_at = modified_at
|
(self, id=None, name=None, url=None, auth_type=None, username=None, password=None, token=None, headers=None, max_retries=None, cache=None, created_at=None, modified_at=None)
|
58,831 |
sib_api_v3_sdk.models.get_all_external_feeds_feeds
|
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(GetAllExternalFeedsFeeds, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,833 |
sib_api_v3_sdk.models.get_attributes
|
GetAttributes
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAttributes(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 = {
'attributes': 'list[GetAttributesAttributes]'
}
attribute_map = {
'attributes': 'attributes'
}
def __init__(self, attributes=None): # noqa: E501
"""GetAttributes - a model defined in Swagger""" # noqa: E501
self._attributes = None
self.discriminator = None
self.attributes = attributes
@property
def attributes(self):
"""Gets the attributes of this GetAttributes. # noqa: E501
Listing of available contact attributes in your account # noqa: E501
:return: The attributes of this GetAttributes. # noqa: E501
:rtype: list[GetAttributesAttributes]
"""
return self._attributes
@attributes.setter
def attributes(self, attributes):
"""Sets the attributes of this GetAttributes.
Listing of available contact attributes in your account # noqa: E501
:param attributes: The attributes of this GetAttributes. # noqa: E501
:type: list[GetAttributesAttributes]
"""
if attributes is None:
raise ValueError("Invalid value for `attributes`, must not be `None`") # noqa: E501
self._attributes = attributes
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(GetAttributes, 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, GetAttributes):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(attributes=None)
|
58,834 |
sib_api_v3_sdk.models.get_attributes
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAttributes):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,835 |
sib_api_v3_sdk.models.get_attributes
|
__init__
|
GetAttributes - a model defined in Swagger
|
def __init__(self, attributes=None): # noqa: E501
"""GetAttributes - a model defined in Swagger""" # noqa: E501
self._attributes = None
self.discriminator = None
self.attributes = attributes
|
(self, attributes=None)
|
58,838 |
sib_api_v3_sdk.models.get_attributes
|
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(GetAttributes, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,840 |
sib_api_v3_sdk.models.get_attributes_attributes
|
GetAttributesAttributes
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAttributesAttributes(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',
'category': 'str',
'type': 'str',
'enumeration': 'list[GetAttributesEnumeration]',
'calculated_value': 'str'
}
attribute_map = {
'name': 'name',
'category': 'category',
'type': 'type',
'enumeration': 'enumeration',
'calculated_value': 'calculatedValue'
}
def __init__(self, name=None, category=None, type=None, enumeration=None, calculated_value=None): # noqa: E501
"""GetAttributesAttributes - a model defined in Swagger""" # noqa: E501
self._name = None
self._category = None
self._type = None
self._enumeration = None
self._calculated_value = None
self.discriminator = None
self.name = name
self.category = category
if type is not None:
self.type = type
if enumeration is not None:
self.enumeration = enumeration
if calculated_value is not None:
self.calculated_value = calculated_value
@property
def name(self):
"""Gets the name of this GetAttributesAttributes. # noqa: E501
Name of the attribute # noqa: E501
:return: The name of this GetAttributesAttributes. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this GetAttributesAttributes.
Name of the attribute # noqa: E501
:param name: The name of this GetAttributesAttributes. # 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 category(self):
"""Gets the category of this GetAttributesAttributes. # noqa: E501
Category of the attribute # noqa: E501
:return: The category of this GetAttributesAttributes. # noqa: E501
:rtype: str
"""
return self._category
@category.setter
def category(self, category):
"""Sets the category of this GetAttributesAttributes.
Category of the attribute # noqa: E501
:param category: The category of this GetAttributesAttributes. # noqa: E501
:type: str
"""
if category is None:
raise ValueError("Invalid value for `category`, must not be `None`") # noqa: E501
allowed_values = ["normal", "transactional", "category", "calculated", "global"] # noqa: E501
if category not in allowed_values:
raise ValueError(
"Invalid value for `category` ({0}), must be one of {1}" # noqa: E501
.format(category, allowed_values)
)
self._category = category
@property
def type(self):
"""Gets the type of this GetAttributesAttributes. # noqa: E501
Type of the attribute # noqa: E501
:return: The type of this GetAttributesAttributes. # noqa: E501
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""Sets the type of this GetAttributesAttributes.
Type of the attribute # noqa: E501
:param type: The type of this GetAttributesAttributes. # noqa: E501
:type: str
"""
allowed_values = ["text", "date", "float", "id", "boolean"] # 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 enumeration(self):
"""Gets the enumeration of this GetAttributesAttributes. # noqa: E501
Parameter only available for \"category\" type attributes. # noqa: E501
:return: The enumeration of this GetAttributesAttributes. # noqa: E501
:rtype: list[GetAttributesEnumeration]
"""
return self._enumeration
@enumeration.setter
def enumeration(self, enumeration):
"""Sets the enumeration of this GetAttributesAttributes.
Parameter only available for \"category\" type attributes. # noqa: E501
:param enumeration: The enumeration of this GetAttributesAttributes. # noqa: E501
:type: list[GetAttributesEnumeration]
"""
self._enumeration = enumeration
@property
def calculated_value(self):
"""Gets the calculated_value of this GetAttributesAttributes. # noqa: E501
Calculated value formula # noqa: E501
:return: The calculated_value of this GetAttributesAttributes. # noqa: E501
:rtype: str
"""
return self._calculated_value
@calculated_value.setter
def calculated_value(self, calculated_value):
"""Sets the calculated_value of this GetAttributesAttributes.
Calculated value formula # noqa: E501
:param calculated_value: The calculated_value of this GetAttributesAttributes. # noqa: E501
:type: str
"""
self._calculated_value = calculated_value
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(GetAttributesAttributes, 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, GetAttributesAttributes):
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, category=None, type=None, enumeration=None, calculated_value=None)
|
58,841 |
sib_api_v3_sdk.models.get_attributes_attributes
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAttributesAttributes):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,842 |
sib_api_v3_sdk.models.get_attributes_attributes
|
__init__
|
GetAttributesAttributes - a model defined in Swagger
|
def __init__(self, name=None, category=None, type=None, enumeration=None, calculated_value=None): # noqa: E501
"""GetAttributesAttributes - a model defined in Swagger""" # noqa: E501
self._name = None
self._category = None
self._type = None
self._enumeration = None
self._calculated_value = None
self.discriminator = None
self.name = name
self.category = category
if type is not None:
self.type = type
if enumeration is not None:
self.enumeration = enumeration
if calculated_value is not None:
self.calculated_value = calculated_value
|
(self, name=None, category=None, type=None, enumeration=None, calculated_value=None)
|
58,845 |
sib_api_v3_sdk.models.get_attributes_attributes
|
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(GetAttributesAttributes, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,847 |
sib_api_v3_sdk.models.get_attributes_enumeration
|
GetAttributesEnumeration
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetAttributesEnumeration(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
"""GetAttributesEnumeration - 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 GetAttributesEnumeration. # noqa: E501
ID of Value of the \"category\" type attribute # noqa: E501
:return: The value of this GetAttributesEnumeration. # noqa: E501
:rtype: int
"""
return self._value
@value.setter
def value(self, value):
"""Sets the value of this GetAttributesEnumeration.
ID of Value of the \"category\" type attribute # noqa: E501
:param value: The value of this GetAttributesEnumeration. # 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 GetAttributesEnumeration. # noqa: E501
Label of the \"category\" type attribute # noqa: E501
:return: The label of this GetAttributesEnumeration. # noqa: E501
:rtype: str
"""
return self._label
@label.setter
def label(self, label):
"""Sets the label of this GetAttributesEnumeration.
Label of the \"category\" type attribute # noqa: E501
:param label: The label of this GetAttributesEnumeration. # 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(GetAttributesEnumeration, 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, GetAttributesEnumeration):
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,848 |
sib_api_v3_sdk.models.get_attributes_enumeration
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetAttributesEnumeration):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,849 |
sib_api_v3_sdk.models.get_attributes_enumeration
|
__init__
|
GetAttributesEnumeration - a model defined in Swagger
|
def __init__(self, value=None, label=None): # noqa: E501
"""GetAttributesEnumeration - 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,852 |
sib_api_v3_sdk.models.get_attributes_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(GetAttributesEnumeration, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,854 |
sib_api_v3_sdk.models.get_blocked_domains
|
GetBlockedDomains
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetBlockedDomains(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 = {
'domains': 'list[str]'
}
attribute_map = {
'domains': 'domains'
}
def __init__(self, domains=None): # noqa: E501
"""GetBlockedDomains - a model defined in Swagger""" # noqa: E501
self._domains = None
self.discriminator = None
self.domains = domains
@property
def domains(self):
"""Gets the domains of this GetBlockedDomains. # noqa: E501
List of all blocked domains # noqa: E501
:return: The domains of this GetBlockedDomains. # noqa: E501
:rtype: list[str]
"""
return self._domains
@domains.setter
def domains(self, domains):
"""Sets the domains of this GetBlockedDomains.
List of all blocked domains # noqa: E501
:param domains: The domains of this GetBlockedDomains. # noqa: E501
:type: list[str]
"""
if domains is None:
raise ValueError("Invalid value for `domains`, must not be `None`") # noqa: E501
self._domains = domains
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(GetBlockedDomains, 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, GetBlockedDomains):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(domains=None)
|
58,855 |
sib_api_v3_sdk.models.get_blocked_domains
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetBlockedDomains):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,856 |
sib_api_v3_sdk.models.get_blocked_domains
|
__init__
|
GetBlockedDomains - a model defined in Swagger
|
def __init__(self, domains=None): # noqa: E501
"""GetBlockedDomains - a model defined in Swagger""" # noqa: E501
self._domains = None
self.discriminator = None
self.domains = domains
|
(self, domains=None)
|
58,859 |
sib_api_v3_sdk.models.get_blocked_domains
|
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(GetBlockedDomains, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,861 |
sib_api_v3_sdk.models.get_campaign_overview
|
GetCampaignOverview
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetCampaignOverview(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',
'subject': 'str',
'type': 'str',
'status': 'str',
'scheduled_at': 'str',
'ab_testing': 'bool',
'subject_a': 'str',
'subject_b': 'str',
'split_rule': 'int',
'winner_criteria': 'str',
'winner_delay': 'int',
'send_at_best_time': 'bool'
}
attribute_map = {
'id': 'id',
'name': 'name',
'subject': 'subject',
'type': 'type',
'status': 'status',
'scheduled_at': 'scheduledAt',
'ab_testing': 'abTesting',
'subject_a': 'subjectA',
'subject_b': 'subjectB',
'split_rule': 'splitRule',
'winner_criteria': 'winnerCriteria',
'winner_delay': 'winnerDelay',
'send_at_best_time': 'sendAtBestTime'
}
def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None): # noqa: E501
"""GetCampaignOverview - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self._subject = None
self._type = None
self._status = None
self._scheduled_at = 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._send_at_best_time = None
self.discriminator = None
self.id = id
self.name = name
if subject is not None:
self.subject = subject
self.type = type
self.status = status
if scheduled_at is not None:
self.scheduled_at = scheduled_at
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 send_at_best_time is not None:
self.send_at_best_time = send_at_best_time
@property
def id(self):
"""Gets the id of this GetCampaignOverview. # noqa: E501
ID of the campaign # noqa: E501
:return: The id of this GetCampaignOverview. # noqa: E501
:rtype: int
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this GetCampaignOverview.
ID of the campaign # noqa: E501
:param id: The id of this GetCampaignOverview. # 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 GetCampaignOverview. # noqa: E501
Name of the campaign # noqa: E501
:return: The name of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this GetCampaignOverview.
Name of the campaign # noqa: E501
:param name: The name of this GetCampaignOverview. # 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 subject(self):
"""Gets the subject of this GetCampaignOverview. # noqa: E501
Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501
:return: The subject of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._subject
@subject.setter
def subject(self, subject):
"""Sets the subject of this GetCampaignOverview.
Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501
:param subject: The subject of this GetCampaignOverview. # noqa: E501
:type: str
"""
self._subject = subject
@property
def type(self):
"""Gets the type of this GetCampaignOverview. # noqa: E501
Type of campaign # noqa: E501
:return: The type of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""Sets the type of this GetCampaignOverview.
Type of campaign # noqa: E501
:param type: The type of this GetCampaignOverview. # noqa: E501
:type: str
"""
if type is None:
raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501
allowed_values = ["classic", "trigger"] # 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 status(self):
"""Gets the status of this GetCampaignOverview. # noqa: E501
Status of the campaign # noqa: E501
:return: The status of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._status
@status.setter
def status(self, status):
"""Sets the status of this GetCampaignOverview.
Status of the campaign # noqa: E501
:param status: The status of this GetCampaignOverview. # noqa: E501
:type: str
"""
if status is None:
raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501
allowed_values = ["draft", "sent", "archive", "queued", "suspended", "in_process"] # noqa: E501
if status not in allowed_values:
raise ValueError(
"Invalid value for `status` ({0}), must be one of {1}" # noqa: E501
.format(status, allowed_values)
)
self._status = status
@property
def scheduled_at(self):
"""Gets the scheduled_at of this GetCampaignOverview. # noqa: E501
UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501
:return: The scheduled_at of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._scheduled_at
@scheduled_at.setter
def scheduled_at(self, scheduled_at):
"""Sets the scheduled_at of this GetCampaignOverview.
UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501
:param scheduled_at: The scheduled_at of this GetCampaignOverview. # noqa: E501
:type: str
"""
self._scheduled_at = scheduled_at
@property
def ab_testing(self):
"""Gets the ab_testing of this GetCampaignOverview. # noqa: E501
Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501
:return: The ab_testing of this GetCampaignOverview. # noqa: E501
:rtype: bool
"""
return self._ab_testing
@ab_testing.setter
def ab_testing(self, ab_testing):
"""Sets the ab_testing of this GetCampaignOverview.
Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501
:param ab_testing: The ab_testing of this GetCampaignOverview. # noqa: E501
:type: bool
"""
self._ab_testing = ab_testing
@property
def subject_a(self):
"""Gets the subject_a of this GetCampaignOverview. # noqa: E501
Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:return: The subject_a of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._subject_a
@subject_a.setter
def subject_a(self, subject_a):
"""Sets the subject_a of this GetCampaignOverview.
Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:param subject_a: The subject_a of this GetCampaignOverview. # noqa: E501
:type: str
"""
self._subject_a = subject_a
@property
def subject_b(self):
"""Gets the subject_b of this GetCampaignOverview. # noqa: E501
Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:return: The subject_b of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._subject_b
@subject_b.setter
def subject_b(self, subject_b):
"""Sets the subject_b of this GetCampaignOverview.
Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:param subject_b: The subject_b of this GetCampaignOverview. # noqa: E501
:type: str
"""
self._subject_b = subject_b
@property
def split_rule(self):
"""Gets the split_rule of this GetCampaignOverview. # noqa: E501
The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:return: The split_rule of this GetCampaignOverview. # noqa: E501
:rtype: int
"""
return self._split_rule
@split_rule.setter
def split_rule(self, split_rule):
"""Sets the split_rule of this GetCampaignOverview.
The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:param split_rule: The split_rule of this GetCampaignOverview. # noqa: E501
:type: int
"""
self._split_rule = split_rule
@property
def winner_criteria(self):
"""Gets the winner_criteria of this GetCampaignOverview. # noqa: E501
Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:return: The winner_criteria of this GetCampaignOverview. # noqa: E501
:rtype: str
"""
return self._winner_criteria
@winner_criteria.setter
def winner_criteria(self, winner_criteria):
"""Sets the winner_criteria of this GetCampaignOverview.
Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:param winner_criteria: The winner_criteria of this GetCampaignOverview. # noqa: E501
:type: str
"""
self._winner_criteria = winner_criteria
@property
def winner_delay(self):
"""Gets the winner_delay of this GetCampaignOverview. # noqa: E501
The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:return: The winner_delay of this GetCampaignOverview. # noqa: E501
:rtype: int
"""
return self._winner_delay
@winner_delay.setter
def winner_delay(self, winner_delay):
"""Sets the winner_delay of this GetCampaignOverview.
The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501
:param winner_delay: The winner_delay of this GetCampaignOverview. # noqa: E501
:type: int
"""
self._winner_delay = winner_delay
@property
def send_at_best_time(self):
"""Gets the send_at_best_time of this GetCampaignOverview. # noqa: E501
It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501
:return: The send_at_best_time of this GetCampaignOverview. # 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 GetCampaignOverview.
It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501
:param send_at_best_time: The send_at_best_time of this GetCampaignOverview. # noqa: E501
:type: bool
"""
self._send_at_best_time = send_at_best_time
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(GetCampaignOverview, 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, GetCampaignOverview):
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, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None)
|
58,862 |
sib_api_v3_sdk.models.get_campaign_overview
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetCampaignOverview):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,863 |
sib_api_v3_sdk.models.get_campaign_overview
|
__init__
|
GetCampaignOverview - a model defined in Swagger
|
def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None): # noqa: E501
"""GetCampaignOverview - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self._subject = None
self._type = None
self._status = None
self._scheduled_at = 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._send_at_best_time = None
self.discriminator = None
self.id = id
self.name = name
if subject is not None:
self.subject = subject
self.type = type
self.status = status
if scheduled_at is not None:
self.scheduled_at = scheduled_at
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 send_at_best_time is not None:
self.send_at_best_time = send_at_best_time
|
(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None)
|
58,866 |
sib_api_v3_sdk.models.get_campaign_overview
|
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(GetCampaignOverview, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,868 |
sib_api_v3_sdk.models.get_campaign_recipients
|
GetCampaignRecipients
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetCampaignRecipients(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 = {
'lists': 'list[int]',
'exclusion_lists': 'list[int]'
}
attribute_map = {
'lists': 'lists',
'exclusion_lists': 'exclusionLists'
}
def __init__(self, lists=None, exclusion_lists=None): # noqa: E501
"""GetCampaignRecipients - a model defined in Swagger""" # noqa: E501
self._lists = None
self._exclusion_lists = None
self.discriminator = None
self.lists = lists
self.exclusion_lists = exclusion_lists
@property
def lists(self):
"""Gets the lists of this GetCampaignRecipients. # noqa: E501
:return: The lists of this GetCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._lists
@lists.setter
def lists(self, lists):
"""Sets the lists of this GetCampaignRecipients.
:param lists: The lists of this GetCampaignRecipients. # noqa: E501
:type: list[int]
"""
if lists is None:
raise ValueError("Invalid value for `lists`, must not be `None`") # noqa: E501
self._lists = lists
@property
def exclusion_lists(self):
"""Gets the exclusion_lists of this GetCampaignRecipients. # noqa: E501
:return: The exclusion_lists of this GetCampaignRecipients. # noqa: E501
:rtype: list[int]
"""
return self._exclusion_lists
@exclusion_lists.setter
def exclusion_lists(self, exclusion_lists):
"""Sets the exclusion_lists of this GetCampaignRecipients.
:param exclusion_lists: The exclusion_lists of this GetCampaignRecipients. # noqa: E501
:type: list[int]
"""
if exclusion_lists is None:
raise ValueError("Invalid value for `exclusion_lists`, must not be `None`") # noqa: E501
self._exclusion_lists = exclusion_lists
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(GetCampaignRecipients, 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, GetCampaignRecipients):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(lists=None, exclusion_lists=None)
|
58,869 |
sib_api_v3_sdk.models.get_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, GetCampaignRecipients):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,870 |
sib_api_v3_sdk.models.get_campaign_recipients
|
__init__
|
GetCampaignRecipients - a model defined in Swagger
|
def __init__(self, lists=None, exclusion_lists=None): # noqa: E501
"""GetCampaignRecipients - a model defined in Swagger""" # noqa: E501
self._lists = None
self._exclusion_lists = None
self.discriminator = None
self.lists = lists
self.exclusion_lists = exclusion_lists
|
(self, lists=None, exclusion_lists=None)
|
58,873 |
sib_api_v3_sdk.models.get_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(GetCampaignRecipients, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,875 |
sib_api_v3_sdk.models.get_campaign_stats
|
GetCampaignStats
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetCampaignStats(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 = {
'list_id': 'int',
'unique_clicks': 'int',
'clickers': 'int',
'complaints': 'int',
'delivered': 'int',
'sent': 'int',
'soft_bounces': 'int',
'hard_bounces': 'int',
'unique_views': 'int',
'trackable_views': 'int',
'trackable_views_rate': 'float',
'estimated_views': 'int',
'unsubscriptions': 'int',
'viewed': 'int',
'deferred': 'int',
'return_bounce': 'int'
}
attribute_map = {
'list_id': 'listId',
'unique_clicks': 'uniqueClicks',
'clickers': 'clickers',
'complaints': 'complaints',
'delivered': 'delivered',
'sent': 'sent',
'soft_bounces': 'softBounces',
'hard_bounces': 'hardBounces',
'unique_views': 'uniqueViews',
'trackable_views': 'trackableViews',
'trackable_views_rate': 'trackableViewsRate',
'estimated_views': 'estimatedViews',
'unsubscriptions': 'unsubscriptions',
'viewed': 'viewed',
'deferred': 'deferred',
'return_bounce': 'returnBounce'
}
def __init__(self, list_id=None, unique_clicks=None, clickers=None, complaints=None, delivered=None, sent=None, soft_bounces=None, hard_bounces=None, unique_views=None, trackable_views=None, trackable_views_rate=None, estimated_views=None, unsubscriptions=None, viewed=None, deferred=None, return_bounce=None): # noqa: E501
"""GetCampaignStats - a model defined in Swagger""" # noqa: E501
self._list_id = None
self._unique_clicks = None
self._clickers = None
self._complaints = None
self._delivered = None
self._sent = None
self._soft_bounces = None
self._hard_bounces = None
self._unique_views = None
self._trackable_views = None
self._trackable_views_rate = None
self._estimated_views = None
self._unsubscriptions = None
self._viewed = None
self._deferred = None
self._return_bounce = None
self.discriminator = None
if list_id is not None:
self.list_id = list_id
self.unique_clicks = unique_clicks
self.clickers = clickers
self.complaints = complaints
self.delivered = delivered
self.sent = sent
self.soft_bounces = soft_bounces
self.hard_bounces = hard_bounces
self.unique_views = unique_views
self.trackable_views = trackable_views
if trackable_views_rate is not None:
self.trackable_views_rate = trackable_views_rate
if estimated_views is not None:
self.estimated_views = estimated_views
self.unsubscriptions = unsubscriptions
self.viewed = viewed
if deferred is not None:
self.deferred = deferred
if return_bounce is not None:
self.return_bounce = return_bounce
@property
def list_id(self):
"""Gets the list_id of this GetCampaignStats. # noqa: E501
List Id of email campaign (only in case of get email campaign(s)(not for global stats)) # noqa: E501
:return: The list_id of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._list_id
@list_id.setter
def list_id(self, list_id):
"""Sets the list_id of this GetCampaignStats.
List Id of email campaign (only in case of get email campaign(s)(not for global stats)) # noqa: E501
:param list_id: The list_id of this GetCampaignStats. # noqa: E501
:type: int
"""
self._list_id = list_id
@property
def unique_clicks(self):
"""Gets the unique_clicks of this GetCampaignStats. # noqa: E501
Number of unique clicks for the campaign # noqa: E501
:return: The unique_clicks of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._unique_clicks
@unique_clicks.setter
def unique_clicks(self, unique_clicks):
"""Sets the unique_clicks of this GetCampaignStats.
Number of unique clicks for the campaign # noqa: E501
:param unique_clicks: The unique_clicks of this GetCampaignStats. # noqa: E501
:type: int
"""
if unique_clicks is None:
raise ValueError("Invalid value for `unique_clicks`, must not be `None`") # noqa: E501
self._unique_clicks = unique_clicks
@property
def clickers(self):
"""Gets the clickers of this GetCampaignStats. # noqa: E501
Number of total clicks for the campaign # noqa: E501
:return: The clickers of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._clickers
@clickers.setter
def clickers(self, clickers):
"""Sets the clickers of this GetCampaignStats.
Number of total clicks for the campaign # noqa: E501
:param clickers: The clickers of this GetCampaignStats. # noqa: E501
:type: int
"""
if clickers is None:
raise ValueError("Invalid value for `clickers`, must not be `None`") # noqa: E501
self._clickers = clickers
@property
def complaints(self):
"""Gets the complaints of this GetCampaignStats. # noqa: E501
Number of complaints (Spam reports) for the campaign # noqa: E501
:return: The complaints of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._complaints
@complaints.setter
def complaints(self, complaints):
"""Sets the complaints of this GetCampaignStats.
Number of complaints (Spam reports) for the campaign # noqa: E501
:param complaints: The complaints of this GetCampaignStats. # noqa: E501
:type: int
"""
if complaints is None:
raise ValueError("Invalid value for `complaints`, must not be `None`") # noqa: E501
self._complaints = complaints
@property
def delivered(self):
"""Gets the delivered of this GetCampaignStats. # noqa: E501
Number of delivered emails for the campaign # noqa: E501
:return: The delivered of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._delivered
@delivered.setter
def delivered(self, delivered):
"""Sets the delivered of this GetCampaignStats.
Number of delivered emails for the campaign # noqa: E501
:param delivered: The delivered of this GetCampaignStats. # noqa: E501
:type: int
"""
if delivered is None:
raise ValueError("Invalid value for `delivered`, must not be `None`") # noqa: E501
self._delivered = delivered
@property
def sent(self):
"""Gets the sent of this GetCampaignStats. # noqa: E501
Number of sent emails for the campaign # noqa: E501
:return: The sent of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._sent
@sent.setter
def sent(self, sent):
"""Sets the sent of this GetCampaignStats.
Number of sent emails for the campaign # noqa: E501
:param sent: The sent of this GetCampaignStats. # noqa: E501
:type: int
"""
if sent is None:
raise ValueError("Invalid value for `sent`, must not be `None`") # noqa: E501
self._sent = sent
@property
def soft_bounces(self):
"""Gets the soft_bounces of this GetCampaignStats. # noqa: E501
Number of softbounce for the campaign # noqa: E501
:return: The soft_bounces of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._soft_bounces
@soft_bounces.setter
def soft_bounces(self, soft_bounces):
"""Sets the soft_bounces of this GetCampaignStats.
Number of softbounce for the campaign # noqa: E501
:param soft_bounces: The soft_bounces of this GetCampaignStats. # noqa: E501
:type: int
"""
if soft_bounces is None:
raise ValueError("Invalid value for `soft_bounces`, must not be `None`") # noqa: E501
self._soft_bounces = soft_bounces
@property
def hard_bounces(self):
"""Gets the hard_bounces of this GetCampaignStats. # noqa: E501
Number of harbounce for the campaign # noqa: E501
:return: The hard_bounces of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._hard_bounces
@hard_bounces.setter
def hard_bounces(self, hard_bounces):
"""Sets the hard_bounces of this GetCampaignStats.
Number of harbounce for the campaign # noqa: E501
:param hard_bounces: The hard_bounces of this GetCampaignStats. # noqa: E501
:type: int
"""
if hard_bounces is None:
raise ValueError("Invalid value for `hard_bounces`, must not be `None`") # noqa: E501
self._hard_bounces = hard_bounces
@property
def unique_views(self):
"""Gets the unique_views of this GetCampaignStats. # noqa: E501
Number of unique openings for the campaign # noqa: E501
:return: The unique_views of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._unique_views
@unique_views.setter
def unique_views(self, unique_views):
"""Sets the unique_views of this GetCampaignStats.
Number of unique openings for the campaign # noqa: E501
:param unique_views: The unique_views of this GetCampaignStats. # noqa: E501
:type: int
"""
if unique_views is None:
raise ValueError("Invalid value for `unique_views`, must not be `None`") # noqa: E501
self._unique_views = unique_views
@property
def trackable_views(self):
"""Gets the trackable_views of this GetCampaignStats. # noqa: E501
Recipients without any privacy protection option enabled in their email client # noqa: E501
:return: The trackable_views of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._trackable_views
@trackable_views.setter
def trackable_views(self, trackable_views):
"""Sets the trackable_views of this GetCampaignStats.
Recipients without any privacy protection option enabled in their email client # noqa: E501
:param trackable_views: The trackable_views of this GetCampaignStats. # noqa: E501
:type: int
"""
if trackable_views is None:
raise ValueError("Invalid value for `trackable_views`, must not be `None`") # noqa: E501
self._trackable_views = trackable_views
@property
def trackable_views_rate(self):
"""Gets the trackable_views_rate of this GetCampaignStats. # noqa: E501
Rate of recipients without any privacy protection option enabled in their email client # noqa: E501
:return: The trackable_views_rate of this GetCampaignStats. # noqa: E501
:rtype: float
"""
return self._trackable_views_rate
@trackable_views_rate.setter
def trackable_views_rate(self, trackable_views_rate):
"""Sets the trackable_views_rate of this GetCampaignStats.
Rate of recipients without any privacy protection option enabled in their email client # noqa: E501
:param trackable_views_rate: The trackable_views_rate of this GetCampaignStats. # noqa: E501
:type: float
"""
self._trackable_views_rate = trackable_views_rate
@property
def estimated_views(self):
"""Gets the estimated_views of this GetCampaignStats. # noqa: E501
Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails # noqa: E501
:return: The estimated_views of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._estimated_views
@estimated_views.setter
def estimated_views(self, estimated_views):
"""Sets the estimated_views of this GetCampaignStats.
Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails # noqa: E501
:param estimated_views: The estimated_views of this GetCampaignStats. # noqa: E501
:type: int
"""
self._estimated_views = estimated_views
@property
def unsubscriptions(self):
"""Gets the unsubscriptions of this GetCampaignStats. # noqa: E501
Number of unsubscription for the campaign # noqa: E501
:return: The unsubscriptions of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._unsubscriptions
@unsubscriptions.setter
def unsubscriptions(self, unsubscriptions):
"""Sets the unsubscriptions of this GetCampaignStats.
Number of unsubscription for the campaign # noqa: E501
:param unsubscriptions: The unsubscriptions of this GetCampaignStats. # noqa: E501
:type: int
"""
if unsubscriptions is None:
raise ValueError("Invalid value for `unsubscriptions`, must not be `None`") # noqa: E501
self._unsubscriptions = unsubscriptions
@property
def viewed(self):
"""Gets the viewed of this GetCampaignStats. # noqa: E501
Number of openings for the campaign # noqa: E501
:return: The viewed of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._viewed
@viewed.setter
def viewed(self, viewed):
"""Sets the viewed of this GetCampaignStats.
Number of openings for the campaign # noqa: E501
:param viewed: The viewed of this GetCampaignStats. # noqa: E501
:type: int
"""
if viewed is None:
raise ValueError("Invalid value for `viewed`, must not be `None`") # noqa: E501
self._viewed = viewed
@property
def deferred(self):
"""Gets the deferred of this GetCampaignStats. # noqa: E501
Number of deferred emails for the campaign # noqa: E501
:return: The deferred of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._deferred
@deferred.setter
def deferred(self, deferred):
"""Sets the deferred of this GetCampaignStats.
Number of deferred emails for the campaign # noqa: E501
:param deferred: The deferred of this GetCampaignStats. # noqa: E501
:type: int
"""
self._deferred = deferred
@property
def return_bounce(self):
"""Gets the return_bounce of this GetCampaignStats. # noqa: E501
Total number of non-delivered campaigns for a particular campaign id. # noqa: E501
:return: The return_bounce of this GetCampaignStats. # noqa: E501
:rtype: int
"""
return self._return_bounce
@return_bounce.setter
def return_bounce(self, return_bounce):
"""Sets the return_bounce of this GetCampaignStats.
Total number of non-delivered campaigns for a particular campaign id. # noqa: E501
:param return_bounce: The return_bounce of this GetCampaignStats. # noqa: E501
:type: int
"""
self._return_bounce = return_bounce
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(GetCampaignStats, 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, GetCampaignStats):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(list_id=None, unique_clicks=None, clickers=None, complaints=None, delivered=None, sent=None, soft_bounces=None, hard_bounces=None, unique_views=None, trackable_views=None, trackable_views_rate=None, estimated_views=None, unsubscriptions=None, viewed=None, deferred=None, return_bounce=None)
|
58,876 |
sib_api_v3_sdk.models.get_campaign_stats
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetCampaignStats):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,877 |
sib_api_v3_sdk.models.get_campaign_stats
|
__init__
|
GetCampaignStats - a model defined in Swagger
|
def __init__(self, list_id=None, unique_clicks=None, clickers=None, complaints=None, delivered=None, sent=None, soft_bounces=None, hard_bounces=None, unique_views=None, trackable_views=None, trackable_views_rate=None, estimated_views=None, unsubscriptions=None, viewed=None, deferred=None, return_bounce=None): # noqa: E501
"""GetCampaignStats - a model defined in Swagger""" # noqa: E501
self._list_id = None
self._unique_clicks = None
self._clickers = None
self._complaints = None
self._delivered = None
self._sent = None
self._soft_bounces = None
self._hard_bounces = None
self._unique_views = None
self._trackable_views = None
self._trackable_views_rate = None
self._estimated_views = None
self._unsubscriptions = None
self._viewed = None
self._deferred = None
self._return_bounce = None
self.discriminator = None
if list_id is not None:
self.list_id = list_id
self.unique_clicks = unique_clicks
self.clickers = clickers
self.complaints = complaints
self.delivered = delivered
self.sent = sent
self.soft_bounces = soft_bounces
self.hard_bounces = hard_bounces
self.unique_views = unique_views
self.trackable_views = trackable_views
if trackable_views_rate is not None:
self.trackable_views_rate = trackable_views_rate
if estimated_views is not None:
self.estimated_views = estimated_views
self.unsubscriptions = unsubscriptions
self.viewed = viewed
if deferred is not None:
self.deferred = deferred
if return_bounce is not None:
self.return_bounce = return_bounce
|
(self, list_id=None, unique_clicks=None, clickers=None, complaints=None, delivered=None, sent=None, soft_bounces=None, hard_bounces=None, unique_views=None, trackable_views=None, trackable_views_rate=None, estimated_views=None, unsubscriptions=None, viewed=None, deferred=None, return_bounce=None)
|
58,880 |
sib_api_v3_sdk.models.get_campaign_stats
|
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(GetCampaignStats, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,882 |
sib_api_v3_sdk.models.get_categories
|
GetCategories
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetCategories(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 = {
'categories': 'list[object]',
'count': 'int'
}
attribute_map = {
'categories': 'categories',
'count': 'count'
}
def __init__(self, categories=None, count=None): # noqa: E501
"""GetCategories - a model defined in Swagger""" # noqa: E501
self._categories = None
self._count = None
self.discriminator = None
self.categories = categories
self.count = count
@property
def categories(self):
"""Gets the categories of this GetCategories. # noqa: E501
:return: The categories of this GetCategories. # noqa: E501
:rtype: list[object]
"""
return self._categories
@categories.setter
def categories(self, categories):
"""Sets the categories of this GetCategories.
:param categories: The categories of this GetCategories. # noqa: E501
:type: list[object]
"""
if categories is None:
raise ValueError("Invalid value for `categories`, must not be `None`") # noqa: E501
self._categories = categories
@property
def count(self):
"""Gets the count of this GetCategories. # noqa: E501
Number of categories # noqa: E501
:return: The count of this GetCategories. # noqa: E501
:rtype: int
"""
return self._count
@count.setter
def count(self, count):
"""Sets the count of this GetCategories.
Number of categories # noqa: E501
:param count: The count of this GetCategories. # noqa: E501
:type: int
"""
if count is None:
raise ValueError("Invalid value for `count`, must not be `None`") # noqa: E501
self._count = count
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(GetCategories, 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, GetCategories):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
|
(categories=None, count=None)
|
58,883 |
sib_api_v3_sdk.models.get_categories
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetCategories):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,884 |
sib_api_v3_sdk.models.get_categories
|
__init__
|
GetCategories - a model defined in Swagger
|
def __init__(self, categories=None, count=None): # noqa: E501
"""GetCategories - a model defined in Swagger""" # noqa: E501
self._categories = None
self._count = None
self.discriminator = None
self.categories = categories
self.count = count
|
(self, categories=None, count=None)
|
58,887 |
sib_api_v3_sdk.models.get_categories
|
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(GetCategories, dict):
for key, value in self.items():
result[key] = value
return result
|
(self)
|
58,889 |
sib_api_v3_sdk.models.get_category_details
|
GetCategoryDetails
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
|
class GetCategoryDetails(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',
'name': 'str',
'created_at': 'str',
'modified_at': 'str',
'url': 'str',
'is_deleted': 'bool'
}
attribute_map = {
'id': 'id',
'name': 'name',
'created_at': 'createdAt',
'modified_at': 'modifiedAt',
'url': 'url',
'is_deleted': 'isDeleted'
}
def __init__(self, id=None, name=None, created_at=None, modified_at=None, url=None, is_deleted=None): # noqa: E501
"""GetCategoryDetails - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self._created_at = None
self._modified_at = None
self._url = None
self._is_deleted = None
self.discriminator = None
self.id = id
self.name = name
self.created_at = created_at
self.modified_at = modified_at
if url is not None:
self.url = url
if is_deleted is not None:
self.is_deleted = is_deleted
@property
def id(self):
"""Gets the id of this GetCategoryDetails. # noqa: E501
Category ID for which you requested the details # noqa: E501
:return: The id of this GetCategoryDetails. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this GetCategoryDetails.
Category ID for which you requested the details # noqa: E501
:param id: The id of this GetCategoryDetails. # noqa: E501
:type: str
"""
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 GetCategoryDetails. # noqa: E501
Name of the category for which you requested the details # noqa: E501
:return: The name of this GetCategoryDetails. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this GetCategoryDetails.
Name of the category for which you requested the details # noqa: E501
:param name: The name of this GetCategoryDetails. # 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 created_at(self):
"""Gets the created_at of this GetCategoryDetails. # noqa: E501
Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501
:return: The created_at of this GetCategoryDetails. # noqa: E501
:rtype: str
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this GetCategoryDetails.
Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501
:param created_at: The created_at of this GetCategoryDetails. # noqa: E501
:type: str
"""
if created_at is None:
raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501
self._created_at = created_at
@property
def modified_at(self):
"""Gets the modified_at of this GetCategoryDetails. # noqa: E501
Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501
:return: The modified_at of this GetCategoryDetails. # noqa: E501
:rtype: str
"""
return self._modified_at
@modified_at.setter
def modified_at(self, modified_at):
"""Sets the modified_at of this GetCategoryDetails.
Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501
:param modified_at: The modified_at of this GetCategoryDetails. # noqa: E501
:type: str
"""
if modified_at is None:
raise ValueError("Invalid value for `modified_at`, must not be `None`") # noqa: E501
self._modified_at = modified_at
@property
def url(self):
"""Gets the url of this GetCategoryDetails. # noqa: E501
URL to the category # noqa: E501
:return: The url of this GetCategoryDetails. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this GetCategoryDetails.
URL to the category # noqa: E501
:param url: The url of this GetCategoryDetails. # noqa: E501
:type: str
"""
self._url = url
@property
def is_deleted(self):
"""Gets the is_deleted of this GetCategoryDetails. # noqa: E501
category deleted from the shop's database # noqa: E501
:return: The is_deleted of this GetCategoryDetails. # noqa: E501
:rtype: bool
"""
return self._is_deleted
@is_deleted.setter
def is_deleted(self, is_deleted):
"""Sets the is_deleted of this GetCategoryDetails.
category deleted from the shop's database # noqa: E501
:param is_deleted: The is_deleted of this GetCategoryDetails. # noqa: E501
:type: bool
"""
self._is_deleted = is_deleted
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(GetCategoryDetails, 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, GetCategoryDetails):
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, created_at=None, modified_at=None, url=None, is_deleted=None)
|
58,890 |
sib_api_v3_sdk.models.get_category_details
|
__eq__
|
Returns true if both objects are equal
|
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetCategoryDetails):
return False
return self.__dict__ == other.__dict__
|
(self, other)
|
58,891 |
sib_api_v3_sdk.models.get_category_details
|
__init__
|
GetCategoryDetails - a model defined in Swagger
|
def __init__(self, id=None, name=None, created_at=None, modified_at=None, url=None, is_deleted=None): # noqa: E501
"""GetCategoryDetails - a model defined in Swagger""" # noqa: E501
self._id = None
self._name = None
self._created_at = None
self._modified_at = None
self._url = None
self._is_deleted = None
self.discriminator = None
self.id = id
self.name = name
self.created_at = created_at
self.modified_at = modified_at
if url is not None:
self.url = url
if is_deleted is not None:
self.is_deleted = is_deleted
|
(self, id=None, name=None, created_at=None, modified_at=None, url=None, is_deleted=None)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.