zscaler-sdk-python 0.8.0__tar.gz → 0.9.0__tar.gz

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.8.0
+Version: 0.9.0
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -22,7 +22,7 @@ Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: dev
 Requires-Dist: aenum ; extra == "dev"
-Requires-Dist: aiohttp (>=3.10.2)
+Requires-Dist: aiohttp (>=3.10.5)
 Requires-Dist: arrow
 Requires-Dist: black (>=24.3.0) ; extra == "dev"
 Requires-Dist: certifi (>=2024.2.2)
@@ -30,11 +30,11 @@ Requires-Dist: charset-normalizer
 Requires-Dist: cryptography (>=43.0.0)
 Requires-Dist: flake8
 Requires-Dist: flatdict
-Requires-Dist: idna
+Requires-Dist: idna (>=3.7,<4.0)
 Requires-Dist: okta (>=2.9.7)
 Requires-Dist: pycryptodomex
 Requires-Dist: pydash (>=8.0.3) ; extra == "dev"
-Requires-Dist: python-box (>=7.2.0,<8.0.0)
+Requires-Dist: python-box (>=7.2.0)
 Requires-Dist: python-dateutil
 Requires-Dist: pytz
 Requires-Dist: pyyaml

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.8.0"
+version = "0.9.0"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -32,8 +32,8 @@ python = ">=3.9,<4.0"
 arrow = "*"
 certifi = ">=2024.2.2"
 charset-normalizer = "*"
-idna = "*"
-python-box = "^7.2.0"
+idna = "^3.7"
+python-box = ">=7.2.0"
 python-dateutil = "*"
 requests = ">=2.32.3"
 responses = ">=0.25.3"
@@ -52,12 +52,12 @@ black = ">=24.3.0"
 # cryptography = ">=3.4,<43.0"
 cryptography = ">=43.0.0"
 okta = ">=2.9.7"
-aiohttp = ">=3.10.2"
+aiohttp = ">=3.10.5"
 
 [tool.poetry.dev-dependencies]
 black = ">=24.3.0"
 pytest = ">=8.3.1"
-pytest-asyncio = "^0.23.8"
+pytest-asyncio = ">=0.23.8"
 pytest-mock = "*"
 pytest-recording = "^0.13.2"
 pytest-cov = "*"

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.8.0"
+__version__ = "0.9.0"
 
 from zscaler.zdx import ZDXClientHelper  # noqa
 from zscaler.zia import ZIAClientHelper  # noqa

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/zscaler/utils.py

@@ -184,11 +184,7 @@ def transform_common_id_fields(id_groups: list, kwargs: dict, payload: dict):
             elif key == "cbi_profile":
                 # Special handling for cbi_profile
                 if isinstance(value, dict) and all(k in value for k in ["id", "name", "url"]):
-                    payload[payload_key] = {
-                        "id": value["id"],
-                        "name": value["name"],
-                        "url": value["url"]
-                    }
+                    payload[payload_key] = {"id": value["id"], "name": value["name"], "url": value["url"]}
             elif key == "cloud_app_risk_profile":
                 # Special handling for cloudAppRiskProfile
                 if isinstance(value, dict) and "id" in value:

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/zscaler/zia/cloudappcontrol.py

@@ -110,6 +110,27 @@ class CloudAppControlAPI:
         """
         return self.rest.get(f"webApplicationRules/{rule_type}/{rule_id}")
 
+    def get_rule_by_name(self, rule_type: str, rule_name: str) -> Box:
+        """
+        Retrieves a specific Cloud App Control rule by its name and type.
+
+        Args:
+            rule_type (str): The type of rules to search within (e.g., "WEBMAIL").
+            rule_name (str): The name of the rule to retrieve.
+
+        Returns:
+            :obj:`Box`: The Cloud App Control rule if found, otherwise None.
+
+        Examples:
+            >>> rule = zia.cloudappcontrol.get_rule_by_name('WEBMAIL', 'Webmail Rule-1')
+            ...    print(rule)
+        """
+        rules = self.list_rules(rule_type)
+        for rule in rules:
+            if rule.get("name") == rule_name:
+                return rule
+        return None
+
     def add_rule(self, rule_type: str, name: str, **kwargs) -> Box:
         """
         Adds a new cloud app control filter rule.
@@ -474,10 +495,6 @@ class CloudAppControlAPI:
         # Set payload to value of existing record and convert nested dict keys.
         payload = convert_keys(self.get_rule(rule_type, rule_id))
 
-        # Convert enabled to API format if present in kwargs
-        if "enabled" in kwargs:
-            kwargs["state"] = "ENABLED" if kwargs.pop("enabled") else "DISABLED"
-
         # Convert enabled to API format if present in kwargs
         if "enabled" in kwargs:
             kwargs["state"] = "ENABLED" if kwargs.pop("enabled") else "DISABLED"

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/zscaler/zia/dlp.py

@@ -52,7 +52,7 @@ class DLPAPI:
         if isinstance(list, Response):
             return None
         return list
-    
+
     def get_dict(self, dict_id: str) -> Box:
         """
         Returns the DLP Dictionary that matches the specified DLP Dictionary id.
@@ -398,13 +398,7 @@ class DLPAPI:
         else:
             return response
 
-    def add_dlp_engine(
-        self,
-        name: str,
-        engine_expression=None,
-        custom_dlp_engine=None,
-        **kwargs
-    ) -> Box:
+    def add_dlp_engine(self, name: str, engine_expression=None, custom_dlp_engine=None, **kwargs) -> Box:
         """
         Adds a new dlp engine.
         Args:
@@ -888,7 +882,7 @@ class DLPAPI:
         if isinstance(response, Response):
             return None
         return response
-    
+
     def list_edm_schema_lite(self, schema_name: str = None, active_only: bool = None, fetch_tokens: bool = None) -> BoxList:
         """
         Returns the list of active EDM templates (or EDM schemas) and their criteria (or token details), only.
@@ -896,7 +890,7 @@ class DLPAPI:
         Args:
             schema_name (str): The EDM schema name.
             active_only (bool): If set to true, only active EDM templates (or schemas) are returned in the response.
-            fetch_tokens (bool): If set to true, the criteria (i.e., token details) for the active templates are returned in the response.
+            fetch_tokens (bool): If set to true, the criteria for the active templates are returned in the response.
 
         Returns:
             :obj:`BoxList`: A list containing ZIA DLP Engines.
@@ -911,11 +905,11 @@ class DLPAPI:
         """
         params = {}
         if schema_name is not None:
-            params['schemaName'] = schema_name
+            params["schemaName"] = schema_name
         if active_only is not None:
-            params['activeOnly'] = active_only
+            params["activeOnly"] = active_only
         if fetch_tokens is not None:
-            params['fetchTokens'] = fetch_tokens
+            params["fetchTokens"] = fetch_tokens
 
         response = self.rest.get("/dlpExactDataMatchSchemas/lite", params=params)
         if isinstance(response, Response):

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/zscaler/zia/url_categories.py

@@ -58,7 +58,7 @@ class URLCategoriesAPI:
     def review_domains_post(self, urls: list) -> BoxList:
         """
         For the specified list of URLs, finds matching entries present in existing custom URL categories.
-        This endpoint allows you to review URLs for potential matches in existing categories to group related entries in a single category.
+        Allows the review of URLs for matches in existing categories to group related entries in a single category.
 
         Args:
             urls (list): A list of URLs to perform a category lookup on. Maximum 100 URLs per request.
@@ -104,7 +104,6 @@ class URLCategoriesAPI:
         else:
             return self.rest.put("urlCategories/review/domains", json=urls)
 
-
     def list_categories(self, custom_only: bool = False, only_counts: bool = False) -> BoxList:
         """
         Returns information on URL categories.

{zscaler_sdk_python-0.8.0 → zscaler_sdk_python-0.9.0}/zscaler/zpa/segment_groups.py

@@ -173,6 +173,49 @@ class SegmentGroupsAPI:
         if not isinstance(resp, Response):
             return self.get_group(group_id)
 
+    # REQUIRES DEPLOYMENT OF ET-76506 IN PRODUCTION BEFORE ENABLING IT.
+    def update_group_v2(self, group_id: str, **kwargs) -> Box:
+        """
+        Updates an existing segment group using v2 endpoint.
+
+        Args:
+            group_id (str): The unique identifier for the segment group to be updated.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            name (str): The name of the new segment group.
+            enabled (bool): Enable the segment group.
+            application_ids (:obj:`list` of :obj:`dict`): Unique application IDs to associate with the segment group.
+            config_space (str): The config space for the segment group. Can either be DEFAULT or SIEM.
+            description (str): A description for the segment group.
+            policy_migrated (bool):
+            microtenant_id (str): The microtenant ID to be used for this request.
+
+        Returns:
+            :obj:`Box`: The resource record for the updated segment group.
+
+        Examples:
+            Updating the name of a segment group:
+
+            >>> zpa.segment_groups.update_group_v2('99999',
+            ...    name='updated_name')
+
+        """
+        payload = {snake_to_camel(k): v for k, v in self.get_group(group_id).items()}
+
+        if kwargs.get("application_ids"):
+            payload["applications"] = [{"id": app_id} for app_id in kwargs.pop("application_ids")]
+
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        microtenant_id = kwargs.pop("microtenant_id", None)
+        params = {"microtenantId": microtenant_id} if microtenant_id else {}
+
+        resp = self.rest.put(f"segmentGroup/{group_id}", json=payload, params=params, api_version="v2").status_code
+        if not isinstance(resp, Response):
+            return self.get_group(group_id)
+
     def delete_group(self, group_id: str, **kwargs) -> int:
         """
         Deletes the specified segment group.