zscaler-sdk-python 0.6.0__tar.gz → 0.6.2__tar.gz

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/PKG-INFO

@@ -1,23 +1,23 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.6.0
+Version: 0.6.2
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
 Keywords: zscaler,sdk,zpa,zia,zdx,zcc,zcon
 Author: Zscaler, Inc.
 Author-email: devrel@zscaler.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: dev

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.6.0"
+version = "0.6.2"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -28,7 +28,7 @@ packages = [
 "Bug Tracker" = "https://github.com/zscaler/zscaler-sdk-python/issues"
 
 [tool.poetry.dependencies]
-python = ">=3.8,<4.0"
+python = ">=3.9,<4.0"
 arrow = "*"
 certifi = ">=2024.2.2"
 charset-normalizer = "*"
@@ -55,15 +55,15 @@ okta = ">=2.9.7"
 
 [tool.poetry.dev-dependencies]
 black = ">=24.3.0"
-pytest = ">=8.2.1"
-pytest-asyncio = ">=0.23.7"
+pytest = ">=8.2.2"
+pytest-asyncio = "^0.23.8"
 pytest-mock = "*"
-pytest-recording = "*"
+pytest-recording = "^0.13.2"
 pytest-cov = "*"
-pyfakefs = "*"
+pyfakefs = "^5.6.0"
 isort = "*"
 wheel = "*"
-sphinx = "*"
+sphinx = "^7.4.6"
 sphinx-autobuild = "*"
 sphinx_rtd_theme = "*"
 

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/__init__.py

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

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/constants.py

@@ -14,7 +14,7 @@ ZPA_BASE_URLS = {
 
 DEV_AUTH_URL = "https://authn1.dev.zpath.net/authn/v1/oauth/token"
 
-RETRYABLE_STATUS_CODES = {409, 429, 500, 502, 503, 504}
+RETRYABLE_STATUS_CODES = {409, 412, 429, 500, 502, 503, 504}
 MAX_RETRIES = 5
 BACKOFF_FACTOR = 1
 BACKOFF_BASE_DURATION = 2

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/zia/__init__.py

@@ -12,6 +12,7 @@ from box import Box, BoxList
 from zscaler import __version__
 from zscaler.cache.no_op_cache import NoOpCache
 from zscaler.cache.zscaler_cache import ZscalerCache
+from zscaler.constants import MAX_RETRIES
 from zscaler.errors.http_error import HTTPError, ZscalerAPIError
 from zscaler.exceptions.exceptions import HTTPException, ZscalerAPIException
 from zscaler.logger import setup_logging
@@ -118,7 +119,7 @@ class ZIAClientHelper(ZIAClient):
         self.sandbox_token = kw.get("sandbox_token") or os.getenv(f"{self._env_base}_SANDBOX_TOKEN")
         self.timeout = timeout
         self.fail_safe = fail_safe
-        cache_enabled = os.environ.get("ZSCALER_CLIENT_CACHE_ENABLED", "true").lower() == "true"
+        cache_enabled = os.environ.get("ZSCALER_CLIENT_CACHE_ENABLED", "false").lower() == "true"
         if cache is None:
             if cache_enabled:
                 ttl = int(os.environ.get("ZSCALER_CLIENT_CACHE_DEFAULT_TTL", 3600))
@@ -168,13 +169,11 @@ class ZIAClientHelper(ZIAClient):
         if self.auth_details is None:
             return True
         now = datetime.datetime.now()
-        if self.auth_details["passwordExpiryTime"] > 0 and (
-            self.session_refreshed + datetime.timedelta(seconds=-self.session_timeout_offset) < now
-        ):
+        if self.auth_details["passwordExpiryTime"] > 0 and (self.session_refreshed - self.session_timeout_offset < now):
             return True
         return False
 
-    @retry_with_backoff(retries=5)
+    @retry_with_backoff(MAX_RETRIES)
     def authenticate(self) -> Box:
         """
         Creates a ZIA authentication session.

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/zia/isolation_profile.py

@@ -39,8 +39,7 @@ class IsolationProfileAPI:
             >>> isolation_profiles = zia.isolation_profiles.list_isolation_profiles()
 
         """
-        payload = {snake_to_camel(key): value for key, value in kwargs.items()}
-        return self.rest.get("browserIsolation/profiles", json=payload)
+        return self.rest.get("browserIsolation/profiles")
 
     def get_profiles_by_name(self, name: str):
         """

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/zia/locations.py

@@ -462,7 +462,28 @@ class LocationsAPI:
         """
         return self.rest.delete(f"locations/{location_id}").status_code
 
-    def list_location_groups(self, **kwargs) -> BoxList:
+    def bulk_delete_locations(self, location_ids: list, **kwargs) -> int:
+        """
+        Deletes all specified Location Management from ZIA.
+
+        Args:
+            location_ids (list): The list of unique ids for the ZIA Locations that will be deleted.
+
+        Returns:
+            :obj:`int`: The status code for the operation.
+
+        Examples:
+            >>> zia.locations.bulk_delete_locations(['111111', '222222', '333333'])
+
+        """
+        payload = {"ids": location_ids}
+        response = self.rest.post("locations/bulkDelete", json=payload).status_code
+        if isinstance(response, Response):
+            status_code = response.status_code
+            raise Exception(f"API call failed with status {status_code}: {response.json()}")
+        return response
+
+    def list_location_groups(self) -> BoxList:
         """
         Return a list of location groups in ZIA.
 
@@ -479,8 +500,7 @@ class LocationsAPI:
             Get a list of all configured location groups:
             >>> location = zia.locations.list_location_groups()
         """
-        payload = {snake_to_camel(key): value for key, value in kwargs.items()}
-        return self.rest.get("locations/groups", json=payload)
+        return self.rest.get("locations/groups")
 
     def get_location_group_by_id(self, group_id: int) -> Box:
         """
@@ -515,9 +535,9 @@ class LocationsAPI:
             >>> location = zia.locations.get_location_group_by_name("Unassigned Locations")
         """
         params = {"page": page, "pageSize": page_size, "search": group_name}
-        return self.rest.get("locations/groups", json=params)
+        return self.rest.get("locations/groups", params=params)
 
-    def list_location_groups_lite(self, **kwargs) -> BoxList:
+    def list_location_groups_lite(self, page: int = 1, page_size: int = 100) -> BoxList:
         """
         Returns a list of location groups (lite version) by their ID where only name and ID is returned in ZIA.
 
@@ -534,8 +554,8 @@ class LocationsAPI:
             Get a list of all configured location groups:
             >>> location = zia.locations.list_location_groups_lite()
         """
-        payload = {snake_to_camel(key): value for key, value in kwargs.items()}
-        return self.rest.get("locations/groups/lite", json=payload)
+        params = {"page": page, "pageSize": page_size}
+        return self.rest.get("locations/groups/lite", params=params)
 
     def get_location_group_lite_by_id(self, group_id: int) -> Box:
         """
@@ -570,7 +590,39 @@ class LocationsAPI:
             >>> locations = zia.locations.get_location_group_lite_by_name("Unassigned Locations")
         """
         params = {"page": page, "pageSize": page_size, "search": group_name}
-        return self.rest.get("locations/groups/lite", json=params)
+        return self.rest.get("locations/groups/lite", params=params)
+
+    def list_location_groups_count(self, **kwargs) -> BoxList:
+        """
+        Returns a list of location groups for your organization.
+
+        Args:
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            group_type (str): The location group's type (i.e., Static or Dynamic).
+            last_mod_user (str): The admin who modified the location group last.
+            version (int): The version parameter is for Zscaler internal use only. Used by the service for backup operations.
+            name (str): The location group's name.
+            comments (str): Additional comments or information about the location group.
+            location_id (int): The unique identifier for a location within a location group.
+
+        Returns:
+            :obj:`BoxList`: A list of location group resource records.
+
+        Examples:
+            Gets the list of location groups for your organization:
+            >>> location = zia.locations.list_location_groups_count(group_type='Static', name='Corporate')
+        """
+        params = {}
+        optional_params = ["group_type", "last_mod_user", "version", "name", "comments", "location_id"]
+
+        for key in optional_params:
+            if key in kwargs:
+                params[key] = kwargs[key]
+
+        response = self.rest.get("locations/groups/count", params=params)
+        return int(response.text)
 
     def list_region_geo_coordinates(self, latitude: int, longitude: int) -> Box:
         """

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/zia/workload_groups.py

@@ -26,14 +26,14 @@ class WorkloadGroupsAPI:
 
     def list_groups(self, **kwargs) -> BoxList:
         """
-        Returns a list of all firewall filter rules.
+        Returns a list of all workload groups configured in the ZIA Admin Portal.
 
         Returns:
-            :obj:`BoxList`: The list of firewall filter rules
+            :obj:`BoxList`: The list of workload groups
 
         Examples:
-            >>> for rule in zia.workload_groups.list_groups():
-            ...    pprint(rule)
+            >>> for workloads in zia.workload_groups.list_groups():
+            ...    pprint(workloads)
 
         """
         response = self.rest.get("/workloadGroups")
@@ -43,6 +43,19 @@ class WorkloadGroupsAPI:
 
     # Search Workload Group By Name
     def get_group_by_name(self, name):
+        """
+        Retrieves a specific workload group by its name.
+
+        Args:
+            name (str): The name of the workload group  to retrieve.
+
+        Returns:
+            :obj:`Box`: The workload group  if found, otherwise None.
+
+        Examples:
+            >>> workload = zia.workload_groups.get_group_by_name('BD_WORKLOAD_GROUP01')
+            ...    print(workload)
+        """
         groups = self.list_groups()
         for group in groups:
             if group.get("name") == name:
@@ -51,6 +64,19 @@ class WorkloadGroupsAPI:
 
     # Search Workload Group By ID
     def get_group_by_id(self, group_id):
+        """
+        Retrieves a specific workload group by its unique identifier.
+
+        Args:
+            profile_id (str): The ID of the workload group  to retrieve.
+
+        Returns:
+            :obj:`Box`: The workload group if found, otherwise None.
+
+        Examples:
+            >>> workload = zia.get_group_by_name.get_group_by_id('12345')
+            ...    print(workload)
+        """
         groups = self.list_groups()
         for group in groups:
             if group.get("id") == group_id:

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/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, DEV_AUTH_URL
+from zscaler.constants import ZPA_BASE_URLS, DEV_AUTH_URL, MAX_RETRIES
 from zscaler.errors.http_error import HTTPError, ZscalerAPIError
 from zscaler.exceptions.exceptions import HTTPException, ZscalerAPIException
 from zscaler.logger import setup_logging
@@ -148,7 +148,7 @@ class ZPAClientHelper(ZPAClient):
                 "User-Agent": self.user_agent,
             }
 
-    @retry_with_backoff(retries=5)
+    @retry_with_backoff(MAX_RETRIES)
     def login(self):
         params = {"client_id": self.client_id, "client_secret": self.client_secret}
         headers = {

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/zpa/client.py

@@ -57,7 +57,7 @@ class ZPAClient:
         scim_user_id=None,
         scim_username=None,
         page=None,
-        pagesize=20,
+        pagesize=500,
         microtenant_id=None,
     ):
         """

{zscaler_sdk_python-0.6.0 → zscaler_sdk_python-0.6.2}/zscaler/zpa/isolation.py

@@ -368,7 +368,7 @@ class IsolationAPI:
                 return profile
         return None
 
-    def list_cbi_profiles(self: str) -> Box:
+    def list_cbi_profiles(self) -> Box:
         """
         Returns information on the specified Cloud browser isolation.