@openremote/rest 1.4.0-snapshot.20250319131926 → 1.4.0-snapshot.20250319161437
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.js +1 -1
- package/lib/restclient.d.ts +428 -428
- 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,69 +9,49 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class MapResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /map
|
|
17
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getSettings(options?: O): RestResponse<{
|
|
20
|
+
[id: string]: unknown;
|
|
21
|
+
}>;
|
|
20
22
|
/**
|
|
21
|
-
* HTTP
|
|
22
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP PUT /map
|
|
24
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
23
25
|
*/
|
|
24
|
-
|
|
26
|
+
saveSettings(mapConfig: {
|
|
27
|
+
[index: string]: Model.MapRealmConfig;
|
|
28
|
+
}, options?: O): RestResponse<any>;
|
|
25
29
|
/**
|
|
26
|
-
* HTTP GET /
|
|
27
|
-
* Java method: org.openremote.model.
|
|
30
|
+
* HTTP GET /map/js
|
|
31
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
28
32
|
*/
|
|
29
|
-
|
|
33
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
34
|
+
[id: string]: unknown;
|
|
35
|
+
}>;
|
|
36
|
+
/**
|
|
37
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
38
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
39
|
+
*/
|
|
40
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
30
41
|
}
|
|
31
|
-
export declare class
|
|
42
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
32
43
|
protected httpClient: HttpClient<O>;
|
|
33
44
|
constructor(httpClient: HttpClient<O>);
|
|
34
45
|
/**
|
|
35
|
-
* HTTP
|
|
36
|
-
* Java method: org.openremote.model.
|
|
37
|
-
*/
|
|
38
|
-
getAssetDescriptors(queryParams?: {
|
|
39
|
-
parentId?: string;
|
|
40
|
-
parentType?: string;
|
|
41
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
42
|
-
/**
|
|
43
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
44
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
45
|
-
*/
|
|
46
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
47
|
-
parentId?: string;
|
|
48
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
49
|
-
/**
|
|
50
|
-
* HTTP GET /model/assetInfos
|
|
51
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
52
|
-
*/
|
|
53
|
-
getAssetInfos(queryParams?: {
|
|
54
|
-
parentId?: string;
|
|
55
|
-
parentType?: string;
|
|
56
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
57
|
-
/**
|
|
58
|
-
* HTTP GET /model/metaItemDescriptors
|
|
59
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
46
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
47
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
60
48
|
*/
|
|
61
|
-
|
|
62
|
-
parentId?: string;
|
|
63
|
-
}, options?: O): RestResponse<{
|
|
64
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
65
|
-
}>;
|
|
49
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
66
50
|
/**
|
|
67
|
-
* HTTP
|
|
68
|
-
* Java method: org.openremote.model.
|
|
51
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
52
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
69
53
|
*/
|
|
70
|
-
|
|
71
|
-
parentId?: string;
|
|
72
|
-
}, options?: O): RestResponse<{
|
|
73
|
-
[index: string]: Model.ValueDescriptor;
|
|
74
|
-
}>;
|
|
54
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
75
55
|
}
|
|
76
56
|
export declare class ConfigurationResourceClient<O> {
|
|
77
57
|
protected httpClient: HttpClient<O>;
|
|
@@ -99,36 +79,6 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
99
79
|
*/
|
|
100
80
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
101
81
|
}
|
|
102
|
-
export declare class MapResourceClient<O> {
|
|
103
|
-
protected httpClient: HttpClient<O>;
|
|
104
|
-
constructor(httpClient: HttpClient<O>);
|
|
105
|
-
/**
|
|
106
|
-
* HTTP GET /map
|
|
107
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
108
|
-
*/
|
|
109
|
-
getSettings(options?: O): RestResponse<{
|
|
110
|
-
[id: string]: unknown;
|
|
111
|
-
}>;
|
|
112
|
-
/**
|
|
113
|
-
* HTTP PUT /map
|
|
114
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
115
|
-
*/
|
|
116
|
-
saveSettings(mapConfig: {
|
|
117
|
-
[index: string]: Model.MapRealmConfig;
|
|
118
|
-
}, options?: O): RestResponse<any>;
|
|
119
|
-
/**
|
|
120
|
-
* HTTP GET /map/js
|
|
121
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
122
|
-
*/
|
|
123
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
124
|
-
[id: string]: unknown;
|
|
125
|
-
}>;
|
|
126
|
-
/**
|
|
127
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
128
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
129
|
-
*/
|
|
130
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
131
|
-
}
|
|
132
82
|
export declare class GatewayServiceResourceClient<O> {
|
|
133
83
|
protected httpClient: HttpClient<O>;
|
|
134
84
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -158,136 +108,57 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
158
108
|
*/
|
|
159
109
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
160
110
|
}
|
|
161
|
-
export declare class
|
|
111
|
+
export declare class AgentResourceClient<O> {
|
|
162
112
|
protected httpClient: HttpClient<O>;
|
|
163
113
|
constructor(httpClient: HttpClient<O>);
|
|
164
114
|
/**
|
|
165
|
-
* HTTP
|
|
166
|
-
* Java method: org.openremote.model.
|
|
115
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
116
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
167
117
|
*/
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
protected httpClient: HttpClient<O>;
|
|
172
|
-
constructor(httpClient: HttpClient<O>);
|
|
118
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
119
|
+
realm?: string;
|
|
120
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
173
121
|
/**
|
|
174
|
-
* HTTP
|
|
175
|
-
* Java method: org.openremote.model.
|
|
122
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
123
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
176
124
|
*/
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
}>;
|
|
125
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
126
|
+
realm?: string;
|
|
127
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
180
128
|
/**
|
|
181
|
-
* HTTP GET /
|
|
182
|
-
* Java method: org.openremote.model.
|
|
129
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
130
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
183
131
|
*/
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
132
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
133
|
+
parentId?: string;
|
|
134
|
+
realm?: string;
|
|
135
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
187
136
|
}
|
|
188
|
-
export declare class
|
|
137
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
189
138
|
protected httpClient: HttpClient<O>;
|
|
190
139
|
constructor(httpClient: HttpClient<O>);
|
|
191
140
|
/**
|
|
192
|
-
* HTTP
|
|
193
|
-
* Java method: org.openremote.model.
|
|
194
|
-
*/
|
|
195
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
196
|
-
/**
|
|
197
|
-
* HTTP DELETE /asset
|
|
198
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
199
|
-
*/
|
|
200
|
-
delete(queryParams?: {
|
|
201
|
-
assetId?: string[];
|
|
202
|
-
}, options?: O): RestResponse<void>;
|
|
203
|
-
/**
|
|
204
|
-
* HTTP PUT /asset/attributes
|
|
205
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
206
|
-
*/
|
|
207
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
208
|
-
/**
|
|
209
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
210
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
211
|
-
*/
|
|
212
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
213
|
-
/**
|
|
214
|
-
* HTTP DELETE /asset/parent
|
|
215
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
216
|
-
*/
|
|
217
|
-
updateNoneParent(queryParams?: {
|
|
218
|
-
assetIds?: string[];
|
|
219
|
-
}, options?: O): RestResponse<void>;
|
|
220
|
-
/**
|
|
221
|
-
* HTTP GET /asset/partial/{assetId}
|
|
222
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
223
|
-
*/
|
|
224
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
225
|
-
/**
|
|
226
|
-
* HTTP POST /asset/query
|
|
227
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
228
|
-
*/
|
|
229
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
230
|
-
/**
|
|
231
|
-
* HTTP GET /asset/user/current
|
|
232
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
233
|
-
*/
|
|
234
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
235
|
-
/**
|
|
236
|
-
* HTTP POST /asset/user/link
|
|
237
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
141
|
+
* HTTP GET /asset/datapoint/export
|
|
142
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
238
143
|
*/
|
|
239
|
-
|
|
144
|
+
getDatapointExport(queryParams?: {
|
|
145
|
+
attributeRefs?: string;
|
|
146
|
+
fromTimestamp?: number;
|
|
147
|
+
toTimestamp?: number;
|
|
148
|
+
}, options?: O): RestResponse<any>;
|
|
240
149
|
/**
|
|
241
|
-
* HTTP GET /asset/
|
|
242
|
-
* Java method: org.openremote.model.
|
|
150
|
+
* HTTP GET /asset/datapoint/periods
|
|
151
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
243
152
|
*/
|
|
244
|
-
|
|
245
|
-
realm?: string;
|
|
246
|
-
userId?: string;
|
|
153
|
+
getDatapointPeriod(queryParams?: {
|
|
247
154
|
assetId?: string;
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
* HTTP POST /asset/user/link/delete
|
|
251
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
252
|
-
*/
|
|
253
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
254
|
-
/**
|
|
255
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
256
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
257
|
-
*/
|
|
258
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
259
|
-
/**
|
|
260
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
261
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
262
|
-
*/
|
|
263
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
264
|
-
/**
|
|
265
|
-
* HTTP GET /asset/{assetId}
|
|
266
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
267
|
-
*/
|
|
268
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
269
|
-
/**
|
|
270
|
-
* HTTP PUT /asset/{assetId}
|
|
271
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
272
|
-
*/
|
|
273
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
274
|
-
/**
|
|
275
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
276
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
277
|
-
*/
|
|
278
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
279
|
-
/**
|
|
280
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
281
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
282
|
-
*/
|
|
283
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
155
|
+
attributeName?: string;
|
|
156
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
284
157
|
/**
|
|
285
|
-
* HTTP
|
|
286
|
-
* Java method: org.openremote.model.
|
|
158
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
159
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
287
160
|
*/
|
|
288
|
-
|
|
289
|
-
assetIds?: string[];
|
|
290
|
-
}, options?: O): RestResponse<void>;
|
|
161
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
291
162
|
}
|
|
292
163
|
export declare class GatewayClientResourceClient<O> {
|
|
293
164
|
protected httpClient: HttpClient<O>;
|
|
@@ -325,13 +196,41 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
325
196
|
*/
|
|
326
197
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
327
198
|
}
|
|
328
|
-
export declare class
|
|
199
|
+
export declare class FlowResourceClient<O> {
|
|
329
200
|
protected httpClient: HttpClient<O>;
|
|
330
201
|
constructor(httpClient: HttpClient<O>);
|
|
331
202
|
/**
|
|
332
|
-
* HTTP
|
|
333
|
-
* Java method: org.openremote.model.rules.
|
|
334
|
-
*/
|
|
203
|
+
* HTTP GET /flow
|
|
204
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
205
|
+
*/
|
|
206
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
207
|
+
/**
|
|
208
|
+
* HTTP GET /flow/{name}
|
|
209
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
210
|
+
*/
|
|
211
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
212
|
+
/**
|
|
213
|
+
* HTTP GET /flow/{type}
|
|
214
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
215
|
+
*/
|
|
216
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
217
|
+
}
|
|
218
|
+
export declare class ConsoleResourceClient<O> {
|
|
219
|
+
protected httpClient: HttpClient<O>;
|
|
220
|
+
constructor(httpClient: HttpClient<O>);
|
|
221
|
+
/**
|
|
222
|
+
* HTTP POST /console/register
|
|
223
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
224
|
+
*/
|
|
225
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
226
|
+
}
|
|
227
|
+
export declare class RulesResourceClient<O> {
|
|
228
|
+
protected httpClient: HttpClient<O>;
|
|
229
|
+
constructor(httpClient: HttpClient<O>);
|
|
230
|
+
/**
|
|
231
|
+
* HTTP POST /rules
|
|
232
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
233
|
+
*/
|
|
335
234
|
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
336
235
|
/**
|
|
337
236
|
* HTTP GET /rules
|
|
@@ -433,96 +332,162 @@ export declare class RulesResourceClient<O> {
|
|
|
433
332
|
*/
|
|
434
333
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
435
334
|
}
|
|
436
|
-
export declare class
|
|
335
|
+
export declare class AppResourceClient<O> {
|
|
437
336
|
protected httpClient: HttpClient<O>;
|
|
438
337
|
constructor(httpClient: HttpClient<O>);
|
|
439
338
|
/**
|
|
440
|
-
* HTTP
|
|
441
|
-
* Java method: org.openremote.model.
|
|
339
|
+
* HTTP GET /apps
|
|
340
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
442
341
|
*/
|
|
443
|
-
|
|
444
|
-
assetIds?: string[];
|
|
445
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
342
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
446
343
|
/**
|
|
447
|
-
* HTTP GET /
|
|
448
|
-
* Java method: org.openremote.model.
|
|
344
|
+
* HTTP GET /apps/consoleConfig
|
|
345
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
449
346
|
*/
|
|
450
|
-
|
|
451
|
-
realm?: string;
|
|
452
|
-
status?: Model.AlarmStatus;
|
|
453
|
-
assetId?: string;
|
|
454
|
-
assigneeId?: string;
|
|
455
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
347
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
456
348
|
/**
|
|
457
|
-
* HTTP
|
|
458
|
-
* Java method: org.openremote.model.
|
|
349
|
+
* HTTP GET /apps/info
|
|
350
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
459
351
|
*/
|
|
460
|
-
|
|
352
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
353
|
+
}
|
|
354
|
+
export declare class RealmResourceClient<O> {
|
|
355
|
+
protected httpClient: HttpClient<O>;
|
|
356
|
+
constructor(httpClient: HttpClient<O>);
|
|
461
357
|
/**
|
|
462
|
-
* HTTP
|
|
463
|
-
* Java method: org.openremote.model.
|
|
358
|
+
* HTTP POST /realm
|
|
359
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
464
360
|
*/
|
|
465
|
-
|
|
361
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
466
362
|
/**
|
|
467
|
-
* HTTP GET /
|
|
468
|
-
* Java method: org.openremote.model.
|
|
363
|
+
* HTTP GET /realm
|
|
364
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
469
365
|
*/
|
|
470
|
-
|
|
366
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
471
367
|
/**
|
|
472
|
-
* HTTP
|
|
473
|
-
* Java method: org.openremote.model.
|
|
368
|
+
* HTTP GET /realm/accessible
|
|
369
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
474
370
|
*/
|
|
475
|
-
|
|
371
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
476
372
|
/**
|
|
477
|
-
* HTTP
|
|
478
|
-
* Java method: org.openremote.model.
|
|
373
|
+
* HTTP DELETE /realm/{name}
|
|
374
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
479
375
|
*/
|
|
480
|
-
|
|
376
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
481
377
|
/**
|
|
482
|
-
* HTTP GET /
|
|
483
|
-
* Java method: org.openremote.model.
|
|
378
|
+
* HTTP GET /realm/{name}
|
|
379
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
484
380
|
*/
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
381
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
382
|
+
/**
|
|
383
|
+
* HTTP PUT /realm/{name}
|
|
384
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
385
|
+
*/
|
|
386
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
488
387
|
}
|
|
489
|
-
export declare class
|
|
388
|
+
export declare class StatusResourceClient<O> {
|
|
490
389
|
protected httpClient: HttpClient<O>;
|
|
491
390
|
constructor(httpClient: HttpClient<O>);
|
|
492
391
|
/**
|
|
493
|
-
* HTTP
|
|
494
|
-
* Java method: org.openremote.model.
|
|
392
|
+
* HTTP GET /health
|
|
393
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
495
394
|
*/
|
|
496
|
-
|
|
395
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
396
|
+
[index: string]: any;
|
|
397
|
+
}>;
|
|
497
398
|
/**
|
|
498
|
-
* HTTP GET /
|
|
499
|
-
* Java method: org.openremote.model.
|
|
399
|
+
* HTTP GET /info
|
|
400
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
500
401
|
*/
|
|
501
|
-
|
|
402
|
+
getInfo(options?: O): RestResponse<{
|
|
403
|
+
[index: string]: any;
|
|
404
|
+
}>;
|
|
405
|
+
}
|
|
406
|
+
export declare class NotificationResourceClient<O> {
|
|
407
|
+
protected httpClient: HttpClient<O>;
|
|
408
|
+
constructor(httpClient: HttpClient<O>);
|
|
502
409
|
/**
|
|
503
|
-
* HTTP
|
|
504
|
-
* Java method: org.openremote.model.
|
|
410
|
+
* HTTP GET /notification
|
|
411
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
505
412
|
*/
|
|
506
|
-
|
|
413
|
+
getNotifications(queryParams?: {
|
|
414
|
+
id?: number;
|
|
415
|
+
type?: string;
|
|
416
|
+
from?: number;
|
|
417
|
+
to?: number;
|
|
418
|
+
realmId?: string;
|
|
419
|
+
userId?: string;
|
|
420
|
+
assetId?: string;
|
|
421
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
507
422
|
/**
|
|
508
|
-
* HTTP
|
|
509
|
-
* Java method: org.openremote.model.
|
|
423
|
+
* HTTP DELETE /notification
|
|
424
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
510
425
|
*/
|
|
511
|
-
|
|
426
|
+
removeNotifications(queryParams?: {
|
|
427
|
+
id?: number;
|
|
428
|
+
type?: string;
|
|
429
|
+
from?: number;
|
|
430
|
+
to?: number;
|
|
431
|
+
realmId?: string;
|
|
432
|
+
userId?: string;
|
|
433
|
+
assetId?: string;
|
|
434
|
+
}, options?: O): RestResponse<void>;
|
|
435
|
+
/**
|
|
436
|
+
* HTTP POST /notification/alert
|
|
437
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
438
|
+
*/
|
|
439
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
440
|
+
/**
|
|
441
|
+
* HTTP DELETE /notification/{notificationId}
|
|
442
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
443
|
+
*/
|
|
444
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
445
|
+
/**
|
|
446
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
447
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
448
|
+
*/
|
|
449
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
450
|
+
targetId?: string;
|
|
451
|
+
}, options?: O): RestResponse<void>;
|
|
452
|
+
/**
|
|
453
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
454
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
455
|
+
*/
|
|
456
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
457
|
+
targetId?: string;
|
|
458
|
+
}, options?: O): RestResponse<void>;
|
|
512
459
|
}
|
|
513
|
-
export declare class
|
|
460
|
+
export declare class SyslogResourceClient<O> {
|
|
514
461
|
protected httpClient: HttpClient<O>;
|
|
515
462
|
constructor(httpClient: HttpClient<O>);
|
|
516
463
|
/**
|
|
517
|
-
* HTTP
|
|
518
|
-
* Java method: org.openremote.model.
|
|
464
|
+
* HTTP GET /syslog/config
|
|
465
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
519
466
|
*/
|
|
520
|
-
|
|
467
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
521
468
|
/**
|
|
522
|
-
* HTTP PUT /
|
|
523
|
-
* Java method: org.openremote.model.
|
|
469
|
+
* HTTP PUT /syslog/config
|
|
470
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
524
471
|
*/
|
|
525
|
-
|
|
472
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
473
|
+
/**
|
|
474
|
+
* HTTP DELETE /syslog/event
|
|
475
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
476
|
+
*/
|
|
477
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
478
|
+
/**
|
|
479
|
+
* HTTP GET /syslog/event
|
|
480
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
481
|
+
*/
|
|
482
|
+
getEvents(queryParams?: {
|
|
483
|
+
level?: Model.SyslogLevel;
|
|
484
|
+
per_page?: number;
|
|
485
|
+
page?: number;
|
|
486
|
+
from?: number;
|
|
487
|
+
to?: number;
|
|
488
|
+
category?: Model.SyslogCategory[];
|
|
489
|
+
subCategory?: string[];
|
|
490
|
+
}, options?: O): RestResponse<any>;
|
|
526
491
|
}
|
|
527
492
|
export declare class DashboardResourceClient<O> {
|
|
528
493
|
protected httpClient: HttpClient<O>;
|
|
@@ -558,142 +523,133 @@ export declare class DashboardResourceClient<O> {
|
|
|
558
523
|
*/
|
|
559
524
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
560
525
|
}
|
|
561
|
-
export declare class
|
|
526
|
+
export declare class AssetResourceClient<O> {
|
|
562
527
|
protected httpClient: HttpClient<O>;
|
|
563
528
|
constructor(httpClient: HttpClient<O>);
|
|
564
529
|
/**
|
|
565
|
-
* HTTP
|
|
566
|
-
* Java method: org.openremote.model.
|
|
530
|
+
* HTTP POST /asset
|
|
531
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
567
532
|
*/
|
|
568
|
-
|
|
533
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
569
534
|
/**
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
535
|
+
* HTTP DELETE /asset
|
|
536
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
572
537
|
*/
|
|
573
|
-
|
|
538
|
+
delete(queryParams?: {
|
|
539
|
+
assetId?: string[];
|
|
540
|
+
}, options?: O): RestResponse<void>;
|
|
574
541
|
/**
|
|
575
|
-
* HTTP
|
|
576
|
-
* Java method: org.openremote.model.
|
|
542
|
+
* HTTP PUT /asset/attributes
|
|
543
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
577
544
|
*/
|
|
578
|
-
|
|
545
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
579
546
|
/**
|
|
580
|
-
* HTTP
|
|
581
|
-
* Java method: org.openremote.model.
|
|
547
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
548
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
582
549
|
*/
|
|
583
|
-
|
|
584
|
-
level?: Model.SyslogLevel;
|
|
585
|
-
per_page?: number;
|
|
586
|
-
page?: number;
|
|
587
|
-
from?: number;
|
|
588
|
-
to?: number;
|
|
589
|
-
category?: Model.SyslogCategory[];
|
|
590
|
-
subCategory?: string[];
|
|
591
|
-
}, options?: O): RestResponse<any>;
|
|
592
|
-
}
|
|
593
|
-
export declare class AgentResourceClient<O> {
|
|
594
|
-
protected httpClient: HttpClient<O>;
|
|
595
|
-
constructor(httpClient: HttpClient<O>);
|
|
550
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
596
551
|
/**
|
|
597
|
-
* HTTP
|
|
598
|
-
* Java method: org.openremote.model.asset.
|
|
552
|
+
* HTTP DELETE /asset/parent
|
|
553
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
599
554
|
*/
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
}, options?: O): RestResponse<
|
|
555
|
+
updateNoneParent(queryParams?: {
|
|
556
|
+
assetIds?: string[];
|
|
557
|
+
}, options?: O): RestResponse<void>;
|
|
603
558
|
/**
|
|
604
|
-
* HTTP
|
|
605
|
-
* Java method: org.openremote.model.asset.
|
|
559
|
+
* HTTP GET /asset/partial/{assetId}
|
|
560
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
606
561
|
*/
|
|
607
|
-
|
|
608
|
-
realm?: string;
|
|
609
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
562
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
610
563
|
/**
|
|
611
|
-
* HTTP
|
|
612
|
-
* Java method: org.openremote.model.asset.
|
|
564
|
+
* HTTP POST /asset/query
|
|
565
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
613
566
|
*/
|
|
614
|
-
|
|
615
|
-
parentId?: string;
|
|
616
|
-
realm?: string;
|
|
617
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
618
|
-
}
|
|
619
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
620
|
-
protected httpClient: HttpClient<O>;
|
|
621
|
-
constructor(httpClient: HttpClient<O>);
|
|
567
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
622
568
|
/**
|
|
623
|
-
* HTTP GET /asset/
|
|
624
|
-
* Java method: org.openremote.model.
|
|
569
|
+
* HTTP GET /asset/user/current
|
|
570
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
625
571
|
*/
|
|
626
|
-
|
|
627
|
-
attributeRefs?: string;
|
|
628
|
-
fromTimestamp?: number;
|
|
629
|
-
toTimestamp?: number;
|
|
630
|
-
}, options?: O): RestResponse<any>;
|
|
572
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
631
573
|
/**
|
|
632
|
-
* HTTP
|
|
633
|
-
* Java method: org.openremote.model.
|
|
574
|
+
* HTTP POST /asset/user/link
|
|
575
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
634
576
|
*/
|
|
635
|
-
|
|
577
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
578
|
+
/**
|
|
579
|
+
* HTTP GET /asset/user/link
|
|
580
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
581
|
+
*/
|
|
582
|
+
getUserAssetLinks(queryParams?: {
|
|
583
|
+
realm?: string;
|
|
584
|
+
userId?: string;
|
|
636
585
|
assetId?: string;
|
|
637
|
-
|
|
638
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
586
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
639
587
|
/**
|
|
640
|
-
* HTTP POST /asset/
|
|
641
|
-
* Java method: org.openremote.model.
|
|
588
|
+
* HTTP POST /asset/user/link/delete
|
|
589
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
642
590
|
*/
|
|
643
|
-
|
|
644
|
-
}
|
|
645
|
-
export declare class AppResourceClient<O> {
|
|
646
|
-
protected httpClient: HttpClient<O>;
|
|
647
|
-
constructor(httpClient: HttpClient<O>);
|
|
591
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
648
592
|
/**
|
|
649
|
-
* HTTP
|
|
650
|
-
* Java method: org.openremote.model.
|
|
593
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
594
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
651
595
|
*/
|
|
652
|
-
|
|
596
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
653
597
|
/**
|
|
654
|
-
* HTTP
|
|
655
|
-
* Java method: org.openremote.model.
|
|
598
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
599
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
656
600
|
*/
|
|
657
|
-
|
|
601
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
602
|
+
/**
|
|
603
|
+
* HTTP GET /asset/{assetId}
|
|
604
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
605
|
+
*/
|
|
606
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
607
|
+
/**
|
|
608
|
+
* HTTP PUT /asset/{assetId}
|
|
609
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
610
|
+
*/
|
|
611
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
612
|
+
/**
|
|
613
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
614
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
615
|
+
*/
|
|
616
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
617
|
+
/**
|
|
618
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
619
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
620
|
+
*/
|
|
621
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
658
622
|
/**
|
|
659
|
-
* HTTP
|
|
660
|
-
* Java method: org.openremote.model.
|
|
623
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
624
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
661
625
|
*/
|
|
662
|
-
|
|
626
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
627
|
+
assetIds?: string[];
|
|
628
|
+
}, options?: O): RestResponse<void>;
|
|
663
629
|
}
|
|
664
|
-
export declare class
|
|
630
|
+
export declare class ProvisioningResourceClient<O> {
|
|
665
631
|
protected httpClient: HttpClient<O>;
|
|
666
632
|
constructor(httpClient: HttpClient<O>);
|
|
667
633
|
/**
|
|
668
|
-
* HTTP POST /
|
|
669
|
-
* Java method: org.openremote.model.
|
|
670
|
-
*/
|
|
671
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
672
|
-
/**
|
|
673
|
-
* HTTP GET /realm
|
|
674
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
675
|
-
*/
|
|
676
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
677
|
-
/**
|
|
678
|
-
* HTTP GET /realm/accessible
|
|
679
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
634
|
+
* HTTP POST /provisioning
|
|
635
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
680
636
|
*/
|
|
681
|
-
|
|
637
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
682
638
|
/**
|
|
683
|
-
* HTTP
|
|
684
|
-
* Java method: org.openremote.model.
|
|
639
|
+
* HTTP GET /provisioning
|
|
640
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
685
641
|
*/
|
|
686
|
-
|
|
642
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
687
643
|
/**
|
|
688
|
-
* HTTP
|
|
689
|
-
* Java method: org.openremote.model.
|
|
644
|
+
* HTTP DELETE /provisioning/{id}
|
|
645
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
690
646
|
*/
|
|
691
|
-
|
|
647
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
692
648
|
/**
|
|
693
|
-
* HTTP PUT /
|
|
694
|
-
* Java method: org.openremote.model.
|
|
649
|
+
* HTTP PUT /provisioning/{id}
|
|
650
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
695
651
|
*/
|
|
696
|
-
|
|
652
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
697
653
|
}
|
|
698
654
|
export declare class UserResourceClient<O> {
|
|
699
655
|
protected httpClient: HttpClient<O>;
|
|
@@ -819,105 +775,149 @@ export declare class UserResourceClient<O> {
|
|
|
819
775
|
*/
|
|
820
776
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
821
777
|
}
|
|
822
|
-
export declare class
|
|
778
|
+
export declare class AssetModelResourceClient<O> {
|
|
823
779
|
protected httpClient: HttpClient<O>;
|
|
824
780
|
constructor(httpClient: HttpClient<O>);
|
|
825
781
|
/**
|
|
826
|
-
* HTTP GET /
|
|
827
|
-
* Java method: org.openremote.model.
|
|
782
|
+
* HTTP GET /model/assetDescriptors
|
|
783
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
828
784
|
*/
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
to?: number;
|
|
834
|
-
realmId?: string;
|
|
835
|
-
userId?: string;
|
|
836
|
-
assetId?: string;
|
|
837
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
785
|
+
getAssetDescriptors(queryParams?: {
|
|
786
|
+
parentId?: string;
|
|
787
|
+
parentType?: string;
|
|
788
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
838
789
|
/**
|
|
839
|
-
* HTTP
|
|
840
|
-
* Java method: org.openremote.model.
|
|
790
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
791
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
841
792
|
*/
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
793
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
794
|
+
parentId?: string;
|
|
795
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
796
|
+
/**
|
|
797
|
+
* HTTP GET /model/assetInfos
|
|
798
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
799
|
+
*/
|
|
800
|
+
getAssetInfos(queryParams?: {
|
|
801
|
+
parentId?: string;
|
|
802
|
+
parentType?: string;
|
|
803
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
804
|
+
/**
|
|
805
|
+
* HTTP GET /model/metaItemDescriptors
|
|
806
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
807
|
+
*/
|
|
808
|
+
getMetaItemDescriptors(queryParams?: {
|
|
809
|
+
parentId?: string;
|
|
810
|
+
}, options?: O): RestResponse<{
|
|
811
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
812
|
+
}>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP GET /model/valueDescriptors
|
|
815
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
816
|
+
*/
|
|
817
|
+
getValueDescriptors(queryParams?: {
|
|
818
|
+
parentId?: string;
|
|
819
|
+
}, options?: O): RestResponse<{
|
|
820
|
+
[index: string]: Model.ValueDescriptor;
|
|
821
|
+
}>;
|
|
822
|
+
}
|
|
823
|
+
export declare class AlarmResourceClient<O> {
|
|
824
|
+
protected httpClient: HttpClient<O>;
|
|
825
|
+
constructor(httpClient: HttpClient<O>);
|
|
826
|
+
/**
|
|
827
|
+
* HTTP POST /alarm
|
|
828
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
829
|
+
*/
|
|
830
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
831
|
+
assetIds?: string[];
|
|
832
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
833
|
+
/**
|
|
834
|
+
* HTTP GET /alarm
|
|
835
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
836
|
+
*/
|
|
837
|
+
getAlarms(queryParams?: {
|
|
838
|
+
realm?: string;
|
|
839
|
+
status?: Model.AlarmStatus;
|
|
849
840
|
assetId?: string;
|
|
850
|
-
|
|
841
|
+
assigneeId?: string;
|
|
842
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
851
843
|
/**
|
|
852
|
-
* HTTP
|
|
853
|
-
* Java method: org.openremote.model.
|
|
844
|
+
* HTTP DELETE /alarm
|
|
845
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
854
846
|
*/
|
|
855
|
-
|
|
847
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
856
848
|
/**
|
|
857
|
-
* HTTP
|
|
858
|
-
* Java method: org.openremote.model.
|
|
849
|
+
* HTTP PUT /alarm/assets
|
|
850
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
859
851
|
*/
|
|
860
|
-
|
|
852
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
861
853
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP GET /alarm/{alarmId}
|
|
855
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
864
856
|
*/
|
|
865
|
-
|
|
866
|
-
targetId?: string;
|
|
867
|
-
}, options?: O): RestResponse<void>;
|
|
857
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
868
858
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
860
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
871
861
|
*/
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
862
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
863
|
+
/**
|
|
864
|
+
* HTTP PUT /alarm/{alarmId}
|
|
865
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
866
|
+
*/
|
|
867
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
868
|
+
/**
|
|
869
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
870
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
871
|
+
*/
|
|
872
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
873
|
+
realm?: string;
|
|
874
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
879
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
880
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
881
878
|
protected _mapResource: AxiosMapResourceClient;
|
|
882
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
883
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
884
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
885
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
886
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
887
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
888
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
889
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
890
879
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
891
|
-
protected
|
|
892
|
-
protected
|
|
880
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
881
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
893
882
|
protected _agentResource: AxiosAgentResourceClient;
|
|
894
883
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
884
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
885
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
886
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
887
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
895
888
|
protected _appResource: AxiosAppResourceClient;
|
|
896
889
|
protected _realmResource: AxiosRealmResourceClient;
|
|
897
|
-
protected
|
|
890
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
898
891
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
893
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
894
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
895
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
896
|
+
protected _userResource: AxiosUserResourceClient;
|
|
897
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
898
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
901
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
902
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
903
900
|
get MapResource(): AxiosMapResourceClient;
|
|
904
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
905
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
906
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
907
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
908
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
909
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
910
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
911
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
912
901
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
913
|
-
get
|
|
914
|
-
get
|
|
902
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
903
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
915
904
|
get AgentResource(): AxiosAgentResourceClient;
|
|
916
905
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
906
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
907
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
908
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
909
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
917
910
|
get AppResource(): AxiosAppResourceClient;
|
|
918
911
|
get RealmResource(): AxiosRealmResourceClient;
|
|
919
|
-
get
|
|
912
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
920
913
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
915
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
916
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
917
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
918
|
+
get UserResource(): AxiosUserResourceClient;
|
|
919
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
920
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
934
|
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
955
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
970
|
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|