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