python-openhab-rest-client 0.1.2__tar.gz → 0.2.1__tar.gz

{python_openhab_rest_client-0.1.2/python_openhab_rest_client.egg-info → python_openhab_rest_client-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-openhab-rest-client
-Version: 0.1.2
+Version: 0.2.1
 Summary: A Python client for the openHAB REST API. This library enables easy interaction with the openHAB REST API to control smart home devices, retrieve status information, and process events.
 Home-page: https://github.com/Michdo93/python-openhab-rest-client
 Author: Michael Christian Dörflinger

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Actions.py

@@ -12,7 +12,7 @@ class Actions:
         """
         self.client = client
 
-    def getAllActions(self, thingUID: str, language: str = None) -> list:
+    def getActions(self, thingUID: str, language: str = None) -> list:
         """
         Get all available actions for provided thing UID.
 
@@ -21,7 +21,7 @@ class Actions:
 
         :return: A list of actions.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -65,7 +65,7 @@ class Actions:
 
         :return: A response from the server.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Content-Type": "application/json", "Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Addons.py

@@ -23,7 +23,7 @@ class Addons:
         :return: A dictionary containing the add-ons data.
         """
         params = {"serviceId": serviceID} if serviceID else {}
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -63,7 +63,7 @@ class Addons:
         :return: A dictionary containing details of the specified add-on.
         """
         params = {"serviceId": serviceID} if serviceID else {}
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -106,7 +106,7 @@ class Addons:
 
         try:
             response = self.client.get(
-                f"/addons/{addonID}/config", header={"Content-Type": "application/json"}, params=params)
+                f"/addons/{addonID}/config", header={"Accept": "application/json"}, params=params)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -151,7 +151,7 @@ class Addons:
 
         try:
             response = self.client.put(
-                f"/addons/{addonID}/config", header={"Content-Type": "application/json"}, data=json.dumps(data))
+                f"/addons/{addonID}/config", header={"Content-Type": "application/json", "Accept": "application/json"}, data=json.dumps(data))
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -179,24 +179,20 @@ class Addons:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def installAddon(self, addonID: str, serviceID: str = None, language: str = None) -> dict:
+    def installAddon(self, addonID: str, serviceID: str = None) -> dict:
         """
         Installs an add-on by its ID.
 
         :param addonID: The unique identifier of the add-on.
         :param serviceID: Optional service ID to specify the target service.
-        :param language: Optional language preference for the response.
 
         :return: A dictionary containing the installation status.
         """
         data = {"serviceId": serviceID} if serviceID else {}
-        header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
 
         try:
             response = self.client.post(
-                f"/addons/{addonID}/install", header=header, data=data)
+                f"/addons/{addonID}/install", data=data)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -220,24 +216,20 @@ class Addons:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def uninstallAddon(self, addonID: str, serviceID: str = None, language: str = None) -> dict:
+    def uninstallAddon(self, addonID: str, serviceID: str = None) -> dict:
         """
         Uninstalls an add-on by its ID.
 
         :param addonID: The unique identifier of the add-on.
         :param serviceID: Optional service ID to specify the target service.
-        :param language: Optional language preference for the response.
 
         :return: A dictionary containing the uninstallation status.
         """
         data = {"serviceId": serviceID} if serviceID else {}
-        header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
 
         try:
             response = self.client.post(
-                f"/addons/{addonID}/uninstall", header=header, data=data)
+                f"/addons/{addonID}/uninstall", data=data)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -269,7 +261,7 @@ class Addons:
 
         :return: A dictionary containing the available add-on services.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -303,7 +295,7 @@ class Addons:
 
         :return: A dictionary containing suggested add-ons.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -329,7 +321,7 @@ class Addons:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getAddonTypes(self, language: str = None) -> dict:
+    def getAddonTypes(self, serviceID: str = None, language: str = None) -> dict:
         """
         Retrieves a list of all available add-on types.
 
@@ -337,13 +329,14 @@ class Addons:
 
         :return: A dictionary containing available add-on types.
         """
-        header = {"Content-Type": "application/json"}
+        params = {"serviceId": serviceID} if serviceID else {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
         try:
             response = self.client.get(
-                "/addons/types", header=header, params=None)
+                "/addons/types", header=header, params=params)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -379,8 +372,7 @@ class Addons:
         endpoint = f"/addons/url/{encoded_url}/install"
 
         try:
-            response = self.client.post(
-                endpoint, header={"Content-Type": "text/plain"}, data=None)
+            response = self.client.post(endpoint, data=None)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Audio.py

@@ -19,7 +19,7 @@ class Audio:
 
         :return: A dictionary containing information about the default sink.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -56,7 +56,7 @@ class Audio:
 
         :return: A dictionary containing information about the default source.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -93,7 +93,7 @@ class Audio:
 
         :return: A list of available sinks.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -126,7 +126,7 @@ class Audio:
 
         :return: A list of available sources.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Auth.py

@@ -13,7 +13,7 @@ class Auth:
         """
         self.client = client
 
-    def getAPITokens(self, language: str = None) -> dict:
+    def getAPITokens(self) -> dict:
         """
         Retrieve the API tokens associated with the authenticated user.
 
@@ -21,9 +21,7 @@ class Auth:
 
         :return: JSON response from the server.
         """
-        header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
+        header = {"Accept": "application/json"}
 
         try:
             response = self.client.get("/auth/apitokens", header=header)
@@ -54,7 +52,7 @@ class Auth:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def revokeAPIToken(self, tokenName: str, language: str = None) -> dict:
+    def revokeAPIToken(self, tokenName: str) -> dict:
         """
         Revoke a specific API token associated with the authenticated user.
 
@@ -63,13 +61,9 @@ class Auth:
 
         :return: JSON response from the server.
         """
-        header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
-
         try:
             response = self.client.delete(
-                f"/auth/apitokens/{tokenName}", header=header)
+                f"/auth/apitokens/{tokenName}")
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -97,22 +91,25 @@ class Auth:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def logout(self, refreshToken: str, language: str = None) -> dict:
+    def logout(self, refreshToken: str, sessionID: str) -> dict:
         """
         Terminate the session associated with a refresh token.
 
         :param refreshToken: The refresh token used to delete the session.
-        :param language: (Optional) Language setting for the API request.
+        :param id: The user ID associated with the refresh token.
 
         :return: JSON response from the server.
         """
         header = {"Content-Type": "application/x-www-form-urlencoded"}
-        if language:
-            header["Accept-Language"] = language
+        
+        data = {
+            "refresh_token": refreshToken,
+            "id": sessionID
+        }
 
         try:
             response = self.client.post(
-                "/auth/logout", header=header, data=json.dumps({"refresh_token": refreshToken}))
+                "/auth/logout", header=header, data=data)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -140,17 +137,13 @@ class Auth:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getSessions(self, language: str = None) -> dict:
+    def getSessions(self) -> dict:
         """
         Retrieve the sessions associated with the authenticated user.
 
-        :param language: (Optional) Language setting for the API request.
-
         :return: JSON response from the server.
         """
-        header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
+        header = {"Accept": "application/json"}
 
         try:
             response = self.client.get("/auth/sessions", header=header)
@@ -181,17 +174,18 @@ class Auth:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getToken(self, grantType: str, code: str = None, redirectURI: str = None, clientID: str = None, refreshToken: str = None, codeVerifier: str = None, language: str = None) -> dict:
+    def getToken(self, useCookie: bool = False, grantType: str = None, code: str = None, redirectURI: str = None, clientID: str = None, 
+                 refreshToken: str = None, codeVerifier: str = None) -> dict:
         """
         Obtain access and refresh tokens.
 
-        :param grantType: The type of grant being requested.
+        :param useCookie: (Optional) Whether to use cookies for the session.
+        :param grantType: (Optional) The type of grant being requested.
         :param code: (Optional) Authorization code for authentication.
         :param redirectUri: (Optional) Redirect URI for OAuth authentication.
         :param clientID: (Optional) Client ID for authentication.
         :param refreshToken: (Optional) Refresh token for token renewal.
         :param codeVerifier: (Optional) Code verifier for PKCE authentication.
-        :param language: (Optional) Language setting for the API request.
 
         :return: JSON response from the server.
         """
@@ -200,6 +194,11 @@ class Auth:
             "Accept": "application/json"
         }
 
+        params = {
+            "useCookie": str(useCookie).lower()
+        }
+
+        # Body mit den erforderlichen Parametern
         body = {
             "grant_type": grantType,
             "code": code,
@@ -208,15 +207,17 @@ class Auth:
             "refresh_token": refreshToken,
             "code_verifier": codeVerifier
         }
-        # Remove all None values
+
+        # Entferne alle None-Werte aus dem Body
         body = {k: v for k, v in body.items() if v is not None}
 
-        # Encode as application/x-www-form-urlencoded
+        # Kodierung als application/x-www-form-urlencoded
         encodedBody = urlencode(body)
 
         try:
+            # Request mit den encoded Daten senden
             response = self.client.post(
-                "/auth/token", header=header, data=encodedBody)
+                "/auth/token", header=header, data=encodedBody, params=params)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -234,8 +235,8 @@ class Auth:
             return {"error": f"Request error: {str(err)}"}
 
         if status_code == 200:
-            return {"message": "OK"}
+            return response  # Gebe die gesamte Antwort zurück
         elif status_code == 400:
             return {"error": "Invalid request parameters."}
 
-        return {"error": f"Unexpected response: {status_code}"}
+        return {"error": f"Unexpected response: {status_code}"}

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/ChannelTypes.py

@@ -11,7 +11,7 @@ class ChannelTypes:
         """
         self.client = client
 
-    def getAllChannelTypes(self, language: str = None, prefixes: str = None) -> list:
+    def getChannelTypes(self, prefixes: str = None, language: str = None) -> list:
         """
         Retrieves all available channel types.
 
@@ -20,7 +20,7 @@ class ChannelTypes:
 
         :return: A list of channel types.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -50,7 +50,7 @@ class ChannelTypes:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getChannelTypeByUID(self, channelTypeUID: str, language: str = None) -> dict:
+    def getChannelType(self, channelTypeUID: str, language: str = None) -> dict:
         """
         Retrieves the item types the given trigger channel type UID can be linked to.
 
@@ -59,7 +59,7 @@ class ChannelTypes:
 
         :return: Details of the specific channel type.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -97,10 +97,9 @@ class ChannelTypes:
 
         :return: A list of item types.
         """
-
         try:
             response = self.client.get(
-                f"/channel-types/{channelTypeUID}/linkableItemTypes")
+                f"/channel-types/{channelTypeUID}/linkableItemTypes", header={"Accept": "application/json"})
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Client.py

@@ -213,7 +213,7 @@ class OpenHABClient:
 
         :return: The response from the PUT request.
         """
-        return self.__executeRequest(header, endpoint, "put", data=data)
+        return self.__executeRequest(header, endpoint, "put", data=data, params=params)
 
     def delete(self, endpoint: str, header: dict = None, data=None, params: dict = None):
         """

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/ConfigDescriptions.py

@@ -11,7 +11,7 @@ class ConfigDescriptions:
         """
         self.client = client
 
-    def getAllConfigDescriptions(self, language: str = None, scheme: str = None) -> list:
+    def getConfigDescriptions(self, scheme: str = None, language: str = None) -> list:
         """
         Retrieves all available config descriptions.
 
@@ -20,7 +20,7 @@ class ConfigDescriptions:
 
         :return: A list of configuration descriptions.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -50,7 +50,7 @@ class ConfigDescriptions:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getConfigDescriptionByURI(self, uri: str, language: str = None) -> dict:
+    def getConfigDescription(self, uri: str, language: str = None) -> dict:
         """
         Retrieves a config description by URI.
 
@@ -59,7 +59,7 @@ class ConfigDescriptions:
 
         :return: Details of the specific configuration description.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Discovery.py

@@ -11,14 +11,14 @@ class Discovery:
         """
         self.client = client
 
-    def getAllDiscoveryBindings(self) -> list:
+    def getDiscoveryBindings(self) -> list:
         """
         Gets all bindings that support discovery.
 
         :return: Eine Liste der Bindings als Strings.
         """
         try:
-            response = self.client.get("/discovery")
+            response = self.client.get("/discovery", header={"Accept": "application/json"})
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -38,17 +38,59 @@ class Discovery:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def startBindingScan(self, bindingID: str) -> int:
+    def getBindingInfo(self, bindingID: str, language: str = None) -> dict:
+        """
+        Gets information about the discovery services for a binding.
+
+        :param bindingId: The ID of the binding to get discovery information for.
+        :param language: Optional language parameter for the response (Accept-Language header).
+
+        :return: Information about the discovery service for the specified binding.
+        """
+        header = {"Accept": "application/json"}
+        if language:
+            header["Accept-Language"] = language
+
+        try:
+            response = self.client.get(
+                f"/discovery/bindings/{bindingID}/info", header=header)
+
+            if isinstance(response, dict) and "status" in response:
+                status_code = response["status"]
+            else:
+                return response
+
+        except requests.exceptions.HTTPError as err:
+            status_code = err.response.status_code
+            if status_code == 404:
+                return {"error": "Discovery service not found."}
+            elif status_code != 200:
+                return {"error": f"HTTP error {status_code}: {str(err)}"}
+
+        except requests.exceptions.RequestException as err:
+            return {"error": f"Request error: {str(err)}"}
+
+        if status_code == 200:
+            return response
+
+        return {"error": f"Unexpected response: {status_code}"}
+
+    def startBindingScan(self, bindingID: str, input: str = None) -> int:
         """
         Starts asynchronous discovery process for a binding and returns the timeout in seconds of the discovery operation.
 
         :param bindingID: The ID of the binding for which the discovery is to be started.
+        :param input: An input parameter to start the discovery.
 
         :return: Timeout duration of the discovery operation in seconds.
         """
+        params = {
+            "input": input
+        }
+
         try:
             response = self.client.post(
-                f"/discovery/bindings/{bindingID}/scan")
+                f"/discovery/bindings/{bindingID}/scan", header={"Accept": "text/plain"}, params=params)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Events.py

@@ -12,7 +12,7 @@ class Events:
         """
         self.client = client
 
-    def getAllEvents(self, topics: str = None) -> list:
+    def getEvents(self, topics: str = None) -> list:
         """
         Get all available events, optionally filtered by topic.
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Iconsets.py

@@ -11,7 +11,7 @@ class Iconsets:
         """
         self.client = client
 
-    def getAllIconsets(self, language: str = None) -> list:
+    def getIconsets(self, language: str = None) -> list:
         """
         Gets all icon sets.
 
@@ -19,9 +19,12 @@ class Iconsets:
 
         :return: A list of icon sets with details such as ID, label, description and supported formats.
         """
+        header = {"Accept": "application/json"}
+        if language:
+            header["Accept-Language"] = language
+
         try:
-            response = self.client.get(
-                "/iconsets", header={"Accept-Language": language} if language else {})
+            response = self.client.get("/iconsets", header=header)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.1}/openhab/Inbox.py

@@ -11,7 +11,7 @@ class Inbox:
         """
         self.client = client
 
-    def getAllDiscoveredThings(self, includeIgnored: bool = True) -> list:
+    def getDiscoveredThings(self, includeIgnored: bool = True) -> list:
         """
         Get all discovered things.
 
@@ -21,7 +21,7 @@ class Inbox:
         """
         try:
             response = self.client.get(
-                "/inbox", params={"includeIgnored": str(includeIgnored).lower()})
+                "/inbox", header={"Accept": "application/json"}, params={"includeIgnored": str(includeIgnored).lower()})
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]