zscaler-sdk-python 1.7.9__tar.gz → 1.8.0__tar.gz

{zscaler_sdk_python-1.7.9 → zscaler_sdk_python-1.8.0}/PKG-INFO

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

{zscaler_sdk_python-1.7.9 → zscaler_sdk_python-1.8.0}/pyproject.toml

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

{zscaler_sdk_python-1.7.9 → zscaler_sdk_python-1.8.0}/zscaler/__init__.py

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

{zscaler_sdk_python-1.7.9 → zscaler_sdk_python-1.8.0}/zscaler/errors/zscaler_api_error.py

@@ -23,7 +23,16 @@ class ZscalerAPIError(Exception):
         if self.error_message:
             message_parts.append(self.error_message)
         if self.params:
-            message_parts.append(f"Parameters: {', '.join(self.params)}")
+            # Handle mixed types in params (lists and strings) safely
+            param_strings = []
+            for param in self.params:
+                if isinstance(param, list):
+                    # Flatten lists and join with commas
+                    param_strings.append(', '.join(str(item) for item in param))
+                else:
+                    # Convert non-list items to strings
+                    param_strings.append(str(param))
+            message_parts.append(f"Parameters: {', '.join(param_strings)}")
 
         self.message = " ".join(message_parts)
         super().__init__(self.message)  # ✅ This is what makes it raise-able

{zscaler_sdk_python-1.7.9 → zscaler_sdk_python-1.8.0}/zscaler/helpers.py

@@ -314,3 +314,36 @@ def convert_keys_to_camel_case(data):
         return [convert_keys_to_camel_case(item) for item in data]
     else:
         return data
+
+
+def convert_keys_to_camel_case_selective(data, preserve_snake_case_keys=None):
+    """
+    Recursively convert keys to camelCase while preserving specific snake_case keys.
+    This function allows users to use snake_case for all attributes, and only converts
+    to camelCase if the attribute is NOT in the preserve_snake_case_keys set.
+    
+    Args:
+        data: Dictionary or list to convert
+        preserve_snake_case_keys: Set of keys that should remain in snake_case
+    
+    Returns:
+        Converted data with selective key preservation
+    """
+    if preserve_snake_case_keys is None:
+        preserve_snake_case_keys = set()
+    
+    if isinstance(data, dict):
+        result = {}
+        for k, v in data.items():
+            # Check if this key should be preserved in snake_case
+            if k in preserve_snake_case_keys:
+                # Keep as snake_case
+                result[k] = convert_keys_to_camel_case_selective(v, preserve_snake_case_keys)
+            else:
+                # Convert to camelCase
+                result[to_lower_camel_case(k)] = convert_keys_to_camel_case_selective(v, preserve_snake_case_keys)
+        return result
+    elif isinstance(data, list):
+        return [convert_keys_to_camel_case_selective(item, preserve_snake_case_keys) for item in data]
+    else:
+        return data

{zscaler_sdk_python-1.7.9 → zscaler_sdk_python-1.8.0}/zscaler/request_executor.py

@@ -119,6 +119,10 @@ class RequestExecutor:
 
         exceptions.raise_exception = self._config["client"].get("raiseException", False)
         self._custom_headers = {}
+        
+        # Track whether any mutations (POST/PUT/DELETE) have occurred during this session
+        # This is used to determine if deauthentication is needed for ZIA/ZTW services
+        self._mutations_occurred = False
 
     def get_base_url(self, endpoint: str) -> str:
         """
@@ -302,6 +306,14 @@ class RequestExecutor:
         if "/zdx/" in endpoint:
             return body  # Do not convert ZDX requests to camelCase
 
+        # Special handling for ZCC service - use selective conversion
+        if "/zcc/" in endpoint and body:
+            from zscaler.helpers import convert_keys_to_camel_case_selective
+            from zscaler.zcc.models.webpolicy import WebPolicy
+            # Use the WebPolicy's snake_case keys for selective conversion
+            body = convert_keys_to_camel_case_selective(body, WebPolicy.SNAKE_CASE_KEYS)
+            return body
+
         # Preserve existing logic for other services
         if body:
             body = convert_keys_to_camel_case(body)
@@ -513,6 +525,13 @@ class RequestExecutor:
             logger.warning("Request Timeout exceeded.")
             return None, None, None, Exception("Request Timeout exceeded.")
 
+        # Track mutations (POST/PUT/DELETE) for ZIA/ZTW deauthentication logic
+        if request["method"].upper() in ["POST", "PUT", "DELETE"]:
+            self._mutations_occurred = True
+            logger.debug(f"Mutation detected: {request['method']} request to {request['url']}")
+        else:
+            logger.debug(f"Non-mutation request: {request['method']} request to {request['url']} (mutations_occurred={self._mutations_occurred})")
+
         # Perform the actual HTTP request
         response, error = self._http_client.send_request(request)
 
@@ -632,11 +651,23 @@ class RequestExecutor:
         logger.debug("Getting custom headers.")
         return self._custom_headers
 
+    def has_mutations_occurred(self):
+        """
+        Check if any mutations (POST/PUT/DELETE) have occurred during this session.
+        
+        Returns:
+            bool: True if mutations occurred, False otherwise.
+        """
+        return self._mutations_occurred
+
     def deauthenticate(self, service_type=None):
         """
         Deauthenticate from Zscaler services that support session-based authentication.
         Currently supports ZIA and ZTW services.
         
+        For ZIA service, deauthentication is only performed if mutations (POST/PUT/DELETE) 
+        have occurred during the session. GET-only sessions do not require deauthentication.
+        
         Args:
             service_type (str, optional): The service type to deauthenticate from.
                 If None, will attempt to determine from the current configuration.
@@ -648,6 +679,11 @@ class RequestExecutor:
             logger.debug(f"Deauthentication not supported for service: {service_type}")
             return False
         
+        # For ZIA service, only deauthenticate if mutations occurred
+        if service_type.lower() == "zia" and not self._mutations_occurred:
+            logger.debug("ZIA service: No mutations occurred during session, skipping deauthentication")
+            return True
+        
         try:
             # Determine the base URL and endpoint based on service type
             if service_type.lower() == "zia":