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