All URIs are relative to https://YOUR_SUPLA_SERVER/api/v3
.
Method | HTTP request | Description |
---|---|---|
configureChannel() | PATCH /channels/{id}/settings | |
createChannelReaction() | POST /channels/{channel}/reactions | Create channel reaction |
deleteChannelMeasurementLogs() | DELETE /channels/{channel}/measurement-logs | Delete channel measurement logs. |
deleteChannelReaction() | DELETE /channels/{channel}/reactions/{reaction} | Delete channel reaction |
downloadChannelMeasurementLogs() | GET /channels/{channel}/measurement-logs-download | Get measurement logs as a zipped CSV file. |
executeAction() | PATCH /channels/{id} | |
getChannel() | GET /channels/{id} | Get Channel |
getChannelChannelGroups() | GET /channels/{id}/channel-groups | Get Channel Groups that the given channel belongs to |
getChannelDirectLinks() | GET /channels/{channel}/direct-links | Get channel direct links |
getChannelMeasurementLogs() | GET /channels/{channel}/measurement-logs | Get channel measurement logs. |
getChannelNotifications() | GET /channels/{channel}/notifications | |
getChannelReaction() | GET /channels/{channel}/reactions/{reaction} | Get channel reaction |
getChannelReactions() | GET /channels/{channel}/reactions | Get channel reactions |
getChannelScenes() | GET /channels/{channel}/scenes | Get channel scenes |
getChannels() | GET /channels | Get Channels |
updateChannel() | PUT /channels/{id} | |
updateChannelReaction() | PUT /channels/{channel}/reactions/{reaction} | Update channel reaction |
configureChannel($id, $inlineObject2): \Supla\ApiClient\Model\Channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID
$inlineObject2 = new \Supla\ApiClient\Model\InlineObject2(); // \Supla\ApiClient\Model\InlineObject2
try {
$result = $apiInstance->configureChannel($id, $inlineObject2);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->configureChannel: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | ID | |
inlineObject2 | \Supla\ApiClient\Model\InlineObject2 |
\Supla\ApiClient\Model\Channel
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createChannelReaction($channel, $inlineObject9, $include): \Supla\ApiClient\Model\Reaction
Create channel reaction
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$inlineObject9 = new \Supla\ApiClient\Model\InlineObject9(); // \Supla\ApiClient\Model\InlineObject9
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->createChannelReaction($channel, $inlineObject9, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->createChannelReaction: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
inlineObject9 | \Supla\ApiClient\Model\InlineObject9 | ||
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Reaction
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteChannelMeasurementLogs($channel, $logsType)
Delete channel measurement logs.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$logsType = 'logsType_example'; // string | Type of the logs to delete. Some devices may gather multiple log types.
try {
$apiInstance->deleteChannelMeasurementLogs($channel, $logsType);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->deleteChannelMeasurementLogs: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
logsType | string | Type of the logs to delete. Some devices may gather multiple log types. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteChannelReaction($channel, $reaction)
Delete channel reaction
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | Channel ID
$reaction = 56; // int | Reaction ID
try {
$apiInstance->deleteChannelReaction($channel, $reaction);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->deleteChannelReaction: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | Channel ID | |
reaction | int | Reaction ID |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
downloadChannelMeasurementLogs($channel, $logsType)
Get measurement logs as a zipped CSV file.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$logsType = 'logsType_example'; // string | Type of the logs to delete. Some devices may gather multiple log types.
try {
$apiInstance->downloadChannelMeasurementLogs($channel, $logsType);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->downloadChannelMeasurementLogs: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
logsType | string | Type of the logs to delete. Some devices may gather multiple log types. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/zip
,application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
executeAction($id, $uNKNOWNBASETYPE)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID
$uNKNOWNBASETYPE = new \Supla\ApiClient\Model\UNKNOWN_BASE_TYPE(); // \Supla\ApiClient\Model\UNKNOWN_BASE_TYPE
try {
$apiInstance->executeAction($id, $uNKNOWNBASETYPE);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->executeAction: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | ID | |
uNKNOWNBASETYPE | \Supla\ApiClient\Model\UNKNOWN_BASE_TYPE |
void (empty response body)
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannel($id, $include): \Supla\ApiClient\Model\Channel
Get Channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannel($id, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannel: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | ID | |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Channel
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelChannelGroups($id, $include): \Supla\ApiClient\Model\ChannelGroup[]
Get Channel Groups that the given channel belongs to
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannelChannelGroups($id, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelChannelGroups: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | ID | |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\ChannelGroup[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelDirectLinks($channel, $include): \Supla\ApiClient\Model\DirectLink[]
Get channel direct links
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannelDirectLinks($channel, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelDirectLinks: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\DirectLink[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelMeasurementLogs($channel, $afterTimestamp, $beforeTimestamp, $order, $sparse, $logsType, $limit, $offset): OneOfArrayArrayArrayArrayArrayArrayArray
Get channel measurement logs.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$afterTimestamp = 56; // int | Fetch log items created after this timestamp.
$beforeTimestamp = 56; // int | Fetch log items created before this timestamp.
$order = 'DESC'; // string | Whether to order items ascending or descending by creation date.
$sparse = 56; // int | Set the maximum items to return from the given period. If specified, the `limit` and `offset` params are ignored. For example, if you fetches the logs from the whole year and set the `sparse` param to `12`, the API will try to return up to 12 log items, equally distributed throug the whole year. Min: 1, Max: 1000.
$logsType = 'logsType_example'; // string | Type of the logs to return. Some devices may gather multiple log types.
$limit = 5000; // int | Maximum items count in response, from 1 to 5000.
$offset = 0; // int | Pagination offset.
try {
$result = $apiInstance->getChannelMeasurementLogs($channel, $afterTimestamp, $beforeTimestamp, $order, $sparse, $logsType, $limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelMeasurementLogs: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
afterTimestamp | int | Fetch log items created after this timestamp. | [optional] |
beforeTimestamp | int | Fetch log items created before this timestamp. | [optional] |
order | string | Whether to order items ascending or descending by creation date. | [optional] [default to 'DESC'] |
sparse | int | Set the maximum items to return from the given period. If specified, the `limit` and `offset` params are ignored. For example, if you fetches the logs from the whole year and set the `sparse` param to `12`, the API will try to return up to 12 log items, equally distributed throug the whole year. Min: 1, Max: 1000. | [optional] |
logsType | string | Type of the logs to return. Some devices may gather multiple log types. | [optional] |
limit | int | Maximum items count in response, from 1 to 5000. | [optional] [default to 5000] |
offset | int | Pagination offset. | [optional] [default to 0] |
OneOfArrayArrayArrayArrayArrayArrayArray
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelNotifications($channel, $onlyManaged, $include): \Supla\ApiClient\Model\Notification[]
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$onlyManaged = True; // bool | Return only notification managed by the device (i.e. originating from the firmware). Can be only set to `true`.
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannelNotifications($channel, $onlyManaged, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelNotifications: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
onlyManaged | bool | Return only notification managed by the device (i.e. originating from the firmware). Can be only set to `true`. | [optional] |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Notification[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelReaction($channel, $reaction, $include): \Supla\ApiClient\Model\Reaction
Get channel reaction
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | Channel ID
$reaction = 56; // int | Reaction ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannelReaction($channel, $reaction, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelReaction: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | Channel ID | |
reaction | int | Reaction ID | |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Reaction
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelReactions($channel, $include): \Supla\ApiClient\Model\Reaction[]
Get channel reactions
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | Channel ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannelReactions($channel, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelReactions: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | Channel ID | |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Reaction[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannelScenes($channel, $include): \Supla\ApiClient\Model\Scene[]
Get channel scenes
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | ID
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->getChannelScenes($channel, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannelScenes: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | ID | |
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Scene[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getChannels($function, $io, $hasFunction, $skipIds, $include, $forIntegration, $deviceIds, $type): \Supla\ApiClient\Model\Channel[]
Get Channels
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$function = array('function_example'); // string[]
$io = 'io_example'; // string | Return only `input` or `output` channels.
$hasFunction = True; // bool | Return only channels with (`true`) or without (`false`) chosen functions.
$skipIds = array(56); // int[]
$include = array('include_example'); // string[] | List of extra fields to include in the response.
$forIntegration = 'forIntegration_example'; // string | Select an integration that the channels should be returned for.
$deviceIds = array(56); // int[]
$type = array('type_example'); // string[]
try {
$result = $apiInstance->getChannels($function, $io, $hasFunction, $skipIds, $include, $forIntegration, $deviceIds, $type);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->getChannels: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
function | string[] | [optional] | |
io | string | Return only `input` or `output` channels. | [optional] |
hasFunction | bool | Return only channels with (`true`) or without (`false`) chosen functions. | [optional] |
skipIds | int[] | [optional] | |
include | string[] | List of extra fields to include in the response. | [optional] |
forIntegration | string | Select an integration that the channels should be returned for. | [optional] |
deviceIds | int[] | [optional] | |
type | string[] | [optional] |
\Supla\ApiClient\Model\Channel[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateChannel($id, $inlineObject1, $safe): \Supla\ApiClient\Model\Channel
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID
$inlineObject1 = new \Supla\ApiClient\Model\InlineObject1(); // \Supla\ApiClient\Model\InlineObject1
$safe = True; // bool | Whether to perform actions that require data loss (e.g. delete schedules when changing channel function)
try {
$result = $apiInstance->updateChannel($id, $inlineObject1, $safe);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->updateChannel: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | ID | |
inlineObject1 | \Supla\ApiClient\Model\InlineObject1 | ||
safe | bool | Whether to perform actions that require data loss (e.g. delete schedules when changing channel function) | [optional] |
\Supla\ApiClient\Model\Channel
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateChannelReaction($channel, $reaction, $inlineObject10, $include): \Supla\ApiClient\Model\Reaction
Update channel reaction
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: BearerAuth
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: OAuth2
$config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Supla\ApiClient\Api\ChannelsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$channel = 56; // int | Channel ID
$reaction = 56; // int | Reaction ID
$inlineObject10 = new \Supla\ApiClient\Model\InlineObject10(); // \Supla\ApiClient\Model\InlineObject10
$include = array('include_example'); // string[] | List of extra fields to include in the response.
try {
$result = $apiInstance->updateChannelReaction($channel, $reaction, $inlineObject10, $include);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ChannelsApi->updateChannelReaction: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
channel | int | Channel ID | |
reaction | int | Reaction ID | |
inlineObject10 | \Supla\ApiClient\Model\InlineObject10 | ||
include | string[] | List of extra fields to include in the response. | [optional] |
\Supla\ApiClient\Model\Reaction
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]