Class TrackingControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

TrackingControllerApi

Implements

ITrackingControllerApi

ITrackingControllerApiSync

ITrackingControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class TrackingControllerApi : ITrackingControllerApi, ITrackingControllerApiSync, ITrackingControllerApiAsync, IApiAccessor

Constructors

TrackingControllerApi()

Initializes a new instance of the TrackingControllerApi class.

Declaration

public TrackingControllerApi()

TrackingControllerApi(string)

Initializes a new instance of the TrackingControllerApi class.

Declaration

public TrackingControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

TrackingControllerApi(Configuration)

Initializes a new instance of the TrackingControllerApi class using Configuration object

Declaration

public TrackingControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

TrackingControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the TrackingControllerApi class using a Configuration object and client instance.

Declaration

public TrackingControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

CreateTrackingPixel(CreateTrackingPixelOptions, int)

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.

Declaration

public TrackingPixelDto CreateTrackingPixel(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateTrackingPixelOptions	createTrackingPixelOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
TrackingPixelDto	TrackingPixelDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTrackingPixelAsync(CreateTrackingPixelOptions, int, CancellationToken)

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.

Declaration

public Task<TrackingPixelDto> CreateTrackingPixelAsync(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateTrackingPixelOptions	createTrackingPixelOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<TrackingPixelDto>	Task of TrackingPixelDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTrackingPixelWithHttpInfo(CreateTrackingPixelOptions, int)

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.

Declaration

public ApiResponse<TrackingPixelDto> CreateTrackingPixelWithHttpInfo(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateTrackingPixelOptions	createTrackingPixelOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<TrackingPixelDto>	ApiResponse of TrackingPixelDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTrackingPixelWithHttpInfoAsync(CreateTrackingPixelOptions, int, CancellationToken)

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.

Declaration

public Task<ApiResponse<TrackingPixelDto>> CreateTrackingPixelWithHttpInfoAsync(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateTrackingPixelOptions	createTrackingPixelOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<TrackingPixelDto>>	Task of ApiResponse (TrackingPixelDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllTrackingPixels(int?, int?, string, string, DateTime?, DateTime?, int)

Get tracking pixels List tracking pixels in paginated form

Declaration

public PageTrackingPixelProjection GetAllTrackingPixels(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageTrackingPixelProjection	PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllTrackingPixelsAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get tracking pixels List tracking pixels in paginated form

Declaration

public Task<PageTrackingPixelProjection> GetAllTrackingPixelsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageTrackingPixelProjection>	Task of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllTrackingPixelsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)

Get tracking pixels List tracking pixels in paginated form

Declaration

public ApiResponse<PageTrackingPixelProjection> GetAllTrackingPixelsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageTrackingPixelProjection>	ApiResponse of PageTrackingPixelProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllTrackingPixelsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get tracking pixels List tracking pixels in paginated form

Declaration

public Task<ApiResponse<PageTrackingPixelProjection>> GetAllTrackingPixelsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageTrackingPixelProjection>>	Task of ApiResponse (PageTrackingPixelProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetTrackingPixel(Guid, int)

Get pixel

Declaration

public TrackingPixelDto GetTrackingPixel(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
TrackingPixelDto	TrackingPixelDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTrackingPixelAsync(Guid, int, CancellationToken)

Get pixel

Declaration

public Task<TrackingPixelDto> GetTrackingPixelAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<TrackingPixelDto>	Task of TrackingPixelDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTrackingPixelWithHttpInfo(Guid, int)

Get pixel

Declaration

public ApiResponse<TrackingPixelDto> GetTrackingPixelWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<TrackingPixelDto>	ApiResponse of TrackingPixelDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTrackingPixelWithHttpInfoAsync(Guid, int, CancellationToken)

Get pixel

Declaration

public Task<ApiResponse<TrackingPixelDto>> GetTrackingPixelWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<TrackingPixelDto>>	Task of ApiResponse (TrackingPixelDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

ITrackingControllerApi

ITrackingControllerApiSync

ITrackingControllerApiAsync

IApiAccessor