UsageHistoriesApi
UsageHistoriesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkClientsUsageHistories() : object
- Operation getNetworkClientsUsageHistories
- getNetworkClientsUsageHistoriesAsync() : PromiseInterface
- Operation getNetworkClientsUsageHistoriesAsync
- getNetworkClientsUsageHistoriesAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkClientsUsageHistoriesAsyncWithHttpInfo
- getNetworkClientsUsageHistoriesWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkClientsUsageHistoriesWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkClientsUsageHistoriesRequest() : Request
- Create request for operation 'getNetworkClientsUsageHistories'
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 —getNetworkClientsUsageHistories()
Operation getNetworkClientsUsageHistories
public
getNetworkClientsUsageHistories(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object
Return the usage histories for clients
Parameters
- $network_id : string
-
network_id (required)
- $clients : string
-
A list of client keys, MACs or IPs separated by comma. (required)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
Tags
Return values
object —getNetworkClientsUsageHistoriesAsync()
Operation getNetworkClientsUsageHistoriesAsync
public
getNetworkClientsUsageHistoriesAsync(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface
Return the usage histories for clients
Parameters
- $network_id : string
-
(required)
- $clients : string
-
A list of client keys, MACs or IPs separated by comma. (required)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
Tags
Return values
PromiseInterface —getNetworkClientsUsageHistoriesAsyncWithHttpInfo()
Operation getNetworkClientsUsageHistoriesAsyncWithHttpInfo
public
getNetworkClientsUsageHistoriesAsyncWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface
Return the usage histories for clients
Parameters
- $network_id : string
-
(required)
- $clients : string
-
A list of client keys, MACs or IPs separated by comma. (required)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
Tags
Return values
PromiseInterface —getNetworkClientsUsageHistoriesWithHttpInfo()
Operation getNetworkClientsUsageHistoriesWithHttpInfo
public
getNetworkClientsUsageHistoriesWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>
Return the usage histories for clients
Parameters
- $network_id : string
-
(required)
- $clients : string
-
A list of client keys, MACs or IPs separated by comma. (required)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (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
getNetworkClientsUsageHistoriesRequest()
Create request for operation 'getNetworkClientsUsageHistories'
protected
getNetworkClientsUsageHistoriesRequest(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $clients : string
-
A list of client keys, MACs or IPs separated by comma. (required)
- $ssid_number : int = null
-
An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)