zscaler-sdk-python 1.9.6__tar.gz → 1.9.8__tar.gz

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/PKG-INFO

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

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/pyproject.toml

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

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/request_executor.py

@@ -448,7 +448,19 @@ class RequestExecutor:
 
         if response.status_code == 204:
             logger.debug(f"Received 204 No Content from {request['url']}")
-            return None, None
+            # Return a response object even for 204 No Content (per Okta SDK pattern)
+            # This allows users to check response.status_code for delete operations
+            return (
+                ZscalerAPIResponse(
+                    request_executor=self,
+                    req=request,
+                    res_details=response,
+                    response_body={},  # Empty body for 204
+                    data_type=response_type,
+                    service_type=request.get("service_type", ""),
+                ),
+                None,
+            )
 
         # If raw response is requested, return it for file download purposes
         if return_raw_response:

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/administrator_controller.py

@@ -256,8 +256,8 @@ class AdministratorControllerAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (AdministratorController({"id": admin_id}), None, None)
+        if response is None or not response.get_body():
+            return (AdministratorController({"id": admin_id}), response, None)
 
         try:
             result = AdministratorController(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/api_keys.py

@@ -259,8 +259,8 @@ class ApiKeysAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ApiKeys({"id": key_id}), None, None)
+        if response is None or not response.get_body():
+            return (ApiKeys({"id": key_id}), response, None)
 
         try:
             result = ApiKeys(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_connector_groups.py

@@ -418,8 +418,8 @@ class AppConnectorGroupAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (AppConnectorGroup({"id": group_id}), None, None)
+        if response is None or not response.get_body():
+            return (AppConnectorGroup({"id": group_id}), response, None)
 
         try:
             result = AppConnectorGroup(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_connector_schedule.py

@@ -213,9 +213,9 @@ class AppConnectorScheduleAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
+        if response is None or not response.get_body():
             # Return a meaningful result to indicate success
-            return (AppConnectorSchedule({"id": scheduler_id}), None, None)
+            return (AppConnectorSchedule({"id": scheduler_id}), response, None)
 
         # Parse the response into an AppConnectorGroup instance
         try:

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_connectors.py

@@ -193,8 +193,8 @@ class AppConnectorControllerAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (AppConnectorController({"id": connector_id}), None, None)
+        if response is None or not response.get_body():
+            return (AppConnectorController({"id": connector_id}), response, None)
 
         try:
             result = AppConnectorController(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_protection.py

@@ -424,8 +424,8 @@ class InspectionControllerAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
-            return (AppProtectionProfile({"id": profile_id}), None, None)
+        if response is None or not response.get_body():
+            return (AppProtectionProfile({"id": profile_id}), response, None)
 
         try:
             result = AppProtectionProfile(self.form_response_body(response.get_body()))
@@ -517,8 +517,8 @@ class InspectionControllerAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
-            return (AppProtectionProfile({"id": profile_id}), None, None)
+        if response is None or not response.get_body():
+            return (AppProtectionProfile({"id": profile_id}), response, None)
 
         # Parse the response into an InspectionProfile instance
         try:
@@ -781,8 +781,8 @@ class InspectionControllerAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
-            return (CustomControls({"id": control_id}), None, None)
+        if response is None or not response.get_body():
+            return (CustomControls({"id": control_id}), response, None)
 
         try:
             result = CustomControls(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_segments_ba.py

@@ -471,8 +471,8 @@ class ApplicationSegmentBAAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ApplicationSegments({"id": segment_id}), None, None)
+        if response is None or not response.get_body():
+            return (ApplicationSegments({"id": segment_id}), response, None)
 
         try:
             result = ApplicationSegments(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_segments_ba_v2.py

@@ -430,8 +430,8 @@ class AppSegmentsBAV2API(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ApplicationSegments({"id": segment_id}), None, None)
+        if response is None or not response.get_body():
+            return (ApplicationSegments({"id": segment_id}), response, None)
 
         try:
             result = ApplicationSegments(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_segments_inspection.py

@@ -466,8 +466,8 @@ class AppSegmentsInspectionAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ApplicationSegments({"id": segment_id}), None, None)
+        if response is None or not response.get_body():
+            return (ApplicationSegments({"id": segment_id}), response, None)
 
         try:
             result = ApplicationSegments(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/app_segments_pra.py

@@ -425,8 +425,8 @@ class AppSegmentsPRAAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ApplicationSegments({"id": segment_id}), None, None)
+        if response is None or not response.get_body():
+            return (ApplicationSegments({"id": segment_id}), response, None)
 
         try:
             result = ApplicationSegments(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/application_segment.py

@@ -463,8 +463,8 @@ class ApplicationSegmentAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ApplicationSegments({"id": segment_id}), None, None)
+        if response is None or not response.get_body():
+            return (ApplicationSegments({"id": segment_id}), response, None)
 
         try:
             result = ApplicationSegments(self.form_response_body(response.get_body()))
@@ -951,8 +951,8 @@ class ApplicationSegmentAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (WeightedLBConfig({"id": segment_id}), None, None)
+        if response is None or not response.get_body():
+            return (WeightedLBConfig({"id": segment_id}), response, None)
 
         try:
             result = WeightedLBConfig(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/browser_protection.py

@@ -218,8 +218,8 @@ class BrowserProtectionProfileAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (BrowserProtectionProfile({"id": profile_id}), None, None)
+        if response is None or not response.get_body():
+            return (BrowserProtectionProfile({"id": profile_id}), response, None)
 
         try:
             result = BrowserProtectionProfile(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/c2c_ip_ranges.py

@@ -272,8 +272,8 @@ class IPRangesAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (IpRanges({"id": range_id}), None, None)
+        if response is None or not response.get_body():
+            return (IpRanges({"id": range_id}), response, None)
 
         try:
             result = IpRanges(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/cbi_banner.py

@@ -210,9 +210,9 @@ class CBIBannerAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
+        if response is None or not response.get_body():
             # Return a meaningful result to indicate success
-            return (CBIBanner({"id": banner_id}), None, None)
+            return (CBIBanner({"id": banner_id}), response, None)
 
         try:
             result = CBIBanner(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/cbi_profile.py

@@ -337,8 +337,8 @@ class CBIProfileAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
-            return (CBIProfile({"id": profile_id}), None, None)
+        if response is None or not response.get_body():
+            return (CBIProfile({"id": profile_id}), response, None)
 
         try:
             result = CBIProfile(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/certificates.py

@@ -303,9 +303,9 @@ class CertificatesAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
+        if response is None or not response.get_body():
             # Return a meaningful result to indicate success
-            return (Certificate({"id": certificate_id}), None, None)
+            return (Certificate({"id": certificate_id}), response, None)
 
         try:
             result = Certificate(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/config_override_controller.py

@@ -207,8 +207,8 @@ class ConfigOverrideControllerAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (ConfigOverrideController({"id": config_id}), None, None)
+        if response is None or not response.get_body():
+            return (ConfigOverrideController({"id": config_id}), response, None)
 
         try:
             result = ConfigOverrideController(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/emergency_access.py

@@ -259,8 +259,8 @@ class EmergencyAccessAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
-            return (EmergencyAccessUser({"id": user_id}), None, None)
+        if response is None or not response.get_body():
+            return (EmergencyAccessUser({"id": user_id}), response, None)
 
         try:
             result = EmergencyAccessUser(self.form_response_body(response.get_body()))
@@ -306,8 +306,8 @@ class EmergencyAccessAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned
-        if response is None:
-            return (None, None, None)
+        if response is None or not response.get_body():
+            return (None, response, None)
 
         try:
             # Process the response to return an EmergencyAccessUser instance

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/enrollment_certificates.py

@@ -272,8 +272,8 @@ class EnrollmentCertificateAPI(APIClient):
         if error:
             return (None, response, error)
 
-        if response is None:
-            return (EnrollmentCertificate({"id": cert_id}), None, None)
+        if response is None or not response.get_body():
+            return (EnrollmentCertificate({"id": cert_id}), response, None)
 
         try:
             result = EnrollmentCertificate(self.form_response_body(response.get_body()))

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/legacy.py

@@ -254,45 +254,68 @@ class LegacyZPAClientHelper:
         Returns:
             Tuple[requests.Response, dict]: Response object and request details.
         """
-        try:
-            base_url = f"{self.baseurl}{path}"
+        from time import sleep
+
+        base_url = f"{self.baseurl}{path}"
+        attempts = 0
+        max_retries = 5
 
-            headers = self.headers.copy()
-            headers.update(self.request_executor.get_custom_headers())
-            if not headers.get("Authorization"):
-                self.refreshToken()
-                # Re-copy headers after refreshToken() to include x-partner-id if it was added
+        while attempts < max_retries:
+            try:
                 headers = self.headers.copy()
                 headers.update(self.request_executor.get_custom_headers())
-                headers["Authorization"] = f"Bearer {self.access_token}"
-
-            response = requests.request(
-                method=method,
-                url=base_url,
-                headers=headers,
-                json=json,
-                params=params,
-                timeout=self.timeout,
-            )
-
-            _, err = check_response_for_error(base_url, response, response.text)
-            if err:
-                raise err
-
-            logger.info("Legacy client request executed successfully. "
-                        "Status: %d, URL: %s", response.status_code, base_url)
-
-            return response, {
-                "method": method,
-                "url": base_url,
-                "params": params or {},
-                "headers": headers,
-                "json": json or {},
-            }
-
-        except requests.RequestException as error:
-            logger.error(f"Error sending request: {error}")
-            raise ValueError(f"Request execution failed: {error}")
+                if not headers.get("Authorization"):
+                    self.refreshToken()
+                    # Re-copy headers after refreshToken() to include x-partner-id if it was added
+                    headers = self.headers.copy()
+                    headers.update(self.request_executor.get_custom_headers())
+                    headers["Authorization"] = f"Bearer {self.access_token}"
+
+                response = requests.request(
+                    method=method,
+                    url=base_url,
+                    headers=headers,
+                    json=json,
+                    params=params,
+                    timeout=self.timeout,
+                )
+
+                # Handle 429 rate limiting with retry-after header
+                # ZPA API returns lowercase 'retry-after' header
+                if response.status_code == 429:
+                    # Check both header variants (lowercase and uppercase)
+                    retry_after = response.headers.get("retry-after") or response.headers.get("Retry-After")
+                    sleep_time = int(retry_after) if retry_after else 2
+                    logger.warning(f"Rate limit exceeded (429). Retrying in {sleep_time} seconds. "
+                                   f"(Attempt {attempts + 1}/{max_retries})")
+                    sleep(sleep_time)
+                    attempts += 1
+                    continue
+
+                _, err = check_response_for_error(base_url, response, response.text)
+                if err:
+                    raise err
+
+                logger.info("Legacy client request executed successfully. "
+                            "Status: %d, URL: %s", response.status_code, base_url)
+
+                return response, {
+                    "method": method,
+                    "url": base_url,
+                    "params": params or {},
+                    "headers": headers,
+                    "json": json or {},
+                }
+
+            except requests.RequestException as error:
+                logger.error(f"Request to {base_url} failed: {error}")
+                if attempts == max_retries - 1:
+                    raise ValueError(f"Request execution failed: {error}")
+                logger.warning(f"Retrying... ({attempts + 1}/{max_retries})")
+                attempts += 1
+                sleep(5)
+
+        raise ValueError("Request execution failed after maximum retries.")
 
     def set_session(self, session: Any) -> None:
         """Dummy method for compatibility with the request executor."""

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/lss.py

@@ -407,9 +407,9 @@ class LSSConfigControllerAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
+        if response is None or not response.get_body():
             # Return a meaningful result to indicate success
-            return (LSSResourceModel({"id": lss_config_id}), None, None)
+            return (LSSResourceModel({"id": lss_config_id}), response, None)
 
         # Parse the response into an LSSConfig instance
         try:

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/microtenants.py

@@ -355,9 +355,9 @@ class MicrotenantsAPI(APIClient):
             return (None, response, error)
 
         # Handle case where no content is returned (204 No Content)
-        if response is None:
+        if response is None or not response.get_body():
             # Return a meaningful result to indicate success
-            return (Microtenant({"id": microtenant_id}), None, None)
+            return (Microtenant({"id": microtenant_id}), response, None)
 
         # Parse the response into an AppConnectorGroup instance
         try:

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/models/oauth2_user_code.py

@@ -14,8 +14,6 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 """
 
-# AUTO-GENERATED! DO NOT EDIT FILE DIRECTLY
-# SEE CONTRIBUTOR DOCUMENTATION
 from zscaler.oneapi_object import ZscalerObject
 from zscaler.oneapi_collection import ZscalerCollection
 

{zscaler_sdk_python-1.9.6 → zscaler_sdk_python-1.9.8}/zscaler/zpa/models/pra_portal.py

@@ -16,7 +16,7 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 from typing import Dict, List, Optional, Any, Union
 from zscaler.oneapi_object import ZscalerObject
-
+from zscaler.oneapi_collection import ZscalerCollection
 
 class PrivilegedRemoteAccessPortal(ZscalerObject):
     """
@@ -47,6 +47,9 @@ class PrivilegedRemoteAccessPortal(ZscalerObject):
             self.user_notification_enabled = config["userNotificationEnabled"] if "userNotificationEnabled" in config else None
             self.user_portal_gid = config["userPortalGid"] if "userPortalGid" in config else None
             self.user_portal_name = config["userPortalName"] if "userPortalName" in config else None
+            self.approval_reviewers = ZscalerCollection.form_list(
+                config["approvalReviewers"] if "approvalReviewers" in config else [], str
+            )
         else:
             self.id = None
             self.name = None
@@ -70,6 +73,7 @@ class PrivilegedRemoteAccessPortal(ZscalerObject):
             self.modified_time = None
             self.user_portal_gid = None
             self.user_portal_name = None
+            self.approval_reviewers = []
 
     def request_format(self) -> Dict[str, Any]:
         """
@@ -98,6 +102,7 @@ class PrivilegedRemoteAccessPortal(ZscalerObject):
             "userNotificationEnabled": self.user_notification_enabled,
             "userPortalGid": self.user_portal_gid,
             "userPortalName": self.user_portal_name,
+            "approvalReviewers": self.approval_reviewers,
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format