Module mailslurp_client.api.campaign_probe_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 CampaignProbeControllerApi (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 CampaignProbeControllerApi(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 compare_campaign_probe_runs(self, probe_id, run_id, other_run_id, **kwargs): # noqa: E501 """Compare two campaign probe runs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.compare_campaign_probe_runs(probe_id, run_id, other_run_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param str other_run_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeRunComparisonDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.compare_campaign_probe_runs_with_http_info(probe_id, run_id, other_run_id, **kwargs) # noqa: E501 def compare_campaign_probe_runs_with_http_info(self, probe_id, run_id, other_run_id, **kwargs): # noqa: E501 """Compare two campaign probe runs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.compare_campaign_probe_runs_with_http_info(probe_id, run_id, other_run_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param str other_run_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CampaignProbeRunComparisonDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', 'run_id', 'other_run_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 compare_campaign_probe_runs" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `compare_campaign_probe_runs`") # noqa: E501 # verify the required parameter 'run_id' is set if self.api_client.client_side_validation and ('run_id' not in local_var_params or # noqa: E501 local_var_params['run_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `run_id` when calling `compare_campaign_probe_runs`") # noqa: E501 # verify the required parameter 'other_run_id' is set if self.api_client.client_side_validation and ('other_run_id' not in local_var_params or # noqa: E501 local_var_params['other_run_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `other_run_id` when calling `compare_campaign_probe_runs`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 if 'run_id' in local_var_params: path_params['runId'] = local_var_params['run_id'] # noqa: E501 if 'other_run_id' in local_var_params: path_params['otherRunId'] = local_var_params['other_run_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( '/campaign-probe/probes/{probeId}/runs/{runId}/compare/{otherRunId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeRunComparisonDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def create_campaign_probe(self, create_campaign_probe_options, **kwargs): # noqa: E501 """Create campaign probe # 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_campaign_probe(create_campaign_probe_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateCampaignProbeOptions create_campaign_probe_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: CampaignProbeDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_campaign_probe_with_http_info(create_campaign_probe_options, **kwargs) # noqa: E501 def create_campaign_probe_with_http_info(self, create_campaign_probe_options, **kwargs): # noqa: E501 """Create campaign probe # 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_campaign_probe_with_http_info(create_campaign_probe_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateCampaignProbeOptions create_campaign_probe_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(CampaignProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_campaign_probe_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_campaign_probe" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_campaign_probe_options' is set if self.api_client.client_side_validation and ('create_campaign_probe_options' not in local_var_params or # noqa: E501 local_var_params['create_campaign_probe_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_campaign_probe_options` when calling `create_campaign_probe`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_campaign_probe_options' in local_var_params: body_params = local_var_params['create_campaign_probe_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( '/campaign-probe/probes', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeDto', # 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_campaign_probe(self, probe_id, **kwargs): # noqa: E501 """Delete campaign probe # 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_campaign_probe(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_campaign_probe_with_http_info(probe_id, **kwargs) # noqa: E501 def delete_campaign_probe_with_http_info(self, probe_id, **kwargs): # noqa: E501 """Delete campaign probe # 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_campaign_probe_with_http_info(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_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_campaign_probe" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `delete_campaign_probe`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_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( '/campaign-probe/probes/{probeId}', '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_campaign_probe(self, probe_id, **kwargs): # noqa: E501 """Get campaign probe # 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_campaign_probe(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_campaign_probe_with_http_info(probe_id, **kwargs) # noqa: E501 def get_campaign_probe_with_http_info(self, probe_id, **kwargs): # noqa: E501 """Get campaign probe # 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_campaign_probe_with_http_info(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CampaignProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_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_campaign_probe" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `get_campaign_probe`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_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( '/campaign-probe/probes/{probeId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeDto', # 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_campaign_probe_insights(self, probe_id, **kwargs): # noqa: E501 """Get campaign probe insights # 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_campaign_probe_insights(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeInsightsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_campaign_probe_insights_with_http_info(probe_id, **kwargs) # noqa: E501 def get_campaign_probe_insights_with_http_info(self, probe_id, **kwargs): # noqa: E501 """Get campaign probe insights # 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_campaign_probe_insights_with_http_info(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :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(CampaignProbeInsightsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', '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_campaign_probe_insights" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `get_campaign_probe_insights`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 query_params = [] if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 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( '/campaign-probe/probes/{probeId}/insights', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeInsightsDto', # 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_campaign_probe_run(self, probe_id, run_id, **kwargs): # noqa: E501 """Get campaign probe run # 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_campaign_probe_run(probe_id, run_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeRunDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_campaign_probe_run_with_http_info(probe_id, run_id, **kwargs) # noqa: E501 def get_campaign_probe_run_with_http_info(self, probe_id, run_id, **kwargs): # noqa: E501 """Get campaign probe run # 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_campaign_probe_run_with_http_info(probe_id, run_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CampaignProbeRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', 'run_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_campaign_probe_run" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `get_campaign_probe_run`") # noqa: E501 # verify the required parameter 'run_id' is set if self.api_client.client_side_validation and ('run_id' not in local_var_params or # noqa: E501 local_var_params['run_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `run_id` when calling `get_campaign_probe_run`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 if 'run_id' in local_var_params: path_params['runId'] = local_var_params['run_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( '/campaign-probe/probes/{probeId}/runs/{runId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeRunDto', # 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_campaign_probe_runs(self, probe_id, **kwargs): # noqa: E501 """List campaign probe runs # 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_campaign_probe_runs(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str status: :param int limit: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[CampaignProbeRunDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_campaign_probe_runs_with_http_info(probe_id, **kwargs) # noqa: E501 def get_campaign_probe_runs_with_http_info(self, probe_id, **kwargs): # noqa: E501 """List campaign probe runs # 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_campaign_probe_runs_with_http_info(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str status: :param int limit: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[CampaignProbeRunDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', 'since', 'before', 'status', 'limit' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_campaign_probe_runs" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `get_campaign_probe_runs`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 query_params = [] if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'status' in local_var_params and local_var_params['status'] is not None: # noqa: E501 query_params.append(('status', local_var_params['status'])) # noqa: E501 if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 query_params.append(('limit', local_var_params['limit'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/campaign-probe/probes/{probeId}/runs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[CampaignProbeRunDto]', # 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_campaign_probe_series(self, probe_id, **kwargs): # noqa: E501 """Get campaign probe trend series # 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_campaign_probe_series(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str bucket: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeSeriesDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_campaign_probe_series_with_http_info(probe_id, **kwargs) # noqa: E501 def get_campaign_probe_series_with_http_info(self, probe_id, **kwargs): # noqa: E501 """Get campaign probe trend series # 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_campaign_probe_series_with_http_info(probe_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str bucket: :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(CampaignProbeSeriesDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', 'since', 'before', 'bucket' ] 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_campaign_probe_series" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `get_campaign_probe_series`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 query_params = [] if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'bucket' in local_var_params and local_var_params['bucket'] is not None: # noqa: E501 query_params.append(('bucket', local_var_params['bucket'])) # noqa: E501 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( '/campaign-probe/probes/{probeId}/series', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeSeriesDto', # 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_campaign_probes(self, **kwargs): # noqa: E501 """List campaign probes # 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_campaign_probes(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[CampaignProbeDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_campaign_probes_with_http_info(**kwargs) # noqa: E501 def get_campaign_probes_with_http_info(self, **kwargs): # noqa: E501 """List campaign probes # 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_campaign_probes_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[CampaignProbeDto], 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_campaign_probes" % 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( '/campaign-probe/probes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[CampaignProbeDto]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def run_campaign_probe_now(self, probe_id, create_campaign_probe_run_options, **kwargs): # noqa: E501 """Run campaign probe now # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.run_campaign_probe_now(probe_id, create_campaign_probe_run_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param CreateCampaignProbeRunOptions create_campaign_probe_run_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: CampaignProbeRunNowResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.run_campaign_probe_now_with_http_info(probe_id, create_campaign_probe_run_options, **kwargs) # noqa: E501 def run_campaign_probe_now_with_http_info(self, probe_id, create_campaign_probe_run_options, **kwargs): # noqa: E501 """Run campaign probe now # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.run_campaign_probe_now_with_http_info(probe_id, create_campaign_probe_run_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param CreateCampaignProbeRunOptions create_campaign_probe_run_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(CampaignProbeRunNowResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', 'create_campaign_probe_run_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 run_campaign_probe_now" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `run_campaign_probe_now`") # noqa: E501 # verify the required parameter 'create_campaign_probe_run_options' is set if self.api_client.client_side_validation and ('create_campaign_probe_run_options' not in local_var_params or # noqa: E501 local_var_params['create_campaign_probe_run_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_campaign_probe_run_options` when calling `run_campaign_probe_now`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_campaign_probe_run_options' in local_var_params: body_params = local_var_params['create_campaign_probe_run_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( '/campaign-probe/probes/{probeId}/run-now', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeRunNowResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def run_due_campaign_probes(self, **kwargs): # noqa: E501 """Run due campaign probes for user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.run_due_campaign_probes(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int max_runs: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeRunDueResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.run_due_campaign_probes_with_http_info(**kwargs) # noqa: E501 def run_due_campaign_probes_with_http_info(self, **kwargs): # noqa: E501 """Run due campaign probes for user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.run_due_campaign_probes_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int max_runs: :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(CampaignProbeRunDueResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'max_runs' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method run_due_campaign_probes" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'max_runs' in local_var_params and local_var_params['max_runs'] is not None: # noqa: E501 query_params.append(('maxRuns', local_var_params['max_runs'])) # 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( '/campaign-probe/probes/run-due', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeRunDueResult', # 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_campaign_probe(self, probe_id, update_campaign_probe_options, **kwargs): # noqa: E501 """Update campaign probe # 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_campaign_probe(probe_id, update_campaign_probe_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param UpdateCampaignProbeOptions update_campaign_probe_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: CampaignProbeDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_campaign_probe_with_http_info(probe_id, update_campaign_probe_options, **kwargs) # noqa: E501 def update_campaign_probe_with_http_info(self, probe_id, update_campaign_probe_options, **kwargs): # noqa: E501 """Update campaign probe # 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_campaign_probe_with_http_info(probe_id, update_campaign_probe_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str probe_id: (required) :param UpdateCampaignProbeOptions update_campaign_probe_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(CampaignProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'probe_id', 'update_campaign_probe_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_campaign_probe" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'probe_id' is set if self.api_client.client_side_validation and ('probe_id' not in local_var_params or # noqa: E501 local_var_params['probe_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `probe_id` when calling `update_campaign_probe`") # noqa: E501 # verify the required parameter 'update_campaign_probe_options' is set if self.api_client.client_side_validation and ('update_campaign_probe_options' not in local_var_params or # noqa: E501 local_var_params['update_campaign_probe_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_campaign_probe_options` when calling `update_campaign_probe`") # noqa: E501 collection_formats = {} path_params = {} if 'probe_id' in local_var_params: path_params['probeId'] = local_var_params['probe_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_campaign_probe_options' in local_var_params: body_params = local_var_params['update_campaign_probe_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( '/campaign-probe/probes/{probeId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CampaignProbeDto', # 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 compare_campaign_probe_runs(self, probe_id, run_id, other_run_id, **kwargs)-
Compare two campaign probe runs # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.compare_campaign_probe_runs(probe_id, run_id, other_run_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param str other_run_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeRunComparisonDto If the method is called asynchronously, returns the request thread.
def compare_campaign_probe_runs_with_http_info(self, probe_id, run_id, other_run_id, **kwargs)-
Compare two campaign probe runs # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.compare_campaign_probe_runs_with_http_info(probe_id, run_id, other_run_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param str other_run_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CampaignProbeRunComparisonDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_campaign_probe(self, create_campaign_probe_options, **kwargs)-
Create campaign probe # 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_campaign_probe(create_campaign_probe_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateCampaignProbeOptions create_campaign_probe_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: CampaignProbeDto If the method is called asynchronously, returns the request thread.
def create_campaign_probe_with_http_info(self, create_campaign_probe_options, **kwargs)-
Create campaign probe # 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_campaign_probe_with_http_info(create_campaign_probe_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateCampaignProbeOptions create_campaign_probe_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(CampaignProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_campaign_probe(self, probe_id, **kwargs)-
Delete campaign probe # 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_campaign_probe(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def delete_campaign_probe_with_http_info(self, probe_id, **kwargs)-
Delete campaign probe # 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_campaign_probe_with_http_info(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
def get_campaign_probe(self, probe_id, **kwargs)-
Get campaign probe # 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_campaign_probe(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeDto If the method is called asynchronously, returns the request thread.
def get_campaign_probe_insights(self, probe_id, **kwargs)-
Get campaign probe insights # 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_campaign_probe_insights(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeInsightsDto If the method is called asynchronously, returns the request thread.
def get_campaign_probe_insights_with_http_info(self, probe_id, **kwargs)-
Get campaign probe insights # 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_campaign_probe_insights_with_http_info(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :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(CampaignProbeInsightsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_campaign_probe_run(self, probe_id, run_id, **kwargs)-
Get campaign probe run # 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_campaign_probe_run(probe_id, run_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeRunDto If the method is called asynchronously, returns the request thread.
def get_campaign_probe_run_with_http_info(self, probe_id, run_id, **kwargs)-
Get campaign probe run # 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_campaign_probe_run_with_http_info(probe_id, run_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param str run_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CampaignProbeRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_campaign_probe_runs(self, probe_id, **kwargs)-
List campaign probe runs # 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_campaign_probe_runs(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str status: :param int limit: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[CampaignProbeRunDto] If the method is called asynchronously, returns the request thread.
def get_campaign_probe_runs_with_http_info(self, probe_id, **kwargs)-
List campaign probe runs # 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_campaign_probe_runs_with_http_info(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str status: :param int limit: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[CampaignProbeRunDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_campaign_probe_series(self, probe_id, **kwargs)-
Get campaign probe trend series # 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_campaign_probe_series(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str bucket: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeSeriesDto If the method is called asynchronously, returns the request thread.
def get_campaign_probe_series_with_http_info(self, probe_id, **kwargs)-
Get campaign probe trend series # 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_campaign_probe_series_with_http_info(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param datetime since: :param datetime before: :param str bucket: :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(CampaignProbeSeriesDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_campaign_probe_with_http_info(self, probe_id, **kwargs)-
Get campaign probe # 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_campaign_probe_with_http_info(probe_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CampaignProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_campaign_probes(self, **kwargs)-
List campaign probes # 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_campaign_probes(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[CampaignProbeDto] If the method is called asynchronously, returns the request thread.
def get_campaign_probes_with_http_info(self, **kwargs)-
List campaign probes # 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_campaign_probes_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[CampaignProbeDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def run_campaign_probe_now(self, probe_id, create_campaign_probe_run_options, **kwargs)-
Run campaign probe now # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_campaign_probe_now(probe_id, create_campaign_probe_run_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param CreateCampaignProbeRunOptions create_campaign_probe_run_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: CampaignProbeRunNowResult If the method is called asynchronously, returns the request thread.
def run_campaign_probe_now_with_http_info(self, probe_id, create_campaign_probe_run_options, **kwargs)-
Run campaign probe now # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_campaign_probe_now_with_http_info(probe_id, create_campaign_probe_run_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param CreateCampaignProbeRunOptions create_campaign_probe_run_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(CampaignProbeRunNowResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def run_due_campaign_probes(self, **kwargs)-
Run due campaign probes for user # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_due_campaign_probes(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int max_runs: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: CampaignProbeRunDueResult If the method is called asynchronously, returns the request thread.
def run_due_campaign_probes_with_http_info(self, **kwargs)-
Run due campaign probes for user # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_due_campaign_probes_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int max_runs: :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(CampaignProbeRunDueResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_campaign_probe(self, probe_id, update_campaign_probe_options, **kwargs)-
Update campaign probe # 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_campaign_probe(probe_id, update_campaign_probe_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param UpdateCampaignProbeOptions update_campaign_probe_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: CampaignProbeDto If the method is called asynchronously, returns the request thread.
def update_campaign_probe_with_http_info(self, probe_id, update_campaign_probe_options, **kwargs)-
Update campaign probe # 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_campaign_probe_with_http_info(probe_id, update_campaign_probe_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str probe_id: (required) :param UpdateCampaignProbeOptions update_campaign_probe_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(CampaignProbeDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.