zscaler-sdk-python 0.9.4__tar.gz → 0.9.6__tar.gz

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.9.4
+Version: 0.9.6
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -42,8 +42,8 @@ Requires-Dist: requests (>=2.32.3)
 Requires-Dist: responses (>=0.25.3)
 Requires-Dist: restfly (>=1.5.0)
 Requires-Dist: six
-Requires-Dist: xmltodict
-Requires-Dist: yarl
+Requires-Dist: xmltodict (>=0.14.2)
+Requires-Dist: yarl (>=1.14.0)
 Project-URL: Bug Tracker, https://github.com/zscaler/zscaler-sdk-python/issues
 Project-URL: Documentation, https://zscaler-sdk-python.readthedocs.io
 Project-URL: Repository, https://github.com/zscaler/zscaler-sdk-python

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.9.4"
+version = "0.9.6"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -41,15 +41,14 @@ restfly = ">=1.5.0"
 six = "*"
 flatdict = "*"
 pyyaml = "*"
-xmltodict = "*"
-yarl = "*"
+xmltodict = ">=0.14.2"
+yarl = ">=1.14.0"
 pycryptodomex = ">=3.20.0"
 aenum = "*"
 pydash = ">=8.0.3"
 flake8 = "*"
 pytz = ">=2024.2"
 black = ">=24.3.0"
-# cryptography = ">=3.4,<43.0"
 cryptography = ">=43.0.0"
 okta = ">=2.9.7"
 aiohttp = ">=3.10.2"
@@ -61,7 +60,7 @@ pytest-asyncio = "^0.23.8"
 pytest-mock = "*"
 pytest-recording = "^0.13.2"
 pytest-cov = "*"
-pyfakefs = "^5.6.0"
+pyfakefs = ">=5.6.0"
 isort = "*"
 wheel = "*"
 sphinx = "^7.4.7"

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/__init__.py

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

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zia/__init__.py

@@ -399,67 +399,99 @@ class ZIAClientHelper(ZIAClient):
             time.sleep(delay)
         return self.send("DELETE", path, json, params)
 
-    ERROR_MESSAGES = {
-        "UNEXPECTED_STATUS": "Unexpected status code {status_code} received for page {page}.",
-        "MISSING_DATA_KEY": "The key '{data_key_name}' was not found in the response for page {page}.",
-        "EMPTY_RESULTS": "No results found for page {page}.",
-    }
-
-    def get_paginated_data(self, path=None, data_key_name=None, data_per_page=5, expected_status_code=200):
-        """
-        Fetch paginated data from the ZIA API.
-        ...
+    def get_paginated_data(
+        self,
+        path=None,
+        expected_status_code=200,
+        page=None,
+        pagesize=None,
+        search=None,
+    ):
+        """
+        Fetches paginated data from the API based on specified parameters and handles pagination.
+
+        Args:
+            path (str): The API endpoint path to send requests to.
+            expected_status_code (int): The expected HTTP status code for a successful request. Defaults to 200.
+            page (int): Specific page number to fetch. Defaults to 1 if not provided.
+            pagesize (int): Number of items per page, default is 100, with a maximum of 1000.
+            search (str): Search query to filter the results.
 
         Returns:
-        - list: List of fetched items.
-        - str: Error message, if any occurred.
+            tuple: A tuple containing:
+                - BoxList: A list of fetched items wrapped in a BoxList for easy access.
+                - str: An error message if any occurred during the data fetching process.
         """
+        logger = logging.getLogger(__name__)
 
-        page = 1
-        ret_data = []
-        error_message = None
-
-        while True:
-            required_url = f"{path}"
-            should_wait, delay = self.rate_limiter.wait("GET")
-            if should_wait:
-                time.sleep(delay)
-
-            # Now proceed with sending the request
-            response = self.send(
-                method="GET",
-                path=required_url,
-                params={"page": page, "pageSize": data_per_page},
-            )
+        ERROR_MESSAGES = {
+            "UNEXPECTED_STATUS": "Unexpected status code {status_code} received for page {page}.",
+            "EMPTY_RESULTS": "No results found for page {page}.",
+        }
+    
+        params = {}
+        params["page"] = page if page is not None else 1  # Default to page 1
+        params["pagesize"] = min(pagesize if pagesize is not None else 100, 1000)  # Default pagesize is 100, max 1000
 
-            if response.status_code != expected_status_code:
-                error_message = self.ERROR_MESSAGES["UNEXPECTED_STATUS"].format(status_code=response.status_code, page=page)
-                logger.error(error_message)
-                break
-            data_json = response.json()
-            if isinstance(data_json, list):
-                data = data_json
-            else:
-                data = data_json.get(data_key_name)
+        if search:
+            params["search"] = search
+
+        ret_data = []
 
-            if data is None:
-                error_message = self.ERROR_MESSAGES["MISSING_DATA_KEY"].format(data_key_name=data_key_name, page=page)
-                logger.error(error_message)
-                break
+        try:
+            while True:
+                # Apply rate-limiting if necessary
+                should_wait, delay = self.rate_limiter.wait("GET")
+                if should_wait:
+                    time.sleep(delay)
+
+                # Send the request to the API
+                response = self.send("GET", path=path, params=params)
+
+                # Check for unexpected status code
+                if response.status_code != expected_status_code:
+                    error_msg = ERROR_MESSAGES["UNEXPECTED_STATUS"].format(
+                        status_code=response.status_code, page=params["page"]
+                    )
+                    logger.error(error_msg)
+                    return BoxList([]), error_msg
+
+                # Parse the response as a flat list of items
+                response_data = response.json()
+                if not isinstance(response_data, list):
+                    error_msg = ERROR_MESSAGES["EMPTY_RESULTS"].format(page=params["page"])
+                    logger.warn(error_msg)
+                    return BoxList([]), error_msg
+
+                data = convert_keys_to_snake(response_data)
+                
+                # If searching for a specific item, stop if we find a match
+                if search:
+                    for item in data:
+                        if item.get("name") == search:
+                            ret_data.append(item)
+                            return BoxList(ret_data), None
+                
+                # If no search, collect all data from the current page
+                ret_data.extend(data)
+
+                # Stop if we've processed all available pages
+                if len(data) < params["pagesize"]:
+                    break
 
-            if not data:  # Checks for empty data
-                logger.info(self.ERROR_MESSAGES["EMPTY_RESULTS"].format(page=page))
-                break
+                # Move to the next page
+                params["page"] += 1
 
-            ret_data.extend(convert_keys_to_snake(data))
+        finally:
+            time.sleep(2)  # Ensure a delay between requests regardless of outcome
 
-            # Check for more pages
-            if len(data) == 0 or isinstance(data_json, dict) and int(response.json().get("totalPages")) <= page + 1:
-                break
+        if not ret_data:
+            error_msg = ERROR_MESSAGES["EMPTY_RESULTS"].format(page=params["page"])
+            logger.warn(error_msg)
+            return BoxList([]), error_msg
 
-            page += 1
+        return BoxList(ret_data), None
 
-        return BoxList(ret_data), error_message
 
     @property
     def admin_and_role_management(self):

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zia/admin_and_role_management.py

@@ -48,7 +48,8 @@ class AdminAndRoleManagementAPI:
             >>> users = zia.admin_and_role_management.list_users('admin@example.com')
 
         """
-        return BoxList(Iterator(self.rest, "adminUsers", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/adminUsers", **kwargs)
+        return list
 
     def get_user(self, user_id: str) -> Box:
         """

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zia/labels.py

@@ -58,7 +58,8 @@ class RuleLabelsAPI:
             ...    print(label)
 
         """
-        return BoxList(Iterator(self.rest, "ruleLabels", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/ruleLabels", **kwargs)
+        return list
 
     def get_label(self, label_id: str) -> Box:
         """

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zia/locations.py

@@ -64,7 +64,8 @@ class LocationsAPI:
             ...    print(location)
 
         """
-        return BoxList(Iterator(self.rest, "locations", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/locations", **kwargs)
+        return list
 
     def get_location(self, location_id: str = None, location_name: str = None) -> Box:
         """
@@ -482,7 +483,7 @@ class LocationsAPI:
             raise Exception(f"API call failed with status {status_code}: {response.json()}")
         return response
 
-    def list_location_groups(self) -> BoxList:
+    def list_location_groups(self, **kwargs) -> BoxList:
         """
         Return a list of location groups in ZIA.
 
@@ -490,7 +491,11 @@ class LocationsAPI:
             **kwargs: Optional keyword args.
 
         Keyword Args:
-            groupType (str): The location group's type (i.e., Static or Dynamic).
+            name (str): The location group's name.
+            comments (str): Additional comments or information about the location group.
+            groupType (str): The location group's type (i.e., STATIC_GROUP or DYNAMIC_GROUP).
+            location_id (int): The unique identifier for a location within a location group.
+            last_mod_user (str): The admin who modified the location group last.
 
         Returns:
             :obj:`BoxList`: A list of location group resource records.
@@ -499,7 +504,14 @@ class LocationsAPI:
             Get a list of all configured location groups:
             >>> location = zia.locations.list_location_groups()
         """
-        return self.rest.get("locations/groups")
+        return BoxList(
+        Iterator(
+            self.rest,
+            f"locations/groups",
+            max_pages=1,
+            **kwargs,
+        )
+    )
 
     def get_location_group_by_id(self, group_id: int) -> Box:
         """
@@ -517,25 +529,6 @@ class LocationsAPI:
         """
         return self.rest.get(f"locations/groups/{group_id}")
 
-    def get_location_group_by_name(self, group_name: str, page: int = 1, page_size: int = 100) -> Box:
-        """
-        Return a specific location group by its name in ZIA.
-
-        Args:
-            group_name (str): The name of the location group.
-            page (int, optional): Page number to retrieve. Defaults to 1.
-            page_size (int, optional): Number of records per page. Defaults to 100.
-
-        Returns:
-            :obj:`Box`: A location group resource record.
-
-        Examples:
-            Get a specific location group by its name:
-            >>> 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", params=params)
-
     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.
@@ -544,7 +537,7 @@ class LocationsAPI:
             **kwargs: Optional keyword args.
 
         Keyword Args:
-            groupType (str): The location group's type (i.e., Static or Dynamic).
+            groupType (str): The location group's type (i.e., STATIC_GROUP or DYNAMIC_GROUP).
 
         Returns:
             :obj:`BoxList`: A list of location group resource records.
@@ -572,25 +565,6 @@ class LocationsAPI:
         """
         return self.rest.get(f"locations/groups/lite/{group_id}")
 
-    def get_location_group_lite_by_name(self, group_name: str, page: int = 1, page_size: int = 100) -> BoxList:
-        """
-        Return specific location groups (lite version) by their name where only name and ID is returned in ZIA.
-
-        Args:
-            group_name (str): The name of the location group.
-            page (int, optional): Page number to retrieve. Defaults to 1.
-            page_size (int, optional): Number of records per page. Defaults to 100.
-
-        Returns:
-            :obj:`BoxList`: A list of location group resource records with only ID and name.
-
-        Examples:
-            Get specific location groups (lite version) by name:
-            >>> 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", params=params)
-
     def list_location_groups_count(self, **kwargs) -> BoxList:
         """
         Returns a list of location groups for your organization.
@@ -599,7 +573,7 @@ class LocationsAPI:
             **kwargs: Optional keyword args.
 
         Keyword Args:
-            group_type (str): The location group's type (i.e., Static or Dynamic).
+            group_type (str): The location group's type (i.e., STATIC_GROUP or DYNAMIC_GROUP).
             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.
@@ -611,7 +585,7 @@ class LocationsAPI:
 
         Examples:
             Gets the list of location groups for your organization:
-            >>> location = zia.locations.list_location_groups_count(group_type='Static', name='Corporate')
+            >>> location = zia.locations.list_location_groups_count(group_type='STATIC_GROUP', name='Corporate')
         """
         params = {}
         optional_params = ["group_type", "last_mod_user", "version", "name", "comments", "location_id"]

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zia/traffic.py

@@ -642,7 +642,8 @@ class TrafficForwardingAPI:
             >>> for credential in zia.traffic.list_vpn_credentials(page_size=200, max_pages=2):
             ...    print(credential)
         """
-        return BoxList(Iterator(self.rest, "vpnCredentials", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/vpnCredentials", **kwargs)
+        return list
 
     def add_vpn_credential(self, authentication_type: str, pre_shared_key: str = None, **kwargs) -> Box:
         """

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zia/users.py

@@ -69,7 +69,8 @@ class UserManagementAPI:
             >>> for department in zia.users.list_departments(page_size=200, max_pages=2):
             ...    print(department)
         """
-        return BoxList(Iterator(self.rest, "departments", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/departments", **kwargs)
+        return list
 
     def get_department(self, department_id: str) -> Box:
         """
@@ -127,7 +128,8 @@ class UserManagementAPI:
             ...    print(group)
 
         """
-        return BoxList(Iterator(self.rest, "groups", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/groups", **kwargs)
+        return list
 
     def get_group(self, group_id: str) -> Box:
         """
@@ -194,7 +196,8 @@ class UserManagementAPI:
             ...    print(user)
 
         """
-        return BoxList(Iterator(self.rest, "users", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/users", **kwargs)
+        return list
 
     def add_user(self, name: str, email: str, groups: list, department: dict, **kwargs) -> Box:
         """

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zpa/connectors.py

@@ -159,7 +159,7 @@ class AppConnectorControllerAPI:
             params["microtenantId"] = kwargs.pop("microtenant_id")
         return self.rest.delete(f"connector/{connector_id}", params=params).status_code
 
-    def bulk_delete_connectors(self, connector_ids: list, **kwargs) -> int:
+    def bulk_delete_connectors(self, connector_ids: list, **kwargs) -> Box:
         """
         Deletes all specified App Connectors from ZPA.
 
@@ -177,7 +177,16 @@ class AppConnectorControllerAPI:
         params = {}
         if "microtenant_id" in kwargs:
             params["microtenantId"] = kwargs.pop("microtenant_id")
-        return self.rest.post("connector/bulkDelete", json=payload)
+
+        response = self.rest.post("connector/bulkDelete", json=payload, params=params)
+
+        if isinstance(response, Response):
+            # Check for HTTP status and handle errors
+            if response.status_code != 200:
+                raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
+
+        # If successful, return the response
+        return response
 
     def list_connector_groups(self, **kwargs) -> BoxList:
         """

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zpa/policies.py

@@ -78,7 +78,14 @@ class PolicySetsAPI:
             "COUNTRY_CODE": [],
         }
 
+        current_operator = "OR"  # Default operator
+        
         for condition in conditions:
+            # Check if the first item is an operator, like "AND" or "OR"
+            if isinstance(condition, tuple) and isinstance(condition[0], str) and condition[0].upper() in ["AND", "OR"]:
+                current_operator = condition[0].upper()  # Set the current operator
+                condition = condition[1]  # The second element is the actual condition
+
             if isinstance(condition, tuple) and len(condition) == 3:
                 # Handle each object type according to its pattern
                 object_type = condition[0].upper()
@@ -110,10 +117,15 @@ class PolicySetsAPI:
                         object_types_to_operands[object_type].append({"objectType": object_type, "lhs": lhs, "rhs": rhs})
                     else:
                         object_types_to_operands[object_type].append({"objectType": object_type, "lhs": "id", "rhs": rhs})
+                        
             elif isinstance(condition, dict):
+                # This part allows passing operator explicitly through conditions
+                if "operator" in condition:
+                    current_operator = condition["operator"]
+                    continue  # Move to the next condition after setting the operator
+
                 # Handle the dictionary logic based on the Go code schema
                 condition_template = {}
-
                 # Extracting keys from the condition dictionary
                 for key in ["id", "negated", "operator"]:
                     if key in condition:
@@ -144,12 +156,12 @@ class PolicySetsAPI:
 
         # Combine APP and APP_GROUP operands into one block
         if app_and_app_group_operands:
-            template.append({"operator": "OR", "operands": app_and_app_group_operands})
+            template.append({"operator": current_operator, "operands": app_and_app_group_operands})
 
         # Combine other object types into their own blocks
         for object_type, operands in object_types_to_operands.items():
             if operands:
-                template.append({"operator": "OR", "operands": operands})
+                template.append({"operator": current_operator, "operands": operands})
 
         return template
 
@@ -390,7 +402,9 @@ class PolicySetsAPI:
                     ('app', 'id', '88888'),
                     ('app_group', 'id', '77777),
                     ('client_type', 'zpn_client_type_exporter', 'zpn_client_type_zapp'),
-                    ('trusted_network', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx', True)]
+                    ("OR", 'trusted_network', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx', True))
+                    ("OR", ("posture", "d019df8b-ec97-4087-a892-749b5abca54c", "false")),
+                    ]
             custom_msg (str):
                 A custom message.
             description (str):

{zscaler_sdk_python-0.9.4 → zscaler_sdk_python-0.9.6}/zscaler/zpa/service_edges.py

@@ -155,7 +155,7 @@ class ServiceEdgesAPI:
             params["microtenantId"] = kwargs.pop("microtenant_id")
         return self.rest.delete(f"serviceEdge/{service_edge_id}", params=params).status_code
 
-    def bulk_delete_service_edges(self, service_edge_ids: list, **kwargs) -> int:
+    def bulk_delete_service_edges(self, service_edge_ids: list, **kwargs) -> Box:
         """
         Bulk deletes the specified Service Edges from ZPA.