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