Documentation

ActionsApi
in package

BIMworks

ActionsApi Class Doc Comment

Constants

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

Properties

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

Methods

__construct() : mixed
addAction() : Action|ErrorResponse: Operation addAction
addActionAsync() : PromiseInterface: Operation addActionAsync
addActionAsyncWithHttpInfo() : PromiseInterface: Operation addActionAsyncWithHttpInfo
addActionRequest() : Request: Create request for operation 'addAction'
addActionWithHttpInfo() : array<string|int, mixed>: Operation addActionWithHttpInfo
deleteAction() : void: Operation deleteAction
deleteActionAsync() : PromiseInterface: Operation deleteActionAsync
deleteActionAsyncWithHttpInfo() : PromiseInterface: Operation deleteActionAsyncWithHttpInfo
deleteActionRequest() : Request: Create request for operation 'deleteAction'
deleteActionWithHttpInfo() : array<string|int, mixed>: Operation deleteActionWithHttpInfo
getAction() : Action|ErrorResponse: Operation getAction
getActionAsync() : PromiseInterface: Operation getActionAsync
getActionAsyncWithHttpInfo() : PromiseInterface: Operation getActionAsyncWithHttpInfo
getActionRequest() : Request: Create request for operation 'getAction'
getActionWithHttpInfo() : array<string|int, mixed>: Operation getActionWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
listActions() : ActionList|ErrorResponse: Operation listActions
listActionsAsync() : PromiseInterface: Operation listActionsAsync
listActionsAsyncWithHttpInfo() : PromiseInterface: Operation listActionsAsyncWithHttpInfo
listActionsRequest() : Request: Create request for operation 'listActions'
listActionsWithHttpInfo() : array<string|int, mixed>: Operation listActionsWithHttpInfo
setHostIndex() : void: Set the host index
undeleteAction() : void: Operation undeleteAction
undeleteActionAsync() : PromiseInterface: Operation undeleteActionAsync
undeleteActionAsyncWithHttpInfo() : PromiseInterface: Operation undeleteActionAsyncWithHttpInfo
undeleteActionRequest() : Request: Create request for operation 'undeleteAction'
undeleteActionWithHttpInfo() : array<string|int, mixed>: Operation undeleteActionWithHttpInfo
updateAction() : Action|ErrorResponse: Operation updateAction
updateActionAsync() : PromiseInterface: Operation updateActionAsync
updateActionAsyncWithHttpInfo() : PromiseInterface: Operation updateActionAsyncWithHttpInfo
updateActionRequest() : Request: Create request for operation 'updateAction'
updateActionWithHttpInfo() : array<string|int, mixed>: Operation updateActionWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addAction' => ['application/json'], 'deleteAction' => ['application/json'], 'getAction' => ['application/json'], 'listActions' => ['application/json'], 'undeleteAction' => ['application/json'], 'updateAction' => ['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

addAction()

Operation addAction


    public
                    addAction(AddActionRequest $add_action_request[, string $contentType = self::contentTypes['addAction'][0] ]) : Action|ErrorResponse

Store an action

Parameters

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

Return values

Action|ErrorResponse

addActionAsync()

Operation addActionAsync


    public
                    addActionAsync(AddActionRequest $add_action_request[, string $contentType = self::contentTypes['addAction'][0] ]) : PromiseInterface

Store an action

Parameters

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

Return values

PromiseInterface

addActionAsyncWithHttpInfo()

Operation addActionAsyncWithHttpInfo


    public
                    addActionAsyncWithHttpInfo(AddActionRequest $add_action_request[, string $contentType = self::contentTypes['addAction'][0] ]) : PromiseInterface

Store an action

Parameters

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

Return values

PromiseInterface

addActionRequest()

Create request for operation 'addAction'


    public
                    addActionRequest(AddActionRequest $add_action_request[, string $contentType = self::contentTypes['addAction'][0] ]) : Request

Parameters

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

Return values

Request

addActionWithHttpInfo()

Operation addActionWithHttpInfo


    public
                    addActionWithHttpInfo(AddActionRequest $add_action_request[, string $contentType = self::contentTypes['addAction'][0] ]) : array<string|int, mixed>

Store an action

Parameters

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

Return values

array<string|int, mixed> —

deleteAction()

Operation deleteAction


    public
                    deleteAction(DeleteActionRequest $delete_action_request[, string $contentType = self::contentTypes['deleteAction'][0] ]) : void

Delete an action

Parameters

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

deleteActionAsync()

Operation deleteActionAsync


    public
                    deleteActionAsync(DeleteActionRequest $delete_action_request[, string $contentType = self::contentTypes['deleteAction'][0] ]) : PromiseInterface

Delete an action

Parameters

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

Return values

PromiseInterface

deleteActionAsyncWithHttpInfo()

Operation deleteActionAsyncWithHttpInfo


    public
                    deleteActionAsyncWithHttpInfo(DeleteActionRequest $delete_action_request[, string $contentType = self::contentTypes['deleteAction'][0] ]) : PromiseInterface

Delete an action

Parameters

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

Return values

PromiseInterface

deleteActionRequest()

Create request for operation 'deleteAction'


    public
                    deleteActionRequest(DeleteActionRequest $delete_action_request[, string $contentType = self::contentTypes['deleteAction'][0] ]) : Request

Parameters

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

Return values

Request

deleteActionWithHttpInfo()

Operation deleteActionWithHttpInfo


    public
                    deleteActionWithHttpInfo(DeleteActionRequest $delete_action_request[, string $contentType = self::contentTypes['deleteAction'][0] ]) : array<string|int, mixed>

Delete an action

Parameters

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

getAction()

Operation getAction


    public
                    getAction([GetActionRequest|null $get_action_request = null ][, string $contentType = self::contentTypes['getAction'][0] ]) : Action|ErrorResponse

Read an action

Parameters

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

Return values

Action|ErrorResponse

getActionAsync()

Operation getActionAsync


    public
                    getActionAsync([GetActionRequest|null $get_action_request = null ][, string $contentType = self::contentTypes['getAction'][0] ]) : PromiseInterface

Read an action

Parameters

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

Return values

PromiseInterface

getActionAsyncWithHttpInfo()

Operation getActionAsyncWithHttpInfo


    public
                    getActionAsyncWithHttpInfo([GetActionRequest|null $get_action_request = null ][, string $contentType = self::contentTypes['getAction'][0] ]) : PromiseInterface

Read an action

Parameters

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

Return values

PromiseInterface

getActionRequest()

Create request for operation 'getAction'


    public
                    getActionRequest([GetActionRequest|null $get_action_request = null ][, string $contentType = self::contentTypes['getAction'][0] ]) : Request

Parameters

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

Return values

Request

getActionWithHttpInfo()

Operation getActionWithHttpInfo


    public
                    getActionWithHttpInfo([GetActionRequest|null $get_action_request = null ][, string $contentType = self::contentTypes['getAction'][0] ]) : array<string|int, mixed>

Read an action

Parameters

$get_action_request : GetActionRequest|null = null: (optional)
$contentType : string = self::contentTypes['getAction'][0]: The value for the Content-Type header. Check self::contentTypes['getAction'] 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

listActions()

Operation listActions


    public
                    listActions([ListActionsRequest|null $list_actions_request = null ][, string $contentType = self::contentTypes['listActions'][0] ]) : ActionList|ErrorResponse

List the actions in a folder

Parameters

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

Return values

ActionList|ErrorResponse

listActionsAsync()

Operation listActionsAsync


    public
                    listActionsAsync([ListActionsRequest|null $list_actions_request = null ][, string $contentType = self::contentTypes['listActions'][0] ]) : PromiseInterface

List the actions in a folder

Parameters

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

Return values

PromiseInterface

listActionsAsyncWithHttpInfo()

Operation listActionsAsyncWithHttpInfo


    public
                    listActionsAsyncWithHttpInfo([ListActionsRequest|null $list_actions_request = null ][, string $contentType = self::contentTypes['listActions'][0] ]) : PromiseInterface

List the actions in a folder

Parameters

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

Return values

PromiseInterface

listActionsRequest()

Create request for operation 'listActions'


    public
                    listActionsRequest([ListActionsRequest|null $list_actions_request = null ][, string $contentType = self::contentTypes['listActions'][0] ]) : Request

Parameters

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

Return values

Request

listActionsWithHttpInfo()

Operation listActionsWithHttpInfo


    public
                    listActionsWithHttpInfo([ListActionsRequest|null $list_actions_request = null ][, string $contentType = self::contentTypes['listActions'][0] ]) : array<string|int, mixed>

List the actions in a folder

Parameters

$list_actions_request : ListActionsRequest|null = null: (optional)
$contentType : string = self::contentTypes['listActions'][0]: The value for the Content-Type header. Check self::contentTypes['listActions'] 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)

undeleteAction()

Operation undeleteAction


    public
                    undeleteAction(UndeleteActionRequest $undelete_action_request[, string $contentType = self::contentTypes['undeleteAction'][0] ]) : void

Bring back a deleted action

Parameters

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

undeleteActionAsync()

Operation undeleteActionAsync


    public
                    undeleteActionAsync(UndeleteActionRequest $undelete_action_request[, string $contentType = self::contentTypes['undeleteAction'][0] ]) : PromiseInterface

Bring back a deleted action

Parameters

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

Return values

PromiseInterface

undeleteActionAsyncWithHttpInfo()

Operation undeleteActionAsyncWithHttpInfo


    public
                    undeleteActionAsyncWithHttpInfo(UndeleteActionRequest $undelete_action_request[, string $contentType = self::contentTypes['undeleteAction'][0] ]) : PromiseInterface

Bring back a deleted action

Parameters

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

Return values

PromiseInterface

undeleteActionRequest()

Create request for operation 'undeleteAction'


    public
                    undeleteActionRequest(UndeleteActionRequest $undelete_action_request[, string $contentType = self::contentTypes['undeleteAction'][0] ]) : Request

Parameters

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

Return values

Request

undeleteActionWithHttpInfo()

Operation undeleteActionWithHttpInfo


    public
                    undeleteActionWithHttpInfo(UndeleteActionRequest $undelete_action_request[, string $contentType = self::contentTypes['undeleteAction'][0] ]) : array<string|int, mixed>

Bring back a deleted action

Parameters

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

updateAction()

Operation updateAction


    public
                    updateAction(UpdateActionRequest $update_action_request[, string $contentType = self::contentTypes['updateAction'][0] ]) : Action|ErrorResponse

Change an action

Parameters

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

Return values

Action|ErrorResponse

updateActionAsync()

Operation updateActionAsync


    public
                    updateActionAsync(UpdateActionRequest $update_action_request[, string $contentType = self::contentTypes['updateAction'][0] ]) : PromiseInterface

Change an action

Parameters

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

Return values

PromiseInterface

updateActionAsyncWithHttpInfo()

Operation updateActionAsyncWithHttpInfo


    public
                    updateActionAsyncWithHttpInfo(UpdateActionRequest $update_action_request[, string $contentType = self::contentTypes['updateAction'][0] ]) : PromiseInterface

Change an action

Parameters

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

Return values

PromiseInterface

updateActionRequest()

Create request for operation 'updateAction'


    public
                    updateActionRequest(UpdateActionRequest $update_action_request[, string $contentType = self::contentTypes['updateAction'][0] ]) : Request

Parameters

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

Return values

Request

updateActionWithHttpInfo()

Operation updateActionWithHttpInfo


    public
                    updateActionWithHttpInfo(UpdateActionRequest $update_action_request[, string $contentType = self::contentTypes['updateAction'][0] ]) : array<string|int, mixed>

Change an action

Parameters

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

ActionsApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addAction()

Parameters

Tags

Return values

addActionAsync()

Parameters

Tags

Return values

addActionAsyncWithHttpInfo()

Parameters

Tags

Return values

addActionRequest()

Parameters

Tags

Return values

addActionWithHttpInfo()

Parameters

Tags

Return values

deleteAction()

Parameters

Tags

deleteActionAsync()

Parameters

Tags

Return values

deleteActionAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteActionRequest()

Parameters

Tags

Return values

deleteActionWithHttpInfo()

Parameters

Tags

Return values

getAction()

Parameters

Tags

Return values

getActionAsync()

Parameters

Tags

Return values

getActionAsyncWithHttpInfo()

Parameters

Tags

Return values

getActionRequest()

Parameters

Tags

Return values

getActionWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

listActions()

ActionsApi
in package

BIMworks