zscaler-sdk-python 1.7.2__tar.gz → 1.7.3__tar.gz

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.7.2
+Version: 1.7.3
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.7.2"
+version = "1.7.3"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "1.7.2"
+__version__ = "1.7.3"
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/request_executor.py

@@ -282,6 +282,10 @@ class RequestExecutor:
         if self.use_legacy_client and self.zdx_legacy_client:
             return body  # Do not convert anything, just return as-is
 
+        # Special handling for ZDX endpoints - keep snake_case format
+        if "/zdx/" in endpoint:
+            return body  # Do not convert ZDX requests to camelCase
+
         # Preserve existing logic for other services
         if body:
             body = convert_keys_to_camel_case(body)

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/utils.py

@@ -426,6 +426,7 @@ def zdx_params(func):
             ("score_bucket", "score_bucket"),  # New: str (poor, okay, good)
             ("limit", "limit"),  # New: int
             ("offset", "offset"),  # New: str (API-defined pagination)
+            ("expiry", "expiry"),  # New: int
         ]:
             if key in kwargs:
                 value = kwargs.pop(key)

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/zdx/alerts.py

@@ -18,6 +18,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zdx.models.alerts import Alerts
 from zscaler.zdx.models.alerts import AlertDetails
+from zscaler.zdx.models.alerts import AffectedDevices
 from zscaler.utils import format_url, zdx_params
 
 
@@ -102,20 +103,11 @@ class AlertsAPI(APIClient):
         if error:
             return (None, response, error)
 
-        # try:
-        #     parsed_response = self.form_response_body(response.get_body())
-        #     alerts_list = parsed_response.get("alerts", [])
-        #     result = [Alerts(alert) for alert in alerts_list]
-        # except Exception as error:
-        #     return (None, response, error)
-        # return (result, response, None)
-
         try:
-            result = []
-            for item in response.get_results():
-                result.append(Alerts(self.form_response_body(item)))
+            result = [Alerts(self.form_response_body(response.get_body()))]
         except Exception as error:
             return (None, response, error)
+
         return (result, response, None)
 
     def get_alert(self, alert_id: str) -> tuple:
@@ -316,7 +308,7 @@ class AlertsAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [AlertDetails(self.form_response_body(response.get_body()))]
+            result = [AffectedDevices(self.form_response_body(response.get_body()))]
         except Exception as error:
             return (None, response, error)
 

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/zdx/apps.py

@@ -20,8 +20,8 @@ from zscaler.zdx.models.applications import ActiveApplications
 from zscaler.zdx.models.applications import ApplicationScore
 from zscaler.zdx.models.applications import ApplicationScoreTrend
 from zscaler.zdx.models.applications import ApplicationMetrics
-from zscaler.zdx.models.users import UserDetails
 from zscaler.zdx.models.application_users import ApplicationUserDetails
+from zscaler.zdx.models.application_users import ApplicationActiveUsers
 from zscaler.utils import format_url, zdx_params
 
 
@@ -305,7 +305,9 @@ class AppsAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [ApplicationMetrics(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(ApplicationMetrics(item))
         except Exception as error:
             return (None, response, error)
 
@@ -381,18 +383,8 @@ class AppsAPI(APIClient):
         if error:
             return (None, response, error)
 
-        # try:
-        #     result = [ApplicationUsers(
-        #         self.form_response_body(response.get_body()))]
-        # except Exception as error:
-        #     return (None, response, error)
-
-        # return (result, response, None)
         try:
-            parsed_response = self.form_response_body(response.get_body())
-            users_list = parsed_response.get("users", [])
-            result = [UserDetails(user) for user in users_list]
-
+            result = [ApplicationActiveUsers(self.form_response_body(response.get_body()))]
         except Exception as error:
             return (None, response, error)
 

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/zdx/devices.py

@@ -373,7 +373,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceAppWebProbes(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceAppWebProbes(item))
         except Exception as error:
             return (None, response, error)
 
@@ -440,7 +442,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceWebProbePageFetch(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceWebProbePageFetch(item))
         except Exception as error:
             return (None, response, error)
 
@@ -497,7 +501,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceAppCloudPathProbes(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceAppCloudPathProbes(item))
         except Exception as error:
             return (None, response, error)
 
@@ -554,7 +560,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceCloudPathProbesMetric(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceCloudPathProbesMetric(item))
         except Exception as error:
             return (None, response, error)
 
@@ -613,7 +621,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceCloudPathProbesHopData(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceCloudPathProbesHopData(item))
         except Exception as error:
             return (None, response, error)
 
@@ -666,7 +676,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [CallQualityMetrics(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(CallQualityMetrics(item))
         except Exception as error:
             return (None, response, error)
 
@@ -721,7 +733,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceHealthMetrics(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceHealthMetrics(item))
         except Exception as error:
             return (None, response, error)
 
@@ -776,7 +790,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceEvents(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceEvents(item))
         except Exception as error:
             return (None, response, error)
 
@@ -834,7 +850,9 @@ class DevicesAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceActiveGeo(self.form_response_body(response.get_body()))]
+            result = []
+            for item in response.get_results():
+                result.append(DeviceActiveGeo(item))
         except Exception as error:
             return (None, response, error)
 

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/zdx/inventory.py

@@ -89,17 +89,14 @@ class InventoryAPI(APIClient):
         response, error = self._request_executor.execute(request)
         if error:
             return (None, response, error)
-
+    
         try:
-            # Convert the response body into a dictionary
-            data = self.form_response_body(response.get_body())
-            # Extract the list of software items (each as a dict)
-            software_items = data.get("software", [])
-            # Instantiate a SoftwareList object for each item using the defensive model
-            result = [SoftwareList(item) for item in software_items]
+            # Parse the wrapper response and extract the individual software items
+            # Use response.get_body() directly to avoid camelCase conversion for ZDX
+            software_list_wrapper = SoftwareList(response.get_body())
+            result = software_list_wrapper.software  # This is the list of DeviceSoftwareInventory objects
         except Exception as error:
             return (None, response, error)
-
         return (result, response, None)
 
     @zdx_params
@@ -168,8 +165,9 @@ class InventoryAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = [DeviceSoftwareInventory(self.form_response_body(response.get_body()))]
+            # Parse the wrapper response and extract the individual software items
+            software_list_wrapper = SoftwareList(self.form_response_body(response.get_body()))
+            result = software_list_wrapper.software  # This is the list of DeviceSoftwareInventory objects
         except Exception as error:
             return (None, response, error)
-
         return (result, response, None)

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/zdx/legacy.py

@@ -417,6 +417,16 @@ class LegacyZDXClientHelper:
 
         return UsersAPI(self.request_executor)
 
+    @property
+    def snapshot(self):
+        """
+        The interface object for the :ref:`ZDX Snapshot Alert interface <zdx-snapshot>`.
+
+        """
+        from zscaler.zdx.snapshot import SnapshotAPI
+
+        return SnapshotAPI(self.request_executor)
+
     """
     Misc
     """

zscaler_sdk_python-1.7.3/zscaler/zdx/models/alerts.py

@@ -0,0 +1,216 @@
+"""
+Copyright (c) 2023, Zscaler Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+"""
+
+from zscaler.oneapi_object import ZscalerObject
+from zscaler.oneapi_collection import ZscalerCollection
+from zscaler.zdx.models import common as common_reference
+from zscaler.zdx.models import common as common
+
+
+class Alerts(ZscalerObject):
+    """
+    A class for ongoing alert rules across an organization objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the ongoing alert rules across an organization model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.next_offset = config["next_offset"] if "next_offset" in config else None
+
+            self.alerts = ZscalerCollection.form_list(
+                config["alerts"] if "alerts" in config else [], AlertDetails
+            )
+        else:
+            self.next_offset = None
+            self.alerts = []
+
+    def request_format(self):
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "next_offset": self.next_offset,
+            "alerts": self.alerts,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class AlertDetails(ZscalerObject):
+    """
+    A class for AlertDetails objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the AlertDetails model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.id = config["id"] if "id" in config else None
+            self.rule_name = config["rule_name"] if "rule_name" in config else None
+            self.severity = config["severity"] if "severity" in config else None
+            self.alert_type = config["alert_type"] if "alert_type" in config else None
+            self.alert_status = config["alert_status"] if "alert_status" in config else None
+            self.started_on = config["started_on"] if "started_on" in config else None
+            self.ended_on = config["ended_on"] if "ended_on" in config else None
+
+            if "application" in config:
+                if isinstance(config["application"], common.CommonIDName):
+                    self.application = config["application"]
+                elif config["application"] is not None:
+                    self.application = common.CommonIDName(config["application"])
+                else:
+                    self.application = None
+            else:
+                self.application = None
+
+            self.geolocations = ZscalerCollection.form_list(
+
+                config["geolocations"] if "geolocations" in config else [], common.GeoLocations
+            )
+            self.departments = ZscalerCollection.form_list(
+                config["departments"] if "departments" in config else [], common.Departments
+            )
+            self.locations = ZscalerCollection.form_list(
+                config["locations"] if "locations" in config else [], common.Locations
+            )
+
+        else:
+            self.id = None
+            self.rule_name = None
+            self.severity = None
+            self.alert_type = None
+            self.alert_status = None
+            self.application = None
+            self.geolocations = []
+            self.departments = []
+            self.locations = []
+            self.started_on = None
+            self.ended_on = None
+
+    def request_format(self):
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "id": self.id,
+            "rule_name": self.rule_name,
+            "severity": self.severity,
+            "alert_type": self.alert_type,
+            "alert_status": self.alert_status,
+            "application": self.application,
+            "geolocations": self.geolocations,
+            "departments": self.departments,
+            "locations": self.locations,
+            "started_on": self.started_on,
+            "ended_on": self.ended_on,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class AffectedDevices(ZscalerObject):
+    """
+    A class for affected devices associated with an alert rule objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the affected devices associated with an alert rule model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.next_offset = config["next_offset"] if "next_offset" in config else None
+
+            self.devices = ZscalerCollection.form_list(
+                config["devices"] if "devices" in config else [], DeviceDetails
+            )
+        else:
+            self.next_offset = None
+            self.devices = []
+
+    def request_format(self):
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "next_offset": self.next_offset,
+            "devices": self.devices,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class DeviceDetails(ZscalerObject):
+    """
+    A class for affected devices associated with an alert rule objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the affected devices associated with an alert rule model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.id = config["id"] if "id" in config else None
+            self.name = config["name"] if "name" in config else None
+            self.userid = config["userid"] if "userid" in config else None
+            self.user_name = config["userName"] if "userName" in config else None
+            self.user_email = config["userEmail"] if "userEmail" in config else None
+        else:
+            self.id = None
+            self.name = None
+            self.userid = None
+            self.user_name = None
+            self.user_email = None
+
+    def request_format(self):
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "id": self.id,
+            "name": self.name,
+            "userid": self.userid,
+            "userName": self.user_name,
+            "userEmail": self.user_email,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format

{zscaler_sdk_python-1.7.2 → zscaler_sdk_python-1.7.3}/zscaler/zdx/models/application_users.py

@@ -16,16 +16,17 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 from zscaler.oneapi_object import ZscalerObject
 from zscaler.oneapi_collection import ZscalerCollection
+from zscaler.zdx.models import common
 
 
-class ApplicationUsers(ZscalerObject):
+class ApplicationActiveUsers(ZscalerObject):
     """
-    A class for Applicationusers objects.
+    A class for active users, their devices, active geolocations objects.
     """
 
     def __init__(self, config=None):
         """
-        Initialize the Applicationusers model based on API response.
+        Initialize the active users, their devices, active geolocations model based on API response.
 
         Args:
             config (dict): A dictionary representing the configuration.
@@ -33,18 +34,24 @@ class ApplicationUsers(ZscalerObject):
         super().__init__(config)
 
         if config:
-            self.users = ZscalerCollection.form_list(config["users"] if "users" in config else [], str)
             self.next_offset = config["next_offset"] if "next_offset" in config else None
+
+            self.users = ZscalerCollection.form_list(
+                config["users"] if "users" in config else [], common.CommonIDName
+            )
         else:
-            self.users = ZscalerCollection.form_list([], str)
             self.next_offset = None
+            self.users = []
 
     def request_format(self):
         """
         Return the object as a dictionary in the format expected for API requests.
         """
         parent_req_format = super().request_format()
-        current_obj_format = {"users": self.users, "next_offset": self.next_offset}
+        current_obj_format = {
+            "next_offset": self.next_offset,
+            "users": self.users,
+        }
         parent_req_format.update(current_obj_format)
         return parent_req_format
 
@@ -68,13 +75,15 @@ class ApplicationUserDetails(ZscalerObject):
             self.name = config["name"] if "name" in config else None
             self.email = config["email"] if "email" in config else None
             self.score = config["score"] if "score" in config else None
-            self.devices = ZscalerCollection.form_list(config["devices"] if "devices" in config else [], str)
+            self.devices = ZscalerCollection.form_list(
+                config["devices"] if "devices" in config else [], common.Devices
+            )
         else:
             self.id = None
             self.name = None
             self.email = None
             self.score = None
-            self.devices = ZscalerCollection.form_list([], str)
+            self.devices = []
 
     def request_format(self):
         """