# 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 ContactsApi(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 add_contact_to_list(self, list_id, contact_emails, **kwargs): # noqa: E501 """Add existing contacts to a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_contact_to_list(list_id, contact_emails, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param AddContactToList contact_emails: Emails addresses OR IDs of the contacts (required) :return: PostContactInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.add_contact_to_list_with_http_info(list_id, contact_emails, **kwargs) # noqa: E501 else: (data) = self.add_contact_to_list_with_http_info(list_id, contact_emails, **kwargs) # noqa: E501 return data def add_contact_to_list_with_http_info(self, list_id, contact_emails, **kwargs): # noqa: E501 """Add existing contacts to a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_contact_to_list_with_http_info(list_id, contact_emails, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param AddContactToList contact_emails: Emails addresses OR IDs of the contacts (required) :return: PostContactInfo If the method is called asynchronously, returns the request thread. """ all_params = ['list_id', 'contact_emails'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method add_contact_to_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'list_id' is set if ('list_id' not in params or params['list_id'] is None): raise ValueError("Missing the required parameter `list_id` when calling `add_contact_to_list`") # noqa: E501 # verify the required parameter 'contact_emails' is set if ('contact_emails' not in params or params['contact_emails'] is None): raise ValueError("Missing the required parameter `contact_emails` when calling `add_contact_to_list`") # noqa: E501 collection_formats = {} path_params = {} if 'list_id' in params: path_params['listId'] = params['list_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'contact_emails' in params: body_params = params['contact_emails'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts/add', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PostContactInfo', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def create_attribute(self, attribute_category, attribute_name, create_attribute, **kwargs): # noqa: E501 """Create contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_attribute(attribute_category, attribute_name, create_attribute, async_req=True) >>> result = thread.get() :param async_req bool :param str attribute_category: Category of the attribute (required) :param str attribute_name: Name of the attribute (required) :param CreateAttribute create_attribute: Values to create an attribute (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, **kwargs) # noqa: E501 else: (data) = self.create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, **kwargs) # noqa: E501 return data def create_attribute_with_http_info(self, attribute_category, attribute_name, create_attribute, **kwargs): # noqa: E501 """Create contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, async_req=True) >>> result = thread.get() :param async_req bool :param str attribute_category: Category of the attribute (required) :param str attribute_name: Name of the attribute (required) :param CreateAttribute create_attribute: Values to create an attribute (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['attribute_category', 'attribute_name', 'create_attribute'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method create_attribute" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'attribute_category' is set if ('attribute_category' not in params or params['attribute_category'] is None): raise ValueError("Missing the required parameter `attribute_category` when calling `create_attribute`") # noqa: E501 # verify the required parameter 'attribute_name' is set if ('attribute_name' not in params or params['attribute_name'] is None): raise ValueError("Missing the required parameter `attribute_name` when calling `create_attribute`") # noqa: E501 # verify the required parameter 'create_attribute' is set if ('create_attribute' not in params or params['create_attribute'] is None): raise ValueError("Missing the required parameter `create_attribute` when calling `create_attribute`") # noqa: E501 collection_formats = {} path_params = {} if 'attribute_category' in params: path_params['attributeCategory'] = params['attribute_category'] # noqa: E501 if 'attribute_name' in params: path_params['attributeName'] = params['attribute_name'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_attribute' in params: body_params = params['create_attribute'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def create_contact(self, create_contact, **kwargs): # noqa: E501 """Create a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_contact(create_contact, async_req=True) >>> result = thread.get() :param async_req bool :param CreateContact create_contact: Values to create a contact (required) :return: CreateUpdateContactModel If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.create_contact_with_http_info(create_contact, **kwargs) # noqa: E501 else: (data) = self.create_contact_with_http_info(create_contact, **kwargs) # noqa: E501 return data def create_contact_with_http_info(self, create_contact, **kwargs): # noqa: E501 """Create a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_contact_with_http_info(create_contact, async_req=True) >>> result = thread.get() :param async_req bool :param CreateContact create_contact: Values to create a contact (required) :return: CreateUpdateContactModel If the method is called asynchronously, returns the request thread. """ all_params = ['create_contact'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method create_contact" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'create_contact' is set if ('create_contact' not in params or params['create_contact'] is None): raise ValueError("Missing the required parameter `create_contact` when calling `create_contact`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_contact' in params: body_params = params['create_contact'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CreateUpdateContactModel', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def create_doi_contact(self, create_doi_contact, **kwargs): # noqa: E501 """Create Contact via DOI (Double-Opt-In) Flow # 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_doi_contact(create_doi_contact, async_req=True) >>> result = thread.get() :param async_req bool :param CreateDoiContact create_doi_contact: Values to create the Double opt-in (DOI) contact (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.create_doi_contact_with_http_info(create_doi_contact, **kwargs) # noqa: E501 else: (data) = self.create_doi_contact_with_http_info(create_doi_contact, **kwargs) # noqa: E501 return data def create_doi_contact_with_http_info(self, create_doi_contact, **kwargs): # noqa: E501 """Create Contact via DOI (Double-Opt-In) Flow # 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_doi_contact_with_http_info(create_doi_contact, async_req=True) >>> result = thread.get() :param async_req bool :param CreateDoiContact create_doi_contact: Values to create the Double opt-in (DOI) contact (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['create_doi_contact'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method create_doi_contact" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'create_doi_contact' is set if ('create_doi_contact' not in params or params['create_doi_contact'] is None): raise ValueError("Missing the required parameter `create_doi_contact` when calling `create_doi_contact`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_doi_contact' in params: body_params = params['create_doi_contact'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/doubleOptinConfirmation', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def create_folder(self, create_folder, **kwargs): # noqa: E501 """Create a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_folder(create_folder, async_req=True) >>> result = thread.get() :param async_req bool :param CreateUpdateFolder create_folder: Name of the folder (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_folder_with_http_info(create_folder, **kwargs) # noqa: E501 else: (data) = self.create_folder_with_http_info(create_folder, **kwargs) # noqa: E501 return data def create_folder_with_http_info(self, create_folder, **kwargs): # noqa: E501 """Create a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_folder_with_http_info(create_folder, async_req=True) >>> result = thread.get() :param async_req bool :param CreateUpdateFolder create_folder: Name of the folder (required) :return: CreateModel If the method is called asynchronously, returns the request thread. """ all_params = ['create_folder'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method create_folder" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'create_folder' is set if ('create_folder' not in params or params['create_folder'] is None): raise ValueError("Missing the required parameter `create_folder` when calling `create_folder`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_folder' in params: body_params = params['create_folder'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders', '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 create_list(self, create_list, **kwargs): # noqa: E501 """Create a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_list(create_list, async_req=True) >>> result = thread.get() :param async_req bool :param CreateList create_list: Values to create a list (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_list_with_http_info(create_list, **kwargs) # noqa: E501 else: (data) = self.create_list_with_http_info(create_list, **kwargs) # noqa: E501 return data def create_list_with_http_info(self, create_list, **kwargs): # noqa: E501 """Create a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_list_with_http_info(create_list, async_req=True) >>> result = thread.get() :param async_req bool :param CreateList create_list: Values to create a list (required) :return: CreateModel If the method is called asynchronously, returns the request thread. """ all_params = ['create_list'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method create_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'create_list' is set if ('create_list' not in params or params['create_list'] is None): raise ValueError("Missing the required parameter `create_list` when calling `create_list`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_list' in params: body_params = params['create_list'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists', '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_attribute(self, attribute_category, attribute_name, **kwargs): # noqa: E501 """Delete an attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_attribute(attribute_category, attribute_name, async_req=True) >>> result = thread.get() :param async_req bool :param str attribute_category: Category of the attribute (required) :param str attribute_name: Name of the existing attribute (required) :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_attribute_with_http_info(attribute_category, attribute_name, **kwargs) # noqa: E501 else: (data) = self.delete_attribute_with_http_info(attribute_category, attribute_name, **kwargs) # noqa: E501 return data def delete_attribute_with_http_info(self, attribute_category, attribute_name, **kwargs): # noqa: E501 """Delete an attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_attribute_with_http_info(attribute_category, attribute_name, async_req=True) >>> result = thread.get() :param async_req bool :param str attribute_category: Category of the attribute (required) :param str attribute_name: Name of the existing attribute (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['attribute_category', 'attribute_name'] # 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_attribute" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'attribute_category' is set if ('attribute_category' not in params or params['attribute_category'] is None): raise ValueError("Missing the required parameter `attribute_category` when calling `delete_attribute`") # noqa: E501 # verify the required parameter 'attribute_name' is set if ('attribute_name' not in params or params['attribute_name'] is None): raise ValueError("Missing the required parameter `attribute_name` when calling `delete_attribute`") # noqa: E501 collection_formats = {} path_params = {} if 'attribute_category' in params: path_params['attributeCategory'] = params['attribute_category'] # noqa: E501 if 'attribute_name' in params: path_params['attributeName'] = params['attribute_name'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def delete_contact(self, identifier, **kwargs): # noqa: E501 """Delete a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_contact(identifier, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.delete_contact_with_http_info(identifier, **kwargs) # noqa: E501 else: (data) = self.delete_contact_with_http_info(identifier, **kwargs) # noqa: E501 return data def delete_contact_with_http_info(self, identifier, **kwargs): # noqa: E501 """Delete a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_contact_with_http_info(identifier, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method delete_contact" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'identifier' is set if ('identifier' not in params or params['identifier'] is None): raise ValueError("Missing the required parameter `identifier` when calling `delete_contact`") # noqa: E501 collection_formats = {} path_params = {} if 'identifier' in params: path_params['identifier'] = params['identifier'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{identifier}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def delete_folder(self, folder_id, **kwargs): # noqa: E501 """Delete a folder (and all its lists) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_folder(folder_id, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: Id of the folder (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.delete_folder_with_http_info(folder_id, **kwargs) # noqa: E501 else: (data) = self.delete_folder_with_http_info(folder_id, **kwargs) # noqa: E501 return data def delete_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 """Delete a folder (and all its lists) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_folder_with_http_info(folder_id, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: Id of the folder (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['folder_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_folder" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'folder_id' is set if ('folder_id' not in params or params['folder_id'] is None): raise ValueError("Missing the required parameter `folder_id` when calling `delete_folder`") # noqa: E501 collection_formats = {} path_params = {} if 'folder_id' in params: path_params['folderId'] = params['folder_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def delete_list(self, list_id, **kwargs): # noqa: E501 """Delete a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_list(list_id, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.delete_list_with_http_info(list_id, **kwargs) # noqa: E501 else: (data) = self.delete_list_with_http_info(list_id, **kwargs) # noqa: E501 return data def delete_list_with_http_info(self, list_id, **kwargs): # noqa: E501 """Delete a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_list_with_http_info(list_id, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['list_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_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'list_id' is set if ('list_id' not in params or params['list_id'] is None): raise ValueError("Missing the required parameter `list_id` when calling `delete_list`") # noqa: E501 collection_formats = {} path_params = {} if 'list_id' in params: path_params['listId'] = params['list_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def get_attributes(self, **kwargs): # noqa: E501 """List all attributes # 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_attributes(async_req=True) >>> result = thread.get() :param async_req bool :return: GetAttributes If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_attributes_with_http_info(**kwargs) # noqa: E501 else: (data) = self.get_attributes_with_http_info(**kwargs) # noqa: E501 return data def get_attributes_with_http_info(self, **kwargs): # noqa: E501 """List all attributes # 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_attributes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :return: GetAttributes If the method is called asynchronously, returns the request thread. """ all_params = [] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_attributes" % key ) params[key] = val del params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetAttributes', # 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_contact_info(self, identifier, **kwargs): # noqa: E501 """Get a contact's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contact_info(identifier, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) :return: GetExtendedContactDetails If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_contact_info_with_http_info(identifier, **kwargs) # noqa: E501 else: (data) = self.get_contact_info_with_http_info(identifier, **kwargs) # noqa: E501 return data def get_contact_info_with_http_info(self, identifier, **kwargs): # noqa: E501 """Get a contact's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contact_info_with_http_info(identifier, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) :return: GetExtendedContactDetails If the method is called asynchronously, returns the request thread. """ all_params = ['identifier'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_contact_info" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'identifier' is set if ('identifier' not in params or params['identifier'] is None): raise ValueError("Missing the required parameter `identifier` when calling `get_contact_info`") # noqa: E501 collection_formats = {} path_params = {} if 'identifier' in params: path_params['identifier'] = params['identifier'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{identifier}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetExtendedContactDetails', # 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_contact_stats(self, identifier, **kwargs): # noqa: E501 """Get email campaigns' statistics for a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contact_stats(identifier, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact (required) :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate :param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate :return: GetContactCampaignStats If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_contact_stats_with_http_info(identifier, **kwargs) # noqa: E501 else: (data) = self.get_contact_stats_with_http_info(identifier, **kwargs) # noqa: E501 return data def get_contact_stats_with_http_info(self, identifier, **kwargs): # noqa: E501 """Get email campaigns' statistics for a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contact_stats_with_http_info(identifier, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact (required) :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate :param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate :return: GetContactCampaignStats If the method is called asynchronously, returns the request thread. """ all_params = ['identifier', 'start_date', 'end_date'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_contact_stats" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'identifier' is set if ('identifier' not in params or params['identifier'] is None): raise ValueError("Missing the required parameter `identifier` when calling `get_contact_stats`") # noqa: E501 collection_formats = {} path_params = {} if 'identifier' in params: path_params['identifier'] = params['identifier'] # noqa: E501 query_params = [] if 'start_date' in params: query_params.append(('startDate', params['start_date'])) # noqa: E501 if 'end_date' in params: query_params.append(('endDate', params['end_date'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{identifier}/campaignStats', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetContactCampaignStats', # 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_contacts(self, **kwargs): # noqa: E501 """Get all the contacts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contacts(async_req=True) >>> result = thread.get() :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_contacts_with_http_info(**kwargs) # noqa: E501 else: (data) = self.get_contacts_with_http_info(**kwargs) # noqa: E501 return data def get_contacts_with_http_info(self, **kwargs): # noqa: E501 """Get all the contacts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contacts_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. """ all_params = ['limit', 'offset', 'modified_since', '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_contacts" % 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_contacts`, must be a value less than or equal to `1000`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'limit' in params: query_params.append(('limit', params['limit'])) # noqa: E501 if 'offset' in params: query_params.append(('offset', params['offset'])) # noqa: E501 if 'modified_since' in params: query_params.append(('modifiedSince', params['modified_since'])) # noqa: E501 if 'sort' in params: query_params.append(('sort', params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetContacts', # 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_contacts_from_list(self, list_id, **kwargs): # noqa: E501 """Get contacts in a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contacts_from_list(list_id, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_contacts_from_list_with_http_info(list_id, **kwargs) # noqa: E501 else: (data) = self.get_contacts_from_list_with_http_info(list_id, **kwargs) # noqa: E501 return data def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E501 """Get contacts in a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_contacts_from_list_with_http_info(list_id, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. """ all_params = ['list_id', 'modified_since', '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_contacts_from_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'list_id' is set if ('list_id' not in params or params['list_id'] is None): raise ValueError("Missing the required parameter `list_id` when calling `get_contacts_from_list`") # noqa: E501 if 'limit' in params and params['limit'] > 500: # noqa: E501 raise ValueError("Invalid value for parameter `limit` when calling `get_contacts_from_list`, must be a value less than or equal to `500`") # noqa: E501 collection_formats = {} path_params = {} if 'list_id' in params: path_params['listId'] = params['list_id'] # noqa: E501 query_params = [] if 'modified_since' in params: query_params.append(('modifiedSince', params['modified_since'])) # 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( '/contacts/lists/{listId}/contacts', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetContacts', # 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_folder(self, folder_id, **kwargs): # noqa: E501 """Returns a folder's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_folder(folder_id, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: id of the folder (required) :return: GetFolder If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_folder_with_http_info(folder_id, **kwargs) # noqa: E501 else: (data) = self.get_folder_with_http_info(folder_id, **kwargs) # noqa: E501 return data def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 """Returns a folder's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_folder_with_http_info(folder_id, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: id of the folder (required) :return: GetFolder If the method is called asynchronously, returns the request thread. """ all_params = ['folder_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_folder" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'folder_id' is set if ('folder_id' not in params or params['folder_id'] is None): raise ValueError("Missing the required parameter `folder_id` when calling `get_folder`") # noqa: E501 collection_formats = {} path_params = {} if 'folder_id' in params: path_params['folderId'] = params['folder_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetFolder', # 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_folder_lists(self, folder_id, **kwargs): # noqa: E501 """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_folder_lists(folder_id, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_folder_lists_with_http_info(folder_id, **kwargs) # noqa: E501 else: (data) = self.get_folder_lists_with_http_info(folder_id, **kwargs) # noqa: E501 return data def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 """Get lists in a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_folder_lists_with_http_info(folder_id, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. """ all_params = ['folder_id', '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_folder_lists" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'folder_id' is set if ('folder_id' not in params or params['folder_id'] is None): raise ValueError("Missing the required parameter `folder_id` when calling `get_folder_lists`") # noqa: E501 if 'limit' in params and params['limit'] > 50: # noqa: E501 raise ValueError("Invalid value for parameter `limit` when calling `get_folder_lists`, must be a value less than or equal to `50`") # noqa: E501 collection_formats = {} path_params = {} if 'folder_id' in params: path_params['folderId'] = params['folder_id'] # noqa: E501 query_params = [] if 'limit' in params: query_params.append(('limit', params['limit'])) # noqa: E501 if 'offset' in params: query_params.append(('offset', params['offset'])) # noqa: E501 if 'sort' in params: query_params.append(('sort', params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}/lists', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetFolderLists', # 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_folders(self, limit, offset, **kwargs): # noqa: E501 """Get all folders # 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_folders(limit, offset, async_req=True) >>> result = thread.get() :param async_req bool :param int limit: Number of documents per page (required) :param int offset: Index of the first document of the page (required) :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolders If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_folders_with_http_info(limit, offset, **kwargs) # noqa: E501 else: (data) = self.get_folders_with_http_info(limit, offset, **kwargs) # noqa: E501 return data def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 """Get all folders # 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_folders_with_http_info(limit, offset, async_req=True) >>> result = thread.get() :param async_req bool :param int limit: Number of documents per page (required) :param int offset: Index of the first document of the page (required) :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolders If the method is called asynchronously, returns the request thread. """ all_params = ['limit', 'offset', 'sort'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_folders" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'limit' is set if ('limit' not in params or params['limit'] is None): raise ValueError("Missing the required parameter `limit` when calling `get_folders`") # noqa: E501 # verify the required parameter 'offset' is set if ('offset' not in params or params['offset'] is None): raise ValueError("Missing the required parameter `offset` when calling `get_folders`") # noqa: E501 if 'limit' in params and params['limit'] > 50: # noqa: E501 raise ValueError("Invalid value for parameter `limit` when calling `get_folders`, must be a value less than or equal to `50`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'limit' in params: query_params.append(('limit', params['limit'])) # noqa: E501 if 'offset' in params: query_params.append(('offset', params['offset'])) # noqa: E501 if 'sort' in params: query_params.append(('sort', params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetFolders', # 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_list(self, list_id, **kwargs): # noqa: E501 """Get a list's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_list(list_id, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :return: GetExtendedList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_list_with_http_info(list_id, **kwargs) # noqa: E501 else: (data) = self.get_list_with_http_info(list_id, **kwargs) # noqa: E501 return data def get_list_with_http_info(self, list_id, **kwargs): # noqa: E501 """Get a list's details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_list_with_http_info(list_id, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :return: GetExtendedList If the method is called asynchronously, returns the request thread. """ all_params = ['list_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_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'list_id' is set if ('list_id' not in params or params['list_id'] is None): raise ValueError("Missing the required parameter `list_id` when calling `get_list`") # noqa: E501 collection_formats = {} path_params = {} if 'list_id' in params: path_params['listId'] = params['list_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetExtendedList', # 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_lists(self, **kwargs): # noqa: E501 """Get all the lists # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_lists(async_req=True) >>> result = thread.get() :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetLists If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.get_lists_with_http_info(**kwargs) # noqa: E501 else: (data) = self.get_lists_with_http_info(**kwargs) # noqa: E501 return data def get_lists_with_http_info(self, **kwargs): # noqa: E501 """Get all the lists # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_lists_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetLists If the method is called asynchronously, returns the request thread. """ all_params = ['limit', 'offset', 'sort'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method get_lists" % key ) params[key] = val del params['kwargs'] if 'limit' in params and params['limit'] > 50: # noqa: E501 raise ValueError("Invalid value for parameter `limit` when calling `get_lists`, must be a value less than or equal to `50`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'limit' in params: query_params.append(('limit', params['limit'])) # noqa: E501 if 'offset' in params: query_params.append(('offset', params['offset'])) # noqa: E501 if 'sort' in params: query_params.append(('sort', params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GetLists', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def import_contacts(self, request_contact_import, **kwargs): # noqa: E501 """Import contacts # noqa: E501 It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_contacts(request_contact_import, async_req=True) >>> result = thread.get() :param async_req bool :param RequestContactImport request_contact_import: Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) :return: CreatedProcessId If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.import_contacts_with_http_info(request_contact_import, **kwargs) # noqa: E501 else: (data) = self.import_contacts_with_http_info(request_contact_import, **kwargs) # noqa: E501 return data def import_contacts_with_http_info(self, request_contact_import, **kwargs): # noqa: E501 """Import contacts # noqa: E501 It returns the background process ID which on completion calls the notify URL that you have set in the input. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_contacts_with_http_info(request_contact_import, async_req=True) >>> result = thread.get() :param async_req bool :param RequestContactImport request_contact_import: Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) :return: CreatedProcessId If the method is called asynchronously, returns the request thread. """ all_params = ['request_contact_import'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method import_contacts" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'request_contact_import' is set if ('request_contact_import' not in params or params['request_contact_import'] is None): raise ValueError("Missing the required parameter `request_contact_import` when calling `import_contacts`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'request_contact_import' in params: body_params = params['request_contact_import'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/import', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CreatedProcessId', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def remove_contact_from_list(self, list_id, contact_emails, **kwargs): # noqa: E501 """Delete a contact from a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_contact_from_list(list_id, contact_emails, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param RemoveContactFromList contact_emails: Emails addresses OR IDs of the contacts (required) :return: PostContactInfo If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.remove_contact_from_list_with_http_info(list_id, contact_emails, **kwargs) # noqa: E501 else: (data) = self.remove_contact_from_list_with_http_info(list_id, contact_emails, **kwargs) # noqa: E501 return data def remove_contact_from_list_with_http_info(self, list_id, contact_emails, **kwargs): # noqa: E501 """Delete a contact from a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_contact_from_list_with_http_info(list_id, contact_emails, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param RemoveContactFromList contact_emails: Emails addresses OR IDs of the contacts (required) :return: PostContactInfo If the method is called asynchronously, returns the request thread. """ all_params = ['list_id', 'contact_emails'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method remove_contact_from_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'list_id' is set if ('list_id' not in params or params['list_id'] is None): raise ValueError("Missing the required parameter `list_id` when calling `remove_contact_from_list`") # noqa: E501 # verify the required parameter 'contact_emails' is set if ('contact_emails' not in params or params['contact_emails'] is None): raise ValueError("Missing the required parameter `contact_emails` when calling `remove_contact_from_list`") # noqa: E501 collection_formats = {} path_params = {} if 'list_id' in params: path_params['listId'] = params['list_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'contact_emails' in params: body_params = params['contact_emails'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts/remove', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PostContactInfo', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def request_contact_export(self, request_contact_export, **kwargs): # noqa: E501 """Export contacts # noqa: E501 It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.request_contact_export(request_contact_export, async_req=True) >>> result = thread.get() :param async_req bool :param RequestContactExport request_contact_export: Values to request a contact export (required) :return: CreatedProcessId If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.request_contact_export_with_http_info(request_contact_export, **kwargs) # noqa: E501 else: (data) = self.request_contact_export_with_http_info(request_contact_export, **kwargs) # noqa: E501 return data def request_contact_export_with_http_info(self, request_contact_export, **kwargs): # noqa: E501 """Export contacts # noqa: E501 It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.request_contact_export_with_http_info(request_contact_export, async_req=True) >>> result = thread.get() :param async_req bool :param RequestContactExport request_contact_export: Values to request a contact export (required) :return: CreatedProcessId If the method is called asynchronously, returns the request thread. """ all_params = ['request_contact_export'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method request_contact_export" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'request_contact_export' is set if ('request_contact_export' not in params or params['request_contact_export'] is None): raise ValueError("Missing the required parameter `request_contact_export` when calling `request_contact_export`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'request_contact_export' in params: body_params = params['request_contact_export'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/export', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CreatedProcessId', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def update_attribute(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501 """Update contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_attribute(attribute_category, attribute_name, update_attribute, async_req=True) >>> result = thread.get() :param async_req bool :param str attribute_category: Category of the attribute (required) :param str attribute_name: Name of the existing attribute (required) :param UpdateAttribute update_attribute: Values to update an attribute (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, **kwargs) # noqa: E501 else: (data) = self.update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, **kwargs) # noqa: E501 return data def update_attribute_with_http_info(self, attribute_category, attribute_name, update_attribute, **kwargs): # noqa: E501 """Update contact attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, async_req=True) >>> result = thread.get() :param async_req bool :param str attribute_category: Category of the attribute (required) :param str attribute_name: Name of the existing attribute (required) :param UpdateAttribute update_attribute: Values to update an attribute (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['attribute_category', 'attribute_name', 'update_attribute'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method update_attribute" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'attribute_category' is set if ('attribute_category' not in params or params['attribute_category'] is None): raise ValueError("Missing the required parameter `attribute_category` when calling `update_attribute`") # noqa: E501 # verify the required parameter 'attribute_name' is set if ('attribute_name' not in params or params['attribute_name'] is None): raise ValueError("Missing the required parameter `attribute_name` when calling `update_attribute`") # noqa: E501 # verify the required parameter 'update_attribute' is set if ('update_attribute' not in params or params['update_attribute'] is None): raise ValueError("Missing the required parameter `update_attribute` when calling `update_attribute`") # noqa: E501 collection_formats = {} path_params = {} if 'attribute_category' in params: path_params['attributeCategory'] = params['attribute_category'] # noqa: E501 if 'attribute_name' in params: path_params['attributeName'] = params['attribute_name'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_attribute' in params: body_params = params['update_attribute'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def update_contact(self, identifier, update_contact, **kwargs): # noqa: E501 """Update a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_contact(identifier, update_contact, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact (required) :param UpdateContact update_contact: Values to update a contact (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_contact_with_http_info(identifier, update_contact, **kwargs) # noqa: E501 else: (data) = self.update_contact_with_http_info(identifier, update_contact, **kwargs) # noqa: E501 return data def update_contact_with_http_info(self, identifier, update_contact, **kwargs): # noqa: E501 """Update a contact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_contact_with_http_info(identifier, update_contact, async_req=True) >>> result = thread.get() :param async_req bool :param str identifier: Email (urlencoded) OR ID of the contact (required) :param UpdateContact update_contact: Values to update a contact (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['identifier', 'update_contact'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method update_contact" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'identifier' is set if ('identifier' not in params or params['identifier'] is None): raise ValueError("Missing the required parameter `identifier` when calling `update_contact`") # noqa: E501 # verify the required parameter 'update_contact' is set if ('update_contact' not in params or params['update_contact'] is None): raise ValueError("Missing the required parameter `update_contact` when calling `update_contact`") # noqa: E501 collection_formats = {} path_params = {} if 'identifier' in params: path_params['identifier'] = params['identifier'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_contact' in params: body_params = params['update_contact'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{identifier}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def update_folder(self, folder_id, update_folder, **kwargs): # noqa: E501 """Update a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_folder(folder_id, update_folder, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: Id of the folder (required) :param CreateUpdateFolder update_folder: Name of the folder (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_folder_with_http_info(folder_id, update_folder, **kwargs) # noqa: E501 else: (data) = self.update_folder_with_http_info(folder_id, update_folder, **kwargs) # noqa: E501 return data def update_folder_with_http_info(self, folder_id, update_folder, **kwargs): # noqa: E501 """Update a folder # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_folder_with_http_info(folder_id, update_folder, async_req=True) >>> result = thread.get() :param async_req bool :param int folder_id: Id of the folder (required) :param CreateUpdateFolder update_folder: Name of the folder (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['folder_id', 'update_folder'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method update_folder" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'folder_id' is set if ('folder_id' not in params or params['folder_id'] is None): raise ValueError("Missing the required parameter `folder_id` when calling `update_folder`") # noqa: E501 # verify the required parameter 'update_folder' is set if ('update_folder' not in params or params['update_folder'] is None): raise ValueError("Missing the required parameter `update_folder` when calling `update_folder`") # noqa: E501 collection_formats = {} path_params = {} if 'folder_id' in params: path_params['folderId'] = params['folder_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_folder' in params: body_params = params['update_folder'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) def update_list(self, list_id, update_list, **kwargs): # noqa: E501 """Update a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_list(list_id, update_list, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param UpdateList update_list: Values to update a list (required) :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): return self.update_list_with_http_info(list_id, update_list, **kwargs) # noqa: E501 else: (data) = self.update_list_with_http_info(list_id, update_list, **kwargs) # noqa: E501 return data def update_list_with_http_info(self, list_id, update_list, **kwargs): # noqa: E501 """Update a list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_list_with_http_info(list_id, update_list, async_req=True) >>> result = thread.get() :param async_req bool :param int list_id: Id of the list (required) :param UpdateList update_list: Values to update a list (required) :return: None If the method is called asynchronously, returns the request thread. """ all_params = ['list_id', 'update_list'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') params = locals() for key, val in six.iteritems(params['kwargs']): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" " to method update_list" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'list_id' is set if ('list_id' not in params or params['list_id'] is None): raise ValueError("Missing the required parameter `list_id` when calling `update_list`") # noqa: E501 # verify the required parameter 'update_list' is set if ('update_list' not in params or params['update_list'] is None): raise ValueError("Missing the required parameter `update_list` when calling `update_list`") # noqa: E501 collection_formats = {} path_params = {} if 'list_id' in params: path_params['listId'] = params['list_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_list' in params: body_params = params['update_list'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats)