Documentation

RfProfilesApi

RfProfilesApi 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
createNetworkWirelessRfProfile()  : object
Operation createNetworkWirelessRfProfile
createNetworkWirelessRfProfileAsync()  : PromiseInterface
Operation createNetworkWirelessRfProfileAsync
createNetworkWirelessRfProfileAsyncWithHttpInfo()  : PromiseInterface
Operation createNetworkWirelessRfProfileAsyncWithHttpInfo
createNetworkWirelessRfProfileWithHttpInfo()  : array<string|int, mixed>
Operation createNetworkWirelessRfProfileWithHttpInfo
deleteNetworkWirelessRfProfile()  : void
Operation deleteNetworkWirelessRfProfile
deleteNetworkWirelessRfProfileAsync()  : PromiseInterface
Operation deleteNetworkWirelessRfProfileAsync
deleteNetworkWirelessRfProfileAsyncWithHttpInfo()  : PromiseInterface
Operation deleteNetworkWirelessRfProfileAsyncWithHttpInfo
deleteNetworkWirelessRfProfileWithHttpInfo()  : array<string|int, mixed>
Operation deleteNetworkWirelessRfProfileWithHttpInfo
getConfig()  : Configuration
getNetworkWirelessRfProfile()  : object
Operation getNetworkWirelessRfProfile
getNetworkWirelessRfProfileAsync()  : PromiseInterface
Operation getNetworkWirelessRfProfileAsync
getNetworkWirelessRfProfileAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkWirelessRfProfileAsyncWithHttpInfo
getNetworkWirelessRfProfiles()  : object
Operation getNetworkWirelessRfProfiles
getNetworkWirelessRfProfilesAsync()  : PromiseInterface
Operation getNetworkWirelessRfProfilesAsync
getNetworkWirelessRfProfilesAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkWirelessRfProfilesAsyncWithHttpInfo
getNetworkWirelessRfProfilesWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkWirelessRfProfilesWithHttpInfo
getNetworkWirelessRfProfileWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkWirelessRfProfileWithHttpInfo
updateNetworkWirelessRfProfile()  : object
Operation updateNetworkWirelessRfProfile
updateNetworkWirelessRfProfileAsync()  : PromiseInterface
Operation updateNetworkWirelessRfProfileAsync
updateNetworkWirelessRfProfileAsyncWithHttpInfo()  : PromiseInterface
Operation updateNetworkWirelessRfProfileAsyncWithHttpInfo
updateNetworkWirelessRfProfileWithHttpInfo()  : array<string|int, mixed>
Operation updateNetworkWirelessRfProfileWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
createNetworkWirelessRfProfileRequest()  : Request
Create request for operation 'createNetworkWirelessRfProfile'
deleteNetworkWirelessRfProfileRequest()  : Request
Create request for operation 'deleteNetworkWirelessRfProfile'
getNetworkWirelessRfProfileRequest()  : Request
Create request for operation 'getNetworkWirelessRfProfile'
getNetworkWirelessRfProfilesRequest()  : Request
Create request for operation 'getNetworkWirelessRfProfiles'
updateNetworkWirelessRfProfileRequest()  : Request
Create request for operation 'updateNetworkWirelessRfProfile'

Properties

Methods

createNetworkWirelessRfProfile()

Operation createNetworkWirelessRfProfile

public createNetworkWirelessRfProfile(string $network_id, CreateNetworkWirelessRfProfile $create_network_wireless_rf_profile) : object

Creates new RF profile for this network

Parameters
$network_id : string

network_id (required)

$create_network_wireless_rf_profile : CreateNetworkWirelessRfProfile

create_network_wireless_rf_profile (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

createNetworkWirelessRfProfileAsync()

Operation createNetworkWirelessRfProfileAsync

public createNetworkWirelessRfProfileAsync(string $network_id, CreateNetworkWirelessRfProfile $create_network_wireless_rf_profile) : PromiseInterface

Creates new RF profile for this network

Parameters
$network_id : string

(required)

$create_network_wireless_rf_profile : CreateNetworkWirelessRfProfile

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createNetworkWirelessRfProfileAsyncWithHttpInfo()

Operation createNetworkWirelessRfProfileAsyncWithHttpInfo

public createNetworkWirelessRfProfileAsyncWithHttpInfo(string $network_id, CreateNetworkWirelessRfProfile $create_network_wireless_rf_profile) : PromiseInterface

Creates new RF profile for this network

Parameters
$network_id : string

(required)

$create_network_wireless_rf_profile : CreateNetworkWirelessRfProfile

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createNetworkWirelessRfProfileWithHttpInfo()

Operation createNetworkWirelessRfProfileWithHttpInfo

public createNetworkWirelessRfProfileWithHttpInfo(string $network_id, CreateNetworkWirelessRfProfile $create_network_wireless_rf_profile) : array<string|int, mixed>

Creates new RF profile for this network

Parameters
$network_id : string

(required)

$create_network_wireless_rf_profile : CreateNetworkWirelessRfProfile

(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)

deleteNetworkWirelessRfProfile()

Operation deleteNetworkWirelessRfProfile

public deleteNetworkWirelessRfProfile(string $network_id, string $rf_profile_id) : void

Delete a RF Profile

Parameters
$network_id : string

network_id (required)

$rf_profile_id : string

rf_profile_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteNetworkWirelessRfProfileAsync()

Operation deleteNetworkWirelessRfProfileAsync

public deleteNetworkWirelessRfProfileAsync(string $network_id, string $rf_profile_id) : PromiseInterface

Delete a RF Profile

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteNetworkWirelessRfProfileAsyncWithHttpInfo()

Operation deleteNetworkWirelessRfProfileAsyncWithHttpInfo

public deleteNetworkWirelessRfProfileAsyncWithHttpInfo(string $network_id, string $rf_profile_id) : PromiseInterface

Delete a RF Profile

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteNetworkWirelessRfProfileWithHttpInfo()

Operation deleteNetworkWirelessRfProfileWithHttpInfo

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

Delete a RF Profile

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
ApiException

on non-2xx response

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

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

getNetworkWirelessRfProfile()

Operation getNetworkWirelessRfProfile

public getNetworkWirelessRfProfile(string $network_id, string $rf_profile_id) : object

Return a RF profile

Parameters
$network_id : string

network_id (required)

$rf_profile_id : string

rf_profile_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getNetworkWirelessRfProfileAsync()

Operation getNetworkWirelessRfProfileAsync

public getNetworkWirelessRfProfileAsync(string $network_id, string $rf_profile_id) : PromiseInterface

Return a RF profile

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessRfProfileAsyncWithHttpInfo()

Operation getNetworkWirelessRfProfileAsyncWithHttpInfo

public getNetworkWirelessRfProfileAsyncWithHttpInfo(string $network_id, string $rf_profile_id) : PromiseInterface

Return a RF profile

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessRfProfiles()

Operation getNetworkWirelessRfProfiles

public getNetworkWirelessRfProfiles(string $network_id[, bool $include_template_profiles = null ]) : object

List the non-basic RF profiles for this network

Parameters
$network_id : string

network_id (required)

$include_template_profiles : bool = null

If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getNetworkWirelessRfProfilesAsync()

Operation getNetworkWirelessRfProfilesAsync

public getNetworkWirelessRfProfilesAsync(string $network_id[, bool $include_template_profiles = null ]) : PromiseInterface

List the non-basic RF profiles for this network

Parameters
$network_id : string

(required)

$include_template_profiles : bool = null

If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessRfProfilesAsyncWithHttpInfo()

Operation getNetworkWirelessRfProfilesAsyncWithHttpInfo

public getNetworkWirelessRfProfilesAsyncWithHttpInfo(string $network_id[, bool $include_template_profiles = null ]) : PromiseInterface

List the non-basic RF profiles for this network

Parameters
$network_id : string

(required)

$include_template_profiles : bool = null

If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkWirelessRfProfilesWithHttpInfo()

Operation getNetworkWirelessRfProfilesWithHttpInfo

public getNetworkWirelessRfProfilesWithHttpInfo(string $network_id[, bool $include_template_profiles = null ]) : array<string|int, mixed>

List the non-basic RF profiles for this network

Parameters
$network_id : string

(required)

$include_template_profiles : bool = null

If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. (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)

getNetworkWirelessRfProfileWithHttpInfo()

Operation getNetworkWirelessRfProfileWithHttpInfo

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

Return a RF profile

Parameters
$network_id : string

(required)

$rf_profile_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)

updateNetworkWirelessRfProfile()

Operation updateNetworkWirelessRfProfile

public updateNetworkWirelessRfProfile(string $network_id, string $rf_profile_id[, UpdateNetworkWirelessRfProfile $update_network_wireless_rf_profile = null ]) : object

Updates specified RF profile for this network

Parameters
$network_id : string

network_id (required)

$rf_profile_id : string

rf_profile_id (required)

$update_network_wireless_rf_profile : UpdateNetworkWirelessRfProfile = null

update_network_wireless_rf_profile (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateNetworkWirelessRfProfileAsync()

Operation updateNetworkWirelessRfProfileAsync

public updateNetworkWirelessRfProfileAsync(string $network_id, string $rf_profile_id[, UpdateNetworkWirelessRfProfile $update_network_wireless_rf_profile = null ]) : PromiseInterface

Updates specified RF profile for this network

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

$update_network_wireless_rf_profile : UpdateNetworkWirelessRfProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkWirelessRfProfileAsyncWithHttpInfo()

Operation updateNetworkWirelessRfProfileAsyncWithHttpInfo

public updateNetworkWirelessRfProfileAsyncWithHttpInfo(string $network_id, string $rf_profile_id[, UpdateNetworkWirelessRfProfile $update_network_wireless_rf_profile = null ]) : PromiseInterface

Updates specified RF profile for this network

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

$update_network_wireless_rf_profile : UpdateNetworkWirelessRfProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkWirelessRfProfileWithHttpInfo()

Operation updateNetworkWirelessRfProfileWithHttpInfo

public updateNetworkWirelessRfProfileWithHttpInfo(string $network_id, string $rf_profile_id[, UpdateNetworkWirelessRfProfile $update_network_wireless_rf_profile = null ]) : array<string|int, mixed>

Updates specified RF profile for this network

Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

$update_network_wireless_rf_profile : UpdateNetworkWirelessRfProfile = 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

createNetworkWirelessRfProfileRequest()

Create request for operation 'createNetworkWirelessRfProfile'

protected createNetworkWirelessRfProfileRequest(string $network_id, CreateNetworkWirelessRfProfile $create_network_wireless_rf_profile) : Request
Parameters
$network_id : string

(required)

$create_network_wireless_rf_profile : CreateNetworkWirelessRfProfile

(required)

Tags
throws
InvalidArgumentException
Return values
Request

deleteNetworkWirelessRfProfileRequest()

Create request for operation 'deleteNetworkWirelessRfProfile'

protected deleteNetworkWirelessRfProfileRequest(string $network_id, string $rf_profile_id) : Request
Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

getNetworkWirelessRfProfileRequest()

Create request for operation 'getNetworkWirelessRfProfile'

protected getNetworkWirelessRfProfileRequest(string $network_id, string $rf_profile_id) : Request
Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

getNetworkWirelessRfProfilesRequest()

Create request for operation 'getNetworkWirelessRfProfiles'

protected getNetworkWirelessRfProfilesRequest(string $network_id[, bool $include_template_profiles = null ]) : Request
Parameters
$network_id : string

(required)

$include_template_profiles : bool = null

If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. (optional)

Tags
throws
InvalidArgumentException
Return values
Request

updateNetworkWirelessRfProfileRequest()

Create request for operation 'updateNetworkWirelessRfProfile'

protected updateNetworkWirelessRfProfileRequest(string $network_id, string $rf_profile_id[, UpdateNetworkWirelessRfProfile $update_network_wireless_rf_profile = null ]) : Request
Parameters
$network_id : string

(required)

$rf_profile_id : string

(required)

$update_network_wireless_rf_profile : UpdateNetworkWirelessRfProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results