Module mailslurp_client.api.api_automated_inbox_placement_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 ApiAutomatedInboxPlacementControllerApi (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 ApiAutomatedInboxPlacementControllerApi(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_automated_inbox_placement_connection(self, create_automated_inbox_placement_connection_options, **kwargs): # noqa: E501 """Create an encrypted sender connection # 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_automated_inbox_placement_connection(create_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementConnectionOptions create_automated_inbox_placement_connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_automated_inbox_placement_connection_with_http_info(create_automated_inbox_placement_connection_options, **kwargs) # noqa: E501 def create_automated_inbox_placement_connection_with_http_info(self, create_automated_inbox_placement_connection_options, **kwargs): # noqa: E501 """Create an encrypted sender connection # 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_automated_inbox_placement_connection_with_http_info(create_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementConnectionOptions create_automated_inbox_placement_connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_automated_inbox_placement_connection_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_automated_inbox_placement_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_automated_inbox_placement_connection_options' is set if self.api_client.client_side_validation and ('create_automated_inbox_placement_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_automated_inbox_placement_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_automated_inbox_placement_connection_options` when calling `create_automated_inbox_placement_connection`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_automated_inbox_placement_connection_options' in local_var_params: body_params = local_var_params['create_automated_inbox_placement_connection_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( '/inbox-placement-tests/automations/connections', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementConnectionDto', # 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 create_automated_inbox_placement_schedule(self, create_automated_inbox_placement_schedule_options, **kwargs): # noqa: E501 """Create an automated inbox placement schedule # 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_automated_inbox_placement_schedule(create_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementScheduleOptions create_automated_inbox_placement_schedule_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: AutomatedInboxPlacementScheduleDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_automated_inbox_placement_schedule_with_http_info(create_automated_inbox_placement_schedule_options, **kwargs) # noqa: E501 def create_automated_inbox_placement_schedule_with_http_info(self, create_automated_inbox_placement_schedule_options, **kwargs): # noqa: E501 """Create an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(create_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementScheduleOptions create_automated_inbox_placement_schedule_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(AutomatedInboxPlacementScheduleDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_automated_inbox_placement_schedule_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_automated_inbox_placement_schedule" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_automated_inbox_placement_schedule_options' is set if self.api_client.client_side_validation and ('create_automated_inbox_placement_schedule_options' not in local_var_params or # noqa: E501 local_var_params['create_automated_inbox_placement_schedule_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_automated_inbox_placement_schedule_options` when calling `create_automated_inbox_placement_schedule`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_automated_inbox_placement_schedule_options' in local_var_params: body_params = local_var_params['create_automated_inbox_placement_schedule_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( '/inbox-placement-tests/automations/schedules', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementScheduleDto', # 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_automated_inbox_placement_connection(self, connection_id, **kwargs): # noqa: E501 """Disconnect a sender connection # 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_automated_inbox_placement_connection(connection_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_automated_inbox_placement_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def delete_automated_inbox_placement_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Disconnect a sender connection # 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_automated_inbox_placement_connection_with_http_info(connection_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_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: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_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 delete_automated_inbox_placement_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'connection_id' is set if self.api_client.client_side_validation and ('connection_id' not in local_var_params or # noqa: E501 local_var_params['connection_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `connection_id` when calling `delete_automated_inbox_placement_connection`") # noqa: E501 collection_formats = {} path_params = {} if 'connection_id' in local_var_params: path_params['connectionId'] = local_var_params['connection_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inbox-placement-tests/automations/connections/{connectionId}', '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_automated_inbox_placement_schedule(self, schedule_id, **kwargs): # noqa: E501 """Delete an automated inbox placement schedule # 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_automated_inbox_placement_schedule(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_automated_inbox_placement_schedule_with_http_info(schedule_id, **kwargs) # noqa: E501 def delete_automated_inbox_placement_schedule_with_http_info(self, schedule_id, **kwargs): # noqa: E501 """Delete an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_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: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_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 delete_automated_inbox_placement_schedule" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `delete_automated_inbox_placement_schedule`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/inbox-placement-tests/automations/schedules/{scheduleId}', '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 get_automated_inbox_placement_connection(self, connection_id, **kwargs): # noqa: E501 """Get a sender connection # 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_automated_inbox_placement_connection(connection_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def get_automated_inbox_placement_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Get a sender connection # 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_automated_inbox_placement_connection_with_http_info(connection_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_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_automated_inbox_placement_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'connection_id' is set if self.api_client.client_side_validation and ('connection_id' not in local_var_params or # noqa: E501 local_var_params['connection_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `connection_id` when calling `get_automated_inbox_placement_connection`") # noqa: E501 collection_formats = {} path_params = {} if 'connection_id' in local_var_params: path_params['connectionId'] = local_var_params['connection_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( '/inbox-placement-tests/automations/connections/{connectionId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementConnectionDto', # 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_automated_inbox_placement_connections(self, **kwargs): # noqa: E501 """List sender connections # 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_automated_inbox_placement_connections(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: list[AutomatedInboxPlacementConnectionDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_connections_with_http_info(**kwargs) # noqa: E501 def get_automated_inbox_placement_connections_with_http_info(self, **kwargs): # noqa: E501 """List sender connections # 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_automated_inbox_placement_connections_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(list[AutomatedInboxPlacementConnectionDto], 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_automated_inbox_placement_connections" % 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( '/inbox-placement-tests/automations/connections', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AutomatedInboxPlacementConnectionDto]', # 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_automated_inbox_placement_execution_events(self, schedule_id, execution_id, **kwargs): # noqa: E501 """List non-secret execution events # 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_automated_inbox_placement_execution_events(schedule_id, execution_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param str execution_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[AutomatedInboxPlacementEventDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_execution_events_with_http_info(schedule_id, execution_id, **kwargs) # noqa: E501 def get_automated_inbox_placement_execution_events_with_http_info(self, schedule_id, execution_id, **kwargs): # noqa: E501 """List non-secret execution events # 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_automated_inbox_placement_execution_events_with_http_info(schedule_id, execution_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param str execution_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[AutomatedInboxPlacementEventDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_id', 'execution_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_automated_inbox_placement_execution_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `get_automated_inbox_placement_execution_events`") # noqa: E501 # verify the required parameter 'execution_id' is set if self.api_client.client_side_validation and ('execution_id' not in local_var_params or # noqa: E501 local_var_params['execution_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `execution_id` when calling `get_automated_inbox_placement_execution_events`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_id'] # noqa: E501 if 'execution_id' in local_var_params: path_params['executionId'] = local_var_params['execution_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( '/inbox-placement-tests/automations/schedules/{scheduleId}/executions/{executionId}/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AutomatedInboxPlacementEventDto]', # 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_automated_inbox_placement_executions(self, schedule_id, **kwargs): # noqa: E501 """List schedule executions # 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_automated_inbox_placement_executions(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param int limit: :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[AutomatedInboxPlacementExecutionDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_executions_with_http_info(schedule_id, **kwargs) # noqa: E501 def get_automated_inbox_placement_executions_with_http_info(self, schedule_id, **kwargs): # noqa: E501 """List schedule executions # 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_automated_inbox_placement_executions_with_http_info(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param int limit: :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[AutomatedInboxPlacementExecutionDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_id', 'limit' ] 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_automated_inbox_placement_executions" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `get_automated_inbox_placement_executions`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_id'] # noqa: E501 query_params = [] if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 query_params.append(('limit', local_var_params['limit'])) # 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( '/inbox-placement-tests/automations/schedules/{scheduleId}/executions', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AutomatedInboxPlacementExecutionDto]', # 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_automated_inbox_placement_providers(self, **kwargs): # noqa: E501 """List automated inbox placement sender providers # 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_automated_inbox_placement_providers(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: list[AutomatedInboxPlacementProviderDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_providers_with_http_info(**kwargs) # noqa: E501 def get_automated_inbox_placement_providers_with_http_info(self, **kwargs): # noqa: E501 """List automated inbox placement sender providers # 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_automated_inbox_placement_providers_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(list[AutomatedInboxPlacementProviderDto], 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_automated_inbox_placement_providers" % 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( '/inbox-placement-tests/automations/providers', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AutomatedInboxPlacementProviderDto]', # 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_automated_inbox_placement_schedule(self, schedule_id, **kwargs): # noqa: E501 """Get an automated inbox placement schedule # 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_automated_inbox_placement_schedule(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_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: AutomatedInboxPlacementScheduleDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_schedule_with_http_info(schedule_id, **kwargs) # noqa: E501 def get_automated_inbox_placement_schedule_with_http_info(self, schedule_id, **kwargs): # noqa: E501 """Get an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_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(AutomatedInboxPlacementScheduleDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_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_automated_inbox_placement_schedule" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `get_automated_inbox_placement_schedule`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_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( '/inbox-placement-tests/automations/schedules/{scheduleId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementScheduleDto', # 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_automated_inbox_placement_schedule_analytics_series(self, schedule_id, **kwargs): # noqa: E501 """Get automation inbox placement analytics over time # noqa: E501 Returns chart-ready metrics for billed placement runs created by this schedule only. # 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_automated_inbox_placement_schedule_analytics_series(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param datetime since: :param datetime before: :param str bucket: :param int run_limit: :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: InboxPlacementAnalyticsSeriesDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_schedule_analytics_series_with_http_info(schedule_id, **kwargs) # noqa: E501 def get_automated_inbox_placement_schedule_analytics_series_with_http_info(self, schedule_id, **kwargs): # noqa: E501 """Get automation inbox placement analytics over time # noqa: E501 Returns chart-ready metrics for billed placement runs created by this schedule only. # 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_automated_inbox_placement_schedule_analytics_series_with_http_info(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param datetime since: :param datetime before: :param str bucket: :param int run_limit: :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(InboxPlacementAnalyticsSeriesDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_id', 'since', 'before', 'bucket', 'run_limit' ] 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_automated_inbox_placement_schedule_analytics_series" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `get_automated_inbox_placement_schedule_analytics_series`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_id'] # noqa: E501 query_params = [] if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'bucket' in local_var_params and local_var_params['bucket'] is not None: # noqa: E501 query_params.append(('bucket', local_var_params['bucket'])) # noqa: E501 if 'run_limit' in local_var_params and local_var_params['run_limit'] is not None: # noqa: E501 query_params.append(('runLimit', local_var_params['run_limit'])) # 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( '/inbox-placement-tests/automations/schedules/{scheduleId}/analytics/series', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxPlacementAnalyticsSeriesDto', # 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_automated_inbox_placement_schedules(self, **kwargs): # noqa: E501 """List automated inbox placement schedules # 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_automated_inbox_placement_schedules(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: list[AutomatedInboxPlacementScheduleDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_automated_inbox_placement_schedules_with_http_info(**kwargs) # noqa: E501 def get_automated_inbox_placement_schedules_with_http_info(self, **kwargs): # noqa: E501 """List automated inbox placement schedules # 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_automated_inbox_placement_schedules_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(list[AutomatedInboxPlacementScheduleDto], 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_automated_inbox_placement_schedules" % 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( '/inbox-placement-tests/automations/schedules', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AutomatedInboxPlacementScheduleDto]', # 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 rotate_automated_inbox_placement_connection_credentials(self, connection_id, rotate_automated_inbox_placement_connection_credentials_options, **kwargs): # noqa: E501 """Rotate sender connection credentials # noqa: E501 Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.rotate_automated_inbox_placement_connection_credentials(connection_id, rotate_automated_inbox_placement_connection_credentials_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateAutomatedInboxPlacementConnectionCredentialsOptions rotate_automated_inbox_placement_connection_credentials_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.rotate_automated_inbox_placement_connection_credentials_with_http_info(connection_id, rotate_automated_inbox_placement_connection_credentials_options, **kwargs) # noqa: E501 def rotate_automated_inbox_placement_connection_credentials_with_http_info(self, connection_id, rotate_automated_inbox_placement_connection_credentials_options, **kwargs): # noqa: E501 """Rotate sender connection credentials # noqa: E501 Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.rotate_automated_inbox_placement_connection_credentials_with_http_info(connection_id, rotate_automated_inbox_placement_connection_credentials_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateAutomatedInboxPlacementConnectionCredentialsOptions rotate_automated_inbox_placement_connection_credentials_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_id', 'rotate_automated_inbox_placement_connection_credentials_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 rotate_automated_inbox_placement_connection_credentials" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'connection_id' is set if self.api_client.client_side_validation and ('connection_id' not in local_var_params or # noqa: E501 local_var_params['connection_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `connection_id` when calling `rotate_automated_inbox_placement_connection_credentials`") # noqa: E501 # verify the required parameter 'rotate_automated_inbox_placement_connection_credentials_options' is set if self.api_client.client_side_validation and ('rotate_automated_inbox_placement_connection_credentials_options' not in local_var_params or # noqa: E501 local_var_params['rotate_automated_inbox_placement_connection_credentials_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `rotate_automated_inbox_placement_connection_credentials_options` when calling `rotate_automated_inbox_placement_connection_credentials`") # noqa: E501 collection_formats = {} path_params = {} if 'connection_id' in local_var_params: path_params['connectionId'] = local_var_params['connection_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'rotate_automated_inbox_placement_connection_credentials_options' in local_var_params: body_params = local_var_params['rotate_automated_inbox_placement_connection_credentials_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( '/inbox-placement-tests/automations/connections/{connectionId}/credentials', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementConnectionDto', # 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 run_automated_inbox_placement_schedule(self, schedule_id, **kwargs): # noqa: E501 """Run an automated inbox placement schedule now # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.run_automated_inbox_placement_schedule(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_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: AutomatedInboxPlacementExecutionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.run_automated_inbox_placement_schedule_with_http_info(schedule_id, **kwargs) # noqa: E501 def run_automated_inbox_placement_schedule_with_http_info(self, schedule_id, **kwargs): # noqa: E501 """Run an automated inbox placement schedule now # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.run_automated_inbox_placement_schedule_with_http_info(schedule_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_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(AutomatedInboxPlacementExecutionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_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 run_automated_inbox_placement_schedule" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `run_automated_inbox_placement_schedule`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_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( '/inbox-placement-tests/automations/schedules/{scheduleId}/run', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementExecutionDto', # 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_automated_inbox_placement_connection(self, connection_id, update_automated_inbox_placement_connection_options, **kwargs): # noqa: E501 """Update a sender connection # noqa: E501 Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings. # 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_automated_inbox_placement_connection(connection_id, update_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateAutomatedInboxPlacementConnectionOptions update_automated_inbox_placement_connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_automated_inbox_placement_connection_with_http_info(connection_id, update_automated_inbox_placement_connection_options, **kwargs) # noqa: E501 def update_automated_inbox_placement_connection_with_http_info(self, connection_id, update_automated_inbox_placement_connection_options, **kwargs): # noqa: E501 """Update a sender connection # noqa: E501 Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings. # 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_automated_inbox_placement_connection_with_http_info(connection_id, update_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateAutomatedInboxPlacementConnectionOptions update_automated_inbox_placement_connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_id', 'update_automated_inbox_placement_connection_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_automated_inbox_placement_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'connection_id' is set if self.api_client.client_side_validation and ('connection_id' not in local_var_params or # noqa: E501 local_var_params['connection_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `connection_id` when calling `update_automated_inbox_placement_connection`") # noqa: E501 # verify the required parameter 'update_automated_inbox_placement_connection_options' is set if self.api_client.client_side_validation and ('update_automated_inbox_placement_connection_options' not in local_var_params or # noqa: E501 local_var_params['update_automated_inbox_placement_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_automated_inbox_placement_connection_options` when calling `update_automated_inbox_placement_connection`") # noqa: E501 collection_formats = {} path_params = {} if 'connection_id' in local_var_params: path_params['connectionId'] = local_var_params['connection_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_automated_inbox_placement_connection_options' in local_var_params: body_params = local_var_params['update_automated_inbox_placement_connection_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( '/inbox-placement-tests/automations/connections/{connectionId}', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementConnectionDto', # 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_automated_inbox_placement_schedule(self, schedule_id, update_automated_inbox_placement_schedule_options, **kwargs): # noqa: E501 """Update an automated inbox placement schedule # 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_automated_inbox_placement_schedule(schedule_id, update_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param UpdateAutomatedInboxPlacementScheduleOptions update_automated_inbox_placement_schedule_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: AutomatedInboxPlacementScheduleDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_automated_inbox_placement_schedule_with_http_info(schedule_id, update_automated_inbox_placement_schedule_options, **kwargs) # noqa: E501 def update_automated_inbox_placement_schedule_with_http_info(self, schedule_id, update_automated_inbox_placement_schedule_options, **kwargs): # noqa: E501 """Update an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(schedule_id, update_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schedule_id: (required) :param UpdateAutomatedInboxPlacementScheduleOptions update_automated_inbox_placement_schedule_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(AutomatedInboxPlacementScheduleDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'schedule_id', 'update_automated_inbox_placement_schedule_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_automated_inbox_placement_schedule" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schedule_id' is set if self.api_client.client_side_validation and ('schedule_id' not in local_var_params or # noqa: E501 local_var_params['schedule_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `schedule_id` when calling `update_automated_inbox_placement_schedule`") # noqa: E501 # verify the required parameter 'update_automated_inbox_placement_schedule_options' is set if self.api_client.client_side_validation and ('update_automated_inbox_placement_schedule_options' not in local_var_params or # noqa: E501 local_var_params['update_automated_inbox_placement_schedule_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_automated_inbox_placement_schedule_options` when calling `update_automated_inbox_placement_schedule`") # noqa: E501 collection_formats = {} path_params = {} if 'schedule_id' in local_var_params: path_params['scheduleId'] = local_var_params['schedule_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_automated_inbox_placement_schedule_options' in local_var_params: body_params = local_var_params['update_automated_inbox_placement_schedule_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( '/inbox-placement-tests/automations/schedules/{scheduleId}', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementScheduleDto', # 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 verify_automated_inbox_placement_connection(self, connection_id, **kwargs): # noqa: E501 """Verify a sender connection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.verify_automated_inbox_placement_connection(connection_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.verify_automated_inbox_placement_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def verify_automated_inbox_placement_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Verify a sender connection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.verify_automated_inbox_placement_connection_with_http_info(connection_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_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 verify_automated_inbox_placement_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'connection_id' is set if self.api_client.client_side_validation and ('connection_id' not in local_var_params or # noqa: E501 local_var_params['connection_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `connection_id` when calling `verify_automated_inbox_placement_connection`") # noqa: E501 collection_formats = {} path_params = {} if 'connection_id' in local_var_params: path_params['connectionId'] = local_var_params['connection_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( '/inbox-placement-tests/automations/connections/{connectionId}/verify', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AutomatedInboxPlacementConnectionDto', # 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_automated_inbox_placement_connection(self, create_automated_inbox_placement_connection_options, **kwargs)-
Create an encrypted sender connection # 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_automated_inbox_placement_connection(create_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementConnectionOptions create_automated_inbox_placement_connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread.
def create_automated_inbox_placement_connection_with_http_info(self, create_automated_inbox_placement_connection_options, **kwargs)-
Create an encrypted sender connection # 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_automated_inbox_placement_connection_with_http_info(create_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementConnectionOptions create_automated_inbox_placement_connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_automated_inbox_placement_schedule(self, create_automated_inbox_placement_schedule_options, **kwargs)-
Create an automated inbox placement schedule # 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_automated_inbox_placement_schedule(create_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementScheduleOptions create_automated_inbox_placement_schedule_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: AutomatedInboxPlacementScheduleDto If the method is called asynchronously, returns the request thread.
def create_automated_inbox_placement_schedule_with_http_info(self, create_automated_inbox_placement_schedule_options, **kwargs)-
Create an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(create_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateAutomatedInboxPlacementScheduleOptions create_automated_inbox_placement_schedule_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(AutomatedInboxPlacementScheduleDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_automated_inbox_placement_connection(self, connection_id, **kwargs)-
Disconnect a sender connection # 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_automated_inbox_placement_connection(connection_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_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: None If the method is called asynchronously, returns the request thread.
def delete_automated_inbox_placement_connection_with_http_info(self, connection_id, **kwargs)-
Disconnect a sender connection # 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_automated_inbox_placement_connection_with_http_info(connection_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_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: None If the method is called asynchronously, returns the request thread.
def delete_automated_inbox_placement_schedule(self, schedule_id, **kwargs)-
Delete an automated inbox placement schedule # 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_automated_inbox_placement_schedule(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_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: None If the method is called asynchronously, returns the request thread.
def delete_automated_inbox_placement_schedule_with_http_info(self, schedule_id, **kwargs)-
Delete an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_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: None If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_connection(self, connection_id, **kwargs)-
Get a sender connection # 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_automated_inbox_placement_connection(connection_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_connection_with_http_info(self, connection_id, **kwargs)-
Get a sender connection # 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_automated_inbox_placement_connection_with_http_info(connection_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_connections(self, **kwargs)-
List sender connections # 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_automated_inbox_placement_connections(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: list[AutomatedInboxPlacementConnectionDto] If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_connections_with_http_info(self, **kwargs)-
List sender connections # 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_automated_inbox_placement_connections_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(list[AutomatedInboxPlacementConnectionDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_execution_events(self, schedule_id, execution_id, **kwargs)-
List non-secret execution events # 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_automated_inbox_placement_execution_events(schedule_id, execution_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param str execution_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[AutomatedInboxPlacementEventDto] If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_execution_events_with_http_info(self, schedule_id, execution_id, **kwargs)-
List non-secret execution events # 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_automated_inbox_placement_execution_events_with_http_info(schedule_id, execution_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param str execution_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[AutomatedInboxPlacementEventDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_executions(self, schedule_id, **kwargs)-
List schedule executions # 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_automated_inbox_placement_executions(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param int limit: :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[AutomatedInboxPlacementExecutionDto] If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_executions_with_http_info(self, schedule_id, **kwargs)-
List schedule executions # 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_automated_inbox_placement_executions_with_http_info(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param int limit: :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[AutomatedInboxPlacementExecutionDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_providers(self, **kwargs)-
List automated inbox placement sender providers # 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_automated_inbox_placement_providers(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: list[AutomatedInboxPlacementProviderDto] If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_providers_with_http_info(self, **kwargs)-
List automated inbox placement sender providers # 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_automated_inbox_placement_providers_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(list[AutomatedInboxPlacementProviderDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_schedule(self, schedule_id, **kwargs)-
Get an automated inbox placement schedule # 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_automated_inbox_placement_schedule(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_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: AutomatedInboxPlacementScheduleDto If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_schedule_analytics_series(self, schedule_id, **kwargs)-
Get automation inbox placement analytics over time # noqa: E501
Returns chart-ready metrics for billed placement runs created by this schedule only. # 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_automated_inbox_placement_schedule_analytics_series(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param datetime since: :param datetime before: :param str bucket: :param int run_limit: :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: InboxPlacementAnalyticsSeriesDto If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_schedule_analytics_series_with_http_info(self, schedule_id, **kwargs)-
Get automation inbox placement analytics over time # noqa: E501
Returns chart-ready metrics for billed placement runs created by this schedule only. # 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_automated_inbox_placement_schedule_analytics_series_with_http_info(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param datetime since: :param datetime before: :param str bucket: :param int run_limit: :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(InboxPlacementAnalyticsSeriesDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_schedule_with_http_info(self, schedule_id, **kwargs)-
Get an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_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(AutomatedInboxPlacementScheduleDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_schedules(self, **kwargs)-
List automated inbox placement schedules # 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_automated_inbox_placement_schedules(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: list[AutomatedInboxPlacementScheduleDto] If the method is called asynchronously, returns the request thread.
def get_automated_inbox_placement_schedules_with_http_info(self, **kwargs)-
List automated inbox placement schedules # 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_automated_inbox_placement_schedules_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(list[AutomatedInboxPlacementScheduleDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def rotate_automated_inbox_placement_connection_credentials(self, connection_id, rotate_automated_inbox_placement_connection_credentials_options, **kwargs)-
Rotate sender connection credentials # noqa: E501
Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.rotate_automated_inbox_placement_connection_credentials(connection_id, rotate_automated_inbox_placement_connection_credentials_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateAutomatedInboxPlacementConnectionCredentialsOptions rotate_automated_inbox_placement_connection_credentials_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread.
def rotate_automated_inbox_placement_connection_credentials_with_http_info(self, connection_id, rotate_automated_inbox_placement_connection_credentials_options, **kwargs)-
Rotate sender connection credentials # noqa: E501
Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.rotate_automated_inbox_placement_connection_credentials_with_http_info(connection_id, rotate_automated_inbox_placement_connection_credentials_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateAutomatedInboxPlacementConnectionCredentialsOptions rotate_automated_inbox_placement_connection_credentials_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def run_automated_inbox_placement_schedule(self, schedule_id, **kwargs)-
Run an automated inbox placement schedule now # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_automated_inbox_placement_schedule(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_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: AutomatedInboxPlacementExecutionDto If the method is called asynchronously, returns the request thread.
def run_automated_inbox_placement_schedule_with_http_info(self, schedule_id, **kwargs)-
Run an automated inbox placement schedule now # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_automated_inbox_placement_schedule_with_http_info(schedule_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_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(AutomatedInboxPlacementExecutionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_automated_inbox_placement_connection(self, connection_id, update_automated_inbox_placement_connection_options, **kwargs)-
Update a sender connection # noqa: E501
Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings. # 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_automated_inbox_placement_connection(connection_id, update_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateAutomatedInboxPlacementConnectionOptions update_automated_inbox_placement_connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread.
def update_automated_inbox_placement_connection_with_http_info(self, connection_id, update_automated_inbox_placement_connection_options, **kwargs)-
Update a sender connection # noqa: E501
Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings. # 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_automated_inbox_placement_connection_with_http_info(connection_id, update_automated_inbox_placement_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateAutomatedInboxPlacementConnectionOptions update_automated_inbox_placement_connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_automated_inbox_placement_schedule(self, schedule_id, update_automated_inbox_placement_schedule_options, **kwargs)-
Update an automated inbox placement schedule # 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_automated_inbox_placement_schedule(schedule_id, update_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param UpdateAutomatedInboxPlacementScheduleOptions update_automated_inbox_placement_schedule_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: AutomatedInboxPlacementScheduleDto If the method is called asynchronously, returns the request thread.
def update_automated_inbox_placement_schedule_with_http_info(self, schedule_id, update_automated_inbox_placement_schedule_options, **kwargs)-
Update an automated inbox placement schedule # 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_automated_inbox_placement_schedule_with_http_info(schedule_id, update_automated_inbox_placement_schedule_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schedule_id: (required) :param UpdateAutomatedInboxPlacementScheduleOptions update_automated_inbox_placement_schedule_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(AutomatedInboxPlacementScheduleDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def verify_automated_inbox_placement_connection(self, connection_id, **kwargs)-
Verify a sender connection # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.verify_automated_inbox_placement_connection(connection_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_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: AutomatedInboxPlacementConnectionDto If the method is called asynchronously, returns the request thread.
def verify_automated_inbox_placement_connection_with_http_info(self, connection_id, **kwargs)-
Verify a sender connection # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.verify_automated_inbox_placement_connection_with_http_info(connection_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_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(AutomatedInboxPlacementConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.