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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-openhab-rest-client
-Version: 0.1.2
+Version: 0.2.0
 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.0}/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.
 

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

@@ -179,20 +179,17 @@ 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(
@@ -220,20 +217,17 @@ 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(
@@ -329,7 +323,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 +331,14 @@ class Addons:
 
         :return: A dictionary containing available add-on types.
         """
+        params = {"serviceId": serviceID} if serviceID else {}
         header = {"Content-Type": "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"]

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.0}/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.
 
@@ -22,8 +22,6 @@ class Auth:
         :return: JSON response from the server.
         """
         header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
 
         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.
 
@@ -64,8 +62,6 @@ class Auth:
         :return: JSON response from the server.
         """
         header = {"Content-Type": "application/json"}
-        if language:
-            header["Accept-Language"] = language
 
         try:
             response = self.client.delete(
@@ -97,22 +93,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 +139,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
 
         try:
             response = self.client.get("/auth/sessions", header=header)
@@ -181,17 +176,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 +196,11 @@ class Auth:
             "Accept": "application/json"
         }
 
+        params = {
+            "useCookie": useCookie
+        }
+
+        # Body mit den erforderlichen Parametern
         body = {
             "grant_type": grantType,
             "code": code,
@@ -208,15 +209,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 +237,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.0}/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.
 
@@ -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.
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.0}/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.0}/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.
 
@@ -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.
 

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

@@ -11,7 +11,7 @@ class Discovery:
         """
         self.client = client
 
-    def getAllDiscoveryBindings(self) -> list:
+    def getDiscoveryBindings(self) -> list:
         """
         Gets all bindings that support discovery.
 
@@ -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.
+        """
+        headers = {}
+        if language:
+            headers["Accept-Language"] = language
+
+        try:
+            response = self.client.get(
+                f"/discovery/bindings/{bindingID}/info", headers=headers)
+
+            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.0}/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.0}/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.
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.0}/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.
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.0}/openhab/Items.py

@@ -12,30 +12,30 @@ class Items:
         """
         self.client = client
 
-    def getAllItems(
+    def getItems(
         self,
-        language: str = None,
         type: str = None,
         tags: str = None,
         metadata: str = ".*",
         recursive: bool = False,
         fields: str = None,
         staticDataOnly: bool = False,
+        language: str = None
     ):
         """
         Get all available items.
 
-        :param language: Optional; Language filter for header "Accept-Language".
         :param type: Optional; Item type filter.
         :param tags: Optional; Item tag filter.
         :param metadata: Optional; Metadata selector (default: .*).
         :param recursive: Optional; Whether to fetch group members recursively (default: False).
         :param fields: Optional; Limit to specific fields (comma-separated).
         :param staticDataOnly: Optional; Only returns cached data (default: False).
+        :param language: Optional; Language filter for header "Accept-Language".
 
         :return: A dictionary or list containing the item data as returned by the API.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -83,7 +83,7 @@ class Items:
         """
         try:
             response = self.client.put(
-                "/items", data=json.dumps(items), header={"Content-Type": "application/json"})
+                "/items", data=json.dumps(items), header={"Content-Type": "application/json", "Accept": "*/*"})
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -107,18 +107,18 @@ class Items:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getItem(self, itemName: str, language: str = None, metadata: str = ".*", recursive: bool = True):
+    def getItem(self, itemName: str, metadata: str = ".*", recursive: bool = True, language: str = None):
         """
         Gets a single item.
 
         :param itemName: The name of the item.
-        :param language: Optional; Language filter for header "Accept-Language".
         :param metadata: Optional; Metadata selector (default: .*).
         :param recursive: Optional; Whether to fetch group members recursively (default: True).
+        :param language: Optional; Language filter for header "Accept-Language".
 
         :return: A dictionary containing the requested item data.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -163,7 +163,7 @@ class Items:
 
         :return: A response object or confirmation that the item was successfully added or updated.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Content-Type": "application/json", "Accept": "*/"}
         if language:
             header["Accept-Language"] = language
 
@@ -212,7 +212,7 @@ class Items:
         """
         try:
             response = self.client.post(f"/items/{itemName}", header={
-                                        "Content-Type": "text/plain; charset=utf-8", "Accept": "text/plain"}, data=command)
+                                        "Content-Type": "text/plain"}, data=command)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -496,7 +496,7 @@ class Items:
 
         :return: A dictionary containing the semantic item data.
         """
-        header = {}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -534,8 +534,9 @@ class Items:
 
         :return: A dictionary containing the current state of the item.
         """
+        header = {"Accept": "text/plain"}
         try:
-            response = self.client.get(f"/items/{itemName}/state")
+            response = self.client.get(f"/items/{itemName}/state", header=header)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -569,8 +570,7 @@ class Items:
 
         :return: A response object or confirmation that the state was successfully updated.
         """
-        header = {"Content-Type": "text/plain; charset=utf-8",
-                  "Accept": "text/plain"}
+        header = {"Content-Type": "text/plain"}
         if language:
             header["Accept-Language"] = language
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.0}/openhab/Links.py

@@ -13,7 +13,7 @@ class Links:
         """
         self.client = client
 
-    def getAllLinks(self, channelUID: str = None, itemName: str = None) -> list:
+    def getLinks(self, channelUID: str = None, itemName: str = None) -> list:
         """
         Gets all available links.
 
@@ -50,7 +50,7 @@ class Links:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getIndividualLink(self, itemName: str, channelUID: str) -> dict:
+    def getLink(self, itemName: str, channelUID: str) -> dict:
         """
         Retrieves an individual link.
 

{python_openhab_rest_client-0.1.2 → python_openhab_rest_client-0.2.0}/openhab/Logging.py

@@ -12,14 +12,15 @@ class Logging:
         """
         self.client = client
 
-    def getAllLoggers(self) -> dict:
+    def getLoggers(self) -> dict:
         """
         Get all loggers.
 
         :return: A list of loggers with names and levels.
         """
+        header = {"Accept": "application/json"}
         try:
-            response = self.client.get("/logging")
+            response = self.client.get("/logging", header=header)
 
             if isinstance(response, dict) and "status" in response:
                 status_code = response["status"]
@@ -39,7 +40,7 @@ class Logging:
 
         return {"error": f"Unexpected response: {status_code}"}
 
-    def getSingleLogger(self, loggerName: str) -> dict:
+    def getLogger(self, loggerName: str) -> dict:
         """
         Get a single logger.
 
@@ -47,8 +48,9 @@ class Logging:
 
         :return: The logger with the specified name and level.
         """
+        
         try:
-            response = self.client.get(f"/logging/{loggerName}")
+            response = self.client.get(f"/logging/{loggerName}", 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.0}/openhab/ModuleTypes.py

@@ -21,7 +21,7 @@ class ModuleTypes:
 
         :return: A list of module types.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language
 
@@ -62,7 +62,7 @@ class ModuleTypes:
 
         :return: A dictionary with the module type information.
         """
-        header = {"Content-Type": "application/json"}
+        header = {"Accept": "application/json"}
         if language:
             header["Accept-Language"] = language