zscaler-sdk-python 1.9.11__tar.gz → 1.9.13__tar.gz

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/PKG-INFO

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

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.11"
+version = "1.9.13"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -58,7 +58,7 @@ responses = ">=0.25.7"
 sphinx = ">=7.2.0"
 sphinx-autobuild = ">=2024.1.0"
 sphinx_rtd_theme = ">=1.3.0"
-wheel = ">=0.42.0"
+wheel = ">=0.46.0"
 
 [tool.poetry.extras]
 dev = ["black", "pytest", "pytest-asyncio", "pytest-mock", "pytest-recording", "pytest-cov", "pyfakefs", "isort", "wheel"]
@@ -87,3 +87,24 @@ max-line-length = 127
 
 [tool.isort]
 profile = "black"
+
+[tool.coverage.run]
+omit = [
+    "*/models/*",
+    "zscaler/*/models/*",
+    "tests/*",
+    "*/__init__.py",
+]
+
+[tool.coverage.report]
+omit = [
+    "*/models/*",
+    "zscaler/*/models/*",
+    "tests/*",
+    "*/__init__.py",
+]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise NotImplementedError",
+]

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/utils.py

@@ -91,6 +91,8 @@ reformat_params = [
     ("entity_group_ids", "entityGroups"),
     ("scope_entity_ids", "adminScopeScopeEntities"),
     ("supported_region_ids", "supportedRegions"),
+    ("src_workload_groups_ids", "srcWorkloadGroups"),
+    ("dest_workload_groups_ids", "destWorkloadGroups"),
 ]
 
 

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/zia/cloud_firewall.py

@@ -610,11 +610,13 @@ class FirewallResourcesAPI(APIClient):
         """
         )
 
+        query_params = query_params or {}
+
         body = {}
 
         body.update(kwargs)
 
-        request, error = self._request_executor.create_request(http_method, api_url, body, {}, {})
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, params=query_params)
         if error:
             return (None, None, error)
 

zscaler_sdk_python-1.9.13/zscaler/zia/models/sandbox.py

@@ -0,0 +1,86 @@
+"""
+Copyright (c) 2023, Zscaler Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+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
+from zscaler.zia.models import common
+
+
+class BehavioralAnalysisAdvancedSettings(ZscalerObject):
+    """
+    A class for Behavioral Analysis Advanced Settings objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the Behavioral Analysis Advanced Settings model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.md5_hash_value_list = ZscalerCollection.form_list(
+                config["md5HashValueList"] if "md5HashValueList" in config else [], MD5HashValueList
+            )
+        else:
+            self.md5_hash_value_list = []
+
+    def request_format(self) -> Dict[str, Any]:
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "md5HashValueList": self.md5_hash_value_list,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class MD5HashValueList(ZscalerObject):
+    """
+    A class for MD5 Hash Value List objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the MD5 Hash Value List model based on API response.
+        """
+        super().__init__(config)
+        if config:
+            self.url = config["url"] if "url" in config else None
+            self.url_comment = config["urlComment"] if "urlComment" in config else None
+            self.type = config["type"] if "type" in config else None
+        else:
+            self.url = None
+            self.url_comment = None
+            self.type = None
+
+    def request_format(self) -> Dict[str, Any]:
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "url": self.url,
+            "urlComment": self.url_comment,
+            "type": self.type,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/zia/rule_labels.py

@@ -277,3 +277,53 @@ class RuleLabelsAPI(APIClient):
         if error:
             return (None, response, error)
         return (None, response, None)
+
+    def get_rule_type_label(self, rule_type: str) -> APIResult[List[RuleLabels]]:
+        """
+        Retrieves a list of rule labels based on the specified rule type
+
+        Args:
+            rule_type (str): The type of rule to retrieve labels for. Only supported values are: URL_FILTERING, FIREWALL, CASB_DLP, CLOUD_APP_CONTROL, DATA_PROTECTION, GENAI, INDUSTRY_PEER, NEWS_FEED, RISK_SCORE, SANDBOX
+
+        Returns:
+            tuple: A tuple containing (list of Rule Labels instances, Response, error)
+
+        Examples:
+            Get Rule Labels for a specific rule type:
+
+            >>> fetched_labels, _, error = client.zia.rule_labels.get_rule_type_label('URL_FILTERING')
+            >>> if error:
+            ...     print(f"Error listing labels: {error}")
+            ...     return
+            ... print(f"Total labels found: {len(fetched_labels)}")
+            ... for label in fetched_labels:
+            ...     print(label.as_dict())
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /ruleLabels/ruleType/{rule_type}
+        """
+        )
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            result = []
+            for item in response.get_results():
+                result.append(RuleLabels(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/zia/sandbox.py

@@ -19,10 +19,12 @@ import mimetypes
 import time
 from zscaler.request_executor import RequestExecutor
 from zscaler.utils import format_url
+from zscaler.api_client import APIClient
 from zscaler.types import APIResult
+from zscaler.zia.models.sandbox import BehavioralAnalysisAdvancedSettings
 
 
-class CloudSandboxAPI:
+class CloudSandboxAPI(APIClient):
     """
     A Client object for the Cloud Sandbox resource.
     """
@@ -31,6 +33,7 @@ class CloudSandboxAPI:
     _zia_base_endpoint = "/zia/api/v1"
 
     def __init__(self, request_executor: "RequestExecutor") -> None:
+        super().__init__()
         self._request_executor: RequestExecutor = request_executor
 
     def submit_file(self, file_path: str, force: bool = False) -> APIResult[dict]:
@@ -268,10 +271,9 @@ class CloudSandboxAPI:
             return (None, response, error)
 
         try:
-            result = response.get_body()
+            result = BehavioralAnalysisAdvancedSettings(self.form_response_body(response.get_body()))
         except Exception as error:
             return (None, response, error)
-
         return (result, response, None)
 
     def get_file_hash_count(self) -> APIResult[dict]:
@@ -314,16 +316,33 @@ class CloudSandboxAPI:
 
         return (result, response, None)
 
-    def add_hash_to_custom_list(self, file_hashes_to_be_blocked: list) -> APIResult[dict]:
+    def add_hash_to_custom_list(
+        self,
+        md5_hash_value_list: List[Dict[str, str]],
+    ) -> APIResult[BehavioralAnalysisAdvancedSettings]:
         """
         Updates the custom list of MD5 file hashes that are blocked by Sandbox.
 
         Args:
-            file_hashes_to_be_blocked (:obj:`list` of :obj:`str`):
-                The list of MD5 Hashes to be added. Pass an empty list to clear the blocklist.
+            md5_hash_value_list (list[dict]): A list of MD5 hash entries to be blocked.
+                Each entry should be a dictionary with the following keys:
+                ``url`` (str): The MD5 hash value.
+                ``type`` (str): The type of hash, e.g., ``CUSTOM_FILEHASH_DENY`` or ``CUSTOM_FILEHASH_ALLOW``.
+                Pass an empty list to clear the blocklist.
 
         Returns:
-            tuple: A tuple containing the result, response, and error.
+            tuple: A tuple containing (BehavioralAnalysisAdvancedSettings, Response, error).
+
+        Examples:
+            Add MD5 hashes to the sandbox blocklist:
+
+            >>> hash_list = [
+            ...     {"url": "35e38d023b253c0cd9bd3e16afc362a7", "type": "CUSTOM_FILEHASH_DENY"},
+            ...     {"url": "f6c1cf98076457e742937240b29132d2", "type": "CUSTOM_FILEHASH_ALLOW"},
+            ... ]
+            >>> result, response, error = client.zia.sandbox.add_hash_to_custom_list(
+            ...     md5_hash_value_list=hash_list
+            ... )
         """
         http_method = "put".upper()
         api_url = format_url(
@@ -333,7 +352,7 @@ class CloudSandboxAPI:
             """
         )
 
-        payload = {"fileHashesToBeBlocked": file_hashes_to_be_blocked}
+        payload = {"md5HashValueList": md5_hash_value_list}
 
         request, error = self._request_executor.create_request(method=http_method, endpoint=api_url, body=payload)
 
@@ -344,5 +363,10 @@ class CloudSandboxAPI:
 
         if error:
             return (None, response, error)
-        time.sleep(2)
-        return self.get_behavioral_analysis()
+
+        try:
+            result = BehavioralAnalysisAdvancedSettings(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+
+        return (result, response, None)

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/zia/url_filtering.py

@@ -62,11 +62,18 @@ class URLFilteringAPI(APIClient):
             query_params {dict}: Map of query parameters for the request.
                 ``[query_params.search]`` {str}: Search string for filtering results by rule name.
 
+                ``[query_params.page]`` (int): Specifies the page offset.
+
+                ``[query_params.page_size]`` (int): Specifies the page size.
+                    The default size is 100, but the maximum size is 100.
+
         Returns:
             tuple: A tuple containing (list of url filtering rules instances, Response, error)
 
         Examples:
-        >>> rules_list, _, error = client.zia.url_filtering.list_rules()
+        >>> rules_list, _, error = client.zia.url_filtering.list_rules(
+        ... query_params={'page': 1, 'page_size': 10}
+        )
         >>> if error:
         ...     print(f"Error listing url filtering rules: {error}")
         ...     return
@@ -84,31 +91,26 @@ class URLFilteringAPI(APIClient):
 
         query_params = query_params or {}
 
-        local_search = query_params.pop("search", None)
-
         body = {}
         headers = {}
 
         request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=query_params)
+
         if error:
             return (None, None, error)
 
         response, error = self._request_executor.execute(request)
+
         if error:
             return (None, response, error)
 
         try:
-            results = []
+            result = []
             for item in response.get_results():
-                results.append(URLFilteringRule(self.form_response_body(item)))
-        except Exception as exc:
-            return (None, response, exc)
-
-        if local_search:
-            lower_search = local_search.lower()
-            results = [r for r in results if lower_search in (r.name.lower() if r.name else "")]
-
-        return (results, response, None)
+                result.append(URLFilteringRule(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
 
     def get_rule(
         self,

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/ztw/forwarding_rules.py

@@ -114,7 +114,7 @@ class ForwardingControlRulesAPI(APIClient):
             order (str): The order of the rule, defaults to adding rule to bottom of list.
             rank (str): The admin rank of the rule. Supported values 1-7
             forward_method (str): The type of traffic forwarding method selected from the available options
-            Supported Values: `INVALID`, `DIRECT`, `PROXYCHAIN`, `ZIA`, `ZPA`, `ECZPA`, `ECSELF`, `DROP`
+            Supported Values: `INVALID`, `DIRECT`, `PROXYCHAIN`, `ZIA`, `ZPA`, `ECZPA`, `ECSELF`, `DROP`, `LOCAL_SWITCH`
 
             state (str): The rule state. Accepted values are 'ENABLED' or 'DISABLED'.
             description (str): Additional information about the rule
@@ -141,6 +141,8 @@ class ForwardingControlRulesAPI(APIClient):
             nw_application_groups (list): IDs for network application groups.
             device_groups (list): Device groups managed using Zscaler Client Connector.
             devices (list): Devices managed using Zscaler Client Connector.
+            src_workload_groups_ids (list): IDs for source workload groups.
+            dest_workload_groups_ids (list): IDs for destination workload groups (Valid for LOCAL_SWITCH forward method).
 
             zpa_app_segments (list[dict]): **ZPA Application Segments applicable to the rule.**
                 - `external_id` (str): Indicates the external ID. Applicable only when this reference is of an external entity.
@@ -170,6 +172,7 @@ class ForwardingControlRulesAPI(APIClient):
             ...    dest_addresses=["192.168.255.1"],
             ...    dest_ip_categories=["ZSPROXY_IPS"],
             ...    dest_countries=["COUNTRY_CA", "COUNTRY_US"],
+            ...    src_workload_groups_ids=["1234567890", "1234567891"],
             ... )
 
             Add a ZPA forwarding control rule:
@@ -274,6 +277,8 @@ class ForwardingControlRulesAPI(APIClient):
             nw_application_groups (list): IDs for network application groups.
             device_groups (list): Device groups managed using Zscaler Client Connector.
             devices (list): Devices managed using Zscaler Client Connector.
+            src_workload_groups_ids (list): IDs for source workload groups.
+            dest_workload_groups_ids (list): IDs for destination workload groups (Valid for LOCAL_SWITCH forward method).
 
             zpa_app_segments (list[dict]): **ZPA Application Segments applicable to the rule.**
                 - `external_id` (str): Indicates the external ID. Applicable only when this reference is of an external entity.
@@ -304,6 +309,7 @@ class ForwardingControlRulesAPI(APIClient):
             ...    dest_addresses=["192.168.255.1"],
             ...    dest_ip_categories=["ZSPROXY_IPS"],
             ...    dest_countries=["COUNTRY_CA", "COUNTRY_US"],
+            ...    src_workload_groups_ids=["1234567890", "1234567891"],
             ... )
 
             Update a ZPA forwarding control rule:
@@ -318,6 +324,7 @@ class ForwardingControlRulesAPI(APIClient):
             ...    dest_addresses=["192.168.255.1"],
             ...    dest_ip_categories=["ZSPROXY_IPS"],
             ...    dest_countries=["COUNTRY_CA", "COUNTRY_US"],
+            ...    src_workload_groups_ids=["1234567890", "1234567891"],
             ...    zpa_gateway={
             ...     "name": "ZPAGW01",
             ...     "external_id": "2"

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/ztw/ip_destination_groups.py

@@ -289,6 +289,108 @@ class IPDestinationGroupsAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
+    def update_ip_destination_group(
+        self,
+        group_id: str,
+        query_params: Optional[dict] = None,
+        **kwargs
+    ) -> APIResult[dict]:
+        """
+        Updates the specified IP Destination Group.
+
+        Args:
+            query_params (dict):
+                Map of query parameters for the request.
+
+                ``[query_params.override]`` (bool): Indicates whether the IPs must be overridden.
+                    When set to false, the IPs are appended
+                    Else the existing IPs are overridden. The default value is true.
+
+            group_id (str): The unique ID of the IP Destination Group.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            name (str): The name of the IP Destination Group.
+            description (str): Additional information about the destination IP group.
+            type (str): Destination IP group type. Allowed values are DSTN_IP and DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER.
+            addresses (list): Destination IP addresses or FQDNs within the group.
+            ip_categories (list): Destination IP address URL categories. Note: Only Custom URL categories allowed.
+            countries (list): Destination IP address counties. i.e COUNTRY_CA, COUNTRY_US.
+
+        Returns:
+            :obj:`Tuple`: The updated IP Destination Group resource record.
+
+        Examples:
+            Update the name of an IP Destination Group:
+
+            >>> updated_group, _, error = client.ztw.ip_destination_groups.update_ip_destination_group(
+            ...     group_id='452125',
+            ...     name=f"UpdateGroup {random.randint(1000, 10000)}",
+            ...     description=f"UpdateGroup {random.randint(1000, 10000)}",
+            ...     addresses=["192.168.1.1", "192.168.1.2"],
+            ...     type="DSTN_IP"
+            ... )
+            >>> if error:
+            ...     print(f"Error updating group: {error}")
+            ...     return
+            ... print(f"Group updated successfully: {updated_group.as_dict()}")
+
+            Update the description and FQDNs for an IP Destination Group:
+
+            >>> updated_group, _, error = client.ztw.ip_destination_groups.update_ip_destination_group(
+            ...     group_id='452125',
+            ...     name=f"UpdateGroup_{random.randint(1000, 10000)}",
+            ...     description=f"UpdateGroup {random.randint(1000, 10000)}",
+            ...     addresses=['arstechnica.com', 'slashdot.org'],
+            ...     type="DSTN_FQDN",
+            ... )
+            >>> if error:
+            ...     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.ztw.ip_destination_groups.update_ip_destination_group(
+            ...    group_id='452125',
+            ...    name=f"UpdateGroup_{random.randint(1000, 10000)}",
+            ...    description=f"UpdateGroup_{random.randint(1000, 10000)}",
+            ...    type='DSTN_OTHER',
+            ...    countries=['COUNTRY_CA']),
+            ...    ip_categories=['CUSTOM_01']),
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {added_group.as_dict()}")
+        """
+        http_method = "put".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /ipDestinationGroups/{group_id}
+        """
+        )
+
+        query_params = query_params or {}
+
+        body = {}
+
+        body.update(kwargs)
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, params=query_params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, IPDestinationGroups)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = IPDestinationGroups(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
     def delete_ip_destination_group(self, group_id: int) -> APIResult[dict]:
         """
         Deletes the specified IP Destination Group.

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/ztw/legacy.py

@@ -506,6 +506,16 @@ class LegacyZTWClientHelper:
         from zscaler.ztw.discovery_service import DiscoveryServiceAPI
         return DiscoveryServiceAPI(self.request_executor)
 
+    @property
+    def workload_groups(self) -> "WorkloadGroupsAPI":
+        """
+        The interface object for the :ref:`ZTW Workload Groups <ztw-workload_groups>`.
+
+        """
+        from zscaler.ztw.workload_groups import WorkloadGroupsAPI
+
+        return WorkloadGroupsAPI(self.request_executor)
+
     """
     Misc
     """

{zscaler_sdk_python-1.9.11 → zscaler_sdk_python-1.9.13}/zscaler/ztw/models/forwarding_rules.py

@@ -125,6 +125,14 @@ class ForwardingControlRule(ZscalerObject):
                 config["labels"] if "labels" in config else [], common.CommonIDNameExternalID
             )
 
+            self.src_workload_groups = ZscalerCollection.form_list(
+                config["srcWorkloadGroups"] if "srcWorkloadGroups" in config else [], common.CommonIDNameExternalID
+            )
+
+            self.dest_workload_groups = ZscalerCollection.form_list(
+                config["destWorkloadGroups"] if "destWorkloadGroups" in config else [], common.CommonIDNameExternalID
+            )
+
             self.devices = ZscalerCollection.form_list(
                 config["devices"] if "devices" in config else [], common.CommonIDNameExternalID
             )
@@ -205,6 +213,8 @@ class ForwardingControlRule(ZscalerObject):
             self.zpa_app_segments = []
             self.zpa_application_segments = []
             self.zpa_application_segment_groups = []
+            self.src_workload_groups = []
+            self.dest_workload_groups = []
             self.proxy_gateway = None
             self.zpa_gateway = None
             self.zpa_broker_rule = None
@@ -252,6 +262,8 @@ class ForwardingControlRule(ZscalerObject):
             "labels": [label.request_format() for label in (self.labels or [])],
             "devices": [device.request_format() for device in (self.devices or [])],
             "deviceGroups": [dg.request_format() for dg in (self.device_groups or [])],
+            "srcWorkloadGroups": [wg.request_format() for wg in (self.src_workload_groups or [])],
+            "destWorkloadGroups": [wg.request_format() for wg in (self.dest_workload_groups or [])],
             "zpaAppSegments": [zpa.request_format() for zpa in (self.zpa_app_segments or [])],
             "zpaApplicationSegments": [zpa_app.request_format() for zpa_app in (self.zpa_application_segments or [])],
             "zpaApplicationSegmentGroups": [