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