Interface IConsentControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IConsentControllerApiSync : IApiAccessorMethods
View SourceCheckSendingConsentForEmailAddress(string, int)
Declaration
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 |
CheckSendingConsentForEmailAddressWithHttpInfo(string, int)
Declaration
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 |
GetOptInIdentities(int?, int?, string, int)
Declaration
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 |
GetOptInIdentitiesWithHttpInfo(int?, int?, string, int)
Declaration
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 |
RevokeOptInConsentForEmailAddress(string, int)
Declaration
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 |
RevokeOptInConsentForEmailAddressWithHttpInfo(string, int)
Declaration
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 |
SendOptInConsentForEmailAddress(OptInConsentOptions, int)
Send a verification code to a user once they have explicitly submitted their email address
Declaration
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 |
Remarks
Send double-opt in consent for an email address
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SendOptInConsentForEmailAddressWithHttpInfo(OptInConsentOptions, int)
Send a verification code to a user once they have explicitly submitted their email address
Declaration
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 |
Remarks
Send double-opt in consent for an email address
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |