OAuthConnectionApi
in package
OAuthConnectionApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createOAuthConnection' => ['application/json'], 'exchangeAuthorizationTokenAndCreateOrUpdateInbox' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createOAuthConnection() : CreateOAuthConnectionResult
- Operation createOAuthConnection
- createOAuthConnectionAsync() : PromiseInterface
- Operation createOAuthConnectionAsync
- createOAuthConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation createOAuthConnectionAsyncWithHttpInfo
- createOAuthConnectionRequest() : Request
- Create request for operation 'createOAuthConnection'
- createOAuthConnectionWithHttpInfo() : array<string|int, mixed>
- Operation createOAuthConnectionWithHttpInfo
- exchangeAuthorizationTokenAndCreateOrUpdateInbox() : CreateOAuthExchangeResult
- Operation exchangeAuthorizationTokenAndCreateOrUpdateInbox
- exchangeAuthorizationTokenAndCreateOrUpdateInboxAsync() : PromiseInterface
- Operation exchangeAuthorizationTokenAndCreateOrUpdateInboxAsync
- exchangeAuthorizationTokenAndCreateOrUpdateInboxAsyncWithHttpInfo() : PromiseInterface
- Operation exchangeAuthorizationTokenAndCreateOrUpdateInboxAsyncWithHttpInfo
- exchangeAuthorizationTokenAndCreateOrUpdateInboxRequest() : Request
- Create request for operation 'exchangeAuthorizationTokenAndCreateOrUpdateInbox'
- exchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfo() : array<string|int, mixed>
- Operation exchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createOAuthConnection' => ['application/json'], 'exchangeAuthorizationTokenAndCreateOrUpdateInbox' => ['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 —createOAuthConnection()
Operation createOAuthConnection
public
createOAuthConnection(string $redirect_base, string $o_auth_connection_type[, string $email_address = null ][, string $contentType = self::contentTypes['createOAuthConnection'][0] ]) : CreateOAuthConnectionResult
Create an OAuth connection
Parameters
- $redirect_base : string
-
redirect_base (required)
- $o_auth_connection_type : string
-
o_auth_connection_type (required)
- $email_address : string = null
-
email_address (optional)
- $contentType : string = self::contentTypes['createOAuthConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOAuthConnection'] to see the possible values for this operation
Tags
Return values
CreateOAuthConnectionResult —createOAuthConnectionAsync()
Operation createOAuthConnectionAsync
public
createOAuthConnectionAsync(string $redirect_base, string $o_auth_connection_type[, string $email_address = null ][, string $contentType = self::contentTypes['createOAuthConnection'][0] ]) : PromiseInterface
Create an OAuth connection
Parameters
- $redirect_base : string
-
(required)
- $o_auth_connection_type : string
-
(required)
- $email_address : string = null
-
(optional)
- $contentType : string = self::contentTypes['createOAuthConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOAuthConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createOAuthConnectionAsyncWithHttpInfo()
Operation createOAuthConnectionAsyncWithHttpInfo
public
createOAuthConnectionAsyncWithHttpInfo(string $redirect_base, string $o_auth_connection_type[, string $email_address = null ][, string $contentType = self::contentTypes['createOAuthConnection'][0] ]) : PromiseInterface
Create an OAuth connection
Parameters
- $redirect_base : string
-
(required)
- $o_auth_connection_type : string
-
(required)
- $email_address : string = null
-
(optional)
- $contentType : string = self::contentTypes['createOAuthConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOAuthConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createOAuthConnectionRequest()
Create request for operation 'createOAuthConnection'
public
createOAuthConnectionRequest(string $redirect_base, string $o_auth_connection_type[, string $email_address = null ][, string $contentType = self::contentTypes['createOAuthConnection'][0] ]) : Request
Parameters
- $redirect_base : string
-
(required)
- $o_auth_connection_type : string
-
(required)
- $email_address : string = null
-
(optional)
- $contentType : string = self::contentTypes['createOAuthConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOAuthConnection'] to see the possible values for this operation
Tags
Return values
Request —createOAuthConnectionWithHttpInfo()
Operation createOAuthConnectionWithHttpInfo
public
createOAuthConnectionWithHttpInfo(string $redirect_base, string $o_auth_connection_type[, string $email_address = null ][, string $contentType = self::contentTypes['createOAuthConnection'][0] ]) : array<string|int, mixed>
Create an OAuth connection
Parameters
- $redirect_base : string
-
(required)
- $o_auth_connection_type : string
-
(required)
- $email_address : string = null
-
(optional)
- $contentType : string = self::contentTypes['createOAuthConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOAuthConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CreateOAuthConnectionResult, HTTP status code, HTTP response headers (array of strings)
exchangeAuthorizationTokenAndCreateOrUpdateInbox()
Operation exchangeAuthorizationTokenAndCreateOrUpdateInbox
public
exchangeAuthorizationTokenAndCreateOrUpdateInbox(string $authorization_code, string $redirect_uri[, string $contentType = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0] ]) : CreateOAuthExchangeResult
Exchange authorization code for access token and create inbox
Parameters
- $authorization_code : string
-
authorization_code (required)
- $redirect_uri : string
-
redirect_uri (required)
- $contentType : string = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'] to see the possible values for this operation
Tags
Return values
CreateOAuthExchangeResult —exchangeAuthorizationTokenAndCreateOrUpdateInboxAsync()
Operation exchangeAuthorizationTokenAndCreateOrUpdateInboxAsync
public
exchangeAuthorizationTokenAndCreateOrUpdateInboxAsync(string $authorization_code, string $redirect_uri[, string $contentType = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0] ]) : PromiseInterface
Exchange authorization code for access token and create inbox
Parameters
- $authorization_code : string
-
(required)
- $redirect_uri : string
-
(required)
- $contentType : string = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exchangeAuthorizationTokenAndCreateOrUpdateInboxAsyncWithHttpInfo()
Operation exchangeAuthorizationTokenAndCreateOrUpdateInboxAsyncWithHttpInfo
public
exchangeAuthorizationTokenAndCreateOrUpdateInboxAsyncWithHttpInfo(string $authorization_code, string $redirect_uri[, string $contentType = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0] ]) : PromiseInterface
Exchange authorization code for access token and create inbox
Parameters
- $authorization_code : string
-
(required)
- $redirect_uri : string
-
(required)
- $contentType : string = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exchangeAuthorizationTokenAndCreateOrUpdateInboxRequest()
Create request for operation 'exchangeAuthorizationTokenAndCreateOrUpdateInbox'
public
exchangeAuthorizationTokenAndCreateOrUpdateInboxRequest(string $authorization_code, string $redirect_uri[, string $contentType = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0] ]) : Request
Parameters
- $authorization_code : string
-
(required)
- $redirect_uri : string
-
(required)
- $contentType : string = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'] to see the possible values for this operation
Tags
Return values
Request —exchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfo()
Operation exchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfo
public
exchangeAuthorizationTokenAndCreateOrUpdateInboxWithHttpInfo(string $authorization_code, string $redirect_uri[, string $contentType = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0] ]) : array<string|int, mixed>
Exchange authorization code for access token and create inbox
Parameters
- $authorization_code : string
-
(required)
- $redirect_uri : string
-
(required)
- $contentType : string = self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['exchangeAuthorizationTokenAndCreateOrUpdateInbox'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CreateOAuthExchangeResult, 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
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