TargetGroupsApi
TargetGroupsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createNetworkSmTargetGroup() : object
- Operation createNetworkSmTargetGroup
- createNetworkSmTargetGroupAsync() : PromiseInterface
- Operation createNetworkSmTargetGroupAsync
- createNetworkSmTargetGroupAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkSmTargetGroupAsyncWithHttpInfo
- createNetworkSmTargetGroupWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkSmTargetGroupWithHttpInfo
- deleteNetworkSmTargetGroup() : void
- Operation deleteNetworkSmTargetGroup
- deleteNetworkSmTargetGroupAsync() : PromiseInterface
- Operation deleteNetworkSmTargetGroupAsync
- deleteNetworkSmTargetGroupAsyncWithHttpInfo() : PromiseInterface
- Operation deleteNetworkSmTargetGroupAsyncWithHttpInfo
- deleteNetworkSmTargetGroupWithHttpInfo() : array<string|int, mixed>
- Operation deleteNetworkSmTargetGroupWithHttpInfo
- getConfig() : Configuration
- getNetworkSmTargetGroup() : object
- Operation getNetworkSmTargetGroup
- getNetworkSmTargetGroupAsync() : PromiseInterface
- Operation getNetworkSmTargetGroupAsync
- getNetworkSmTargetGroupAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmTargetGroupAsyncWithHttpInfo
- getNetworkSmTargetGroups() : object
- Operation getNetworkSmTargetGroups
- getNetworkSmTargetGroupsAsync() : PromiseInterface
- Operation getNetworkSmTargetGroupsAsync
- getNetworkSmTargetGroupsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmTargetGroupsAsyncWithHttpInfo
- getNetworkSmTargetGroupsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmTargetGroupsWithHttpInfo
- getNetworkSmTargetGroupWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmTargetGroupWithHttpInfo
- updateNetworkSmTargetGroup() : object
- Operation updateNetworkSmTargetGroup
- updateNetworkSmTargetGroupAsync() : PromiseInterface
- Operation updateNetworkSmTargetGroupAsync
- updateNetworkSmTargetGroupAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkSmTargetGroupAsyncWithHttpInfo
- updateNetworkSmTargetGroupWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkSmTargetGroupWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createNetworkSmTargetGroupRequest() : Request
- Create request for operation 'createNetworkSmTargetGroup'
- deleteNetworkSmTargetGroupRequest() : Request
- Create request for operation 'deleteNetworkSmTargetGroup'
- getNetworkSmTargetGroupRequest() : Request
- Create request for operation 'getNetworkSmTargetGroup'
- getNetworkSmTargetGroupsRequest() : Request
- Create request for operation 'getNetworkSmTargetGroups'
- updateNetworkSmTargetGroupRequest() : Request
- Create request for operation 'updateNetworkSmTargetGroup'
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 —createNetworkSmTargetGroup()
Operation createNetworkSmTargetGroup
public
createNetworkSmTargetGroup(string $network_id[, CreateNetworkSmTargetGroup $create_network_sm_target_group = null ]) : object
Add a target group
Parameters
- $network_id : string
-
network_id (required)
- $create_network_sm_target_group : CreateNetworkSmTargetGroup = null
-
create_network_sm_target_group (optional)
Tags
Return values
object —createNetworkSmTargetGroupAsync()
Operation createNetworkSmTargetGroupAsync
public
createNetworkSmTargetGroupAsync(string $network_id[, CreateNetworkSmTargetGroup $create_network_sm_target_group = null ]) : PromiseInterface
Add a target group
Parameters
- $network_id : string
-
(required)
- $create_network_sm_target_group : CreateNetworkSmTargetGroup = null
-
(optional)
Tags
Return values
PromiseInterface —createNetworkSmTargetGroupAsyncWithHttpInfo()
Operation createNetworkSmTargetGroupAsyncWithHttpInfo
public
createNetworkSmTargetGroupAsyncWithHttpInfo(string $network_id[, CreateNetworkSmTargetGroup $create_network_sm_target_group = null ]) : PromiseInterface
Add a target group
Parameters
- $network_id : string
-
(required)
- $create_network_sm_target_group : CreateNetworkSmTargetGroup = null
-
(optional)
Tags
Return values
PromiseInterface —createNetworkSmTargetGroupWithHttpInfo()
Operation createNetworkSmTargetGroupWithHttpInfo
public
createNetworkSmTargetGroupWithHttpInfo(string $network_id[, CreateNetworkSmTargetGroup $create_network_sm_target_group = null ]) : array<string|int, mixed>
Add a target group
Parameters
- $network_id : string
-
(required)
- $create_network_sm_target_group : CreateNetworkSmTargetGroup = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteNetworkSmTargetGroup()
Operation deleteNetworkSmTargetGroup
public
deleteNetworkSmTargetGroup(string $network_id, string $target_group_id) : void
Delete a target group from a network
Parameters
- $network_id : string
-
network_id (required)
- $target_group_id : string
-
target_group_id (required)
Tags
Return values
void —deleteNetworkSmTargetGroupAsync()
Operation deleteNetworkSmTargetGroupAsync
public
deleteNetworkSmTargetGroupAsync(string $network_id, string $target_group_id) : PromiseInterface
Delete a target group from a network
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkSmTargetGroupAsyncWithHttpInfo()
Operation deleteNetworkSmTargetGroupAsyncWithHttpInfo
public
deleteNetworkSmTargetGroupAsyncWithHttpInfo(string $network_id, string $target_group_id) : PromiseInterface
Delete a target group from a network
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkSmTargetGroupWithHttpInfo()
Operation deleteNetworkSmTargetGroupWithHttpInfo
public
deleteNetworkSmTargetGroupWithHttpInfo(string $network_id, string $target_group_id) : array<string|int, mixed>
Delete a target group from a network
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkSmTargetGroup()
Operation getNetworkSmTargetGroup
public
getNetworkSmTargetGroup(string $network_id, string $target_group_id[, bool $with_details = null ]) : object
Return a target group
Parameters
- $network_id : string
-
network_id (required)
- $target_group_id : string
-
target_group_id (required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
object —getNetworkSmTargetGroupAsync()
Operation getNetworkSmTargetGroupAsync
public
getNetworkSmTargetGroupAsync(string $network_id, string $target_group_id[, bool $with_details = null ]) : PromiseInterface
Return a target group
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
PromiseInterface —getNetworkSmTargetGroupAsyncWithHttpInfo()
Operation getNetworkSmTargetGroupAsyncWithHttpInfo
public
getNetworkSmTargetGroupAsyncWithHttpInfo(string $network_id, string $target_group_id[, bool $with_details = null ]) : PromiseInterface
Return a target group
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
PromiseInterface —getNetworkSmTargetGroups()
Operation getNetworkSmTargetGroups
public
getNetworkSmTargetGroups(string $network_id[, bool $with_details = null ]) : object
List the target groups in this network
Parameters
- $network_id : string
-
network_id (required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
object —getNetworkSmTargetGroupsAsync()
Operation getNetworkSmTargetGroupsAsync
public
getNetworkSmTargetGroupsAsync(string $network_id[, bool $with_details = null ]) : PromiseInterface
List the target groups in this network
Parameters
- $network_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
PromiseInterface —getNetworkSmTargetGroupsAsyncWithHttpInfo()
Operation getNetworkSmTargetGroupsAsyncWithHttpInfo
public
getNetworkSmTargetGroupsAsyncWithHttpInfo(string $network_id[, bool $with_details = null ]) : PromiseInterface
List the target groups in this network
Parameters
- $network_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
PromiseInterface —getNetworkSmTargetGroupsWithHttpInfo()
Operation getNetworkSmTargetGroupsWithHttpInfo
public
getNetworkSmTargetGroupsWithHttpInfo(string $network_id[, bool $with_details = null ]) : array<string|int, mixed>
List the target groups in this network
Parameters
- $network_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkSmTargetGroupWithHttpInfo()
Operation getNetworkSmTargetGroupWithHttpInfo
public
getNetworkSmTargetGroupWithHttpInfo(string $network_id, string $target_group_id[, bool $with_details = null ]) : array<string|int, mixed>
Return a target group
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkSmTargetGroup()
Operation updateNetworkSmTargetGroup
public
updateNetworkSmTargetGroup(string $network_id, string $target_group_id[, UpdateNetworkSmTargetGroup $update_network_sm_target_group = null ]) : object
Update a target group
Parameters
- $network_id : string
-
network_id (required)
- $target_group_id : string
-
target_group_id (required)
- $update_network_sm_target_group : UpdateNetworkSmTargetGroup = null
-
update_network_sm_target_group (optional)
Tags
Return values
object —updateNetworkSmTargetGroupAsync()
Operation updateNetworkSmTargetGroupAsync
public
updateNetworkSmTargetGroupAsync(string $network_id, string $target_group_id[, UpdateNetworkSmTargetGroup $update_network_sm_target_group = null ]) : PromiseInterface
Update a target group
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $update_network_sm_target_group : UpdateNetworkSmTargetGroup = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkSmTargetGroupAsyncWithHttpInfo()
Operation updateNetworkSmTargetGroupAsyncWithHttpInfo
public
updateNetworkSmTargetGroupAsyncWithHttpInfo(string $network_id, string $target_group_id[, UpdateNetworkSmTargetGroup $update_network_sm_target_group = null ]) : PromiseInterface
Update a target group
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $update_network_sm_target_group : UpdateNetworkSmTargetGroup = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkSmTargetGroupWithHttpInfo()
Operation updateNetworkSmTargetGroupWithHttpInfo
public
updateNetworkSmTargetGroupWithHttpInfo(string $network_id, string $target_group_id[, UpdateNetworkSmTargetGroup $update_network_sm_target_group = null ]) : array<string|int, mixed>
Update a target group
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $update_network_sm_target_group : UpdateNetworkSmTargetGroup = 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
createNetworkSmTargetGroupRequest()
Create request for operation 'createNetworkSmTargetGroup'
protected
createNetworkSmTargetGroupRequest(string $network_id[, CreateNetworkSmTargetGroup $create_network_sm_target_group = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_sm_target_group : CreateNetworkSmTargetGroup = null
-
(optional)
Tags
Return values
Request —deleteNetworkSmTargetGroupRequest()
Create request for operation 'deleteNetworkSmTargetGroup'
protected
deleteNetworkSmTargetGroupRequest(string $network_id, string $target_group_id) : Request
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
Tags
Return values
Request —getNetworkSmTargetGroupRequest()
Create request for operation 'getNetworkSmTargetGroup'
protected
getNetworkSmTargetGroupRequest(string $network_id, string $target_group_id[, bool $with_details = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
Request —getNetworkSmTargetGroupsRequest()
Create request for operation 'getNetworkSmTargetGroups'
protected
getNetworkSmTargetGroupsRequest(string $network_id[, bool $with_details = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $with_details : bool = null
-
Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response (optional)
Tags
Return values
Request —updateNetworkSmTargetGroupRequest()
Create request for operation 'updateNetworkSmTargetGroup'
protected
updateNetworkSmTargetGroupRequest(string $network_id, string $target_group_id[, UpdateNetworkSmTargetGroup $update_network_sm_target_group = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $target_group_id : string
-
(required)
- $update_network_sm_target_group : UpdateNetworkSmTargetGroup = null
-
(optional)