zscaler-sdk-python 1.9.29__tar.gz → 1.9.30__tar.gz

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.30}/PKG-INFO

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

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.30}/pyproject.toml

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

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.30}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.30}/zscaler/zia/ips_signature_rules.py

@@ -40,8 +40,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Lists custom IPS signature rules.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-get>`_
+        See the `List ZIA Custom IPS Signature Rules API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-get>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -106,8 +106,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Fetches the custom IPS signature rules based on the specified ID
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`_
+        See the `Get ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -190,8 +190,8 @@ class IPSSignatureRulesAPI(APIClient):
         issued. If the rule is syntactically or semantically invalid, the method
         returns ``(None, None, ValueError(...))`` and no create call is made.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`_
+        See the `Add ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -264,8 +264,8 @@ class IPSSignatureRulesAPI(APIClient):
             If you want to validate ``rule_text`` before updating, call
             :meth:`validate_ips_signature_rule` explicitly from your code.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-put>`_
+        See the `Update ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-put>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -319,8 +319,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Deletes the specified IPS Signature Rule.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-delete>`_
+        See the `Delete ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-delete>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -360,8 +360,8 @@ class IPSSignatureRulesAPI(APIClient):
         Validates a new custom signature rule based on specific predefined conditions,
         such as syntax errors, duplicate signatures, and more.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/validateRuleText-post>`_
+        See the `Validate ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/validateRuleText-post>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -424,8 +424,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Exports the custom IPS signature rules to a CSV file.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/export-get>`_
+        See the `Export ZIA Custom IPS Signature Rules API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/export-get>`__
         for further detail on optional keyword parameter structures.
 
         Args:

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.30}/zscaler/zia/legacy.py

@@ -97,6 +97,7 @@ if TYPE_CHECKING:
     from zscaler.zia.saas_security_api import SaaSSecurityAPI
     from zscaler.zia.sandbox import CloudSandboxAPI
     from zscaler.zia.sandbox_rules import SandboxRulesAPI
+    from zscaler.zia.secure_browsing import SecureBrowsingAPI
     from zscaler.zia.security_policy_settings import SecurityPolicyAPI
     from zscaler.zia.shadow_it_report import ShadowITAPI
     from zscaler.zia.ssl_inspection_rules import SSLInspectionAPI
@@ -1263,6 +1264,15 @@ class LegacyZIAClientHelper:
         """
         return IPSSignatureRulesAPI(self.request_executor)
 
+    @property
+    def secure_browsing(self) -> "SecureBrowsingAPI":
+        """
+        The interface object for the :ref:`ZIA Secure Browsing API interface <zia-secure_browsing>`.
+
+        """
+        return SecureBrowsingAPI(self.request_executor)
+
+
     """
     Misc
     """

zscaler_sdk_python-1.9.30/zscaler/zia/models/secure_browsing.py

@@ -0,0 +1,271 @@
+"""
+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 Any, Dict, List, Optional
+
+from zscaler.oneapi_collection import ZscalerCollection
+from zscaler.oneapi_object import ZscalerObject
+from zscaler.zia.models import cloud_browser_isolation as isolation
+from zscaler.zia.models import user_management as user_management
+
+
+class BrowserControlSettings(ZscalerObject):
+    """
+    A class for Secure Browsing objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the Secure Browsing model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.enable_smart_browser_isolation: Optional[Any] = config["enableSmartBrowserIsolation"] \
+                if "enableSmartBrowserIsolation" in config else None
+            self.enable_warnings: Optional[Any] = config["enableWarnings"] \
+                if "enableWarnings" in config else None
+            self.plugin_check_frequency: Optional[Any] = config["pluginCheckFrequency"] \
+                if "pluginCheckFrequency" in config else None
+            self.bypass_plugins: List[Any] = ZscalerCollection.form_list(
+                config["bypassPlugins"] if "bypassPlugins" in config else [], str
+            )
+            self.bypass_applications: List[Any] = ZscalerCollection.form_list(
+                config["bypassApplications"] if "bypassApplications" in config else [], str
+            )
+            self.allow_all_browsers: Optional[Any] = config["allowAllBrowsers"] \
+                if "allowAllBrowsers" in config else None
+            self.bypass_all_browsers: Optional[Any] = config["bypassAllBrowsers"] \
+                if "bypassAllBrowsers" in config else None
+            self.blocked_chrome_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedChromeVersions"] if "blockedChromeVersions" in config else [], str
+            )
+            self.blocked_firefox_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedFirefoxVersions"] if "blockedFirefoxVersions" in config else [], str
+            )
+            self.blocked_internet_explorer_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedInternetExplorerVersions"] if "blockedInternetExplorerVersions" in config else [], str
+            )
+            self.blocked_opera_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedOperaVersions"] if "blockedOperaVersions" in config else [], str
+            )
+            self.blocked_safari_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedSafariVersions"] if "blockedSafariVersions" in config else [], str
+            )
+            if "smartIsolationProfile" in config:
+                if isinstance(config["smartIsolationProfile"], isolation.CBIProfile):
+                    self.smart_isolation_profile: Optional[isolation.CBIProfile] = config["smartIsolationProfile"]
+                elif config["smartIsolationProfile"] is not None:
+                    self.smart_isolation_profile = isolation.CBIProfile(config["smartIsolationProfile"])
+                else:
+                    self.smart_isolation_profile = None
+            else:
+                self.smart_isolation_profile: Optional[isolation.CBIProfile] = None
+            self.smart_isolation_profile_id: Optional[Any] = config["smartIsolationProfileId"] \
+                if "smartIsolationProfileId" in config else None
+        else:
+            self.enable_smart_browser_isolation: Optional[Any] = None
+            self.enable_warnings: Optional[Any] = None
+            self.plugin_check_frequency: Optional[Any] = None
+            self.bypass_plugins: List[Any] = []
+            self.bypass_applications: List[Any] = []
+            self.allow_all_browsers: Optional[Any] = None
+            self.bypass_all_browsers: Optional[Any] = None
+            self.blocked_chrome_versions: List[Any] = []
+            self.blocked_firefox_versions: List[Any] = []
+            self.blocked_internet_explorer_versions: List[Any] = []
+            self.blocked_opera_versions: List[Any] = []
+            self.blocked_safari_versions: List[Any] = []
+            self.smart_isolation_profile: Optional[isolation.CBIProfile] = None
+            self.smart_isolation_profile_id: Optional[Any] = 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 = {
+            "enableSmartBrowserIsolation": self.enable_smart_browser_isolation,
+            "enableWarnings": self.enable_warnings,
+            "pluginCheckFrequency": self.plugin_check_frequency,
+            "bypassPlugins": self.bypass_plugins,
+            "bypassApplications": self.bypass_applications,
+            "allowAllBrowsers": self.allow_all_browsers,
+            "bypassAllBrowsers": self.bypass_all_browsers,
+            "blockedChromeVersions": self.blocked_chrome_versions,
+            "blockedFirefoxVersions": self.blocked_firefox_versions,
+            "blockedInternetExplorerVersions": self.blocked_internet_explorer_versions,
+            "blockedOperaVersions": self.blocked_opera_versions,
+            "blockedSafariVersions": self.blocked_safari_versions,
+            "smartIsolationProfile": self.smart_isolation_profile,
+            "smartIsolationProfileId": self.smart_isolation_profile_id
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class SmartIsolation(ZscalerObject):
+    """
+    A class for SmartIsolation objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the SmartIsolation model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.plugin_check_frequency: Optional[Any] = config["pluginCheckFrequency"] \
+                if "pluginCheckFrequency" in config else None
+            self.bypass_plugins: List[Any] = ZscalerCollection.form_list(
+                config["bypassPlugins"] if "bypassPlugins" in config else [], str
+            )
+            self.bypass_applications: List[Any] = ZscalerCollection.form_list(
+                config["bypassApplications"] if "bypassApplications" in config else [], str
+            )
+            self.bypass_all_browsers: Optional[Any] = config["bypassAllBrowsers"] \
+                if "bypassAllBrowsers" in config else None
+            self.blocked_internet_explorer_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedInternetExplorerVersions"] if "blockedInternetExplorerVersions" in config else [], str
+            )
+            self.blocked_chrome_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedChromeVersions"] if "blockedChromeVersions" in config else [], str
+            )
+            self.blocked_firefox_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedFirefoxVersions"] if "blockedFirefoxVersions" in config else [], str
+            )
+            self.blocked_safari_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedSafariVersions"] if "blockedSafariVersions" in config else [], str
+            )
+            self.blocked_opera_versions: List[Any] = ZscalerCollection.form_list(
+                config["blockedOperaVersions"] if "blockedOperaVersions" in config else [], str
+            )
+            self.allow_all_browsers: Optional[Any] = config["allowAllBrowsers"] \
+                if "allowAllBrowsers" in config else None
+            self.enable_warnings: Optional[Any] = config["enableWarnings"] \
+                if "enableWarnings" in config else None
+            self.enable_smart_browser_isolation: Optional[Any] = config["enableSmartBrowserIsolation"] \
+                if "enableSmartBrowserIsolation" in config else None
+
+            self.smart_isolation_groups = ZscalerCollection.form_list(config["smartIsolationGroups"] if "smartIsolationGroups" in config else [], user_management.Groups)
+
+            self.smart_isolation_users = ZscalerCollection.form_list(
+                config["smartIsolationUsers"] if "smartIsolationUsers" in config else [], user_management.UserManagement
+            )
+
+            if "smartIsolationProfile" in config:
+                if isinstance(config["smartIsolationProfile"], isolation.CBIProfile):
+                    self.smart_isolation_profile: Optional[isolation.CBIProfile] = config["smartIsolationProfile"]
+                elif config["smartIsolationProfile"] is not None:
+                    self.smart_isolation_profile = isolation.CBIProfile(config["smartIsolationProfile"])
+                else:
+                    self.smart_isolation_profile = None
+            else:
+                self.smart_isolation_profile: Optional[isolation.CBIProfile] = None
+            self.smart_isolation_profile_id: Optional[Any] = config["smartIsolationProfileId"] \
+                if "smartIsolationProfileId" in config else None
+        else:
+            self.plugin_check_frequency: Optional[Any] = None
+            self.bypass_plugins: List[Any] = []
+            self.bypass_applications: List[Any] = []
+            self.bypass_all_browsers: Optional[Any] = None
+            self.blocked_internet_explorer_versions: List[Any] = []
+            self.blocked_chrome_versions: List[Any] = []
+            self.blocked_firefox_versions: List[Any] = []
+            self.blocked_safari_versions: List[Any] = []
+            self.blocked_opera_versions: List[Any] = []
+            self.allow_all_browsers: Optional[Any] = None
+            self.enable_warnings: Optional[Any] = None
+            self.enable_smart_browser_isolation: Optional[Any] = None
+            self.smart_isolation_users: List[user_management.UserManagement] = []
+            self.smart_isolation_groups: List[user_management.Groups] = []
+            self.smart_isolation_profile: Optional[isolation.CBIProfile] = None
+            self.smart_isolation_profile_id: Optional[Any] = 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 = {
+            "pluginCheckFrequency": self.plugin_check_frequency,
+            "bypassPlugins": self.bypass_plugins,
+            "bypassApplications": self.bypass_applications,
+            "bypassAllBrowsers": self.bypass_all_browsers,
+            "blockedInternetExplorerVersions": self.blocked_internet_explorer_versions,
+            "blockedChromeVersions": self.blocked_chrome_versions,
+            "blockedFirefoxVersions": self.blocked_firefox_versions,
+            "blockedSafariVersions": self.blocked_safari_versions,
+            "blockedOperaVersions": self.blocked_opera_versions,
+            "allowAllBrowsers": self.allow_all_browsers,
+            "enableWarnings": self.enable_warnings,
+            "enableSmartBrowserIsolation": self.enable_smart_browser_isolation,
+            "smartIsolationUsers": self.smart_isolation_users,
+            "smartIsolationGroups": self.smart_isolation_groups,
+            "smartIsolationProfile": self.smart_isolation_profile,
+            "smartIsolationProfileId": self.smart_isolation_profile_id
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class SupportedBrowserVersions(ZscalerObject):
+    """
+    A class for SupportedBrowserVersions objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the SupportedBrowserVersions model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.browser_type: Optional[Any] = config["browserType"] \
+                if "browserType" in config else None
+            self.versions: List[Any] = ZscalerCollection.form_list(
+                config["versions"] if "versions" in config else [], str
+            )
+            self.older_versions: List[Any] = ZscalerCollection.form_list(
+                config["olderVersions"] if "olderVersions" in config else [], str
+            )
+        else:
+            self.browser_type: Optional[Any] = None
+            self.versions: List[Any] = []
+            self.older_versions: List[Any] = []
+
+    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 = {
+            "browserType": self.browser_type,
+            "versions": self.versions,
+            "olderVersions": self.older_versions
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.30}/zscaler/zia/models/url_filtering_rules.py

@@ -114,8 +114,15 @@ class URLFilteringRule(ZscalerObject):
                 config["deviceGroups"] if "deviceGroups" in config else [], device_groups.DeviceGroups
             )
 
-            # Handling nested single object for CBIProfile
-            self.cbi_profile = isolation.CBIProfile(config["cbiProfile"]) if "cbiProfile" in config else None
+            if "cbiProfile" in config:
+                if isinstance(config["cbiProfile"], isolation.CBIProfile):
+                    self.cbi_profile = config["cbiProfile"]
+                elif config["cbiProfile"] is not None:
+                    self.cbi_profile = isolation.CBIProfile(config["cbiProfile"])
+                else:
+                    self.cbi_profile = None
+            else:
+                self.cbi_profile = None
 
             if "lastModifiedBy" in config:
                 if isinstance(config["lastModifiedBy"], common.CommonBlocks):