TrafficHistoryApi
TrafficHistoryApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkClientTrafficHistory() : object
- Operation getNetworkClientTrafficHistory
- getNetworkClientTrafficHistoryAsync() : PromiseInterface
- Operation getNetworkClientTrafficHistoryAsync
- getNetworkClientTrafficHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkClientTrafficHistoryAsyncWithHttpInfo
- getNetworkClientTrafficHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkClientTrafficHistoryWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkClientTrafficHistoryRequest() : Request
- Create request for operation 'getNetworkClientTrafficHistory'
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 —getNetworkClientTrafficHistory()
Operation getNetworkClientTrafficHistory
public
getNetworkClientTrafficHistory(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object
Return the client's network traffic data over time
Parameters
- $network_id : string
-
network_id (required)
- $client_id : string
-
client_id (required)
- $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)
Tags
Return values
object —getNetworkClientTrafficHistoryAsync()
Operation getNetworkClientTrafficHistoryAsync
public
getNetworkClientTrafficHistoryAsync(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface
Return the client's network traffic data over time
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $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)
Tags
Return values
PromiseInterface —getNetworkClientTrafficHistoryAsyncWithHttpInfo()
Operation getNetworkClientTrafficHistoryAsyncWithHttpInfo
public
getNetworkClientTrafficHistoryAsyncWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface
Return the client's network traffic data over time
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $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)
Tags
Return values
PromiseInterface —getNetworkClientTrafficHistoryWithHttpInfo()
Operation getNetworkClientTrafficHistoryWithHttpInfo
public
getNetworkClientTrafficHistoryWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>
Return the client's network traffic data over time
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $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)
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
getNetworkClientTrafficHistoryRequest()
Create request for operation 'getNetworkClientTrafficHistory'
protected
getNetworkClientTrafficHistoryRequest(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $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)