Module mailslurp_client.api.api_email_warmup_controller_api
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Classes
class ApiEmailWarmupControllerApi (api_client=None)-
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Expand source code
class ApiEmailWarmupControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def create_email_warmup_program(self, create_email_warmup_program_options, **kwargs): # noqa: E501 """Create an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_email_warmup_program(create_email_warmup_program_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateEmailWarmupProgramOptions create_email_warmup_program_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_email_warmup_program_with_http_info(create_email_warmup_program_options, **kwargs) # noqa: E501 def create_email_warmup_program_with_http_info(self, create_email_warmup_program_options, **kwargs): # noqa: E501 """Create an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_email_warmup_program_with_http_info(create_email_warmup_program_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateEmailWarmupProgramOptions create_email_warmup_program_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_email_warmup_program_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_email_warmup_program_options' is set if self.api_client.client_side_validation and ('create_email_warmup_program_options' not in local_var_params or # noqa: E501 local_var_params['create_email_warmup_program_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_email_warmup_program_options` when calling `create_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_email_warmup_program_options' in local_var_params: body_params = local_var_params['create_email_warmup_program_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Delete an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, **kwargs) # noqa: E501 def delete_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Delete an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'email_warmup_program_command_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `delete_email_warmup_program`") # noqa: E501 # verify the required parameter 'email_warmup_program_command_options' is set if self.api_client.client_side_validation and ('email_warmup_program_command_options' not in local_var_params or # noqa: E501 local_var_params['email_warmup_program_command_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_warmup_program_command_options` when calling `delete_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_warmup_program_command_options' in local_var_params: body_params = local_var_params['email_warmup_program_command_options'] # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}', '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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_email_warmup_sender_seats(self, **kwargs): # noqa: E501 """Cancel purchased email warmup sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_warmup_sender_seats(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupUsageSummaryDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_email_warmup_sender_seats_with_http_info(**kwargs) # noqa: E501 def delete_email_warmup_sender_seats_with_http_info(self, **kwargs): # noqa: E501 """Cancel purchased email warmup sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_email_warmup_sender_seats_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupUsageSummaryDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_email_warmup_sender_seats" % key ) local_var_params[key] = val del local_var_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/sender-seats', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupUsageSummaryDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_overview(self, **kwargs): # noqa: E501 """Get operational email warmup activity and program progress # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_overview(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int days: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupOverviewDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_overview_with_http_info(**kwargs) # noqa: E501 def get_email_warmup_overview_with_http_info(self, **kwargs): # noqa: E501 """Get operational email warmup activity and program progress # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_overview_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int days: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupOverviewDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'days' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_overview" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'days' in local_var_params and local_var_params['days'] > 90: # noqa: E501 raise ApiValueError("Invalid value for parameter `days` when calling `get_email_warmup_overview`, must be a value less than or equal to `90`") # noqa: E501 if self.api_client.client_side_validation and 'days' in local_var_params and local_var_params['days'] < 7: # noqa: E501 raise ApiValueError("Invalid value for parameter `days` when calling `get_email_warmup_overview`, must be a value greater than or equal to `7`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'days' in local_var_params and local_var_params['days'] is not None: # noqa: E501 query_params.append(('days', local_var_params['days'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/overview', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupOverviewDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_placement_checks(self, program_id, **kwargs): # noqa: E501 """List Gmail and Outlook placement checks for an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_placement_checks(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[EmailWarmupPlacementCheckDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_placement_checks_with_http_info(program_id, **kwargs) # noqa: E501 def get_email_warmup_placement_checks_with_http_info(self, program_id, **kwargs): # noqa: E501 """List Gmail and Outlook placement checks for an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_placement_checks_with_http_info(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[EmailWarmupPlacementCheckDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_placement_checks" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `get_email_warmup_placement_checks`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/placement-checks', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[EmailWarmupPlacementCheckDto]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_program(self, program_id, **kwargs): # noqa: E501 """Get an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_program(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_program_with_http_info(program_id, **kwargs) # noqa: E501 def get_email_warmup_program_with_http_info(self, program_id, **kwargs): # noqa: E501 """Get an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_program_with_http_info(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `get_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_program_analytics(self, program_id, **kwargs): # noqa: E501 """Get email warmup program progress and daily activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_program_analytics(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param int days: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramAnalyticsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_program_analytics_with_http_info(program_id, **kwargs) # noqa: E501 def get_email_warmup_program_analytics_with_http_info(self, program_id, **kwargs): # noqa: E501 """Get email warmup program progress and daily activity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_program_analytics_with_http_info(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param int days: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramAnalyticsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'days' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_program_analytics" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `get_email_warmup_program_analytics`") # noqa: E501 if self.api_client.client_side_validation and 'days' in local_var_params and local_var_params['days'] > 90: # noqa: E501 raise ApiValueError("Invalid value for parameter `days` when calling `get_email_warmup_program_analytics`, must be a value less than or equal to `90`") # noqa: E501 if self.api_client.client_side_validation and 'days' in local_var_params and local_var_params['days'] < 7: # noqa: E501 raise ApiValueError("Invalid value for parameter `days` when calling `get_email_warmup_program_analytics`, must be a value greater than or equal to `7`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] if 'days' in local_var_params and local_var_params['days'] is not None: # noqa: E501 query_params.append(('days', local_var_params['days'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/analytics', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramAnalyticsDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_programs(self, **kwargs): # noqa: E501 """List email warmup programs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_programs(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: :param int size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramPageDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_programs_with_http_info(**kwargs) # noqa: E501 def get_email_warmup_programs_with_http_info(self, **kwargs): # noqa: E501 """List email warmup programs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_programs_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: :param int size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramPageDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_programs" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_email_warmup_programs`, must be a value greater than or equal to `0`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_email_warmup_programs`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_email_warmup_programs`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramPageDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_readiness(self, program_id, **kwargs): # noqa: E501 """Get warmup readiness, adaptive pacing, and sender-health signals # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_readiness(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupReadinessDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_readiness_with_http_info(program_id, **kwargs) # noqa: E501 def get_email_warmup_readiness_with_http_info(self, program_id, **kwargs): # noqa: E501 """Get warmup readiness, adaptive pacing, and sender-health signals # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_readiness_with_http_info(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupReadinessDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_readiness" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `get_email_warmup_readiness`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/readiness', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupReadinessDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_slots(self, program_id, **kwargs): # noqa: E501 """List scheduled email warmup slots # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_slots(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param int page: :param int size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupSendSlotPageDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_slots_with_http_info(program_id, **kwargs) # noqa: E501 def get_email_warmup_slots_with_http_info(self, program_id, **kwargs): # noqa: E501 """List scheduled email warmup slots # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_slots_with_http_info(program_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param int page: :param int size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupSendSlotPageDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'page', 'size' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_slots" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `get_email_warmup_slots`") # noqa: E501 if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 0: # noqa: E501 raise ApiValueError("Invalid value for parameter `page` when calling `get_email_warmup_slots`, must be a value greater than or equal to `0`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_email_warmup_slots`, must be a value less than or equal to `100`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] < 1: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_email_warmup_slots`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/slots', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupSendSlotPageDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_email_warmup_usage(self, **kwargs): # noqa: E501 """Get email warmup sender capacity, included credits, and billable usage # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_usage(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupUsageSummaryDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_email_warmup_usage_with_http_info(**kwargs) # noqa: E501 def get_email_warmup_usage_with_http_info(self, **kwargs): # noqa: E501 """Get email warmup sender capacity, included credits, and billable usage # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_email_warmup_usage_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupUsageSummaryDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_email_warmup_usage" % key ) local_var_params[key] = val del local_var_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/usage', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupUsageSummaryDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def pause_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Pause an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.pause_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.pause_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, **kwargs) # noqa: E501 def pause_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Pause an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.pause_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'email_warmup_program_command_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method pause_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `pause_email_warmup_program`") # noqa: E501 # verify the required parameter 'email_warmup_program_command_options' is set if self.api_client.client_side_validation and ('email_warmup_program_command_options' not in local_var_params or # noqa: E501 local_var_params['email_warmup_program_command_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_warmup_program_command_options` when calling `pause_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_warmup_program_command_options' in local_var_params: body_params = local_var_params['email_warmup_program_command_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/pause', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def resume_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Resume an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.resume_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.resume_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, **kwargs) # noqa: E501 def resume_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Resume an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.resume_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'email_warmup_program_command_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method resume_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `resume_email_warmup_program`") # noqa: E501 # verify the required parameter 'email_warmup_program_command_options' is set if self.api_client.client_side_validation and ('email_warmup_program_command_options' not in local_var_params or # noqa: E501 local_var_params['email_warmup_program_command_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_warmup_program_command_options` when calling `resume_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_warmup_program_command_options' in local_var_params: body_params = local_var_params['email_warmup_program_command_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/resume', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def retry_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Retry a system-paused email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.retry_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.retry_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, **kwargs) # noqa: E501 def retry_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Retry a system-paused email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.retry_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'email_warmup_program_command_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method retry_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `retry_email_warmup_program`") # noqa: E501 # verify the required parameter 'email_warmup_program_command_options' is set if self.api_client.client_side_validation and ('email_warmup_program_command_options' not in local_var_params or # noqa: E501 local_var_params['email_warmup_program_command_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_warmup_program_command_options` when calling `retry_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_warmup_program_command_options' in local_var_params: body_params = local_var_params['email_warmup_program_command_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/retry', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def start_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Start an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.start_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, **kwargs) # noqa: E501 def start_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Start an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'email_warmup_program_command_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method start_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `start_email_warmup_program`") # noqa: E501 # verify the required parameter 'email_warmup_program_command_options' is set if self.api_client.client_side_validation and ('email_warmup_program_command_options' not in local_var_params or # noqa: E501 local_var_params['email_warmup_program_command_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_warmup_program_command_options` when calling `start_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_warmup_program_command_options' in local_var_params: body_params = local_var_params['email_warmup_program_command_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/start', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def stop_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Stop an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.stop_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.stop_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, **kwargs) # noqa: E501 def stop_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs): # noqa: E501 """Stop an email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.stop_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'email_warmup_program_command_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method stop_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `stop_email_warmup_program`") # noqa: E501 # verify the required parameter 'email_warmup_program_command_options' is set if self.api_client.client_side_validation and ('email_warmup_program_command_options' not in local_var_params or # noqa: E501 local_var_params['email_warmup_program_command_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `email_warmup_program_command_options` when calling `stop_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'email_warmup_program_command_options' in local_var_params: body_params = local_var_params['email_warmup_program_command_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}/stop', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def update_email_warmup_program(self, program_id, update_email_warmup_program_options, **kwargs): # noqa: E501 """Update a draft email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_email_warmup_program(program_id, update_email_warmup_program_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param UpdateEmailWarmupProgramOptions update_email_warmup_program_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_email_warmup_program_with_http_info(program_id, update_email_warmup_program_options, **kwargs) # noqa: E501 def update_email_warmup_program_with_http_info(self, program_id, update_email_warmup_program_options, **kwargs): # noqa: E501 """Update a draft email warmup program # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_email_warmup_program_with_http_info(program_id, update_email_warmup_program_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str program_id: (required) :param UpdateEmailWarmupProgramOptions update_email_warmup_program_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'program_id', 'update_email_warmup_program_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method update_email_warmup_program" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'program_id' is set if self.api_client.client_side_validation and ('program_id' not in local_var_params or # noqa: E501 local_var_params['program_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `program_id` when calling `update_email_warmup_program`") # noqa: E501 # verify the required parameter 'update_email_warmup_program_options' is set if self.api_client.client_side_validation and ('update_email_warmup_program_options' not in local_var_params or # noqa: E501 local_var_params['update_email_warmup_program_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_email_warmup_program_options` when calling `update_email_warmup_program`") # noqa: E501 collection_formats = {} path_params = {} if 'program_id' in local_var_params: path_params['programId'] = local_var_params['program_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_email_warmup_program_options' in local_var_params: body_params = local_var_params['update_email_warmup_program_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/{programId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupProgramDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def update_email_warmup_sender_seats(self, update_email_warmup_sender_seats_options, **kwargs): # noqa: E501 """Update purchased email warmup sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_email_warmup_sender_seats(update_email_warmup_sender_seats_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param UpdateEmailWarmupSenderSeatsOptions update_email_warmup_sender_seats_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupUsageSummaryDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_email_warmup_sender_seats_with_http_info(update_email_warmup_sender_seats_options, **kwargs) # noqa: E501 def update_email_warmup_sender_seats_with_http_info(self, update_email_warmup_sender_seats_options, **kwargs): # noqa: E501 """Update purchased email warmup sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_email_warmup_sender_seats_with_http_info(update_email_warmup_sender_seats_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param UpdateEmailWarmupSenderSeatsOptions update_email_warmup_sender_seats_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupUsageSummaryDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'update_email_warmup_sender_seats_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method update_email_warmup_sender_seats" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'update_email_warmup_sender_seats_options' is set if self.api_client.client_side_validation and ('update_email_warmup_sender_seats_options' not in local_var_params or # noqa: E501 local_var_params['update_email_warmup_sender_seats_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_email_warmup_sender_seats_options` when calling `update_email_warmup_sender_seats`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_email_warmup_sender_seats_options' in local_var_params: body_params = local_var_params['update_email_warmup_sender_seats_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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'] # noqa: E501 return self.api_client.call_api( '/email-warmup/programs/sender-seats', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmailWarmupUsageSummaryDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)Methods
def create_email_warmup_program(self, create_email_warmup_program_options, **kwargs)-
Create an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_email_warmup_program(create_email_warmup_program_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateEmailWarmupProgramOptions create_email_warmup_program_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def create_email_warmup_program_with_http_info(self, create_email_warmup_program_options, **kwargs)-
Create an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_email_warmup_program_with_http_info(create_email_warmup_program_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateEmailWarmupProgramOptions create_email_warmup_program_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs)-
Delete an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def delete_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs)-
Delete an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def delete_email_warmup_sender_seats(self, **kwargs)-
Cancel purchased email warmup sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email_warmup_sender_seats(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupUsageSummaryDto If the method is called asynchronously, returns the request thread.
def delete_email_warmup_sender_seats_with_http_info(self, **kwargs)-
Cancel purchased email warmup sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_email_warmup_sender_seats_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupUsageSummaryDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_overview(self, **kwargs)-
Get operational email warmup activity and program progress # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_overview(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int days: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupOverviewDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_overview_with_http_info(self, **kwargs)-
Get operational email warmup activity and program progress # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_overview_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int days: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupOverviewDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_placement_checks(self, program_id, **kwargs)-
List Gmail and Outlook placement checks for an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_placement_checks(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[EmailWarmupPlacementCheckDto] If the method is called asynchronously, returns the request thread.
def get_email_warmup_placement_checks_with_http_info(self, program_id, **kwargs)-
List Gmail and Outlook placement checks for an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_placement_checks_with_http_info(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[EmailWarmupPlacementCheckDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_program(self, program_id, **kwargs)-
Get an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_program(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_program_analytics(self, program_id, **kwargs)-
Get email warmup program progress and daily activity # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_program_analytics(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param int days: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramAnalyticsDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_program_analytics_with_http_info(self, program_id, **kwargs)-
Get email warmup program progress and daily activity # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_program_analytics_with_http_info(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param int days: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramAnalyticsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_program_with_http_info(self, program_id, **kwargs)-
Get an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_program_with_http_info(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_programs(self, **kwargs)-
List email warmup programs # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_programs(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: :param int size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramPageDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_programs_with_http_info(self, **kwargs)-
List email warmup programs # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_programs_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: :param int size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramPageDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_readiness(self, program_id, **kwargs)-
Get warmup readiness, adaptive pacing, and sender-health signals # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_readiness(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupReadinessDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_readiness_with_http_info(self, program_id, **kwargs)-
Get warmup readiness, adaptive pacing, and sender-health signals # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_readiness_with_http_info(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupReadinessDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_slots(self, program_id, **kwargs)-
List scheduled email warmup slots # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_slots(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param int page: :param int size: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupSendSlotPageDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_slots_with_http_info(self, program_id, **kwargs)-
List scheduled email warmup slots # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_slots_with_http_info(program_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param int page: :param int size: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupSendSlotPageDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_email_warmup_usage(self, **kwargs)-
Get email warmup sender capacity, included credits, and billable usage # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_usage(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupUsageSummaryDto If the method is called asynchronously, returns the request thread.
def get_email_warmup_usage_with_http_info(self, **kwargs)-
Get email warmup sender capacity, included credits, and billable usage # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_warmup_usage_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupUsageSummaryDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def pause_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs)-
Pause an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.pause_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def pause_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs)-
Pause an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.pause_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def resume_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs)-
Resume an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.resume_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def resume_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs)-
Resume an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.resume_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def retry_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs)-
Retry a system-paused email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.retry_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def retry_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs)-
Retry a system-paused email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.retry_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def start_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs)-
Start an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.start_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def start_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs)-
Start an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.start_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def stop_email_warmup_program(self, program_id, email_warmup_program_command_options, **kwargs)-
Stop an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.stop_email_warmup_program(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def stop_email_warmup_program_with_http_info(self, program_id, email_warmup_program_command_options, **kwargs)-
Stop an email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.stop_email_warmup_program_with_http_info(program_id, email_warmup_program_command_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param EmailWarmupProgramCommandOptions email_warmup_program_command_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_email_warmup_program(self, program_id, update_email_warmup_program_options, **kwargs)-
Update a draft email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_email_warmup_program(program_id, update_email_warmup_program_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param UpdateEmailWarmupProgramOptions update_email_warmup_program_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupProgramDto If the method is called asynchronously, returns the request thread.
def update_email_warmup_program_with_http_info(self, program_id, update_email_warmup_program_options, **kwargs)-
Update a draft email warmup program # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_email_warmup_program_with_http_info(program_id, update_email_warmup_program_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str program_id: (required) :param UpdateEmailWarmupProgramOptions update_email_warmup_program_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupProgramDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_email_warmup_sender_seats(self, update_email_warmup_sender_seats_options, **kwargs)-
Update purchased email warmup sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_email_warmup_sender_seats(update_email_warmup_sender_seats_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param UpdateEmailWarmupSenderSeatsOptions update_email_warmup_sender_seats_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: EmailWarmupUsageSummaryDto If the method is called asynchronously, returns the request thread.
def update_email_warmup_sender_seats_with_http_info(self, update_email_warmup_sender_seats_options, **kwargs)-
Update purchased email warmup sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_email_warmup_sender_seats_with_http_info(update_email_warmup_sender_seats_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param UpdateEmailWarmupSenderSeatsOptions update_email_warmup_sender_seats_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(EmailWarmupUsageSummaryDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.