AlertsApi
AlertsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkAlertsSettings() : object
- Operation getNetworkAlertsSettings
- getNetworkAlertsSettingsAsync() : PromiseInterface
- Operation getNetworkAlertsSettingsAsync
- getNetworkAlertsSettingsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkAlertsSettingsAsyncWithHttpInfo
- getNetworkAlertsSettingsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkAlertsSettingsWithHttpInfo
- updateNetworkAlertsSettings() : object
- Operation updateNetworkAlertsSettings
- updateNetworkAlertsSettingsAsync() : PromiseInterface
- Operation updateNetworkAlertsSettingsAsync
- updateNetworkAlertsSettingsAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkAlertsSettingsAsyncWithHttpInfo
- updateNetworkAlertsSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkAlertsSettingsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkAlertsSettingsRequest() : Request
- Create request for operation 'getNetworkAlertsSettings'
- updateNetworkAlertsSettingsRequest() : Request
- Create request for operation 'updateNetworkAlertsSettings'
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 —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkAlertsSettings()
Operation getNetworkAlertsSettings
public
getNetworkAlertsSettings(string $network_id) : object
Return the alert configuration for this network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkAlertsSettingsAsync()
Operation getNetworkAlertsSettingsAsync
public
getNetworkAlertsSettingsAsync(string $network_id) : PromiseInterface
Return the alert configuration for this network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkAlertsSettingsAsyncWithHttpInfo()
Operation getNetworkAlertsSettingsAsyncWithHttpInfo
public
getNetworkAlertsSettingsAsyncWithHttpInfo(string $network_id) : PromiseInterface
Return the alert configuration for this network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkAlertsSettingsWithHttpInfo()
Operation getNetworkAlertsSettingsWithHttpInfo
public
getNetworkAlertsSettingsWithHttpInfo(string $network_id) : array<string|int, mixed>
Return the alert configuration for this network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkAlertsSettings()
Operation updateNetworkAlertsSettings
public
updateNetworkAlertsSettings(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : object
Update the alert configuration for this network
Parameters
- $network_id : string
-
network_id (required)
- $update_network_alerts_settings : UpdateNetworkAlertsSettings = null
-
update_network_alerts_settings (optional)
Tags
Return values
object —updateNetworkAlertsSettingsAsync()
Operation updateNetworkAlertsSettingsAsync
public
updateNetworkAlertsSettingsAsync(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : PromiseInterface
Update the alert configuration for this network
Parameters
- $network_id : string
-
(required)
- $update_network_alerts_settings : UpdateNetworkAlertsSettings = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkAlertsSettingsAsyncWithHttpInfo()
Operation updateNetworkAlertsSettingsAsyncWithHttpInfo
public
updateNetworkAlertsSettingsAsyncWithHttpInfo(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : PromiseInterface
Update the alert configuration for this network
Parameters
- $network_id : string
-
(required)
- $update_network_alerts_settings : UpdateNetworkAlertsSettings = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkAlertsSettingsWithHttpInfo()
Operation updateNetworkAlertsSettingsWithHttpInfo
public
updateNetworkAlertsSettingsWithHttpInfo(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : array<string|int, mixed>
Update the alert configuration for this network
Parameters
- $network_id : string
-
(required)
- $update_network_alerts_settings : UpdateNetworkAlertsSettings = 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
getNetworkAlertsSettingsRequest()
Create request for operation 'getNetworkAlertsSettings'
protected
getNetworkAlertsSettingsRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —updateNetworkAlertsSettingsRequest()
Create request for operation 'updateNetworkAlertsSettings'
protected
updateNetworkAlertsSettingsRequest(string $network_id[, UpdateNetworkAlertsSettings $update_network_alerts_settings = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_alerts_settings : UpdateNetworkAlertsSettings = null
-
(optional)