zscaler-sdk-python 1.4.3__tar.gz → 1.5.0__tar.gz

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.4.3
+Version: 1.5.0
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -980,6 +980,7 @@ You can provide credentials via the `ZDX_CLIENT_ID`, `ZDX_CLIENT_SECRET` environ
 |--------------|-------------|-------------------|
 | `key_id`       | _(String)_ A string that contains the key_id for the ZDX Portal.| `ZDX_CLIENT_ID` |
 | `key_secret`       | _(String)_ A string that contains the key_secret key for the ZDX Portal.| `ZDX_CLIENT_SECRET` |
+| `cloud`            | _(String)_ The cloud name prefix that identifies the correct API endpoint.| `ZDX_CLOUD` |
 
 ### ZDX Legacy Client Initialization
 
@@ -1078,6 +1079,11 @@ When a 429 error is received, the `retry-after` header will tell you the time at
 
 This SDK uses the built-in retry strategy to automatically retry on 429 errors based on the response headers returned by each respective API service.
 
+| Configuration Option        | Description                                                                                                                                          |
+| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| client.rateLimit.maxRetries | The number of times to retry (on retryable errors)
+| client.rateLimit.maxRetrySeconds | Max wait duration allowed for a retry backoff
+
 ## Contributing
 
 At this moment we are not accepting contributions, but we welcome suggestions on how to improve this SDK or feature requests, which can then be added in  future releases.

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/README.md

@@ -941,6 +941,7 @@ You can provide credentials via the `ZDX_CLIENT_ID`, `ZDX_CLIENT_SECRET` environ
 |--------------|-------------|-------------------|
 | `key_id`       | _(String)_ A string that contains the key_id for the ZDX Portal.| `ZDX_CLIENT_ID` |
 | `key_secret`       | _(String)_ A string that contains the key_secret key for the ZDX Portal.| `ZDX_CLIENT_SECRET` |
+| `cloud`            | _(String)_ The cloud name prefix that identifies the correct API endpoint.| `ZDX_CLOUD` |
 
 ### ZDX Legacy Client Initialization
 
@@ -1039,6 +1040,11 @@ When a 429 error is received, the `retry-after` header will tell you the time at
 
 This SDK uses the built-in retry strategy to automatically retry on 429 errors based on the response headers returned by each respective API service.
 
+| Configuration Option        | Description                                                                                                                                          |
+| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| client.rateLimit.maxRetries | The number of times to retry (on retryable errors)
+| client.rateLimit.maxRetrySeconds | Max wait duration allowed for a retry backoff
+
 ## Contributing
 
 At this moment we are not accepting contributions, but we welcome suggestions on how to improve this SDK or feature requests, which can then be added in  future releases.

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.4.3"
+version = "1.5.0"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -48,7 +48,7 @@ isort = ">=5.13.0"
 pytest = ">=8.3.5"
 pytest-mock = ">=3.12.0"
 pytest-asyncio = ">=0.23.0"
-pytest-cov = ">=4.1.0"
+pytest-cov = ">=6.2.1"
 pyfakefs = ">=5.7.0"
 responses = ">=0.25.7"
 sphinx = ">=7.2.0"

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/__init__.py

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

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/config/config_setter.py

@@ -39,6 +39,7 @@ class ConfigSetter:
             "proxy": {"port": "", "host": "", "username": "", "password": ""},
             "rateLimit": {
                 "maxRetries": 2,
+                "maxRetrySeconds": "",
             },
             "testing": {"disableHttpsCheck": ""},
         }

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/exceptions/exceptions.py

@@ -84,3 +84,7 @@ class TokenRefreshError(Exception):
 
 class HeaderUpdateError(Exception):
     pass
+
+class RetryTooLong(Exception):
+    """Raised when backoff time exceeds maxRetrySeconds configuration."""
+    pass

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/oneapi_client.py

@@ -431,7 +431,7 @@ class LegacyZWAClient(Client):
     ):
         key_id = config.get("key_id", os.getenv("ZWA_CLIENT_ID"))
         key_secret = config.get("key_secret", os.getenv("ZWA_CLIENT_SECRET"))
-        cloud = config.get("cloud", os.getenv("ZWACLOUD", "us1"))
+        cloud = config.get("cloud", os.getenv("ZWA_CLOUD", "us1"))
         timeout = config.get("timeout", 240)
         request_executor_impl = config.get("requestExecutor", None)
         # Initialize the LegacyZWAClientHelper with the extracted parameters

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/request_executor.py

@@ -520,7 +520,6 @@ class RequestExecutor:
             HTTPStatus.CONFLICT,
             HTTPStatus.PRECONDITION_FAILED,
             HTTPStatus.TOO_MANY_REQUESTS,
-            HTTPStatus.INTERNAL_SERVER_ERROR,
             HTTPStatus.SERVICE_UNAVAILABLE,
             HTTPStatus.GATEWAY_TIMEOUT,
         )
@@ -585,6 +584,36 @@ class RequestExecutor:
         logger.debug("Getting custom headers.")
         return self._custom_headers
 
+    # def get_retry_after(self, headers, logger):
+    #     retry_limit_reset_header = (
+    #         headers.get("x-ratelimit-reset") or 
+    #         headers.get("X-RateLimit-Reset") or
+    #         headers.get("RateLimit-Reset") or
+            
+    #         # ZCC Specific Rate Limiting Headers (LegacyZCCClientHelper)
+    #         headers.get("X-Rate-Limit-Retry-After-Seconds") or # ZCC /downloadDevices Rate Limiting Header (LegacyZCCClientHelper)
+    #         headers.get("X-Rate-Limit-Remaining") # (LegacyZCCClientHelper)
+    #     )
+    #     retry_after = headers.get("Retry-After") or headers.get("retry-after")
+
+    #     if retry_after:
+    #         try:
+    #             return int(retry_after.strip("s")) + 1  # Add 1 second padding
+    #         except ValueError:
+    #             logger.error(f"Error parsing Retry-After header: {retry_after}")
+    #             return None
+
+    #     if retry_limit_reset_header is not None:
+    #         try:
+    #             reset_seconds = float(retry_limit_reset_header)
+    #             return reset_seconds + 1  # Add 1 second padding
+    #         except ValueError:
+    #             logger.error(f"Error parsing x-ratelimit-reset header: {retry_limit_reset_header}")
+    #             return None
+
+    #     logger.error("Missing Retry-After and X-Rate-Limit-Reset headers.")
+    #     return None
+
     def get_retry_after(self, headers, logger):
         retry_limit_reset_header = (
             headers.get("x-ratelimit-reset") or 
@@ -592,25 +621,45 @@ class RequestExecutor:
             headers.get("RateLimit-Reset") or
             
             # ZCC Specific Rate Limiting Headers (LegacyZCCClientHelper)
-            headers.get("X-Rate-Limit-Retry-After-Seconds") or # ZCC /downloadDevices Rate Limiting Header (LegacyZCCClientHelper)
-            headers.get("X-Rate-Limit-Remaining") # (LegacyZCCClientHelper)
+            headers.get("X-Rate-Limit-Retry-After-Seconds") or
+            headers.get("X-Rate-Limit-Remaining")
         )
         retry_after = headers.get("Retry-After") or headers.get("retry-after")
 
+        backoff = None
+
         if retry_after:
             try:
-                return int(retry_after.strip("s")) + 1  # Add 1 second padding
+                backoff = int(retry_after.strip("s")) + 1  # Add 1s padding
             except ValueError:
                 logger.error(f"Error parsing Retry-After header: {retry_after}")
                 return None
 
-        if retry_limit_reset_header is not None:
+        elif retry_limit_reset_header is not None:
             try:
-                reset_seconds = float(retry_limit_reset_header)
-                return reset_seconds + 1  # Add 1 second padding
+                backoff = float(retry_limit_reset_header) + 1
             except ValueError:
                 logger.error(f"Error parsing x-ratelimit-reset header: {retry_limit_reset_header}")
                 return None
+        else:
+            logger.error("Missing Retry-After and X-Rate-Limit-Reset headers.")
+            return None
+
+        # ✅ INSERT THIS BLOCK — check against maxRetrySeconds from config
+        max_retry_seconds = (
+            self._config.get("client", {})
+            .get("rateLimit", {})
+            .get("maxRetrySeconds", None)
+        )
+        if max_retry_seconds is not None:
+            try:
+                max_retry_seconds = int(max_retry_seconds)
+                if backoff > max_retry_seconds:
+                    from zscaler.exceptions.exceptions import RetryTooLong
+                    raise RetryTooLong(
+                        f"Retry wait time {backoff} seconds exceeds configured maxRetrySeconds {max_retry_seconds}."
+                    )
+            except ValueError:
+                logger.warning(f"Ignoring invalid maxRetrySeconds config value: {max_retry_seconds}")
 
-        logger.error("Missing Retry-After and X-Rate-Limit-Reset headers.")
-        return None
+        return backoff

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/utils.py

@@ -78,6 +78,17 @@ reformat_params = [
     ("workload_groups", "workloadGroups"),
     ("service_ids", "services"),
     ("bandwidth_class_ids", "bandwidthClasses"),
+    ("virtual_zen_node_ids", "virtualZenNodes"),
+    ("smart_isolation_user_ids", "smartIsolationUsers"),
+    ("smart_isolation_group_ids", "smartIsolationGroups"),
+    ("cloud_app_tenant_ids", "cloudAppTenants"),
+    ("object_type_ids", "objectTypes"),
+    ("bucket_ids", "buckets"),
+    ("included_domain_profile_ids", "includedDomainProfiles"),
+    ("excluded_domain_profile_ids", "excludedDomainProfiles"),
+    ("criteria_domain_profile_ids", "criteriaDomainProfiles"),
+    ("email_recipient_profile_ids", "emailRecipientProfiles"),
+    ("entity_group_ids", "entityGroups"),
 ]
 
 

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/zdx/models/devices.py

@@ -32,23 +32,29 @@ class Devices(ZscalerObject):
             config (dict): A dictionary representing the configuration.
         """
         super().__init__(config)
-        print(f"DEBUG: Raw config received in devices: {config}")  # Debugging input
 
         if config:
-            self.users = ZscalerCollection.form_list(config.get("devices", []), common_reference.Common)
+            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.next_offset = config["next_offset"] if "next_offset" in config else None
         else:
-            self.devices = ZscalerCollection.form_list([], str)
+            self.id = None
+            self.name = None
             self.next_offset = None
-
-        print(f"DEBUG: Parsed Devices object - {len(self.devices)} devices found")
+            self.userid = 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 = {"devices": [device.as_dict() for device in self.devices], "next_offset": self.next_offset}
+        current_obj_format = {
+            "id": self.id,
+            "name": self.name,
+            "next_offset": self.next_offset,
+            "userid": self.userid,
+        }
         parent_req_format.update(current_obj_format)
         return parent_req_format
 
@@ -70,14 +76,35 @@ class DeviceModelInfo(ZscalerObject):
         if config:
             self.id = config["id"] if "id" in config else None
             self.name = config["name"] if "name" in config else None
-            self.hardware = config["hardware"] if "hardware" in config else None
-            self.network = ZscalerCollection.form_list(config["network"] if "network" in config else [], str)
-            self.software = config["software"] if "software" in config else None
+            
+            self.network = ZscalerCollection.form_list(
+                config["network"] if "network" in config else [], Network
+            )
+
+            if "hardware" in config:
+                if isinstance(config["hardware"], Hardware):
+                    self.hardware = config["hardware"]
+                elif config["hardware"] is not None:
+                    self.hardware = Hardware(config["hardware"])
+                else:
+                    self.hardware = None
+            else:
+                self.hardware = None
+
+            if "software" in config:
+                if isinstance(config["software"], Software):
+                    self.software = config["software"]
+                elif config["software"] is not None:
+                    self.software = Software(config["software"])
+                else:
+                    self.software = None
+            else:
+                self.software = None
         else:
             self.id = None
             self.name = None
             self.hardware = None
-            self.network = ZscalerCollection.form_list([], str)
+            self.network = []
             self.software = None
 
     def request_format(self):
@@ -96,6 +123,212 @@ class DeviceModelInfo(ZscalerObject):
         return parent_req_format
 
 
+class Hardware(ZscalerObject):
+    """
+    A class for Hardware objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the Hardware model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.hw_model = config["hw_model"] \
+                if "hw_model" in config else None
+            self.hw_mfg = config["hw_mfg"] \
+                if "hw_mfg" in config else None
+            self.hw_type = config["hw_type"] \
+                if "hw_type" in config else None
+            self.hw_serial = config["hw_serial"] \
+                if "hw_serial" in config else None
+            self.tot_mem = config["tot_mem"] \
+                if "tot_mem" in config else None
+            self.gpu = config["gpu"] \
+                if "gpu" in config else None
+            self.disk_size = config["disk_size"] \
+                if "disk_size" in config else None
+            self.disk_model = config["disk_model"] \
+                if "disk_model" in config else None
+            self.disk_type = config["disk_type"] \
+                if "disk_type" in config else None
+            self.cpu_mfg = config["cpu_mfg"] \
+                if "cpu_mfg" in config else None
+            self.cpu_model = config["cpu_model"] \
+                if "cpu_model" in config else None
+            self.speed_ghz = config["speed_ghz"] \
+                if "speed_ghz" in config else None
+            self.logical_proc = config["logical_proc"] \
+                if "logical_proc" in config else None
+            self.num_cores = config["num_cores"] \
+                if "num_cores" in config else None
+        else:
+            self.hw_model = None
+            self.hw_mfg = None
+            self.hw_type = None
+            self.hw_serial = None
+            self.tot_mem = None
+            self.gpu = None
+            self.disk_size = None
+            self.disk_model = None
+            self.disk_type = None
+            self.cpu_mfg = None
+            self.cpu_model = None
+            self.speed_ghz = None
+            self.logical_proc = None
+            self.num_cores = 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 = {
+            "hw_model": self.hw_model,
+            "hw_mfg": self.hw_mfg,
+            "hw_type": self.hw_type,
+            "hw_serial": self.hw_serial,
+            "tot_mem": self.tot_mem,
+            "gpu": self.gpu,
+            "disk_size": self.disk_size,
+            "disk_model": self.disk_model,
+            "disk_type": self.disk_type,
+            "cpu_mfg": self.cpu_mfg,
+            "cpu_model": self.cpu_model,
+            "speed_ghz": self.speed_ghz,
+            "logical_proc": self.logical_proc,
+            "num_cores": self.num_cores
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class Network(ZscalerObject):
+    """
+    A class for Network objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the Network model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.net_type = config["net_type"] \
+                if "net_type" in config else None
+            self.status = config["status"] \
+                if "status" in config else None
+            self.ipv4 = config["ipv4"] \
+                if "ipv4" in config else None
+            self.ipv6 = config["ipv6"] \
+                if "ipv6" in config else None
+            self.dns_srvs = config["dns_srvs"] \
+                if "dns_srvs" in config else None
+            self.dns_suffix = config["dns_suffix"] \
+                if "dns_suffix" in config else None
+            self.gateway = config["gateway"] \
+                if "gateway" in config else None
+            self.mac = config["mac"] \
+                if "mac" in config else None
+            self.guid = config["guid"] \
+                if "guid" in config else None
+        else:
+            self.net_type = None
+            self.status = None
+            self.ipv4 = None
+            self.ipv6 = None
+            self.dns_srvs = None
+            self.dns_suffix = None
+            self.gateway = None
+            self.mac = None
+            self.guid = 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 = {
+            "net_type": self.net_type,
+            "status": self.status,
+            "ipv4": self.ipv4,
+            "ipv6": self.ipv6,
+            "dns_srvs": self.dns_srvs,
+            "dns_suffix": self.dns_suffix,
+            "gateway": self.gateway,
+            "mac": self.mac,
+            "guid": self.guid
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+    
+class Software(ZscalerObject):
+    """
+    A class for Software objects.
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the Software model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.os_name = config["os_name"] \
+                if "os_name" in config else None
+            self.os_ver = config["os_ver"] \
+                if "os_ver" in config else None
+            self.os_build = config["os_build"] \
+                if "os_build" in config else None
+            self.hostname = config["hostname"] \
+                if "hostname" in config else None
+            self.netbios = config["netbios"] \
+                if "netbios" in config else None
+            self.user = config["user"] \
+                if "user" in config else None
+            self.client_conn_ver = config["client_conn_ver"] \
+                if "client_conn_ver" in config else None
+            self.zdx_ver = config["zdx_ver"] \
+                if "zdx_ver" in config else None
+        else:
+            self.os_name = None
+            self.os_ver = None
+            self.os_build = None
+            self.hostname = None
+            self.netbios = None
+            self.user = None
+            self.client_conn_ver = None
+            self.zdx_ver = 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 = {
+            "os_name": self.os_name,
+            "os_ver": self.os_ver,
+            "os_build": self.os_build,
+            "hostname": self.hostname,
+            "netbios": self.netbios,
+            "user": self.user,
+            "client_conn_ver": self.client_conn_ver,
+            "zdx_ver": self.zdx_ver
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
 class DeviceActiveApplications(ZscalerObject):
     """
     A class for DeviceActiveApplications objects.

{zscaler_sdk_python-1.4.3 → zscaler_sdk_python-1.5.0}/zscaler/zia/alert_subscriptions.py

@@ -72,8 +72,8 @@ class AlertSubscriptionsAPI(APIClient):
             return (None, response, error)
 
         try:
-            advanced_settings = AlertSubscriptions(response.get_body())
-            return (advanced_settings, response, None)
+            results = [AlertSubscriptions(item) for item in response.get_body()]
+            return (results, response, None)
         except Exception as ex:
             return (None, response, ex)
 
@@ -257,3 +257,41 @@ class AlertSubscriptionsAPI(APIClient):
             return (None, response, error)
 
         return (result, response, None)
+
+    def delete_alert_subscription(self, subscription_id: int) -> tuple:
+        """
+        Deletes the specified Alert Subscription
+
+        Args:
+            subscription_id (str): The unique identifier of the Alert Subscription.
+
+        Returns:
+            tuple: A tuple containing the response object and error (if any).
+
+        Examples:
+            Delete a Alert Subscription:
+
+            >>> _, _, error = client.zia.alert_subscriptions.delete_alert_subscription('73459')
+            >>> if error:
+            ...     print(f"Error deleting Alert Subscription: {error}")
+            ...     return
+            ... print(f"Alert Subscription with ID {'73459' deleted successfully.")
+        """
+        http_method = "delete".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /alertSubscriptions/{subscription_id}
+        """
+        )
+
+        params = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, params=params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+        if error:
+            return (None, response, error)
+        return (None, response, None)