Documentation

WorkspacesApi
in package

BIMworks

WorkspacesApi Class Doc Comment

Constants

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

Properties

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

Methods

__construct() : mixed
createWorkspace() : CreateWorkspace200Response|ErrorResponse: Operation createWorkspace
createWorkspaceAsync() : PromiseInterface: Operation createWorkspaceAsync
createWorkspaceAsyncWithHttpInfo() : PromiseInterface: Operation createWorkspaceAsyncWithHttpInfo
createWorkspaceRequest() : Request: Create request for operation 'createWorkspace'
createWorkspaceWithHttpInfo() : array<string|int, mixed>: Operation createWorkspaceWithHttpInfo
deleteWorkspace() : void: Operation deleteWorkspace
deleteWorkspaceAsync() : PromiseInterface: Operation deleteWorkspaceAsync
deleteWorkspaceAsyncWithHttpInfo() : PromiseInterface: Operation deleteWorkspaceAsyncWithHttpInfo
deleteWorkspaceRequest() : Request: Create request for operation 'deleteWorkspace'
deleteWorkspaceWithHttpInfo() : array<string|int, mixed>: Operation deleteWorkspaceWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
listWorkspaces() : array<string|int, Workspace>|ErrorResponse: Operation listWorkspaces
listWorkspacesAsync() : PromiseInterface: Operation listWorkspacesAsync
listWorkspacesAsyncWithHttpInfo() : PromiseInterface: Operation listWorkspacesAsyncWithHttpInfo
listWorkspacesRequest() : Request: Create request for operation 'listWorkspaces'
listWorkspacesWithHttpInfo() : array<string|int, mixed>: Operation listWorkspacesWithHttpInfo
publishWorkspace() : Workspace|ErrorResponse: Operation publishWorkspace
publishWorkspaceAsync() : PromiseInterface: Operation publishWorkspaceAsync
publishWorkspaceAsyncWithHttpInfo() : PromiseInterface: Operation publishWorkspaceAsyncWithHttpInfo
publishWorkspaceRequest() : Request: Create request for operation 'publishWorkspace'
publishWorkspaceWithHttpInfo() : array<string|int, mixed>: Operation publishWorkspaceWithHttpInfo
setHostIndex() : void: Set the host index
updateWorkspace() : void: Operation updateWorkspace
updateWorkspaceAsync() : PromiseInterface: Operation updateWorkspaceAsync
updateWorkspaceAsyncWithHttpInfo() : PromiseInterface: Operation updateWorkspaceAsyncWithHttpInfo
updateWorkspaceRequest() : Request: Create request for operation 'updateWorkspace'
updateWorkspaceWithHttpInfo() : array<string|int, mixed>: Operation updateWorkspaceWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['createWorkspace' => ['application/json'], 'deleteWorkspace' => ['application/json'], 'listWorkspaces' => ['application/json'], 'publishWorkspace' => ['application/json'], 'updateWorkspace' => ['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

createWorkspace()

Operation createWorkspace


    public
                    createWorkspace(CreateWorkspaceRequest $create_workspace_request[, string $contentType = self::contentTypes['createWorkspace'][0] ]) : CreateWorkspace200Response|ErrorResponse

Create a workspace

Parameters

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

Return values

CreateWorkspace200Response|ErrorResponse

createWorkspaceAsync()

Operation createWorkspaceAsync


    public
                    createWorkspaceAsync(CreateWorkspaceRequest $create_workspace_request[, string $contentType = self::contentTypes['createWorkspace'][0] ]) : PromiseInterface

Create a workspace

Parameters

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

Return values

PromiseInterface

createWorkspaceAsyncWithHttpInfo()

Operation createWorkspaceAsyncWithHttpInfo


    public
                    createWorkspaceAsyncWithHttpInfo(CreateWorkspaceRequest $create_workspace_request[, string $contentType = self::contentTypes['createWorkspace'][0] ]) : PromiseInterface

Create a workspace

Parameters

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

Return values

PromiseInterface

createWorkspaceRequest()

Create request for operation 'createWorkspace'


    public
                    createWorkspaceRequest(CreateWorkspaceRequest $create_workspace_request[, string $contentType = self::contentTypes['createWorkspace'][0] ]) : Request

Parameters

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

Return values

Request

createWorkspaceWithHttpInfo()

Operation createWorkspaceWithHttpInfo


    public
                    createWorkspaceWithHttpInfo(CreateWorkspaceRequest $create_workspace_request[, string $contentType = self::contentTypes['createWorkspace'][0] ]) : array<string|int, mixed>

Create a workspace

Parameters

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

Return values

array<string|int, mixed> —

deleteWorkspace()

Operation deleteWorkspace


    public
                    deleteWorkspace(DeleteWorkspaceRequest $delete_workspace_request[, string $contentType = self::contentTypes['deleteWorkspace'][0] ]) : void

Delete a workspace

Parameters

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

deleteWorkspaceAsync()

Operation deleteWorkspaceAsync


    public
                    deleteWorkspaceAsync(DeleteWorkspaceRequest $delete_workspace_request[, string $contentType = self::contentTypes['deleteWorkspace'][0] ]) : PromiseInterface

Delete a workspace

Parameters

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

Return values

PromiseInterface

deleteWorkspaceAsyncWithHttpInfo()

Operation deleteWorkspaceAsyncWithHttpInfo


    public
                    deleteWorkspaceAsyncWithHttpInfo(DeleteWorkspaceRequest $delete_workspace_request[, string $contentType = self::contentTypes['deleteWorkspace'][0] ]) : PromiseInterface

Delete a workspace

Parameters

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

Return values

PromiseInterface

deleteWorkspaceRequest()

Create request for operation 'deleteWorkspace'


    public
                    deleteWorkspaceRequest(DeleteWorkspaceRequest $delete_workspace_request[, string $contentType = self::contentTypes['deleteWorkspace'][0] ]) : Request

Parameters

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

Return values

Request

deleteWorkspaceWithHttpInfo()

Operation deleteWorkspaceWithHttpInfo


    public
                    deleteWorkspaceWithHttpInfo(DeleteWorkspaceRequest $delete_workspace_request[, string $contentType = self::contentTypes['deleteWorkspace'][0] ]) : array<string|int, mixed>

Delete a workspace

Parameters

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

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

listWorkspaces()

Operation listWorkspaces


    public
                    listWorkspaces([string $contentType = self::contentTypes['listWorkspaces'][0] ]) : array<string|int, Workspace>|ErrorResponse

List the caller's workspaces

Parameters

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

Return values

array<string|int, Workspace>|ErrorResponse

listWorkspacesAsync()

Operation listWorkspacesAsync


    public
                    listWorkspacesAsync([string $contentType = self::contentTypes['listWorkspaces'][0] ]) : PromiseInterface

List the caller's workspaces

Parameters

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

Return values

PromiseInterface

listWorkspacesAsyncWithHttpInfo()

Operation listWorkspacesAsyncWithHttpInfo


    public
                    listWorkspacesAsyncWithHttpInfo([string $contentType = self::contentTypes['listWorkspaces'][0] ]) : PromiseInterface

List the caller's workspaces

Parameters

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

Return values

PromiseInterface

listWorkspacesRequest()

Create request for operation 'listWorkspaces'


    public
                    listWorkspacesRequest([string $contentType = self::contentTypes['listWorkspaces'][0] ]) : Request

Parameters

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

Return values

Request

listWorkspacesWithHttpInfo()

Operation listWorkspacesWithHttpInfo


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

List the caller's workspaces

Parameters

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

Return values

array<string|int, mixed> —

publishWorkspace()

Operation publishWorkspace


    public
                    publishWorkspace(PublishWorkspaceRequest $publish_workspace_request[, string $contentType = self::contentTypes['publishWorkspace'][0] ]) : Workspace|ErrorResponse

Publish or unpublish a workspace

Parameters

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

Return values

Workspace|ErrorResponse

publishWorkspaceAsync()

Operation publishWorkspaceAsync


    public
                    publishWorkspaceAsync(PublishWorkspaceRequest $publish_workspace_request[, string $contentType = self::contentTypes['publishWorkspace'][0] ]) : PromiseInterface

Publish or unpublish a workspace

Parameters

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

Return values

PromiseInterface

publishWorkspaceAsyncWithHttpInfo()

Operation publishWorkspaceAsyncWithHttpInfo


    public
                    publishWorkspaceAsyncWithHttpInfo(PublishWorkspaceRequest $publish_workspace_request[, string $contentType = self::contentTypes['publishWorkspace'][0] ]) : PromiseInterface

Publish or unpublish a workspace

Parameters

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

Return values

PromiseInterface

publishWorkspaceRequest()

Create request for operation 'publishWorkspace'


    public
                    publishWorkspaceRequest(PublishWorkspaceRequest $publish_workspace_request[, string $contentType = self::contentTypes['publishWorkspace'][0] ]) : Request

Parameters

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

Return values

Request

publishWorkspaceWithHttpInfo()

Operation publishWorkspaceWithHttpInfo


    public
                    publishWorkspaceWithHttpInfo(PublishWorkspaceRequest $publish_workspace_request[, string $contentType = self::contentTypes['publishWorkspace'][0] ]) : array<string|int, mixed>

Publish or unpublish a workspace

Parameters

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

updateWorkspace()

Operation updateWorkspace


    public
                    updateWorkspace(UpdateWorkspaceRequest $update_workspace_request[, string $contentType = self::contentTypes['updateWorkspace'][0] ]) : void

Change a workspace

Parameters

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

updateWorkspaceAsync()

Operation updateWorkspaceAsync


    public
                    updateWorkspaceAsync(UpdateWorkspaceRequest $update_workspace_request[, string $contentType = self::contentTypes['updateWorkspace'][0] ]) : PromiseInterface

Change a workspace

Parameters

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

Return values

PromiseInterface

updateWorkspaceAsyncWithHttpInfo()

Operation updateWorkspaceAsyncWithHttpInfo


    public
                    updateWorkspaceAsyncWithHttpInfo(UpdateWorkspaceRequest $update_workspace_request[, string $contentType = self::contentTypes['updateWorkspace'][0] ]) : PromiseInterface

Change a workspace

Parameters

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

Return values

PromiseInterface

updateWorkspaceRequest()

Create request for operation 'updateWorkspace'


    public
                    updateWorkspaceRequest(UpdateWorkspaceRequest $update_workspace_request[, string $contentType = self::contentTypes['updateWorkspace'][0] ]) : Request

Parameters

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

Return values

Request

updateWorkspaceWithHttpInfo()

Operation updateWorkspaceWithHttpInfo


    public
                    updateWorkspaceWithHttpInfo(UpdateWorkspaceRequest $update_workspace_request[, string $contentType = self::contentTypes['updateWorkspace'][0] ]) : array<string|int, mixed>

Change a workspace

Parameters

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

Return values

array<string|int, mixed> —

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

createHttpClientOption()

Create http client option


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

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


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

Parameters

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

Return values

array<string|int, mixed>

responseWithinRangeCode()


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

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

WorkspacesApi in package BIMworks

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createWorkspace()

Parameters

Tags

Return values

createWorkspaceAsync()

Parameters

Tags

Return values

createWorkspaceAsyncWithHttpInfo()

Parameters

Tags

Return values

createWorkspaceRequest()

Parameters

Tags

Return values

createWorkspaceWithHttpInfo()

Parameters

Tags

Return values

deleteWorkspace()

Parameters

Tags

deleteWorkspaceAsync()

Parameters

Tags

Return values

deleteWorkspaceAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteWorkspaceRequest()

Parameters

Tags

Return values

deleteWorkspaceWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

listWorkspaces()

Parameters

Tags

Return values

listWorkspacesAsync()

Parameters

Tags

Return values

listWorkspacesAsyncWithHttpInfo()

Parameters

Tags

Return values

listWorkspacesRequest()

Parameters

Tags

Return values

listWorkspacesWithHttpInfo()

Parameters

Tags

Return values

publishWorkspace()

WorkspacesApi
in package

BIMworks