Module mailslurp_client.api.api_sending_connection_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 ApiSendingConnectionControllerApi (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 ApiSendingConnectionControllerApi(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_sending_connection(self, create_sending_connection_options, **kwargs): # noqa: E501 """Create a sending 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_sending_connection(create_sending_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateSendingConnectionOptions create_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_sending_connection_with_http_info(create_sending_connection_options, **kwargs) # noqa: E501 def create_sending_connection_with_http_info(self, create_sending_connection_options, **kwargs): # noqa: E501 """Create a sending 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_sending_connection_with_http_info(create_sending_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateSendingConnectionOptions create_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_sending_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_sending_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_sending_connection_options' is set if self.api_client.client_side_validation and ('create_sending_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_sending_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_sending_connection_options` when calling `create_sending_connection`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_sending_connection_options' in local_var_params: body_params = local_var_params['create_sending_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( '/sending-connections', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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_delivery_sender_seats(self, **kwargs): # noqa: E501 """Cancel purchased Delivery Sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_delivery_sender_seats(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DeliverySenderCapacityDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_delivery_sender_seats_with_http_info(**kwargs) # noqa: E501 def delete_delivery_sender_seats_with_http_info(self, **kwargs): # noqa: E501 """Cancel purchased Delivery Sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_delivery_sender_seats_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DeliverySenderCapacityDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_delivery_sender_seats" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/sending-connections/sender-seats', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='DeliverySenderCapacityDto', # 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_sending_connection(self, connection_id, **kwargs): # noqa: E501 """Disconnect a sending 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_sending_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_sending_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def delete_sending_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Disconnect a sending 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_sending_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_sending_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_sending_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( '/sending-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 disable_sending_connection(self, connection_id, **kwargs): # noqa: E501 """Disable Delivery Sender capacity # noqa: E501 Releases this connection's shared sender allocation while retaining its verified credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.disable_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.disable_sending_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def disable_sending_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Disable Delivery Sender capacity # noqa: E501 Releases this connection's shared sender allocation while retaining its verified credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.disable_sending_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(SendingConnectionDto, 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 disable_sending_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 `disable_sending_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( '/sending-connections/{connectionId}/enable', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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 enable_sending_connection(self, connection_id, **kwargs): # noqa: E501 """Enable a verified Delivery Sender # noqa: E501 Allocates shared sender capacity. Included capacity is used first and supported additional capacity is added to the existing subscription when possible. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.enable_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.enable_sending_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def enable_sending_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Enable a verified Delivery Sender # noqa: E501 Allocates shared sender capacity. Included capacity is used first and supported additional capacity is added to the existing subscription when possible. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.enable_sending_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(SendingConnectionDto, 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 enable_sending_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 `enable_sending_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( '/sending-connections/{connectionId}/enable', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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_delivery_sender_capacity(self, **kwargs): # noqa: E501 """Get shared Delivery Sender capacity # 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_delivery_sender_capacity(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: DeliverySenderCapacityDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_delivery_sender_capacity_with_http_info(**kwargs) # noqa: E501 def get_delivery_sender_capacity_with_http_info(self, **kwargs): # noqa: E501 """Get shared Delivery Sender capacity # 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_delivery_sender_capacity_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(DeliverySenderCapacityDto, 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_delivery_sender_capacity" % 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( '/sending-connections/capacity', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='DeliverySenderCapacityDto', # 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_sending_connection(self, connection_id, **kwargs): # noqa: E501 """Get a sending 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_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_sending_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def get_sending_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Get a sending 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_sending_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(SendingConnectionDto, 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_sending_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_sending_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( '/sending-connections/{connectionId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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_sending_connection_providers(self, **kwargs): # noqa: E501 """List sending connection 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_sending_connection_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[SendingConnectionProviderDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_sending_connection_providers_with_http_info(**kwargs) # noqa: E501 def get_sending_connection_providers_with_http_info(self, **kwargs): # noqa: E501 """List sending connection 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_sending_connection_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[SendingConnectionProviderDto], 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_sending_connection_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( '/sending-connections/providers', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[SendingConnectionProviderDto]', # 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_sending_connections(self, **kwargs): # noqa: E501 """List sending 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_sending_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[SendingConnectionDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_sending_connections_with_http_info(**kwargs) # noqa: E501 def get_sending_connections_with_http_info(self, **kwargs): # noqa: E501 """List sending 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_sending_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[SendingConnectionDto], 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_sending_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( '/sending-connections', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[SendingConnectionDto]', # 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 probe_sending_connection_delivery(self, connection_id, **kwargs): # noqa: E501 """Send an unbilled delivery test to a temporary MailSlurp inbox # noqa: E501 Uses only the selected customer-owned connection. A successful receipt proves provider acceptance and delivery to MailSlurp, not Gmail or Outlook placement. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.probe_sending_connection_delivery(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: SendingConnectionDeliveryProbeDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.probe_sending_connection_delivery_with_http_info(connection_id, **kwargs) # noqa: E501 def probe_sending_connection_delivery_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Send an unbilled delivery test to a temporary MailSlurp inbox # noqa: E501 Uses only the selected customer-owned connection. A successful receipt proves provider acceptance and delivery to MailSlurp, not Gmail or Outlook placement. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.probe_sending_connection_delivery_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(SendingConnectionDeliveryProbeDto, 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 probe_sending_connection_delivery" % 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 `probe_sending_connection_delivery`") # 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( '/sending-connections/{connectionId}/delivery-probe', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDeliveryProbeDto', # 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_sending_connection_credentials(self, connection_id, rotate_sending_connection_credentials_options, **kwargs): # noqa: E501 """Rotate sending connection credentials # noqa: E501 Verifies supported replacement credentials before atomically replacing the encrypted credential envelope. # 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_sending_connection_credentials(connection_id, rotate_sending_connection_credentials_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateSendingConnectionCredentialsOptions rotate_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.rotate_sending_connection_credentials_with_http_info(connection_id, rotate_sending_connection_credentials_options, **kwargs) # noqa: E501 def rotate_sending_connection_credentials_with_http_info(self, connection_id, rotate_sending_connection_credentials_options, **kwargs): # noqa: E501 """Rotate sending connection credentials # noqa: E501 Verifies supported replacement credentials before atomically replacing the encrypted credential envelope. # 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_sending_connection_credentials_with_http_info(connection_id, rotate_sending_connection_credentials_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateSendingConnectionCredentialsOptions rotate_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_id', 'rotate_sending_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_sending_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_sending_connection_credentials`") # noqa: E501 # verify the required parameter 'rotate_sending_connection_credentials_options' is set if self.api_client.client_side_validation and ('rotate_sending_connection_credentials_options' not in local_var_params or # noqa: E501 local_var_params['rotate_sending_connection_credentials_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `rotate_sending_connection_credentials_options` when calling `rotate_sending_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_sending_connection_credentials_options' in local_var_params: body_params = local_var_params['rotate_sending_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( '/sending-connections/{connectionId}/credentials', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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_delivery_sender_seats(self, update_delivery_sender_seats_options, **kwargs): # noqa: E501 """Update purchased Delivery Sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_delivery_sender_seats(update_delivery_sender_seats_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param UpdateDeliverySenderSeatsOptions update_delivery_sender_seats_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DeliverySenderCapacityDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_delivery_sender_seats_with_http_info(update_delivery_sender_seats_options, **kwargs) # noqa: E501 def update_delivery_sender_seats_with_http_info(self, update_delivery_sender_seats_options, **kwargs): # noqa: E501 """Update purchased Delivery Sender seats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_delivery_sender_seats_with_http_info(update_delivery_sender_seats_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param UpdateDeliverySenderSeatsOptions update_delivery_sender_seats_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DeliverySenderCapacityDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'update_delivery_sender_seats_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method update_delivery_sender_seats" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'update_delivery_sender_seats_options' is set if self.api_client.client_side_validation and ('update_delivery_sender_seats_options' not in local_var_params or # noqa: E501 local_var_params['update_delivery_sender_seats_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_delivery_sender_seats_options` when calling `update_delivery_sender_seats`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_delivery_sender_seats_options' in local_var_params: body_params = local_var_params['update_delivery_sender_seats_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/sending-connections/sender-seats', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='DeliverySenderCapacityDto', # 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_sending_connection(self, connection_id, update_sending_connection_options, **kwargs): # noqa: E501 """Update a sending connection # noqa: E501 Updates non-secret connection metadata. Use the credentials endpoint to replace supported SMTP or API-key credentials. # 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_sending_connection(connection_id, update_sending_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateSendingConnectionOptions update_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_sending_connection_with_http_info(connection_id, update_sending_connection_options, **kwargs) # noqa: E501 def update_sending_connection_with_http_info(self, connection_id, update_sending_connection_options, **kwargs): # noqa: E501 """Update a sending connection # noqa: E501 Updates non-secret connection metadata. Use the credentials endpoint to replace supported SMTP or API-key credentials. # 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_sending_connection_with_http_info(connection_id, update_sending_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateSendingConnectionOptions update_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'connection_id', 'update_sending_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_sending_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_sending_connection`") # noqa: E501 # verify the required parameter 'update_sending_connection_options' is set if self.api_client.client_side_validation and ('update_sending_connection_options' not in local_var_params or # noqa: E501 local_var_params['update_sending_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_sending_connection_options` when calling `update_sending_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_sending_connection_options' in local_var_params: body_params = local_var_params['update_sending_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( '/sending-connections/{connectionId}', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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_sending_connection(self, connection_id, **kwargs): # noqa: E501 """Verify a sending connection # noqa: E501 Verifies the customer credential without enabling billable sender capacity. A consuming product enables the shared Delivery Sender seat when sending starts. # 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_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.verify_sending_connection_with_http_info(connection_id, **kwargs) # noqa: E501 def verify_sending_connection_with_http_info(self, connection_id, **kwargs): # noqa: E501 """Verify a sending connection # noqa: E501 Verifies the customer credential without enabling billable sender capacity. A consuming product enables the shared Delivery Sender seat when sending starts. # 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_sending_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(SendingConnectionDto, 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_sending_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_sending_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( '/sending-connections/{connectionId}/verify', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SendingConnectionDto', # 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_sending_connection(self, create_sending_connection_options, **kwargs)-
Create a sending 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_sending_connection(create_sending_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateSendingConnectionOptions create_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def create_sending_connection_with_http_info(self, create_sending_connection_options, **kwargs)-
Create a sending 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_sending_connection_with_http_info(create_sending_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateSendingConnectionOptions create_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_delivery_sender_seats(self, **kwargs)-
Cancel purchased Delivery Sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_delivery_sender_seats(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DeliverySenderCapacityDto If the method is called asynchronously, returns the request thread.
def delete_delivery_sender_seats_with_http_info(self, **kwargs)-
Cancel purchased Delivery Sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_delivery_sender_seats_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DeliverySenderCapacityDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_sending_connection(self, connection_id, **kwargs)-
Disconnect a sending 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_sending_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_sending_connection_with_http_info(self, connection_id, **kwargs)-
Disconnect a sending 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_sending_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 disable_sending_connection(self, connection_id, **kwargs)-
Disable Delivery Sender capacity # noqa: E501
Releases this connection's shared sender allocation while retaining its verified credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.disable_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def disable_sending_connection_with_http_info(self, connection_id, **kwargs)-
Disable Delivery Sender capacity # noqa: E501
Releases this connection's shared sender allocation while retaining its verified credentials. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.disable_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def enable_sending_connection(self, connection_id, **kwargs)-
Enable a verified Delivery Sender # noqa: E501
Allocates shared sender capacity. Included capacity is used first and supported additional capacity is added to the existing subscription when possible. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.enable_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def enable_sending_connection_with_http_info(self, connection_id, **kwargs)-
Enable a verified Delivery Sender # noqa: E501
Allocates shared sender capacity. Included capacity is used first and supported additional capacity is added to the existing subscription when possible. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.enable_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_delivery_sender_capacity(self, **kwargs)-
Get shared Delivery Sender capacity # 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_delivery_sender_capacity(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: DeliverySenderCapacityDto If the method is called asynchronously, returns the request thread.
def get_delivery_sender_capacity_with_http_info(self, **kwargs)-
Get shared Delivery Sender capacity # 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_delivery_sender_capacity_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(DeliverySenderCapacityDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_sending_connection(self, connection_id, **kwargs)-
Get a sending 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_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def get_sending_connection_providers(self, **kwargs)-
List sending connection 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_sending_connection_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[SendingConnectionProviderDto] If the method is called asynchronously, returns the request thread.
def get_sending_connection_providers_with_http_info(self, **kwargs)-
List sending connection 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_sending_connection_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[SendingConnectionProviderDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_sending_connection_with_http_info(self, connection_id, **kwargs)-
Get a sending 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_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_sending_connections(self, **kwargs)-
List sending 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_sending_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[SendingConnectionDto] If the method is called asynchronously, returns the request thread.
def get_sending_connections_with_http_info(self, **kwargs)-
List sending 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_sending_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[SendingConnectionDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def probe_sending_connection_delivery(self, connection_id, **kwargs)-
Send an unbilled delivery test to a temporary MailSlurp inbox # noqa: E501
Uses only the selected customer-owned connection. A successful receipt proves provider acceptance and delivery to MailSlurp, not Gmail or Outlook placement. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.probe_sending_connection_delivery(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: SendingConnectionDeliveryProbeDto If the method is called asynchronously, returns the request thread.
def probe_sending_connection_delivery_with_http_info(self, connection_id, **kwargs)-
Send an unbilled delivery test to a temporary MailSlurp inbox # noqa: E501
Uses only the selected customer-owned connection. A successful receipt proves provider acceptance and delivery to MailSlurp, not Gmail or Outlook placement. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.probe_sending_connection_delivery_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(SendingConnectionDeliveryProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def rotate_sending_connection_credentials(self, connection_id, rotate_sending_connection_credentials_options, **kwargs)-
Rotate sending connection credentials # noqa: E501
Verifies supported replacement credentials before atomically replacing the encrypted credential envelope. # 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_sending_connection_credentials(connection_id, rotate_sending_connection_credentials_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateSendingConnectionCredentialsOptions rotate_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def rotate_sending_connection_credentials_with_http_info(self, connection_id, rotate_sending_connection_credentials_options, **kwargs)-
Rotate sending connection credentials # noqa: E501
Verifies supported replacement credentials before atomically replacing the encrypted credential envelope. # 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_sending_connection_credentials_with_http_info(connection_id, rotate_sending_connection_credentials_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param RotateSendingConnectionCredentialsOptions rotate_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_delivery_sender_seats(self, update_delivery_sender_seats_options, **kwargs)-
Update purchased Delivery Sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_delivery_sender_seats(update_delivery_sender_seats_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param UpdateDeliverySenderSeatsOptions update_delivery_sender_seats_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: DeliverySenderCapacityDto If the method is called asynchronously, returns the request thread.
def update_delivery_sender_seats_with_http_info(self, update_delivery_sender_seats_options, **kwargs)-
Update purchased Delivery Sender seats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_delivery_sender_seats_with_http_info(update_delivery_sender_seats_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param UpdateDeliverySenderSeatsOptions update_delivery_sender_seats_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(DeliverySenderCapacityDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_sending_connection(self, connection_id, update_sending_connection_options, **kwargs)-
Update a sending connection # noqa: E501
Updates non-secret connection metadata. Use the credentials endpoint to replace supported SMTP or API-key credentials. # 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_sending_connection(connection_id, update_sending_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateSendingConnectionOptions update_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def update_sending_connection_with_http_info(self, connection_id, update_sending_connection_options, **kwargs)-
Update a sending connection # noqa: E501
Updates non-secret connection metadata. Use the credentials endpoint to replace supported SMTP or API-key credentials. # 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_sending_connection_with_http_info(connection_id, update_sending_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str connection_id: (required) :param UpdateSendingConnectionOptions update_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def verify_sending_connection(self, connection_id, **kwargs)-
Verify a sending connection # noqa: E501
Verifies the customer credential without enabling billable sender capacity. A consuming product enables the shared Delivery Sender seat when sending starts. # 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_sending_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: SendingConnectionDto If the method is called asynchronously, returns the request thread.
def verify_sending_connection_with_http_info(self, connection_id, **kwargs)-
Verify a sending connection # noqa: E501
Verifies the customer credential without enabling billable sender capacity. A consuming product enables the shared Delivery Sender seat when sending starts. # 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_sending_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(SendingConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.