Documentation

FsApi
in package

BIMworks

FsApi Class Doc Comment

Constants

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

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
deleteNode() : void: Operation deleteNode
deleteNodeAsync() : PromiseInterface: Operation deleteNodeAsync
deleteNodeAsyncWithHttpInfo() : PromiseInterface: Operation deleteNodeAsyncWithHttpInfo
deleteNodeError() : void: Operation deleteNodeError
deleteNodeErrorAsync() : PromiseInterface: Operation deleteNodeErrorAsync
deleteNodeErrorAsyncWithHttpInfo() : PromiseInterface: Operation deleteNodeErrorAsyncWithHttpInfo
deleteNodeErrorRequest() : Request: Create request for operation 'deleteNodeError'
deleteNodeErrorWithHttpInfo() : array<string|int, mixed>: Operation deleteNodeErrorWithHttpInfo
deleteNodeRequest() : Request: Create request for operation 'deleteNode'
deleteNodeWithHttpInfo() : array<string|int, mixed>: Operation deleteNodeWithHttpInfo
deleteVersion() : void: Operation deleteVersion
deleteVersionAsync() : PromiseInterface: Operation deleteVersionAsync
deleteVersionAsyncWithHttpInfo() : PromiseInterface: Operation deleteVersionAsyncWithHttpInfo
deleteVersionRequest() : Request: Create request for operation 'deleteVersion'
deleteVersionWithHttpInfo() : array<string|int, mixed>: Operation deleteVersionWithHttpInfo
downloadAsZip() : SplFileObject|ErrorResponse: Operation downloadAsZip
downloadAsZipAsync() : PromiseInterface: Operation downloadAsZipAsync
downloadAsZipAsyncWithHttpInfo() : PromiseInterface: Operation downloadAsZipAsyncWithHttpInfo
downloadAsZipRequest() : Request: Create request for operation 'downloadAsZip'
downloadAsZipWithHttpInfo() : array<string|int, mixed>: Operation downloadAsZipWithHttpInfo
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
listNodeErrors() : array<string|int, Error>|ErrorResponse: Operation listNodeErrors
listNodeErrorsAsync() : PromiseInterface: Operation listNodeErrorsAsync
listNodeErrorsAsyncWithHttpInfo() : PromiseInterface: Operation listNodeErrorsAsyncWithHttpInfo
listNodeErrorsRequest() : Request: Create request for operation 'listNodeErrors'
listNodeErrorsWithHttpInfo() : array<string|int, mixed>: Operation listNodeErrorsWithHttpInfo
listNodes() : array<string|int, Node>|ErrorResponse: Operation listNodes
listNodesAsync() : PromiseInterface: Operation listNodesAsync
listNodesAsyncWithHttpInfo() : PromiseInterface: Operation listNodesAsyncWithHttpInfo
listNodesRecursive() : array<string|int, Node>|ErrorResponse: Operation listNodesRecursive
listNodesRecursiveAsync() : PromiseInterface: Operation listNodesRecursiveAsync
listNodesRecursiveAsyncWithHttpInfo() : PromiseInterface: Operation listNodesRecursiveAsyncWithHttpInfo
listNodesRecursiveRequest() : Request: Create request for operation 'listNodesRecursive'
listNodesRecursiveWithHttpInfo() : array<string|int, mixed>: Operation listNodesRecursiveWithHttpInfo
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
moveNode() : Node|ErrorResponse: Operation moveNode
moveNodeAsync() : PromiseInterface: Operation moveNodeAsync
moveNodeAsyncWithHttpInfo() : PromiseInterface: Operation moveNodeAsyncWithHttpInfo
moveNodeRequest() : Request: Create request for operation 'moveNode'
moveNodeWithHttpInfo() : array<string|int, mixed>: Operation moveNodeWithHttpInfo
setHostIndex() : void: Set the host index
undeleteNode() : void: Operation undeleteNode
undeleteNodeAsync() : PromiseInterface: Operation undeleteNodeAsync
undeleteNodeAsyncWithHttpInfo() : PromiseInterface: Operation undeleteNodeAsyncWithHttpInfo
undeleteNodeRequest() : Request: Create request for operation 'undeleteNode'
undeleteNodeWithHttpInfo() : array<string|int, mixed>: Operation undeleteNodeWithHttpInfo
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
updateVersion() : Version|ErrorResponse: Operation updateVersion
updateVersionAsync() : PromiseInterface: Operation updateVersionAsync
updateVersionAsyncWithHttpInfo() : PromiseInterface: Operation updateVersionAsyncWithHttpInfo
updateVersionRequest() : Request: Create request for operation 'updateVersion'
updateVersionWithHttpInfo() : array<string|int, mixed>: Operation updateVersionWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createNode' => ['application/json'], 'deleteNode' => ['application/json'], 'deleteNodeError' => ['application/json'], 'deleteVersion' => ['application/json'], 'downloadAsZip' => ['application/json'], 'getNode' => ['application/json'], 'getRootNodeUuid' => ['application/json'], 'getVersion' => ['application/json'], 'listNodeErrors' => ['application/json'], 'listNodes' => ['application/json'], 'listNodesRecursive' => ['application/json'], 'listVersions' => ['application/json'], 'moveNode' => ['application/json'], 'undeleteNode' => ['application/json'], 'updateNode' => ['application/json'], 'updateVersion' => ['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

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

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

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

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

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

Return values

array<string|int, mixed> —

deleteNode()

Operation deleteNode


    public
                    deleteNode(DeleteNodeRequest $delete_node_request[, string $contentType = self::contentTypes['deleteNode'][0] ]) : void

Delete a Node

Parameters

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

deleteNodeAsync()

Operation deleteNodeAsync


    public
                    deleteNodeAsync(DeleteNodeRequest $delete_node_request[, string $contentType = self::contentTypes['deleteNode'][0] ]) : PromiseInterface

Delete a Node

Parameters

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

Return values

PromiseInterface

deleteNodeAsyncWithHttpInfo()

Operation deleteNodeAsyncWithHttpInfo


    public
                    deleteNodeAsyncWithHttpInfo(DeleteNodeRequest $delete_node_request[, string $contentType = self::contentTypes['deleteNode'][0] ]) : PromiseInterface

Delete a Node

Parameters

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

Return values

PromiseInterface

deleteNodeError()

Operation deleteNodeError


    public
                    deleteNodeError(DeleteNodeErrorRequest $delete_node_error_request[, string $contentType = self::contentTypes['deleteNodeError'][0] ]) : void

Clear an error of a Node

Parameters

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

deleteNodeErrorAsync()

Operation deleteNodeErrorAsync


    public
                    deleteNodeErrorAsync(DeleteNodeErrorRequest $delete_node_error_request[, string $contentType = self::contentTypes['deleteNodeError'][0] ]) : PromiseInterface

Clear an error of a Node

Parameters

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

Return values

PromiseInterface

deleteNodeErrorAsyncWithHttpInfo()

Operation deleteNodeErrorAsyncWithHttpInfo


    public
                    deleteNodeErrorAsyncWithHttpInfo(DeleteNodeErrorRequest $delete_node_error_request[, string $contentType = self::contentTypes['deleteNodeError'][0] ]) : PromiseInterface

Clear an error of a Node

Parameters

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

Return values

PromiseInterface

deleteNodeErrorRequest()

Create request for operation 'deleteNodeError'


    public
                    deleteNodeErrorRequest(DeleteNodeErrorRequest $delete_node_error_request[, string $contentType = self::contentTypes['deleteNodeError'][0] ]) : Request

Parameters

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

Return values

Request

deleteNodeErrorWithHttpInfo()

Operation deleteNodeErrorWithHttpInfo


    public
                    deleteNodeErrorWithHttpInfo(DeleteNodeErrorRequest $delete_node_error_request[, string $contentType = self::contentTypes['deleteNodeError'][0] ]) : array<string|int, mixed>

Clear an error of a Node

Parameters

$delete_node_error_request : DeleteNodeErrorRequest: (required)
$contentType : string = self::contentTypes['deleteNodeError'][0]: The value for the Content-Type header. Check self::contentTypes['deleteNodeError'] 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)

deleteNodeRequest()

Create request for operation 'deleteNode'


    public
                    deleteNodeRequest(DeleteNodeRequest $delete_node_request[, string $contentType = self::contentTypes['deleteNode'][0] ]) : Request

Parameters

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

Return values

Request

deleteNodeWithHttpInfo()

Operation deleteNodeWithHttpInfo


    public
                    deleteNodeWithHttpInfo(DeleteNodeRequest $delete_node_request[, string $contentType = self::contentTypes['deleteNode'][0] ]) : array<string|int, mixed>

Delete a Node

Parameters

$delete_node_request : DeleteNodeRequest: (required)
$contentType : string = self::contentTypes['deleteNode'][0]: The value for the Content-Type header. Check self::contentTypes['deleteNode'] 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)

deleteVersion()

Operation deleteVersion


    public
                    deleteVersion(DeleteVersionRequest $delete_version_request[, string $contentType = self::contentTypes['deleteVersion'][0] ]) : void

Delete a Version of a Node

Parameters

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

deleteVersionAsync()

Operation deleteVersionAsync


    public
                    deleteVersionAsync(DeleteVersionRequest $delete_version_request[, string $contentType = self::contentTypes['deleteVersion'][0] ]) : PromiseInterface

Delete a Version of a Node

Parameters

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

Return values

PromiseInterface

deleteVersionAsyncWithHttpInfo()

Operation deleteVersionAsyncWithHttpInfo


    public
                    deleteVersionAsyncWithHttpInfo(DeleteVersionRequest $delete_version_request[, string $contentType = self::contentTypes['deleteVersion'][0] ]) : PromiseInterface

Delete a Version of a Node

Parameters

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

Return values

PromiseInterface

deleteVersionRequest()

Create request for operation 'deleteVersion'


    public
                    deleteVersionRequest(DeleteVersionRequest $delete_version_request[, string $contentType = self::contentTypes['deleteVersion'][0] ]) : Request

Parameters

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

Return values

Request

deleteVersionWithHttpInfo()

Operation deleteVersionWithHttpInfo


    public
                    deleteVersionWithHttpInfo(DeleteVersionRequest $delete_version_request[, string $contentType = self::contentTypes['deleteVersion'][0] ]) : array<string|int, mixed>

Delete a Version of a Node

Parameters

$delete_version_request : DeleteVersionRequest: (required)
$contentType : string = self::contentTypes['deleteVersion'][0]: The value for the Content-Type header. Check self::contentTypes['deleteVersion'] 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)

downloadAsZip()

Operation downloadAsZip


    public
                    downloadAsZip(DownloadAsZipRequest $download_as_zip_request[, string $contentType = self::contentTypes['downloadAsZip'][0] ]) : SplFileObject|ErrorResponse

Download a folder Node and everything below it as a ZIP file

Parameters

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

Return values

SplFileObject|ErrorResponse

downloadAsZipAsync()

Operation downloadAsZipAsync


    public
                    downloadAsZipAsync(DownloadAsZipRequest $download_as_zip_request[, string $contentType = self::contentTypes['downloadAsZip'][0] ]) : PromiseInterface

Download a folder Node and everything below it as a ZIP file

Parameters

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

Return values

PromiseInterface

downloadAsZipAsyncWithHttpInfo()

Operation downloadAsZipAsyncWithHttpInfo


    public
                    downloadAsZipAsyncWithHttpInfo(DownloadAsZipRequest $download_as_zip_request[, string $contentType = self::contentTypes['downloadAsZip'][0] ]) : PromiseInterface

Download a folder Node and everything below it as a ZIP file

Parameters

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

Return values

PromiseInterface

downloadAsZipRequest()

Create request for operation 'downloadAsZip'


    public
                    downloadAsZipRequest(DownloadAsZipRequest $download_as_zip_request[, string $contentType = self::contentTypes['downloadAsZip'][0] ]) : Request

Parameters

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

Return values

Request

downloadAsZipWithHttpInfo()

Operation downloadAsZipWithHttpInfo


    public
                    downloadAsZipWithHttpInfo(DownloadAsZipRequest $download_as_zip_request[, string $contentType = self::contentTypes['downloadAsZip'][0] ]) : array<string|int, mixed>

Download a folder Node and everything below it as a ZIP file

Parameters

$download_as_zip_request : DownloadAsZipRequest: (required)
$contentType : string = self::contentTypes['downloadAsZip'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAsZip'] 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

getNode()

Operation getNode


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

Get Node based on a given path, by its UUID or by the UUID of one of its Versions. 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

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, by its UUID or by the UUID of one of its Versions. 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

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, by its UUID or by the UUID of one of its Versions. 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

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

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, by its UUID or by the UUID of one of its Versions. 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

Return values

array<string|int, mixed> —

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

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

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

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

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

Return values

array<string|int, mixed> —

getVersion()

Operation getVersion


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

Get a Version by its 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

Return values

Version|ErrorResponse

getVersionAsync()

Operation getVersionAsync


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

Get a Version by its 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

Return values

PromiseInterface

getVersionAsyncWithHttpInfo()

Operation getVersionAsyncWithHttpInfo


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

Get a Version by its 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

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

Return values

Request

getVersionWithHttpInfo()

Operation getVersionWithHttpInfo


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

Get a Version by its 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

Return values

array<string|int, mixed> —

listNodeErrors()

Operation listNodeErrors


    public
                    listNodeErrors(ListNodeErrorsRequest $list_node_errors_request[, string $contentType = self::contentTypes['listNodeErrors'][0] ]) : array<string|int, Error>|ErrorResponse

Get the errors of the given Node

Parameters

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

Return values

array<string|int, Error>|ErrorResponse

listNodeErrorsAsync()

Operation listNodeErrorsAsync


    public
                    listNodeErrorsAsync(ListNodeErrorsRequest $list_node_errors_request[, string $contentType = self::contentTypes['listNodeErrors'][0] ]) : PromiseInterface

Get the errors of the given Node

Parameters

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

Return values

PromiseInterface

listNodeErrorsAsyncWithHttpInfo()

Operation listNodeErrorsAsyncWithHttpInfo


    public
                    listNodeErrorsAsyncWithHttpInfo(ListNodeErrorsRequest $list_node_errors_request[, string $contentType = self::contentTypes['listNodeErrors'][0] ]) : PromiseInterface

Get the errors of the given Node

Parameters

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

Return values

PromiseInterface

listNodeErrorsRequest()

Create request for operation 'listNodeErrors'


    public
                    listNodeErrorsRequest(ListNodeErrorsRequest $list_node_errors_request[, string $contentType = self::contentTypes['listNodeErrors'][0] ]) : Request

Parameters

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

Return values

Request

listNodeErrorsWithHttpInfo()

Operation listNodeErrorsWithHttpInfo


    public
                    listNodeErrorsWithHttpInfo(ListNodeErrorsRequest $list_node_errors_request[, string $contentType = self::contentTypes['listNodeErrors'][0] ]) : array<string|int, mixed>

Get the errors of the given Node

Parameters

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

Return values

array<string|int, mixed> —

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

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

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

Return values

PromiseInterface

listNodesRecursive()

Operation listNodesRecursive


    public
                    listNodesRecursive(ListNodesRecursiveRequest $list_nodes_recursive_request[, string $contentType = self::contentTypes['listNodesRecursive'][0] ]) : array<string|int, Node>|ErrorResponse

Get all Nodes below the given Node, recursively

Parameters

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

Return values

array<string|int, Node>|ErrorResponse

listNodesRecursiveAsync()

Operation listNodesRecursiveAsync


    public
                    listNodesRecursiveAsync(ListNodesRecursiveRequest $list_nodes_recursive_request[, string $contentType = self::contentTypes['listNodesRecursive'][0] ]) : PromiseInterface

Get all Nodes below the given Node, recursively

Parameters

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

Return values

PromiseInterface

listNodesRecursiveAsyncWithHttpInfo()

Operation listNodesRecursiveAsyncWithHttpInfo


    public
                    listNodesRecursiveAsyncWithHttpInfo(ListNodesRecursiveRequest $list_nodes_recursive_request[, string $contentType = self::contentTypes['listNodesRecursive'][0] ]) : PromiseInterface

Get all Nodes below the given Node, recursively

Parameters

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

Return values

PromiseInterface

listNodesRecursiveRequest()

Create request for operation 'listNodesRecursive'


    public
                    listNodesRecursiveRequest(ListNodesRecursiveRequest $list_nodes_recursive_request[, string $contentType = self::contentTypes['listNodesRecursive'][0] ]) : Request

Parameters

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

Return values

Request

listNodesRecursiveWithHttpInfo()

Operation listNodesRecursiveWithHttpInfo


    public
                    listNodesRecursiveWithHttpInfo(ListNodesRecursiveRequest $list_nodes_recursive_request[, string $contentType = self::contentTypes['listNodesRecursive'][0] ]) : array<string|int, mixed>

Get all Nodes below the given Node, recursively

Parameters

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

Return values

array<string|int, mixed> —

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

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

Return values

array<string|int, mixed> —

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, or the given Versions

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

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, or the given Versions

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

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, or the given Versions

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

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

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, or the given Versions

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

Return values

array<string|int, mixed> —

moveNode()

Operation moveNode


    public
                    moveNode(MoveNodeRequest $move_node_request[, string $contentType = self::contentTypes['moveNode'][0] ]) : Node|ErrorResponse

Move a Node to another parent folder

Parameters

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

Return values

Node|ErrorResponse

moveNodeAsync()

Operation moveNodeAsync


    public
                    moveNodeAsync(MoveNodeRequest $move_node_request[, string $contentType = self::contentTypes['moveNode'][0] ]) : PromiseInterface

Move a Node to another parent folder

Parameters

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

Return values

PromiseInterface

moveNodeAsyncWithHttpInfo()

Operation moveNodeAsyncWithHttpInfo


    public
                    moveNodeAsyncWithHttpInfo(MoveNodeRequest $move_node_request[, string $contentType = self::contentTypes['moveNode'][0] ]) : PromiseInterface

Move a Node to another parent folder

Parameters

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

Return values

PromiseInterface

moveNodeRequest()

Create request for operation 'moveNode'


    public
                    moveNodeRequest(MoveNodeRequest $move_node_request[, string $contentType = self::contentTypes['moveNode'][0] ]) : Request

Parameters

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

Return values

Request

moveNodeWithHttpInfo()

Operation moveNodeWithHttpInfo


    public
                    moveNodeWithHttpInfo(MoveNodeRequest $move_node_request[, string $contentType = self::contentTypes['moveNode'][0] ]) : array<string|int, mixed>

Move a Node to another parent folder

Parameters

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

Return values

array<string|int, mixed> —

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

undeleteNode()

Operation undeleteNode


    public
                    undeleteNode(UndeleteNodeRequest $undelete_node_request[, string $contentType = self::contentTypes['undeleteNode'][0] ]) : void

Restore a previously deleted Node

Parameters

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

undeleteNodeAsync()

Operation undeleteNodeAsync


    public
                    undeleteNodeAsync(UndeleteNodeRequest $undelete_node_request[, string $contentType = self::contentTypes['undeleteNode'][0] ]) : PromiseInterface

Restore a previously deleted Node

Parameters

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

Return values

PromiseInterface

undeleteNodeAsyncWithHttpInfo()

Operation undeleteNodeAsyncWithHttpInfo


    public
                    undeleteNodeAsyncWithHttpInfo(UndeleteNodeRequest $undelete_node_request[, string $contentType = self::contentTypes['undeleteNode'][0] ]) : PromiseInterface

Restore a previously deleted Node

Parameters

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

Return values

PromiseInterface

undeleteNodeRequest()

Create request for operation 'undeleteNode'


    public
                    undeleteNodeRequest(UndeleteNodeRequest $undelete_node_request[, string $contentType = self::contentTypes['undeleteNode'][0] ]) : Request

Parameters

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

Return values

Request

undeleteNodeWithHttpInfo()

Operation undeleteNodeWithHttpInfo


    public
                    undeleteNodeWithHttpInfo(UndeleteNodeRequest $undelete_node_request[, string $contentType = self::contentTypes['undeleteNode'][0] ]) : array<string|int, mixed>

Restore a previously deleted Node

Parameters

$undelete_node_request : UndeleteNodeRequest: (required)
$contentType : string = self::contentTypes['undeleteNode'][0]: The value for the Content-Type header. Check self::contentTypes['undeleteNode'] 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)

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

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

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

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

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

Return values

array<string|int, mixed> —

updateVersion()

Operation updateVersion


    public
                    updateVersion(UpdateVersionRequest $update_version_request[, string $contentType = self::contentTypes['updateVersion'][0] ]) : Version|ErrorResponse

Change a Version's disciplines or alignment

Parameters

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

Return values

Version|ErrorResponse

updateVersionAsync()

Operation updateVersionAsync


    public
                    updateVersionAsync(UpdateVersionRequest $update_version_request[, string $contentType = self::contentTypes['updateVersion'][0] ]) : PromiseInterface

Change a Version's disciplines or alignment

Parameters

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

Return values

PromiseInterface

updateVersionAsyncWithHttpInfo()

Operation updateVersionAsyncWithHttpInfo


    public
                    updateVersionAsyncWithHttpInfo(UpdateVersionRequest $update_version_request[, string $contentType = self::contentTypes['updateVersion'][0] ]) : PromiseInterface

Change a Version's disciplines or alignment

Parameters

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

Return values

PromiseInterface

updateVersionRequest()

Create request for operation 'updateVersion'


    public
                    updateVersionRequest(UpdateVersionRequest $update_version_request[, string $contentType = self::contentTypes['updateVersion'][0] ]) : Request

Parameters

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

Return values

Request

updateVersionWithHttpInfo()

Operation updateVersionWithHttpInfo


    public
                    updateVersionWithHttpInfo(UpdateVersionRequest $update_version_request[, string $contentType = self::contentTypes['updateVersion'][0] ]) : array<string|int, mixed>

Change a Version's disciplines or alignment

Parameters

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

Return values

array<string|int, mixed> —

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

FsApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createNode()

Parameters

Tags

Return values

createNodeAsync()

Parameters

Tags

Return values

createNodeAsyncWithHttpInfo()

Parameters

Tags

Return values

createNodeRequest()

Parameters

Tags

Return values

createNodeWithHttpInfo()

Parameters

Tags

Return values

deleteNode()

Parameters

Tags

deleteNodeAsync()

Parameters

Tags

Return values

deleteNodeAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteNodeError()

Parameters

Tags

deleteNodeErrorAsync()

Parameters

Tags

Return values

deleteNodeErrorAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteNodeErrorRequest()

Parameters

Tags

Return values

deleteNodeErrorWithHttpInfo()

Parameters

Tags

Return values

deleteNodeRequest()

Parameters

Tags

Return values

deleteNodeWithHttpInfo()

Parameters

Tags

Return values

deleteVersion()

Parameters

Tags

deleteVersionAsync()

Parameters

Tags

FsApi
in package

BIMworks