Tectly PHP Client

WallOpeningsApi
in package

Tectly

OpenAPI

WallOpeningsApi Class Doc Comment

Constants

contentTypes = ['addWallOpening' => ['application/json'], 'fetchWallOpening' => ['application/json'], 'fetchWallOpenings' => ['application/json'], 'remove' => ['application/json'], 'updateWallOpening' => ['application/json']]

Properties

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

Methods

__construct() : mixed
addWallOpening() : WallOpening: Operation addWallOpening
addWallOpeningAsync() : PromiseInterface: Operation addWallOpeningAsync
addWallOpeningAsyncWithHttpInfo() : PromiseInterface: Operation addWallOpeningAsyncWithHttpInfo
addWallOpeningRequest() : Request: Create request for operation 'addWallOpening'
addWallOpeningWithHttpInfo() : array<string|int, mixed>: Operation addWallOpeningWithHttpInfo
fetchWallOpening() : WallOpening: Operation fetchWallOpening
fetchWallOpeningAsync() : PromiseInterface: Operation fetchWallOpeningAsync
fetchWallOpeningAsyncWithHttpInfo() : PromiseInterface: Operation fetchWallOpeningAsyncWithHttpInfo
fetchWallOpeningRequest() : Request: Create request for operation 'fetchWallOpening'
fetchWallOpenings() : array<string|int, WallOpening>: Operation fetchWallOpenings
fetchWallOpeningsAsync() : PromiseInterface: Operation fetchWallOpeningsAsync
fetchWallOpeningsAsyncWithHttpInfo() : PromiseInterface: Operation fetchWallOpeningsAsyncWithHttpInfo
fetchWallOpeningsRequest() : Request: Create request for operation 'fetchWallOpenings'
fetchWallOpeningsWithHttpInfo() : array<string|int, mixed>: Operation fetchWallOpeningsWithHttpInfo
fetchWallOpeningWithHttpInfo() : array<string|int, mixed>: Operation fetchWallOpeningWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
remove() : void: Operation remove
removeAsync() : PromiseInterface: Operation removeAsync
removeAsyncWithHttpInfo() : PromiseInterface: Operation removeAsyncWithHttpInfo
removeRequest() : Request: Create request for operation 'remove'
removeWithHttpInfo() : array<string|int, mixed>: Operation removeWithHttpInfo
setHostIndex() : void: Set the host index
updateWallOpening() : void: Operation updateWallOpening
updateWallOpeningAsync() : PromiseInterface: Operation updateWallOpeningAsync
updateWallOpeningAsyncWithHttpInfo() : PromiseInterface: Operation updateWallOpeningAsyncWithHttpInfo
updateWallOpeningRequest() : Request: Create request for operation 'updateWallOpening'
updateWallOpeningWithHttpInfo() : array<string|int, mixed>: Operation updateWallOpeningWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addWallOpening' => ['application/json'], 'fetchWallOpening' => ['application/json'], 'fetchWallOpenings' => ['application/json'], 'remove' => ['application/json'], 'updateWallOpening' => ['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

addWallOpening()

Operation addWallOpening


    public
                    addWallOpening(string $floor_id, WallOpeningCreate $wall_opening_create[, string $contentType = self::contentTypes['addWallOpening'][0] ]) : WallOpening

Add a new wall opening to a floor.

Parameters

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

Return values

WallOpening

addWallOpeningAsync()

Operation addWallOpeningAsync


    public
                    addWallOpeningAsync(string $floor_id, WallOpeningCreate $wall_opening_create[, string $contentType = self::contentTypes['addWallOpening'][0] ]) : PromiseInterface

Add a new wall opening to a floor.

Parameters

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

Return values

PromiseInterface

addWallOpeningAsyncWithHttpInfo()

Operation addWallOpeningAsyncWithHttpInfo


    public
                    addWallOpeningAsyncWithHttpInfo(string $floor_id, WallOpeningCreate $wall_opening_create[, string $contentType = self::contentTypes['addWallOpening'][0] ]) : PromiseInterface

Add a new wall opening to a floor.

Parameters

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

Return values

PromiseInterface

addWallOpeningRequest()

Create request for operation 'addWallOpening'


    public
                    addWallOpeningRequest(string $floor_id, WallOpeningCreate $wall_opening_create[, string $contentType = self::contentTypes['addWallOpening'][0] ]) : Request

Parameters

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

Return values

Request

addWallOpeningWithHttpInfo()

Operation addWallOpeningWithHttpInfo


    public
                    addWallOpeningWithHttpInfo(string $floor_id, WallOpeningCreate $wall_opening_create[, string $contentType = self::contentTypes['addWallOpening'][0] ]) : array<string|int, mixed>

Add a new wall opening to a floor.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchWallOpening()

Operation fetchWallOpening


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

Get a wall opening by its ID

Parameters

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

Return values

WallOpening

fetchWallOpeningAsync()

Operation fetchWallOpeningAsync


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

Get a wall opening by its ID

Parameters

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

Return values

PromiseInterface

fetchWallOpeningAsyncWithHttpInfo()

Operation fetchWallOpeningAsyncWithHttpInfo


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

Get a wall opening by its ID

Parameters

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

Return values

PromiseInterface

fetchWallOpeningRequest()

Create request for operation 'fetchWallOpening'


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

Parameters

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

Return values

Request

fetchWallOpenings()

Operation fetchWallOpenings


    public
                    fetchWallOpenings(string $floor_id[, string $contentType = self::contentTypes['fetchWallOpenings'][0] ]) : array<string|int, WallOpening>

Get all walls openings of a floor.

Parameters

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

Return values

array<string|int, WallOpening>

fetchWallOpeningsAsync()

Operation fetchWallOpeningsAsync


    public
                    fetchWallOpeningsAsync(string $floor_id[, string $contentType = self::contentTypes['fetchWallOpenings'][0] ]) : PromiseInterface

Get all walls openings of a floor.

Parameters

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

Return values

PromiseInterface

fetchWallOpeningsAsyncWithHttpInfo()

Operation fetchWallOpeningsAsyncWithHttpInfo


    public
                    fetchWallOpeningsAsyncWithHttpInfo(string $floor_id[, string $contentType = self::contentTypes['fetchWallOpenings'][0] ]) : PromiseInterface

Get all walls openings of a floor.

Parameters

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

Return values

PromiseInterface

fetchWallOpeningsRequest()

Create request for operation 'fetchWallOpenings'


    public
                    fetchWallOpeningsRequest(string $floor_id[, string $contentType = self::contentTypes['fetchWallOpenings'][0] ]) : Request

Parameters

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

Return values

Request

fetchWallOpeningsWithHttpInfo()

Operation fetchWallOpeningsWithHttpInfo


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

Get all walls openings of a floor.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchWallOpeningWithHttpInfo()

Operation fetchWallOpeningWithHttpInfo


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

Get a wall opening by its ID

Parameters

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

Return values

array<string|int, mixed> —

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

remove()

Operation remove


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

Remove a wall opening by its id.

Parameters

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

removeAsync()

Operation removeAsync


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

Remove a wall opening by its id.

Parameters

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

Return values

PromiseInterface

removeAsyncWithHttpInfo()

Operation removeAsyncWithHttpInfo


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

Remove a wall opening by its id.

Parameters

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

Return values

PromiseInterface

removeRequest()

Create request for operation 'remove'


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

Parameters

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

Return values

Request

removeWithHttpInfo()

Operation removeWithHttpInfo


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

Remove a wall opening by its id.

Parameters

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

updateWallOpening()

Operation updateWallOpening


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

Update a wall opening by its id.

Parameters

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

updateWallOpeningAsync()

Operation updateWallOpeningAsync


    public
                    updateWallOpeningAsync(string $id, WallOpeningUpdate $wall_opening_update[, string $contentType = self::contentTypes['updateWallOpening'][0] ]) : PromiseInterface

Update a wall opening by its id.

Parameters

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

Return values

PromiseInterface

updateWallOpeningAsyncWithHttpInfo()

Operation updateWallOpeningAsyncWithHttpInfo


    public
                    updateWallOpeningAsyncWithHttpInfo(string $id, WallOpeningUpdate $wall_opening_update[, string $contentType = self::contentTypes['updateWallOpening'][0] ]) : PromiseInterface

Update a wall opening by its id.

Parameters

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

Return values

PromiseInterface

updateWallOpeningRequest()

Create request for operation 'updateWallOpening'


    public
                    updateWallOpeningRequest(string $id, WallOpeningUpdate $wall_opening_update[, string $contentType = self::contentTypes['updateWallOpening'][0] ]) : Request

Parameters

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

Return values

Request

updateWallOpeningWithHttpInfo()

Operation updateWallOpeningWithHttpInfo


    public
                    updateWallOpeningWithHttpInfo(string $id, WallOpeningUpdate $wall_opening_update[, string $contentType = self::contentTypes['updateWallOpening'][0] ]) : array<string|int, mixed>

Update a wall opening by its id.

Parameters

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

WallOpeningsApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addWallOpening()

Parameters

Tags

Return values

addWallOpeningAsync()

Parameters

Tags

Return values

addWallOpeningAsyncWithHttpInfo()

Parameters

Tags

Return values

addWallOpeningRequest()

Parameters

Tags

Return values

addWallOpeningWithHttpInfo()

Parameters

Tags

Return values

fetchWallOpening()

Parameters

Tags

Return values

fetchWallOpeningAsync()

Parameters

Tags

Return values

fetchWallOpeningAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchWallOpeningRequest()

Parameters

Tags

Return values

fetchWallOpenings()

Parameters

Tags

Return values

fetchWallOpeningsAsync()

Parameters

Tags

Return values

fetchWallOpeningsAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchWallOpeningsRequest()

Parameters

Tags

Return values

fetchWallOpeningsWithHttpInfo()

Parameters

Tags

Return values

fetchWallOpeningWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

WallOpeningsApi
in package

Tectly

OpenAPI