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