Documentation

AccountApi
in package

BIMworks

AccountApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['changePassword' => ['application/json'], 'get...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
changePassword() : AuthResult|ErrorResponse: Operation changePassword
changePasswordAsync() : PromiseInterface: Operation changePasswordAsync
changePasswordAsyncWithHttpInfo() : PromiseInterface: Operation changePasswordAsyncWithHttpInfo
changePasswordRequest() : Request: Create request for operation 'changePassword'
changePasswordWithHttpInfo() : array<string|int, mixed>: Operation changePasswordWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
getSettings() : AccountSettings|ErrorResponse: Operation getSettings
getSettingsAsync() : PromiseInterface: Operation getSettingsAsync
getSettingsAsyncWithHttpInfo() : PromiseInterface: Operation getSettingsAsyncWithHttpInfo
getSettingsRequest() : Request: Create request for operation 'getSettings'
getSettingsWithHttpInfo() : array<string|int, mixed>: Operation getSettingsWithHttpInfo
listReferenceValues() : array<string|int, ReferenceValue>|ErrorResponse: Operation listReferenceValues
listReferenceValuesAsync() : PromiseInterface: Operation listReferenceValuesAsync
listReferenceValuesAsyncWithHttpInfo() : PromiseInterface: Operation listReferenceValuesAsyncWithHttpInfo
listReferenceValuesRequest() : Request: Create request for operation 'listReferenceValues'
listReferenceValuesWithHttpInfo() : array<string|int, mixed>: Operation listReferenceValuesWithHttpInfo
logout() : void: Operation logout
logoutAsync() : PromiseInterface: Operation logoutAsync
logoutAsyncWithHttpInfo() : PromiseInterface: Operation logoutAsyncWithHttpInfo
logoutRequest() : Request: Create request for operation 'logout'
logoutWithHttpInfo() : array<string|int, mixed>: Operation logoutWithHttpInfo
register() : void: Operation register
registerAsync() : PromiseInterface: Operation registerAsync
registerAsyncWithHttpInfo() : PromiseInterface: Operation registerAsyncWithHttpInfo
registerRequest() : Request: Create request for operation 'register'
registerWithHttpInfo() : array<string|int, mixed>: Operation registerWithHttpInfo
requestPasswordReset() : void: Operation requestPasswordReset
requestPasswordResetAsync() : PromiseInterface: Operation requestPasswordResetAsync
requestPasswordResetAsyncWithHttpInfo() : PromiseInterface: Operation requestPasswordResetAsyncWithHttpInfo
requestPasswordResetRequest() : Request: Create request for operation 'requestPasswordReset'
requestPasswordResetWithHttpInfo() : array<string|int, mixed>: Operation requestPasswordResetWithHttpInfo
requestValidationEmail() : void: Operation requestValidationEmail
requestValidationEmailAsync() : PromiseInterface: Operation requestValidationEmailAsync
requestValidationEmailAsyncWithHttpInfo() : PromiseInterface: Operation requestValidationEmailAsyncWithHttpInfo
requestValidationEmailRequest() : Request: Create request for operation 'requestValidationEmail'
requestValidationEmailWithHttpInfo() : array<string|int, mixed>: Operation requestValidationEmailWithHttpInfo
saveSettings() : void: Operation saveSettings
saveSettingsAsync() : PromiseInterface: Operation saveSettingsAsync
saveSettingsAsyncWithHttpInfo() : PromiseInterface: Operation saveSettingsAsyncWithHttpInfo
saveSettingsRequest() : Request: Create request for operation 'saveSettings'
saveSettingsWithHttpInfo() : array<string|int, mixed>: Operation saveSettingsWithHttpInfo
setHostIndex() : void: Set the host index
signOutOtherSessions() : AuthResult|ErrorResponse: Operation signOutOtherSessions
signOutOtherSessionsAsync() : PromiseInterface: Operation signOutOtherSessionsAsync
signOutOtherSessionsAsyncWithHttpInfo() : PromiseInterface: Operation signOutOtherSessionsAsyncWithHttpInfo
signOutOtherSessionsRequest() : Request: Create request for operation 'signOutOtherSessions'
signOutOtherSessionsWithHttpInfo() : array<string|int, mixed>: Operation signOutOtherSessionsWithHttpInfo
validateEmailAddress() : void: Operation validateEmailAddress
validateEmailAddressAsync() : PromiseInterface: Operation validateEmailAddressAsync
validateEmailAddressAsyncWithHttpInfo() : PromiseInterface: Operation validateEmailAddressAsyncWithHttpInfo
validateEmailAddressRequest() : Request: Create request for operation 'validateEmailAddress'
validateEmailAddressWithHttpInfo() : array<string|int, mixed>: Operation validateEmailAddressWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['changePassword' => ['application/json'], 'getSettings' => ['application/json'], 'listReferenceValues' => ['application/json'], 'logout' => ['application/json'], 'register' => ['application/json'], 'requestPasswordReset' => ['application/json'], 'requestValidationEmail' => ['application/json'], 'saveSettings' => ['application/json'], 'signOutOtherSessions' => ['application/json'], 'validateEmailAddress' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

changePassword()

Operation changePassword


    public
                    changePassword(ChangePasswordRequest $change_password_request[, string $contentType = self::contentTypes['changePassword'][0] ]) : AuthResult|ErrorResponse

Change the password

Parameters

$change_password_request : ChangePasswordRequest: change_password_request (required)
$contentType : string = self::contentTypes['changePassword'][0]: The value for the Content-Type header. Check self::contentTypes['changePassword'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

changePasswordAsync()

Operation changePasswordAsync


    public
                    changePasswordAsync(ChangePasswordRequest $change_password_request[, string $contentType = self::contentTypes['changePassword'][0] ]) : PromiseInterface

Change the password

Parameters

$change_password_request : ChangePasswordRequest: (required)
$contentType : string = self::contentTypes['changePassword'][0]: The value for the Content-Type header. Check self::contentTypes['changePassword'] to see the possible values for this operation

Return values

PromiseInterface

changePasswordAsyncWithHttpInfo()

Operation changePasswordAsyncWithHttpInfo


    public
                    changePasswordAsyncWithHttpInfo(ChangePasswordRequest $change_password_request[, string $contentType = self::contentTypes['changePassword'][0] ]) : PromiseInterface

Change the password

Parameters

$change_password_request : ChangePasswordRequest: (required)
$contentType : string = self::contentTypes['changePassword'][0]: The value for the Content-Type header. Check self::contentTypes['changePassword'] to see the possible values for this operation

Return values

PromiseInterface

changePasswordRequest()

Create request for operation 'changePassword'


    public
                    changePasswordRequest(ChangePasswordRequest $change_password_request[, string $contentType = self::contentTypes['changePassword'][0] ]) : Request

Parameters

$change_password_request : ChangePasswordRequest: (required)
$contentType : string = self::contentTypes['changePassword'][0]: The value for the Content-Type header. Check self::contentTypes['changePassword'] to see the possible values for this operation

Return values

Request

changePasswordWithHttpInfo()

Operation changePasswordWithHttpInfo


    public
                    changePasswordWithHttpInfo(ChangePasswordRequest $change_password_request[, string $contentType = self::contentTypes['changePassword'][0] ]) : array<string|int, mixed>

Change the password

Parameters

$change_password_request : ChangePasswordRequest: (required)
$contentType : string = self::contentTypes['changePassword'][0]: The value for the Content-Type header. Check self::contentTypes['changePassword'] to see the possible values for this operation

Return values

array<string|int, mixed> —

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getSettings()

Operation getSettings


    public
                    getSettings([string $contentType = self::contentTypes['getSettings'][0] ]) : AccountSettings|ErrorResponse

Read the account settings

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

AccountSettings|ErrorResponse

getSettingsAsync()

Operation getSettingsAsync


    public
                    getSettingsAsync([string $contentType = self::contentTypes['getSettings'][0] ]) : PromiseInterface

Read the account settings

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

PromiseInterface

getSettingsAsyncWithHttpInfo()

Operation getSettingsAsyncWithHttpInfo


    public
                    getSettingsAsyncWithHttpInfo([string $contentType = self::contentTypes['getSettings'][0] ]) : PromiseInterface

Read the account settings

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

PromiseInterface

getSettingsRequest()

Create request for operation 'getSettings'


    public
                    getSettingsRequest([string $contentType = self::contentTypes['getSettings'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

Request

getSettingsWithHttpInfo()

Operation getSettingsWithHttpInfo


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

Read the account settings

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

array<string|int, mixed> —

listReferenceValues()

Operation listReferenceValues


    public
                    listReferenceValues(ListReferenceValuesRequest $list_reference_values_request[, string $contentType = self::contentTypes['listReferenceValues'][0] ]) : array<string|int, ReferenceValue>|ErrorResponse

The values of the settings form

Parameters

$list_reference_values_request : ListReferenceValuesRequest: list_reference_values_request (required)
$contentType : string = self::contentTypes['listReferenceValues'][0]: The value for the Content-Type header. Check self::contentTypes['listReferenceValues'] to see the possible values for this operation

Return values

array<string|int, ReferenceValue>|ErrorResponse

listReferenceValuesAsync()

Operation listReferenceValuesAsync


    public
                    listReferenceValuesAsync(ListReferenceValuesRequest $list_reference_values_request[, string $contentType = self::contentTypes['listReferenceValues'][0] ]) : PromiseInterface

The values of the settings form

Parameters

$list_reference_values_request : ListReferenceValuesRequest: (required)
$contentType : string = self::contentTypes['listReferenceValues'][0]: The value for the Content-Type header. Check self::contentTypes['listReferenceValues'] to see the possible values for this operation

Return values

PromiseInterface

listReferenceValuesAsyncWithHttpInfo()

Operation listReferenceValuesAsyncWithHttpInfo


    public
                    listReferenceValuesAsyncWithHttpInfo(ListReferenceValuesRequest $list_reference_values_request[, string $contentType = self::contentTypes['listReferenceValues'][0] ]) : PromiseInterface

The values of the settings form

Parameters

$list_reference_values_request : ListReferenceValuesRequest: (required)
$contentType : string = self::contentTypes['listReferenceValues'][0]: The value for the Content-Type header. Check self::contentTypes['listReferenceValues'] to see the possible values for this operation

Return values

PromiseInterface

listReferenceValuesRequest()

Create request for operation 'listReferenceValues'


    public
                    listReferenceValuesRequest(ListReferenceValuesRequest $list_reference_values_request[, string $contentType = self::contentTypes['listReferenceValues'][0] ]) : Request

Parameters

$list_reference_values_request : ListReferenceValuesRequest: (required)
$contentType : string = self::contentTypes['listReferenceValues'][0]: The value for the Content-Type header. Check self::contentTypes['listReferenceValues'] to see the possible values for this operation

Return values

Request

listReferenceValuesWithHttpInfo()

Operation listReferenceValuesWithHttpInfo


    public
                    listReferenceValuesWithHttpInfo(ListReferenceValuesRequest $list_reference_values_request[, string $contentType = self::contentTypes['listReferenceValues'][0] ]) : array<string|int, mixed>

The values of the settings form

Parameters

$list_reference_values_request : ListReferenceValuesRequest: (required)
$contentType : string = self::contentTypes['listReferenceValues'][0]: The value for the Content-Type header. Check self::contentTypes['listReferenceValues'] to see the possible values for this operation

Return values

array<string|int, mixed> —

logout()

Operation logout


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

Record a sign-out

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

logoutAsync()

Operation logoutAsync


    public
                    logoutAsync([string $contentType = self::contentTypes['logout'][0] ]) : PromiseInterface

Record a sign-out

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

PromiseInterface

logoutAsyncWithHttpInfo()

Operation logoutAsyncWithHttpInfo


    public
                    logoutAsyncWithHttpInfo([string $contentType = self::contentTypes['logout'][0] ]) : PromiseInterface

Record a sign-out

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

PromiseInterface

logoutRequest()

Create request for operation 'logout'


    public
                    logoutRequest([string $contentType = self::contentTypes['logout'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

Request

logoutWithHttpInfo()

Operation logoutWithHttpInfo


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

Record a sign-out

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

register()

Operation register


    public
                    register(RegisterRequest $register_request[, string $contentType = self::contentTypes['register'][0] ]) : void

Parameters

$register_request : RegisterRequest: register_request (required)
$contentType : string = self::contentTypes['register'][0]: The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

registerAsync()

Operation registerAsync


    public
                    registerAsync(RegisterRequest $register_request[, string $contentType = self::contentTypes['register'][0] ]) : PromiseInterface

Parameters

$register_request : RegisterRequest: (required)
$contentType : string = self::contentTypes['register'][0]: The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Return values

PromiseInterface

registerAsyncWithHttpInfo()

Operation registerAsyncWithHttpInfo


    public
                    registerAsyncWithHttpInfo(RegisterRequest $register_request[, string $contentType = self::contentTypes['register'][0] ]) : PromiseInterface

Parameters

$register_request : RegisterRequest: (required)
$contentType : string = self::contentTypes['register'][0]: The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Return values

PromiseInterface

registerRequest()

Create request for operation 'register'


    public
                    registerRequest(RegisterRequest $register_request[, string $contentType = self::contentTypes['register'][0] ]) : Request

Parameters

$register_request : RegisterRequest: (required)
$contentType : string = self::contentTypes['register'][0]: The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Return values

Request

registerWithHttpInfo()

Operation registerWithHttpInfo


    public
                    registerWithHttpInfo(RegisterRequest $register_request[, string $contentType = self::contentTypes['register'][0] ]) : array<string|int, mixed>

Parameters

$register_request : RegisterRequest: (required)
$contentType : string = self::contentTypes['register'][0]: The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

requestPasswordReset()

Operation requestPasswordReset


    public
                    requestPasswordReset(RequestPasswordResetRequest $request_password_reset_request[, string $contentType = self::contentTypes['requestPasswordReset'][0] ]) : void

Send a password reset e-mail

Parameters

$request_password_reset_request : RequestPasswordResetRequest: request_password_reset_request (required)
$contentType : string = self::contentTypes['requestPasswordReset'][0]: The value for the Content-Type header. Check self::contentTypes['requestPasswordReset'] to see the possible values for this operation

requestPasswordResetAsync()

Operation requestPasswordResetAsync


    public
                    requestPasswordResetAsync(RequestPasswordResetRequest $request_password_reset_request[, string $contentType = self::contentTypes['requestPasswordReset'][0] ]) : PromiseInterface

Send a password reset e-mail

Parameters

$request_password_reset_request : RequestPasswordResetRequest: (required)
$contentType : string = self::contentTypes['requestPasswordReset'][0]: The value for the Content-Type header. Check self::contentTypes['requestPasswordReset'] to see the possible values for this operation

Return values

PromiseInterface

requestPasswordResetAsyncWithHttpInfo()

Operation requestPasswordResetAsyncWithHttpInfo


    public
                    requestPasswordResetAsyncWithHttpInfo(RequestPasswordResetRequest $request_password_reset_request[, string $contentType = self::contentTypes['requestPasswordReset'][0] ]) : PromiseInterface

Send a password reset e-mail

Parameters

$request_password_reset_request : RequestPasswordResetRequest: (required)
$contentType : string = self::contentTypes['requestPasswordReset'][0]: The value for the Content-Type header. Check self::contentTypes['requestPasswordReset'] to see the possible values for this operation

Return values

PromiseInterface

requestPasswordResetRequest()

Create request for operation 'requestPasswordReset'


    public
                    requestPasswordResetRequest(RequestPasswordResetRequest $request_password_reset_request[, string $contentType = self::contentTypes['requestPasswordReset'][0] ]) : Request

Parameters

$request_password_reset_request : RequestPasswordResetRequest: (required)
$contentType : string = self::contentTypes['requestPasswordReset'][0]: The value for the Content-Type header. Check self::contentTypes['requestPasswordReset'] to see the possible values for this operation

Return values

Request

requestPasswordResetWithHttpInfo()

Operation requestPasswordResetWithHttpInfo


    public
                    requestPasswordResetWithHttpInfo(RequestPasswordResetRequest $request_password_reset_request[, string $contentType = self::contentTypes['requestPasswordReset'][0] ]) : array<string|int, mixed>

Send a password reset e-mail

Parameters

$request_password_reset_request : RequestPasswordResetRequest: (required)
$contentType : string = self::contentTypes['requestPasswordReset'][0]: The value for the Content-Type header. Check self::contentTypes['requestPasswordReset'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

requestValidationEmail()

Operation requestValidationEmail


    public
                    requestValidationEmail(RequestValidationEmailRequest $request_validation_email_request[, string $contentType = self::contentTypes['requestValidationEmail'][0] ]) : void

Send a new validation e-mail

Parameters

$request_validation_email_request : RequestValidationEmailRequest: request_validation_email_request (required)
$contentType : string = self::contentTypes['requestValidationEmail'][0]: The value for the Content-Type header. Check self::contentTypes['requestValidationEmail'] to see the possible values for this operation

requestValidationEmailAsync()

Operation requestValidationEmailAsync


    public
                    requestValidationEmailAsync(RequestValidationEmailRequest $request_validation_email_request[, string $contentType = self::contentTypes['requestValidationEmail'][0] ]) : PromiseInterface

Send a new validation e-mail

Parameters

$request_validation_email_request : RequestValidationEmailRequest: (required)
$contentType : string = self::contentTypes['requestValidationEmail'][0]: The value for the Content-Type header. Check self::contentTypes['requestValidationEmail'] to see the possible values for this operation

Return values

PromiseInterface

requestValidationEmailAsyncWithHttpInfo()

Operation requestValidationEmailAsyncWithHttpInfo


    public
                    requestValidationEmailAsyncWithHttpInfo(RequestValidationEmailRequest $request_validation_email_request[, string $contentType = self::contentTypes['requestValidationEmail'][0] ]) : PromiseInterface

Send a new validation e-mail

Parameters

$request_validation_email_request : RequestValidationEmailRequest: (required)
$contentType : string = self::contentTypes['requestValidationEmail'][0]: The value for the Content-Type header. Check self::contentTypes['requestValidationEmail'] to see the possible values for this operation

Return values

PromiseInterface

requestValidationEmailRequest()

Create request for operation 'requestValidationEmail'


    public
                    requestValidationEmailRequest(RequestValidationEmailRequest $request_validation_email_request[, string $contentType = self::contentTypes['requestValidationEmail'][0] ]) : Request

Parameters

$request_validation_email_request : RequestValidationEmailRequest: (required)
$contentType : string = self::contentTypes['requestValidationEmail'][0]: The value for the Content-Type header. Check self::contentTypes['requestValidationEmail'] to see the possible values for this operation

Return values

Request

requestValidationEmailWithHttpInfo()

Operation requestValidationEmailWithHttpInfo


    public
                    requestValidationEmailWithHttpInfo(RequestValidationEmailRequest $request_validation_email_request[, string $contentType = self::contentTypes['requestValidationEmail'][0] ]) : array<string|int, mixed>

Send a new validation e-mail

Parameters

$request_validation_email_request : RequestValidationEmailRequest: (required)
$contentType : string = self::contentTypes['requestValidationEmail'][0]: The value for the Content-Type header. Check self::contentTypes['requestValidationEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

saveSettings()

Operation saveSettings


    public
                    saveSettings(AccountSettings $account_settings[, string $contentType = self::contentTypes['saveSettings'][0] ]) : void

Change the account settings

Parameters

$account_settings : AccountSettings: account_settings (required)
$contentType : string = self::contentTypes['saveSettings'][0]: The value for the Content-Type header. Check self::contentTypes['saveSettings'] to see the possible values for this operation

saveSettingsAsync()

Operation saveSettingsAsync


    public
                    saveSettingsAsync(AccountSettings $account_settings[, string $contentType = self::contentTypes['saveSettings'][0] ]) : PromiseInterface

Change the account settings

Parameters

$account_settings : AccountSettings: (required)
$contentType : string = self::contentTypes['saveSettings'][0]: The value for the Content-Type header. Check self::contentTypes['saveSettings'] to see the possible values for this operation

Return values

PromiseInterface

saveSettingsAsyncWithHttpInfo()

Operation saveSettingsAsyncWithHttpInfo


    public
                    saveSettingsAsyncWithHttpInfo(AccountSettings $account_settings[, string $contentType = self::contentTypes['saveSettings'][0] ]) : PromiseInterface

Change the account settings

Parameters

$account_settings : AccountSettings: (required)
$contentType : string = self::contentTypes['saveSettings'][0]: The value for the Content-Type header. Check self::contentTypes['saveSettings'] to see the possible values for this operation

Return values

PromiseInterface

saveSettingsRequest()

Create request for operation 'saveSettings'


    public
                    saveSettingsRequest(AccountSettings $account_settings[, string $contentType = self::contentTypes['saveSettings'][0] ]) : Request

Parameters

$account_settings : AccountSettings: (required)
$contentType : string = self::contentTypes['saveSettings'][0]: The value for the Content-Type header. Check self::contentTypes['saveSettings'] to see the possible values for this operation

Return values

Request

saveSettingsWithHttpInfo()

Operation saveSettingsWithHttpInfo


    public
                    saveSettingsWithHttpInfo(AccountSettings $account_settings[, string $contentType = self::contentTypes['saveSettings'][0] ]) : array<string|int, mixed>

Change the account settings

Parameters

$account_settings : AccountSettings: (required)
$contentType : string = self::contentTypes['saveSettings'][0]: The value for the Content-Type header. Check self::contentTypes['saveSettings'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, 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)

signOutOtherSessions()

Operation signOutOtherSessions


    public
                    signOutOtherSessions([SignOutOtherSessionsRequest|null $sign_out_other_sessions_request = null ][, string $contentType = self::contentTypes['signOutOtherSessions'][0] ]) : AuthResult|ErrorResponse

Sign out every other session

Parameters

$sign_out_other_sessions_request : SignOutOtherSessionsRequest|null = null: sign_out_other_sessions_request (optional)
$contentType : string = self::contentTypes['signOutOtherSessions'][0]: The value for the Content-Type header. Check self::contentTypes['signOutOtherSessions'] to see the possible values for this operation

Return values

AuthResult|ErrorResponse

signOutOtherSessionsAsync()

Operation signOutOtherSessionsAsync


    public
                    signOutOtherSessionsAsync([SignOutOtherSessionsRequest|null $sign_out_other_sessions_request = null ][, string $contentType = self::contentTypes['signOutOtherSessions'][0] ]) : PromiseInterface

Sign out every other session

Parameters

$sign_out_other_sessions_request : SignOutOtherSessionsRequest|null = null: (optional)
$contentType : string = self::contentTypes['signOutOtherSessions'][0]: The value for the Content-Type header. Check self::contentTypes['signOutOtherSessions'] to see the possible values for this operation

Return values

PromiseInterface

signOutOtherSessionsAsyncWithHttpInfo()

Operation signOutOtherSessionsAsyncWithHttpInfo


    public
                    signOutOtherSessionsAsyncWithHttpInfo([SignOutOtherSessionsRequest|null $sign_out_other_sessions_request = null ][, string $contentType = self::contentTypes['signOutOtherSessions'][0] ]) : PromiseInterface

Sign out every other session

Parameters

$sign_out_other_sessions_request : SignOutOtherSessionsRequest|null = null: (optional)
$contentType : string = self::contentTypes['signOutOtherSessions'][0]: The value for the Content-Type header. Check self::contentTypes['signOutOtherSessions'] to see the possible values for this operation

Return values

PromiseInterface

signOutOtherSessionsRequest()

Create request for operation 'signOutOtherSessions'


    public
                    signOutOtherSessionsRequest([SignOutOtherSessionsRequest|null $sign_out_other_sessions_request = null ][, string $contentType = self::contentTypes['signOutOtherSessions'][0] ]) : Request

Parameters

$sign_out_other_sessions_request : SignOutOtherSessionsRequest|null = null: (optional)
$contentType : string = self::contentTypes['signOutOtherSessions'][0]: The value for the Content-Type header. Check self::contentTypes['signOutOtherSessions'] to see the possible values for this operation

Return values

Request

signOutOtherSessionsWithHttpInfo()

Operation signOutOtherSessionsWithHttpInfo


    public
                    signOutOtherSessionsWithHttpInfo([SignOutOtherSessionsRequest|null $sign_out_other_sessions_request = null ][, string $contentType = self::contentTypes['signOutOtherSessions'][0] ]) : array<string|int, mixed>

Sign out every other session

Parameters

$sign_out_other_sessions_request : SignOutOtherSessionsRequest|null = null: (optional)
$contentType : string = self::contentTypes['signOutOtherSessions'][0]: The value for the Content-Type header. Check self::contentTypes['signOutOtherSessions'] to see the possible values for this operation

Return values

array<string|int, mixed> —

validateEmailAddress()

Operation validateEmailAddress


    public
                    validateEmailAddress(ValidateEmailAddressRequest $validate_email_address_request[, string $contentType = self::contentTypes['validateEmailAddress'][0] ]) : void

Confirm an e-mail address and set the password

Parameters

$validate_email_address_request : ValidateEmailAddressRequest: validate_email_address_request (required)
$contentType : string = self::contentTypes['validateEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmailAddress'] to see the possible values for this operation

validateEmailAddressAsync()

Operation validateEmailAddressAsync


    public
                    validateEmailAddressAsync(ValidateEmailAddressRequest $validate_email_address_request[, string $contentType = self::contentTypes['validateEmailAddress'][0] ]) : PromiseInterface

Confirm an e-mail address and set the password

Parameters

$validate_email_address_request : ValidateEmailAddressRequest: (required)
$contentType : string = self::contentTypes['validateEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmailAddress'] to see the possible values for this operation

Return values

PromiseInterface

validateEmailAddressAsyncWithHttpInfo()

Operation validateEmailAddressAsyncWithHttpInfo


    public
                    validateEmailAddressAsyncWithHttpInfo(ValidateEmailAddressRequest $validate_email_address_request[, string $contentType = self::contentTypes['validateEmailAddress'][0] ]) : PromiseInterface

Confirm an e-mail address and set the password

Parameters

$validate_email_address_request : ValidateEmailAddressRequest: (required)
$contentType : string = self::contentTypes['validateEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmailAddress'] to see the possible values for this operation

Return values

PromiseInterface

validateEmailAddressRequest()

Create request for operation 'validateEmailAddress'


    public
                    validateEmailAddressRequest(ValidateEmailAddressRequest $validate_email_address_request[, string $contentType = self::contentTypes['validateEmailAddress'][0] ]) : Request

Parameters

$validate_email_address_request : ValidateEmailAddressRequest: (required)
$contentType : string = self::contentTypes['validateEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmailAddress'] to see the possible values for this operation

Return values

Request

validateEmailAddressWithHttpInfo()

Operation validateEmailAddressWithHttpInfo


    public
                    validateEmailAddressWithHttpInfo(ValidateEmailAddressRequest $validate_email_address_request[, string $contentType = self::contentTypes['validateEmailAddress'][0] ]) : array<string|int, mixed>

Confirm an e-mail address and set the password

Parameters

$validate_email_address_request : ValidateEmailAddressRequest: (required)
$contentType : string = self::contentTypes['validateEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmailAddress'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

AccountApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

changePassword()

Parameters

Tags

Return values

changePasswordAsync()

Parameters

Tags

Return values

changePasswordAsyncWithHttpInfo()

Parameters

Tags

Return values

changePasswordRequest()

Parameters

Tags

Return values

changePasswordWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

getSettings()

Parameters

Tags

Return values

getSettingsAsync()

Parameters

Tags

Return values

getSettingsAsyncWithHttpInfo()

Parameters

Tags

Return values

getSettingsRequest()

Parameters

Tags

Return values

getSettingsWithHttpInfo()

Parameters

Tags

Return values

listReferenceValues()

Parameters

Tags

Return values

listReferenceValuesAsync()

Parameters

Tags

Return values

listReferenceValuesAsyncWithHttpInfo()

Parameters

Tags

Return values

listReferenceValuesRequest()

Parameters

Tags

Return values

listReferenceValuesWithHttpInfo()

Parameters

Tags

Return values

AccountApi
in package

BIMworks