Documentation

FsApi
in package

FsApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  = ['createNode' => ['application/json'], 'getNode' => ['application/json'], 'getRootNodeUuid' => ['application/json'], 'getVersion' => ['application/json'], 'listNodes' => ['application/json'], 'listVersions' => ['application/json'], 'updateNode' => ['application/json']]

Properties

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

Methods

__construct()  : mixed
createNode()  : Node|ErrorResponse
Operation createNode
createNodeAsync()  : PromiseInterface
Operation createNodeAsync
createNodeAsyncWithHttpInfo()  : PromiseInterface
Operation createNodeAsyncWithHttpInfo
createNodeRequest()  : Request
Create request for operation 'createNode'
createNodeWithHttpInfo()  : array<string|int, mixed>
Operation createNodeWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getNode()  : Node|ErrorResponse
Operation getNode
getNodeAsync()  : PromiseInterface
Operation getNodeAsync
getNodeAsyncWithHttpInfo()  : PromiseInterface
Operation getNodeAsyncWithHttpInfo
getNodeRequest()  : Request
Create request for operation 'getNode'
getNodeWithHttpInfo()  : array<string|int, mixed>
Operation getNodeWithHttpInfo
getRootNodeUuid()  : string|ErrorResponse
Operation getRootNodeUuid
getRootNodeUuidAsync()  : PromiseInterface
Operation getRootNodeUuidAsync
getRootNodeUuidAsyncWithHttpInfo()  : PromiseInterface
Operation getRootNodeUuidAsyncWithHttpInfo
getRootNodeUuidRequest()  : Request
Create request for operation 'getRootNodeUuid'
getRootNodeUuidWithHttpInfo()  : array<string|int, mixed>
Operation getRootNodeUuidWithHttpInfo
getVersion()  : Version|ErrorResponse
Operation getVersion
getVersionAsync()  : PromiseInterface
Operation getVersionAsync
getVersionAsyncWithHttpInfo()  : PromiseInterface
Operation getVersionAsyncWithHttpInfo
getVersionRequest()  : Request
Create request for operation 'getVersion'
getVersionWithHttpInfo()  : array<string|int, mixed>
Operation getVersionWithHttpInfo
listNodes()  : array<string|int, Node>|ErrorResponse
Operation listNodes
listNodesAsync()  : PromiseInterface
Operation listNodesAsync
listNodesAsyncWithHttpInfo()  : PromiseInterface
Operation listNodesAsyncWithHttpInfo
listNodesRequest()  : Request
Create request for operation 'listNodes'
listNodesWithHttpInfo()  : array<string|int, mixed>
Operation listNodesWithHttpInfo
listVersions()  : array<string|int, Version>|ErrorResponse
Operation listVersions
listVersionsAsync()  : PromiseInterface
Operation listVersionsAsync
listVersionsAsyncWithHttpInfo()  : PromiseInterface
Operation listVersionsAsyncWithHttpInfo
listVersionsRequest()  : Request
Create request for operation 'listVersions'
listVersionsWithHttpInfo()  : array<string|int, mixed>
Operation listVersionsWithHttpInfo
setHostIndex()  : void
Set the host index
updateNode()  : Node|ErrorResponse
Operation updateNode
updateNodeAsync()  : PromiseInterface
Operation updateNodeAsync
updateNodeAsyncWithHttpInfo()  : PromiseInterface
Operation updateNodeAsyncWithHttpInfo
updateNodeRequest()  : Request
Create request for operation 'updateNode'
updateNodeWithHttpInfo()  : array<string|int, mixed>
Operation updateNodeWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

public array<string|int, string> contentTypes = ['createNode' => ['application/json'], 'getNode' => ['application/json'], 'getRootNodeUuid' => ['application/json'], 'getVersion' => ['application/json'], 'listNodes' => ['application/json'], 'listVersions' => ['application/json'], 'updateNode' => ['application/json']]

Properties

$client

protected ClientInterface $client

$hostIndex

protected int $hostIndex

Host index

Methods

__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

createNode()

Operation createNode

public createNode(CreateNodeRequest $create_node_request[, string $contentType = self::contentTypes['createNode'][0] ]) : Node|ErrorResponse

Create a new Node

Parameters
$create_node_request : CreateNodeRequest

create_node_request (required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
Node|ErrorResponse

createNodeAsync()

Operation createNodeAsync

public createNodeAsync(CreateNodeRequest $create_node_request[, string $contentType = self::contentTypes['createNode'][0] ]) : PromiseInterface

Create a new Node

Parameters
$create_node_request : CreateNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createNodeAsyncWithHttpInfo()

Operation createNodeAsyncWithHttpInfo

public createNodeAsyncWithHttpInfo(CreateNodeRequest $create_node_request[, string $contentType = self::contentTypes['createNode'][0] ]) : PromiseInterface

Create a new Node

Parameters
$create_node_request : CreateNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createNodeRequest()

Create request for operation 'createNode'

public createNodeRequest(CreateNodeRequest $create_node_request[, string $contentType = self::contentTypes['createNode'][0] ]) : Request
Parameters
$create_node_request : CreateNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

createNodeWithHttpInfo()

Operation createNodeWithHttpInfo

public createNodeWithHttpInfo(CreateNodeRequest $create_node_request[, string $contentType = self::contentTypes['createNode'][0] ]) : array<string|int, mixed>

Create a new Node

Parameters
$create_node_request : CreateNodeRequest

(required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

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

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

getNode()

Operation getNode

public getNode(GetNodeRequest $get_node_request[, string $contentType = self::contentTypes['getNode'][0] ]) : Node|ErrorResponse

Get Node based on a given path or by its UUID or by it Version's UUID. A path is always relative to the Root Node of the used Token.

Parameters
$get_node_request : GetNodeRequest

get_node_request (required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
Node|ErrorResponse

getNodeAsync()

Operation getNodeAsync

public getNodeAsync(GetNodeRequest $get_node_request[, string $contentType = self::contentTypes['getNode'][0] ]) : PromiseInterface

Get Node based on a given path or by its UUID or by it Version's UUID. A path is always relative to the Root Node of the used Token.

Parameters
$get_node_request : GetNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNodeAsyncWithHttpInfo()

Operation getNodeAsyncWithHttpInfo

public getNodeAsyncWithHttpInfo(GetNodeRequest $get_node_request[, string $contentType = self::contentTypes['getNode'][0] ]) : PromiseInterface

Get Node based on a given path or by its UUID or by it Version's UUID. A path is always relative to the Root Node of the used Token.

Parameters
$get_node_request : GetNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNodeRequest()

Create request for operation 'getNode'

public getNodeRequest(GetNodeRequest $get_node_request[, string $contentType = self::contentTypes['getNode'][0] ]) : Request
Parameters
$get_node_request : GetNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getNodeWithHttpInfo()

Operation getNodeWithHttpInfo

public getNodeWithHttpInfo(GetNodeRequest $get_node_request[, string $contentType = self::contentTypes['getNode'][0] ]) : array<string|int, mixed>

Get Node based on a given path or by its UUID or by it Version's UUID. A path is always relative to the Root Node of the used Token.

Parameters
$get_node_request : GetNodeRequest

(required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

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

getRootNodeUuid()

Operation getRootNodeUuid

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

Get the UUID of the current root Node. This depends on the API Token/Auth Token that is being used.

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
string|ErrorResponse

getRootNodeUuidAsync()

Operation getRootNodeUuidAsync

public getRootNodeUuidAsync([string $contentType = self::contentTypes['getRootNodeUuid'][0] ]) : PromiseInterface

Get the UUID of the current root Node. This depends on the API Token/Auth Token that is being used.

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getRootNodeUuidAsyncWithHttpInfo()

Operation getRootNodeUuidAsyncWithHttpInfo

public getRootNodeUuidAsyncWithHttpInfo([string $contentType = self::contentTypes['getRootNodeUuid'][0] ]) : PromiseInterface

Get the UUID of the current root Node. This depends on the API Token/Auth Token that is being used.

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getRootNodeUuidRequest()

Create request for operation 'getRootNodeUuid'

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getRootNodeUuidWithHttpInfo()

Operation getRootNodeUuidWithHttpInfo

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

Get the UUID of the current root Node. This depends on the API Token/Auth Token that is being used.

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

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

getVersion()

Operation getVersion

public getVersion(GetVersionRequest $get_version_request[, string $contentType = self::contentTypes['getVersion'][0] ]) : Version|ErrorResponse

Get Version by it's UUID

Parameters
$get_version_request : GetVersionRequest

get_version_request (required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
Version|ErrorResponse

getVersionAsync()

Operation getVersionAsync

public getVersionAsync(GetVersionRequest $get_version_request[, string $contentType = self::contentTypes['getVersion'][0] ]) : PromiseInterface

Get Version by it's UUID

Parameters
$get_version_request : GetVersionRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getVersionAsyncWithHttpInfo()

Operation getVersionAsyncWithHttpInfo

public getVersionAsyncWithHttpInfo(GetVersionRequest $get_version_request[, string $contentType = self::contentTypes['getVersion'][0] ]) : PromiseInterface

Get Version by it's UUID

Parameters
$get_version_request : GetVersionRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getVersionRequest()

Create request for operation 'getVersion'

public getVersionRequest(GetVersionRequest $get_version_request[, string $contentType = self::contentTypes['getVersion'][0] ]) : Request
Parameters
$get_version_request : GetVersionRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getVersionWithHttpInfo()

Operation getVersionWithHttpInfo

public getVersionWithHttpInfo(GetVersionRequest $get_version_request[, string $contentType = self::contentTypes['getVersion'][0] ]) : array<string|int, mixed>

Get Version by it's UUID

Parameters
$get_version_request : GetVersionRequest

(required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

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

listNodes()

Operation listNodes

public listNodes(ListNodesRequest $list_nodes_request[, string $contentType = self::contentTypes['listNodes'][0] ]) : array<string|int, Node>|ErrorResponse

Get a list of Nodes that are children of the given Node

Parameters
$list_nodes_request : ListNodesRequest

list_nodes_request (required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, Node>|ErrorResponse

listNodesAsync()

Operation listNodesAsync

public listNodesAsync(ListNodesRequest $list_nodes_request[, string $contentType = self::contentTypes['listNodes'][0] ]) : PromiseInterface

Get a list of Nodes that are children of the given Node

Parameters
$list_nodes_request : ListNodesRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listNodesAsyncWithHttpInfo()

Operation listNodesAsyncWithHttpInfo

public listNodesAsyncWithHttpInfo(ListNodesRequest $list_nodes_request[, string $contentType = self::contentTypes['listNodes'][0] ]) : PromiseInterface

Get a list of Nodes that are children of the given Node

Parameters
$list_nodes_request : ListNodesRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listNodesRequest()

Create request for operation 'listNodes'

public listNodesRequest(ListNodesRequest $list_nodes_request[, string $contentType = self::contentTypes['listNodes'][0] ]) : Request
Parameters
$list_nodes_request : ListNodesRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

listNodesWithHttpInfo()

Operation listNodesWithHttpInfo

public listNodesWithHttpInfo(ListNodesRequest $list_nodes_request[, string $contentType = self::contentTypes['listNodes'][0] ]) : array<string|int, mixed>

Get a list of Nodes that are children of the given Node

Parameters
$list_nodes_request : ListNodesRequest

(required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

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

listVersions()

Operation listVersions

public listVersions(ListVersionsRequest $list_versions_request[, string $contentType = self::contentTypes['listVersions'][0] ]) : array<string|int, Version>|ErrorResponse

Get a list of all the Versions of the given Node

Parameters
$list_versions_request : ListVersionsRequest

list_versions_request (required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, Version>|ErrorResponse

listVersionsAsync()

Operation listVersionsAsync

public listVersionsAsync(ListVersionsRequest $list_versions_request[, string $contentType = self::contentTypes['listVersions'][0] ]) : PromiseInterface

Get a list of all the Versions of the given Node

Parameters
$list_versions_request : ListVersionsRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listVersionsAsyncWithHttpInfo()

Operation listVersionsAsyncWithHttpInfo

public listVersionsAsyncWithHttpInfo(ListVersionsRequest $list_versions_request[, string $contentType = self::contentTypes['listVersions'][0] ]) : PromiseInterface

Get a list of all the Versions of the given Node

Parameters
$list_versions_request : ListVersionsRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listVersionsRequest()

Create request for operation 'listVersions'

public listVersionsRequest(ListVersionsRequest $list_versions_request[, string $contentType = self::contentTypes['listVersions'][0] ]) : Request
Parameters
$list_versions_request : ListVersionsRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

listVersionsWithHttpInfo()

Operation listVersionsWithHttpInfo

public listVersionsWithHttpInfo(ListVersionsRequest $list_versions_request[, string $contentType = self::contentTypes['listVersions'][0] ]) : array<string|int, mixed>

Get a list of all the Versions of the given Node

Parameters
$list_versions_request : ListVersionsRequest

(required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

of \BIMworks\Model\Version[]|\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)

updateNode()

Operation updateNode

public updateNode(UpdateNodeRequest $update_node_request[, string $contentType = self::contentTypes['updateNode'][0] ]) : Node|ErrorResponse

Update a Node

Parameters
$update_node_request : UpdateNodeRequest

update_node_request (required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
Node|ErrorResponse

updateNodeAsync()

Operation updateNodeAsync

public updateNodeAsync(UpdateNodeRequest $update_node_request[, string $contentType = self::contentTypes['updateNode'][0] ]) : PromiseInterface

Update a Node

Parameters
$update_node_request : UpdateNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNodeAsyncWithHttpInfo()

Operation updateNodeAsyncWithHttpInfo

public updateNodeAsyncWithHttpInfo(UpdateNodeRequest $update_node_request[, string $contentType = self::contentTypes['updateNode'][0] ]) : PromiseInterface

Update a Node

Parameters
$update_node_request : UpdateNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNodeRequest()

Create request for operation 'updateNode'

public updateNodeRequest(UpdateNodeRequest $update_node_request[, string $contentType = self::contentTypes['updateNode'][0] ]) : Request
Parameters
$update_node_request : UpdateNodeRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

updateNodeWithHttpInfo()

Operation updateNodeWithHttpInfo

public updateNodeWithHttpInfo(UpdateNodeRequest $update_node_request[, string $contentType = self::contentTypes['updateNode'][0] ]) : array<string|int, mixed>

Update a Node

Parameters
$update_node_request : UpdateNodeRequest

(required)

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

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

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

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

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

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

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

        
On this page

Search results