Tectly PHP Client

PlansApi
in package

Tectly

OpenAPI

PlansApi Class Doc Comment

Constants

contentTypes = ['addPlan' => ['application/json'], 'fetchPlan' => ['application/json'], 'removePlan' => ['application/json'], 'updatePlan' => ['application/json']]

Properties

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

Methods

__construct() : mixed
addPlan() : Plan: Operation addPlan
addPlanAsync() : PromiseInterface: Operation addPlanAsync
addPlanAsyncWithHttpInfo() : PromiseInterface: Operation addPlanAsyncWithHttpInfo
addPlanRequest() : Request: Create request for operation 'addPlan'
addPlanWithHttpInfo() : array<string|int, mixed>: Operation addPlanWithHttpInfo
fetchPlan() : Plan: Operation fetchPlan
fetchPlanAsync() : PromiseInterface: Operation fetchPlanAsync
fetchPlanAsyncWithHttpInfo() : PromiseInterface: Operation fetchPlanAsyncWithHttpInfo
fetchPlanRequest() : Request: Create request for operation 'fetchPlan'
fetchPlanWithHttpInfo() : array<string|int, mixed>: Operation fetchPlanWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
removePlan() : void: Operation removePlan
removePlanAsync() : PromiseInterface: Operation removePlanAsync
removePlanAsyncWithHttpInfo() : PromiseInterface: Operation removePlanAsyncWithHttpInfo
removePlanRequest() : Request: Create request for operation 'removePlan'
removePlanWithHttpInfo() : array<string|int, mixed>: Operation removePlanWithHttpInfo
setHostIndex() : void: Set the host index
updatePlan() : void: Operation updatePlan
updatePlanAsync() : PromiseInterface: Operation updatePlanAsync
updatePlanAsyncWithHttpInfo() : PromiseInterface: Operation updatePlanAsyncWithHttpInfo
updatePlanRequest() : Request: Create request for operation 'updatePlan'
updatePlanWithHttpInfo() : array<string|int, mixed>: Operation updatePlanWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['addPlan' => ['application/json'], 'fetchPlan' => ['application/json'], 'removePlan' => ['application/json'], 'updatePlan' => ['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

addPlan()

Operation addPlan


    public
                    addPlan(string $id, PlanCreate $plan_create[, string $contentType = self::contentTypes['addPlan'][0] ]) : Plan

Add a new plan to a document page.

Parameters

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

Return values

Plan

addPlanAsync()

Operation addPlanAsync


    public
                    addPlanAsync(string $id, PlanCreate $plan_create[, string $contentType = self::contentTypes['addPlan'][0] ]) : PromiseInterface

Add a new plan to a document page.

Parameters

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

Return values

PromiseInterface

addPlanAsyncWithHttpInfo()

Operation addPlanAsyncWithHttpInfo


    public
                    addPlanAsyncWithHttpInfo(string $id, PlanCreate $plan_create[, string $contentType = self::contentTypes['addPlan'][0] ]) : PromiseInterface

Add a new plan to a document page.

Parameters

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

Return values

PromiseInterface

addPlanRequest()

Create request for operation 'addPlan'


    public
                    addPlanRequest(string $id, PlanCreate $plan_create[, string $contentType = self::contentTypes['addPlan'][0] ]) : Request

Parameters

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

Return values

Request

addPlanWithHttpInfo()

Operation addPlanWithHttpInfo


    public
                    addPlanWithHttpInfo(string $id, PlanCreate $plan_create[, string $contentType = self::contentTypes['addPlan'][0] ]) : array<string|int, mixed>

Add a new plan to a document page.

Parameters

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

Return values

array<string|int, mixed> —

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

fetchPlan()

Operation fetchPlan


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

Get a plan and all recognized assets its id.

Parameters

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

Return values

Plan

fetchPlanAsync()

Operation fetchPlanAsync


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

Get a plan and all recognized assets its id.

Parameters

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

Return values

PromiseInterface

fetchPlanAsyncWithHttpInfo()

Operation fetchPlanAsyncWithHttpInfo


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

Get a plan and all recognized assets its id.

Parameters

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

Return values

PromiseInterface

fetchPlanRequest()

Create request for operation 'fetchPlan'


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

Parameters

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

Return values

Request

fetchPlanWithHttpInfo()

Operation fetchPlanWithHttpInfo


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

Get a plan and all recognized assets its id.

Parameters

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

Return values

array<string|int, mixed> —

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

removePlan()

Operation removePlan


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

Delete a plan.

Parameters

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

removePlanAsync()

Operation removePlanAsync


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

Delete a plan.

Parameters

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

Return values

PromiseInterface

removePlanAsyncWithHttpInfo()

Operation removePlanAsyncWithHttpInfo


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

Delete a plan.

Parameters

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

Return values

PromiseInterface

removePlanRequest()

Create request for operation 'removePlan'


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

Parameters

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

Return values

Request

removePlanWithHttpInfo()

Operation removePlanWithHttpInfo


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

Delete a plan.

Parameters

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

updatePlan()

Operation updatePlan


    public
                    updatePlan(string $plan_id, PlanUpdate $plan_update[, string $contentType = self::contentTypes['updatePlan'][0] ]) : void

Update page section that contains the floor plan in plan description.

Parameters

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

updatePlanAsync()

Operation updatePlanAsync


    public
                    updatePlanAsync(string $plan_id, PlanUpdate $plan_update[, string $contentType = self::contentTypes['updatePlan'][0] ]) : PromiseInterface

Update page section that contains the floor plan in plan description.

Parameters

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

Return values

PromiseInterface

updatePlanAsyncWithHttpInfo()

Operation updatePlanAsyncWithHttpInfo


    public
                    updatePlanAsyncWithHttpInfo(string $plan_id, PlanUpdate $plan_update[, string $contentType = self::contentTypes['updatePlan'][0] ]) : PromiseInterface

Update page section that contains the floor plan in plan description.

Parameters

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

Return values

PromiseInterface

updatePlanRequest()

Create request for operation 'updatePlan'


    public
                    updatePlanRequest(string $plan_id, PlanUpdate $plan_update[, string $contentType = self::contentTypes['updatePlan'][0] ]) : Request

Parameters

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

Return values

Request

updatePlanWithHttpInfo()

Operation updatePlanWithHttpInfo


    public
                    updatePlanWithHttpInfo(string $plan_id, PlanUpdate $plan_update[, string $contentType = self::contentTypes['updatePlan'][0] ]) : array<string|int, mixed>

Update page section that contains the floor plan in plan description.

Parameters

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

PlansApi in package Tectly OpenAPI

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

addPlan()

Parameters

Tags

Return values

addPlanAsync()

Parameters

Tags

Return values

addPlanAsyncWithHttpInfo()

Parameters

Tags

Return values

addPlanRequest()

Parameters

Tags

Return values

addPlanWithHttpInfo()

Parameters

Tags

Return values

fetchPlan()

Parameters

Tags

Return values

fetchPlanAsync()

Parameters

Tags

Return values

fetchPlanAsyncWithHttpInfo()

Parameters

Tags

Return values

fetchPlanRequest()

Parameters

Tags

Return values

fetchPlanWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

removePlan()

Parameters

Tags

removePlanAsync()

Parameters

Tags

Return values

removePlanAsyncWithHttpInfo()

Parameters

Tags

Return values

removePlanRequest()

Parameters

Tags

Return values

removePlanWithHttpInfo()

Parameters

Tags

Return values

setHostIndex()

PlansApi
in package

Tectly

OpenAPI