Tectly PHP Client

WallsApi
in package

Tectly

OpenAPI

WallsApi Class Doc Comment

Constants

contentTypes = ['addWall' => ['application/json'], 'fetchWall' => ['application/json'], 'fetchWalls' => ['application/json'], 'removeWall' => ['application/json'], 'updateWall' => ['application/json']]

Properties

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

Methods

__construct() : mixed
addWall() : Wall: Operation addWall
addWallAsync() : PromiseInterface: Operation addWallAsync
addWallAsyncWithHttpInfo() : PromiseInterface: Operation addWallAsyncWithHttpInfo
addWallRequest() : Request: Create request for operation 'addWall'
addWallWithHttpInfo() : array<string|int, mixed>: Operation addWallWithHttpInfo
fetchWall() : Wall: Operation fetchWall
fetchWallAsync() : PromiseInterface: Operation fetchWallAsync
fetchWallAsyncWithHttpInfo() : PromiseInterface: Operation fetchWallAsyncWithHttpInfo
fetchWallRequest() : Request: Create request for operation 'fetchWall'
fetchWalls() : array<string|int, Wall>: Operation fetchWalls
fetchWallsAsync() : PromiseInterface: Operation fetchWallsAsync
fetchWallsAsyncWithHttpInfo() : PromiseInterface: Operation fetchWallsAsyncWithHttpInfo
fetchWallsRequest() : Request: Create request for operation 'fetchWalls'
fetchWallsWithHttpInfo() : array<string|int, mixed>: Operation fetchWallsWithHttpInfo
fetchWallWithHttpInfo() : array<string|int, mixed>: Operation fetchWallWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
removeWall() : void: Operation removeWall
removeWallAsync() : PromiseInterface: Operation removeWallAsync
removeWallAsyncWithHttpInfo() : PromiseInterface: Operation removeWallAsyncWithHttpInfo
removeWallRequest() : Request: Create request for operation 'removeWall'
removeWallWithHttpInfo() : array<string|int, mixed>: Operation removeWallWithHttpInfo
setHostIndex() : void: Set the host index
updateWall() : void: Operation updateWall
updateWallAsync() : PromiseInterface: Operation updateWallAsync
updateWallAsyncWithHttpInfo() : PromiseInterface: Operation updateWallAsyncWithHttpInfo
updateWallRequest() : Request: Create request for operation 'updateWall'
updateWallWithHttpInfo() : array<string|int, mixed>: Operation updateWallWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addWall' => ['application/json'], 'fetchWall' => ['application/json'], 'fetchWalls' => ['application/json'], 'removeWall' => ['application/json'], 'updateWall' => ['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

addWall()

Operation addWall


    public
                    addWall(string $id, WallCreate $wall_create[, string $contentType = self::contentTypes['addWall'][0] ]) : Wall

Add a new wall to a floor.

Parameters

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

Return values

Wall

addWallAsync()

Operation addWallAsync


    public
                    addWallAsync(string $id, WallCreate $wall_create[, string $contentType = self::contentTypes['addWall'][0] ]) : PromiseInterface

Add a new wall to a floor.

Parameters

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

Return values

PromiseInterface

addWallAsyncWithHttpInfo()

Operation addWallAsyncWithHttpInfo


    public
                    addWallAsyncWithHttpInfo(string $id, WallCreate $wall_create[, string $contentType = self::contentTypes['addWall'][0] ]) : PromiseInterface

Add a new wall to a floor.

Parameters

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

Return values

PromiseInterface

addWallRequest()

Create request for operation 'addWall'


    public
                    addWallRequest(string $id, WallCreate $wall_create[, string $contentType = self::contentTypes['addWall'][0] ]) : Request

Parameters

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

Return values

Request

addWallWithHttpInfo()

Operation addWallWithHttpInfo


    public
                    addWallWithHttpInfo(string $id, WallCreate $wall_create[, string $contentType = self::contentTypes['addWall'][0] ]) : array<string|int, mixed>

Add a new wall to a floor.

Parameters

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

Return values

array<string|int, mixed> —

of \Tectly\OpenAPI\Model\Wall|\Tectly\OpenAPI\Model\Wall, HTTP status code, HTTP response headers (array of strings)

fetchWall()

Operation fetchWall


    public
                    fetchWall(string $id[, string $contentType = self::contentTypes['fetchWall'][0] ]) : Wall

Get a wall by its ID

Parameters

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

Return values

Wall

fetchWallAsync()

Operation fetchWallAsync


    public
                    fetchWallAsync(string $id[, string $contentType = self::contentTypes['fetchWall'][0] ]) : PromiseInterface

Get a wall by its ID

Parameters

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

Return values

PromiseInterface

fetchWallAsyncWithHttpInfo()

Operation fetchWallAsyncWithHttpInfo


    public
                    fetchWallAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['fetchWall'][0] ]) : PromiseInterface

Get a wall by its ID

Parameters

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

Return values

PromiseInterface

fetchWallRequest()

Create request for operation 'fetchWall'


    public
                    fetchWallRequest(string $id[, string $contentType = self::contentTypes['fetchWall'][0] ]) : Request

Parameters

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

Return values

Request

fetchWalls()

Operation fetchWalls


    public
                    fetchWalls(string $id[, string $contentType = self::contentTypes['fetchWalls'][0] ]) : array<string|int, Wall>

Get all walls of a floor.

Parameters

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

Return values

array<string|int, Wall>

fetchWallsAsync()

Operation fetchWallsAsync


    public
                    fetchWallsAsync(string $id[, string $contentType = self::contentTypes['fetchWalls'][0] ]) : PromiseInterface

Get all walls of a floor.

Parameters

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

Return values

PromiseInterface

fetchWallsAsyncWithHttpInfo()

Operation fetchWallsAsyncWithHttpInfo


    public
                    fetchWallsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['fetchWalls'][0] ]) : PromiseInterface

Get all walls of a floor.

Parameters

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

Return values

PromiseInterface

fetchWallsRequest()

Create request for operation 'fetchWalls'


    public
                    fetchWallsRequest(string $id[, string $contentType = self::contentTypes['fetchWalls'][0] ]) : Request

Parameters

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

Return values

Request

fetchWallsWithHttpInfo()

Operation fetchWallsWithHttpInfo


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

Get all walls of a floor.

Parameters

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

Return values

array<string|int, mixed> —

of \Tectly\OpenAPI\Model\Wall[], HTTP status code, HTTP response headers (array of strings)

fetchWallWithHttpInfo()

Operation fetchWallWithHttpInfo


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

Get a wall by its ID

Parameters

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

Return values

array<string|int, mixed> —

of \Tectly\OpenAPI\Model\Wall, 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

removeWall()

Operation removeWall


    public
                    removeWall(string $id[, string $contentType = self::contentTypes['removeWall'][0] ]) : void

Remove a wall by its id.

Parameters

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

removeWallAsync()

Operation removeWallAsync


    public
                    removeWallAsync(string $id[, string $contentType = self::contentTypes['removeWall'][0] ]) : PromiseInterface

Remove a wall by its id.

Parameters

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

Return values

PromiseInterface

removeWallAsyncWithHttpInfo()

Operation removeWallAsyncWithHttpInfo


    public
                    removeWallAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['removeWall'][0] ]) : PromiseInterface

Remove a wall by its id.

Parameters

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

Return values

PromiseInterface

removeWallRequest()

Create request for operation 'removeWall'


    public
                    removeWallRequest(string $id[, string $contentType = self::contentTypes['removeWall'][0] ]) : Request

Parameters

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

Return values

Request

removeWallWithHttpInfo()

Operation removeWallWithHttpInfo


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

Remove a wall by its id.

Parameters

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

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

updateWall()

Operation updateWall


    public
                    updateWall(string $id, WallUpdate $wall_update[, string $contentType = self::contentTypes['updateWall'][0] ]) : void

Update a wall by its id.

Parameters

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

updateWallAsync()

Operation updateWallAsync


    public
                    updateWallAsync(string $id, WallUpdate $wall_update[, string $contentType = self::contentTypes['updateWall'][0] ]) : PromiseInterface

Update a wall by its id.

Parameters

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

Return values

PromiseInterface

updateWallAsyncWithHttpInfo()

Operation updateWallAsyncWithHttpInfo


    public
                    updateWallAsyncWithHttpInfo(string $id, WallUpdate $wall_update[, string $contentType = self::contentTypes['updateWall'][0] ]) : PromiseInterface

Update a wall by its id.

Parameters

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

Return values

PromiseInterface

updateWallRequest()

Create request for operation 'updateWall'


    public
                    updateWallRequest(string $id, WallUpdate $wall_update[, string $contentType = self::contentTypes['updateWall'][0] ]) : Request

Parameters

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

Return values

Request

updateWallWithHttpInfo()

Operation updateWallWithHttpInfo


    public
                    updateWallWithHttpInfo(string $id, WallUpdate $wall_update[, string $contentType = self::contentTypes['updateWall'][0] ]) : array<string|int, mixed>

Update a wall by its id.

Parameters

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

WallsApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addWall()

Parameters

Tags

Return values

addWallAsync()

Parameters

Tags

Return values

addWallAsyncWithHttpInfo()

Parameters

Tags

Return values

addWallRequest()

Parameters

Tags

Return values

addWallWithHttpInfo()

Parameters

Tags

Return values

fetchWall()

Parameters

Tags

Return values

fetchWallAsync()

Parameters

Tags

Return values

fetchWallAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchWallRequest()

Parameters

Tags

Return values

fetchWalls()

Parameters

Tags

Return values

fetchWallsAsync()

Parameters

Tags

Return values

fetchWallsAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchWallsRequest()

Parameters

Tags

Return values

fetchWallsWithHttpInfo()

Parameters

Tags

Return values

fetchWallWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

WallsApi
in package

Tectly

OpenAPI