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