zscaler-sdk-python 0.4.0__tar.gz → 0.5.1__tar.gz

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.4.0
+Version: 0.5.1
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -33,12 +33,12 @@ Requires-Dist: idna
 Requires-Dist: okta (>=2.9.7)
 Requires-Dist: pycryptodomex
 Requires-Dist: pydash ; extra == "dev"
-Requires-Dist: python-box (>=7.1.1,<8.0.0)
+Requires-Dist: python-box (>=7.2.0,<8.0.0)
 Requires-Dist: python-dateutil
 Requires-Dist: pytz
 Requires-Dist: pyyaml
 Requires-Dist: requests (>=2.32.0)
-Requires-Dist: responses (>=0.25.0)
+Requires-Dist: responses (>=0.25.3)
 Requires-Dist: restfly
 Requires-Dist: six
 Requires-Dist: xmltodict
@@ -337,8 +337,10 @@ Contributors
 - Eddie Parra - [eparra](https://github.com/eparra)
 - Paul Abbot - [abbottp](https://github.com/abbottp)
 
-## License
-MIT License
+Thank you to [Mitch Kelly](https://github.com/mitchos/pyZscaler), creator of the [PyZscaler](https://github.com/mitchos/pyZscaler) SDK, 
+which this SDK was inspired on.
+
+## MIT License
 
 =======
 

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/README.md

@@ -287,8 +287,10 @@ Contributors
 - Eddie Parra - [eparra](https://github.com/eparra)
 - Paul Abbot - [abbottp](https://github.com/abbottp)
 
-## License
-MIT License
+Thank you to [Mitch Kelly](https://github.com/mitchos/pyZscaler), creator of the [PyZscaler](https://github.com/mitchos/pyZscaler) SDK, 
+which this SDK was inspired on.
+
+## MIT License
 
 =======
 

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.4.0"
+version = "0.5.1"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -33,10 +33,10 @@ arrow = "*"
 certifi = ">=2024.2.2"
 charset-normalizer = "*"
 idna = "*"
-python-box = "^7.1.1"
+python-box = "^7.2.0"
 python-dateutil = "*"
 requests = ">=2.32.0"
-responses = ">=0.25.0"
+responses = ">=0.25.3"
 restfly = "*"
 six = "*"
 flatdict = "*"

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.4.0"
+__version__ = "0.5.1"
 
 from zscaler.zia import ZIAClientHelper  # noqa
 from zscaler.zpa import ZPAClientHelper  # noqa

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/zscaler/utils.py

@@ -147,11 +147,45 @@ def add_id_groups(id_groups: list, kwargs: dict, payload: dict):
     return
 
 
+# def transform_common_id_fields(id_groups: list, kwargs: dict, payload: dict):
+#     for entry in id_groups:
+#         if kwargs.get(entry[0]):
+#             # Ensure each ID is treated as an integer before adding it to the payload
+#             payload[entry[1]] = [{"id": int(param_id)} for param_id in kwargs.pop(entry[0])]
+#     return
+
+# ####### Function used in the ZIA Forwarding Control Rule #######
+# def transform_fwd_id_fields(id_groups: list, kwargs: dict, payload: dict):
+#     for entry in id_groups:
+#         key, payload_key = entry
+#         if key in kwargs:
+#             value = kwargs.pop(key)
+#             if isinstance(value, dict):
+#                 payload[payload_key] = {k: v for k, v in value.items() if k in ['id', 'name']}
+#             elif isinstance(value, list):
+#                 payload[payload_key] = [{"id": int(item)} if isinstance(item, str) and item.isdigit() else item for item in value]
+#     return
+
+
 def transform_common_id_fields(id_groups: list, kwargs: dict, payload: dict):
     for entry in id_groups:
-        if kwargs.get(entry[0]):
-            # Ensure each ID is treated as an integer before adding it to the payload
-            payload[entry[1]] = [{"id": int(param_id)} for param_id in kwargs.pop(entry[0])]
+        key, payload_key = entry
+        if key in kwargs:
+            value = kwargs.pop(key)
+            if key in ["zpa_gateway", "proxy_gateway", "zpa_server_group"]:
+                # Handle zpa_gateway, proxy_gateway, and zpa_server_group
+                if isinstance(value, dict):
+                    payload[payload_key] = {
+                        snake_to_camel(k): v for k, v in value.items() if k in ["id", "name", "external_id"]
+                    }
+            elif key in ["zpa_app_segments", "zpa_application_segments", "zpa_application_segment_groups"]:
+                # Handle zpa_app_segments, zpa_application_segments, and zpa_application_segment_groups
+                if isinstance(value, list):
+                    payload[payload_key] = [{"externalId": item["external_id"], "name": item["name"]} for item in value]
+            else:
+                # General case for ID transformations
+                if isinstance(value, list):
+                    payload[payload_key] = [{"id": int(item)} if isinstance(item, (str, int)) else item for item in value]
     return
 
 

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/zscaler/zia/firewall.py

@@ -233,10 +233,7 @@ class FirewallPolicyAPI:
 
         response = self.rest.put(f"firewallFilteringRules/{rule_id}", json=payload)
         if isinstance(response, Response) and not response.ok:
-            # Handle error response
             raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
-
-        # Return the updated object
         return self.get_rule(rule_id)
 
     def delete_rule(self, rule_id: str) -> int:
@@ -516,11 +513,8 @@ class FirewallPolicyAPI:
             ...    ip_addresses=['192.0.2.0/29', '192.0.2.8/29', '192.0.2.128/25'])
 
         """
-
-        # Set payload to value of existing record
         payload = {snake_to_camel(k): v for k, v in self.get_ip_source_group(group_id).items()}
 
-        # Update payload
         for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
@@ -557,30 +551,12 @@ class FirewallPolicyAPI:
 
         Returns:
             :obj:`Box`: The Network Application Group resource record.
+
+        Examples:
+            >>> pprint(zia.firewall.get_network_app_group('287342'))
+
         """
-        response = self.rest.get(f"networkApplicationGroups/{group_id}")
-
-        # If 'response' is a Box, it should contain the response data directly
-        # If 'response' is an HTTP response, it should have a 'status_code' attribute
-        if hasattr(response, "status_code"):
-            # Check if the response is successful and the content is not empty
-            if response.status_code == 200 and response.content:
-                # Convert to Box for consistent return type
-                return Box(response.json())
-            else:
-                # Handle non-200 responses
-                response.raise_for_status()
-        else:
-            # Assume 'response' is a Box and contains the desired data
-            if "ok" in response and response.ok:
-                # 'response' is a Box with the expected data
-                return response
-            else:
-                # Handle cases where the response Box does not contain the expected data
-                # For example, you might want to check for an 'error' or 'message' field
-                # and raise an exception or handle the situation as needed
-                # Example: raise ValueError("Failed to retrieve the network application group.")
-                return Box()  # An empty Box indicates no data was found or an error occurred.
+        return self.rest.get(f"networkApplicationGroups/{group_id}")
 
     def delete_network_app_group(self, group_id: str) -> int:
         """
@@ -598,7 +574,7 @@ class FirewallPolicyAPI:
         """
         return self.rest.delete(f"networkApplicationGroups/{group_id}").status_code
 
-    def add_network_app_group(self, name: str, network_applications: list, description: str = None) -> Box:
+    def add_network_app_group(self, name: str, network_applications: list, **kwargs) -> Box:
         """
         Adds a new Network Application Group.
 
@@ -618,22 +594,16 @@ class FirewallPolicyAPI:
             ...    description='Additional information about the Network Application Group.')
 
         """
-
         payload = {
             "name": name,
             "networkApplications": network_applications,
-            "description": description,
         }
 
-        response = self.rest.post("networkApplicationGroups", json=payload)
-        if isinstance(response, Response):
-            # this is only true when the creation failed (status code is not 2xx)
-            status_code = response.status_code
-            # Handle error response
-            raise Exception(f"API call failed with status {status_code}: {response.json()}")
-        return response
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
 
-        # return self.rest.post("networkApplicationGroups", json=payload)
+        return self.rest.post("networkApplicationGroups", json=payload)
 
     def update_network_app_group(self, group_id: str, **kwargs) -> Box:
         """
@@ -675,8 +645,6 @@ class FirewallPolicyAPI:
             payload[snake_to_camel(key)] = value
 
         resp = self.rest.put(f"networkApplicationGroups/{group_id}", json=payload).status_code
-
-        # Return the object if it was updated successfully
         if not isinstance(resp, Response):
             return self.get_network_app_group(group_id)
 
@@ -941,10 +909,10 @@ class FirewallPolicyAPI:
         # Convert tuple list to dict and add to payload
         if ports is not None:
             for items in ports:
-                port_range = [{"start": items[2]}]
+                port_dict = {"start": int(items[2])}
                 if len(items) == 4:
-                    port_range.append({"end": items[3]})
-                payload.setdefault(f"{items[0]}{items[1].title()}Ports", []).extend(port_range)
+                    port_dict["end"] = int(items[3])
+                payload.setdefault(f"{items[0]}{items[1].title()}Ports", []).append(port_dict)
 
         # Add optional parameters to payload
         for key, value in kwargs.items():
@@ -999,7 +967,6 @@ class FirewallPolicyAPI:
             ...    ports=[
             ...        ('dest', 'tcp', '500', '510')])
 
-
         """
         payload = {snake_to_camel(k): v for k, v in self.get_network_service(service_id).items()}
 
@@ -1017,11 +984,7 @@ class FirewallPolicyAPI:
         for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
-        resp = self.rest.put(f"networkServices/{service_id}", json=payload).status_code
-
-        # Return the object if it was updated successfully
-        if not isinstance(resp, Response):
-            return self.get_network_service(service_id)
+        return self.rest.put(f"networkServices/{service_id}", json=payload)
 
     def list_time_windows(self) -> Box:
         """

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/zscaler/zia/forwarding_control.py

@@ -68,10 +68,7 @@ class ForwardingControlAPI:
             ...    pprint(rule)
 
         """
-        response = self.rest.get("/forwardingRules")
-        if isinstance(response, Response):
-            return None
-        return response
+        return self.rest.get("forwardingRules")
 
     def get_rule(self, rule_id: str) -> Box:
         """
@@ -158,18 +155,19 @@ class ForwardingControlAPI:
 
         # Transform ID fields in kwargs
         transform_common_id_fields(self.reformat_params, kwargs, payload)
+
         for key, value in kwargs.items():
             if value is not None:
-                payload[snake_to_camel(key)] = value
+                if key == "state" and isinstance(value, bool):
+                    payload[key] = "ENABLED" if value else "DISABLED"
+                else:
+                    payload[key] = value
 
         # Convert the entire payload's keys to camelCase before sending
         camel_payload = recursive_snake_to_camel(payload)
-        for key, value in kwargs.items():
-            if value is not None:
-                camel_payload[snake_to_camel(key)] = value
 
         # Send POST request to create the rule
-        response = self.rest.post("forwardingRules", json=payload)
+        response = self.rest.post("forwardingRules", json=camel_payload)
         if isinstance(response, Response):
             # Handle error response
             status_code = response.status_code
@@ -227,7 +225,6 @@ class ForwardingControlAPI:
             ...    description="TT#1965232866")
 
         """
-
         # Set payload to value of existing record and convert nested dict keys.
         payload = convert_keys(self.get_rule(rule_id))
 
@@ -240,14 +237,14 @@ class ForwardingControlAPI:
 
         # Add remaining optional parameters to payload
         for key, value in kwargs.items():
-            payload[snake_to_camel(key)] = value
+            if key == "state" and isinstance(value, bool):
+                payload[snake_to_camel(key)] = "ENABLED" if value else "DISABLED"
+            else:
+                payload[snake_to_camel(key)] = value
 
         response = self.rest.put(f"forwardingRules/{rule_id}", json=payload)
         if isinstance(response, Response) and not response.ok:
-            # Handle error response
             raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
-
-        # Return the updated object
         return self.get_rule(rule_id)
 
     def delete_rule(self, rule_id: str) -> int:

{zscaler_sdk_python-0.4.0 → zscaler_sdk_python-0.5.1}/zscaler/zia/zpa_gateway.py

@@ -17,7 +17,7 @@
 from box import Box, BoxList
 from requests import Response
 
-from zscaler.utils import convert_keys, snake_to_camel
+from zscaler.utils import convert_keys, snake_to_camel, transform_common_id_fields
 from zscaler.zia import ZIAClient
 
 
@@ -68,7 +68,6 @@ class ZPAGatewayAPI:
         self,
         name: str,
         zpa_server_group: dict = None,
-        zpa_app_segments: list = None,
         **kwargs,
     ) -> Box:
         """
@@ -95,24 +94,21 @@ class ZPAGatewayAPI:
         """
         payload = {"name": name, "type": "ZPA"}
 
+        # Add zpa_server_group to kwargs
         if zpa_server_group:
-            payload["zpaServerGroup"] = {
-                "externalId": zpa_server_group.get("external_id"),
-                "name": zpa_server_group.get("name"),
-            }
+            kwargs["zpa_server_group"] = zpa_server_group
 
-        if zpa_app_segments:
-            payload["zpaAppSegments"] = [
-                {"externalId": segment.get("external_id"), "name": segment.get("name")} for segment in zpa_app_segments
-            ]
+        # Define the id groups specific to this function
+        zpa_gateway_id_groups = [
+            ("zpa_server_group", "zpaServerGroup"),
+        ]
+        transform_common_id_fields(zpa_gateway_id_groups, kwargs, payload)
 
-        # Add other optional parameters to payload
         for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
         response = self.rest.post("zpaGateways", json=payload)
         if isinstance(response, Response):
-            # Handle error response
             status_code = response.status_code
             raise Exception(f"API call failed with status {status_code}: {response.json()}")
         return response
@@ -143,23 +139,22 @@ class ZPAGatewayAPI:
         """
         payload = convert_keys(self.get_gateway(gateway_id))
 
-        # Update payload with provided arguments
-        for key, value in kwargs.items():
-            if key == "zpa_server_group" and isinstance(value, dict):
-                # Convert nested keys in zpa_server_group to camelCase
-                value = {snake_to_camel(k): v for k, v in value.items()}
-            elif key == "zpa_app_segments" and isinstance(value, list):
-                # Convert nested keys in zpa_app_segments to camelCase
-                value = [{snake_to_camel(k): v for k, v in item.items()} for item in value]
+        if "zpa_server_group" in kwargs:
+            kwargs["zpa_server_group"] = kwargs["zpa_server_group"]
+
+        # Define the id groups specific to this function
+        zpa_gateway_id_groups = [
+            ("zpa_server_group", "zpaServerGroup"),
+        ]
+
+        transform_common_id_fields(zpa_gateway_id_groups, kwargs, payload)
 
+        for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
         response = self.rest.put(f"zpaGateways/{gateway_id}", json=payload)
         if isinstance(response, Response) and not response.ok:
-            # Handle error response
-            raise Exception(f"API call failed with status {response.status_code}: " f"{response.json()}")
-
-        # Return the updated object
+            raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
         return self.get_gateway(gateway_id)
 
     def delete_gateway(self, gateway_id):