zscaler-sdk-python 1.4.0__tar.gz → 1.4.2__tar.gz

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/PKG-INFO

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

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/pyproject.toml

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

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/__init__.py

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

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/logger.py

@@ -24,7 +24,8 @@ def setup_logging(logger_name="zscaler-sdk-python", enabled=None, verbose=None):
 
     if not enabled:
         # If logging is not enabled, set up a null handler
-        logging.disable(logging.INFO)
+        # logging.disable(logging.INFO)
+        logging.getLogger(logger_name).addHandler(logging.NullHandler())
         return
 
     if verbose is None:

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/utils.py

@@ -51,7 +51,6 @@ reformat_params = [
     ("excluded_departments", "excludedDepartments"),
     ("excluded_groups", "excludedGroups"),
     ("excluded_users", "excludedUsers"),
-    ("source_ip_groups", "source_ip_groups"),
     ("dest_ip_groups", "destIpGroups"),
     ("dest_ipv6_groups", "destIpv6Groups"),
     ("groups", "groups"),
@@ -62,6 +61,9 @@ reformat_params = [
     ("location_groups", "locationGroups"),
     ("nw_application_groups", "nwApplicationGroups"),
     ("nw_service_groups", "nwServiceGroups"),
+    ("nw_services", "nwServices"),
+    ("source_ip_groups", "source_ip_groups"),
+    ("source_ip_groups", "sourceIpGroups"),
     ("src_ip_groups", "srcIpGroups"),
     ("src_ipv6_groups", "srcIpv6Groups"),
     ("proxy_gateway", "proxyGateway"),

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zcc/devices.py

@@ -438,7 +438,7 @@ class DevicesAPI(APIClient):
                 ``[query_params.page_size]`` {int}: Specifies the page size.
                     If not provided, the default page size is 30.
                     The max page size is 5000.
-                    
+
                 client_connector_version (list[str]): List of the client connector agent versions
                 os_type (int): Valid options are: ios, android, windows, macos, linux.
                 udids (list[str]): The list of udids for the devices to be removed

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zcc/legacy.py

@@ -11,26 +11,13 @@ from zscaler.utils import (
     is_token_expired,
     RateLimitExceededError
 )
-from zscaler.logger import setup_logging
 from zscaler.errors.response_checker import check_response_for_error
+from zscaler.logger import setup_logging
 
 # Setup the logger
 setup_logging(logger_name="zscaler-sdk-python")
 logger = logging.getLogger("zscaler-sdk-python")
 
-import os, time, urllib.parse, logging, requests
-from datetime import datetime, timedelta
-from zscaler import __version__
-from zscaler.user_agent import UserAgent
-from zscaler.cache.no_op_cache import NoOpCache
-from zscaler.cache.cache import Cache
-from zscaler.cache.zscaler_cache import ZscalerCache
-from zscaler.errors.response_checker import check_response_for_error
-from zscaler.ratelimiter.ratelimiter import RateLimiter
-from zscaler.utils import is_token_expired
-
-logger = logging.getLogger("zscaler-sdk-python")
-
 
 class LegacyZCCClientHelper:
     """
@@ -148,7 +135,7 @@ class LegacyZCCClientHelper:
             _, err = check_response_for_error(url, resp, resp.text)
             if err:
                 raise err
-            
+
             logger.info("Login attempt with status: %d", resp.status_code)
             return resp
         except Exception as e:
@@ -317,7 +304,6 @@ class LegacyZCCClientHelper:
             "json": json or {},
         }
 
-
     def set_session(self, session):
         """Dummy method for compatibility with the request executor."""
         self._session = session

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zia/bandwidth_classes.py

@@ -91,7 +91,6 @@ class BandwidthClassesAPI(APIClient):
 
         return (results, response, None)
 
-
     def list_classes_lite(self) -> tuple:
         """
         Fetches a specific bandwidth class lite by ID.

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zia/bandwidth_control_rules.py

@@ -36,7 +36,7 @@ class BandwidthControlRulesAPI(APIClient):
         List bandwidth control rules in your organization.
         If the `search` parameter is provided, the function filters the rules client-side.
 
-        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access 
+        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access
         token included in the request's Authorization header.
 
         Args:
@@ -109,7 +109,7 @@ class BandwidthControlRulesAPI(APIClient):
         """
         Fetches a specific bandwidth control rule lite.
 
-        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access 
+        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access
         token included in the request's Authorization header.
 
         Args:
@@ -164,7 +164,7 @@ class BandwidthControlRulesAPI(APIClient):
         """
         Returns information for the specified bandwidth control rule.
 
-        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access 
+        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access
         token included in the request's Authorization header.
 
         Args:
@@ -216,7 +216,7 @@ class BandwidthControlRulesAPI(APIClient):
         """
         Adds a new cloud bandwidth control rule.
 
-        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access 
+        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access
         token included in the request's Authorization header.
 
         Args:
@@ -296,7 +296,7 @@ class BandwidthControlRulesAPI(APIClient):
         """
         Updates an existing bandwidth control rule.
 
-        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access 
+        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access
         token included in the request's Authorization header.
 
         Args:
@@ -379,7 +379,7 @@ class BandwidthControlRulesAPI(APIClient):
         """
         Deletes the specified bandwidth control rule.
 
-        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access 
+        Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access
         token included in the request's Authorization header.
 
         Args:

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zia/cloud_firewall.py

@@ -561,7 +561,7 @@ class FirewallResourcesAPI(APIClient):
             ...     print(f"Error updating group: {error}")
             ...     return
             ... print(f"Group updated successfully: {updated_group.as_dict()}")
-            
+
             Update a Destination IP Group with country and url category for the US:
 
             >>> updated_group, _, error = client.zia.cloud_firewall.update_ip_destination_group(

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zia/legacy.py

@@ -307,7 +307,6 @@ class LegacyZIAClientHelper:
         """Dummy method for compatibility with the request executor."""
         self._session = session
 
-
     @property
     def activate(self):
         """
@@ -417,7 +416,7 @@ class LegacyZIAClientHelper:
         from zscaler.zia.shadow_it_report import ShadowITAPI
 
         return ShadowITAPI(self.request_executor)
-    
+
     @property
     def cloud_browser_isolation(self):
         """
@@ -951,4 +950,4 @@ class LegacyZIAClientHelper:
         return self.request_executor.get_custom_headers()
 
     def get_default_headers(self):
-        return self.request_executor.get_default_headers()
+        return self.request_executor.get_default_headers()

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zia/models/cloud_firewall_rules.py

@@ -87,7 +87,7 @@ class FirewallRule(ZscalerObject):
             self.app_service_groups = ZscalerCollection.form_list(
                 config["appServiceGroups"] if "appServiceGroups" in config else [], app_services.AppServices
             )
-            self.nw_services = ZscalerCollection.form_list(
+            self.app_services = ZscalerCollection.form_list(
                 config["appServices"] if "appServices" in config else [], app_services.AppServices
             )
             self.locations = ZscalerCollection.form_list(
@@ -128,7 +128,7 @@ class FirewallRule(ZscalerObject):
 
             self.devices = ZscalerCollection.form_list(config["devices"] if "devices" in config else [], devices.Devices)
 
-            self.nw_services = ZscalerCollection.form_list(
+            self.labels = ZscalerCollection.form_list(
                 config["labels"] if "labels" in config else [], rule_labels.RuleLabels
             )
 

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zia/zia_service.py

@@ -177,7 +177,7 @@ class ZIAService:
 
         """
         return ShadowITAPI(self._request_executor)
-    
+
     @property
     def cloud_nss(self):
         """

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/app_protection.py

@@ -223,7 +223,7 @@ class InspectionControllerAPI(APIClient):
         """
         )
         version = kwargs.pop("predefined_controls_version", "OWASP_CRS/3.3.0")
-        
+
         groups, _, err = self.list_predef_controls(query_params={"version": version})
         if err or not groups:
             return None, None, f"Failed to retrieve predefined control groups: {err}"
@@ -268,7 +268,7 @@ class InspectionControllerAPI(APIClient):
 
         try:
             created_profile = AppProtectionProfile(self.form_response_body(response.get_body()))
-            
+
             # Fetch the full created profile explicitly
             profile_id = created_profile.id
             full_profile, _, fetch_error = self.get_profile(profile_id)
@@ -297,7 +297,7 @@ class InspectionControllerAPI(APIClient):
         """
         )
         version = kwargs.pop("predefined_controls_version", "OWASP_CRS/3.3.0")
-        
+
         # Get default predefined controls
         groups, _, err = self.list_predef_controls(query_params={"version": version})
         if err or not groups:
@@ -483,8 +483,14 @@ class InspectionControllerAPI(APIClient):
         if kwargs.get("predefined_controls"):
             predefined_controls_extra = kwargs.pop("predefined_controls")
             payload["predefinedControls"].extend(
-                [{"id": control["id"], "action": control["action"], "default_action": control["action"]}
-                for control in predefined_controls_extra]
+                [
+                    {
+                        "id": control["id"],
+                        "action": control["action"],
+                        "default_action": control["action"]
+                    }
+                    for control in predefined_controls_extra
+                ]
             )
 
         # Add custom controls if provided
@@ -582,7 +588,7 @@ class InspectionControllerAPI(APIClient):
 
         Returns:
             PredefinedInspectionControlResource: The corresponding predefined control object.
-            
+
         Examples:
             >>> predef_controls, _, err = client.zpa.app_protection.get_all_predef_control(
             ... query_params={'version': 'OWASP_CRS/4.8.0'})
@@ -628,7 +634,7 @@ class InspectionControllerAPI(APIClient):
 
         Returns:
             AppProtectionCustomControl: The corresponding predefined control object.
-            
+
         Examples:
             >>> fetched_predf_control, _, err = client.zpa.app_protection.get_predef_control(control_id='72057594037928524')
             >>> if err:
@@ -837,53 +843,24 @@ class InspectionControllerAPI(APIClient):
                 print(f"Fetched predefined control adp: {fetched_predf_control.as_dict()}")
 
         """
-        # SUPPORTED = {"OWASP_CRS/4.8.0", "OWASP_CRS/3.3.5", "OWASP_CRS/3.3.0"}
-        # qp = dict(query_params or {})
-
-        # version = qp.get("version")
-        # if version is None:
-        #     return (None, None,
-        #             ValueError("'version' is required in query_params"))
-        # if version not in SUPPORTED:
-        #     return (None, None,
-        #             ValueError(f"Unsupported version '{version}'. "
-        #                     f"Supported values: {', '.join(sorted(SUPPORTED))}"))
-
-        # search_field = qp.pop("search_field", None)
-        # if "search" in qp and search_field:
-        #     qp["search"] = f"{qp['search']}+EQ+{search_field}"
-
-        # base_url = f"{self._zpa_base_endpoint}/inspectionControls/predefined"
-        # query_str = "&".join(f"{k}={quote(str(v), safe='')}" for k, v in qp.items())
-        # api_url = f"{base_url}?{query_str}"
-
-        # request, err = self._request_executor.create_request("GET", api_url)
-        # if err:
-        #     return (None, None, err)
-
-        # response, err = self._request_executor.execute(request)
-        # if err:
-        #     return (None, response, err)
-
-        # try:
-        #     body = self.form_response_body(response.get_body())
-        #     result = PredefinedInspectionControlResource(body)
-        # except Exception as exc:
-        #     return (None, response, exc)
-
-        # return (result, response, None)
-
         SUPPORTED = {"OWASP_CRS/4.8.0", "OWASP_CRS/3.3.5", "OWASP_CRS/3.3.0"}
         qp = dict(query_params or {})
 
         version = qp.get("version")
         if version is None:
-            return (None, None,
-                    ValueError("'version' is required in query_params"))
+            return (
+                None,
+                None,
+                ValueError("'version' is required in query_params")
+            )
         if version not in SUPPORTED:
-            return (None, None,
-                    ValueError(f"Unsupported version '{version}'. "
-                            f"Supported values: {', '.join(sorted(SUPPORTED))}"))
+            return (
+                None,
+                None,
+                ValueError(
+                    f"Unsupported version '{version}'. Supported values: {', '.join(sorted(SUPPORTED))}"
+                )
+            )
 
         search_field = qp.pop("search_field", None)
         if "search" in qp and search_field:

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/app_segments_ba.py

@@ -423,13 +423,16 @@ class ApplicationSegmentBAAPI(APIClient):
             for app in clientless_apps:
                 # Find the segment that matches the domain and belongs to this segment
                 matched_segment = next(
-                    (seg for seg in segments_list 
-                    if seg.domain == app.get("domain") and str(seg.app_id) == segment_id),
+                    (
+                        seg for seg in segments_list
+                        if seg.domain == app.get("domain") and str(seg.app_id) == segment_id
+                    ),
                     None
                 )
-                
+
                 if not matched_segment:
-                    return (None, None, f"Error: No matching clientless App found for domain '{app.get('domain')}' in existing segments.")
+                    return (None, None, f"Error: No matching clientless App found for domain \
+                        '{app.get('domain')}' in existing segments.")
 
                 # Update the app with required IDs
                 app["appId"] = segment_id

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/app_segments_ba_v2.py

@@ -310,7 +310,7 @@ class AppSegmentsBAV2API(APIClient):
            Create an application segment using **new TCP port format** (`tcp_port_range`):
 
             >>> updated_segment, _, err = client.zpa.app_segments_ba_v2.add_segment_ba(
-            ...     segment_id='1455863112',                
+            ...     segment_id='1455863112',
             ...     name=f"UpdatedBASegment_{random.randint(1000, 10000)}",
             ...     description=f"UpdatedBASegment_{random.randint(1000, 10000)}",
             ...     enabled=True,

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/application_segment.py

@@ -844,7 +844,7 @@ class ApplicationSegmentAPI(APIClient):
         except Exception as error:
             return (None, response, error)
         return (result, response, None)
-    
+
     def update_weighted_lb_config(self, segment_id: str, query_params=None, **kwargs) -> tuple:
         """
         Updates the Weighted Load Balancing configuration for the specified Application Segment.
@@ -868,7 +868,7 @@ class ApplicationSegmentAPI(APIClient):
             application_to_server_group_mappings (list of dict):
                 A list of mappings that define server groups and their associated weights and passive flags.
                 Each item must be a dictionary with the following keys:
-                
+
                 - `id` (str): The ID of the server group.
                 - `weight` (str): The weight assigned to this server group.
                 - `passive` (bool): Indicates whether the server group operates in passive mode.

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/emergency_access.py

@@ -40,12 +40,12 @@ class EmergencyAccessAPI(APIClient):
         Args:
             query_params {dict}: Map of query parameters for the request.
 
-                ``[query_params.page]`` {str}: Specifies the page number.
+                ``[query_params.page_id]`` {str}: Specifies the page number.
 
                 ``[query_params.page_size]`` {str}: Specifies the page size.
                     If not provided, the default page size is 20. The max page size is 500.
 
-                ``[query_params.search]`` {str}: Search string for filtering results.
+                ``[query_params.search]`` {str}: The search string used to support search by features and fields for the API.
                 ``[query_params.microtenant_id]`` {str}: The unique identifier of the microtenant of ZPA tenant.
 
         Returns:
@@ -53,7 +53,7 @@ class EmergencyAccessAPI(APIClient):
 
         Examples:
             >>> access_list, _, err = client.zpa.emergency_access.list_users(
-            ... query_params={'search': 'portal01', 'page': '1', 'page_size': '100'})
+            ... query_params={'search': 'first_name+EQ+Emily', 'page_id': '1', 'page_size': '100'})
             ... if err:
             ...     print(f"Error listing emergency access users: {err}")
             ...     return
@@ -70,9 +70,7 @@ class EmergencyAccessAPI(APIClient):
         )
 
         query_params = query_params or {}
-        query_params.update(kwargs)
-
-        microtenant_id = query_params.pop("microtenant_id", None)
+        microtenant_id = query_params.get("microtenant_id", None)
         if microtenant_id:
             query_params["microtenantId"] = microtenant_id
 
@@ -146,6 +144,7 @@ class EmergencyAccessAPI(APIClient):
             first_name (str): The first name of the emergency access user.
             last_name (str): The last name of the emergency access user.
             user_id (str): The unique identifier of the emergency access user.
+            update_enabled (bool): Indicates if the emergency access user can be updated (true) or not (false).
             activate_now (bool, optional): Indicates if the emergency access user is activated upon creation. Defaults to True.
 
         Returns:

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/microtenants.py

@@ -19,10 +19,6 @@ from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.microtenants import Microtenant
 from zscaler.zpa.models.microtenants import MicrotenantSearch
 from zscaler.utils import format_url
-import logging
-
-logging.basicConfig(level=logging.DEBUG)
-logger = logging.getLogger(__name__)
 
 
 class MicrotenantsAPI(APIClient):

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/models/app_protection_predefined_controls.py

@@ -19,6 +19,7 @@ from zscaler.oneapi_collection import ZscalerCollection
 from zscaler.zpa.models import app_protection_predefined_controls as app_protection_predefined_controls
 from zscaler.zpa.models import common as common
 
+
 class PredefinedInspectionControlResource(ZscalerObject):
     """
     A class for PredefinedInspectionControlResource objects.
@@ -32,20 +33,20 @@ class PredefinedInspectionControlResource(ZscalerObject):
             config (dict): A dictionary representing the configuration.
         """
         super().__init__(config)
-        
+
         # Initialize as empty list to ensure it's always iterable
         self._items = []
-        
+
         if config:
             self.control_group = config.get("controlGroup")
             self.default_group = config.get("defaultGroup")
-            
+
             # Store the raw config for iteration purposes
             if isinstance(config, list):
                 self._items = config
             elif isinstance(config, dict):
                 self._items = [config]
-            
+
             self.predefined_inspection_controls = ZscalerCollection.form_list(
                 config.get("predefinedInspectionControls", []),
                 PredefinedInspectionControls,

{zscaler_sdk_python-1.4.0 → zscaler_sdk_python-1.4.2}/zscaler/zpa/models/app_protection_profile.py

@@ -83,7 +83,7 @@ class AppProtectionProfile(ZscalerObject):
             self.predefined_api_controls = ZscalerCollection.form_list(
                 config["predefinedApiControls"] if "predefinedApiControls" in config else [], PredefinedAPIControls
             )
-            
+
             self.threatlabz_controls = ZscalerCollection.form_list(
                 config["threatlabzControls"] if "threatlabzControls" in config else [], ThreatLabzControls
             )
@@ -146,6 +146,7 @@ class AppProtectionProfile(ZscalerObject):
         parent_req_format.update(current_obj_format)
         return parent_req_format
 
+
 class ControlsInfo(ZscalerObject):
     """
     A class for ControlsInfo objects.
@@ -180,7 +181,8 @@ class ControlsInfo(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
-    
+
+
 class CustomControls(ZscalerObject):
     """
     A class for CustomControls objects.
@@ -249,7 +251,7 @@ class CustomControls(ZscalerObject):
             self.rules = ZscalerCollection.form_list(
                 config["rules"] if "rules" in config else [], InspectionRule
             )
-            
+
         else:
             self.action = None
             self.action_value = None
@@ -303,7 +305,7 @@ class CustomControls(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
-    
+
 
 class PredefinedControls(ZscalerObject):
     """
@@ -537,7 +539,8 @@ class PredefinedADPControls(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
-    
+
+
 class PredefinedAPIControls(ZscalerObject):
     """
     A class for PredefinedAPIControls objects.
@@ -589,7 +592,7 @@ class PredefinedAPIControls(ZscalerObject):
                 if "severity" in config else None
             self.version = config["version"] \
                 if "version" in config else None
-                
+
             self.associated_inspection_profile_names = ZscalerCollection.form_list(
                 config["associatedInspectionProfileNames"] if "associatedInspectionProfileNames" in config else [],
                 common.CommonIDName,
@@ -654,7 +657,7 @@ class PredefinedAPIControls(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
-    
+
 
 class ThreatLabzControls(ZscalerObject):
     """
@@ -758,7 +761,8 @@ class ThreatLabzControls(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
-    
+
+
 class WebSocketControls(ZscalerObject):
     """
     A class for WebSocketControls objects.
@@ -804,7 +808,7 @@ class WebSocketControls(ZscalerObject):
                 if "severity" in config else None
             self.version = config["version"] \
                 if "version" in config else None
-                
+
             self.associated_inspection_profile_names = ZscalerCollection.form_list(
                 config["associatedInspectionProfileNames"] if "associatedInspectionProfileNames" in config else [],
                 common.CommonIDName,
@@ -863,7 +867,8 @@ class WebSocketControls(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
-    
+
+
 class InspectionRule(ZscalerObject):
     """
     A class for InspectionRule objects.