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