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

# \AddonsApi

All URIs are relative to */rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_addon_by_id**](AddonsApi.md#get_addon_by_id) | **GET** /addons/{addonId} | Get add-on with given ID.
[**get_addon_configuration**](AddonsApi.md#get_addon_configuration) | **GET** /addons/{addonId}/config | Get add-on configuration for given add-on ID.
[**get_addon_services**](AddonsApi.md#get_addon_services) | **GET** /addons/types | Get add-on services.
[**get_addon_types**](AddonsApi.md#get_addon_types) | **GET** /addons/services | Get all add-on types.
[**get_addons**](AddonsApi.md#get_addons) | **GET** /addons | Get all add-ons.
[**get_suggested_addons**](AddonsApi.md#get_suggested_addons) | **GET** /addons/suggestions | Get suggested add-ons to be installed.
[**install_addon_by_id**](AddonsApi.md#install_addon_by_id) | **POST** /addons/{addonId}/install | Installs the add-on with the given ID.
[**install_addon_from_url**](AddonsApi.md#install_addon_from_url) | **POST** /addons/url/{url}/install | Installs the add-on from the given URL.
[**uninstall_addon**](AddonsApi.md#uninstall_addon) | **POST** /addons/{addonId}/uninstall | Uninstalls the add-on with the given ID.
[**update_addon_configuration**](AddonsApi.md#update_addon_configuration) | **PUT** /addons/{addonId}/config | Updates an add-on configuration for given ID and returns the old configuration.



## get_addon_by_id

> models::Addon get_addon_by_id(addon_id, accept_language, service_id)
Get add-on with given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**addon_id** | **String** | addon ID | [required] |
**accept_language** | Option<**String**> | language |  |
**service_id** | Option<**String**> | service ID |  |

### Return type

[**models::Addon**](Addon.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_addon_configuration

> String get_addon_configuration(addon_id, service_id)
Get add-on configuration for given add-on ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**addon_id** | **String** | addon ID | [required] |
**service_id** | Option<**String**> | service ID |  |

### Return type

**String**

### 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_addon_services

> Vec<models::AddonType> get_addon_services(accept_language, service_id)
Get add-on services.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |
**service_id** | Option<**String**> | service ID |  |

### Return type

[**Vec<models::AddonType>**](AddonType.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_addon_types

> Vec<models::AddonType> get_addon_types(accept_language)
Get all add-on types.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<models::AddonType>**](AddonType.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_addons

> Vec<models::Addon> get_addons(accept_language, service_id)
Get all add-ons.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |
**service_id** | Option<**String**> | service ID |  |

### Return type

[**Vec<models::Addon>**](Addon.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_suggested_addons

> Vec<models::Addon> get_suggested_addons(accept_language)
Get suggested add-ons to be installed.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<models::Addon>**](Addon.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)


## install_addon_by_id

> install_addon_by_id(addon_id, service_id)
Installs the add-on with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**addon_id** | **String** | addon ID | [required] |
**service_id** | Option<**String**> | service ID |  |

### 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)


## install_addon_from_url

> install_addon_from_url(url)
Installs the add-on from the given URL.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**url** | **String** | addon install URL | [required] |

### 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)


## uninstall_addon

> uninstall_addon(addon_id, service_id)
Uninstalls the add-on with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**addon_id** | **String** | addon ID | [required] |
**service_id** | Option<**String**> | service ID |  |

### 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_addon_configuration

> String update_addon_configuration(addon_id, service_id, request_body)
Updates an add-on configuration for given ID and returns the old configuration.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**addon_id** | **String** | Add-on id | [required] |
**service_id** | Option<**String**> | service ID |  |
**request_body** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> |  |  |

### Return type

**String**

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)