# coding: utf-8 """ SendinBlue API SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 OpenAPI spec version: 3.0.0 Contact: contact@sendinblue.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ from __future__ import absolute_import import re # noqa: F401 # python 2 and python 3 compatibility library import six from sib_api_v3_sdk.api_client import ApiClient class EmailCampaignsApi(object): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def create_email_campaign(self, email_campaigns, **kwargs): # noqa: E501 """Create an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_email_campaign(email_campaigns, async_req=True) >>> result = thread.get() :param async_req bool :param CreateEmailCampaign email_campaigns: Values to create a campaign (required) :return: CreateModel If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.create_email_campaign_with_http_info(email_campaigns, **kwargs) # noqa: E501 else: (data) = self.create_email_campaign_with_http_info(email_campaigns, **kwargs) # noqa: E501 return data def create_email_campaign_with_http_info(self, email_campaigns, **kwargs): # noqa: E501 """Create an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_email_campaign_with_http_info(email_campaigns, async_req=True) >>> result = thread.get() :param async_req bool :param CreateEmailCampaign email_campaigns: Values to create a campaign (required) :return: CreateModel If the method is called asynchronously, returns the request thread. """ all_params = ['email_campaigns'] # 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_email_campaign" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'email_campaigns' is set if ('email_campaigns' not in params or params['email_campaigns'] is None): raise ValueError("Missing the required parameter `email_campaigns` when calling `create_email_campaign`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_campaigns' in params: body_params = params['email_campaigns'] # 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( '/emailCampaigns', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CreateModel', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def delete_email_campaign(self, campaign_id, **kwargs): # noqa: E501 """Delete an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_campaign(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: id of the campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.delete_email_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501 else: (data) = self.delete_email_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501 return data def delete_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501 """Delete an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_campaign_with_http_info(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: id of the campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method delete_email_campaign" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `delete_email_campaign`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def email_export_recipients(self, campaign_id, **kwargs): # noqa: E501 """Export the recipients of an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.email_export_recipients(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param EmailExportRecipients recipient_export: Values to send for a recipient export request :return: CreatedProcessId If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.email_export_recipients_with_http_info(campaign_id, **kwargs) # noqa: E501 else: (data) = self.email_export_recipients_with_http_info(campaign_id, **kwargs) # noqa: E501 return data def email_export_recipients_with_http_info(self, campaign_id, **kwargs): # noqa: E501 """Export the recipients of an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.email_export_recipients_with_http_info(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param EmailExportRecipients recipient_export: Values to send for a recipient export request :return: CreatedProcessId If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id', 'recipient_export'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method email_export_recipients" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `email_export_recipients`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'recipient_export' in params: body_params = params['recipient_export'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/exportRecipients', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CreatedProcessId', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def get_ab_test_campaign_result(self, campaign_id, **kwargs): # noqa: E501 """Get an A/B test email campaign results # noqa: E501 Obtain winning version of an A/B test email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ab_test_campaign_result(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the A/B test campaign (required) :return: AbTestCampaignResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_ab_test_campaign_result_with_http_info(campaign_id, **kwargs) # noqa: E501 else: (data) = self.get_ab_test_campaign_result_with_http_info(campaign_id, **kwargs) # noqa: E501 return data def get_ab_test_campaign_result_with_http_info(self, campaign_id, **kwargs): # noqa: E501 """Get an A/B test email campaign results # noqa: E501 Obtain winning version of an A/B test email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ab_test_campaign_result_with_http_info(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the A/B test campaign (required) :return: AbTestCampaignResult If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_ab_test_campaign_result" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `get_ab_test_campaign_result`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/abTestCampaignResult', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AbTestCampaignResult', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def get_email_campaign(self, campaign_id, **kwargs): # noqa: E501 """Get an email campaign report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_campaign(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :return: GetEmailCampaign If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_email_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501 else: (data) = self.get_email_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501 return data def get_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501 """Get an email campaign report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_campaign_with_http_info(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :return: GetEmailCampaign If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_email_campaign" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `get_email_campaign`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetEmailCampaign', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def get_email_campaigns(self, **kwargs): # noqa: E501 """Return all your created email campaigns # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_campaigns(async_req=True) >>> result = thread.get() :param async_req bool :param str type: Filter on the type of the campaigns :param str status: Filter on the status of the campaign :param datetime start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param datetime end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param int limit: Number of documents per page :param int offset: Index of the first document in the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetEmailCampaigns If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_email_campaigns_with_http_info(**kwargs) # noqa: E501 else: (data) = self.get_email_campaigns_with_http_info(**kwargs) # noqa: E501 return data def get_email_campaigns_with_http_info(self, **kwargs): # noqa: E501 """Return all your created email campaigns # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_campaigns_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :param str type: Filter on the type of the campaigns :param str status: Filter on the status of the campaign :param datetime start_date: Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param datetime end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param int limit: Number of documents per page :param int offset: Index of the first document in the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetEmailCampaigns If the method is called asynchronously, returns the request thread. """ all_params = ['type', 'status', 'start_date', 'end_date', 'limit', 'offset', 'sort'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_email_campaigns" % key ) params[key] = val del params['kwargs'] if 'limit' in params and params['limit'] > 1000: # noqa: E501 raise ValueError("Invalid value for parameter `limit` when calling `get_email_campaigns`, must be a value less than or equal to `1000`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'type' in params: query_params.append(('type', params['type'])) # noqa: E501 if 'status' in params: query_params.append(('status', params['status'])) # noqa: E501 if 'start_date' in params: query_params.append(('startDate', params['start_date'])) # noqa: E501 if 'end_date' in params: query_params.append(('endDate', params['end_date'])) # noqa: E501 if 'limit' in params: query_params.append(('limit', params['limit'])) # noqa: E501 if 'offset' in params: query_params.append(('offset', params['offset'])) # noqa: E501 if 'sort' in params: query_params.append(('sort', params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetEmailCampaigns', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def get_shared_template_url(self, campaign_id, **kwargs): # noqa: E501 """Get a shared template url # noqa: E501 Get a unique URL to share & import an email template from one Sendinblue account to another. # 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_shared_template_url(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign or template (required) :return: GetSharedTemplateUrl If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_shared_template_url_with_http_info(campaign_id, **kwargs) # noqa: E501 else: (data) = self.get_shared_template_url_with_http_info(campaign_id, **kwargs) # noqa: E501 return data def get_shared_template_url_with_http_info(self, campaign_id, **kwargs): # noqa: E501 """Get a shared template url # noqa: E501 Get a unique URL to share & import an email template from one Sendinblue account to another. # 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_shared_template_url_with_http_info(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign or template (required) :return: GetSharedTemplateUrl If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_shared_template_url" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `get_shared_template_url`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/sharedUrl', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetSharedTemplateUrl', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def send_email_campaign_now(self, campaign_id, **kwargs): # noqa: E501 """Send an email campaign immediately, based on campaignId # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_campaign_now(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.send_email_campaign_now_with_http_info(campaign_id, **kwargs) # noqa: E501 else: (data) = self.send_email_campaign_now_with_http_info(campaign_id, **kwargs) # noqa: E501 return data def send_email_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa: E501 """Send an email campaign immediately, based on campaignId # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_email_campaign_now_with_http_info(campaign_id, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method send_email_campaign_now" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `send_email_campaign_now`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/sendNow', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def send_report(self, campaign_id, send_report, **kwargs): # noqa: E501 """Send the report of a campaign # noqa: E501 A PDF will be sent to the specified email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_report(campaign_id, send_report, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param SendReport send_report: Values for send a report (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.send_report_with_http_info(campaign_id, send_report, **kwargs) # noqa: E501 else: (data) = self.send_report_with_http_info(campaign_id, send_report, **kwargs) # noqa: E501 return data def send_report_with_http_info(self, campaign_id, send_report, **kwargs): # noqa: E501 """Send the report of a campaign # noqa: E501 A PDF will be sent to the specified email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_report_with_http_info(campaign_id, send_report, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param SendReport send_report: Values for send a report (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id', 'send_report'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method send_report" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `send_report`") # noqa: E501 # verify the required parameter 'send_report' is set if ('send_report' not in params or params['send_report'] is None): raise ValueError("Missing the required parameter `send_report` when calling `send_report`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'send_report' in params: body_params = params['send_report'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/sendReport', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def send_test_email(self, campaign_id, email_to, **kwargs): # noqa: E501 """Send an email campaign to your test list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_test_email(campaign_id, email_to, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param SendTestEmail email_to: (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.send_test_email_with_http_info(campaign_id, email_to, **kwargs) # noqa: E501 else: (data) = self.send_test_email_with_http_info(campaign_id, email_to, **kwargs) # noqa: E501 return data def send_test_email_with_http_info(self, campaign_id, email_to, **kwargs): # noqa: E501 """Send an email campaign to your test list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.send_test_email_with_http_info(campaign_id, email_to, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param SendTestEmail email_to: (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id', 'email_to'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method send_test_email" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `send_test_email`") # noqa: E501 # verify the required parameter 'email_to' is set if ('email_to' not in params or params['email_to'] is None): raise ValueError("Missing the required parameter `email_to` when calling `send_test_email`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_to' in params: body_params = params['email_to'] # 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( '/emailCampaigns/{campaignId}/sendTest', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def update_campaign_status(self, campaign_id, status, **kwargs): # noqa: E501 """Update an email campaign status # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_campaign_status(campaign_id, status, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param UpdateCampaignStatus status: Status of the campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_campaign_status_with_http_info(campaign_id, status, **kwargs) # noqa: E501 else: (data) = self.update_campaign_status_with_http_info(campaign_id, status, **kwargs) # noqa: E501 return data def update_campaign_status_with_http_info(self, campaign_id, status, **kwargs): # noqa: E501 """Update an email campaign status # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_campaign_status_with_http_info(campaign_id, status, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param UpdateCampaignStatus status: Status of the campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id', 'status'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method update_campaign_status" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `update_campaign_status`") # noqa: E501 # verify the required parameter 'status' is set if ('status' not in params or params['status'] is None): raise ValueError("Missing the required parameter `status` when calling `update_campaign_status`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'status' in params: body_params = params['status'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/status', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def update_email_campaign(self, campaign_id, email_campaign, **kwargs): # noqa: E501 """Update an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_email_campaign(campaign_id, email_campaign, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param UpdateEmailCampaign email_campaign: Values to update a campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_email_campaign_with_http_info(campaign_id, email_campaign, **kwargs) # noqa: E501 else: (data) = self.update_email_campaign_with_http_info(campaign_id, email_campaign, **kwargs) # noqa: E501 return data def update_email_campaign_with_http_info(self, campaign_id, email_campaign, **kwargs): # noqa: E501 """Update an email campaign # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_email_campaign_with_http_info(campaign_id, email_campaign, async_req=True) >>> result = thread.get() :param async_req bool :param int campaign_id: Id of the campaign (required) :param UpdateEmailCampaign email_campaign: Values to update a campaign (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['campaign_id', 'email_campaign'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method update_email_campaign" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'campaign_id' is set if ('campaign_id' not in params or params['campaign_id'] is None): raise ValueError("Missing the required parameter `campaign_id` when calling `update_email_campaign`") # noqa: E501 # verify the required parameter 'email_campaign' is set if ('email_campaign' not in params or params['email_campaign'] is None): raise ValueError("Missing the required parameter `email_campaign` when calling `update_email_campaign`") # noqa: E501 collection_formats = {} path_params = {} if 'campaign_id' in params: path_params['campaignId'] = params['campaign_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_campaign' in params: body_params = params['email_campaign'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def upload_image_to_gallery(self, upload_image, **kwargs): # noqa: E501 """Upload an image to your account's image gallery # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.upload_image_to_gallery(upload_image, async_req=True) >>> result = thread.get() :param async_req bool :param UploadImageToGallery upload_image: Parameters to upload an image (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.upload_image_to_gallery_with_http_info(upload_image, **kwargs) # noqa: E501 else: (data) = self.upload_image_to_gallery_with_http_info(upload_image, **kwargs) # noqa: E501 return data def upload_image_to_gallery_with_http_info(self, upload_image, **kwargs): # noqa: E501 """Upload an image to your account's image gallery # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.upload_image_to_gallery_with_http_info(upload_image, async_req=True) >>> result = thread.get() :param async_req bool :param UploadImageToGallery upload_image: Parameters to upload an image (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['upload_image'] # 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 upload_image_to_gallery" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'upload_image' is set if ('upload_image' not in params or params['upload_image'] is None): raise ValueError("Missing the required parameter `upload_image` when calling `upload_image_to_gallery`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'upload_image' in params: body_params = params['upload_image'] # 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( '/emailCampaigns/images', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats)