ConsentControllerApi
in package
ConsentControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['checkSendingConsentForEmailAddress' => ['application/json'], 'getOptInIdentities' => ['application/json'], 'revokeOptInConsentForEmailAddress' => ['application/json'], 'sendOptInConsentForEmailAddress' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- checkSendingConsentForEmailAddress() : OptInSendingConsentDto
- Operation checkSendingConsentForEmailAddress
- checkSendingConsentForEmailAddressAsync() : PromiseInterface
- Operation checkSendingConsentForEmailAddressAsync
- checkSendingConsentForEmailAddressAsyncWithHttpInfo() : PromiseInterface
- Operation checkSendingConsentForEmailAddressAsyncWithHttpInfo
- checkSendingConsentForEmailAddressRequest() : Request
- Create request for operation 'checkSendingConsentForEmailAddress'
- checkSendingConsentForEmailAddressWithHttpInfo() : array<string|int, mixed>
- Operation checkSendingConsentForEmailAddressWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getOptInIdentities() : PageOptInIdentityProjection
- Operation getOptInIdentities
- getOptInIdentitiesAsync() : PromiseInterface
- Operation getOptInIdentitiesAsync
- getOptInIdentitiesAsyncWithHttpInfo() : PromiseInterface
- Operation getOptInIdentitiesAsyncWithHttpInfo
- getOptInIdentitiesRequest() : Request
- Create request for operation 'getOptInIdentities'
- getOptInIdentitiesWithHttpInfo() : array<string|int, mixed>
- Operation getOptInIdentitiesWithHttpInfo
- revokeOptInConsentForEmailAddress() : OptInSendingConsentDto
- Operation revokeOptInConsentForEmailAddress
- revokeOptInConsentForEmailAddressAsync() : PromiseInterface
- Operation revokeOptInConsentForEmailAddressAsync
- revokeOptInConsentForEmailAddressAsyncWithHttpInfo() : PromiseInterface
- Operation revokeOptInConsentForEmailAddressAsyncWithHttpInfo
- revokeOptInConsentForEmailAddressRequest() : Request
- Create request for operation 'revokeOptInConsentForEmailAddress'
- revokeOptInConsentForEmailAddressWithHttpInfo() : array<string|int, mixed>
- Operation revokeOptInConsentForEmailAddressWithHttpInfo
- sendOptInConsentForEmailAddress() : OptInConsentSendResult
- Operation sendOptInConsentForEmailAddress
- sendOptInConsentForEmailAddressAsync() : PromiseInterface
- Operation sendOptInConsentForEmailAddressAsync
- sendOptInConsentForEmailAddressAsyncWithHttpInfo() : PromiseInterface
- Operation sendOptInConsentForEmailAddressAsyncWithHttpInfo
- sendOptInConsentForEmailAddressRequest() : Request
- Create request for operation 'sendOptInConsentForEmailAddress'
- sendOptInConsentForEmailAddressWithHttpInfo() : array<string|int, mixed>
- Operation sendOptInConsentForEmailAddressWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['checkSendingConsentForEmailAddress' => ['application/json'], 'getOptInIdentities' => ['application/json'], 'revokeOptInConsentForEmailAddress' => ['application/json'], 'sendOptInConsentForEmailAddress' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —checkSendingConsentForEmailAddress()
Operation checkSendingConsentForEmailAddress
public
checkSendingConsentForEmailAddress(string $email_address[, string $contentType = self::contentTypes['checkSendingConsentForEmailAddress'][0] ]) : OptInSendingConsentDto
Parameters
- $email_address : string
-
Email address to check consent for (required)
- $contentType : string = self::contentTypes['checkSendingConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['checkSendingConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
OptInSendingConsentDto —checkSendingConsentForEmailAddressAsync()
Operation checkSendingConsentForEmailAddressAsync
public
checkSendingConsentForEmailAddressAsync(string $email_address[, string $contentType = self::contentTypes['checkSendingConsentForEmailAddress'][0] ]) : PromiseInterface
Parameters
- $email_address : string
-
Email address to check consent for (required)
- $contentType : string = self::contentTypes['checkSendingConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['checkSendingConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —checkSendingConsentForEmailAddressAsyncWithHttpInfo()
Operation checkSendingConsentForEmailAddressAsyncWithHttpInfo
public
checkSendingConsentForEmailAddressAsyncWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['checkSendingConsentForEmailAddress'][0] ]) : PromiseInterface
Parameters
- $email_address : string
-
Email address to check consent for (required)
- $contentType : string = self::contentTypes['checkSendingConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['checkSendingConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —checkSendingConsentForEmailAddressRequest()
Create request for operation 'checkSendingConsentForEmailAddress'
public
checkSendingConsentForEmailAddressRequest(string $email_address[, string $contentType = self::contentTypes['checkSendingConsentForEmailAddress'][0] ]) : Request
Parameters
- $email_address : string
-
Email address to check consent for (required)
- $contentType : string = self::contentTypes['checkSendingConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['checkSendingConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
Request —checkSendingConsentForEmailAddressWithHttpInfo()
Operation checkSendingConsentForEmailAddressWithHttpInfo
public
checkSendingConsentForEmailAddressWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['checkSendingConsentForEmailAddress'][0] ]) : array<string|int, mixed>
Parameters
- $email_address : string
-
Email address to check consent for (required)
- $contentType : string = self::contentTypes['checkSendingConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['checkSendingConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\OptInSendingConsentDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getOptInIdentities()
Operation getOptInIdentities
public
getOptInIdentities(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getOptInIdentities'][0] ]) : PageOptInIdentityProjection
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getOptInIdentities'][0]
-
The value for the Content-Type header. Check self::contentTypes['getOptInIdentities'] to see the possible values for this operation
Tags
Return values
PageOptInIdentityProjection —getOptInIdentitiesAsync()
Operation getOptInIdentitiesAsync
public
getOptInIdentitiesAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getOptInIdentities'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getOptInIdentities'][0]
-
The value for the Content-Type header. Check self::contentTypes['getOptInIdentities'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getOptInIdentitiesAsyncWithHttpInfo()
Operation getOptInIdentitiesAsyncWithHttpInfo
public
getOptInIdentitiesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getOptInIdentities'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getOptInIdentities'][0]
-
The value for the Content-Type header. Check self::contentTypes['getOptInIdentities'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getOptInIdentitiesRequest()
Create request for operation 'getOptInIdentities'
public
getOptInIdentitiesRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getOptInIdentities'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getOptInIdentities'][0]
-
The value for the Content-Type header. Check self::contentTypes['getOptInIdentities'] to see the possible values for this operation
Tags
Return values
Request —getOptInIdentitiesWithHttpInfo()
Operation getOptInIdentitiesWithHttpInfo
public
getOptInIdentitiesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getOptInIdentities'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getOptInIdentities'][0]
-
The value for the Content-Type header. Check self::contentTypes['getOptInIdentities'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageOptInIdentityProjection, HTTP status code, HTTP response headers (array of strings)
revokeOptInConsentForEmailAddress()
Operation revokeOptInConsentForEmailAddress
public
revokeOptInConsentForEmailAddress(string $email_address[, string $contentType = self::contentTypes['revokeOptInConsentForEmailAddress'][0] ]) : OptInSendingConsentDto
Parameters
- $email_address : string
-
Email address to revoke consent for (required)
- $contentType : string = self::contentTypes['revokeOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['revokeOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
OptInSendingConsentDto —revokeOptInConsentForEmailAddressAsync()
Operation revokeOptInConsentForEmailAddressAsync
public
revokeOptInConsentForEmailAddressAsync(string $email_address[, string $contentType = self::contentTypes['revokeOptInConsentForEmailAddress'][0] ]) : PromiseInterface
Parameters
- $email_address : string
-
Email address to revoke consent for (required)
- $contentType : string = self::contentTypes['revokeOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['revokeOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —revokeOptInConsentForEmailAddressAsyncWithHttpInfo()
Operation revokeOptInConsentForEmailAddressAsyncWithHttpInfo
public
revokeOptInConsentForEmailAddressAsyncWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['revokeOptInConsentForEmailAddress'][0] ]) : PromiseInterface
Parameters
- $email_address : string
-
Email address to revoke consent for (required)
- $contentType : string = self::contentTypes['revokeOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['revokeOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —revokeOptInConsentForEmailAddressRequest()
Create request for operation 'revokeOptInConsentForEmailAddress'
public
revokeOptInConsentForEmailAddressRequest(string $email_address[, string $contentType = self::contentTypes['revokeOptInConsentForEmailAddress'][0] ]) : Request
Parameters
- $email_address : string
-
Email address to revoke consent for (required)
- $contentType : string = self::contentTypes['revokeOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['revokeOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
Request —revokeOptInConsentForEmailAddressWithHttpInfo()
Operation revokeOptInConsentForEmailAddressWithHttpInfo
public
revokeOptInConsentForEmailAddressWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['revokeOptInConsentForEmailAddress'][0] ]) : array<string|int, mixed>
Parameters
- $email_address : string
-
Email address to revoke consent for (required)
- $contentType : string = self::contentTypes['revokeOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['revokeOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\OptInSendingConsentDto, HTTP status code, HTTP response headers (array of strings)
sendOptInConsentForEmailAddress()
Operation sendOptInConsentForEmailAddress
public
sendOptInConsentForEmailAddress(OptInConsentOptions $opt_in_consent_options[, string $contentType = self::contentTypes['sendOptInConsentForEmailAddress'][0] ]) : OptInConsentSendResult
Send a verification code to a user once they have explicitly submitted their email address
Parameters
- $opt_in_consent_options : OptInConsentOptions
-
opt_in_consent_options (required)
- $contentType : string = self::contentTypes['sendOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
OptInConsentSendResult —sendOptInConsentForEmailAddressAsync()
Operation sendOptInConsentForEmailAddressAsync
public
sendOptInConsentForEmailAddressAsync(OptInConsentOptions $opt_in_consent_options[, string $contentType = self::contentTypes['sendOptInConsentForEmailAddress'][0] ]) : PromiseInterface
Send a verification code to a user once they have explicitly submitted their email address
Parameters
- $opt_in_consent_options : OptInConsentOptions
-
(required)
- $contentType : string = self::contentTypes['sendOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendOptInConsentForEmailAddressAsyncWithHttpInfo()
Operation sendOptInConsentForEmailAddressAsyncWithHttpInfo
public
sendOptInConsentForEmailAddressAsyncWithHttpInfo(OptInConsentOptions $opt_in_consent_options[, string $contentType = self::contentTypes['sendOptInConsentForEmailAddress'][0] ]) : PromiseInterface
Send a verification code to a user once they have explicitly submitted their email address
Parameters
- $opt_in_consent_options : OptInConsentOptions
-
(required)
- $contentType : string = self::contentTypes['sendOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendOptInConsentForEmailAddressRequest()
Create request for operation 'sendOptInConsentForEmailAddress'
public
sendOptInConsentForEmailAddressRequest(OptInConsentOptions $opt_in_consent_options[, string $contentType = self::contentTypes['sendOptInConsentForEmailAddress'][0] ]) : Request
Parameters
- $opt_in_consent_options : OptInConsentOptions
-
(required)
- $contentType : string = self::contentTypes['sendOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
Request —sendOptInConsentForEmailAddressWithHttpInfo()
Operation sendOptInConsentForEmailAddressWithHttpInfo
public
sendOptInConsentForEmailAddressWithHttpInfo(OptInConsentOptions $opt_in_consent_options[, string $contentType = self::contentTypes['sendOptInConsentForEmailAddress'][0] ]) : array<string|int, mixed>
Send a verification code to a user once they have explicitly submitted their email address
Parameters
- $opt_in_consent_options : OptInConsentOptions
-
(required)
- $contentType : string = self::contentTypes['sendOptInConsentForEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendOptInConsentForEmailAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\OptInConsentSendResult, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options