Tectly PHP Client

ScaleLinesApi
in package

Tectly

OpenAPI

ScaleLinesApi Class Doc Comment

Constants

contentTypes = ['addScaleLine' => ['application/json'], 'fetchScaleLine' => ['application/json'], 'fetchScaleLines' => ['application/json'], 'removeScaleLine' => ['application/json'], 'updateScaleLine' => ['application/json']]

Properties

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

Methods

__construct() : mixed
addScaleLine() : ScaleLine: Operation addScaleLine
addScaleLineAsync() : PromiseInterface: Operation addScaleLineAsync
addScaleLineAsyncWithHttpInfo() : PromiseInterface: Operation addScaleLineAsyncWithHttpInfo
addScaleLineRequest() : Request: Create request for operation 'addScaleLine'
addScaleLineWithHttpInfo() : array<string|int, mixed>: Operation addScaleLineWithHttpInfo
fetchScaleLine() : ScaleLine: Operation fetchScaleLine
fetchScaleLineAsync() : PromiseInterface: Operation fetchScaleLineAsync
fetchScaleLineAsyncWithHttpInfo() : PromiseInterface: Operation fetchScaleLineAsyncWithHttpInfo
fetchScaleLineRequest() : Request: Create request for operation 'fetchScaleLine'
fetchScaleLines() : array<string|int, ScaleLine>: Operation fetchScaleLines
fetchScaleLinesAsync() : PromiseInterface: Operation fetchScaleLinesAsync
fetchScaleLinesAsyncWithHttpInfo() : PromiseInterface: Operation fetchScaleLinesAsyncWithHttpInfo
fetchScaleLinesRequest() : Request: Create request for operation 'fetchScaleLines'
fetchScaleLinesWithHttpInfo() : array<string|int, mixed>: Operation fetchScaleLinesWithHttpInfo
fetchScaleLineWithHttpInfo() : array<string|int, mixed>: Operation fetchScaleLineWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
removeScaleLine() : void: Operation removeScaleLine
removeScaleLineAsync() : PromiseInterface: Operation removeScaleLineAsync
removeScaleLineAsyncWithHttpInfo() : PromiseInterface: Operation removeScaleLineAsyncWithHttpInfo
removeScaleLineRequest() : Request: Create request for operation 'removeScaleLine'
removeScaleLineWithHttpInfo() : array<string|int, mixed>: Operation removeScaleLineWithHttpInfo
setHostIndex() : void: Set the host index
updateScaleLine() : void: Operation updateScaleLine
updateScaleLineAsync() : PromiseInterface: Operation updateScaleLineAsync
updateScaleLineAsyncWithHttpInfo() : PromiseInterface: Operation updateScaleLineAsyncWithHttpInfo
updateScaleLineRequest() : Request: Create request for operation 'updateScaleLine'
updateScaleLineWithHttpInfo() : array<string|int, mixed>: Operation updateScaleLineWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addScaleLine' => ['application/json'], 'fetchScaleLine' => ['application/json'], 'fetchScaleLines' => ['application/json'], 'removeScaleLine' => ['application/json'], 'updateScaleLine' => ['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

addScaleLine()

Operation addScaleLine


    public
                    addScaleLine(string $id, ScaleLineCreate $scale_line_create[, string $contentType = self::contentTypes['addScaleLine'][0] ]) : ScaleLine

Add a new scale line to a floor.

Parameters

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

Return values

ScaleLine

addScaleLineAsync()

Operation addScaleLineAsync


    public
                    addScaleLineAsync(string $id, ScaleLineCreate $scale_line_create[, string $contentType = self::contentTypes['addScaleLine'][0] ]) : PromiseInterface

Add a new scale line to a floor.

Parameters

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

Return values

PromiseInterface

addScaleLineAsyncWithHttpInfo()

Operation addScaleLineAsyncWithHttpInfo


    public
                    addScaleLineAsyncWithHttpInfo(string $id, ScaleLineCreate $scale_line_create[, string $contentType = self::contentTypes['addScaleLine'][0] ]) : PromiseInterface

Add a new scale line to a floor.

Parameters

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

Return values

PromiseInterface

addScaleLineRequest()

Create request for operation 'addScaleLine'


    public
                    addScaleLineRequest(string $id, ScaleLineCreate $scale_line_create[, string $contentType = self::contentTypes['addScaleLine'][0] ]) : Request

Parameters

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

Return values

Request

addScaleLineWithHttpInfo()

Operation addScaleLineWithHttpInfo


    public
                    addScaleLineWithHttpInfo(string $id, ScaleLineCreate $scale_line_create[, string $contentType = self::contentTypes['addScaleLine'][0] ]) : array<string|int, mixed>

Add a new scale line to a floor.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchScaleLine()

Operation fetchScaleLine


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

Get a scale line by its ID

Parameters

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

Return values

ScaleLine

fetchScaleLineAsync()

Operation fetchScaleLineAsync


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

Get a scale line by its ID

Parameters

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

Return values

PromiseInterface

fetchScaleLineAsyncWithHttpInfo()

Operation fetchScaleLineAsyncWithHttpInfo


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

Get a scale line by its ID

Parameters

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

Return values

PromiseInterface

fetchScaleLineRequest()

Create request for operation 'fetchScaleLine'


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

Parameters

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

Return values

Request

fetchScaleLines()

Operation fetchScaleLines


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

Get all scale lines of a floor.

Parameters

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

Return values

array<string|int, ScaleLine>

fetchScaleLinesAsync()

Operation fetchScaleLinesAsync


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

Get all scale lines of a floor.

Parameters

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

Return values

PromiseInterface

fetchScaleLinesAsyncWithHttpInfo()

Operation fetchScaleLinesAsyncWithHttpInfo


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

Get all scale lines of a floor.

Parameters

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

Return values

PromiseInterface

fetchScaleLinesRequest()

Create request for operation 'fetchScaleLines'


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

Parameters

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

Return values

Request

fetchScaleLinesWithHttpInfo()

Operation fetchScaleLinesWithHttpInfo


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

Get all scale lines of a floor.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchScaleLineWithHttpInfo()

Operation fetchScaleLineWithHttpInfo


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

Get a scale line by its ID

Parameters

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

Return values

array<string|int, mixed> —

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

removeScaleLine()

Operation removeScaleLine


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

Remove a scale line by its id.

Parameters

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

removeScaleLineAsync()

Operation removeScaleLineAsync


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

Remove a scale line by its id.

Parameters

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

Return values

PromiseInterface

removeScaleLineAsyncWithHttpInfo()

Operation removeScaleLineAsyncWithHttpInfo


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

Remove a scale line by its id.

Parameters

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

Return values

PromiseInterface

removeScaleLineRequest()

Create request for operation 'removeScaleLine'


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

Parameters

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

Return values

Request

removeScaleLineWithHttpInfo()

Operation removeScaleLineWithHttpInfo


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

Remove a scale line by its id.

Parameters

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

updateScaleLine()

Operation updateScaleLine


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

Update a scale line by its id.

Parameters

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

updateScaleLineAsync()

Operation updateScaleLineAsync


    public
                    updateScaleLineAsync(string $id, ScaleLineUpdate $scale_line_update[, string $contentType = self::contentTypes['updateScaleLine'][0] ]) : PromiseInterface

Update a scale line by its id.

Parameters

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

Return values

PromiseInterface

updateScaleLineAsyncWithHttpInfo()

Operation updateScaleLineAsyncWithHttpInfo


    public
                    updateScaleLineAsyncWithHttpInfo(string $id, ScaleLineUpdate $scale_line_update[, string $contentType = self::contentTypes['updateScaleLine'][0] ]) : PromiseInterface

Update a scale line by its id.

Parameters

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

Return values

PromiseInterface

updateScaleLineRequest()

Create request for operation 'updateScaleLine'


    public
                    updateScaleLineRequest(string $id, ScaleLineUpdate $scale_line_update[, string $contentType = self::contentTypes['updateScaleLine'][0] ]) : Request

Parameters

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

Return values

Request

updateScaleLineWithHttpInfo()

Operation updateScaleLineWithHttpInfo


    public
                    updateScaleLineWithHttpInfo(string $id, ScaleLineUpdate $scale_line_update[, string $contentType = self::contentTypes['updateScaleLine'][0] ]) : array<string|int, mixed>

Update a scale line by its id.

Parameters

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

ScaleLinesApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addScaleLine()

Parameters

Tags

Return values

addScaleLineAsync()

Parameters

Tags

Return values

addScaleLineAsyncWithHttpInfo()

Parameters

Tags

Return values

addScaleLineRequest()

Parameters

Tags

Return values

addScaleLineWithHttpInfo()

Parameters

Tags

Return values

fetchScaleLine()

Parameters

Tags

Return values

fetchScaleLineAsync()

Parameters

Tags

Return values

fetchScaleLineAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchScaleLineRequest()

Parameters

Tags

Return values

fetchScaleLines()

Parameters

Tags

Return values

fetchScaleLinesAsync()

Parameters

Tags

Return values

fetchScaleLinesAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchScaleLinesRequest()

Parameters

Tags

Return values

fetchScaleLinesWithHttpInfo()

Parameters

Tags

Return values

fetchScaleLineWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

ScaleLinesApi
in package

Tectly

OpenAPI