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