Tectly PHP Client

FloorsApi
in package

Tectly

OpenAPI

FloorsApi Class Doc Comment

Constants

contentTypes = ['addFloor' => ['application/json'], 'fetchFloor' => ['application/json'], 'fetchFloors' => ['application/json'], 'removeFloor' => ['application/json'], 'updateFloor' => ['application/json']]

Properties

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

Methods

__construct() : mixed
addFloor() : Floor: Operation addFloor
addFloorAsync() : PromiseInterface: Operation addFloorAsync
addFloorAsyncWithHttpInfo() : PromiseInterface: Operation addFloorAsyncWithHttpInfo
addFloorRequest() : Request: Create request for operation 'addFloor'
addFloorWithHttpInfo() : array<string|int, mixed>: Operation addFloorWithHttpInfo
fetchFloor() : Floor: Operation fetchFloor
fetchFloorAsync() : PromiseInterface: Operation fetchFloorAsync
fetchFloorAsyncWithHttpInfo() : PromiseInterface: Operation fetchFloorAsyncWithHttpInfo
fetchFloorRequest() : Request: Create request for operation 'fetchFloor'
fetchFloors() : array<string|int, Floor>: Operation fetchFloors
fetchFloorsAsync() : PromiseInterface: Operation fetchFloorsAsync
fetchFloorsAsyncWithHttpInfo() : PromiseInterface: Operation fetchFloorsAsyncWithHttpInfo
fetchFloorsRequest() : Request: Create request for operation 'fetchFloors'
fetchFloorsWithHttpInfo() : array<string|int, mixed>: Operation fetchFloorsWithHttpInfo
fetchFloorWithHttpInfo() : array<string|int, mixed>: Operation fetchFloorWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
removeFloor() : void: Operation removeFloor
removeFloorAsync() : PromiseInterface: Operation removeFloorAsync
removeFloorAsyncWithHttpInfo() : PromiseInterface: Operation removeFloorAsyncWithHttpInfo
removeFloorRequest() : Request: Create request for operation 'removeFloor'
removeFloorWithHttpInfo() : array<string|int, mixed>: Operation removeFloorWithHttpInfo
setHostIndex() : void: Set the host index
updateFloor() : void: Operation updateFloor
updateFloorAsync() : PromiseInterface: Operation updateFloorAsync
updateFloorAsyncWithHttpInfo() : PromiseInterface: Operation updateFloorAsyncWithHttpInfo
updateFloorRequest() : Request: Create request for operation 'updateFloor'
updateFloorWithHttpInfo() : array<string|int, mixed>: Operation updateFloorWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addFloor' => ['application/json'], 'fetchFloor' => ['application/json'], 'fetchFloors' => ['application/json'], 'removeFloor' => ['application/json'], 'updateFloor' => ['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

addFloor()

Operation addFloor


    public
                    addFloor(string $id, FloorCreate $floor_create[, string $contentType = self::contentTypes['addFloor'][0] ]) : Floor

Add a new floor to a project.

Parameters

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

Return values

Floor

addFloorAsync()

Operation addFloorAsync


    public
                    addFloorAsync(string $id, FloorCreate $floor_create[, string $contentType = self::contentTypes['addFloor'][0] ]) : PromiseInterface

Add a new floor to a project.

Parameters

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

Return values

PromiseInterface

addFloorAsyncWithHttpInfo()

Operation addFloorAsyncWithHttpInfo


    public
                    addFloorAsyncWithHttpInfo(string $id, FloorCreate $floor_create[, string $contentType = self::contentTypes['addFloor'][0] ]) : PromiseInterface

Add a new floor to a project.

Parameters

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

Return values

PromiseInterface

addFloorRequest()

Create request for operation 'addFloor'


    public
                    addFloorRequest(string $id, FloorCreate $floor_create[, string $contentType = self::contentTypes['addFloor'][0] ]) : Request

Parameters

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

Return values

Request

addFloorWithHttpInfo()

Operation addFloorWithHttpInfo


    public
                    addFloorWithHttpInfo(string $id, FloorCreate $floor_create[, string $contentType = self::contentTypes['addFloor'][0] ]) : array<string|int, mixed>

Add a new floor to a project.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchFloor()

Operation fetchFloor


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

Get a floor by its ID

Parameters

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

Return values

Floor

fetchFloorAsync()

Operation fetchFloorAsync


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

Get a floor by its ID

Parameters

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

Return values

PromiseInterface

fetchFloorAsyncWithHttpInfo()

Operation fetchFloorAsyncWithHttpInfo


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

Get a floor by its ID

Parameters

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

Return values

PromiseInterface

fetchFloorRequest()

Create request for operation 'fetchFloor'


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

Parameters

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

Return values

Request

fetchFloors()

Operation fetchFloors


    public
                    fetchFloors(string $project_id[, string $contentType = self::contentTypes['fetchFloors'][0] ]) : array<string|int, Floor>

Get all floors of a project.

Parameters

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

Return values

array<string|int, Floor>

fetchFloorsAsync()

Operation fetchFloorsAsync


    public
                    fetchFloorsAsync(string $project_id[, string $contentType = self::contentTypes['fetchFloors'][0] ]) : PromiseInterface

Get all floors of a project.

Parameters

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

Return values

PromiseInterface

fetchFloorsAsyncWithHttpInfo()

Operation fetchFloorsAsyncWithHttpInfo


    public
                    fetchFloorsAsyncWithHttpInfo(string $project_id[, string $contentType = self::contentTypes['fetchFloors'][0] ]) : PromiseInterface

Get all floors of a project.

Parameters

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

Return values

PromiseInterface

fetchFloorsRequest()

Create request for operation 'fetchFloors'


    public
                    fetchFloorsRequest(string $project_id[, string $contentType = self::contentTypes['fetchFloors'][0] ]) : Request

Parameters

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

Return values

Request

fetchFloorsWithHttpInfo()

Operation fetchFloorsWithHttpInfo


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

Get all floors of a project.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchFloorWithHttpInfo()

Operation fetchFloorWithHttpInfo


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

Get a floor by its ID

Parameters

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

Return values

array<string|int, mixed> —

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

removeFloor()

Operation removeFloor


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

Remove a floor by its id.

Parameters

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

removeFloorAsync()

Operation removeFloorAsync


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

Remove a floor by its id.

Parameters

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

Return values

PromiseInterface

removeFloorAsyncWithHttpInfo()

Operation removeFloorAsyncWithHttpInfo


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

Remove a floor by its id.

Parameters

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

Return values

PromiseInterface

removeFloorRequest()

Create request for operation 'removeFloor'


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

Parameters

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

Return values

Request

removeFloorWithHttpInfo()

Operation removeFloorWithHttpInfo


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

Remove a floor by its id.

Parameters

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

updateFloor()

Operation updateFloor


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

Update a floor by its id.

Parameters

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

updateFloorAsync()

Operation updateFloorAsync


    public
                    updateFloorAsync(string $id, FloorUpdate $floor_update[, string $contentType = self::contentTypes['updateFloor'][0] ]) : PromiseInterface

Update a floor by its id.

Parameters

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

Return values

PromiseInterface

updateFloorAsyncWithHttpInfo()

Operation updateFloorAsyncWithHttpInfo


    public
                    updateFloorAsyncWithHttpInfo(string $id, FloorUpdate $floor_update[, string $contentType = self::contentTypes['updateFloor'][0] ]) : PromiseInterface

Update a floor by its id.

Parameters

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

Return values

PromiseInterface

updateFloorRequest()

Create request for operation 'updateFloor'


    public
                    updateFloorRequest(string $id, FloorUpdate $floor_update[, string $contentType = self::contentTypes['updateFloor'][0] ]) : Request

Parameters

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

Return values

Request

updateFloorWithHttpInfo()

Operation updateFloorWithHttpInfo


    public
                    updateFloorWithHttpInfo(string $id, FloorUpdate $floor_update[, string $contentType = self::contentTypes['updateFloor'][0] ]) : array<string|int, mixed>

Update a floor by its id.

Parameters

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

FloorsApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addFloor()

Parameters

Tags

Return values

addFloorAsync()

Parameters

Tags

Return values

addFloorAsyncWithHttpInfo()

Parameters

Tags

Return values

addFloorRequest()

Parameters

Tags

Return values

addFloorWithHttpInfo()

Parameters

Tags

Return values

fetchFloor()

Parameters

Tags

Return values

fetchFloorAsync()

Parameters

Tags

Return values

fetchFloorAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchFloorRequest()

Parameters

Tags

Return values

fetchFloors()

Parameters

Tags

Return values

fetchFloorsAsync()

Parameters

Tags

Return values

fetchFloorsAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchFloorsRequest()

Parameters

Tags

Return values

fetchFloorsWithHttpInfo()

Parameters

Tags

Return values

fetchFloorWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

FloorsApi
in package

Tectly

OpenAPI