hab-rs-api-client 0.3.0

Bindings for openHAB REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374

# \ThingsApi

All URIs are relative to */rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_thing_in_registry**](ThingsApi.md#create_thing_in_registry) | **POST** /things | Creates a new thing and adds it to the registry.
[**enable_thing**](ThingsApi.md#enable_thing) | **PUT** /things/{thingUID}/enable | Sets the thing enabled status.
[**get_available_firmwares_for_thing**](ThingsApi.md#get_available_firmwares_for_thing) | **GET** /things/{thingUID}/firmwares | Get all available firmwares for provided thing UID
[**get_thing_by_id**](ThingsApi.md#get_thing_by_id) | **GET** /things/{thingUID} | Gets thing by UID.
[**get_thing_config_status**](ThingsApi.md#get_thing_config_status) | **GET** /things/{thingUID}/config/status | Gets thing config status.
[**get_thing_firmware_status**](ThingsApi.md#get_thing_firmware_status) | **GET** /things/{thingUID}/firmware/status | Gets thing's firmware status.
[**get_thing_status**](ThingsApi.md#get_thing_status) | **GET** /things/{thingUID}/status | Gets thing status.
[**get_things**](ThingsApi.md#get_things) | **GET** /things | Get all available things.
[**remove_thing_by_id**](ThingsApi.md#remove_thing_by_id) | **DELETE** /things/{thingUID} | Removes a thing from the registry. Set 'force' to __true__ if you want the thing to be removed immediately.
[**update_thing**](ThingsApi.md#update_thing) | **PUT** /things/{thingUID} | Updates a thing.
[**update_thing_config**](ThingsApi.md#update_thing_config) | **PUT** /things/{thingUID}/config | Updates thing's configuration.
[**update_thing_firmware**](ThingsApi.md#update_thing_firmware) | **PUT** /things/{thingUID}/firmware/{firmwareVersion} | Update thing firmware.



## create_thing_in_registry

> models::EnrichedThingDto create_thing_in_registry(thing_dto, accept_language)
Creates a new thing and adds it to the registry.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_dto** | [**ThingDto**](ThingDto.md) | thing data | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**models::EnrichedThingDto**](EnrichedThingDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## enable_thing

> models::EnrichedThingDto enable_thing(thing_uid, accept_language, body)
Sets the thing enabled status.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thing | [required] |
**accept_language** | Option<**String**> | language |  |
**body** | Option<**String**> | enabled |  |

### Return type

[**models::EnrichedThingDto**](EnrichedThingDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: text/plain
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_available_firmwares_for_thing

> Vec<models::FirmwareDto> get_available_firmwares_for_thing(thing_uid, accept_language)
Get all available firmwares for provided thing UID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thingUID | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<models::FirmwareDto>**](FirmwareDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_thing_by_id

> models::EnrichedThingDto get_thing_by_id(thing_uid, accept_language)
Gets thing by UID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thingUID | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**models::EnrichedThingDto**](EnrichedThingDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_thing_config_status

> Vec<models::ConfigStatusMessage> get_thing_config_status(thing_uid, accept_language)
Gets thing config status.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thing | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<models::ConfigStatusMessage>**](ConfigStatusMessage.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_thing_firmware_status

> models::FirmwareStatusDto get_thing_firmware_status(thing_uid, accept_language)
Gets thing's firmware status.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thing | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**models::FirmwareStatusDto**](FirmwareStatusDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_thing_status

> models::ThingStatusInfo get_thing_status(thing_uid, accept_language)
Gets thing status.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thing | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**models::ThingStatusInfo**](ThingStatusInfo.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_things

> Vec<models::EnrichedThingDto> get_things(accept_language, summary, static_data_only)
Get all available things.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |
**summary** | Option<**bool**> | summary fields only |  |
**static_data_only** | Option<**bool**> | provides a cacheable list of values not expected to change regularly and checks the If-Modified-Since header |  |[default to false]

### Return type

[**Vec<models::EnrichedThingDto>**](EnrichedThingDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_thing_by_id

> remove_thing_by_id(thing_uid, accept_language, force)
Removes a thing from the registry. Set 'force' to __true__ if you want the thing to be removed immediately.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thingUID | [required] |
**accept_language** | Option<**String**> | language |  |
**force** | Option<**bool**> | force |  |[default to false]

### Return type

 (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_thing

> models::EnrichedThingDto update_thing(thing_uid, thing_dto, accept_language)
Updates a thing.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thingUID | [required] |
**thing_dto** | [**ThingDto**](ThingDto.md) | thing | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**models::EnrichedThingDto**](EnrichedThingDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_thing_config

> models::EnrichedThingDto update_thing_config(thing_uid, accept_language, request_body)
Updates thing's configuration.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thing | [required] |
**accept_language** | Option<**String**> | language |  |
**request_body** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | configuration parameters |  |

### Return type

[**models::EnrichedThingDto**](EnrichedThingDTO.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_thing_firmware

> update_thing_firmware(thing_uid, firmware_version, accept_language)
Update thing firmware.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**thing_uid** | **String** | thing | [required] |
**firmware_version** | **String** | version | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

 (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)