Documentation

BluetoothApi

BluetoothApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
getConfig()  : Configuration
getDeviceWirelessBluetoothSettings()  : object
Operation getDeviceWirelessBluetoothSettings
getDeviceWirelessBluetoothSettingsAsync()  : PromiseInterface
Operation getDeviceWirelessBluetoothSettingsAsync
getDeviceWirelessBluetoothSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceWirelessBluetoothSettingsAsyncWithHttpInfo
getDeviceWirelessBluetoothSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceWirelessBluetoothSettingsWithHttpInfo
getNetworkWirelessBluetoothSettings()  : object
Operation getNetworkWirelessBluetoothSettings
getNetworkWirelessBluetoothSettingsAsync()  : PromiseInterface
Operation getNetworkWirelessBluetoothSettingsAsync
getNetworkWirelessBluetoothSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkWirelessBluetoothSettingsAsyncWithHttpInfo
getNetworkWirelessBluetoothSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkWirelessBluetoothSettingsWithHttpInfo
updateDeviceWirelessBluetoothSettings()  : object
Operation updateDeviceWirelessBluetoothSettings
updateDeviceWirelessBluetoothSettingsAsync()  : PromiseInterface
Operation updateDeviceWirelessBluetoothSettingsAsync
updateDeviceWirelessBluetoothSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation updateDeviceWirelessBluetoothSettingsAsyncWithHttpInfo
updateDeviceWirelessBluetoothSettingsWithHttpInfo()  : array<string|int, mixed>
Operation updateDeviceWirelessBluetoothSettingsWithHttpInfo
updateNetworkWirelessBluetoothSettings()  : object
Operation updateNetworkWirelessBluetoothSettings
updateNetworkWirelessBluetoothSettingsAsync()  : PromiseInterface
Operation updateNetworkWirelessBluetoothSettingsAsync
updateNetworkWirelessBluetoothSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation updateNetworkWirelessBluetoothSettingsAsyncWithHttpInfo
updateNetworkWirelessBluetoothSettingsWithHttpInfo()  : array<string|int, mixed>
Operation updateNetworkWirelessBluetoothSettingsWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getDeviceWirelessBluetoothSettingsRequest()  : Request
Create request for operation 'getDeviceWirelessBluetoothSettings'
getNetworkWirelessBluetoothSettingsRequest()  : Request
Create request for operation 'getNetworkWirelessBluetoothSettings'
updateDeviceWirelessBluetoothSettingsRequest()  : Request
Create request for operation 'updateDeviceWirelessBluetoothSettings'
updateNetworkWirelessBluetoothSettingsRequest()  : Request
Create request for operation 'updateNetworkWirelessBluetoothSettings'

Properties

Methods

getDeviceWirelessBluetoothSettings()

Operation getDeviceWirelessBluetoothSettings

public getDeviceWirelessBluetoothSettings(string $serial) : object

Return the bluetooth settings for a wireless device

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getDeviceWirelessBluetoothSettingsAsync()

Operation getDeviceWirelessBluetoothSettingsAsync

public getDeviceWirelessBluetoothSettingsAsync(string $serial) : PromiseInterface

Return the bluetooth settings for a wireless device

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getDeviceWirelessBluetoothSettingsAsyncWithHttpInfo()

Operation getDeviceWirelessBluetoothSettingsAsyncWithHttpInfo

public getDeviceWirelessBluetoothSettingsAsyncWithHttpInfo(string $serial) : PromiseInterface

Return the bluetooth settings for a wireless device

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getDeviceWirelessBluetoothSettingsWithHttpInfo()

Operation getDeviceWirelessBluetoothSettingsWithHttpInfo

public getDeviceWirelessBluetoothSettingsWithHttpInfo(string $serial) : array<string|int, mixed>

Return the bluetooth settings for a wireless device

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessBluetoothSettings()

Operation getNetworkWirelessBluetoothSettings

public getNetworkWirelessBluetoothSettings(string $network_id) : object

Return the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings must be enabled on the network.

Parameters
$network_id : string

network_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getNetworkWirelessBluetoothSettingsAsync()

Operation getNetworkWirelessBluetoothSettingsAsync

public getNetworkWirelessBluetoothSettingsAsync(string $network_id) : PromiseInterface

Return the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings must be enabled on the network.

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessBluetoothSettingsAsyncWithHttpInfo()

Operation getNetworkWirelessBluetoothSettingsAsyncWithHttpInfo

public getNetworkWirelessBluetoothSettingsAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings must be enabled on the network.

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessBluetoothSettingsWithHttpInfo()

Operation getNetworkWirelessBluetoothSettingsWithHttpInfo

public getNetworkWirelessBluetoothSettingsWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings must be enabled on the network.

Parameters
$network_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

updateDeviceWirelessBluetoothSettings()

Operation updateDeviceWirelessBluetoothSettings

public updateDeviceWirelessBluetoothSettings(string $serial[, UpdateDeviceWirelessBluetoothSettings $update_device_wireless_bluetooth_settings = null ]) : object

Update the bluetooth settings for a wireless device

Parameters
$serial : string

serial (required)

$update_device_wireless_bluetooth_settings : UpdateDeviceWirelessBluetoothSettings = null

update_device_wireless_bluetooth_settings (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateDeviceWirelessBluetoothSettingsAsync()

Operation updateDeviceWirelessBluetoothSettingsAsync

public updateDeviceWirelessBluetoothSettingsAsync(string $serial[, UpdateDeviceWirelessBluetoothSettings $update_device_wireless_bluetooth_settings = null ]) : PromiseInterface

Update the bluetooth settings for a wireless device

Parameters
$serial : string

(required)

$update_device_wireless_bluetooth_settings : UpdateDeviceWirelessBluetoothSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateDeviceWirelessBluetoothSettingsAsyncWithHttpInfo()

Operation updateDeviceWirelessBluetoothSettingsAsyncWithHttpInfo

public updateDeviceWirelessBluetoothSettingsAsyncWithHttpInfo(string $serial[, UpdateDeviceWirelessBluetoothSettings $update_device_wireless_bluetooth_settings = null ]) : PromiseInterface

Update the bluetooth settings for a wireless device

Parameters
$serial : string

(required)

$update_device_wireless_bluetooth_settings : UpdateDeviceWirelessBluetoothSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateDeviceWirelessBluetoothSettingsWithHttpInfo()

Operation updateDeviceWirelessBluetoothSettingsWithHttpInfo

public updateDeviceWirelessBluetoothSettingsWithHttpInfo(string $serial[, UpdateDeviceWirelessBluetoothSettings $update_device_wireless_bluetooth_settings = null ]) : array<string|int, mixed>

Update the bluetooth settings for a wireless device

Parameters
$serial : string

(required)

$update_device_wireless_bluetooth_settings : UpdateDeviceWirelessBluetoothSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkWirelessBluetoothSettings()

Operation updateNetworkWirelessBluetoothSettings

public updateNetworkWirelessBluetoothSettings(string $network_id[, UpdateNetworkWirelessBluetoothSettings $update_network_wireless_bluetooth_settings = null ]) : object

Update the Bluetooth settings for a network

Parameters
$network_id : string

network_id (required)

$update_network_wireless_bluetooth_settings : UpdateNetworkWirelessBluetoothSettings = null

update_network_wireless_bluetooth_settings (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateNetworkWirelessBluetoothSettingsAsync()

Operation updateNetworkWirelessBluetoothSettingsAsync

public updateNetworkWirelessBluetoothSettingsAsync(string $network_id[, UpdateNetworkWirelessBluetoothSettings $update_network_wireless_bluetooth_settings = null ]) : PromiseInterface

Update the Bluetooth settings for a network

Parameters
$network_id : string

(required)

$update_network_wireless_bluetooth_settings : UpdateNetworkWirelessBluetoothSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkWirelessBluetoothSettingsAsyncWithHttpInfo()

Operation updateNetworkWirelessBluetoothSettingsAsyncWithHttpInfo

public updateNetworkWirelessBluetoothSettingsAsyncWithHttpInfo(string $network_id[, UpdateNetworkWirelessBluetoothSettings $update_network_wireless_bluetooth_settings = null ]) : PromiseInterface

Update the Bluetooth settings for a network

Parameters
$network_id : string

(required)

$update_network_wireless_bluetooth_settings : UpdateNetworkWirelessBluetoothSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkWirelessBluetoothSettingsWithHttpInfo()

Operation updateNetworkWirelessBluetoothSettingsWithHttpInfo

public updateNetworkWirelessBluetoothSettingsWithHttpInfo(string $network_id[, UpdateNetworkWirelessBluetoothSettings $update_network_wireless_bluetooth_settings = null ]) : array<string|int, mixed>

Update the Bluetooth settings for a network

Parameters
$network_id : string

(required)

$update_network_wireless_bluetooth_settings : UpdateNetworkWirelessBluetoothSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

getDeviceWirelessBluetoothSettingsRequest()

Create request for operation 'getDeviceWirelessBluetoothSettings'

protected getDeviceWirelessBluetoothSettingsRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

getNetworkWirelessBluetoothSettingsRequest()

Create request for operation 'getNetworkWirelessBluetoothSettings'

protected getNetworkWirelessBluetoothSettingsRequest(string $network_id) : Request
Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

updateDeviceWirelessBluetoothSettingsRequest()

Create request for operation 'updateDeviceWirelessBluetoothSettings'

protected updateDeviceWirelessBluetoothSettingsRequest(string $serial[, UpdateDeviceWirelessBluetoothSettings $update_device_wireless_bluetooth_settings = null ]) : Request
Parameters
$serial : string

(required)

$update_device_wireless_bluetooth_settings : UpdateDeviceWirelessBluetoothSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

updateNetworkWirelessBluetoothSettingsRequest()

Create request for operation 'updateNetworkWirelessBluetoothSettings'

protected updateNetworkWirelessBluetoothSettingsRequest(string $network_id[, UpdateNetworkWirelessBluetoothSettings $update_network_wireless_bluetooth_settings = null ]) : Request
Parameters
$network_id : string

(required)

$update_network_wireless_bluetooth_settings : UpdateNetworkWirelessBluetoothSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results