zscaler-sdk-python 0.1.8__tar.gz → 0.3.0__tar.gz

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.1.8
+Version: 0.3.0
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -23,9 +23,10 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: dev
 Requires-Dist: aenum ; extra == "dev"
 Requires-Dist: arrow
-Requires-Dist: black (>=24.4.1,<25.0.0) ; extra == "dev"
+Requires-Dist: black ; extra == "dev"
 Requires-Dist: certifi
 Requires-Dist: charset-normalizer
+Requires-Dist: cryptography (>=3.4,<43.0)
 Requires-Dist: flake8
 Requires-Dist: flatdict
 Requires-Dist: idna
@@ -35,11 +36,10 @@ Requires-Dist: python-box (>=7.1.1,<8.0.0)
 Requires-Dist: python-dateutil
 Requires-Dist: pytz
 Requires-Dist: pyyaml
-Requires-Dist: requests
+Requires-Dist: requests (>=2.32.0)
 Requires-Dist: responses
 Requires-Dist: restfly
 Requires-Dist: six
-Requires-Dist: urllib3
 Requires-Dist: xmltodict
 Requires-Dist: yarl
 Project-URL: Bug Tracker, https://github.com/zscaler/zscaler-sdk-python/issues

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.1.8"
+version = "0.3.0"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -35,11 +35,10 @@ charset-normalizer = "*"
 idna = "*"
 python-box = "^7.1.1"
 python-dateutil = "*"
-requests = "*"
+requests = ">=2.32.0"
 responses = "*"
 restfly = "*"
 six = "*"
-urllib3 = "*"
 flatdict = "*"
 pyyaml = "*"
 xmltodict = "*"
@@ -49,12 +48,13 @@ aenum = "*"
 pydash = "*"
 flake8 = "*"
 pytz = "*"
-black = "^24.4.1"
+black = "*"
+cryptography = ">=3.4,<43.0"
 
 [tool.poetry.dev-dependencies]
-black = "*"
-pytest = "*"
-pytest-asyncio = "*"
+black = "24.3.0"
+pytest = "^8.2.1"
+pytest-asyncio = ">=0.23.7"
 pytest-mock = "*"
 pytest-recording = "*"
 pytest-cov = "*"

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.1.8"
+__version__ = "0.3.0"
 
 from zscaler.zia import ZIAClientHelper  # noqa
 from zscaler.zpa import ZPAClientHelper  # noqa

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/zscaler/constants.py

@@ -9,8 +9,11 @@ ZPA_BASE_URLS = {
     "PREVIEW": "https://config.zpapreview.net",
     "QA": "https://config.qa.zpath.net",
     "QA2": "https://pdx2-zpa-config.qa2.zpath.net",
+    "DEV": "https://public-api.dev.zpath.net",
 }
 
+DEV_AUTH_URL = "https://authn1.dev.zpath.net/authn/v1/oauth/token"
+
 RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}
 MAX_RETRIES = 5
 BACKOFF_FACTOR = 1

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/zscaler/zpa/__init__.py

@@ -11,7 +11,7 @@ from box import BoxList
 from zscaler import __version__
 from zscaler.cache.no_op_cache import NoOpCache
 from zscaler.cache.zscaler_cache import ZscalerCache
-from zscaler.constants import ZPA_BASE_URLS
+from zscaler.constants import ZPA_BASE_URLS, DEV_AUTH_URL
 from zscaler.errors.http_error import HTTPError, ZscalerAPIError
 from zscaler.exceptions.exceptions import HTTPException, ZscalerAPIException
 from zscaler.logger import setup_logging
@@ -36,10 +36,11 @@ from zscaler.zpa.connectors import AppConnectorControllerAPI
 from zscaler.zpa.emergency_access import EmergencyAccessAPI
 from zscaler.zpa.idp import IDPControllerAPI
 from zscaler.zpa.inspection import InspectionControllerAPI
-from zscaler.zpa.isolation_profile import IsolationProfileAPI
+from zscaler.zpa.isolation import IsolationAPI
 from zscaler.zpa.lss import LSSConfigControllerAPI
 from zscaler.zpa.machine_groups import MachineGroupsAPI
 from zscaler.zpa.policies import PolicySetsAPI
+from zscaler.zpa.policiesv2 import PolicySetsV2API
 from zscaler.zpa.posture_profiles import PostureProfilesAPI
 from zscaler.zpa.privileged_remote_access import PrivilegedRemoteAccessAPI
 from zscaler.zpa.provisioning import ProvisioningKeyAPI
@@ -151,7 +152,7 @@ class ZPAClientHelper(ZPAClient):
     @retry_with_backoff(retries=5)
     def login(self):
         """Log in to the ZPA API and set the access token for subsequent requests."""
-        data = urllib.parse.urlencode({"client_id": self.client_id, "client_secret": self.client_secret})
+        params = {"client_id": self.client_id, "client_secret": self.client_secret}
         headers = {
             "Content-Type": "application/x-www-form-urlencoded",
             "Accept": "application/json",
@@ -159,6 +160,9 @@ class ZPAClientHelper(ZPAClient):
         }
         try:
             url = f"{self.baseurl}/signin"
+            if self.cloud == "DEV":
+                url = DEV_AUTH_URL + "?grant_type=CLIENT_CREDENTIALS"
+            data = urllib.parse.urlencode(params)
             resp = requests.post(url, data=data, headers=headers, timeout=self.timeout)
             # Avoid logging all data from the response, focus on the status and a summary instead
             logger.info("Login attempt with status: %d", resp.status_code)
@@ -187,6 +191,8 @@ class ZPAClientHelper(ZPAClient):
             api = self.v2_lss_url
         elif api_version == "userconfig_v1":
             api = self.user_config_url
+        elif api_version == "cbiconfig_v1":
+            api = self.cbi_url
 
         url = f"{api}/{path.lstrip('/')}"
         start_time = time.time()
@@ -456,7 +462,7 @@ class ZPAClientHelper(ZPAClient):
                 params["page"] = page
 
         finally:
-            time.sleep(1)  # Ensure a delay between requests regardless of outcome
+            time.sleep(2)  # Ensure a delay between requests regardless of outcome
 
         if not ret_data:
             error_msg = ERROR_MESSAGES["EMPTY_RESULTS"]
@@ -498,12 +504,12 @@ class ZPAClientHelper(ZPAClient):
         return CertificatesAPI(self)
 
     @property
-    def isolation_profile(self):
+    def isolation(self):
         """
-        The interface object for the :ref:`ZPA Isolation Profiles <zpa-isolation_profile>`.
+        The interface object for the :ref:`ZPA Isolation <zpa-isolation>`.
 
         """
-        return IsolationProfileAPI(self)
+        return IsolationAPI(self)
 
     @property
     def cloud_connector_groups(self):
@@ -569,6 +575,14 @@ class ZPAClientHelper(ZPAClient):
         """
         return PolicySetsAPI(self)
 
+    @property
+    def policiesv2(self):
+        """
+        The interface object for the :ref:`ZPA Policy Sets V2 interface <zpa-policiesv2>`.
+
+        """
+        return PolicySetsV2API(self)
+
     @property
     def posture_profiles(self):
         """

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/zscaler/zpa/app_segments.py

@@ -91,6 +91,40 @@ class ApplicationSegmentAPI:
                 return app
         return None
 
+    def get_segments_by_type(self, application_type: str, expand_all: bool = False, **kwargs) -> Box:
+        """
+        Retrieve all configured application segments of a specified type, optionally expanding all related data.
+
+        Args:
+            application_type (str): Type of application segment to retrieve. Must be one of "BROWSER_ACCESS", "INSPECT", "SECURE_REMOTE_ACCESS".
+            expand_all (bool, optional): Whether to expand all related data. Defaults to False.
+
+        Keyword Args:
+            max_items (int, optional): The maximum number of items to request before stopping iteration.
+            max_pages (int, optional): The maximum number of pages to request before stopping iteration.
+            pagesize (int, optional): Specifies the page size. The default size is 20, but the maximum size is 500.
+            page (int, optional): Specifies the page number to begin fetching from.
+            search (str, optional): The search string used to match against features and fields.
+
+        Returns:
+            BoxList: List of application segments.
+
+        Examples:
+            >>> app_type = 'BROWSER_ACCESS'
+            >>> expand_all = True
+            >>> search = "ba_server01"
+            >>> app_segments = zpa.app_segments.get_segments_by_type(app_type, expand_all, search=search)
+        """
+        params = {"applicationType": application_type, "expandAll": "true" if expand_all else "false"}
+        # Include additional search parameters if specified
+        if "search" in kwargs:
+            params["search"] = kwargs["search"]
+
+        result, error = self.rest.get_paginated_data(path="/application/getAppsByType", params=params, **kwargs)
+        if error:
+            return BoxList([])  # Return an empty BoxList on failure due to the error
+        return result
+
     def delete_segment(self, segment_id: str, force_delete: bool = False) -> int:
         """
         Delete an application segment.

{zscaler_sdk_python-0.1.8 → zscaler_sdk_python-0.3.0}/zscaler/zpa/certificates.py

@@ -171,7 +171,9 @@ class CertificatesAPI:
             >>> ba_certificate = zpa.certificates.get_certificate('99999')
 
         """
-        return self.rest.get(f"certificate/{certificate_id}")
+        response = self.rest.delete("/certificate/%s" % (certificate_id))
+        return response.status_code
+        # return self.rest.get(f"certificate/{certificate_id}")
 
     def get_enrolment(self, certificate_id: str) -> Box:
         """