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