Documentation

AuthV2Api
in package

AuthV2Api Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['authV2AccountSwitch' => ['application/json'], 'authV2Bootstrap' => ['application/json'], 'authV2EnvironmentSwitch' => ['application/json'], 'authV2Logout' => ['application/json'], 'authV2PasswordLogin' => ['application/json'], 'authV2ProviderCallback' => ['application/json'], 'emailCallback' => ['application/json'], 'emailCallbackComplete' => ['application/x-www-form-urlencoded'], 'emailCallbackContinue' => ['application/json'], 'emailCallbackContinueScript' => ['application/json'], 'emailCallbackHead' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
authV2AccountSwitch()  : AuthV2BootstrapDto
Operation authV2AccountSwitch
authV2AccountSwitchAsync()  : PromiseInterface
Operation authV2AccountSwitchAsync
authV2AccountSwitchAsyncWithHttpInfo()  : PromiseInterface
Operation authV2AccountSwitchAsyncWithHttpInfo
authV2AccountSwitchRequest()  : Request
Create request for operation 'authV2AccountSwitch'
authV2AccountSwitchWithHttpInfo()  : array<string|int, mixed>
Operation authV2AccountSwitchWithHttpInfo
authV2Bootstrap()  : AuthV2BootstrapDto
Operation authV2Bootstrap
authV2BootstrapAsync()  : PromiseInterface
Operation authV2BootstrapAsync
authV2BootstrapAsyncWithHttpInfo()  : PromiseInterface
Operation authV2BootstrapAsyncWithHttpInfo
authV2BootstrapRequest()  : Request
Create request for operation 'authV2Bootstrap'
authV2BootstrapWithHttpInfo()  : array<string|int, mixed>
Operation authV2BootstrapWithHttpInfo
authV2EnvironmentSwitch()  : AuthV2BootstrapDto
Operation authV2EnvironmentSwitch
authV2EnvironmentSwitchAsync()  : PromiseInterface
Operation authV2EnvironmentSwitchAsync
authV2EnvironmentSwitchAsyncWithHttpInfo()  : PromiseInterface
Operation authV2EnvironmentSwitchAsyncWithHttpInfo
authV2EnvironmentSwitchRequest()  : Request
Create request for operation 'authV2EnvironmentSwitch'
authV2EnvironmentSwitchWithHttpInfo()  : array<string|int, mixed>
Operation authV2EnvironmentSwitchWithHttpInfo
authV2Logout()  : void
Operation authV2Logout
authV2LogoutAsync()  : PromiseInterface
Operation authV2LogoutAsync
authV2LogoutAsyncWithHttpInfo()  : PromiseInterface
Operation authV2LogoutAsyncWithHttpInfo
authV2LogoutRequest()  : Request
Create request for operation 'authV2Logout'
authV2LogoutWithHttpInfo()  : array<string|int, mixed>
Operation authV2LogoutWithHttpInfo
authV2PasswordLogin()  : AuthV2BootstrapDto
Operation authV2PasswordLogin
authV2PasswordLoginAsync()  : PromiseInterface
Operation authV2PasswordLoginAsync
authV2PasswordLoginAsyncWithHttpInfo()  : PromiseInterface
Operation authV2PasswordLoginAsyncWithHttpInfo
authV2PasswordLoginRequest()  : Request
Create request for operation 'authV2PasswordLogin'
authV2PasswordLoginWithHttpInfo()  : array<string|int, mixed>
Operation authV2PasswordLoginWithHttpInfo
authV2ProviderCallback()  : void
Operation authV2ProviderCallback
authV2ProviderCallbackAsync()  : PromiseInterface
Operation authV2ProviderCallbackAsync
authV2ProviderCallbackAsyncWithHttpInfo()  : PromiseInterface
Operation authV2ProviderCallbackAsyncWithHttpInfo
authV2ProviderCallbackRequest()  : Request
Create request for operation 'authV2ProviderCallback'
authV2ProviderCallbackWithHttpInfo()  : array<string|int, mixed>
Operation authV2ProviderCallbackWithHttpInfo
emailCallback()  : void
Operation emailCallback
emailCallbackAsync()  : PromiseInterface
Operation emailCallbackAsync
emailCallbackAsyncWithHttpInfo()  : PromiseInterface
Operation emailCallbackAsyncWithHttpInfo
emailCallbackComplete()  : void
Operation emailCallbackComplete
emailCallbackCompleteAsync()  : PromiseInterface
Operation emailCallbackCompleteAsync
emailCallbackCompleteAsyncWithHttpInfo()  : PromiseInterface
Operation emailCallbackCompleteAsyncWithHttpInfo
emailCallbackCompleteRequest()  : Request
Create request for operation 'emailCallbackComplete'
emailCallbackCompleteWithHttpInfo()  : array<string|int, mixed>
Operation emailCallbackCompleteWithHttpInfo
emailCallbackContinue()  : string
Operation emailCallbackContinue
emailCallbackContinueAsync()  : PromiseInterface
Operation emailCallbackContinueAsync
emailCallbackContinueAsyncWithHttpInfo()  : PromiseInterface
Operation emailCallbackContinueAsyncWithHttpInfo
emailCallbackContinueRequest()  : Request
Create request for operation 'emailCallbackContinue'
emailCallbackContinueScript()  : string
Operation emailCallbackContinueScript
emailCallbackContinueScriptAsync()  : PromiseInterface
Operation emailCallbackContinueScriptAsync
emailCallbackContinueScriptAsyncWithHttpInfo()  : PromiseInterface
Operation emailCallbackContinueScriptAsyncWithHttpInfo
emailCallbackContinueScriptRequest()  : Request
Create request for operation 'emailCallbackContinueScript'
emailCallbackContinueScriptWithHttpInfo()  : array<string|int, mixed>
Operation emailCallbackContinueScriptWithHttpInfo
emailCallbackContinueWithHttpInfo()  : array<string|int, mixed>
Operation emailCallbackContinueWithHttpInfo
emailCallbackHead()  : void
Operation emailCallbackHead
emailCallbackHeadAsync()  : PromiseInterface
Operation emailCallbackHeadAsync
emailCallbackHeadAsyncWithHttpInfo()  : PromiseInterface
Operation emailCallbackHeadAsyncWithHttpInfo
emailCallbackHeadRequest()  : Request
Create request for operation 'emailCallbackHead'
emailCallbackHeadWithHttpInfo()  : array<string|int, mixed>
Operation emailCallbackHeadWithHttpInfo
emailCallbackRequest()  : Request
Create request for operation 'emailCallback'
emailCallbackWithHttpInfo()  : array<string|int, mixed>
Operation emailCallbackWithHttpInfo
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 = ['authV2AccountSwitch' => ['application/json'], 'authV2Bootstrap' => ['application/json'], 'authV2EnvironmentSwitch' => ['application/json'], 'authV2Logout' => ['application/json'], 'authV2PasswordLogin' => ['application/json'], 'authV2ProviderCallback' => ['application/json'], 'emailCallback' => ['application/json'], 'emailCallbackComplete' => ['application/x-www-form-urlencoded'], 'emailCallbackContinue' => ['application/json'], 'emailCallbackContinueScript' => ['application/json'], 'emailCallbackHead' => ['application/json']]

Properties

$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 —

authV2AccountSwitch()

Operation authV2AccountSwitch

public authV2AccountSwitch(SwitchAccountOptions $switch_account_options[, string $contentType = self::contentTypes['authV2AccountSwitch'][0] ]) : AuthV2BootstrapDto

Switch the account bound to an Auth v2 session

Parameters
$switch_account_options : SwitchAccountOptions

switch_account_options (required)

$contentType : string = self::contentTypes['authV2AccountSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2AccountSwitch'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AuthV2BootstrapDto —

authV2AccountSwitchAsync()

Operation authV2AccountSwitchAsync

public authV2AccountSwitchAsync(SwitchAccountOptions $switch_account_options[, string $contentType = self::contentTypes['authV2AccountSwitch'][0] ]) : PromiseInterface

Switch the account bound to an Auth v2 session

Parameters
$switch_account_options : SwitchAccountOptions

(required)

$contentType : string = self::contentTypes['authV2AccountSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2AccountSwitch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2AccountSwitchAsyncWithHttpInfo()

Operation authV2AccountSwitchAsyncWithHttpInfo

public authV2AccountSwitchAsyncWithHttpInfo(SwitchAccountOptions $switch_account_options[, string $contentType = self::contentTypes['authV2AccountSwitch'][0] ]) : PromiseInterface

Switch the account bound to an Auth v2 session

Parameters
$switch_account_options : SwitchAccountOptions

(required)

$contentType : string = self::contentTypes['authV2AccountSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2AccountSwitch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2AccountSwitchRequest()

Create request for operation 'authV2AccountSwitch'

public authV2AccountSwitchRequest(SwitchAccountOptions $switch_account_options[, string $contentType = self::contentTypes['authV2AccountSwitch'][0] ]) : Request
Parameters
$switch_account_options : SwitchAccountOptions

(required)

$contentType : string = self::contentTypes['authV2AccountSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2AccountSwitch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authV2AccountSwitchWithHttpInfo()

Operation authV2AccountSwitchWithHttpInfo

public authV2AccountSwitchWithHttpInfo(SwitchAccountOptions $switch_account_options[, string $contentType = self::contentTypes['authV2AccountSwitch'][0] ]) : array<string|int, mixed>

Switch the account bound to an Auth v2 session

Parameters
$switch_account_options : SwitchAccountOptions

(required)

$contentType : string = self::contentTypes['authV2AccountSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2AccountSwitch'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AuthV2BootstrapDto, HTTP status code, HTTP response headers (array of strings)

authV2Bootstrap()

Operation authV2Bootstrap

public authV2Bootstrap([AuthV2BootstrapOptions $auth_v2_bootstrap_options = null ][, string $contentType = self::contentTypes['authV2Bootstrap'][0] ]) : AuthV2BootstrapDto

Bootstrap an existing Auth v2 session

Parameters
$auth_v2_bootstrap_options : AuthV2BootstrapOptions = null

auth_v2_bootstrap_options (optional)

$contentType : string = self::contentTypes['authV2Bootstrap'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Bootstrap'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AuthV2BootstrapDto —

authV2BootstrapAsync()

Operation authV2BootstrapAsync

public authV2BootstrapAsync([AuthV2BootstrapOptions $auth_v2_bootstrap_options = null ][, string $contentType = self::contentTypes['authV2Bootstrap'][0] ]) : PromiseInterface

Bootstrap an existing Auth v2 session

Parameters
$auth_v2_bootstrap_options : AuthV2BootstrapOptions = null

(optional)

$contentType : string = self::contentTypes['authV2Bootstrap'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Bootstrap'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2BootstrapAsyncWithHttpInfo()

Operation authV2BootstrapAsyncWithHttpInfo

public authV2BootstrapAsyncWithHttpInfo([AuthV2BootstrapOptions $auth_v2_bootstrap_options = null ][, string $contentType = self::contentTypes['authV2Bootstrap'][0] ]) : PromiseInterface

Bootstrap an existing Auth v2 session

Parameters
$auth_v2_bootstrap_options : AuthV2BootstrapOptions = null

(optional)

$contentType : string = self::contentTypes['authV2Bootstrap'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Bootstrap'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2BootstrapRequest()

Create request for operation 'authV2Bootstrap'

public authV2BootstrapRequest([AuthV2BootstrapOptions $auth_v2_bootstrap_options = null ][, string $contentType = self::contentTypes['authV2Bootstrap'][0] ]) : Request
Parameters
$auth_v2_bootstrap_options : AuthV2BootstrapOptions = null

(optional)

$contentType : string = self::contentTypes['authV2Bootstrap'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Bootstrap'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authV2BootstrapWithHttpInfo()

Operation authV2BootstrapWithHttpInfo

public authV2BootstrapWithHttpInfo([AuthV2BootstrapOptions $auth_v2_bootstrap_options = null ][, string $contentType = self::contentTypes['authV2Bootstrap'][0] ]) : array<string|int, mixed>

Bootstrap an existing Auth v2 session

Parameters
$auth_v2_bootstrap_options : AuthV2BootstrapOptions = null

(optional)

$contentType : string = self::contentTypes['authV2Bootstrap'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Bootstrap'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AuthV2BootstrapDto, HTTP status code, HTTP response headers (array of strings)

authV2EnvironmentSwitch()

Operation authV2EnvironmentSwitch

public authV2EnvironmentSwitch(string $target_user_id[, string $contentType = self::contentTypes['authV2EnvironmentSwitch'][0] ]) : AuthV2BootstrapDto

Switch the environment bound to an Auth v2 session

Parameters
$target_user_id : string

target_user_id (required)

$contentType : string = self::contentTypes['authV2EnvironmentSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2EnvironmentSwitch'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AuthV2BootstrapDto —

authV2EnvironmentSwitchAsync()

Operation authV2EnvironmentSwitchAsync

public authV2EnvironmentSwitchAsync(string $target_user_id[, string $contentType = self::contentTypes['authV2EnvironmentSwitch'][0] ]) : PromiseInterface

Switch the environment bound to an Auth v2 session

Parameters
$target_user_id : string

(required)

$contentType : string = self::contentTypes['authV2EnvironmentSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2EnvironmentSwitch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2EnvironmentSwitchAsyncWithHttpInfo()

Operation authV2EnvironmentSwitchAsyncWithHttpInfo

public authV2EnvironmentSwitchAsyncWithHttpInfo(string $target_user_id[, string $contentType = self::contentTypes['authV2EnvironmentSwitch'][0] ]) : PromiseInterface

Switch the environment bound to an Auth v2 session

Parameters
$target_user_id : string

(required)

$contentType : string = self::contentTypes['authV2EnvironmentSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2EnvironmentSwitch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2EnvironmentSwitchRequest()

Create request for operation 'authV2EnvironmentSwitch'

public authV2EnvironmentSwitchRequest(string $target_user_id[, string $contentType = self::contentTypes['authV2EnvironmentSwitch'][0] ]) : Request
Parameters
$target_user_id : string

(required)

$contentType : string = self::contentTypes['authV2EnvironmentSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2EnvironmentSwitch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authV2EnvironmentSwitchWithHttpInfo()

Operation authV2EnvironmentSwitchWithHttpInfo

public authV2EnvironmentSwitchWithHttpInfo(string $target_user_id[, string $contentType = self::contentTypes['authV2EnvironmentSwitch'][0] ]) : array<string|int, mixed>

Switch the environment bound to an Auth v2 session

Parameters
$target_user_id : string

(required)

$contentType : string = self::contentTypes['authV2EnvironmentSwitch'][0]

The value for the Content-Type header. Check self::contentTypes['authV2EnvironmentSwitch'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AuthV2BootstrapDto, HTTP status code, HTTP response headers (array of strings)

authV2Logout()

Operation authV2Logout

public authV2Logout([string $contentType = self::contentTypes['authV2Logout'][0] ]) : void

Revoke an Auth v2 session

Parameters
$contentType : string = self::contentTypes['authV2Logout'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Logout'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

authV2LogoutAsync()

Operation authV2LogoutAsync

public authV2LogoutAsync([string $contentType = self::contentTypes['authV2Logout'][0] ]) : PromiseInterface

Revoke an Auth v2 session

Parameters
$contentType : string = self::contentTypes['authV2Logout'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Logout'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2LogoutAsyncWithHttpInfo()

Operation authV2LogoutAsyncWithHttpInfo

public authV2LogoutAsyncWithHttpInfo([string $contentType = self::contentTypes['authV2Logout'][0] ]) : PromiseInterface

Revoke an Auth v2 session

Parameters
$contentType : string = self::contentTypes['authV2Logout'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Logout'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2LogoutRequest()

Create request for operation 'authV2Logout'

public authV2LogoutRequest([string $contentType = self::contentTypes['authV2Logout'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['authV2Logout'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Logout'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authV2LogoutWithHttpInfo()

Operation authV2LogoutWithHttpInfo

public authV2LogoutWithHttpInfo([string $contentType = self::contentTypes['authV2Logout'][0] ]) : array<string|int, mixed>

Revoke an Auth v2 session

Parameters
$contentType : string = self::contentTypes['authV2Logout'][0]

The value for the Content-Type header. Check self::contentTypes['authV2Logout'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

authV2PasswordLogin()

Operation authV2PasswordLogin

public authV2PasswordLogin(AuthV2PasswordLoginOptions $auth_v2_password_login_options[, string $contentType = self::contentTypes['authV2PasswordLogin'][0] ]) : AuthV2BootstrapDto

Create an Auth v2 session using a password

Parameters
$auth_v2_password_login_options : AuthV2PasswordLoginOptions

auth_v2_password_login_options (required)

$contentType : string = self::contentTypes['authV2PasswordLogin'][0]

The value for the Content-Type header. Check self::contentTypes['authV2PasswordLogin'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AuthV2BootstrapDto —

authV2PasswordLoginAsync()

Operation authV2PasswordLoginAsync

public authV2PasswordLoginAsync(AuthV2PasswordLoginOptions $auth_v2_password_login_options[, string $contentType = self::contentTypes['authV2PasswordLogin'][0] ]) : PromiseInterface

Create an Auth v2 session using a password

Parameters
$auth_v2_password_login_options : AuthV2PasswordLoginOptions

(required)

$contentType : string = self::contentTypes['authV2PasswordLogin'][0]

The value for the Content-Type header. Check self::contentTypes['authV2PasswordLogin'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2PasswordLoginAsyncWithHttpInfo()

Operation authV2PasswordLoginAsyncWithHttpInfo

public authV2PasswordLoginAsyncWithHttpInfo(AuthV2PasswordLoginOptions $auth_v2_password_login_options[, string $contentType = self::contentTypes['authV2PasswordLogin'][0] ]) : PromiseInterface

Create an Auth v2 session using a password

Parameters
$auth_v2_password_login_options : AuthV2PasswordLoginOptions

(required)

$contentType : string = self::contentTypes['authV2PasswordLogin'][0]

The value for the Content-Type header. Check self::contentTypes['authV2PasswordLogin'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2PasswordLoginRequest()

Create request for operation 'authV2PasswordLogin'

public authV2PasswordLoginRequest(AuthV2PasswordLoginOptions $auth_v2_password_login_options[, string $contentType = self::contentTypes['authV2PasswordLogin'][0] ]) : Request
Parameters
$auth_v2_password_login_options : AuthV2PasswordLoginOptions

(required)

$contentType : string = self::contentTypes['authV2PasswordLogin'][0]

The value for the Content-Type header. Check self::contentTypes['authV2PasswordLogin'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authV2PasswordLoginWithHttpInfo()

Operation authV2PasswordLoginWithHttpInfo

public authV2PasswordLoginWithHttpInfo(AuthV2PasswordLoginOptions $auth_v2_password_login_options[, string $contentType = self::contentTypes['authV2PasswordLogin'][0] ]) : array<string|int, mixed>

Create an Auth v2 session using a password

Parameters
$auth_v2_password_login_options : AuthV2PasswordLoginOptions

(required)

$contentType : string = self::contentTypes['authV2PasswordLogin'][0]

The value for the Content-Type header. Check self::contentTypes['authV2PasswordLogin'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AuthV2BootstrapDto, HTTP status code, HTTP response headers (array of strings)

authV2ProviderCallback()

Operation authV2ProviderCallback

public authV2ProviderCallback(string $provider_kind[, string $code = null ][, string $contentType = self::contentTypes['authV2ProviderCallback'][0] ]) : void

Redeem a staging provider handoff and continue to the app

Parameters
$provider_kind : string

provider_kind (required)

$code : string = null

code (optional)

$contentType : string = self::contentTypes['authV2ProviderCallback'][0]

The value for the Content-Type header. Check self::contentTypes['authV2ProviderCallback'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

authV2ProviderCallbackAsync()

Operation authV2ProviderCallbackAsync

public authV2ProviderCallbackAsync(string $provider_kind[, string $code = null ][, string $contentType = self::contentTypes['authV2ProviderCallback'][0] ]) : PromiseInterface

Redeem a staging provider handoff and continue to the app

Parameters
$provider_kind : string

(required)

$code : string = null

(optional)

$contentType : string = self::contentTypes['authV2ProviderCallback'][0]

The value for the Content-Type header. Check self::contentTypes['authV2ProviderCallback'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2ProviderCallbackAsyncWithHttpInfo()

Operation authV2ProviderCallbackAsyncWithHttpInfo

public authV2ProviderCallbackAsyncWithHttpInfo(string $provider_kind[, string $code = null ][, string $contentType = self::contentTypes['authV2ProviderCallback'][0] ]) : PromiseInterface

Redeem a staging provider handoff and continue to the app

Parameters
$provider_kind : string

(required)

$code : string = null

(optional)

$contentType : string = self::contentTypes['authV2ProviderCallback'][0]

The value for the Content-Type header. Check self::contentTypes['authV2ProviderCallback'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authV2ProviderCallbackRequest()

Create request for operation 'authV2ProviderCallback'

public authV2ProviderCallbackRequest(string $provider_kind[, string $code = null ][, string $contentType = self::contentTypes['authV2ProviderCallback'][0] ]) : Request
Parameters
$provider_kind : string

(required)

$code : string = null

(optional)

$contentType : string = self::contentTypes['authV2ProviderCallback'][0]

The value for the Content-Type header. Check self::contentTypes['authV2ProviderCallback'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authV2ProviderCallbackWithHttpInfo()

Operation authV2ProviderCallbackWithHttpInfo

public authV2ProviderCallbackWithHttpInfo(string $provider_kind[, string $code = null ][, string $contentType = self::contentTypes['authV2ProviderCallback'][0] ]) : array<string|int, mixed>

Redeem a staging provider handoff and continue to the app

Parameters
$provider_kind : string

(required)

$code : string = null

(optional)

$contentType : string = self::contentTypes['authV2ProviderCallback'][0]

The value for the Content-Type header. Check self::contentTypes['authV2ProviderCallback'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

emailCallback()

Operation emailCallback

public emailCallback([string $code = null ][, string $contentType = self::contentTypes['emailCallback'][0] ]) : void
Parameters
$code : string = null

code (optional)

$contentType : string = self::contentTypes['emailCallback'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallback'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

emailCallbackAsync()

Operation emailCallbackAsync

public emailCallbackAsync([string $code = null ][, string $contentType = self::contentTypes['emailCallback'][0] ]) : PromiseInterface
Parameters
$code : string = null

(optional)

$contentType : string = self::contentTypes['emailCallback'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallback'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackAsyncWithHttpInfo()

Operation emailCallbackAsyncWithHttpInfo

public emailCallbackAsyncWithHttpInfo([string $code = null ][, string $contentType = self::contentTypes['emailCallback'][0] ]) : PromiseInterface
Parameters
$code : string = null

(optional)

$contentType : string = self::contentTypes['emailCallback'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallback'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackComplete()

Operation emailCallbackComplete

public emailCallbackComplete([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackComplete'][0] ]) : void
Parameters
$attempt : string = null

attempt (optional)

$contentType : string = self::contentTypes['emailCallbackComplete'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackComplete'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

emailCallbackCompleteAsync()

Operation emailCallbackCompleteAsync

public emailCallbackCompleteAsync([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackComplete'][0] ]) : PromiseInterface
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackComplete'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackComplete'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackCompleteAsyncWithHttpInfo()

Operation emailCallbackCompleteAsyncWithHttpInfo

public emailCallbackCompleteAsyncWithHttpInfo([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackComplete'][0] ]) : PromiseInterface
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackComplete'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackComplete'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackCompleteRequest()

Create request for operation 'emailCallbackComplete'

public emailCallbackCompleteRequest([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackComplete'][0] ]) : Request
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackComplete'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackComplete'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

emailCallbackCompleteWithHttpInfo()

Operation emailCallbackCompleteWithHttpInfo

public emailCallbackCompleteWithHttpInfo([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackComplete'][0] ]) : array<string|int, mixed>
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackComplete'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackComplete'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

emailCallbackContinue()

Operation emailCallbackContinue

public emailCallbackContinue([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackContinue'][0] ]) : string
Parameters
$attempt : string = null

attempt (optional)

$contentType : string = self::contentTypes['emailCallbackContinue'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinue'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
string —

emailCallbackContinueAsync()

Operation emailCallbackContinueAsync

public emailCallbackContinueAsync([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackContinue'][0] ]) : PromiseInterface
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackContinue'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinue'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackContinueAsyncWithHttpInfo()

Operation emailCallbackContinueAsyncWithHttpInfo

public emailCallbackContinueAsyncWithHttpInfo([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackContinue'][0] ]) : PromiseInterface
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackContinue'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinue'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackContinueRequest()

Create request for operation 'emailCallbackContinue'

public emailCallbackContinueRequest([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackContinue'][0] ]) : Request
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackContinue'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinue'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

emailCallbackContinueScript()

Operation emailCallbackContinueScript

public emailCallbackContinueScript([string $contentType = self::contentTypes['emailCallbackContinueScript'][0] ]) : string
Parameters
$contentType : string = self::contentTypes['emailCallbackContinueScript'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinueScript'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
string —

emailCallbackContinueScriptAsync()

Operation emailCallbackContinueScriptAsync

public emailCallbackContinueScriptAsync([string $contentType = self::contentTypes['emailCallbackContinueScript'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['emailCallbackContinueScript'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinueScript'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackContinueScriptAsyncWithHttpInfo()

Operation emailCallbackContinueScriptAsyncWithHttpInfo

public emailCallbackContinueScriptAsyncWithHttpInfo([string $contentType = self::contentTypes['emailCallbackContinueScript'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['emailCallbackContinueScript'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinueScript'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackContinueScriptRequest()

Create request for operation 'emailCallbackContinueScript'

public emailCallbackContinueScriptRequest([string $contentType = self::contentTypes['emailCallbackContinueScript'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['emailCallbackContinueScript'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinueScript'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

emailCallbackContinueScriptWithHttpInfo()

Operation emailCallbackContinueScriptWithHttpInfo

public emailCallbackContinueScriptWithHttpInfo([string $contentType = self::contentTypes['emailCallbackContinueScript'][0] ]) : array<string|int, mixed>
Parameters
$contentType : string = self::contentTypes['emailCallbackContinueScript'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinueScript'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

emailCallbackContinueWithHttpInfo()

Operation emailCallbackContinueWithHttpInfo

public emailCallbackContinueWithHttpInfo([string $attempt = null ][, string $contentType = self::contentTypes['emailCallbackContinue'][0] ]) : array<string|int, mixed>
Parameters
$attempt : string = null

(optional)

$contentType : string = self::contentTypes['emailCallbackContinue'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackContinue'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

emailCallbackHead()

Operation emailCallbackHead

public emailCallbackHead([string $contentType = self::contentTypes['emailCallbackHead'][0] ]) : void
Parameters
$contentType : string = self::contentTypes['emailCallbackHead'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackHead'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

emailCallbackHeadAsync()

Operation emailCallbackHeadAsync

public emailCallbackHeadAsync([string $contentType = self::contentTypes['emailCallbackHead'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['emailCallbackHead'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackHead'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackHeadAsyncWithHttpInfo()

Operation emailCallbackHeadAsyncWithHttpInfo

public emailCallbackHeadAsyncWithHttpInfo([string $contentType = self::contentTypes['emailCallbackHead'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['emailCallbackHead'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackHead'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

emailCallbackHeadRequest()

Create request for operation 'emailCallbackHead'

public emailCallbackHeadRequest([string $contentType = self::contentTypes['emailCallbackHead'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['emailCallbackHead'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackHead'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

emailCallbackHeadWithHttpInfo()

Operation emailCallbackHeadWithHttpInfo

public emailCallbackHeadWithHttpInfo([string $contentType = self::contentTypes['emailCallbackHead'][0] ]) : array<string|int, mixed>
Parameters
$contentType : string = self::contentTypes['emailCallbackHead'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallbackHead'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

emailCallbackRequest()

Create request for operation 'emailCallback'

public emailCallbackRequest([string $code = null ][, string $contentType = self::contentTypes['emailCallback'][0] ]) : Request
Parameters
$code : string = null

(optional)

$contentType : string = self::contentTypes['emailCallback'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallback'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

emailCallbackWithHttpInfo()

Operation emailCallbackWithHttpInfo

public emailCallbackWithHttpInfo([string $code = null ][, string $contentType = self::contentTypes['emailCallback'][0] ]) : array<string|int, mixed>
Parameters
$code : string = null

(optional)

$contentType : string = self::contentTypes['emailCallback'][0]

The value for the Content-Type header. Check self::contentTypes['emailCallback'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

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
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

Search results