Module mailslurp_client.api.domain_monitor_postmaster_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 DomainMonitorPostmasterControllerApi (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 DomainMonitorPostmasterControllerApi(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_domain_monitor_postmaster_connection(self, create_postmaster_connection_options, **kwargs): # noqa: E501 """Create Postmaster OAuth connection URL # 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_domain_monitor_postmaster_connection(create_postmaster_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePostmasterConnectionOptions create_postmaster_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: CreatePostmasterConnectionResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_domain_monitor_postmaster_connection_with_http_info(create_postmaster_connection_options, **kwargs) # noqa: E501 def create_domain_monitor_postmaster_connection_with_http_info(self, create_postmaster_connection_options, **kwargs): # noqa: E501 """Create Postmaster OAuth connection URL # 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_domain_monitor_postmaster_connection_with_http_info(create_postmaster_connection_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePostmasterConnectionOptions create_postmaster_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(CreatePostmasterConnectionResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_postmaster_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_domain_monitor_postmaster_connection" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_postmaster_connection_options' is set if self.api_client.client_side_validation and ('create_postmaster_connection_options' not in local_var_params or # noqa: E501 local_var_params['create_postmaster_connection_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_postmaster_connection_options` when calling `create_domain_monitor_postmaster_connection`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_postmaster_connection_options' in local_var_params: body_params = local_var_params['create_postmaster_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( '/domain-monitor/postmaster/connect', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CreatePostmasterConnectionResult', # 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_domain_monitor_postmaster_connection(self, **kwargs): # noqa: E501 """Disconnect Postmaster OAuth # 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_domain_monitor_postmaster_connection(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: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_domain_monitor_postmaster_connection_with_http_info(**kwargs) # noqa: E501 def delete_domain_monitor_postmaster_connection_with_http_info(self, **kwargs): # noqa: E501 """Disconnect Postmaster OAuth # 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_domain_monitor_postmaster_connection_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: None 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_domain_monitor_postmaster_connection" % 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 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/domain-monitor/postmaster/connection', '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 exchange_domain_monitor_postmaster_code(self, exchange_postmaster_code_options, **kwargs): # noqa: E501 """Exchange Postmaster OAuth authorization code # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.exchange_domain_monitor_postmaster_code(exchange_postmaster_code_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ExchangePostmasterCodeOptions exchange_postmaster_code_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: PostmasterConnectionDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.exchange_domain_monitor_postmaster_code_with_http_info(exchange_postmaster_code_options, **kwargs) # noqa: E501 def exchange_domain_monitor_postmaster_code_with_http_info(self, exchange_postmaster_code_options, **kwargs): # noqa: E501 """Exchange Postmaster OAuth authorization code # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.exchange_domain_monitor_postmaster_code_with_http_info(exchange_postmaster_code_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ExchangePostmasterCodeOptions exchange_postmaster_code_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(PostmasterConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'exchange_postmaster_code_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 exchange_domain_monitor_postmaster_code" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'exchange_postmaster_code_options' is set if self.api_client.client_side_validation and ('exchange_postmaster_code_options' not in local_var_params or # noqa: E501 local_var_params['exchange_postmaster_code_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `exchange_postmaster_code_options` when calling `exchange_domain_monitor_postmaster_code`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'exchange_postmaster_code_options' in local_var_params: body_params = local_var_params['exchange_postmaster_code_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( '/domain-monitor/postmaster/oauth-exchange', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PostmasterConnectionDto', # 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_domain_monitor_postmaster_connection(self, **kwargs): # noqa: E501 """Get Postmaster connection status # 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_domain_monitor_postmaster_connection(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: PostmasterConnectionStatusDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_domain_monitor_postmaster_connection_with_http_info(**kwargs) # noqa: E501 def get_domain_monitor_postmaster_connection_with_http_info(self, **kwargs): # noqa: E501 """Get Postmaster connection status # 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_domain_monitor_postmaster_connection_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(PostmasterConnectionStatusDto, 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_domain_monitor_postmaster_connection" % 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( '/domain-monitor/postmaster/connection', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PostmasterConnectionStatusDto', # 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_domain_monitor_postmaster_domains(self, **kwargs): # noqa: E501 """List local Postmaster domain snapshots # 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_domain_monitor_postmaster_domains(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[PostmasterDomainDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_domain_monitor_postmaster_domains_with_http_info(**kwargs) # noqa: E501 def get_domain_monitor_postmaster_domains_with_http_info(self, **kwargs): # noqa: E501 """List local Postmaster domain snapshots # 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_domain_monitor_postmaster_domains_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[PostmasterDomainDto], 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_domain_monitor_postmaster_domains" % 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( '/domain-monitor/postmaster/domains', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[PostmasterDomainDto]', # 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_domain_monitor_postmaster_traffic_stats(self, domain, **kwargs): # noqa: E501 """Get local Postmaster traffic stats # 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_domain_monitor_postmaster_traffic_stats(domain, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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: PostmasterTrafficStatsListDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_domain_monitor_postmaster_traffic_stats_with_http_info(domain, **kwargs) # noqa: E501 def get_domain_monitor_postmaster_traffic_stats_with_http_info(self, domain, **kwargs): # noqa: E501 """Get local Postmaster traffic stats # 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_domain_monitor_postmaster_traffic_stats_with_http_info(domain, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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(PostmasterTrafficStatsListDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'domain', 'start_date', 'end_date' ] 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_domain_monitor_postmaster_traffic_stats" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'domain' is set if self.api_client.client_side_validation and ('domain' not in local_var_params or # noqa: E501 local_var_params['domain'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `domain` when calling `get_domain_monitor_postmaster_traffic_stats`") # noqa: E501 collection_formats = {} path_params = {} if 'domain' in local_var_params: path_params['domain'] = local_var_params['domain'] # noqa: E501 query_params = [] if 'start_date' in local_var_params and local_var_params['start_date'] is not None: # noqa: E501 query_params.append(('startDate', local_var_params['start_date'])) # noqa: E501 if 'end_date' in local_var_params and local_var_params['end_date'] is not None: # noqa: E501 query_params.append(('endDate', local_var_params['end_date'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/domain-monitor/postmaster/domains/{domain}/traffic-stats', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PostmasterTrafficStatsListDto', # 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 sync_domain_monitor_postmaster_domains(self, **kwargs): # noqa: E501 """Sync Postmaster domains # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sync_domain_monitor_postmaster_domains(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[PostmasterDomainDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sync_domain_monitor_postmaster_domains_with_http_info(**kwargs) # noqa: E501 def sync_domain_monitor_postmaster_domains_with_http_info(self, **kwargs): # noqa: E501 """Sync Postmaster domains # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sync_domain_monitor_postmaster_domains_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[PostmasterDomainDto], 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 sync_domain_monitor_postmaster_domains" % 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( '/domain-monitor/postmaster/domains/sync', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[PostmasterDomainDto]', # 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 sync_domain_monitor_postmaster_traffic_stats(self, domain, **kwargs): # noqa: E501 """Sync Postmaster traffic stats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sync_domain_monitor_postmaster_traffic_stats(domain, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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: PostmasterTrafficStatsListDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sync_domain_monitor_postmaster_traffic_stats_with_http_info(domain, **kwargs) # noqa: E501 def sync_domain_monitor_postmaster_traffic_stats_with_http_info(self, domain, **kwargs): # noqa: E501 """Sync Postmaster traffic stats # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sync_domain_monitor_postmaster_traffic_stats_with_http_info(domain, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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(PostmasterTrafficStatsListDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'domain', 'start_date', 'end_date' ] 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 sync_domain_monitor_postmaster_traffic_stats" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'domain' is set if self.api_client.client_side_validation and ('domain' not in local_var_params or # noqa: E501 local_var_params['domain'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `domain` when calling `sync_domain_monitor_postmaster_traffic_stats`") # noqa: E501 collection_formats = {} path_params = {} if 'domain' in local_var_params: path_params['domain'] = local_var_params['domain'] # noqa: E501 query_params = [] if 'start_date' in local_var_params and local_var_params['start_date'] is not None: # noqa: E501 query_params.append(('startDate', local_var_params['start_date'])) # noqa: E501 if 'end_date' in local_var_params and local_var_params['end_date'] is not None: # noqa: E501 query_params.append(('endDate', local_var_params['end_date'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/domain-monitor/postmaster/domains/{domain}/traffic-stats/sync', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PostmasterTrafficStatsListDto', # 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_domain_monitor_postmaster_connection(self, create_postmaster_connection_options, **kwargs)-
Create Postmaster OAuth connection URL # 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_domain_monitor_postmaster_connection(create_postmaster_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePostmasterConnectionOptions create_postmaster_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: CreatePostmasterConnectionResult If the method is called asynchronously, returns the request thread.
def create_domain_monitor_postmaster_connection_with_http_info(self, create_postmaster_connection_options, **kwargs)-
Create Postmaster OAuth connection URL # 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_domain_monitor_postmaster_connection_with_http_info(create_postmaster_connection_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePostmasterConnectionOptions create_postmaster_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(CreatePostmasterConnectionResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_domain_monitor_postmaster_connection(self, **kwargs)-
Disconnect Postmaster OAuth # 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_domain_monitor_postmaster_connection(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: None If the method is called asynchronously, returns the request thread.
def delete_domain_monitor_postmaster_connection_with_http_info(self, **kwargs)-
Disconnect Postmaster OAuth # 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_domain_monitor_postmaster_connection_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: None If the method is called asynchronously, returns the request thread.
def exchange_domain_monitor_postmaster_code(self, exchange_postmaster_code_options, **kwargs)-
Exchange Postmaster OAuth authorization code # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.exchange_domain_monitor_postmaster_code(exchange_postmaster_code_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ExchangePostmasterCodeOptions exchange_postmaster_code_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: PostmasterConnectionDto If the method is called asynchronously, returns the request thread.
def exchange_domain_monitor_postmaster_code_with_http_info(self, exchange_postmaster_code_options, **kwargs)-
Exchange Postmaster OAuth authorization code # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.exchange_domain_monitor_postmaster_code_with_http_info(exchange_postmaster_code_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ExchangePostmasterCodeOptions exchange_postmaster_code_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(PostmasterConnectionDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_domain_monitor_postmaster_connection(self, **kwargs)-
Get Postmaster connection status # 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_domain_monitor_postmaster_connection(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: PostmasterConnectionStatusDto If the method is called asynchronously, returns the request thread.
def get_domain_monitor_postmaster_connection_with_http_info(self, **kwargs)-
Get Postmaster connection status # 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_domain_monitor_postmaster_connection_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(PostmasterConnectionStatusDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_domain_monitor_postmaster_domains(self, **kwargs)-
List local Postmaster domain snapshots # 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_domain_monitor_postmaster_domains(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[PostmasterDomainDto] If the method is called asynchronously, returns the request thread.
def get_domain_monitor_postmaster_domains_with_http_info(self, **kwargs)-
List local Postmaster domain snapshots # 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_domain_monitor_postmaster_domains_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[PostmasterDomainDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_domain_monitor_postmaster_traffic_stats(self, domain, **kwargs)-
Get local Postmaster traffic stats # 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_domain_monitor_postmaster_traffic_stats(domain, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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: PostmasterTrafficStatsListDto If the method is called asynchronously, returns the request thread.
def get_domain_monitor_postmaster_traffic_stats_with_http_info(self, domain, **kwargs)-
Get local Postmaster traffic stats # 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_domain_monitor_postmaster_traffic_stats_with_http_info(domain, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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(PostmasterTrafficStatsListDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def sync_domain_monitor_postmaster_domains(self, **kwargs)-
Sync Postmaster domains # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sync_domain_monitor_postmaster_domains(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[PostmasterDomainDto] If the method is called asynchronously, returns the request thread.
def sync_domain_monitor_postmaster_domains_with_http_info(self, **kwargs)-
Sync Postmaster domains # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sync_domain_monitor_postmaster_domains_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[PostmasterDomainDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def sync_domain_monitor_postmaster_traffic_stats(self, domain, **kwargs)-
Sync Postmaster traffic stats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sync_domain_monitor_postmaster_traffic_stats(domain, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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: PostmasterTrafficStatsListDto If the method is called asynchronously, returns the request thread.
def sync_domain_monitor_postmaster_traffic_stats_with_http_info(self, domain, **kwargs)-
Sync Postmaster traffic stats # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sync_domain_monitor_postmaster_traffic_stats_with_http_info(domain, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str domain: (required) :param date start_date: :param date end_date: :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(PostmasterTrafficStatsListDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.