Module mailslurp_client.api.tracking_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 TrackingControllerApi (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 TrackingControllerApi(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_tracking_pixel(self, create_tracking_pixel_options, **kwargs): # noqa: E501 """Create tracking pixel # noqa: E501 Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. # 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_tracking_pixel(create_tracking_pixel_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateTrackingPixelOptions create_tracking_pixel_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: TrackingPixelDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_tracking_pixel_with_http_info(create_tracking_pixel_options, **kwargs) # noqa: E501 def create_tracking_pixel_with_http_info(self, create_tracking_pixel_options, **kwargs): # noqa: E501 """Create tracking pixel # noqa: E501 Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. # 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_tracking_pixel_with_http_info(create_tracking_pixel_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateTrackingPixelOptions create_tracking_pixel_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(TrackingPixelDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_tracking_pixel_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_tracking_pixel" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_tracking_pixel_options' is set if self.api_client.client_side_validation and ('create_tracking_pixel_options' not in local_var_params or # noqa: E501 local_var_params['create_tracking_pixel_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_tracking_pixel_options` when calling `create_tracking_pixel`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_tracking_pixel_options' in local_var_params: body_params = local_var_params['create_tracking_pixel_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( '/tracking/pixels', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TrackingPixelDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_all_tracking_pixels(self, **kwargs): # noqa: E501 """Get tracking pixels # noqa: E501 List tracking pixels in paginated form # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_tracking_pixels(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageTrackingPixelProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_tracking_pixels_with_http_info(**kwargs) # noqa: E501 def get_all_tracking_pixels_with_http_info(self, **kwargs): # noqa: E501 """Get tracking pixels # noqa: E501 List tracking pixels in paginated form # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_tracking_pixels_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageTrackingPixelProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'search_filter', '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_all_tracking_pixels" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'search_filter' in local_var_params and local_var_params['search_filter'] is not None: # noqa: E501 query_params.append(('searchFilter', local_var_params['search_filter'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tracking/pixels', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageTrackingPixelProjection', # 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_tracking_pixel(self, id, **kwargs): # noqa: E501 """Get pixel # 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_tracking_pixel(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str 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: TrackingPixelDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_tracking_pixel_with_http_info(id, **kwargs) # noqa: E501 def get_tracking_pixel_with_http_info(self, id, **kwargs): # noqa: E501 """Get pixel # 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_tracking_pixel_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str 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(TrackingPixelDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_tracking_pixel" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_tracking_pixel`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/tracking/pixels/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TrackingPixelDto', # 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_tracking_pixel(self, create_tracking_pixel_options, **kwargs)-
Create tracking pixel # noqa: E501
Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. # 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_tracking_pixel(create_tracking_pixel_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateTrackingPixelOptions create_tracking_pixel_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: TrackingPixelDto If the method is called asynchronously, returns the request thread.
def create_tracking_pixel_with_http_info(self, create_tracking_pixel_options, **kwargs)-
Create tracking pixel # noqa: E501
Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. # 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_tracking_pixel_with_http_info(create_tracking_pixel_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateTrackingPixelOptions create_tracking_pixel_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(TrackingPixelDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_all_tracking_pixels(self, **kwargs)-
Get tracking pixels # noqa: E501
List tracking pixels in paginated form # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_tracking_pixels(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageTrackingPixelProjection If the method is called asynchronously, returns the request thread.
def get_all_tracking_pixels_with_http_info(self, **kwargs)-
Get tracking pixels # noqa: E501
List tracking pixels in paginated form # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_tracking_pixels_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param str search_filter: Optional search filter :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PageTrackingPixelProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_tracking_pixel(self, id, **kwargs)-
Get pixel # 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_tracking_pixel(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str 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: TrackingPixelDto If the method is called asynchronously, returns the request thread.
def get_tracking_pixel_with_http_info(self, id, **kwargs)-
Get pixel # 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_tracking_pixel_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str 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(TrackingPixelDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.