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