Documentation

AdminApi
in package

AdminApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  : array<string|int, string> = ['listAccountUserFeatures' => ['application/jso...

Properties

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

Methods

__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
listAccounts()  : array<string|int, AccountEntry>|ErrorResponse
Operation listAccounts
listAccountsAsync()  : PromiseInterface
Operation listAccountsAsync
listAccountsAsyncWithHttpInfo()  : PromiseInterface
Operation listAccountsAsyncWithHttpInfo
listAccountsRequest()  : Request
Create request for operation 'listAccounts'
listAccountsWithHttpInfo()  : array<string|int, mixed>
Operation listAccountsWithHttpInfo
listAccountUserFeatures()  : array<string|int, UserFeatureState>|ErrorResponse
Operation listAccountUserFeatures
listAccountUserFeaturesAsync()  : PromiseInterface
Operation listAccountUserFeaturesAsync
listAccountUserFeaturesAsyncWithHttpInfo()  : PromiseInterface
Operation listAccountUserFeaturesAsyncWithHttpInfo
listAccountUserFeaturesRequest()  : Request
Create request for operation 'listAccountUserFeatures'
listAccountUserFeaturesWithHttpInfo()  : array<string|int, mixed>
Operation listAccountUserFeaturesWithHttpInfo
listOrganizations()  : array<string|int, Organization>|ErrorResponse
Operation listOrganizations
listOrganizationsAsync()  : PromiseInterface
Operation listOrganizationsAsync
listOrganizationsAsyncWithHttpInfo()  : PromiseInterface
Operation listOrganizationsAsyncWithHttpInfo
listOrganizationsRequest()  : Request
Create request for operation 'listOrganizations'
listOrganizationsWithHttpInfo()  : array<string|int, mixed>
Operation listOrganizationsWithHttpInfo
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

public array<string|int, string> contentTypes = ['listAccountUserFeatures' => ['application/json'], 'listAccounts' => ['application/json'], 'listOrganizations' => ['application/json']]

Properties

$client

protected ClientInterface $client

$hostIndex

protected int $hostIndex

Host index

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

listAccounts()

Operation listAccounts

public listAccounts([ListAccountsRequest|null $list_accounts_request = null ][, string $contentType = self::contentTypes['listAccounts'][0] ]) : array<string|int, AccountEntry>|ErrorResponse

List the accounts of the organization

Parameters
$list_accounts_request : ListAccountsRequest|null = null

list_accounts_request (optional)

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

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

Tags
throws
ApiException

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

InvalidArgumentException
Return values
array<string|int, AccountEntry>|ErrorResponse

listAccountsAsync()

Operation listAccountsAsync

public listAccountsAsync([ListAccountsRequest|null $list_accounts_request = null ][, string $contentType = self::contentTypes['listAccounts'][0] ]) : PromiseInterface

List the accounts of the organization

Parameters
$list_accounts_request : ListAccountsRequest|null = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listAccountsAsyncWithHttpInfo()

Operation listAccountsAsyncWithHttpInfo

public listAccountsAsyncWithHttpInfo([ListAccountsRequest|null $list_accounts_request = null ][, string $contentType = self::contentTypes['listAccounts'][0] ]) : PromiseInterface

List the accounts of the organization

Parameters
$list_accounts_request : ListAccountsRequest|null = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listAccountsRequest()

Create request for operation 'listAccounts'

public listAccountsRequest([ListAccountsRequest|null $list_accounts_request = null ][, string $contentType = self::contentTypes['listAccounts'][0] ]) : Request
Parameters
$list_accounts_request : ListAccountsRequest|null = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

listAccountsWithHttpInfo()

Operation listAccountsWithHttpInfo

public listAccountsWithHttpInfo([ListAccountsRequest|null $list_accounts_request = null ][, string $contentType = self::contentTypes['listAccounts'][0] ]) : array<string|int, mixed>

List the accounts of the organization

Parameters
$list_accounts_request : ListAccountsRequest|null = null

(optional)

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

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

Tags
throws
ApiException

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

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

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

listAccountUserFeatures()

Operation listAccountUserFeatures

public listAccountUserFeatures([ListAccountUserFeaturesRequest|null $list_account_user_features_request = null ][, string $contentType = self::contentTypes['listAccountUserFeatures'][0] ]) : array<string|int, UserFeatureState>|ErrorResponse

The user features of an account

Parameters
$list_account_user_features_request : ListAccountUserFeaturesRequest|null = null

list_account_user_features_request (optional)

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

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

Tags
throws
ApiException

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

InvalidArgumentException
Return values
array<string|int, UserFeatureState>|ErrorResponse

listAccountUserFeaturesAsync()

Operation listAccountUserFeaturesAsync

public listAccountUserFeaturesAsync([ListAccountUserFeaturesRequest|null $list_account_user_features_request = null ][, string $contentType = self::contentTypes['listAccountUserFeatures'][0] ]) : PromiseInterface

The user features of an account

Parameters
$list_account_user_features_request : ListAccountUserFeaturesRequest|null = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listAccountUserFeaturesAsyncWithHttpInfo()

Operation listAccountUserFeaturesAsyncWithHttpInfo

public listAccountUserFeaturesAsyncWithHttpInfo([ListAccountUserFeaturesRequest|null $list_account_user_features_request = null ][, string $contentType = self::contentTypes['listAccountUserFeatures'][0] ]) : PromiseInterface

The user features of an account

Parameters
$list_account_user_features_request : ListAccountUserFeaturesRequest|null = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listAccountUserFeaturesRequest()

Create request for operation 'listAccountUserFeatures'

public listAccountUserFeaturesRequest([ListAccountUserFeaturesRequest|null $list_account_user_features_request = null ][, string $contentType = self::contentTypes['listAccountUserFeatures'][0] ]) : Request
Parameters
$list_account_user_features_request : ListAccountUserFeaturesRequest|null = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

listAccountUserFeaturesWithHttpInfo()

Operation listAccountUserFeaturesWithHttpInfo

public listAccountUserFeaturesWithHttpInfo([ListAccountUserFeaturesRequest|null $list_account_user_features_request = null ][, string $contentType = self::contentTypes['listAccountUserFeatures'][0] ]) : array<string|int, mixed>

The user features of an account

Parameters
$list_account_user_features_request : ListAccountUserFeaturesRequest|null = null

(optional)

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

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

Tags
throws
ApiException

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

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

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

listOrganizations()

Operation listOrganizations

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

The caller's organization

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

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

Tags
throws
ApiException

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

InvalidArgumentException
Return values
array<string|int, Organization>|ErrorResponse

listOrganizationsAsync()

Operation listOrganizationsAsync

public listOrganizationsAsync([string $contentType = self::contentTypes['listOrganizations'][0] ]) : PromiseInterface

The caller's organization

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listOrganizationsAsyncWithHttpInfo()

Operation listOrganizationsAsyncWithHttpInfo

public listOrganizationsAsyncWithHttpInfo([string $contentType = self::contentTypes['listOrganizations'][0] ]) : PromiseInterface

The caller's organization

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

listOrganizationsRequest()

Create request for operation 'listOrganizations'

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

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

Tags
throws
InvalidArgumentException
Return values
Request

listOrganizationsWithHttpInfo()

Operation listOrganizationsWithHttpInfo

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

The caller's organization

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

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

Tags
throws
ApiException

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

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

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

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

createHttpClientOption()

Create http client option

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

on file opening failure

Return values
array<string|int, mixed> —

of http client options

handleResponseWithDataType()

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

responseWithinRangeCode()

private responseWithinRangeCode(string $rangeCode, int $statusCode) : bool
Parameters
$rangeCode : string
$statusCode : int
Return values
bool
On this page

Search results