Tectly PHP Client

RoomsApi
in package

Tectly

OpenAPI

RoomsApi Class Doc Comment

Constants

contentTypes = ['addRoom' => ['application/json'], 'fetchRoom' => ['application/json'], 'fetchRooms' => ['application/json'], 'removeRoom' => ['application/json'], 'updateRoom' => ['application/json']]

Properties

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

Methods

__construct() : mixed
addRoom() : Room: Operation addRoom
addRoomAsync() : PromiseInterface: Operation addRoomAsync
addRoomAsyncWithHttpInfo() : PromiseInterface: Operation addRoomAsyncWithHttpInfo
addRoomRequest() : Request: Create request for operation 'addRoom'
addRoomWithHttpInfo() : array<string|int, mixed>: Operation addRoomWithHttpInfo
fetchRoom() : Room: Operation fetchRoom
fetchRoomAsync() : PromiseInterface: Operation fetchRoomAsync
fetchRoomAsyncWithHttpInfo() : PromiseInterface: Operation fetchRoomAsyncWithHttpInfo
fetchRoomRequest() : Request: Create request for operation 'fetchRoom'
fetchRooms() : array<string|int, Room>: Operation fetchRooms
fetchRoomsAsync() : PromiseInterface: Operation fetchRoomsAsync
fetchRoomsAsyncWithHttpInfo() : PromiseInterface: Operation fetchRoomsAsyncWithHttpInfo
fetchRoomsRequest() : Request: Create request for operation 'fetchRooms'
fetchRoomsWithHttpInfo() : array<string|int, mixed>: Operation fetchRoomsWithHttpInfo
fetchRoomWithHttpInfo() : array<string|int, mixed>: Operation fetchRoomWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
removeRoom() : void: Operation removeRoom
removeRoomAsync() : PromiseInterface: Operation removeRoomAsync
removeRoomAsyncWithHttpInfo() : PromiseInterface: Operation removeRoomAsyncWithHttpInfo
removeRoomRequest() : Request: Create request for operation 'removeRoom'
removeRoomWithHttpInfo() : array<string|int, mixed>: Operation removeRoomWithHttpInfo
setHostIndex() : void: Set the host index
updateRoom() : void: Operation updateRoom
updateRoomAsync() : PromiseInterface: Operation updateRoomAsync
updateRoomAsyncWithHttpInfo() : PromiseInterface: Operation updateRoomAsyncWithHttpInfo
updateRoomRequest() : Request: Create request for operation 'updateRoom'
updateRoomWithHttpInfo() : array<string|int, mixed>: Operation updateRoomWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addRoom' => ['application/json'], 'fetchRoom' => ['application/json'], 'fetchRooms' => ['application/json'], 'removeRoom' => ['application/json'], 'updateRoom' => ['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

addRoom()

Operation addRoom


    public
                    addRoom(string $id, RoomCreate $room_create[, string $contentType = self::contentTypes['addRoom'][0] ]) : Room

Add a new room to a floor.

Parameters

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

Return values

Room

addRoomAsync()

Operation addRoomAsync


    public
                    addRoomAsync(string $id, RoomCreate $room_create[, string $contentType = self::contentTypes['addRoom'][0] ]) : PromiseInterface

Add a new room to a floor.

Parameters

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

Return values

PromiseInterface

addRoomAsyncWithHttpInfo()

Operation addRoomAsyncWithHttpInfo


    public
                    addRoomAsyncWithHttpInfo(string $id, RoomCreate $room_create[, string $contentType = self::contentTypes['addRoom'][0] ]) : PromiseInterface

Add a new room to a floor.

Parameters

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

Return values

PromiseInterface

addRoomRequest()

Create request for operation 'addRoom'


    public
                    addRoomRequest(string $id, RoomCreate $room_create[, string $contentType = self::contentTypes['addRoom'][0] ]) : Request

Parameters

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

Return values

Request

addRoomWithHttpInfo()

Operation addRoomWithHttpInfo


    public
                    addRoomWithHttpInfo(string $id, RoomCreate $room_create[, string $contentType = self::contentTypes['addRoom'][0] ]) : array<string|int, mixed>

Add a new room to a floor.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchRoom()

Operation fetchRoom


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

Get a room by its ID

Parameters

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

Return values

Room

fetchRoomAsync()

Operation fetchRoomAsync


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

Get a room by its ID

Parameters

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

Return values

PromiseInterface

fetchRoomAsyncWithHttpInfo()

Operation fetchRoomAsyncWithHttpInfo


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

Get a room by its ID

Parameters

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

Return values

PromiseInterface

fetchRoomRequest()

Create request for operation 'fetchRoom'


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

Parameters

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

Return values

Request

fetchRooms()

Operation fetchRooms


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

Get all rooms of a floor

Parameters

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

Return values

array<string|int, Room>

fetchRoomsAsync()

Operation fetchRoomsAsync


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

Get all rooms of a floor

Parameters

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

Return values

PromiseInterface

fetchRoomsAsyncWithHttpInfo()

Operation fetchRoomsAsyncWithHttpInfo


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

Get all rooms of a floor

Parameters

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

Return values

PromiseInterface

fetchRoomsRequest()

Create request for operation 'fetchRooms'


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

Parameters

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

Return values

Request

fetchRoomsWithHttpInfo()

Operation fetchRoomsWithHttpInfo


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

Get all rooms of a floor

Parameters

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

Return values

array<string|int, mixed> —

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

fetchRoomWithHttpInfo()

Operation fetchRoomWithHttpInfo


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

Get a room by its ID

Parameters

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

Return values

array<string|int, mixed> —

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

removeRoom()

Operation removeRoom


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

Remove a room by its id.

Parameters

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

removeRoomAsync()

Operation removeRoomAsync


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

Remove a room by its id.

Parameters

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

Return values

PromiseInterface

removeRoomAsyncWithHttpInfo()

Operation removeRoomAsyncWithHttpInfo


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

Remove a room by its id.

Parameters

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

Return values

PromiseInterface

removeRoomRequest()

Create request for operation 'removeRoom'


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

Parameters

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

Return values

Request

removeRoomWithHttpInfo()

Operation removeRoomWithHttpInfo


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

Remove a room by its id.

Parameters

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

updateRoom()

Operation updateRoom


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

Update a room by its id.

Parameters

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

updateRoomAsync()

Operation updateRoomAsync


    public
                    updateRoomAsync(string $id, RoomUpdate $room_update[, string $contentType = self::contentTypes['updateRoom'][0] ]) : PromiseInterface

Update a room by its id.

Parameters

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

Return values

PromiseInterface

updateRoomAsyncWithHttpInfo()

Operation updateRoomAsyncWithHttpInfo


    public
                    updateRoomAsyncWithHttpInfo(string $id, RoomUpdate $room_update[, string $contentType = self::contentTypes['updateRoom'][0] ]) : PromiseInterface

Update a room by its id.

Parameters

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

Return values

PromiseInterface

updateRoomRequest()

Create request for operation 'updateRoom'


    public
                    updateRoomRequest(string $id, RoomUpdate $room_update[, string $contentType = self::contentTypes['updateRoom'][0] ]) : Request

Parameters

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

Return values

Request

updateRoomWithHttpInfo()

Operation updateRoomWithHttpInfo


    public
                    updateRoomWithHttpInfo(string $id, RoomUpdate $room_update[, string $contentType = self::contentTypes['updateRoom'][0] ]) : array<string|int, mixed>

Update a room by its id.

Parameters

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

RoomsApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addRoom()

Parameters

Tags

Return values

addRoomAsync()

Parameters

Tags

Return values

addRoomAsyncWithHttpInfo()

Parameters

Tags

Return values

addRoomRequest()

Parameters

Tags

Return values

addRoomWithHttpInfo()

Parameters

Tags

Return values

fetchRoom()

Parameters

Tags

Return values

fetchRoomAsync()

Parameters

Tags

Return values

fetchRoomAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchRoomRequest()

Parameters

Tags

Return values

fetchRooms()

Parameters

Tags

Return values

fetchRoomsAsync()

Parameters

Tags

Return values

fetchRoomsAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchRoomsRequest()

Parameters

Tags

Return values

fetchRoomsWithHttpInfo()

Parameters

Tags

Return values

fetchRoomWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

RoomsApi
in package

Tectly

OpenAPI