fix: provide ability to configure the lookup key for objects when upd…

…ating
sophos · Oct 15, 2024 · 1659f63 · 1659f63
1 parent 5a935c7
commit 1659f63
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/sophosfirewall_python/api_client.py b/sophosfirewall_python/api_client.py
@@ -335,6 +335,7 @@ def update(
         xml_tag: str,
         update_params: dict,
         name: str = None,
+        lookup_key: str = "Name",
         output_format: str = "dict",
         debug: bool = False,
     ):
@@ -344,12 +345,13 @@ def update(
             xml_tag (str): The XML tag indicating the type of object to be updated.
             update_params (dict): Keys/values to be updated. Keys must match an existing XML key.
             name (str, optional): The name of the object to be updated, if applicable.
+            lookup_key (str, optional): The XML key name to look up the name of the object. Default is "Name".
             output_format(str): Output format. Valid options are "dict" or "xml". Defaults to dict.
             debug (bool): Displays the XML payload that was submitted
         """
         if name:
             resp = self.get_tag_with_filter(
-                xml_tag=xml_tag, key="Name", value=name, operator="="
+                xml_tag=xml_tag, key=lookup_key, value=name, operator="="
             )
         else:
             resp = self.get_tag(xml_tag=xml_tag)

diff --git a/sophosfirewall_python/firewallapi.py b/sophosfirewall_python/firewallapi.py
@@ -147,6 +147,7 @@ def update(
         xml_tag: str,
         update_params: dict,
         name: str = None,
+        lookup_key: str = "Name",
         output_format: str = "dict",
         debug: bool = False,
     ):
@@ -156,10 +157,11 @@ def update(
             xml_tag (str): The XML tag indicating the type of object to be updated.
             update_params (dict): Keys/values to be updated. Keys must match an existing XML key.
             name (str, optional): The name of the object to be updated, if applicable.
+            lookup_key (str, optional): The XML key name to look up the name of the object. Default is "Name".
             output_format(str): Output format. Valid options are "dict" or "xml". Defaults to dict.
             debug (bool): Displays the XML payload that was submitted
         """
-        return self.client.update(xml_tag, update_params, name, output_format, debug)
+        return self.client.update(xml_tag, update_params, name, lookup_key, output_format, debug)
 
     # METHODS FOR OBJECT RETRIEVAL (GET)