zscaler-sdk-python 1.7.6__tar.gz → 1.7.8__tar.gz

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/PKG-INFO

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

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/pyproject.toml

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

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/__init__.py

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

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/helpers.py

@@ -152,6 +152,7 @@ def to_lower_camel_case(string):
     FIELD_EXCEPTIONS = {
         "predefined_adp_controls": "predefinedADPControls",
         "surrogate_ip": "surrogateIP",
+        "surrogate_ip_enforced_for_known_browsers": "surrogateIPEnforcedForKnownBrowsers",
         "internal_ip_range": "internalIpRange",
         "start_ip_address": "startIPAddress",
         "end_ip_address": "endIPAddress",

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/oneapi_response.py

@@ -8,7 +8,6 @@ logger = logging.getLogger(__name__)
 class ZscalerAPIResponse:
     """
     Class for defining the wrapper of a Zscaler API response.
-    Inspired by the Okta approach, this class only returns the initial page of results.
     The user can check if more pages exist with `has_next()` and fetch them on-demand using `next()`.
     """
 
@@ -118,7 +117,7 @@ class ZscalerAPIResponse:
 
     def get_headers(self):
         """
-        Returns the response body of the Okta API Response.
+        Returns the response body of the Zscaler API Response.
 
         Returns:
             CIMultiDictProxy: dict-like object
@@ -128,7 +127,7 @@ class ZscalerAPIResponse:
 
     def get_body(self):
         """
-        Returns the response body of the Okta API Response.
+        Returns the response body of the Zscaler API Response.
 
         Returns:
             dict: Dictionary format of response

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/request_executor.py

@@ -651,16 +651,10 @@ class RequestExecutor:
         try:
             # Determine the base URL and endpoint based on service type
             if service_type.lower() == "zia":
-                if self.cloud and self.cloud != "production":
-                    base_url = f"https://api.{self.cloud}.zsapi.net"
-                else:
-                    base_url = "https://api.{self.cloud}.zsapi.net"
+                base_url = self.get_base_url("/zia/api/v1/authenticatedSession")
                 endpoint = "/zia/api/v1/authenticatedSession"
             elif service_type.lower() == "ztw":
-                if self.cloud and self.cloud != "production":
-                    base_url = f"https://api.{self.cloud}.zsapi.net"
-                else:
-                    base_url = "https://api.{self.cloud}.zsapi.net"
+                base_url = self.get_base_url("/ztw/api/v1/auth")
                 endpoint = "/ztw/api/v1/auth"
             
             url = f"{base_url}{endpoint}"

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/zia/cloud_firewall_rules.py

@@ -18,7 +18,6 @@ from zscaler.request_executor import RequestExecutor
 from zscaler.api_client import APIClient
 from zscaler.zia.models.cloud_firewall_rules import FirewallRule
 from zscaler.utils import format_url, transform_common_id_fields, reformat_params
-import json
 
 
 class FirewallPolicyAPI(APIClient):
@@ -39,7 +38,27 @@ class FirewallPolicyAPI(APIClient):
 
         Args:
             query_params {dict}: Map of query parameters for the request.
-                ``[query_params.search]`` {str}: Search string for filtering results by rule name.
+                ``[query_params.rule_name]`` {str}: Filters rules based on rule names using the specified keywords
+                ``[query_params.rule_label]`` {str}: Filters rules based on rule labels using the specified keywords
+                ``[query_params.rule_order]`` {str}: Filters rules based on rule order using the specified keywords
+                ``[query_params.rule_description]`` {str}: Filters rules based on rule descriptions using the specified keywords
+                ``[query_params.rule_action]`` {str}: Filters rules based on rule actions using the specified keywords
+                ``[query_params.location]`` {str}: Filters rules based on locations using the specified keywords
+                ``[query_params.department]`` {str}: Filters rules based on user departments using the specified keywords
+                ``[query_params.group]`` {str}: Filters rules based on user groups using the specified keywords
+                ``[query_params.user]`` {str}: Filters rules based on users using the specified keywords
+                ``[query_params.device]`` {str}: Filters rules based on devices using the specified keywords
+                ``[query_params.device_group]`` {str}: Filters rules based on device groups using the specified keywords
+                ``[query_params.device_trust_level]`` {str}: Filters rules based on device trust levels using the specified keywords
+                ``[query_params.src_ips]`` {str}: Filters rules based on source IP addresses using the specified keywords
+                ``[query_params.dest_addresses]`` {str}: Filters rules based on destination IP addresses using the specified keywords
+                ``[query_params.src_ip_groups]`` {str}: Filters rules based on source IP groups using the specified keywords
+                ``[query_params.dest_ip_groups]`` {str}: Filters rules based on destination IP groups using the specified keywords
+                ``[query_params.nw_application]`` {str}: Filters rules based on network applications using the specified keywords
+                ``[query_params.nw_services]`` {str}: Filters rules based on network services using the specified keywords
+                ``[query_params.dest_ip_categories]`` {str}: Filters rules based on destination URL categories using the specified keywords
+                ``[query_params.page]`` {str}: Specifies the page offset
+                ``[query_params.page_size]`` {str}: Specifies the page size. The default size is set to 5,000, if not specified.
 
         Returns:
             tuple: A tuple containing (list of firewall rules instances, Response, error)
@@ -209,7 +228,6 @@ class FirewallPolicyAPI(APIClient):
 
         body = kwargs
 
-        # Convert 'enabled' to 'state' (ENABLED/DISABLED) if it's present in the payload
         if "enabled" in body:
             body["state"] = "ENABLED" if body.pop("enabled") else "DISABLED"
 

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/zia/models/location_management.py

@@ -39,6 +39,7 @@ class LocationManagement(ZscalerObject):
             self.up_bandwidth = config["upBandwidth"] if "upBandwidth" in config else None
             self.dn_bandwidth = config["dnBandwidth"] if "dnBandwidth" in config else None
             self.country = config["country"] if "country" in config else None
+            self.state = config["state"] if "state" in config else None
             self.language = config["language"] if "language" in config else None
             self.tz = config["tz"] if "tz" in config else None
             self.geo_override = config["geoOverride"] if "geoOverride" in config else False
@@ -66,11 +67,18 @@ class LocationManagement(ZscalerObject):
                 or False  # ← fallback
             )
 
+            self.surrogate_ip_enforced_for_known_browsers = (
+                config.get("surrogate_ip_enforced_for_known_browsers")  # ← used by the converted keys
+                or config.get("surrogateIpEnforcedForKnownBrowsers")  # ← if not snake_cased
+                or config.get("surrogateIPEnforcedForKnownBrowsers")  # ← raw from the API
+                or False  # ← fallback
+            )
+            
             self.cookies_and_proxy = config["cookiesAndProxy"] if "cookiesAndProxy" in config else None
             self.idle_time_in_minutes = config["idleTimeInMinutes"] if "idleTimeInMinutes" in config else None
             self.display_time_unit = config["displayTimeUnit"] if "displayTimeUnit" in config else None
-            self.surrogate_ip_enforced_for_known_browsers = (
-                config["surrogateIPEnforcedForKnownBrowsers"] if "surrogateIPEnforcedForKnownBrowsers" in config else False
+            self.surrogate_refresh_time_unit = (
+                config["surrogateRefreshTimeUnit"] if "surrogateRefreshTimeUnit" in config else None
             )
             self.surrogate_refresh_time_in_minutes = (
                 config["surrogateRefreshTimeInMinutes"] if "surrogateRefreshTimeInMinutes" in config else None
@@ -106,7 +114,8 @@ class LocationManagement(ZscalerObject):
             self.basic_auth_enabled = config["basicAuthEnabled"] if "basicAuthEnabled" in config else False
 
             self.digest_auth_enabled = config["digestAuthEnabled"] if "digestAuthEnabled" in config else False
-
+            self.ports = config["ports"] if "ports"  in config else None
+            
             # Handling nested lists and collections
             self.static_location_groups = ZscalerCollection.form_list(
                 config["staticLocationGroups"] if "staticLocationGroups" in config else [], common.CommonIDName
@@ -161,6 +170,7 @@ class LocationManagement(ZscalerObject):
             self.up_bandwidth = None
             self.dn_bandwidth = None
             self.country = None
+            self.state = None
             self.language = None
             self.tz = None
             self.geo_override = False
@@ -199,6 +209,7 @@ class LocationManagement(ZscalerObject):
             self.extranet = None
             self.extranet_ip_pool = None
             self.extranet_dns = None
+            self.ports = None
             self.static_location_groups = []
             self.dynamic_location_groups = []
             self.vpn_credentials = []
@@ -217,6 +228,7 @@ class LocationManagement(ZscalerObject):
             "upBandwidth": self.up_bandwidth,
             "dnBandwidth": self.dn_bandwidth,
             "country": self.country,
+            "state": self.state,
             "language": self.language,
             "tz": self.tz,
             "geoOverride": self.geo_override,
@@ -234,6 +246,7 @@ class LocationManagement(ZscalerObject):
             "displayTimeUnit": self.display_time_unit,
             "surrogateIPEnforcedForKnownBrowsers": self.surrogate_ip_enforced_for_known_browsers,
             "surrogateRefreshTimeInMinutes": self.surrogate_refresh_time_in_minutes,
+            "surrogateRefreshTimeUnit": self.surrogate_refresh_time_unit,
             "kerberosAuth": self.kerberos_auth,
             "basicAuthEnabled": self.basic_auth_enabled,
             "digestAuthEnabled": self.digest_auth_enabled,
@@ -255,6 +268,7 @@ class LocationManagement(ZscalerObject):
             "ipAddresses": self.ip_addresses,
             "ipv6Enabled": self.ipv6_enabled,
             "extranet": self.extranet,
+            "ports": self.ports,
             "extranetIpPool": self.extranet_ip_pool,
             "extranetDns": self.extranet_dns,
             "defaultExtranetTsPool": self.default_extranet_ts_pool,

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/ztw/activation.py

@@ -31,7 +31,7 @@ class ActivationAPI(APIClient):
         super().__init__()
         self._request_executor: RequestExecutor = request_executor
 
-    def activate(self, force: bool = False) -> tuple:
+    def activate(self, force: bool = False, **kwargs) -> tuple:
         """
         Activate the configuration.
 
@@ -60,8 +60,10 @@ class ActivationAPI(APIClient):
 
         api_url = format_url(f"{self._ztw_base_endpoint}{endpoint_path}")
 
+        body = kwargs
+
         # Create the request
-        request, error = self._request_executor.create_request(http_method, api_url, body={}, headers={}, params={})
+        request, error = self._request_executor.create_request(http_method, api_url, body=body, headers={}, params={})
         if error:
             return (None, None, error)
 

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/ztw/ip_destination_groups.py

@@ -87,27 +87,22 @@ class IPDestinationGroupsAPI(APIClient):
 
         query_params = query_params or {}
 
-        # Add excludeType to query_params if it's provided
         if exclude_type:
             query_params["excludeType"] = exclude_type
 
-        # Prepare request body and headers
         body = {}
         headers = {}
 
-        # Create the request
         request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=query_params)
 
         if error:
             return (None, None, error)
 
-        # Execute the request
         response, error = self._request_executor.execute(request)
 
         if error:
             return (None, response, error)
 
-        # Parse the response into IPDestinationGroups instances
         try:
             result = []
             for item in response.get_results():

{zscaler_sdk_python-1.7.6 → zscaler_sdk_python-1.7.8}/zscaler/ztw/nw_service_groups.py

@@ -17,7 +17,7 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 from zscaler.request_executor import RequestExecutor
 from zscaler.api_client import APIClient
 from zscaler.ztw.models.nw_service_groups import NetworkServiceGroups
-from zscaler.utils import format_url, transform_common_id_fields, reformat_params
+from zscaler.utils import format_url
 
 
 class NWServiceGroupsAPI(APIClient):