@openremote/rest 1.9.0-snapshot.20250903163007 → 1.9.0-snapshot.20250904112310
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 +443 -443
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,58 +9,58 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AlarmResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /alarm
|
|
17
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
}>;
|
|
19
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
20
|
+
assetIds?: string[];
|
|
21
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
22
22
|
/**
|
|
23
|
-
* HTTP
|
|
24
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /alarm
|
|
24
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
25
25
|
*/
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
26
|
+
getAlarms(queryParams?: {
|
|
27
|
+
realm?: string;
|
|
28
|
+
status?: Model.AlarmStatus;
|
|
29
|
+
assetId?: string;
|
|
30
|
+
assigneeId?: string;
|
|
31
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
29
32
|
/**
|
|
30
|
-
* HTTP DELETE /
|
|
31
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP DELETE /alarm
|
|
34
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
32
35
|
*/
|
|
33
|
-
|
|
34
|
-
[id: string]: unknown;
|
|
35
|
-
}>;
|
|
36
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
36
37
|
/**
|
|
37
|
-
* HTTP
|
|
38
|
-
* Java method: org.openremote.model.
|
|
38
|
+
* HTTP PUT /alarm/assets
|
|
39
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
39
40
|
*/
|
|
40
|
-
|
|
41
|
-
[id: string]: unknown;
|
|
42
|
-
}>;
|
|
41
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
43
42
|
/**
|
|
44
|
-
* HTTP GET /
|
|
45
|
-
* Java method: org.openremote.model.
|
|
43
|
+
* HTTP GET /alarm/{alarmId}
|
|
44
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
46
45
|
*/
|
|
47
|
-
|
|
48
|
-
[id: string]: unknown;
|
|
49
|
-
}>;
|
|
46
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
50
47
|
/**
|
|
51
|
-
* HTTP
|
|
52
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
49
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
53
50
|
*/
|
|
54
|
-
|
|
51
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
55
52
|
/**
|
|
56
|
-
* HTTP
|
|
57
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP PUT /alarm/{alarmId}
|
|
54
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
58
55
|
*/
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
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
64
|
}
|
|
65
65
|
export declare class FlowResourceClient<O> {
|
|
66
66
|
protected httpClient: HttpClient<O>;
|
|
@@ -81,109 +81,23 @@ export declare class FlowResourceClient<O> {
|
|
|
81
81
|
*/
|
|
82
82
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
83
83
|
}
|
|
84
|
-
export declare class
|
|
84
|
+
export declare class StatusResourceClient<O> {
|
|
85
85
|
protected httpClient: HttpClient<O>;
|
|
86
86
|
constructor(httpClient: HttpClient<O>);
|
|
87
87
|
/**
|
|
88
|
-
* HTTP
|
|
89
|
-
* Java method: org.openremote.model.
|
|
90
|
-
*/
|
|
91
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
92
|
-
/**
|
|
93
|
-
* HTTP DELETE /asset
|
|
94
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
95
|
-
*/
|
|
96
|
-
delete(queryParams?: {
|
|
97
|
-
assetId?: string[];
|
|
98
|
-
}, options?: O): RestResponse<void>;
|
|
99
|
-
/**
|
|
100
|
-
* HTTP PUT /asset/attributes
|
|
101
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
102
|
-
*/
|
|
103
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
104
|
-
/**
|
|
105
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
106
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
107
|
-
*/
|
|
108
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
109
|
-
/**
|
|
110
|
-
* HTTP DELETE /asset/parent
|
|
111
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
112
|
-
*/
|
|
113
|
-
updateNoneParent(queryParams?: {
|
|
114
|
-
assetIds?: string[];
|
|
115
|
-
}, options?: O): RestResponse<void>;
|
|
116
|
-
/**
|
|
117
|
-
* HTTP GET /asset/partial/{assetId}
|
|
118
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
119
|
-
*/
|
|
120
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
121
|
-
/**
|
|
122
|
-
* HTTP POST /asset/query
|
|
123
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
124
|
-
*/
|
|
125
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
126
|
-
/**
|
|
127
|
-
* HTTP GET /asset/user/current
|
|
128
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
129
|
-
*/
|
|
130
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
131
|
-
/**
|
|
132
|
-
* HTTP POST /asset/user/link
|
|
133
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
134
|
-
*/
|
|
135
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
136
|
-
/**
|
|
137
|
-
* HTTP GET /asset/user/link
|
|
138
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
139
|
-
*/
|
|
140
|
-
getUserAssetLinks(queryParams?: {
|
|
141
|
-
realm?: string;
|
|
142
|
-
userId?: string;
|
|
143
|
-
assetId?: string;
|
|
144
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
145
|
-
/**
|
|
146
|
-
* HTTP POST /asset/user/link/delete
|
|
147
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
148
|
-
*/
|
|
149
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
150
|
-
/**
|
|
151
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
152
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
153
|
-
*/
|
|
154
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
155
|
-
/**
|
|
156
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
157
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
158
|
-
*/
|
|
159
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
160
|
-
/**
|
|
161
|
-
* HTTP GET /asset/{assetId}
|
|
162
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
163
|
-
*/
|
|
164
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
165
|
-
/**
|
|
166
|
-
* HTTP PUT /asset/{assetId}
|
|
167
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
168
|
-
*/
|
|
169
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
170
|
-
/**
|
|
171
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
172
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
173
|
-
*/
|
|
174
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
175
|
-
/**
|
|
176
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
177
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
88
|
+
* HTTP GET /health
|
|
89
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
178
90
|
*/
|
|
179
|
-
|
|
91
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
92
|
+
[index: string]: any;
|
|
93
|
+
}>;
|
|
180
94
|
/**
|
|
181
|
-
* HTTP
|
|
182
|
-
* Java method: org.openremote.model.
|
|
95
|
+
* HTTP GET /info
|
|
96
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
183
97
|
*/
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
}
|
|
98
|
+
getInfo(options?: O): RestResponse<{
|
|
99
|
+
[index: string]: any;
|
|
100
|
+
}>;
|
|
187
101
|
}
|
|
188
102
|
export declare class ConfigurationResourceClient<O> {
|
|
189
103
|
protected httpClient: HttpClient<O>;
|
|
@@ -211,23 +125,31 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
211
125
|
*/
|
|
212
126
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
213
127
|
}
|
|
214
|
-
export declare class
|
|
128
|
+
export declare class AgentResourceClient<O> {
|
|
215
129
|
protected httpClient: HttpClient<O>;
|
|
216
130
|
constructor(httpClient: HttpClient<O>);
|
|
217
131
|
/**
|
|
218
|
-
* HTTP GET /
|
|
219
|
-
* Java method: org.openremote.model.
|
|
132
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
133
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
220
134
|
*/
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
}>;
|
|
135
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
136
|
+
realm?: string;
|
|
137
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
224
138
|
/**
|
|
225
|
-
* HTTP
|
|
226
|
-
* Java method: org.openremote.model.
|
|
139
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
140
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
227
141
|
*/
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
}>;
|
|
142
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
143
|
+
realm?: string;
|
|
144
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
145
|
+
/**
|
|
146
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
147
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
148
|
+
*/
|
|
149
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
150
|
+
parentId?: string;
|
|
151
|
+
realm?: string;
|
|
152
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
231
153
|
}
|
|
232
154
|
export declare class RulesResourceClient<O> {
|
|
233
155
|
protected httpClient: HttpClient<O>;
|
|
@@ -337,48 +259,66 @@ export declare class RulesResourceClient<O> {
|
|
|
337
259
|
*/
|
|
338
260
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
339
261
|
}
|
|
340
|
-
export declare class
|
|
262
|
+
export declare class ConsoleResourceClient<O> {
|
|
341
263
|
protected httpClient: HttpClient<O>;
|
|
342
264
|
constructor(httpClient: HttpClient<O>);
|
|
343
265
|
/**
|
|
344
|
-
* HTTP
|
|
345
|
-
* Java method: org.openremote.model.
|
|
346
|
-
*/
|
|
347
|
-
deleteConnections(queryParams?: {
|
|
348
|
-
realm?: string[];
|
|
349
|
-
}, options?: O): RestResponse<void>;
|
|
350
|
-
/**
|
|
351
|
-
* HTTP GET /gateway/connection
|
|
352
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
353
|
-
*/
|
|
354
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
355
|
-
/**
|
|
356
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
357
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
266
|
+
* HTTP POST /console/register
|
|
267
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
358
268
|
*/
|
|
359
|
-
|
|
269
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
270
|
+
}
|
|
271
|
+
export declare class AppResourceClient<O> {
|
|
272
|
+
protected httpClient: HttpClient<O>;
|
|
273
|
+
constructor(httpClient: HttpClient<O>);
|
|
360
274
|
/**
|
|
361
|
-
* HTTP GET /
|
|
362
|
-
* Java method: org.openremote.model.
|
|
275
|
+
* HTTP GET /apps
|
|
276
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
363
277
|
*/
|
|
364
|
-
|
|
278
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
365
279
|
/**
|
|
366
|
-
* HTTP
|
|
367
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* HTTP GET /apps/consoleConfig
|
|
281
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
368
282
|
*/
|
|
369
|
-
|
|
283
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
370
284
|
/**
|
|
371
|
-
* HTTP GET /
|
|
372
|
-
* Java method: org.openremote.model.
|
|
285
|
+
* HTTP GET /apps/info
|
|
286
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
373
287
|
*/
|
|
374
|
-
|
|
288
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
375
289
|
}
|
|
376
|
-
export declare class
|
|
290
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
377
291
|
protected httpClient: HttpClient<O>;
|
|
378
292
|
constructor(httpClient: HttpClient<O>);
|
|
379
293
|
/**
|
|
380
|
-
* HTTP
|
|
381
|
-
* Java method: org.openremote.model.
|
|
294
|
+
* HTTP GET /asset/datapoint/export
|
|
295
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
296
|
+
*/
|
|
297
|
+
getDatapointExport(queryParams?: {
|
|
298
|
+
attributeRefs?: string;
|
|
299
|
+
fromTimestamp?: number;
|
|
300
|
+
toTimestamp?: number;
|
|
301
|
+
}, options?: O): RestResponse<any>;
|
|
302
|
+
/**
|
|
303
|
+
* HTTP GET /asset/datapoint/periods
|
|
304
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
305
|
+
*/
|
|
306
|
+
getDatapointPeriod(queryParams?: {
|
|
307
|
+
assetId?: string;
|
|
308
|
+
attributeName?: string;
|
|
309
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
310
|
+
/**
|
|
311
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
312
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
313
|
+
*/
|
|
314
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
315
|
+
}
|
|
316
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
317
|
+
protected httpClient: HttpClient<O>;
|
|
318
|
+
constructor(httpClient: HttpClient<O>);
|
|
319
|
+
/**
|
|
320
|
+
* HTTP POST /gateway/tunnel
|
|
321
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
382
322
|
*/
|
|
383
323
|
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
384
324
|
/**
|
|
@@ -526,162 +466,83 @@ export declare class UserResourceClient<O> {
|
|
|
526
466
|
*/
|
|
527
467
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
528
468
|
}
|
|
529
|
-
export declare class
|
|
530
|
-
protected httpClient: HttpClient<O>;
|
|
531
|
-
constructor(httpClient: HttpClient<O>);
|
|
532
|
-
/**
|
|
533
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
534
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
535
|
-
*/
|
|
536
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
537
|
-
realm?: string;
|
|
538
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
541
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
542
|
-
*/
|
|
543
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
544
|
-
realm?: string;
|
|
545
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
546
|
-
/**
|
|
547
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
548
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
549
|
-
*/
|
|
550
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
551
|
-
parentId?: string;
|
|
552
|
-
realm?: string;
|
|
553
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
554
|
-
}
|
|
555
|
-
export declare class AlarmResourceClient<O> {
|
|
469
|
+
export declare class ProvisioningResourceClient<O> {
|
|
556
470
|
protected httpClient: HttpClient<O>;
|
|
557
471
|
constructor(httpClient: HttpClient<O>);
|
|
558
472
|
/**
|
|
559
|
-
* HTTP POST /
|
|
560
|
-
* Java method: org.openremote.model.
|
|
561
|
-
*/
|
|
562
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
563
|
-
assetIds?: string[];
|
|
564
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
565
|
-
/**
|
|
566
|
-
* HTTP GET /alarm
|
|
567
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
568
|
-
*/
|
|
569
|
-
getAlarms(queryParams?: {
|
|
570
|
-
realm?: string;
|
|
571
|
-
status?: Model.AlarmStatus;
|
|
572
|
-
assetId?: string;
|
|
573
|
-
assigneeId?: string;
|
|
574
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
575
|
-
/**
|
|
576
|
-
* HTTP DELETE /alarm
|
|
577
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
578
|
-
*/
|
|
579
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
580
|
-
/**
|
|
581
|
-
* HTTP PUT /alarm/assets
|
|
582
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
583
|
-
*/
|
|
584
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
585
|
-
/**
|
|
586
|
-
* HTTP GET /alarm/{alarmId}
|
|
587
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
588
|
-
*/
|
|
589
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
590
|
-
/**
|
|
591
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
592
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
593
|
-
*/
|
|
594
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
595
|
-
/**
|
|
596
|
-
* HTTP PUT /alarm/{alarmId}
|
|
597
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
473
|
+
* HTTP POST /provisioning
|
|
474
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
598
475
|
*/
|
|
599
|
-
|
|
476
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
600
477
|
/**
|
|
601
|
-
* HTTP GET /
|
|
602
|
-
* Java method: org.openremote.model.
|
|
478
|
+
* HTTP GET /provisioning
|
|
479
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
603
480
|
*/
|
|
604
|
-
|
|
605
|
-
realm?: string;
|
|
606
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
607
|
-
}
|
|
608
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
609
|
-
protected httpClient: HttpClient<O>;
|
|
610
|
-
constructor(httpClient: HttpClient<O>);
|
|
481
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
611
482
|
/**
|
|
612
|
-
* HTTP
|
|
613
|
-
* Java method: org.openremote.model.
|
|
483
|
+
* HTTP DELETE /provisioning/{id}
|
|
484
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
614
485
|
*/
|
|
615
|
-
|
|
486
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
616
487
|
/**
|
|
617
|
-
* HTTP PUT /
|
|
618
|
-
* Java method: org.openremote.model.
|
|
488
|
+
* HTTP PUT /provisioning/{id}
|
|
489
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
619
490
|
*/
|
|
620
|
-
|
|
491
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
621
492
|
}
|
|
622
|
-
export declare class
|
|
493
|
+
export declare class NotificationResourceClient<O> {
|
|
623
494
|
protected httpClient: HttpClient<O>;
|
|
624
495
|
constructor(httpClient: HttpClient<O>);
|
|
625
496
|
/**
|
|
626
|
-
* HTTP GET /
|
|
627
|
-
* Java method: org.openremote.model.
|
|
628
|
-
*/
|
|
629
|
-
getAssetDescriptors(queryParams?: {
|
|
630
|
-
parentId?: string;
|
|
631
|
-
parentType?: string;
|
|
632
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
633
|
-
/**
|
|
634
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
635
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
636
|
-
*/
|
|
637
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
638
|
-
parentId?: string;
|
|
639
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
640
|
-
/**
|
|
641
|
-
* HTTP GET /model/assetInfos
|
|
642
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
497
|
+
* HTTP GET /notification
|
|
498
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
643
499
|
*/
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
500
|
+
getNotifications(queryParams?: {
|
|
501
|
+
id?: number;
|
|
502
|
+
type?: string;
|
|
503
|
+
from?: number;
|
|
504
|
+
to?: number;
|
|
505
|
+
realmId?: string;
|
|
506
|
+
userId?: string;
|
|
507
|
+
assetId?: string;
|
|
508
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
648
509
|
/**
|
|
649
|
-
* HTTP
|
|
650
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP DELETE /notification
|
|
511
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
651
512
|
*/
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
513
|
+
removeNotifications(queryParams?: {
|
|
514
|
+
id?: number;
|
|
515
|
+
type?: string;
|
|
516
|
+
from?: number;
|
|
517
|
+
to?: number;
|
|
518
|
+
realmId?: string;
|
|
519
|
+
userId?: string;
|
|
520
|
+
assetId?: string;
|
|
521
|
+
}, options?: O): RestResponse<void>;
|
|
657
522
|
/**
|
|
658
|
-
* HTTP
|
|
659
|
-
* Java method: org.openremote.model.
|
|
523
|
+
* HTTP POST /notification/alert
|
|
524
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
660
525
|
*/
|
|
661
|
-
|
|
662
|
-
parentId?: string;
|
|
663
|
-
}, options?: O): RestResponse<{
|
|
664
|
-
[index: string]: Model.ValueDescriptor;
|
|
665
|
-
}>;
|
|
666
|
-
}
|
|
667
|
-
export declare class AppResourceClient<O> {
|
|
668
|
-
protected httpClient: HttpClient<O>;
|
|
669
|
-
constructor(httpClient: HttpClient<O>);
|
|
526
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
670
527
|
/**
|
|
671
|
-
* HTTP
|
|
672
|
-
* Java method: org.openremote.model.
|
|
528
|
+
* HTTP DELETE /notification/{notificationId}
|
|
529
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
673
530
|
*/
|
|
674
|
-
|
|
531
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
675
532
|
/**
|
|
676
|
-
* HTTP
|
|
677
|
-
* Java method: org.openremote.model.
|
|
533
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
534
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
678
535
|
*/
|
|
679
|
-
|
|
536
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
537
|
+
targetId?: string;
|
|
538
|
+
}, options?: O): RestResponse<void>;
|
|
680
539
|
/**
|
|
681
|
-
* HTTP
|
|
682
|
-
* Java method: org.openremote.model.
|
|
540
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
541
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
683
542
|
*/
|
|
684
|
-
|
|
543
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
544
|
+
targetId?: string;
|
|
545
|
+
}, options?: O): RestResponse<void>;
|
|
685
546
|
}
|
|
686
547
|
export declare class DashboardResourceClient<O> {
|
|
687
548
|
protected httpClient: HttpClient<O>;
|
|
@@ -717,6 +578,42 @@ export declare class DashboardResourceClient<O> {
|
|
|
717
578
|
*/
|
|
718
579
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
719
580
|
}
|
|
581
|
+
export declare class GatewayClientResourceClient<O> {
|
|
582
|
+
protected httpClient: HttpClient<O>;
|
|
583
|
+
constructor(httpClient: HttpClient<O>);
|
|
584
|
+
/**
|
|
585
|
+
* HTTP DELETE /gateway/connection
|
|
586
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
587
|
+
*/
|
|
588
|
+
deleteConnections(queryParams?: {
|
|
589
|
+
realm?: string[];
|
|
590
|
+
}, options?: O): RestResponse<void>;
|
|
591
|
+
/**
|
|
592
|
+
* HTTP GET /gateway/connection
|
|
593
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
594
|
+
*/
|
|
595
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
596
|
+
/**
|
|
597
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
598
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
599
|
+
*/
|
|
600
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
601
|
+
/**
|
|
602
|
+
* HTTP GET /gateway/connection/{realm}
|
|
603
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
604
|
+
*/
|
|
605
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
606
|
+
/**
|
|
607
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
608
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
609
|
+
*/
|
|
610
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
611
|
+
/**
|
|
612
|
+
* HTTP GET /gateway/status/{realm}
|
|
613
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
614
|
+
*/
|
|
615
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
616
|
+
}
|
|
720
617
|
export declare class RealmResourceClient<O> {
|
|
721
618
|
protected httpClient: HttpClient<O>;
|
|
722
619
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -751,196 +648,299 @@ export declare class RealmResourceClient<O> {
|
|
|
751
648
|
*/
|
|
752
649
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
753
650
|
}
|
|
754
|
-
export declare class
|
|
651
|
+
export declare class MapResourceClient<O> {
|
|
755
652
|
protected httpClient: HttpClient<O>;
|
|
756
653
|
constructor(httpClient: HttpClient<O>);
|
|
757
654
|
/**
|
|
758
|
-
* HTTP GET /
|
|
759
|
-
* Java method: org.openremote.model.
|
|
655
|
+
* HTTP GET /map
|
|
656
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
760
657
|
*/
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
658
|
+
getSettings(options?: O): RestResponse<{
|
|
659
|
+
[id: string]: unknown;
|
|
660
|
+
}>;
|
|
661
|
+
/**
|
|
662
|
+
* HTTP PUT /map
|
|
663
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
765
664
|
*/
|
|
766
|
-
|
|
665
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
666
|
+
[id: string]: unknown;
|
|
667
|
+
}>;
|
|
767
668
|
/**
|
|
768
|
-
* HTTP DELETE /
|
|
769
|
-
* Java method: org.openremote.model.
|
|
669
|
+
* HTTP DELETE /map/deleteMap
|
|
670
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
770
671
|
*/
|
|
771
|
-
|
|
672
|
+
deleteMap(options?: O): RestResponse<{
|
|
673
|
+
[id: string]: unknown;
|
|
674
|
+
}>;
|
|
772
675
|
/**
|
|
773
|
-
* HTTP GET /
|
|
774
|
-
* Java method: org.openremote.model.
|
|
676
|
+
* HTTP GET /map/getCustomMapInfo
|
|
677
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
775
678
|
*/
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
679
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
680
|
+
[id: string]: unknown;
|
|
681
|
+
}>;
|
|
682
|
+
/**
|
|
683
|
+
* HTTP GET /map/js
|
|
684
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
685
|
+
*/
|
|
686
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
687
|
+
[id: string]: unknown;
|
|
688
|
+
}>;
|
|
689
|
+
/**
|
|
690
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
691
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
692
|
+
*/
|
|
693
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
694
|
+
/**
|
|
695
|
+
* HTTP POST /map/upload
|
|
696
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
697
|
+
*/
|
|
698
|
+
uploadMap(queryParams?: {
|
|
699
|
+
filename?: string;
|
|
700
|
+
}, options?: O): RestResponse<{
|
|
701
|
+
[id: string]: unknown;
|
|
702
|
+
}>;
|
|
785
703
|
}
|
|
786
|
-
export declare class
|
|
704
|
+
export declare class AssetModelResourceClient<O> {
|
|
787
705
|
protected httpClient: HttpClient<O>;
|
|
788
706
|
constructor(httpClient: HttpClient<O>);
|
|
789
707
|
/**
|
|
790
|
-
* HTTP
|
|
791
|
-
* Java method: org.openremote.model.
|
|
708
|
+
* HTTP GET /model/assetDescriptors
|
|
709
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
792
710
|
*/
|
|
793
|
-
|
|
711
|
+
getAssetDescriptors(queryParams?: {
|
|
712
|
+
parentId?: string;
|
|
713
|
+
parentType?: string;
|
|
714
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
794
715
|
/**
|
|
795
|
-
* HTTP GET /
|
|
796
|
-
* Java method: org.openremote.model.
|
|
716
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
717
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
797
718
|
*/
|
|
798
|
-
|
|
719
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
720
|
+
parentId?: string;
|
|
721
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
799
722
|
/**
|
|
800
|
-
* HTTP
|
|
801
|
-
* Java method: org.openremote.model.
|
|
723
|
+
* HTTP GET /model/assetInfos
|
|
724
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
802
725
|
*/
|
|
803
|
-
|
|
726
|
+
getAssetInfos(queryParams?: {
|
|
727
|
+
parentId?: string;
|
|
728
|
+
parentType?: string;
|
|
729
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
804
730
|
/**
|
|
805
|
-
* HTTP
|
|
806
|
-
* Java method: org.openremote.model.
|
|
731
|
+
* HTTP GET /model/metaItemDescriptors
|
|
732
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
807
733
|
*/
|
|
808
|
-
|
|
734
|
+
getMetaItemDescriptors(queryParams?: {
|
|
735
|
+
parentId?: string;
|
|
736
|
+
}, options?: O): RestResponse<{
|
|
737
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
738
|
+
}>;
|
|
739
|
+
/**
|
|
740
|
+
* HTTP GET /model/valueDescriptors
|
|
741
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
742
|
+
*/
|
|
743
|
+
getValueDescriptors(queryParams?: {
|
|
744
|
+
parentId?: string;
|
|
745
|
+
}, options?: O): RestResponse<{
|
|
746
|
+
[index: string]: Model.ValueDescriptor;
|
|
747
|
+
}>;
|
|
809
748
|
}
|
|
810
|
-
export declare class
|
|
749
|
+
export declare class AssetResourceClient<O> {
|
|
811
750
|
protected httpClient: HttpClient<O>;
|
|
812
751
|
constructor(httpClient: HttpClient<O>);
|
|
813
752
|
/**
|
|
814
|
-
* HTTP
|
|
815
|
-
* Java method: org.openremote.model.
|
|
753
|
+
* HTTP POST /asset
|
|
754
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
816
755
|
*/
|
|
817
|
-
|
|
818
|
-
attributeRefs?: string;
|
|
819
|
-
fromTimestamp?: number;
|
|
820
|
-
toTimestamp?: number;
|
|
821
|
-
}, options?: O): RestResponse<any>;
|
|
756
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
822
757
|
/**
|
|
823
|
-
* HTTP
|
|
824
|
-
* Java method: org.openremote.model.
|
|
758
|
+
* HTTP DELETE /asset
|
|
759
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
825
760
|
*/
|
|
826
|
-
|
|
761
|
+
delete(queryParams?: {
|
|
762
|
+
assetId?: string[];
|
|
763
|
+
}, options?: O): RestResponse<void>;
|
|
764
|
+
/**
|
|
765
|
+
* HTTP PUT /asset/attributes
|
|
766
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
767
|
+
*/
|
|
768
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
769
|
+
/**
|
|
770
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
771
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
772
|
+
*/
|
|
773
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
774
|
+
/**
|
|
775
|
+
* HTTP DELETE /asset/parent
|
|
776
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
777
|
+
*/
|
|
778
|
+
updateNoneParent(queryParams?: {
|
|
779
|
+
assetIds?: string[];
|
|
780
|
+
}, options?: O): RestResponse<void>;
|
|
781
|
+
/**
|
|
782
|
+
* HTTP GET /asset/partial/{assetId}
|
|
783
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
784
|
+
*/
|
|
785
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
786
|
+
/**
|
|
787
|
+
* HTTP POST /asset/query
|
|
788
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
789
|
+
*/
|
|
790
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
791
|
+
/**
|
|
792
|
+
* HTTP GET /asset/user/current
|
|
793
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
794
|
+
*/
|
|
795
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
796
|
+
/**
|
|
797
|
+
* HTTP POST /asset/user/link
|
|
798
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
799
|
+
*/
|
|
800
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
801
|
+
/**
|
|
802
|
+
* HTTP GET /asset/user/link
|
|
803
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
804
|
+
*/
|
|
805
|
+
getUserAssetLinks(queryParams?: {
|
|
806
|
+
realm?: string;
|
|
807
|
+
userId?: string;
|
|
827
808
|
assetId?: string;
|
|
828
|
-
|
|
829
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
809
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
830
810
|
/**
|
|
831
|
-
* HTTP POST /asset/
|
|
832
|
-
* Java method: org.openremote.model.
|
|
811
|
+
* HTTP POST /asset/user/link/delete
|
|
812
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
833
813
|
*/
|
|
834
|
-
|
|
835
|
-
}
|
|
836
|
-
export declare class ConsoleResourceClient<O> {
|
|
837
|
-
protected httpClient: HttpClient<O>;
|
|
838
|
-
constructor(httpClient: HttpClient<O>);
|
|
814
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
839
815
|
/**
|
|
840
|
-
* HTTP
|
|
841
|
-
* Java method: org.openremote.model.
|
|
816
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
817
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
842
818
|
*/
|
|
843
|
-
|
|
819
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
820
|
+
/**
|
|
821
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
822
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
823
|
+
*/
|
|
824
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
825
|
+
/**
|
|
826
|
+
* HTTP GET /asset/{assetId}
|
|
827
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
828
|
+
*/
|
|
829
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
830
|
+
/**
|
|
831
|
+
* HTTP PUT /asset/{assetId}
|
|
832
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
833
|
+
*/
|
|
834
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
835
|
+
/**
|
|
836
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
837
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
838
|
+
*/
|
|
839
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
840
|
+
/**
|
|
841
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
842
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
843
|
+
*/
|
|
844
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
845
|
+
/**
|
|
846
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
847
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
848
|
+
*/
|
|
849
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
850
|
+
assetIds?: string[];
|
|
851
|
+
}, options?: O): RestResponse<void>;
|
|
844
852
|
}
|
|
845
|
-
export declare class
|
|
853
|
+
export declare class SyslogResourceClient<O> {
|
|
846
854
|
protected httpClient: HttpClient<O>;
|
|
847
855
|
constructor(httpClient: HttpClient<O>);
|
|
848
856
|
/**
|
|
849
|
-
* HTTP GET /
|
|
850
|
-
* Java method: org.openremote.model.
|
|
857
|
+
* HTTP GET /syslog/config
|
|
858
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
851
859
|
*/
|
|
852
|
-
|
|
853
|
-
id?: number;
|
|
854
|
-
type?: string;
|
|
855
|
-
from?: number;
|
|
856
|
-
to?: number;
|
|
857
|
-
realmId?: string;
|
|
858
|
-
userId?: string;
|
|
859
|
-
assetId?: string;
|
|
860
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
860
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
861
861
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
862
|
+
* HTTP PUT /syslog/config
|
|
863
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
864
864
|
*/
|
|
865
|
-
|
|
866
|
-
id?: number;
|
|
867
|
-
type?: string;
|
|
868
|
-
from?: number;
|
|
869
|
-
to?: number;
|
|
870
|
-
realmId?: string;
|
|
871
|
-
userId?: string;
|
|
872
|
-
assetId?: string;
|
|
873
|
-
}, options?: O): RestResponse<void>;
|
|
865
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
874
866
|
/**
|
|
875
|
-
* HTTP
|
|
876
|
-
* Java method: org.openremote.model.
|
|
867
|
+
* HTTP DELETE /syslog/event
|
|
868
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
877
869
|
*/
|
|
878
|
-
|
|
870
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
879
871
|
/**
|
|
880
|
-
* HTTP
|
|
881
|
-
* Java method: org.openremote.model.
|
|
872
|
+
* HTTP GET /syslog/event
|
|
873
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
882
874
|
*/
|
|
883
|
-
|
|
875
|
+
getEvents(queryParams?: {
|
|
876
|
+
level?: Model.SyslogLevel;
|
|
877
|
+
per_page?: number;
|
|
878
|
+
page?: number;
|
|
879
|
+
from?: number;
|
|
880
|
+
to?: number;
|
|
881
|
+
category?: Model.SyslogCategory[];
|
|
882
|
+
subCategory?: string[];
|
|
883
|
+
}, options?: O): RestResponse<any>;
|
|
884
|
+
}
|
|
885
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
886
|
+
protected httpClient: HttpClient<O>;
|
|
887
|
+
constructor(httpClient: HttpClient<O>);
|
|
884
888
|
/**
|
|
885
|
-
* HTTP
|
|
886
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
890
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
887
891
|
*/
|
|
888
|
-
|
|
889
|
-
targetId?: string;
|
|
890
|
-
}, options?: O): RestResponse<void>;
|
|
892
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
891
893
|
/**
|
|
892
|
-
* HTTP PUT /
|
|
893
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
895
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
894
896
|
*/
|
|
895
|
-
|
|
896
|
-
targetId?: string;
|
|
897
|
-
}, options?: O): RestResponse<void>;
|
|
897
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
901
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
902
902
|
protected _flowResource: AxiosFlowResourceClient;
|
|
903
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
904
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
905
903
|
protected _statusResource: AxiosStatusResourceClient;
|
|
904
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
905
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
906
906
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
907
|
-
protected
|
|
907
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
908
|
+
protected _appResource: AxiosAppResourceClient;
|
|
909
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
908
910
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
909
911
|
protected _userResource: AxiosUserResourceClient;
|
|
910
|
-
protected
|
|
911
|
-
protected
|
|
912
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
913
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
914
|
-
protected _appResource: AxiosAppResourceClient;
|
|
912
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
913
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
915
914
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
915
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
916
916
|
protected _realmResource: AxiosRealmResourceClient;
|
|
917
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
918
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
919
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
917
920
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
918
|
-
protected
|
|
919
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
920
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
921
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
921
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
923
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
924
924
|
get FlowResource(): AxiosFlowResourceClient;
|
|
925
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
926
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
927
925
|
get StatusResource(): AxiosStatusResourceClient;
|
|
926
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
927
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
928
928
|
get RulesResource(): AxiosRulesResourceClient;
|
|
929
|
-
get
|
|
929
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
930
|
+
get AppResource(): AxiosAppResourceClient;
|
|
931
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
930
932
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
931
933
|
get UserResource(): AxiosUserResourceClient;
|
|
932
|
-
get
|
|
933
|
-
get
|
|
934
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
935
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
936
|
-
get AppResource(): AxiosAppResourceClient;
|
|
934
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
935
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
937
936
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
937
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
938
938
|
get RealmResource(): AxiosRealmResourceClient;
|
|
939
|
+
get MapResource(): AxiosMapResourceClient;
|
|
940
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
941
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
939
942
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
940
|
-
get
|
|
941
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
942
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
943
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
943
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
954
|
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
960
|
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
966
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
996
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|