@openremote/rest 1.9.0-snapshot.20250926082424 → 1.9.0-snapshot.20250926085108
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +615 -615
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,133 +9,74 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class ProvisioningResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
getNotifications(queryParams?: {
|
|
20
|
-
id?: number;
|
|
21
|
-
type?: string;
|
|
22
|
-
from?: number;
|
|
23
|
-
to?: number;
|
|
24
|
-
realmId?: string;
|
|
25
|
-
userId?: string;
|
|
26
|
-
assetId?: string;
|
|
27
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
28
|
-
/**
|
|
29
|
-
* HTTP DELETE /notification
|
|
30
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
31
|
-
*/
|
|
32
|
-
removeNotifications(queryParams?: {
|
|
33
|
-
id?: number;
|
|
34
|
-
type?: string;
|
|
35
|
-
from?: number;
|
|
36
|
-
to?: number;
|
|
37
|
-
realmId?: string;
|
|
38
|
-
userId?: string;
|
|
39
|
-
assetId?: string;
|
|
40
|
-
}, options?: O): RestResponse<void>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP POST /notification/alert
|
|
43
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
16
|
+
* HTTP POST /provisioning
|
|
17
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
44
18
|
*/
|
|
45
|
-
|
|
19
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
46
20
|
/**
|
|
47
|
-
* HTTP
|
|
48
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /provisioning
|
|
22
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
49
23
|
*/
|
|
50
|
-
|
|
24
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
51
25
|
/**
|
|
52
|
-
* HTTP
|
|
53
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /provisioning/{id}
|
|
27
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
54
28
|
*/
|
|
55
|
-
|
|
56
|
-
targetId?: string;
|
|
57
|
-
}, options?: O): RestResponse<void>;
|
|
29
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
58
30
|
/**
|
|
59
|
-
* HTTP PUT /
|
|
60
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP PUT /provisioning/{id}
|
|
32
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
61
33
|
*/
|
|
62
|
-
|
|
63
|
-
targetId?: string;
|
|
64
|
-
}, options?: O): RestResponse<void>;
|
|
34
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
65
35
|
}
|
|
66
|
-
export declare class
|
|
36
|
+
export declare class AssetModelResourceClient<O> {
|
|
67
37
|
protected httpClient: HttpClient<O>;
|
|
68
38
|
constructor(httpClient: HttpClient<O>);
|
|
69
39
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
73
|
-
*/
|
|
74
|
-
getServices(queryParams?: {
|
|
75
|
-
realm?: string;
|
|
76
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
77
|
-
/**
|
|
78
|
-
* Response code 200 - Service registered successfully
|
|
79
|
-
* Response code 400 - Invalid external service object
|
|
80
|
-
* Response code 409 - ExternalService instance already registered
|
|
81
|
-
* HTTP POST /service
|
|
82
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
83
|
-
*/
|
|
84
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
85
|
-
/**
|
|
86
|
-
* Response code 200 - List of registered external services
|
|
87
|
-
* HTTP GET /service/global
|
|
88
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
89
|
-
*/
|
|
90
|
-
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
91
|
-
/**
|
|
92
|
-
* Response code 200 - Service registered successfully
|
|
93
|
-
* Response code 400 - Invalid external service object
|
|
94
|
-
* Response code 409 - ExternalService instance already registered
|
|
95
|
-
* HTTP POST /service/global
|
|
96
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
97
|
-
*/
|
|
98
|
-
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
99
|
-
/**
|
|
100
|
-
* Response code 204 - Service deregistered successfully
|
|
101
|
-
* Response code 404 - Service instance not found
|
|
102
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
103
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
104
|
-
*/
|
|
105
|
-
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
106
|
-
/**
|
|
107
|
-
* Response code 200 - ExternalService retrieved successfully
|
|
108
|
-
* Response code 404 - ExternalService not found
|
|
109
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
110
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
40
|
+
* HTTP GET /model/assetDescriptors
|
|
41
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
111
42
|
*/
|
|
112
|
-
|
|
43
|
+
getAssetDescriptors(queryParams?: {
|
|
44
|
+
parentId?: string;
|
|
45
|
+
parentType?: string;
|
|
46
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
113
47
|
/**
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
117
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
48
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
49
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
118
50
|
*/
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
protected httpClient: HttpClient<O>;
|
|
123
|
-
constructor(httpClient: HttpClient<O>);
|
|
51
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
52
|
+
parentId?: string;
|
|
53
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
124
54
|
/**
|
|
125
|
-
* HTTP GET /
|
|
126
|
-
* Java method: org.openremote.model.
|
|
55
|
+
* HTTP GET /model/assetInfos
|
|
56
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
127
57
|
*/
|
|
128
|
-
|
|
58
|
+
getAssetInfos(queryParams?: {
|
|
59
|
+
parentId?: string;
|
|
60
|
+
parentType?: string;
|
|
61
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
129
62
|
/**
|
|
130
|
-
* HTTP GET /
|
|
131
|
-
* Java method: org.openremote.model.
|
|
63
|
+
* HTTP GET /model/metaItemDescriptors
|
|
64
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
132
65
|
*/
|
|
133
|
-
|
|
66
|
+
getMetaItemDescriptors(queryParams?: {
|
|
67
|
+
parentId?: string;
|
|
68
|
+
}, options?: O): RestResponse<{
|
|
69
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
70
|
+
}>;
|
|
134
71
|
/**
|
|
135
|
-
* HTTP GET /
|
|
136
|
-
* Java method: org.openremote.model.
|
|
72
|
+
* HTTP GET /model/valueDescriptors
|
|
73
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
137
74
|
*/
|
|
138
|
-
|
|
75
|
+
getValueDescriptors(queryParams?: {
|
|
76
|
+
parentId?: string;
|
|
77
|
+
}, options?: O): RestResponse<{
|
|
78
|
+
[index: string]: Model.ValueDescriptor;
|
|
79
|
+
}>;
|
|
139
80
|
}
|
|
140
81
|
export declare class StatusResourceClient<O> {
|
|
141
82
|
protected httpClient: HttpClient<O>;
|
|
@@ -155,37 +96,14 @@ export declare class StatusResourceClient<O> {
|
|
|
155
96
|
[index: string]: any;
|
|
156
97
|
}>;
|
|
157
98
|
}
|
|
158
|
-
export declare class
|
|
99
|
+
export declare class ConsoleResourceClient<O> {
|
|
159
100
|
protected httpClient: HttpClient<O>;
|
|
160
101
|
constructor(httpClient: HttpClient<O>);
|
|
161
102
|
/**
|
|
162
|
-
* HTTP
|
|
163
|
-
* Java method: org.openremote.model.
|
|
164
|
-
*/
|
|
165
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
166
|
-
/**
|
|
167
|
-
* HTTP PUT /syslog/config
|
|
168
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
169
|
-
*/
|
|
170
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
171
|
-
/**
|
|
172
|
-
* HTTP DELETE /syslog/event
|
|
173
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
174
|
-
*/
|
|
175
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
176
|
-
/**
|
|
177
|
-
* HTTP GET /syslog/event
|
|
178
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
103
|
+
* HTTP POST /console/register
|
|
104
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
179
105
|
*/
|
|
180
|
-
|
|
181
|
-
level?: Model.SyslogLevel;
|
|
182
|
-
per_page?: number;
|
|
183
|
-
page?: number;
|
|
184
|
-
from?: number;
|
|
185
|
-
to?: number;
|
|
186
|
-
category?: Model.SyslogCategory[];
|
|
187
|
-
subCategory?: string[];
|
|
188
|
-
}, options?: O): RestResponse<any>;
|
|
106
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
189
107
|
}
|
|
190
108
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
191
109
|
protected httpClient: HttpClient<O>;
|
|
@@ -201,66 +119,138 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
201
119
|
*/
|
|
202
120
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
203
121
|
}
|
|
204
|
-
export declare class
|
|
122
|
+
export declare class ConfigurationResourceClient<O> {
|
|
205
123
|
protected httpClient: HttpClient<O>;
|
|
206
124
|
constructor(httpClient: HttpClient<O>);
|
|
207
125
|
/**
|
|
208
|
-
* HTTP GET /
|
|
209
|
-
* Java method: org.openremote.model.
|
|
126
|
+
* HTTP GET /configuration/manager
|
|
127
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
210
128
|
*/
|
|
211
|
-
|
|
212
|
-
attributeRefs?: string;
|
|
213
|
-
fromTimestamp?: number;
|
|
214
|
-
toTimestamp?: number;
|
|
215
|
-
}, options?: O): RestResponse<any>;
|
|
129
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
216
130
|
/**
|
|
217
|
-
* HTTP
|
|
218
|
-
* Java method: org.openremote.model.
|
|
131
|
+
* HTTP PUT /configuration/manager
|
|
132
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
219
133
|
*/
|
|
220
|
-
|
|
221
|
-
assetId?: string;
|
|
222
|
-
attributeName?: string;
|
|
223
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
134
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
224
135
|
/**
|
|
225
|
-
* HTTP POST /
|
|
226
|
-
* Java method: org.openremote.model.
|
|
136
|
+
* HTTP POST /configuration/manager/file
|
|
137
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
227
138
|
*/
|
|
228
|
-
|
|
139
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
140
|
+
path?: string;
|
|
141
|
+
}, options?: O): RestResponse<string>;
|
|
142
|
+
/**
|
|
143
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
144
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
145
|
+
*/
|
|
146
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
229
147
|
}
|
|
230
|
-
export declare class
|
|
148
|
+
export declare class AppResourceClient<O> {
|
|
231
149
|
protected httpClient: HttpClient<O>;
|
|
232
150
|
constructor(httpClient: HttpClient<O>);
|
|
233
151
|
/**
|
|
234
|
-
* HTTP GET /
|
|
235
|
-
* Java method: org.openremote.model.
|
|
152
|
+
* HTTP GET /apps
|
|
153
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
236
154
|
*/
|
|
237
|
-
|
|
238
|
-
[id: string]: unknown;
|
|
239
|
-
}>;
|
|
155
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
240
156
|
/**
|
|
241
|
-
* HTTP
|
|
242
|
-
* Java method: org.openremote.model.
|
|
157
|
+
* HTTP GET /apps/consoleConfig
|
|
158
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
243
159
|
*/
|
|
244
|
-
|
|
245
|
-
[id: string]: unknown;
|
|
246
|
-
}>;
|
|
160
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
247
161
|
/**
|
|
248
|
-
* HTTP
|
|
249
|
-
* Java method: org.openremote.model.
|
|
162
|
+
* HTTP GET /apps/info
|
|
163
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
250
164
|
*/
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
165
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
166
|
+
}
|
|
167
|
+
export declare class AlarmResourceClient<O> {
|
|
168
|
+
protected httpClient: HttpClient<O>;
|
|
169
|
+
constructor(httpClient: HttpClient<O>);
|
|
254
170
|
/**
|
|
255
|
-
* HTTP
|
|
256
|
-
* Java method: org.openremote.model.
|
|
171
|
+
* HTTP POST /alarm
|
|
172
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
257
173
|
*/
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
}>;
|
|
174
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
175
|
+
assetIds?: string[];
|
|
176
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
261
177
|
/**
|
|
262
|
-
* HTTP GET /
|
|
263
|
-
* Java method: org.openremote.model.
|
|
178
|
+
* HTTP GET /alarm
|
|
179
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
180
|
+
*/
|
|
181
|
+
getAlarms(queryParams?: {
|
|
182
|
+
realm?: string;
|
|
183
|
+
status?: Model.AlarmStatus;
|
|
184
|
+
assetId?: string;
|
|
185
|
+
assigneeId?: string;
|
|
186
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
187
|
+
/**
|
|
188
|
+
* HTTP DELETE /alarm
|
|
189
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
190
|
+
*/
|
|
191
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
192
|
+
/**
|
|
193
|
+
* HTTP PUT /alarm/assets
|
|
194
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
195
|
+
*/
|
|
196
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
197
|
+
/**
|
|
198
|
+
* HTTP GET /alarm/{alarmId}
|
|
199
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
200
|
+
*/
|
|
201
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
202
|
+
/**
|
|
203
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
204
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
205
|
+
*/
|
|
206
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
207
|
+
/**
|
|
208
|
+
* HTTP PUT /alarm/{alarmId}
|
|
209
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
210
|
+
*/
|
|
211
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
212
|
+
/**
|
|
213
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
214
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
215
|
+
*/
|
|
216
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
217
|
+
realm?: string;
|
|
218
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
219
|
+
}
|
|
220
|
+
export declare class MapResourceClient<O> {
|
|
221
|
+
protected httpClient: HttpClient<O>;
|
|
222
|
+
constructor(httpClient: HttpClient<O>);
|
|
223
|
+
/**
|
|
224
|
+
* HTTP GET /map
|
|
225
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
226
|
+
*/
|
|
227
|
+
getSettings(options?: O): RestResponse<{
|
|
228
|
+
[id: string]: unknown;
|
|
229
|
+
}>;
|
|
230
|
+
/**
|
|
231
|
+
* HTTP PUT /map
|
|
232
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
233
|
+
*/
|
|
234
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
235
|
+
[id: string]: unknown;
|
|
236
|
+
}>;
|
|
237
|
+
/**
|
|
238
|
+
* HTTP DELETE /map/deleteMap
|
|
239
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
240
|
+
*/
|
|
241
|
+
deleteMap(options?: O): RestResponse<{
|
|
242
|
+
[id: string]: unknown;
|
|
243
|
+
}>;
|
|
244
|
+
/**
|
|
245
|
+
* HTTP GET /map/getCustomMapInfo
|
|
246
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
247
|
+
*/
|
|
248
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
249
|
+
[id: string]: unknown;
|
|
250
|
+
}>;
|
|
251
|
+
/**
|
|
252
|
+
* HTTP GET /map/js
|
|
253
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
264
254
|
*/
|
|
265
255
|
getSettingsJs(options?: O): RestResponse<{
|
|
266
256
|
[id: string]: unknown;
|
|
@@ -280,296 +270,149 @@ export declare class MapResourceClient<O> {
|
|
|
280
270
|
[id: string]: unknown;
|
|
281
271
|
}>;
|
|
282
272
|
}
|
|
283
|
-
export declare class
|
|
273
|
+
export declare class DashboardResourceClient<O> {
|
|
284
274
|
protected httpClient: HttpClient<O>;
|
|
285
275
|
constructor(httpClient: HttpClient<O>);
|
|
286
276
|
/**
|
|
287
|
-
* HTTP POST /
|
|
288
|
-
* Java method: org.openremote.model.
|
|
277
|
+
* HTTP POST /dashboard
|
|
278
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
289
279
|
*/
|
|
290
|
-
|
|
291
|
-
}
|
|
292
|
-
export declare class ProvisioningResourceClient<O> {
|
|
293
|
-
protected httpClient: HttpClient<O>;
|
|
294
|
-
constructor(httpClient: HttpClient<O>);
|
|
280
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
295
281
|
/**
|
|
296
|
-
* HTTP
|
|
297
|
-
* Java method: org.openremote.model.
|
|
282
|
+
* HTTP PUT /dashboard
|
|
283
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
298
284
|
*/
|
|
299
|
-
|
|
285
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
300
286
|
/**
|
|
301
|
-
* HTTP GET /
|
|
302
|
-
* Java method: org.openremote.model.
|
|
287
|
+
* HTTP GET /dashboard/all/{realm}
|
|
288
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
303
289
|
*/
|
|
304
|
-
|
|
290
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
305
291
|
/**
|
|
306
|
-
* HTTP
|
|
307
|
-
* Java method: org.openremote.model.
|
|
292
|
+
* HTTP POST /dashboard/query
|
|
293
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
308
294
|
*/
|
|
309
|
-
|
|
295
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
310
296
|
/**
|
|
311
|
-
* HTTP
|
|
312
|
-
* Java method: org.openremote.model.
|
|
297
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
298
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
313
299
|
*/
|
|
314
|
-
|
|
300
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
301
|
+
/**
|
|
302
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
303
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
304
|
+
*/
|
|
305
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
315
306
|
}
|
|
316
|
-
export declare class
|
|
307
|
+
export declare class GatewayClientResourceClient<O> {
|
|
317
308
|
protected httpClient: HttpClient<O>;
|
|
318
309
|
constructor(httpClient: HttpClient<O>);
|
|
319
310
|
/**
|
|
320
|
-
* HTTP
|
|
321
|
-
* Java method: org.openremote.model.
|
|
311
|
+
* HTTP DELETE /gateway/connection
|
|
312
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
322
313
|
*/
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
314
|
+
deleteConnections(queryParams?: {
|
|
315
|
+
realm?: string[];
|
|
316
|
+
}, options?: O): RestResponse<void>;
|
|
327
317
|
/**
|
|
328
|
-
* HTTP GET /
|
|
329
|
-
* Java method: org.openremote.model.
|
|
318
|
+
* HTTP GET /gateway/connection
|
|
319
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
330
320
|
*/
|
|
331
|
-
|
|
332
|
-
parentId?: string;
|
|
333
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
321
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
334
322
|
/**
|
|
335
|
-
* HTTP
|
|
336
|
-
* Java method: org.openremote.model.
|
|
323
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
324
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
337
325
|
*/
|
|
338
|
-
|
|
339
|
-
parentId?: string;
|
|
340
|
-
parentType?: string;
|
|
341
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
326
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
342
327
|
/**
|
|
343
|
-
* HTTP GET /
|
|
344
|
-
* Java method: org.openremote.model.
|
|
328
|
+
* HTTP GET /gateway/connection/{realm}
|
|
329
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
345
330
|
*/
|
|
346
|
-
|
|
347
|
-
parentId?: string;
|
|
348
|
-
}, options?: O): RestResponse<{
|
|
349
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
350
|
-
}>;
|
|
331
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
351
332
|
/**
|
|
352
|
-
* HTTP
|
|
353
|
-
* Java method: org.openremote.model.
|
|
333
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
334
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
354
335
|
*/
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
336
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
337
|
+
/**
|
|
338
|
+
* HTTP GET /gateway/status/{realm}
|
|
339
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
340
|
+
*/
|
|
341
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
360
342
|
}
|
|
361
|
-
export declare class
|
|
343
|
+
export declare class FlowResourceClient<O> {
|
|
362
344
|
protected httpClient: HttpClient<O>;
|
|
363
345
|
constructor(httpClient: HttpClient<O>);
|
|
364
346
|
/**
|
|
365
|
-
* HTTP
|
|
366
|
-
* Java method: org.openremote.model.
|
|
347
|
+
* HTTP GET /flow
|
|
348
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
367
349
|
*/
|
|
368
|
-
|
|
350
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
369
351
|
/**
|
|
370
|
-
* HTTP
|
|
371
|
-
* Java method: org.openremote.model.
|
|
352
|
+
* HTTP GET /flow/{name}
|
|
353
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
372
354
|
*/
|
|
373
|
-
|
|
355
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
374
356
|
/**
|
|
375
|
-
* HTTP
|
|
376
|
-
* Java method: org.openremote.model.
|
|
357
|
+
* HTTP GET /flow/{type}
|
|
358
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
377
359
|
*/
|
|
378
|
-
|
|
360
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
361
|
+
}
|
|
362
|
+
export declare class RulesResourceClient<O> {
|
|
363
|
+
protected httpClient: HttpClient<O>;
|
|
364
|
+
constructor(httpClient: HttpClient<O>);
|
|
379
365
|
/**
|
|
380
|
-
* HTTP
|
|
381
|
-
* Java method: org.openremote.model.
|
|
366
|
+
* HTTP POST /rules
|
|
367
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
382
368
|
*/
|
|
383
|
-
|
|
369
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
384
370
|
/**
|
|
385
|
-
* HTTP
|
|
386
|
-
* Java method: org.openremote.model.
|
|
371
|
+
* HTTP GET /rules
|
|
372
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
387
373
|
*/
|
|
388
|
-
|
|
374
|
+
getGlobalRulesets(queryParams?: {
|
|
375
|
+
language?: Model.RulesetLang[];
|
|
376
|
+
fullyPopulate?: boolean;
|
|
377
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
389
378
|
/**
|
|
390
|
-
* HTTP
|
|
391
|
-
* Java method: org.openremote.model.
|
|
379
|
+
* HTTP POST /rules/asset
|
|
380
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
392
381
|
*/
|
|
393
|
-
|
|
382
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
394
383
|
/**
|
|
395
|
-
* HTTP GET /
|
|
396
|
-
* Java method: org.openremote.model.
|
|
384
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
385
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
397
386
|
*/
|
|
398
|
-
|
|
387
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
388
|
+
language?: Model.RulesetLang[];
|
|
389
|
+
fullyPopulate?: boolean;
|
|
390
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
399
391
|
/**
|
|
400
|
-
* HTTP
|
|
401
|
-
* Java method: org.openremote.model.
|
|
392
|
+
* HTTP DELETE /rules/asset/{id}
|
|
393
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
402
394
|
*/
|
|
403
|
-
|
|
395
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
404
396
|
/**
|
|
405
|
-
* HTTP GET /
|
|
406
|
-
* Java method: org.openremote.model.
|
|
397
|
+
* HTTP GET /rules/asset/{id}
|
|
398
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
407
399
|
*/
|
|
408
|
-
|
|
400
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
409
401
|
/**
|
|
410
|
-
* HTTP PUT /
|
|
411
|
-
* Java method: org.openremote.model.
|
|
402
|
+
* HTTP PUT /rules/asset/{id}
|
|
403
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
412
404
|
*/
|
|
413
|
-
|
|
405
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
414
406
|
/**
|
|
415
|
-
* HTTP
|
|
416
|
-
* Java method: org.openremote.model.
|
|
407
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
408
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
417
409
|
*/
|
|
418
|
-
|
|
410
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
419
411
|
/**
|
|
420
|
-
* HTTP GET /
|
|
421
|
-
* Java method: org.openremote.model.
|
|
412
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
413
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
422
414
|
*/
|
|
423
|
-
|
|
424
|
-
/**
|
|
425
|
-
* HTTP PUT /user/{realm}/roles
|
|
426
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
427
|
-
*/
|
|
428
|
-
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
429
|
-
/**
|
|
430
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
431
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
432
|
-
*/
|
|
433
|
-
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
434
|
-
/**
|
|
435
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
436
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
437
|
-
*/
|
|
438
|
-
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
439
|
-
/**
|
|
440
|
-
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
441
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
442
|
-
*/
|
|
443
|
-
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
444
|
-
/**
|
|
445
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
446
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
447
|
-
*/
|
|
448
|
-
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
449
|
-
/**
|
|
450
|
-
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
451
|
-
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
452
|
-
*/
|
|
453
|
-
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
454
|
-
/**
|
|
455
|
-
* HTTP POST /user/{realm}/users
|
|
456
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
457
|
-
*/
|
|
458
|
-
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
459
|
-
/**
|
|
460
|
-
* HTTP PUT /user/{realm}/users
|
|
461
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
462
|
-
*/
|
|
463
|
-
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
464
|
-
/**
|
|
465
|
-
* HTTP DELETE /user/{realm}/users/{userId}
|
|
466
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
467
|
-
*/
|
|
468
|
-
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
469
|
-
/**
|
|
470
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
471
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
472
|
-
*/
|
|
473
|
-
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
474
|
-
/**
|
|
475
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
476
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
477
|
-
*/
|
|
478
|
-
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
479
|
-
/**
|
|
480
|
-
* HTTP GET /user/{realm}/{userId}
|
|
481
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
482
|
-
*/
|
|
483
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
484
|
-
}
|
|
485
|
-
export declare class RealmResourceClient<O> {
|
|
486
|
-
protected httpClient: HttpClient<O>;
|
|
487
|
-
constructor(httpClient: HttpClient<O>);
|
|
488
|
-
/**
|
|
489
|
-
* HTTP POST /realm
|
|
490
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
491
|
-
*/
|
|
492
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
493
|
-
/**
|
|
494
|
-
* HTTP GET /realm
|
|
495
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
496
|
-
*/
|
|
497
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
498
|
-
/**
|
|
499
|
-
* HTTP GET /realm/accessible
|
|
500
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
501
|
-
*/
|
|
502
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
503
|
-
/**
|
|
504
|
-
* HTTP DELETE /realm/{name}
|
|
505
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
506
|
-
*/
|
|
507
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
508
|
-
/**
|
|
509
|
-
* HTTP GET /realm/{name}
|
|
510
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
511
|
-
*/
|
|
512
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
513
|
-
/**
|
|
514
|
-
* HTTP PUT /realm/{name}
|
|
515
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
516
|
-
*/
|
|
517
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
518
|
-
}
|
|
519
|
-
export declare class RulesResourceClient<O> {
|
|
520
|
-
protected httpClient: HttpClient<O>;
|
|
521
|
-
constructor(httpClient: HttpClient<O>);
|
|
522
|
-
/**
|
|
523
|
-
* HTTP POST /rules
|
|
524
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
525
|
-
*/
|
|
526
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
527
|
-
/**
|
|
528
|
-
* HTTP GET /rules
|
|
529
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
530
|
-
*/
|
|
531
|
-
getGlobalRulesets(queryParams?: {
|
|
532
|
-
language?: Model.RulesetLang[];
|
|
533
|
-
fullyPopulate?: boolean;
|
|
534
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
535
|
-
/**
|
|
536
|
-
* HTTP POST /rules/asset
|
|
537
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
538
|
-
*/
|
|
539
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
540
|
-
/**
|
|
541
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
542
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
543
|
-
*/
|
|
544
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
545
|
-
language?: Model.RulesetLang[];
|
|
546
|
-
fullyPopulate?: boolean;
|
|
547
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
548
|
-
/**
|
|
549
|
-
* HTTP DELETE /rules/asset/{id}
|
|
550
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
551
|
-
*/
|
|
552
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
553
|
-
/**
|
|
554
|
-
* HTTP GET /rules/asset/{id}
|
|
555
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
556
|
-
*/
|
|
557
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
558
|
-
/**
|
|
559
|
-
* HTTP PUT /rules/asset/{id}
|
|
560
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
561
|
-
*/
|
|
562
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
563
|
-
/**
|
|
564
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
565
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
566
|
-
*/
|
|
567
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
568
|
-
/**
|
|
569
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
570
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
571
|
-
*/
|
|
572
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
415
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
573
416
|
/**
|
|
574
417
|
* HTTP GET /rules/info/global
|
|
575
418
|
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
@@ -624,40 +467,6 @@ export declare class RulesResourceClient<O> {
|
|
|
624
467
|
*/
|
|
625
468
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
626
469
|
}
|
|
627
|
-
export declare class DashboardResourceClient<O> {
|
|
628
|
-
protected httpClient: HttpClient<O>;
|
|
629
|
-
constructor(httpClient: HttpClient<O>);
|
|
630
|
-
/**
|
|
631
|
-
* HTTP POST /dashboard
|
|
632
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
633
|
-
*/
|
|
634
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
635
|
-
/**
|
|
636
|
-
* HTTP PUT /dashboard
|
|
637
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
638
|
-
*/
|
|
639
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
640
|
-
/**
|
|
641
|
-
* HTTP GET /dashboard/all/{realm}
|
|
642
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
643
|
-
*/
|
|
644
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
645
|
-
/**
|
|
646
|
-
* HTTP POST /dashboard/query
|
|
647
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
648
|
-
*/
|
|
649
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
650
|
-
/**
|
|
651
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
652
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
653
|
-
*/
|
|
654
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
655
|
-
/**
|
|
656
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
657
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
658
|
-
*/
|
|
659
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
660
|
-
}
|
|
661
470
|
export declare class AssetResourceClient<O> {
|
|
662
471
|
protected httpClient: HttpClient<O>;
|
|
663
472
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -755,57 +564,337 @@ export declare class AssetResourceClient<O> {
|
|
|
755
564
|
*/
|
|
756
565
|
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
757
566
|
/**
|
|
758
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
759
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
567
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
568
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
569
|
+
*/
|
|
570
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
571
|
+
assetIds?: string[];
|
|
572
|
+
}, options?: O): RestResponse<void>;
|
|
573
|
+
}
|
|
574
|
+
export declare class UserResourceClient<O> {
|
|
575
|
+
protected httpClient: HttpClient<O>;
|
|
576
|
+
constructor(httpClient: HttpClient<O>);
|
|
577
|
+
/**
|
|
578
|
+
* HTTP PUT /user/locale
|
|
579
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
580
|
+
*/
|
|
581
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
582
|
+
/**
|
|
583
|
+
* HTTP POST /user/query
|
|
584
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
585
|
+
*/
|
|
586
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
587
|
+
/**
|
|
588
|
+
* HTTP PUT /user/request-password-reset
|
|
589
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
590
|
+
*/
|
|
591
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
592
|
+
/**
|
|
593
|
+
* HTTP PUT /user/reset-password
|
|
594
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
595
|
+
*/
|
|
596
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
597
|
+
/**
|
|
598
|
+
* HTTP PUT /user/update
|
|
599
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
600
|
+
*/
|
|
601
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
602
|
+
/**
|
|
603
|
+
* HTTP GET /user/user
|
|
604
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
605
|
+
*/
|
|
606
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
607
|
+
/**
|
|
608
|
+
* HTTP GET /user/userRealmRoles
|
|
609
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
610
|
+
*/
|
|
611
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
612
|
+
/**
|
|
613
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
614
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
615
|
+
*/
|
|
616
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
617
|
+
/**
|
|
618
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
619
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
620
|
+
*/
|
|
621
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
622
|
+
/**
|
|
623
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
624
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
625
|
+
*/
|
|
626
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
627
|
+
/**
|
|
628
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
629
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
630
|
+
*/
|
|
631
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
632
|
+
/**
|
|
633
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
634
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
635
|
+
*/
|
|
636
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
637
|
+
/**
|
|
638
|
+
* HTTP PUT /user/{realm}/roles
|
|
639
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
640
|
+
*/
|
|
641
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
642
|
+
/**
|
|
643
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
644
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
645
|
+
*/
|
|
646
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
647
|
+
/**
|
|
648
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
649
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
650
|
+
*/
|
|
651
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
652
|
+
/**
|
|
653
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
654
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
655
|
+
*/
|
|
656
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
657
|
+
/**
|
|
658
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
659
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
660
|
+
*/
|
|
661
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
662
|
+
/**
|
|
663
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
664
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
665
|
+
*/
|
|
666
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
667
|
+
/**
|
|
668
|
+
* HTTP POST /user/{realm}/users
|
|
669
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
670
|
+
*/
|
|
671
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
672
|
+
/**
|
|
673
|
+
* HTTP PUT /user/{realm}/users
|
|
674
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
675
|
+
*/
|
|
676
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
677
|
+
/**
|
|
678
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
679
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
680
|
+
*/
|
|
681
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
682
|
+
/**
|
|
683
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
684
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
685
|
+
*/
|
|
686
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
687
|
+
/**
|
|
688
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
689
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
690
|
+
*/
|
|
691
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
692
|
+
/**
|
|
693
|
+
* HTTP GET /user/{realm}/{userId}
|
|
694
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
695
|
+
*/
|
|
696
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
697
|
+
}
|
|
698
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
699
|
+
protected httpClient: HttpClient<O>;
|
|
700
|
+
constructor(httpClient: HttpClient<O>);
|
|
701
|
+
/**
|
|
702
|
+
* Response code 200 - List of registered external services
|
|
703
|
+
* HTTP GET /service
|
|
704
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
705
|
+
*/
|
|
706
|
+
getServices(queryParams?: {
|
|
707
|
+
realm?: string;
|
|
708
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
709
|
+
/**
|
|
710
|
+
* Response code 200 - Service registered successfully
|
|
711
|
+
* Response code 400 - Invalid external service object
|
|
712
|
+
* Response code 409 - ExternalService instance already registered
|
|
713
|
+
* HTTP POST /service
|
|
714
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
715
|
+
*/
|
|
716
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
717
|
+
/**
|
|
718
|
+
* Response code 200 - List of registered external services
|
|
719
|
+
* HTTP GET /service/global
|
|
720
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
721
|
+
*/
|
|
722
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
723
|
+
/**
|
|
724
|
+
* Response code 200 - Service registered successfully
|
|
725
|
+
* Response code 400 - Invalid external service object
|
|
726
|
+
* Response code 409 - ExternalService instance already registered
|
|
727
|
+
* HTTP POST /service/global
|
|
728
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
729
|
+
*/
|
|
730
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
731
|
+
/**
|
|
732
|
+
* Response code 204 - Service deregistered successfully
|
|
733
|
+
* Response code 404 - Service instance not found
|
|
734
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
735
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
736
|
+
*/
|
|
737
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
738
|
+
/**
|
|
739
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
740
|
+
* Response code 404 - ExternalService not found
|
|
741
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
742
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
743
|
+
*/
|
|
744
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
745
|
+
/**
|
|
746
|
+
* Response code 204 - Heartbeat sent successfully
|
|
747
|
+
* Response code 404 - Service instance not found
|
|
748
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
749
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
750
|
+
*/
|
|
751
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
752
|
+
}
|
|
753
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
754
|
+
protected httpClient: HttpClient<O>;
|
|
755
|
+
constructor(httpClient: HttpClient<O>);
|
|
756
|
+
/**
|
|
757
|
+
* HTTP GET /asset/datapoint/export
|
|
758
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
759
|
+
*/
|
|
760
|
+
getDatapointExport(queryParams?: {
|
|
761
|
+
attributeRefs?: string;
|
|
762
|
+
fromTimestamp?: number;
|
|
763
|
+
toTimestamp?: number;
|
|
764
|
+
}, options?: O): RestResponse<any>;
|
|
765
|
+
/**
|
|
766
|
+
* HTTP GET /asset/datapoint/periods
|
|
767
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
768
|
+
*/
|
|
769
|
+
getDatapointPeriod(queryParams?: {
|
|
770
|
+
assetId?: string;
|
|
771
|
+
attributeName?: string;
|
|
772
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
773
|
+
/**
|
|
774
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
775
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
776
|
+
*/
|
|
777
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
778
|
+
}
|
|
779
|
+
export declare class NotificationResourceClient<O> {
|
|
780
|
+
protected httpClient: HttpClient<O>;
|
|
781
|
+
constructor(httpClient: HttpClient<O>);
|
|
782
|
+
/**
|
|
783
|
+
* HTTP GET /notification
|
|
784
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
785
|
+
*/
|
|
786
|
+
getNotifications(queryParams?: {
|
|
787
|
+
id?: number;
|
|
788
|
+
type?: string;
|
|
789
|
+
from?: number;
|
|
790
|
+
to?: number;
|
|
791
|
+
realmId?: string;
|
|
792
|
+
userId?: string;
|
|
793
|
+
assetId?: string;
|
|
794
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
795
|
+
/**
|
|
796
|
+
* HTTP DELETE /notification
|
|
797
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
798
|
+
*/
|
|
799
|
+
removeNotifications(queryParams?: {
|
|
800
|
+
id?: number;
|
|
801
|
+
type?: string;
|
|
802
|
+
from?: number;
|
|
803
|
+
to?: number;
|
|
804
|
+
realmId?: string;
|
|
805
|
+
userId?: string;
|
|
806
|
+
assetId?: string;
|
|
807
|
+
}, options?: O): RestResponse<void>;
|
|
808
|
+
/**
|
|
809
|
+
* HTTP POST /notification/alert
|
|
810
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
811
|
+
*/
|
|
812
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP DELETE /notification/{notificationId}
|
|
815
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
816
|
+
*/
|
|
817
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
820
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
821
|
+
*/
|
|
822
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
823
|
+
targetId?: string;
|
|
824
|
+
}, options?: O): RestResponse<void>;
|
|
825
|
+
/**
|
|
826
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
827
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
828
|
+
*/
|
|
829
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
830
|
+
targetId?: string;
|
|
831
|
+
}, options?: O): RestResponse<void>;
|
|
832
|
+
}
|
|
833
|
+
export declare class RealmResourceClient<O> {
|
|
834
|
+
protected httpClient: HttpClient<O>;
|
|
835
|
+
constructor(httpClient: HttpClient<O>);
|
|
836
|
+
/**
|
|
837
|
+
* HTTP POST /realm
|
|
838
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
839
|
+
*/
|
|
840
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
841
|
+
/**
|
|
842
|
+
* HTTP GET /realm
|
|
843
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
844
|
+
*/
|
|
845
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
846
|
+
/**
|
|
847
|
+
* HTTP GET /realm/accessible
|
|
848
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
760
849
|
*/
|
|
761
|
-
|
|
762
|
-
assetIds?: string[];
|
|
763
|
-
}, options?: O): RestResponse<void>;
|
|
764
|
-
}
|
|
765
|
-
export declare class FlowResourceClient<O> {
|
|
766
|
-
protected httpClient: HttpClient<O>;
|
|
767
|
-
constructor(httpClient: HttpClient<O>);
|
|
850
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
768
851
|
/**
|
|
769
|
-
* HTTP
|
|
770
|
-
* Java method: org.openremote.model.
|
|
852
|
+
* HTTP DELETE /realm/{name}
|
|
853
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
771
854
|
*/
|
|
772
|
-
|
|
855
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
773
856
|
/**
|
|
774
|
-
* HTTP GET /
|
|
775
|
-
* Java method: org.openremote.model.
|
|
857
|
+
* HTTP GET /realm/{name}
|
|
858
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
776
859
|
*/
|
|
777
|
-
|
|
860
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
778
861
|
/**
|
|
779
|
-
* HTTP
|
|
780
|
-
* Java method: org.openremote.model.
|
|
862
|
+
* HTTP PUT /realm/{name}
|
|
863
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
781
864
|
*/
|
|
782
|
-
|
|
865
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
783
866
|
}
|
|
784
|
-
export declare class
|
|
867
|
+
export declare class SyslogResourceClient<O> {
|
|
785
868
|
protected httpClient: HttpClient<O>;
|
|
786
869
|
constructor(httpClient: HttpClient<O>);
|
|
787
870
|
/**
|
|
788
|
-
* HTTP GET /
|
|
789
|
-
* Java method: org.openremote.model.
|
|
871
|
+
* HTTP GET /syslog/config
|
|
872
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
790
873
|
*/
|
|
791
|
-
|
|
874
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
792
875
|
/**
|
|
793
|
-
* HTTP PUT /
|
|
794
|
-
* Java method: org.openremote.model.
|
|
876
|
+
* HTTP PUT /syslog/config
|
|
877
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
795
878
|
*/
|
|
796
|
-
|
|
879
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
797
880
|
/**
|
|
798
|
-
* HTTP
|
|
799
|
-
* Java method: org.openremote.model.
|
|
881
|
+
* HTTP DELETE /syslog/event
|
|
882
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
800
883
|
*/
|
|
801
|
-
|
|
802
|
-
path?: string;
|
|
803
|
-
}, options?: O): RestResponse<string>;
|
|
884
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
804
885
|
/**
|
|
805
|
-
* HTTP GET /
|
|
806
|
-
* Java method: org.openremote.model.
|
|
886
|
+
* HTTP GET /syslog/event
|
|
887
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
807
888
|
*/
|
|
808
|
-
|
|
889
|
+
getEvents(queryParams?: {
|
|
890
|
+
level?: Model.SyslogLevel;
|
|
891
|
+
per_page?: number;
|
|
892
|
+
page?: number;
|
|
893
|
+
from?: number;
|
|
894
|
+
to?: number;
|
|
895
|
+
category?: Model.SyslogCategory[];
|
|
896
|
+
subCategory?: string[];
|
|
897
|
+
}, options?: O): RestResponse<any>;
|
|
809
898
|
}
|
|
810
899
|
export declare class GatewayServiceResourceClient<O> {
|
|
811
900
|
protected httpClient: HttpClient<O>;
|
|
@@ -836,95 +925,6 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
836
925
|
*/
|
|
837
926
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
838
927
|
}
|
|
839
|
-
export declare class AlarmResourceClient<O> {
|
|
840
|
-
protected httpClient: HttpClient<O>;
|
|
841
|
-
constructor(httpClient: HttpClient<O>);
|
|
842
|
-
/**
|
|
843
|
-
* HTTP POST /alarm
|
|
844
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
845
|
-
*/
|
|
846
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
847
|
-
assetIds?: string[];
|
|
848
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
849
|
-
/**
|
|
850
|
-
* HTTP GET /alarm
|
|
851
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
852
|
-
*/
|
|
853
|
-
getAlarms(queryParams?: {
|
|
854
|
-
realm?: string;
|
|
855
|
-
status?: Model.AlarmStatus;
|
|
856
|
-
assetId?: string;
|
|
857
|
-
assigneeId?: string;
|
|
858
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
859
|
-
/**
|
|
860
|
-
* HTTP DELETE /alarm
|
|
861
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
862
|
-
*/
|
|
863
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
864
|
-
/**
|
|
865
|
-
* HTTP PUT /alarm/assets
|
|
866
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
867
|
-
*/
|
|
868
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
869
|
-
/**
|
|
870
|
-
* HTTP GET /alarm/{alarmId}
|
|
871
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
872
|
-
*/
|
|
873
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
874
|
-
/**
|
|
875
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
876
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
877
|
-
*/
|
|
878
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
879
|
-
/**
|
|
880
|
-
* HTTP PUT /alarm/{alarmId}
|
|
881
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
882
|
-
*/
|
|
883
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
884
|
-
/**
|
|
885
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
886
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
887
|
-
*/
|
|
888
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
889
|
-
realm?: string;
|
|
890
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
891
|
-
}
|
|
892
|
-
export declare class GatewayClientResourceClient<O> {
|
|
893
|
-
protected httpClient: HttpClient<O>;
|
|
894
|
-
constructor(httpClient: HttpClient<O>);
|
|
895
|
-
/**
|
|
896
|
-
* HTTP DELETE /gateway/connection
|
|
897
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
898
|
-
*/
|
|
899
|
-
deleteConnections(queryParams?: {
|
|
900
|
-
realm?: string[];
|
|
901
|
-
}, options?: O): RestResponse<void>;
|
|
902
|
-
/**
|
|
903
|
-
* HTTP GET /gateway/connection
|
|
904
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
905
|
-
*/
|
|
906
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
907
|
-
/**
|
|
908
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
909
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
910
|
-
*/
|
|
911
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
912
|
-
/**
|
|
913
|
-
* HTTP GET /gateway/connection/{realm}
|
|
914
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
915
|
-
*/
|
|
916
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
917
|
-
/**
|
|
918
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
919
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
920
|
-
*/
|
|
921
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
922
|
-
/**
|
|
923
|
-
* HTTP GET /gateway/status/{realm}
|
|
924
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
925
|
-
*/
|
|
926
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
927
|
-
}
|
|
928
928
|
export declare class AgentResourceClient<O> {
|
|
929
929
|
protected httpClient: HttpClient<O>;
|
|
930
930
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -953,50 +953,50 @@ export declare class AgentResourceClient<O> {
|
|
|
953
953
|
}
|
|
954
954
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
955
955
|
export declare class ApiClient {
|
|
956
|
-
protected
|
|
957
|
-
protected
|
|
958
|
-
protected _appResource: AxiosAppResourceClient;
|
|
956
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
957
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
959
958
|
protected _statusResource: AxiosStatusResourceClient;
|
|
960
|
-
protected
|
|
959
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
961
960
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
962
|
-
protected
|
|
961
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
962
|
+
protected _appResource: AxiosAppResourceClient;
|
|
963
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
963
964
|
protected _mapResource: AxiosMapResourceClient;
|
|
964
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
965
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
966
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
967
|
-
protected _userResource: AxiosUserResourceClient;
|
|
968
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
969
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
970
965
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
971
|
-
protected
|
|
966
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
972
967
|
protected _flowResource: AxiosFlowResourceClient;
|
|
973
|
-
protected
|
|
968
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
969
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
970
|
+
protected _userResource: AxiosUserResourceClient;
|
|
971
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
972
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
973
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
974
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
975
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
974
976
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
975
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
976
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
977
977
|
protected _agentResource: AxiosAgentResourceClient;
|
|
978
978
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
979
|
-
get
|
|
980
|
-
get
|
|
981
|
-
get AppResource(): AxiosAppResourceClient;
|
|
979
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
980
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
982
981
|
get StatusResource(): AxiosStatusResourceClient;
|
|
983
|
-
get
|
|
982
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
984
983
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
985
|
-
get
|
|
984
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
985
|
+
get AppResource(): AxiosAppResourceClient;
|
|
986
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
986
987
|
get MapResource(): AxiosMapResourceClient;
|
|
987
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
988
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
989
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
990
|
-
get UserResource(): AxiosUserResourceClient;
|
|
991
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
992
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
993
988
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
994
|
-
get
|
|
989
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
995
990
|
get FlowResource(): AxiosFlowResourceClient;
|
|
996
|
-
get
|
|
991
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
992
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
993
|
+
get UserResource(): AxiosUserResourceClient;
|
|
994
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
995
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
996
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
997
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
998
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
997
999
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
998
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
999
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1000
1000
|
get AgentResource(): AxiosAgentResourceClient;
|
|
1001
1001
|
}
|
|
1002
1002
|
import * as Axios from "axios";
|
|
@@ -1005,67 +1005,67 @@ declare module "axios" {
|
|
|
1005
1005
|
data: R;
|
|
1006
1006
|
}
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1009
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
|
-
}
|
|
1011
|
-
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1008
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1010
|
}
|
|
1014
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1015
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1016
1013
|
}
|
|
1017
1014
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1018
1015
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1019
1016
|
}
|
|
1020
|
-
export declare class
|
|
1017
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1021
1018
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1022
1019
|
}
|
|
1023
1020
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1024
1021
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1025
1022
|
}
|
|
1026
|
-
export declare class
|
|
1023
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1027
1024
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1028
1025
|
}
|
|
1029
|
-
export declare class
|
|
1026
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1030
1027
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1031
1028
|
}
|
|
1032
|
-
export declare class
|
|
1029
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
1030
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1034
1031
|
}
|
|
1035
|
-
export declare class
|
|
1032
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1036
1033
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1037
1034
|
}
|
|
1038
|
-
export declare class
|
|
1035
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1039
1036
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1040
1037
|
}
|
|
1041
|
-
export declare class
|
|
1038
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1042
1039
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1043
1040
|
}
|
|
1044
|
-
export declare class
|
|
1041
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1045
1042
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1046
1043
|
}
|
|
1047
1044
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1048
1045
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1049
1046
|
}
|
|
1050
|
-
export declare class
|
|
1047
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1051
1048
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1052
1049
|
}
|
|
1053
|
-
export declare class
|
|
1050
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1054
1051
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1055
1052
|
}
|
|
1056
|
-
export declare class
|
|
1053
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1057
1054
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1058
1055
|
}
|
|
1059
|
-
export declare class
|
|
1056
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1060
1057
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1061
1058
|
}
|
|
1062
|
-
export declare class
|
|
1059
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1063
1060
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1064
1061
|
}
|
|
1065
|
-
export declare class
|
|
1062
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
1063
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
1064
|
}
|
|
1068
|
-
export declare class
|
|
1065
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
|
+
}
|
|
1068
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1069
1069
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1070
1070
|
}
|
|
1071
1071
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|