Class ConsentControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

ConsentControllerApi

Implements

IConsentControllerApi

IConsentControllerApiSync

IConsentControllerApiAsync

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 ConsentControllerApi : IConsentControllerApi, IConsentControllerApiSync, IConsentControllerApiAsync, IApiAccessor

Constructors

View Source

ConsentControllerApi()

Initializes a new instance of the ConsentControllerApi class.

Declaration

public ConsentControllerApi()

View Source

ConsentControllerApi(string)

Initializes a new instance of the ConsentControllerApi class.

Declaration

public ConsentControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

ConsentControllerApi(Configuration)

Initializes a new instance of the ConsentControllerApi class using Configuration object

Declaration

public ConsentControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

ConsentControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

public ConsentControllerApi(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

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

CheckSendingConsentForEmailAddress(string, int)

Declaration

public OptInSendingConsentDto CheckSendingConsentForEmailAddress(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address to check consent for
int	operationIndex	Index associated with the operation.

Returns

Type	Description
OptInSendingConsentDto	OptInSendingConsentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckSendingConsentForEmailAddressAsync(string, int, CancellationToken)

Declaration

public Task<OptInSendingConsentDto> CheckSendingConsentForEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address to check consent for
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<OptInSendingConsentDto>	Task of OptInSendingConsentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckSendingConsentForEmailAddressWithHttpInfo(string, int)

Declaration

public ApiResponse<OptInSendingConsentDto> CheckSendingConsentForEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address to check consent for
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<OptInSendingConsentDto>	ApiResponse of OptInSendingConsentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckSendingConsentForEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Declaration

public Task<ApiResponse<OptInSendingConsentDto>> CheckSendingConsentForEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address to check consent for
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetOptInIdentities(int?, int?, string, int)

Declaration

public PageOptInIdentityProjection GetOptInIdentities(int? page = null, int? size = null, string sort = 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)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageOptInIdentityProjection	PageOptInIdentityProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetOptInIdentitiesAsync(int?, int?, string, int, CancellationToken)

Declaration

public Task<PageOptInIdentityProjection> GetOptInIdentitiesAsync(int? page = null, int? size = null, string sort = 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)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageOptInIdentityProjection>	Task of PageOptInIdentityProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetOptInIdentitiesWithHttpInfo(int?, int?, string, int)

Declaration

public ApiResponse<PageOptInIdentityProjection> GetOptInIdentitiesWithHttpInfo(int? page = null, int? size = null, string sort = 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)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageOptInIdentityProjection>	ApiResponse of PageOptInIdentityProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetOptInIdentitiesWithHttpInfoAsync(int?, int?, string, int, CancellationToken)

Declaration

public Task<ApiResponse<PageOptInIdentityProjection>> GetOptInIdentitiesWithHttpInfoAsync(int? page = null, int? size = null, string sort = 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)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RevokeOptInConsentForEmailAddress(string, int)

Declaration

public OptInSendingConsentDto RevokeOptInConsentForEmailAddress(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address to revoke consent for
int	operationIndex	Index associated with the operation.

Returns

Type	Description
OptInSendingConsentDto	OptInSendingConsentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RevokeOptInConsentForEmailAddressAsync(string, int, CancellationToken)

Declaration

public Task<OptInSendingConsentDto> RevokeOptInConsentForEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address to revoke consent for
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<OptInSendingConsentDto>	Task of OptInSendingConsentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RevokeOptInConsentForEmailAddressWithHttpInfo(string, int)

Declaration

public ApiResponse<OptInSendingConsentDto> RevokeOptInConsentForEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address to revoke consent for
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<OptInSendingConsentDto>	ApiResponse of OptInSendingConsentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RevokeOptInConsentForEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Declaration

public Task<ApiResponse<OptInSendingConsentDto>> RevokeOptInConsentForEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address to revoke consent for
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendOptInConsentForEmailAddress(OptInConsentOptions, int)

Send a verification code to a user once they have explicitly submitted their email address Send double-opt in consent for an email address

Declaration

public OptInConsentSendResult SendOptInConsentForEmailAddress(OptInConsentOptions optInConsentOptions, int operationIndex = 0)

Parameters

Type	Name	Description
OptInConsentOptions	optInConsentOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
OptInConsentSendResult	OptInConsentSendResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendOptInConsentForEmailAddressAsync(OptInConsentOptions, int, CancellationToken)

Send a verification code to a user once they have explicitly submitted their email address Send double-opt in consent for an email address

Declaration

public Task<OptInConsentSendResult> SendOptInConsentForEmailAddressAsync(OptInConsentOptions optInConsentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<OptInConsentSendResult>	Task of OptInConsentSendResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendOptInConsentForEmailAddressWithHttpInfo(OptInConsentOptions, int)

Send a verification code to a user once they have explicitly submitted their email address Send double-opt in consent for an email address

Declaration

public ApiResponse<OptInConsentSendResult> SendOptInConsentForEmailAddressWithHttpInfo(OptInConsentOptions optInConsentOptions, int operationIndex = 0)

Parameters

Type	Name	Description
OptInConsentOptions	optInConsentOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<OptInConsentSendResult>	ApiResponse of OptInConsentSendResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendOptInConsentForEmailAddressWithHttpInfoAsync(OptInConsentOptions, int, CancellationToken)

Send a verification code to a user once they have explicitly submitted their email address Send double-opt in consent for an email address

Declaration

public Task<ApiResponse<OptInConsentSendResult>> SendOptInConsentForEmailAddressWithHttpInfoAsync(OptInConsentOptions optInConsentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IConsentControllerApi

IConsentControllerApiSync

IConsentControllerApiAsync

IApiAccessor