Skip to content

Commit 9da1045

Browse files
shehzad-koreshehzad-kore
committed
add broadcast
1 parent 5281576 commit 9da1045

6 files changed

Lines changed: 184 additions & 66 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -128,29 +128,30 @@ api.bindDevice(subscriptionId, registryId, device, callback);
128128

129129
## Documentation for API Endpoints
130130

131-
All URIs are relative to *https://api.omnicore.korewireless.com*
131+
All URIs are relative to *https://api.omnicore.korewireless.com/model-state-management*
132132

133133
Class | Method | HTTP request | Description
134134
------------ | ------------- | ------------- | -------------
135-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**bindDevice**](docs/DeviceApi.md#bindDevice) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway |
136-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**bindDevices**](docs/DeviceApi.md#bindDevices) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway |
137-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**blockDeviceCommuncation**](docs/DeviceApi.md#blockDeviceCommuncation) | **PUT** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication |
138-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**createDevice**](docs/DeviceApi.md#createDevice) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices |
139-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**deleteDevice**](docs/DeviceApi.md#deleteDevice) | **DELETE** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
140-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getConfig**](docs/DeviceApi.md#getConfig) | **GET** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions |
141-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getDevice**](docs/DeviceApi.md#getDevice) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
142-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getDevices**](docs/DeviceApi.md#getDevices) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices |
143-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getStates**](docs/DeviceApi.md#getStates) | **GET** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states |
144-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**sendCommandToDevice**](docs/DeviceApi.md#sendCommandToDevice) | **POST** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice |
145-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**unBindDevice**](docs/DeviceApi.md#unBindDevice) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway |
146-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**unBindDevices**](docs/DeviceApi.md#unBindDevices) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway |
147-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**updateConfigurationToDevice**](docs/DeviceApi.md#updateConfigurationToDevice) | **POST** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice |
148-
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**updateDevice**](docs/DeviceApi.md#updateDevice) | **PATCH** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
149-
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**createRegistry**](docs/RegistryApi.md#createRegistry) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries |
150-
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**deleteRegistry**](docs/RegistryApi.md#deleteRegistry) | **DELETE** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId} |
151-
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**getRegistries**](docs/RegistryApi.md#getRegistries) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries |
152-
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**getRegistry**](docs/RegistryApi.md#getRegistry) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId} |
153-
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**updateRegistry**](docs/RegistryApi.md#updateRegistry) | **PATCH** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId} |
135+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**bindDevice**](docs/DeviceApi.md#bindDevice) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway |
136+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**bindDevices**](docs/DeviceApi.md#bindDevices) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway |
137+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**blockDeviceCommuncation**](docs/DeviceApi.md#blockDeviceCommuncation) | **PUT** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication |
138+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**createDevice**](docs/DeviceApi.md#createDevice) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/devices |
139+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**deleteDevice**](docs/DeviceApi.md#deleteDevice) | **DELETE** /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
140+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getConfig**](docs/DeviceApi.md#getConfig) | **GET** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions |
141+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getDevice**](docs/DeviceApi.md#getDevice) | **GET** /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
142+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getDevices**](docs/DeviceApi.md#getDevices) | **GET** /subscriptions/{subscriptionId}/registries/{registryId}/devices |
143+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**getStates**](docs/DeviceApi.md#getStates) | **GET** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states |
144+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**sendCommandToDevice**](docs/DeviceApi.md#sendCommandToDevice) | **POST** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice |
145+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**unBindDevice**](docs/DeviceApi.md#unBindDevice) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway |
146+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**unBindDevices**](docs/DeviceApi.md#unBindDevices) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway |
147+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**updateConfigurationToDevice**](docs/DeviceApi.md#updateConfigurationToDevice) | **POST** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice |
148+
*OmniCoreModelAndStateManagementApi.DeviceApi* | [**updateDevice**](docs/DeviceApi.md#updateDevice) | **PATCH** /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
149+
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**createRegistry**](docs/RegistryApi.md#createRegistry) | **POST** /subscriptions/{subscriptionId}/registries |
150+
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**deleteRegistry**](docs/RegistryApi.md#deleteRegistry) | **DELETE** /subscriptions/{subscriptionId}/registries/{registryId} |
151+
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**getRegistries**](docs/RegistryApi.md#getRegistries) | **GET** /subscriptions/{subscriptionId}/registries |
152+
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**getRegistry**](docs/RegistryApi.md#getRegistry) | **GET** /subscriptions/{subscriptionId}/registries/{registryId} |
153+
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**sendBroadcastToDevices**](docs/RegistryApi.md#sendBroadcastToDevices) | **POST** /subscriptions/{subscriptionid}/registries/{registryId}/sendBroadcastToDevice |
154+
*OmniCoreModelAndStateManagementApi.RegistryApi* | [**updateRegistry**](docs/RegistryApi.md#updateRegistry) | **PATCH** /subscriptions/{subscriptionId}/registries/{registryId} |
154155

155156

156157
## Documentation for Models

‎docs/DeviceApi.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# OmniCoreModelAndStateManagementApi.DeviceApi
22

3-
All URIs are relative to *https://api.omnicore.korewireless.com*
3+
All URIs are relative to *https://api.omnicore.korewireless.com/model-state-management*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**bindDevice**](DeviceApi.md#bindDevice) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway |
8-
[**bindDevices**](DeviceApi.md#bindDevices) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway |
9-
[**blockDeviceCommuncation**](DeviceApi.md#blockDeviceCommuncation) | **PUT** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication |
10-
[**createDevice**](DeviceApi.md#createDevice) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices |
11-
[**deleteDevice**](DeviceApi.md#deleteDevice) | **DELETE** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
12-
[**getConfig**](DeviceApi.md#getConfig) | **GET** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions |
13-
[**getDevice**](DeviceApi.md#getDevice) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
14-
[**getDevices**](DeviceApi.md#getDevices) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices |
15-
[**getStates**](DeviceApi.md#getStates) | **GET** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states |
16-
[**sendCommandToDevice**](DeviceApi.md#sendCommandToDevice) | **POST** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice |
17-
[**unBindDevice**](DeviceApi.md#unBindDevice) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway |
18-
[**unBindDevices**](DeviceApi.md#unBindDevices) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway |
19-
[**updateConfigurationToDevice**](DeviceApi.md#updateConfigurationToDevice) | **POST** /model-state-management/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice |
20-
[**updateDevice**](DeviceApi.md#updateDevice) | **PATCH** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
7+
[**bindDevice**](DeviceApi.md#bindDevice) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway |
8+
[**bindDevices**](DeviceApi.md#bindDevices) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway |
9+
[**blockDeviceCommuncation**](DeviceApi.md#blockDeviceCommuncation) | **PUT** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication |
10+
[**createDevice**](DeviceApi.md#createDevice) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/devices |
11+
[**deleteDevice**](DeviceApi.md#deleteDevice) | **DELETE** /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
12+
[**getConfig**](DeviceApi.md#getConfig) | **GET** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions |
13+
[**getDevice**](DeviceApi.md#getDevice) | **GET** /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
14+
[**getDevices**](DeviceApi.md#getDevices) | **GET** /subscriptions/{subscriptionId}/registries/{registryId}/devices |
15+
[**getStates**](DeviceApi.md#getStates) | **GET** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states |
16+
[**sendCommandToDevice**](DeviceApi.md#sendCommandToDevice) | **POST** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice |
17+
[**unBindDevice**](DeviceApi.md#unBindDevice) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway |
18+
[**unBindDevices**](DeviceApi.md#unBindDevices) | **POST** /subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway |
19+
[**updateConfigurationToDevice**](DeviceApi.md#updateConfigurationToDevice) | **POST** /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice |
20+
[**updateDevice**](DeviceApi.md#updateDevice) | **PATCH** /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} |
2121

2222

2323

‎docs/RegistryApi.md‎

Lines changed: 68 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# OmniCoreModelAndStateManagementApi.RegistryApi
22

3-
All URIs are relative to *https://api.omnicore.korewireless.com*
3+
All URIs are relative to *https://api.omnicore.korewireless.com/model-state-management*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createRegistry**](RegistryApi.md#createRegistry) | **POST** /model-state-management/subscriptions/{subscriptionId}/registries |
8-
[**deleteRegistry**](RegistryApi.md#deleteRegistry) | **DELETE** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId} |
9-
[**getRegistries**](RegistryApi.md#getRegistries) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries |
10-
[**getRegistry**](RegistryApi.md#getRegistry) | **GET** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId} |
11-
[**updateRegistry**](RegistryApi.md#updateRegistry) | **PATCH** /model-state-management/subscriptions/{subscriptionId}/registries/{registryId} |
7+
[**createRegistry**](RegistryApi.md#createRegistry) | **POST** /subscriptions/{subscriptionId}/registries |
8+
[**deleteRegistry**](RegistryApi.md#deleteRegistry) | **DELETE** /subscriptions/{subscriptionId}/registries/{registryId} |
9+
[**getRegistries**](RegistryApi.md#getRegistries) | **GET** /subscriptions/{subscriptionId}/registries |
10+
[**getRegistry**](RegistryApi.md#getRegistry) | **GET** /subscriptions/{subscriptionId}/registries/{registryId} |
11+
[**sendBroadcastToDevices**](RegistryApi.md#sendBroadcastToDevices) | **POST** /subscriptions/{subscriptionid}/registries/{registryId}/sendBroadcastToDevice |
12+
[**updateRegistry**](RegistryApi.md#updateRegistry) | **PATCH** /subscriptions/{subscriptionId}/registries/{registryId} |
1213

1314

1415

@@ -152,7 +153,8 @@ let apiInstance = new OmniCoreModelAndStateManagementApi.RegistryApi();
152153
let subscriptionId = "subscriptionId_example"; // String | Subscription ID
153154
let opts = {
154155
'pageNumber': 56, // Number | Page Number
155-
'pageSize': 56 // Number | Page Size
156+
'pageSize': 56, // Number | Page Size
157+
'registryIds': ["null"] // [String] | A list of registry string IDs. For example, ['registry0', 'registry12']. If empty, this field is ignored. Maximum IDs: 10,000
156158
};
157159
apiInstance.getRegistries(subscriptionId, opts, (error, data, response) => {
158160
if (error) {
@@ -171,6 +173,7 @@ Name | Type | Description | Notes
171173
**subscriptionId** | **String**| Subscription ID |
172174
**pageNumber** | **Number**| Page Number | [optional]
173175
**pageSize** | **Number**| Page Size | [optional]
176+
**registryIds** | [**[String]**](String.md)| A list of registry string IDs. For example, ['registry0', 'registry12']. If empty, this field is ignored. Maximum IDs: 10,000 | [optional]
174177

175178
### Return type
176179

@@ -242,6 +245,64 @@ Name | Type | Description | Notes
242245
- **Accept**: application/json
243246

244247

248+
## sendBroadcastToDevices
249+
250+
> Object sendBroadcastToDevices(subscriptionid, registryId, registry)
251+
252+
253+
254+
Send Broadcast To Devices
255+
256+
### Example
257+
258+
```javascript
259+
import OmniCoreModelAndStateManagementApi from 'omni_core_model_and_state_management_api';
260+
let defaultClient = OmniCoreModelAndStateManagementApi.ApiClient.instance;
261+
// Configure API key authorization: apiKey
262+
let apiKey = defaultClient.authentications['apiKey'];
263+
apiKey.apiKey = 'YOUR API KEY';
264+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
265+
//apiKey.apiKeyPrefix = 'Token';
266+
// Configure Bearer (JWT) access token for authorization: bearerAuth
267+
let bearerAuth = defaultClient.authentications['bearerAuth'];
268+
bearerAuth.accessToken = "YOUR ACCESS TOKEN"
269+
270+
let apiInstance = new OmniCoreModelAndStateManagementApi.RegistryApi();
271+
let subscriptionid = "subscriptionid_example"; // String | Subscription ID
272+
let registryId = "registryId_example"; // String | Registry ID
273+
let registry = new OmniCoreModelAndStateManagementApi.DeviceCommand(); // DeviceCommand | application/json
274+
apiInstance.sendBroadcastToDevices(subscriptionid, registryId, registry, (error, data, response) => {
275+
if (error) {
276+
console.error(error);
277+
} else {
278+
console.log('API called successfully. Returned data: ' + data);
279+
}
280+
});
281+
```
282+
283+
### Parameters
284+
285+
286+
Name | Type | Description | Notes
287+
------------- | ------------- | ------------- | -------------
288+
**subscriptionid** | **String**| Subscription ID |
289+
**registryId** | **String**| Registry ID |
290+
**registry** | [**DeviceCommand**](DeviceCommand.md)| application/json |
291+
292+
### Return type
293+
294+
**Object**
295+
296+
### Authorization
297+
298+
[apiKey](../README.md#apiKey), [bearerAuth](../README.md#bearerAuth)
299+
300+
### HTTP request headers
301+
302+
- **Content-Type**: application/json
303+
- **Accept**: application/json
304+
305+
245306
## updateRegistry
246307

247308
> DeviceRegistry updateRegistry(subscriptionId, registryId, updateMask, opts)

‎src/ApiClient.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ class ApiClient {
3333
* Overrides the default value set in spec file if present
3434
* @param {String} basePath
3535
*/
36-
constructor(basePath = 'https://api.omnicore.korewireless.com') {
36+
constructor(basePath = 'https://api.omnicore.korewireless.com/model-state-management') {
3737
/**
3838
* The base URL against which to resolve every API call's (relative) path.
3939
* @type {String}
40-
* @default https://api.omnicore.korewireless.com
40+
* @default https://api.omnicore.korewireless.com/model-state-management
4141
*/
4242
this.basePath = basePath.replace(/\/+$/, '');
4343

@@ -594,11 +594,11 @@ class ApiClient {
594594
hostSettings() {
595595
return [
596596
{
597-
'url': "https://api.omnicore.korewireless.com",
597+
'url': "https://api.omnicore.korewireless.com/model-state-management",
598598
'description': "Production Server",
599599
},
600600
{
601-
'url': "https://demo-api.omnicore.cloud.korewireless.com",
601+
'url': "https://demo-api.omnicore.cloud.korewireless.com/model-state-management",
602602
'description': "Demo Server",
603603
}
604604
];

0 commit comments

Comments
 (0)