FloorPlansApi
FloorPlansApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createNetworkFloorPlan() : object
- Operation createNetworkFloorPlan
- createNetworkFloorPlanAsync() : PromiseInterface
- Operation createNetworkFloorPlanAsync
- createNetworkFloorPlanAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkFloorPlanAsyncWithHttpInfo
- createNetworkFloorPlanWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkFloorPlanWithHttpInfo
- deleteNetworkFloorPlan() : void
- Operation deleteNetworkFloorPlan
- deleteNetworkFloorPlanAsync() : PromiseInterface
- Operation deleteNetworkFloorPlanAsync
- deleteNetworkFloorPlanAsyncWithHttpInfo() : PromiseInterface
- Operation deleteNetworkFloorPlanAsyncWithHttpInfo
- deleteNetworkFloorPlanWithHttpInfo() : array<string|int, mixed>
- Operation deleteNetworkFloorPlanWithHttpInfo
- getConfig() : Configuration
- getNetworkFloorPlan() : object
- Operation getNetworkFloorPlan
- getNetworkFloorPlanAsync() : PromiseInterface
- Operation getNetworkFloorPlanAsync
- getNetworkFloorPlanAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkFloorPlanAsyncWithHttpInfo
- getNetworkFloorPlans() : object
- Operation getNetworkFloorPlans
- getNetworkFloorPlansAsync() : PromiseInterface
- Operation getNetworkFloorPlansAsync
- getNetworkFloorPlansAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkFloorPlansAsyncWithHttpInfo
- getNetworkFloorPlansWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkFloorPlansWithHttpInfo
- getNetworkFloorPlanWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkFloorPlanWithHttpInfo
- updateNetworkFloorPlan() : object
- Operation updateNetworkFloorPlan
- updateNetworkFloorPlanAsync() : PromiseInterface
- Operation updateNetworkFloorPlanAsync
- updateNetworkFloorPlanAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkFloorPlanAsyncWithHttpInfo
- updateNetworkFloorPlanWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkFloorPlanWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createNetworkFloorPlanRequest() : Request
- Create request for operation 'createNetworkFloorPlan'
- deleteNetworkFloorPlanRequest() : Request
- Create request for operation 'deleteNetworkFloorPlan'
- getNetworkFloorPlanRequest() : Request
- Create request for operation 'getNetworkFloorPlan'
- getNetworkFloorPlansRequest() : Request
- Create request for operation 'getNetworkFloorPlans'
- updateNetworkFloorPlanRequest() : Request
- Create request for operation 'updateNetworkFloorPlan'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —createNetworkFloorPlan()
Operation createNetworkFloorPlan
public
createNetworkFloorPlan(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : object
Upload a floor plan
Parameters
- $network_id : string
-
network_id (required)
- $create_network_floor_plan : CreateNetworkFloorPlan
-
create_network_floor_plan (required)
Tags
Return values
object —createNetworkFloorPlanAsync()
Operation createNetworkFloorPlanAsync
public
createNetworkFloorPlanAsync(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : PromiseInterface
Upload a floor plan
Parameters
- $network_id : string
-
(required)
- $create_network_floor_plan : CreateNetworkFloorPlan
-
(required)
Tags
Return values
PromiseInterface —createNetworkFloorPlanAsyncWithHttpInfo()
Operation createNetworkFloorPlanAsyncWithHttpInfo
public
createNetworkFloorPlanAsyncWithHttpInfo(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : PromiseInterface
Upload a floor plan
Parameters
- $network_id : string
-
(required)
- $create_network_floor_plan : CreateNetworkFloorPlan
-
(required)
Tags
Return values
PromiseInterface —createNetworkFloorPlanWithHttpInfo()
Operation createNetworkFloorPlanWithHttpInfo
public
createNetworkFloorPlanWithHttpInfo(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : array<string|int, mixed>
Upload a floor plan
Parameters
- $network_id : string
-
(required)
- $create_network_floor_plan : CreateNetworkFloorPlan
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteNetworkFloorPlan()
Operation deleteNetworkFloorPlan
public
deleteNetworkFloorPlan(string $network_id, string $floor_plan_id) : void
Destroy a floor plan
Parameters
- $network_id : string
-
network_id (required)
- $floor_plan_id : string
-
floor_plan_id (required)
Tags
Return values
void —deleteNetworkFloorPlanAsync()
Operation deleteNetworkFloorPlanAsync
public
deleteNetworkFloorPlanAsync(string $network_id, string $floor_plan_id) : PromiseInterface
Destroy a floor plan
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkFloorPlanAsyncWithHttpInfo()
Operation deleteNetworkFloorPlanAsyncWithHttpInfo
public
deleteNetworkFloorPlanAsyncWithHttpInfo(string $network_id, string $floor_plan_id) : PromiseInterface
Destroy a floor plan
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkFloorPlanWithHttpInfo()
Operation deleteNetworkFloorPlanWithHttpInfo
public
deleteNetworkFloorPlanWithHttpInfo(string $network_id, string $floor_plan_id) : array<string|int, mixed>
Destroy a floor plan
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkFloorPlan()
Operation getNetworkFloorPlan
public
getNetworkFloorPlan(string $network_id, string $floor_plan_id) : object
Find a floor plan by ID
Parameters
- $network_id : string
-
network_id (required)
- $floor_plan_id : string
-
floor_plan_id (required)
Tags
Return values
object —getNetworkFloorPlanAsync()
Operation getNetworkFloorPlanAsync
public
getNetworkFloorPlanAsync(string $network_id, string $floor_plan_id) : PromiseInterface
Find a floor plan by ID
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkFloorPlanAsyncWithHttpInfo()
Operation getNetworkFloorPlanAsyncWithHttpInfo
public
getNetworkFloorPlanAsyncWithHttpInfo(string $network_id, string $floor_plan_id) : PromiseInterface
Find a floor plan by ID
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkFloorPlans()
Operation getNetworkFloorPlans
public
getNetworkFloorPlans(string $network_id) : object
List the floor plans that belong to your network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkFloorPlansAsync()
Operation getNetworkFloorPlansAsync
public
getNetworkFloorPlansAsync(string $network_id) : PromiseInterface
List the floor plans that belong to your network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkFloorPlansAsyncWithHttpInfo()
Operation getNetworkFloorPlansAsyncWithHttpInfo
public
getNetworkFloorPlansAsyncWithHttpInfo(string $network_id) : PromiseInterface
List the floor plans that belong to your network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkFloorPlansWithHttpInfo()
Operation getNetworkFloorPlansWithHttpInfo
public
getNetworkFloorPlansWithHttpInfo(string $network_id) : array<string|int, mixed>
List the floor plans that belong to your network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkFloorPlanWithHttpInfo()
Operation getNetworkFloorPlanWithHttpInfo
public
getNetworkFloorPlanWithHttpInfo(string $network_id, string $floor_plan_id) : array<string|int, mixed>
Find a floor plan by ID
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkFloorPlan()
Operation updateNetworkFloorPlan
public
updateNetworkFloorPlan(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : object
Update a floor plan's geolocation and other meta data
Parameters
- $network_id : string
-
network_id (required)
- $floor_plan_id : string
-
floor_plan_id (required)
- $update_network_floor_plan : UpdateNetworkFloorPlan = null
-
update_network_floor_plan (optional)
Tags
Return values
object —updateNetworkFloorPlanAsync()
Operation updateNetworkFloorPlanAsync
public
updateNetworkFloorPlanAsync(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : PromiseInterface
Update a floor plan's geolocation and other meta data
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
- $update_network_floor_plan : UpdateNetworkFloorPlan = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkFloorPlanAsyncWithHttpInfo()
Operation updateNetworkFloorPlanAsyncWithHttpInfo
public
updateNetworkFloorPlanAsyncWithHttpInfo(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : PromiseInterface
Update a floor plan's geolocation and other meta data
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
- $update_network_floor_plan : UpdateNetworkFloorPlan = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkFloorPlanWithHttpInfo()
Operation updateNetworkFloorPlanWithHttpInfo
public
updateNetworkFloorPlanWithHttpInfo(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : array<string|int, mixed>
Update a floor plan's geolocation and other meta data
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
- $update_network_floor_plan : UpdateNetworkFloorPlan = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createNetworkFloorPlanRequest()
Create request for operation 'createNetworkFloorPlan'
protected
createNetworkFloorPlanRequest(string $network_id, CreateNetworkFloorPlan $create_network_floor_plan) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_floor_plan : CreateNetworkFloorPlan
-
(required)
Tags
Return values
Request —deleteNetworkFloorPlanRequest()
Create request for operation 'deleteNetworkFloorPlan'
protected
deleteNetworkFloorPlanRequest(string $network_id, string $floor_plan_id) : Request
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
Request —getNetworkFloorPlanRequest()
Create request for operation 'getNetworkFloorPlan'
protected
getNetworkFloorPlanRequest(string $network_id, string $floor_plan_id) : Request
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
Tags
Return values
Request —getNetworkFloorPlansRequest()
Create request for operation 'getNetworkFloorPlans'
protected
getNetworkFloorPlansRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —updateNetworkFloorPlanRequest()
Create request for operation 'updateNetworkFloorPlan'
protected
updateNetworkFloorPlanRequest(string $network_id, string $floor_plan_id[, UpdateNetworkFloorPlan $update_network_floor_plan = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $floor_plan_id : string
-
(required)
- $update_network_floor_plan : UpdateNetworkFloorPlan = null
-
(optional)