com.mailslurp.apis

Class TrackingControllerApi

java.lang.Object

com.mailslurp.apis.TrackingControllerApi

public class TrackingControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TrackingControllerApi()
TrackingControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TrackingPixelDto	createTrackingPixel(CreateTrackingPixelOptions createTrackingPixelOptions) Create tracking pixel Create a tracking pixel.
okhttp3.Call	createTrackingPixelAsync(CreateTrackingPixelOptions createTrackingPixelOptions, ApiCallback<TrackingPixelDto> _callback) Create tracking pixel (asynchronously) Create a tracking pixel.
okhttp3.Call	createTrackingPixelCall(CreateTrackingPixelOptions createTrackingPixelOptions, ApiCallback _callback) Build call for createTrackingPixel
ApiResponse<TrackingPixelDto>	createTrackingPixelWithHttpInfo(CreateTrackingPixelOptions createTrackingPixelOptions) Create tracking pixel Create a tracking pixel.
PageTrackingPixelProjection	getAllTrackingPixels(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get tracking pixels List tracking pixels in paginated form
okhttp3.Call	getAllTrackingPixelsAsync(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageTrackingPixelProjection> _callback) Get tracking pixels (asynchronously) List tracking pixels in paginated form
okhttp3.Call	getAllTrackingPixelsCall(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getAllTrackingPixels
ApiResponse<PageTrackingPixelProjection>	getAllTrackingPixelsWithHttpInfo(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get tracking pixels List tracking pixels in paginated form
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
TrackingPixelDto	getTrackingPixel(UUID id) Get pixel
okhttp3.Call	getTrackingPixelAsync(UUID id, ApiCallback<TrackingPixelDto> _callback) Get pixel (asynchronously)
okhttp3.Call	getTrackingPixelCall(UUID id, ApiCallback _callback) Build call for getTrackingPixel
ApiResponse<TrackingPixelDto>	getTrackingPixelWithHttpInfo(UUID id) Get pixel
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrackingControllerApi

public TrackingControllerApi()

TrackingControllerApi

public TrackingControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createTrackingPixelCall

public okhttp3.Call createTrackingPixelCall(CreateTrackingPixelOptions createTrackingPixelOptions,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for createTrackingPixel

Parameters:

createTrackingPixelOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

createTrackingPixel

public TrackingPixelDto createTrackingPixel(CreateTrackingPixelOptions createTrackingPixelOptions)
                                     throws ApiException

Create tracking pixel 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.

Parameters:

createTrackingPixelOptions - (required)

Returns:

TrackingPixelDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

createTrackingPixelWithHttpInfo

public ApiResponse<TrackingPixelDto> createTrackingPixelWithHttpInfo(CreateTrackingPixelOptions createTrackingPixelOptions)
                                                              throws ApiException

Create tracking pixel 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.

Parameters:

createTrackingPixelOptions - (required)

Returns:

ApiResponse<TrackingPixelDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

createTrackingPixelAsync

public okhttp3.Call createTrackingPixelAsync(CreateTrackingPixelOptions createTrackingPixelOptions,
                                             ApiCallback<TrackingPixelDto> _callback)
                                      throws ApiException

Create tracking pixel (asynchronously) 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.

Parameters:

createTrackingPixelOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-

getAllTrackingPixelsCall

public okhttp3.Call getAllTrackingPixelsCall(Integer page,
                                             Integer size,
                                             String sort,
                                             String searchFilter,
                                             OffsetDateTime since,
                                             OffsetDateTime before,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getAllTrackingPixels

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllTrackingPixels

public PageTrackingPixelProjection getAllTrackingPixels(Integer page,
                                                        Integer size,
                                                        String sort,
                                                        String searchFilter,
                                                        OffsetDateTime since,
                                                        OffsetDateTime before)
                                                 throws ApiException

Get tracking pixels List tracking pixels in paginated form

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageTrackingPixelProjection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllTrackingPixelsWithHttpInfo

public ApiResponse<PageTrackingPixelProjection> getAllTrackingPixelsWithHttpInfo(Integer page,
                                                                                 Integer size,
                                                                                 String sort,
                                                                                 String searchFilter,
                                                                                 OffsetDateTime since,
                                                                                 OffsetDateTime before)
                                                                          throws ApiException

Get tracking pixels List tracking pixels in paginated form

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageTrackingPixelProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllTrackingPixelsAsync

public okhttp3.Call getAllTrackingPixelsAsync(Integer page,
                                              Integer size,
                                              String sort,
                                              String searchFilter,
                                              OffsetDateTime since,
                                              OffsetDateTime before,
                                              ApiCallback<PageTrackingPixelProjection> _callback)
                                       throws ApiException

Get tracking pixels (asynchronously) List tracking pixels in paginated form

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getTrackingPixelCall

public okhttp3.Call getTrackingPixelCall(UUID id,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getTrackingPixel

Parameters:

id - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getTrackingPixel

public TrackingPixelDto getTrackingPixel(UUID id)
                                  throws ApiException

Get pixel

Parameters:

id - (required)

Returns:

TrackingPixelDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getTrackingPixelWithHttpInfo

public ApiResponse<TrackingPixelDto> getTrackingPixelWithHttpInfo(UUID id)
                                                           throws ApiException

Get pixel

Parameters:

id - (required)

Returns:

ApiResponse<TrackingPixelDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getTrackingPixelAsync

public okhttp3.Call getTrackingPixelAsync(UUID id,
                                          ApiCallback<TrackingPixelDto> _callback)
                                   throws ApiException

Get pixel (asynchronously)

Parameters:

id - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-