Module mailslurp_client.api.inbox_replier_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 InboxReplierControllerApi (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 InboxReplierControllerApi(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_new_inbox_replier(self, create_inbox_replier_options, **kwargs): # noqa: E501 """Create an inbox replier # noqa: E501 Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving # 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_new_inbox_replier(create_inbox_replier_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxReplierOptions create_inbox_replier_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: InboxReplierDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_new_inbox_replier_with_http_info(create_inbox_replier_options, **kwargs) # noqa: E501 def create_new_inbox_replier_with_http_info(self, create_inbox_replier_options, **kwargs): # noqa: E501 """Create an inbox replier # noqa: E501 Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving # 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_new_inbox_replier_with_http_info(create_inbox_replier_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxReplierOptions create_inbox_replier_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(InboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_inbox_replier_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_new_inbox_replier" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_inbox_replier_options' is set if self.api_client.client_side_validation and ('create_inbox_replier_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_replier_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_replier_options` when calling `create_new_inbox_replier`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_replier_options' in local_var_params: body_params = local_var_params['create_inbox_replier_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( '/repliers', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxReplierDto', # 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_inbox_replier(self, id, **kwargs): # noqa: E501 """Delete an inbox replier # noqa: E501 Delete inbox replier # 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_inbox_replier(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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_inbox_replier_with_http_info(id, **kwargs) # noqa: E501 def delete_inbox_replier_with_http_info(self, id, **kwargs): # noqa: E501 """Delete an inbox replier # noqa: E501 Delete inbox replier # 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_inbox_replier_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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 = [ '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_inbox_replier" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `delete_inbox_replier`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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( '/repliers/{id}', '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_inbox_repliers(self, **kwargs): # noqa: E501 """Delete inbox repliers # noqa: E501 Delete inbox repliers. Accepts optional inboxId filter. # 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_inbox_repliers(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach replier to :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_inbox_repliers_with_http_info(**kwargs) # noqa: E501 def delete_inbox_repliers_with_http_info(self, **kwargs): # noqa: E501 """Delete inbox repliers # noqa: E501 Delete inbox repliers. Accepts optional inboxId filter. # 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_inbox_repliers_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach replier to :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 = [ 'inbox_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_inbox_repliers" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/repliers', '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_all_inbox_replier_events(self, **kwargs): # noqa: E501 """Get inbox replier event list # noqa: E501 Get all inbox ruleset 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_all_inbox_replier_events(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_replier_id: ID of inbox replier :param str inbox_id: ID of inbox :param str email_id: ID of email :param str sent_id: ID of sent :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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: PageInboxReplierEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_inbox_replier_events_with_http_info(**kwargs) # noqa: E501 def get_all_inbox_replier_events_with_http_info(self, **kwargs): # noqa: E501 """Get inbox replier event list # noqa: E501 Get all inbox ruleset 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_all_inbox_replier_events_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_replier_id: ID of inbox replier :param str inbox_id: ID of inbox :param str email_id: ID of email :param str sent_id: ID of sent :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxReplierEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_replier_id', 'inbox_id', 'email_id', 'sent_id', 'page', 'size', 'sort' ] 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_all_inbox_replier_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_replier_id' in local_var_params and local_var_params['inbox_replier_id'] is not None: # noqa: E501 query_params.append(('inboxReplierId', local_var_params['inbox_replier_id'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'sent_id' in local_var_params and local_var_params['sent_id'] is not None: # noqa: E501 query_params.append(('sentId', local_var_params['sent_id'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/repliers/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxReplierEvents', # 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_inbox_replier(self, id, **kwargs): # noqa: E501 """Get an inbox replier # noqa: E501 Get inbox ruleset # 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_inbox_replier(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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: InboxReplierDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_replier_with_http_info(id, **kwargs) # noqa: E501 def get_inbox_replier_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox replier # noqa: E501 Get inbox ruleset # 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_inbox_replier_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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(InboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '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_inbox_replier" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_replier`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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( '/repliers/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxReplierDto', # 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_inbox_replier_events(self, id, **kwargs): # noqa: E501 """Get an inbox replier event list # noqa: E501 Get inbox ruleset 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_inbox_replier_events(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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: PageInboxReplierEvents If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_replier_events_with_http_info(id, **kwargs) # noqa: E501 def get_inbox_replier_events_with_http_info(self, id, **kwargs): # noqa: E501 """Get an inbox replier event list # noqa: E501 Get inbox ruleset 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_inbox_replier_events_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxReplierEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'page', 'size', 'sort' ] 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_inbox_replier_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_inbox_replier_events`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/repliers/{id}/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxReplierEvents', # 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_inbox_repliers(self, **kwargs): # noqa: E501 """List inbox repliers # noqa: E501 List all repliers attached to an inbox # 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_inbox_repliers(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get repliers from :param int page: Optional page index in inbox replier list pagination :param int size: Optional page size in inbox replier list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageInboxReplierDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_repliers_with_http_info(**kwargs) # noqa: E501 def get_inbox_repliers_with_http_info(self, **kwargs): # noqa: E501 """List inbox repliers # noqa: E501 List all repliers attached to an inbox # 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_inbox_repliers_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get repliers from :param int page: Optional page index in inbox replier list pagination :param int size: Optional page size in inbox replier list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageInboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'inbox_id', 'page', 'size', 'sort', 'since', 'before' ] 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_inbox_repliers" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 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 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( '/repliers', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxReplierDto', # 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_inbox_replier(self, id, update_inbox_replier_options, **kwargs): # noqa: E501 """Update an inbox replier # noqa: E501 Update inbox ruleset # 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_inbox_replier(id, update_inbox_replier_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param UpdateInboxReplierOptions update_inbox_replier_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: InboxReplierDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_inbox_replier_with_http_info(id, update_inbox_replier_options, **kwargs) # noqa: E501 def update_inbox_replier_with_http_info(self, id, update_inbox_replier_options, **kwargs): # noqa: E501 """Update an inbox replier # noqa: E501 Update inbox ruleset # 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_inbox_replier_with_http_info(id, update_inbox_replier_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param UpdateInboxReplierOptions update_inbox_replier_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(InboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'update_inbox_replier_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_inbox_replier" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `update_inbox_replier`") # noqa: E501 # verify the required parameter 'update_inbox_replier_options' is set if self.api_client.client_side_validation and ('update_inbox_replier_options' not in local_var_params or # noqa: E501 local_var_params['update_inbox_replier_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_inbox_replier_options` when calling `update_inbox_replier`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_inbox_replier_options' in local_var_params: body_params = local_var_params['update_inbox_replier_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( '/repliers/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxReplierDto', # 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_new_inbox_replier(self, create_inbox_replier_options, **kwargs)-
Create an inbox replier # noqa: E501
Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving # 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_new_inbox_replier(create_inbox_replier_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxReplierOptions create_inbox_replier_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: InboxReplierDto If the method is called asynchronously, returns the request thread.
def create_new_inbox_replier_with_http_info(self, create_inbox_replier_options, **kwargs)-
Create an inbox replier # noqa: E501
Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving # 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_new_inbox_replier_with_http_info(create_inbox_replier_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxReplierOptions create_inbox_replier_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(InboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_inbox_replier(self, id, **kwargs)-
Delete an inbox replier # noqa: E501
Delete inbox replier # 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_inbox_replier(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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_inbox_replier_with_http_info(self, id, **kwargs)-
Delete an inbox replier # noqa: E501
Delete inbox replier # 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_inbox_replier_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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_inbox_repliers(self, **kwargs)-
Delete inbox repliers # noqa: E501
Delete inbox repliers. Accepts optional inboxId filter. # 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_inbox_repliers(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach replier to :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_inbox_repliers_with_http_info(self, **kwargs)-
Delete inbox repliers # noqa: E501
Delete inbox repliers. Accepts optional inboxId filter. # 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_inbox_repliers_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to attach replier to :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_all_inbox_replier_events(self, **kwargs)-
Get inbox replier event list # noqa: E501
Get all inbox ruleset 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_all_inbox_replier_events(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_replier_id: ID of inbox replier :param str inbox_id: ID of inbox :param str email_id: ID of email :param str sent_id: ID of sent :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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: PageInboxReplierEvents If the method is called asynchronously, returns the request thread.
def get_all_inbox_replier_events_with_http_info(self, **kwargs)-
Get inbox replier event list # noqa: E501
Get all inbox ruleset 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_all_inbox_replier_events_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_replier_id: ID of inbox replier :param str inbox_id: ID of inbox :param str email_id: ID of email :param str sent_id: ID of sent :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxReplierEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_replier(self, id, **kwargs)-
Get an inbox replier # noqa: E501
Get inbox ruleset # 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_inbox_replier(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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: InboxReplierDto If the method is called asynchronously, returns the request thread.
def get_inbox_replier_events(self, id, **kwargs)-
Get an inbox replier event list # noqa: E501
Get inbox ruleset 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_inbox_replier_events(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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: PageInboxReplierEvents If the method is called asynchronously, returns the request thread.
def get_inbox_replier_events_with_http_info(self, id, **kwargs)-
Get an inbox replier event list # noqa: E501
Get inbox ruleset 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_inbox_replier_events_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param int page: Optional page index in inbox replier event list pagination :param int size: Optional page size in inbox replier event list pagination :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxReplierEvents, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_replier_with_http_info(self, id, **kwargs)-
Get an inbox replier # noqa: E501
Get inbox ruleset # 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_inbox_replier_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (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(InboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_repliers(self, **kwargs)-
List inbox repliers # noqa: E501
List all repliers attached to an inbox # 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_inbox_repliers(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get repliers from :param int page: Optional page index in inbox replier list pagination :param int size: Optional page size in inbox replier list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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: PageInboxReplierDto If the method is called asynchronously, returns the request thread.
def get_inbox_repliers_with_http_info(self, **kwargs)-
List inbox repliers # noqa: E501
List all repliers attached to an inbox # 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_inbox_repliers_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str inbox_id: Optional inbox id to get repliers from :param int page: Optional page index in inbox replier list pagination :param int size: Optional page size in inbox replier list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageInboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_inbox_replier(self, id, update_inbox_replier_options, **kwargs)-
Update an inbox replier # noqa: E501
Update inbox ruleset # 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_inbox_replier(id, update_inbox_replier_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param UpdateInboxReplierOptions update_inbox_replier_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: InboxReplierDto If the method is called asynchronously, returns the request thread.
def update_inbox_replier_with_http_info(self, id, update_inbox_replier_options, **kwargs)-
Update an inbox replier # noqa: E501
Update inbox ruleset # 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_inbox_replier_with_http_info(id, update_inbox_replier_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of inbox replier (required) :param UpdateInboxReplierOptions update_inbox_replier_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(InboxReplierDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.