zscaler-sdk-python 0.1.4__tar.gz → 0.1.6__tar.gz

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.1.4
+Version: 0.1.6
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -54,6 +54,7 @@ Description-Content-Type: text/markdown
 [![Documentation Status](https://readthedocs.org/projects/zscaler-sdk-python/badge/?version=latest)](https://zscaler-sdk-python.readthedocs.io/en/latest/?badge=latest)
 [![Latest version released on PyPi](https://img.shields.io/pypi/v/zscaler-sdk-python.svg)](https://pypi.org/project/zscaler-sdk-python)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler-sdk-python.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
+[![codecov](https://codecov.io/gh/zscaler/zscaler-sdk-python/graph/badge.svg?token=56B53PITU8)](https://codecov.io/gh/zscaler/zscaler-sdk-python)
 [![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)
 
 ## Support Disclaimer

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/README.md

@@ -5,6 +5,7 @@
 [![Documentation Status](https://readthedocs.org/projects/zscaler-sdk-python/badge/?version=latest)](https://zscaler-sdk-python.readthedocs.io/en/latest/?badge=latest)
 [![Latest version released on PyPi](https://img.shields.io/pypi/v/zscaler-sdk-python.svg)](https://pypi.org/project/zscaler-sdk-python)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler-sdk-python.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
+[![codecov](https://codecov.io/gh/zscaler/zscaler-sdk-python/graph/badge.svg?token=56B53PITU8)](https://codecov.io/gh/zscaler/zscaler-sdk-python)
 [![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)
 
 ## Support Disclaimer

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/pyproject.toml

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

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/zscaler/__init__.py

@@ -16,7 +16,7 @@
 
 """Official Python SDK for the Zscaler Products (Beta)
 
-Zscaler SDK Python is an SDK that provides a uniform and easy-to-use 
+Zscaler SDK Python is an SDK that provides a uniform and easy-to-use
 interface for each of the Zscaler product APIs.
 
 Documentation available at https://zscaler-sdk-python.readthedocs.io
@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.1.4"
+__version__ = "0.1.6"
 
 from zscaler.zia import ZIAClientHelper  # noqa
 from zscaler.zpa import ZPAClientHelper  # noqa

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/zscaler/zpa/__init__.py

@@ -114,6 +114,7 @@ class ZPAClientHelper(ZPAClient):
         self.url = f"{self.baseurl}/mgmtconfig/v1/admin/customers/{customer_id}"
         self.user_config_url = f"{self.baseurl}/userconfig/v1/customers/{customer_id}"
         self.v2_url = f"{self.baseurl}/mgmtconfig/v2/admin/customers/{customer_id}"
+        self.v2_lss_url = f"{self.baseurl}/mgmtconfig/v2/admin/lssConfig/customers/{customer_id}"
         self.cbi_url = f"{self.baseurl}/cbiconfig/cbi/api/customers/{customer_id}"
         self.fail_safe = fail_safe
         # Cache setup
@@ -182,6 +183,8 @@ class ZPAClientHelper(ZPAClient):
             api = self.url
         elif api_version == "v2":
             api = self.v2_url
+        elif api_version == "v2_lss":
+            api = self.v2_lss_url
         elif api_version == "userconfig_v1":
             api = self.user_config_url
 

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/zscaler/zpa/client.py

@@ -33,7 +33,7 @@ class ZPAClient:
         - path (str): API endpoint path.
         - json (str): the request body.
         - params (dict): the query params
-        - api_version (str): the api version, availbale values: v1, v2, userconfig_v1, cbiconfig_v1
+        - api_version (str): the api version, availbale values: v1, v2, v2_lss, userconfig_v1, cbiconfig_v1
         """
         pass
 
@@ -64,7 +64,7 @@ class ZPAClient:
         - data_key_name (str): list field key.
         - data_per_page: the page size
         - params (dict): the query params
-        - api_version (str): the api version, availbale values: v1, v2, userconfig_v1 or cbiconfig
+        - api_version (str): the api version, availbale values: v1, v2, v2_lss, userconfig_v1 or cbiconfig
         """
         pass
 
@@ -86,7 +86,7 @@ class ZPAClient:
         - path (str): API endpoint path.
         - json (str): the request body.
         - params (dict): the query params
-        - api_version (str): the api version, availbale values: v1, v2, userconfig_v1 or cbiconfig
+        - api_version (str): the api version, availbale values: v1, v2, v2_lss, userconfig_v1 or cbiconfig
         """
         pass
 
@@ -97,7 +97,7 @@ class ZPAClient:
         - path (str): API endpoint path.
         - json (str): the request body.
         - params (dict): the query params
-        - api_version (str): the api version, availbale values: v1, v2, userconfig_v1 or cbiconfig
+        - api_version (str): the api version, availbale values: v1, v2, v2_lss, userconfig_v1 or cbiconfig
         """
         pass
 
@@ -108,6 +108,6 @@ class ZPAClient:
         - path (str): API endpoint path.
         - json (str): the request body.
         - params (dict): the query params
-        - api_version (str): the api version, availbale values: v1, v2, userconfig_v1 or cbiconfig
+        - api_version (str): the api version, availbale values: v1, v2, v2_lss, userconfig_v1 or cbiconfig
         """
         pass

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/zscaler/zpa/lss.py

@@ -88,42 +88,41 @@ class LSSConfigControllerAPI:
 
         return template
 
-    def get_client_types(self) -> Box:
+    def get_client_types(self, client_type=None) -> Box:
         """
-        Returns all available LSS Client Types.
+        Returns all available LSS Client Types or a specific Client Type if specified.
 
-        Client Types are used when creating LSS Receiver configs. ZPA uses an internal code for Client Types, e.g.
-        ``zpn_client_type_ip_anchoring`` is the Client Type for a ZIA Service Edge. zscaler-sdk-python inverts the key/value so
-        that you can perform a lookup using a human-readable name in your code (e.g. ``cloud_connector``).
+        Client Types are used when creating LSS Receiver configs.
+        ZPA uses an internal code for Client Types, e.g.
+        `zpn_client_type_ip_anchoring` is the Client Type for a ZIA Service Edge.
+        The zscaler-sdk-python inverts the key/value so
+        that you can perform a lookup using a human-readable name in your code (e.g. `cloud_connector`).
+
+        Args:
+            client_type_name (str, optional): The human-readable name of the client type to filter for.
 
         Returns:
-            :obj:`Box`: Dictionary containing all LSS Client Types with human-readable name as the key.
+            :obj:`Box`: Dictionary containing all or a specific LSS Client Type with human-readable name as the key.
 
         Examples:
             Print all LSS Client Types:
-
             >>> print(zpa.lss.get_client_types())
 
+            Print only the 'web_browser' Client Type:
+            >>> print(zpa.lss.get_client_types('web_browser'))
         """
-        # ZPA returns a dictionary of client types but the keys are the internal ZPA codes, which our users probably
-        # won't know. This method reverses the dictionary, converts the 'normalised' Client Type name to snake_case
-        # before returning it so that a lookup can be easily performed using the Client Type name in plain english.
-        #
-        # Example before:
-        # {'zpn_client_type_exporter': 'Web Browser'}
-        # Example after:
-        # {'web_browser': 'zpn_client_type_exporter'}
-
-        response = requests.get(f"{self.v2_admin_url}/clientTypes", headers=self.rest.headers)
-
+        response = self.rest.send("GET", "clientTypes", api_version="v2_lss")
         if response.status_code == 200:
-            return response.json()
+            client_types = response.json()
+            reverse_map = {v.lower().replace(" ", "_"): k for k, v in client_types.items()}
+            box = Box(reverse_map)
+
+            if client_type and client_type in box:
+                return Box({client_type: box[client_type]})
+            return box
         else:
             response.raise_for_status()
 
-        reverse_map = {v.lower().replace(" ", "_"): k for k, v in response.items()}
-        return Box(reverse_map)
-
     def list_configs(self, **kwargs) -> BoxList:
         """
         Returns all configured LSS receivers.
@@ -167,32 +166,43 @@ class LSSConfigControllerAPI:
             >>> print(zpa.lss.get_config('99999'))
 
         """
-        response = self.rest.get("/lssConfig/%s" % (lss_id), api_version="v2")
+        response = self.rest.send("GET", "/lssConfig/%s" % (lss_id), api_version="v2")
         if isinstance(response, Response):
             status_code = response.status_code
             if status_code != 200:
                 return None
         return response
 
-    def get_log_formats(self) -> Box:
+    def get_log_formats(self, log_type=None) -> Box:
         """
-        Returns all available pre-configured LSS Log Formats.
+        Returns all available pre-configured LSS Log Formats or a specific log format if specified.
 
-        LSS Log Formats are provided as either CSV, JSON or TSV. LSS Log Format values can be used when
+        LSS Log Formats are provided as either CSV, JSON, or TSV. The values can be used when
         creating or updating LSS Log Receiver configs.
 
+        Args:
+            log_type_name (str, optional): The name of the log type to retrieve (e.g., 'zpn_ast_comprehensive_stats').
+
         Returns:
             :obj:`Box`: Dictionary containing pre-configured LSS Log Formats.
 
         Examples:
-            >>> for item in zpa.lss.get_log_formats():
-            ...    print(item)
-
+            >>> print(zpa.lss.get_log_formats())
+            >>> print(zpa.lss.get_log_formats('zpn_ast_comprehensive_stats'))
         """
-        response = requests.get(f"{self.v2_admin_url}/logType/formats", headers=self.rest.headers)
-
+        response = self.rest.send("GET", "lssConfig/logType/formats", api_version="v2")
         if response.status_code == 200:
-            return response.json()
+            formats = response.json()
+            if log_type:
+                # Filter and return only the requested log type
+                specific_format = formats.get(log_type, None)
+                if specific_format:
+                    return Box({log_type: specific_format})
+                else:
+                    return Box()  # or raise an Exception if preferred
+            else:
+                # Return all formats
+                return Box(formats)
         else:
             response.raise_for_status()
 

{zscaler_sdk_python-0.1.4 → zscaler_sdk_python-0.1.6}/zscaler/zpa/policies.py

@@ -34,12 +34,16 @@ class PolicySetsAPI:
         "client_forwarding": "CLIENT_FORWARDING_POLICY",
         "isolation": "ISOLATION_POLICY",
         "inspection": "INSPECTION_POLICY",
+        "redirection": "REDIRECTION_POLICY",
+        "credential": "CREDENTIAL_POLICY",
+        "capabilities": "CAPABILITIES_POLICY",
         "siem": "SIEM_POLICY",
     }
 
     reformat_params = [
         ("app_server_group_ids", "appServerGroups"),
         ("app_connector_group_ids", "appConnectorGroups"),
+        ("service_edge_group_ids", "serviceEdgeGroups"),
     ]
 
     @staticmethod
@@ -148,7 +152,13 @@ class PolicySetsAPI:
                  |  ``access``
                  |  ``timeout``
                  |  ``client_forwarding``
+                 |  ``isolation``
+                 |  ``inspection``
+                 |  ``redirection``
+                 |  ``credential``
+                 |  ``capabilities``
                  |  ``siem``
+                 
             rule_id (str): The unique identifier for the policy rule.
 
         Returns:
@@ -197,7 +207,12 @@ class PolicySetsAPI:
                 |  ``access`` - returns Access Policy rules
                 |  ``timeout`` - returns Timeout Policy rules
                 |  ``client_forwarding`` - returns Client Forwarding Policy rules
-
+                |  ``isolation`` - returns Isolation Policy rules
+                |  ``inspection`` - returns Inspection Policy rules
+                |  ``redirection`` - returns Redirection Policy rules
+                |  ``credential`` - returns Credential Policy rules
+                |  ``capabilities`` - returns Capabilities Policy rules
+                |  ``siem`` - returns SIEM Policy rules
         Returns:
             :obj:`list`: A list of all policy rules that match the requested type.
 
@@ -234,7 +249,13 @@ class PolicySetsAPI:
                  |  ``access``
                  |  ``timeout``
                  |  ``client_forwarding``
+                 |  ``isolation``
+                 |  ``inspection``
+                 |  ``redirection``
+                 |  ``credential``
+                 |  ``capabilities``
                  |  ``siem``
+                 
             rule_id (str):
                 The unique identifier for the policy rule.
 
@@ -753,6 +774,12 @@ class PolicySetsAPI:
                  |  ``access``
                  |  ``timeout``
                  |  ``client_forwarding``
+                 |  ``isolation``
+                 |  ``inspection``
+                 |  ``redirection``
+                 |  ``credential``
+                 |  ``capabilities``
+                 |  ``siem``
 
         Returns:
              :obj:`Box`: The updated policy rule resource record.
@@ -768,7 +795,7 @@ class PolicySetsAPI:
         # Get policy id for specified policy type
         policy_id = self.get_policy(policy_type).id
 
-        resp = self._put(f"policySet/{policy_id}/rule/{rule_id}/reorder/{rule_order}").status_code
+        resp = self.rest.put(f"policySet/{policy_id}/rule/{rule_id}/reorder/{rule_order}").status_code
 
         if resp == 204:
             return self.get_rule(policy_type, rule_id)
@@ -803,6 +830,12 @@ class PolicySetsAPI:
                  |  ``access``
                  |  ``timeout``
                  |  ``client_forwarding``
+                 |  ``isolation``
+                 |  ``inspection``
+                 |  ``redirection``
+                 |  ``credential``
+                 |  ``capabilities``
+                 |  ``siem``
 
         """
         # Get policy id for specified policy type