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