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