Documentation

AuthApi
in package

BIMworks

AuthApi Class Doc Comment

Constants

contentTypes = ['createNodesToken' => ['application/json'], 'createRecursiveNodeToken' => ['application/json'], 'createVersionsToken' => ['application/json'], 'loginWithApiToken' => ['application/json'], 'loginWithUsernamePassword' => ['application/json']]

Properties

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

Methods

__construct() : mixed
createNodesToken() : Auth|ErrorResponse: Operation createNodesToken
createNodesTokenAsync() : PromiseInterface: Operation createNodesTokenAsync
createNodesTokenAsyncWithHttpInfo() : PromiseInterface: Operation createNodesTokenAsyncWithHttpInfo
createNodesTokenRequest() : Request: Create request for operation 'createNodesToken'
createNodesTokenWithHttpInfo() : array<string|int, mixed>: Operation createNodesTokenWithHttpInfo
createRecursiveNodeToken() : Auth|ErrorResponse: Operation createRecursiveNodeToken
createRecursiveNodeTokenAsync() : PromiseInterface: Operation createRecursiveNodeTokenAsync
createRecursiveNodeTokenAsyncWithHttpInfo() : PromiseInterface: Operation createRecursiveNodeTokenAsyncWithHttpInfo
createRecursiveNodeTokenRequest() : Request: Create request for operation 'createRecursiveNodeToken'
createRecursiveNodeTokenWithHttpInfo() : array<string|int, mixed>: Operation createRecursiveNodeTokenWithHttpInfo
createVersionsToken() : Auth|ErrorResponse: Operation createVersionsToken
createVersionsTokenAsync() : PromiseInterface: Operation createVersionsTokenAsync
createVersionsTokenAsyncWithHttpInfo() : PromiseInterface: Operation createVersionsTokenAsyncWithHttpInfo
createVersionsTokenRequest() : Request: Create request for operation 'createVersionsToken'
createVersionsTokenWithHttpInfo() : array<string|int, mixed>: Operation createVersionsTokenWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
loginWithApiToken() : string|ErrorResponse: Operation loginWithApiToken
loginWithApiTokenAsync() : PromiseInterface: Operation loginWithApiTokenAsync
loginWithApiTokenAsyncWithHttpInfo() : PromiseInterface: Operation loginWithApiTokenAsyncWithHttpInfo
loginWithApiTokenRequest() : Request: Create request for operation 'loginWithApiToken'
loginWithApiTokenWithHttpInfo() : array<string|int, mixed>: Operation loginWithApiTokenWithHttpInfo
loginWithUsernamePassword() : LoginWithUsernamePassword200Response|ErrorResponse: Operation loginWithUsernamePassword
loginWithUsernamePasswordAsync() : PromiseInterface: Operation loginWithUsernamePasswordAsync
loginWithUsernamePasswordAsyncWithHttpInfo() : PromiseInterface: Operation loginWithUsernamePasswordAsyncWithHttpInfo
loginWithUsernamePasswordRequest() : Request: Create request for operation 'loginWithUsernamePassword'
loginWithUsernamePasswordWithHttpInfo() : array<string|int, mixed>: Operation loginWithUsernamePasswordWithHttpInfo
setHostIndex() : void: Set the host index
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createNodesToken' => ['application/json'], 'createRecursiveNodeToken' => ['application/json'], 'createVersionsToken' => ['application/json'], 'loginWithApiToken' => ['application/json'], 'loginWithUsernamePassword' => ['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

createNodesToken()

Operation createNodesToken


    public
                    createNodesToken(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : Auth|ErrorResponse

Create a new token, based on a set of Nodes

Parameters

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

Return values

Auth|ErrorResponse

createNodesTokenAsync()

Operation createNodesTokenAsync


    public
                    createNodesTokenAsync(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Nodes

Parameters

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

Return values

PromiseInterface

createNodesTokenAsyncWithHttpInfo()

Operation createNodesTokenAsyncWithHttpInfo


    public
                    createNodesTokenAsyncWithHttpInfo(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Nodes

Parameters

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

Return values

PromiseInterface

createNodesTokenRequest()

Create request for operation 'createNodesToken'


    public
                    createNodesTokenRequest(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : Request

Parameters

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

Return values

Request

createNodesTokenWithHttpInfo()

Operation createNodesTokenWithHttpInfo


    public
                    createNodesTokenWithHttpInfo(CreateNodesTokenRequest $create_nodes_token_request[, string $contentType = self::contentTypes['createNodesToken'][0] ]) : array<string|int, mixed>

Create a new token, based on a set of Nodes

Parameters

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

Return values

array<string|int, mixed> —

of \BIMworks\Model\Auth|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

createRecursiveNodeToken()

Operation createRecursiveNodeToken


    public
                    createRecursiveNodeToken(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : Auth|ErrorResponse

Create a new token, based on a Node

Parameters

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

Return values

Auth|ErrorResponse

createRecursiveNodeTokenAsync()

Operation createRecursiveNodeTokenAsync


    public
                    createRecursiveNodeTokenAsync(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : PromiseInterface

Create a new token, based on a Node

Parameters

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

Return values

PromiseInterface

createRecursiveNodeTokenAsyncWithHttpInfo()

Operation createRecursiveNodeTokenAsyncWithHttpInfo


    public
                    createRecursiveNodeTokenAsyncWithHttpInfo(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : PromiseInterface

Create a new token, based on a Node

Parameters

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

Return values

PromiseInterface

createRecursiveNodeTokenRequest()

Create request for operation 'createRecursiveNodeToken'


    public
                    createRecursiveNodeTokenRequest(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : Request

Parameters

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

Return values

Request

createRecursiveNodeTokenWithHttpInfo()

Operation createRecursiveNodeTokenWithHttpInfo


    public
                    createRecursiveNodeTokenWithHttpInfo(CreateRecursiveNodeTokenRequest $create_recursive_node_token_request[, string $contentType = self::contentTypes['createRecursiveNodeToken'][0] ]) : array<string|int, mixed>

Create a new token, based on a Node

Parameters

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

Return values

array<string|int, mixed> —

of \BIMworks\Model\Auth|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

createVersionsToken()

Operation createVersionsToken


    public
                    createVersionsToken(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : Auth|ErrorResponse

Create a new token, based on a set of Versions

Parameters

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

Return values

Auth|ErrorResponse

createVersionsTokenAsync()

Operation createVersionsTokenAsync


    public
                    createVersionsTokenAsync(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Versions

Parameters

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

Return values

PromiseInterface

createVersionsTokenAsyncWithHttpInfo()

Operation createVersionsTokenAsyncWithHttpInfo


    public
                    createVersionsTokenAsyncWithHttpInfo(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : PromiseInterface

Create a new token, based on a set of Versions

Parameters

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

Return values

PromiseInterface

createVersionsTokenRequest()

Create request for operation 'createVersionsToken'


    public
                    createVersionsTokenRequest(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : Request

Parameters

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

Return values

Request

createVersionsTokenWithHttpInfo()

Operation createVersionsTokenWithHttpInfo


    public
                    createVersionsTokenWithHttpInfo(CreateVersionsTokenRequest $create_versions_token_request[, string $contentType = self::contentTypes['createVersionsToken'][0] ]) : array<string|int, mixed>

Create a new token, based on a set of Versions

Parameters

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

Return values

array<string|int, mixed> —

of \BIMworks\Model\Auth|\BIMworks\Model\ErrorResponse, 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

loginWithApiToken()

Operation loginWithApiToken


    public
                    loginWithApiToken(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : string|ErrorResponse

Parameters

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

Return values

string|ErrorResponse

loginWithApiTokenAsync()

Operation loginWithApiTokenAsync


    public
                    loginWithApiTokenAsync(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface

loginWithApiTokenAsyncWithHttpInfo()

Operation loginWithApiTokenAsyncWithHttpInfo


    public
                    loginWithApiTokenAsyncWithHttpInfo(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface

loginWithApiTokenRequest()

Create request for operation 'loginWithApiToken'


    public
                    loginWithApiTokenRequest(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : Request

Parameters

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

Return values

Request

loginWithApiTokenWithHttpInfo()

Operation loginWithApiTokenWithHttpInfo


    public
                    loginWithApiTokenWithHttpInfo(LoginWithApiTokenRequest $login_with_api_token_request[, string $contentType = self::contentTypes['loginWithApiToken'][0] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed> —

of string|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

loginWithUsernamePassword()

Operation loginWithUsernamePassword


    public
                    loginWithUsernamePassword(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : LoginWithUsernamePassword200Response|ErrorResponse

Parameters

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

Return values

LoginWithUsernamePassword200Response|ErrorResponse

loginWithUsernamePasswordAsync()

Operation loginWithUsernamePasswordAsync


    public
                    loginWithUsernamePasswordAsync(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface

loginWithUsernamePasswordAsyncWithHttpInfo()

Operation loginWithUsernamePasswordAsyncWithHttpInfo


    public
                    loginWithUsernamePasswordAsyncWithHttpInfo(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : PromiseInterface

Parameters

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

Return values

PromiseInterface

loginWithUsernamePasswordRequest()

Create request for operation 'loginWithUsernamePassword'


    public
                    loginWithUsernamePasswordRequest(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : Request

Parameters

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

Return values

Request

loginWithUsernamePasswordWithHttpInfo()

Operation loginWithUsernamePasswordWithHttpInfo


    public
                    loginWithUsernamePasswordWithHttpInfo(LoginWithUsernamePasswordRequest $login_with_username_password_request[, string $contentType = self::contentTypes['loginWithUsernamePassword'][0] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed> —

of \BIMworks\Model\LoginWithUsernamePassword200Response|\BIMworks\Model\ErrorResponse, 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)

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

AuthApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createNodesToken()

Parameters

Tags

Return values

createNodesTokenAsync()

Parameters

Tags

Return values

createNodesTokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createNodesTokenRequest()

Parameters

Tags

Return values

createNodesTokenWithHttpInfo()

Parameters

Tags

Return values

createRecursiveNodeToken()

Parameters

Tags

Return values

createRecursiveNodeTokenAsync()

Parameters

Tags

Return values

createRecursiveNodeTokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createRecursiveNodeTokenRequest()

Parameters

Tags

Return values

createRecursiveNodeTokenWithHttpInfo()

Parameters

Tags

Return values

createVersionsToken()

Parameters

Tags

Return values

createVersionsTokenAsync()

Parameters

Tags

Return values

createVersionsTokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createVersionsTokenRequest()

Parameters

Tags

Return values

createVersionsTokenWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

AuthApi
in package

BIMworks