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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.9.6
+Version: 0.10.0
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT

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

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

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

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

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

@@ -39,6 +39,7 @@ from zscaler.zia.forwarding_control import ForwardingControlAPI
 from zscaler.zia.cloudappcontrol import CloudAppControlAPI
 from zscaler.zia.isolation_profile import IsolationProfileAPI
 from zscaler.zia.labels import RuleLabelsAPI
+from zscaler.zia.pac_files import PacFilesAPI
 from zscaler.zia.locations import LocationsAPI
 from zscaler.zia.sandbox import CloudSandboxAPI
 from zscaler.zia.security import SecurityPolicyAPI
@@ -406,6 +407,14 @@ class ZIAClientHelper(ZIAClient):
         page=None,
         pagesize=None,
         search=None,
+        max_page_size=1000,  # Default to 1000, can be adjusted based on endpoint constraints
+        max_items=None,  # Maximum number of items to retrieve across pages
+        max_pages=None,  # Maximum number of pages to retrieve
+        type=None,  # Specify type of VPN credentials (CN, IP, UFQDN, XAUTH)
+        include_only_without_location=None,  # Include only VPN credentials not associated with any location
+        location_id=None,  # VPN credentials for a specific location ID
+        managed_by=None,  # VPN credentials managed by a given partner
+        prefix=None,  # VPN credentials managed by a given partner
     ):
         """
         Fetches paginated data from the API based on specified parameters and handles pagination.
@@ -416,6 +425,13 @@ class ZIAClientHelper(ZIAClient):
             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.
+            max_items (int): Maximum number of items to retrieve.
+            max_pages (int): Maximum number of pages to fetch.
+            type (str, optional): Type of VPN credentials (e.g., CN, IP, UFQDN, XAUTH).
+            include_only_without_location (bool, optional): Filter to include only VPN credentials not associated with a location.
+            location_id (int, optional): Retrieve VPN credentials for the specified location ID.
+            managed_by (int, optional): Retrieve VPN credentials managed by the specified partner.
+            prefix (int, optional): Retrieve VPN credentials managed by the specified partner.
 
         Returns:
             tuple: A tuple containing:
@@ -428,15 +444,29 @@ class ZIAClientHelper(ZIAClient):
             "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
 
+        # Initialize pagination parameters
+        params = {
+            "page": page if page is not None else 1,  # Start at page 1 if not specified
+            "pagesize": min(pagesize if pagesize is not None else 100, max_page_size),  # Apply max_page_size limit
+        }
+
+        # Add optional filters to the params if provided
         if search:
             params["search"] = search
+        if type:
+            params["type"] = type
+        if include_only_without_location is not None:
+            params["includeOnlyWithoutLocation"] = include_only_without_location
+        if location_id:
+            params["locationId"] = location_id
+        if managed_by:
+            params["managedBy"] = managed_by
+        if prefix:
+            params["prefix"] = prefix
 
         ret_data = []
+        total_collected = 0
 
         try:
             while True:
@@ -464,18 +494,27 @@ class ZIAClientHelper(ZIAClient):
                     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
+
+                # Limit data collection based on max_items
+                if max_items is not None:
+                    data = data[: max_items - total_collected]  # Limit items on the current page
                 ret_data.extend(data)
+                total_collected += len(data)
+
+                # Check if we've reached max_items or max_pages limits
+                if (max_items is not None and total_collected >= max_items) or (
+                    max_pages is not None and params["page"] >= max_pages
+                ):
+                    break
 
-                # Stop if we've processed all available pages
+                # Stop if we've processed all available pages (i.e., less than requested page size)
                 if len(data) < params["pagesize"]:
                     break
 
@@ -492,7 +531,6 @@ class ZIAClientHelper(ZIAClient):
 
         return BoxList(ret_data), None
 
-
     @property
     def admin_and_role_management(self):
         """
@@ -677,3 +715,11 @@ class ZIAClientHelper(ZIAClient):
 
         """
         return WorkloadGroupsAPI(self)
+
+    @property
+    def pac_files(self):
+        """
+        The interface object for the :ref:`ZIA Pac Files interface <zia-pac_files>`.
+
+        """
+        return PacFilesAPI(self)

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

@@ -18,7 +18,7 @@
 from box import Box, BoxList
 from requests import Response
 
-from zscaler.utils import Iterator, convert_keys, snake_to_camel
+from zscaler.utils import convert_keys, snake_to_camel
 from zscaler.zia import ZIAClient
 
 

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

@@ -18,7 +18,7 @@
 from box import Box, BoxList
 from requests import Response
 
-from zscaler.utils import Iterator, snake_to_camel
+from zscaler.utils import snake_to_camel
 from zscaler.zia import ZIAClient
 
 
@@ -188,7 +188,7 @@ class LocationsAPI:
                 Additional notes or information regarding the location or sub-location. The description cannot
                 exceed 1024 characters.
             static_location_groups (list): IDs for static location groups.
-            
+
         Returns:
             :obj:`Box`: The newly created location resource record
 
@@ -258,14 +258,8 @@ class LocationsAPI:
             ...    pprint(sub_location)
 
         """
-        return BoxList(
-            Iterator(
-                self.rest,
-                f"locations/{location_id}/sublocations",
-                max_pages=1,
-                **kwargs,
-            )
-        )
+        list, _ = self.rest.get_paginated_data(path=f"/locations/{location_id}/sublocations", **kwargs)
+        return list
 
     def list_locations_lite(self, **kwargs) -> BoxList:
         """
@@ -305,7 +299,8 @@ class LocationsAPI:
             ...    print(location)
 
         """
-        return BoxList(Iterator(self.rest, "locations/lite", **kwargs))
+        list, _ = self.rest.get_paginated_data(path="/locations/lite", **kwargs)
+        return list
 
     def update_location(self, location_id: str, **kwargs) -> Box:
         """
@@ -504,14 +499,8 @@ class LocationsAPI:
             Get a list of all configured location groups:
             >>> location = zia.locations.list_location_groups()
         """
-        return BoxList(
-        Iterator(
-            self.rest,
-            f"locations/groups",
-            max_pages=1,
-            **kwargs,
-        )
-    )
+        list, _ = self.rest.get_paginated_data(path="/locations/groups", **kwargs)
+        return list
 
     def get_location_group_by_id(self, group_id: int) -> Box:
         """
@@ -665,5 +654,5 @@ class LocationsAPI:
             returned. Ensure you narrow your search result as much as possible to avoid this.
 
         """
-        return BoxList(Iterator(self.rest, "region/search", **kwargs))
-
+        list, _ = self.rest.get_paginated_data(path="/region/search", **kwargs)
+        return list

zscaler_sdk_python-0.10.0/zscaler/zia/pac_files.py

@@ -0,0 +1,429 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Zscaler Inc.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+from box import Box, BoxList
+from requests import Response
+
+from zscaler.utils import snake_to_camel
+from zscaler.zia import ZIAClient
+
+
+class PacFilesAPI:
+    def __init__(self, client: ZIAClient):
+        self.rest = client
+
+    def list_pac_files(self, **kwargs) -> BoxList:
+        """
+        Returns the list of ZIA Pac Files.
+
+        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.
+            **page_size (int, optional):
+                Specifies the page size. The default size is 100, but the maximum size is 1000.
+
+        Returns:
+            :obj:`BoxList`: The list of Rule Labels configured in ZIA.
+
+        Examples:
+            List Rule Labels using default settings:
+
+            >>> for label in zia.labels.list_labels():
+            ...   print(label)
+
+            List labels, limiting to a maximum of 10 items:
+
+            >>> for label in zia.labels.list_labels(max_items=10):
+            ...    print(label)
+
+            List labels, returning 200 items per page for a maximum of 2 pages:
+
+            >>> for label in zia.labels.list_labels(page_size=200, max_pages=2):
+            ...    print(label)
+
+        """
+        list, _ = self.rest.get_paginated_data(path="/pacFiles", **kwargs)
+        return list
+
+    def get_pac_file(self, pac_id: str, filter: str = None) -> Box:
+        """
+        Returns the PAC file details for a given PAC ID.
+
+        Args:
+            pac_id (str): The unique identifier for the PAC file.
+            filter (str, optional): Excludes specific information about the PAC file from
+                                    the response such as the PAC file content.
+                                    Accepts only the value 'pac_content'.
+
+        Returns:
+            :obj:`Box`: The PAC file resource record.
+
+        Example:
+            >>> pac_file = zia.get_pac_file('12345', filter='pac_content')
+        """
+        # Construct URL with optional filter
+        url = f"/pacFiles/{pac_id}/version"
+        if filter == "pac_content":
+            url += f"?filter={filter}"
+
+        response = self.rest.get(url)
+        if isinstance(response, Response):
+            if response.status_code != 200:
+                return None
+        return response
+
+    def get_pac_file_version(self, pac_id: str, pac_version: str, filter: str = None) -> Box:
+        """
+        Returns the PAC file version details for a given PAC ID and version.
+
+        Args:
+            pac_id (str): The unique identifier for the PAC file.
+            pac_version (str): The specific version of the PAC file.
+            filter (str, optional): Excludes specific information about the PAC file from
+                                    the response such as the PAC file content.
+                                    Accepts only the value 'pac_content'.
+
+        Returns:
+            :obj:`Box`: The PAC file version resource record.
+
+        Example:
+            >>> pac_file_version = zia.get_pac_file_version('12345', '1', filter='pac_content')
+        """
+        # Construct URL with optional filter
+        url = f"/pacFiles/{pac_id}/version/{pac_version}"
+        if filter == "pac_content":
+            url += f"?filter={filter}"
+
+        response = self.rest.get(url)
+        if isinstance(response, Response):
+            if response.status_code != 200:
+                return None
+        return response
+
+    def validate_pac_file(self, pac_file_content: str) -> Box:
+        """
+        Sends the PAC file content for validation and returns the validation result.
+
+        Args:
+            pac_file_content (str): The PAC file content to be validated.
+
+        Returns:
+            Box: The API response containing the validation result.
+
+        Raises:
+            Exception: If the API call fails with a non-2xx status code.
+
+        Example:
+            To validate PAC file content:
+
+            .. code-block:: python
+
+                pac_file_content = '''
+                function FindProxyForURL(url, host) {
+                    return "PROXY gateway.example.com:80";
+                }
+                '''
+                
+                response = client.validate_pac_file(pac_file_content=pac_file_content)
+                if response["success"]:
+                    print("PAC file is valid.")
+                else:
+                    print("PAC file validation failed.")
+        """
+        # Send only the PAC content as the raw body
+        response = self.rest.post("pacFiles/validate", data=pac_file_content)
+
+        # Check if the response is successful and already in Box format
+        if isinstance(response, Box):
+            return response
+        elif isinstance(response, Response):
+            if response.status_code != 200:
+                raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
+            # Convert to Box if needed
+            return Box(response.json())
+
+    def add_pac_file(
+        self,
+        name: str,
+        description: str,
+        domain: str,
+        pac_commit_message: str,
+        pac_verification_status: str,
+        pac_version_status: str,
+        pac_content: str,
+        **kwargs,
+    ) -> Box:
+        """
+        Adds a new custom PAC file after validating the PAC content.
+
+        Args:
+            name (str): The name of the new PAC file.
+            description (str): The description of the new PAC file.
+            domain (str): The domain of your organization to which the PAC file applies.
+            pac_commit_message (str): The commit message entered while saving the PAC file version as indicated by the pacVersion field.
+            pac_verification_status (str): Indicates the verification status of the PAC file and if any errors are identified in the syntax.
+                                           Supported Values: `VERIFY_NOERR`, `VERIFY_ERR`, `NOVERIFY`
+            pac_version_status (str): Version status of the new PAC file.
+                                      Supported Values: `DEPLOYED`, `STAGE`, `LKG`
+            pac_content (str): The actual PAC file content to be validated and cloned.
+
+        Keyword Args:
+            Additional optional parameters as key-value pairs.
+
+        Returns:
+            Box: The newly added PAC file resource record.
+
+        Example:
+            >>> pac_file = zia.add_pac_file(
+                    name="Test_Pac_File_01",
+                    description="Test_Pac_File_01",
+                    domain="bd-hashicorp.com",
+                    pacCommitMessage="Test_Pac_File_01",
+                    pacVerificationStatus="VERIFY_NOERR",
+                    pacVersionStatus="DEPLOYED",
+                    pacContent="function FindProxyForURL(url, host) { return 'PROXY gateway.example.com:80'; }"
+                )
+        """
+        validation_result = self.validate_pac_file(pac_content)
+        if not validation_result.success:
+            raise Exception("PAC content validation failed: {}".format(validation_result))
+
+        payload = {
+            "name": name,
+            "description": description,
+            "domain": domain,
+            "pacCommitMessage": pac_commit_message,
+            "pacVerificationStatus": pac_verification_status,
+            "pacVersionStatus": pac_version_status,
+            "pacContent": pac_content,
+        }
+
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        response = self.rest.post("pacFiles", json=payload)
+        if isinstance(response, Response):
+            if response.status_code != 200:
+                raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
+            return Box(response.json())
+        return response
+
+    def clone_pac_file(
+        self,
+        pac_id: str,
+        pac_version: str,
+        name: str,
+        description: str,
+        domain: str,
+        pac_commit_message: str,
+        pac_verification_status: str,
+        pac_version_status: str,
+        pac_content: str,
+        delete_version: int = None,
+        **kwargs,
+    ) -> Box:
+        """
+        Clones an existing PAC file by creating a new PAC file based on the specified PAC ID and version.
+
+        Args:
+            pac_id (str): The unique identifier of the PAC file to be cloned.
+            pac_version (str): The specific version of the PAC file to be cloned.
+            name (str): The name of the new PAC file.
+            domain (str): The domain associated with the new PAC file.
+            pac_commit_message (str): Commit message for the new PAC file.
+            pac_verification_status (str): Verification status of the new PAC file.
+                                        Supported Values: `VERIFY_NOERR`, `VERIFY_ERR`, `NOVERIFY`
+            pac_version_status (str): Version status of the new PAC file.
+                                    Supported Values: `DEPLOYED`, `STAGE`, `LKG`
+            pac_content (str): The actual PAC file content to be validated and cloned.
+            delete_version (int, optional): Specifies the PAC file version to replace if the version limit of 10 is reached.
+
+        Keyword Args:
+            Additional optional parameters as key-value pairs.
+
+        Returns:
+            Box: The newly cloned PAC file resource record.
+
+        Example:
+            >>> pac_file = zia.clone_pac_file(
+                    pac_id="12345",
+                    pac_version="1",
+                    name="Cloned_Pac_File_01",
+                    description="Cloned_Pac_File_01",
+                    domain="bd-hashicorp.com",
+                    pac_commit_message="Clone of Test_Pac_File_01",
+                    pac_verification_status="VERIFY_NOERR",
+                    pac_version_status="DEPLOYED",
+                    pac_content="function FindProxyForURL(url, host) { return 'PROXY gateway.example.com:80'; }",
+                    delete_version=5
+                )
+        """
+        # Step 1: Validate the PAC content
+        validation_result = self.validate_pac_file(pac_content)
+        if not validation_result.success:
+            raise Exception("PAC content validation failed: {}".format(validation_result))
+
+        # Step 2: Check the number of PAC file versions
+        pac_file_details = self.get_pac_file(pac_id)
+        if isinstance(pac_file_details, Box):
+            pac_file_details = pac_file_details.to_list()  # Convert Box to a list of dictionaries if needed
+
+        # Extract pac versions from details
+        pac_versions = [entry.get("pacVersion") for entry in pac_file_details] if pac_file_details else []
+        total_versions = len(pac_versions)
+
+        # Step 3: Decide on including delete_version in the URL
+        if total_versions >= 10:
+            if delete_version is None:
+                # If delete_version was not provided, default to the oldest version (smallest number)
+                delete_version = min(pac_versions)
+            url = f"/pacFiles/{pac_id}/version/{pac_version}?deleteVersion={delete_version}"
+        else:
+            url = f"/pacFiles/{pac_id}/version/{pac_version}"
+
+        # Step 4: Construct the payload with mandatory fields
+        payload = {
+            "name": name,
+            "description": description,
+            "domain": domain,
+            "pacCommitMessage": pac_commit_message,
+            "pacVerificationStatus": pac_verification_status,
+            "pacVersionStatus": pac_version_status,
+            "pacContent": pac_content,
+        }
+
+        # Add any additional optional parameters
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        # Step 5: Make the request to clone the PAC file
+        response = self.rest.post(url, json=payload)
+        if isinstance(response, Response):
+            if response.status_code != 200:
+                raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
+            return Box(response.json())
+        return response
+
+    def update_pac_file(
+        self,
+        pac_id: str,
+        pac_version: str,
+        pac_version_action: str,
+        name: str,
+        description: str,
+        domain: str,
+        pac_commit_message: str,
+        pac_verification_status: str,
+        # pac_version_status: str,
+        pac_content: str,
+        new_lkg_ver: int = None,
+        **kwargs,
+    ) -> Box:
+        """
+        Performs the specified action on the PAC file version and updates the file status.
+        Supported actions include deploying, staging, unstaging, and marking or unmarking
+        the file as last known good version.
+
+        Args:
+            pac_id (str): The unique identifier of the PAC file to be updated.
+            pac_version (str): The specific version of the PAC file to be updated.
+            pac_version_action (str): Action to perform on the PAC version.
+                                    Supported Values: `DEPLOY`, `STAGE`, `LKG`, `UNSTAGE`, `REMOVE_LKG`
+            name (str): The name of the PAC file.
+            description (str): Description of the PAC file.
+            domain (str): The domain associated with the PAC file.
+            pac_commit_message (str): Commit message for the PAC file.
+            pac_verification_status (str): Verification status of the PAC file.
+                                        Supported Values: `VERIFY_NOERR`, `VERIFY_ERR`, `NOVERIFY`
+            pac_version_status (str): Version status of the PAC file.
+                                    Supported Values: `DEPLOYED`, `STAGE`, `LKG`
+            pac_content (str): The actual PAC file content to be updated.
+            new_lkg_ver (int, optional): Specifies a different version to be marked as the last known good version
+                                        if the action is removing the current last known good version.
+
+        Keyword Args:
+            Additional optional parameters as key-value pairs.
+
+        Returns:
+            Box: The updated PAC file resource record.
+
+        Example:
+            >>> pac_file = zia.update_pac_file(
+                    pac_id="12345",
+                    pac_version="1",
+                    pac_version_action="DEPLOY",
+                    name="Update_Pac_File_01",
+                    description="Update_Pac_File_01",
+                    domain="bd-hashicorp.com",
+                    pac_commit_message="Update_Pac_File_01",
+                    pac_verification_status="VERIFY_NOERR",
+                    pac_version_status="DEPLOYED",
+                    pac_content="function FindProxyForURL(url, host) { return 'PROXY gateway.example.com:80'; }",
+                    new_lkg_ver=5
+                )
+        """
+        # Step 1: Validate the PAC content
+        validation_result = self.validate_pac_file(pac_content)
+        if not validation_result.success:
+            raise Exception("PAC content validation failed: {}".format(validation_result))
+
+        # Step 2: Construct the URL with mandatory parameters and optional newLKGVer
+        url = f"/pacFiles/{pac_id}/version/{pac_version}/action/{pac_version_action}"
+        if new_lkg_ver is not None:
+            url += f"?newLKGVer={new_lkg_ver}"
+
+        # Step 3: Construct the payload with required fields
+        payload = {
+            "name": name,
+            "description": description,
+            "domain": domain,
+            "pacCommitMessage": pac_commit_message,
+            "pacVerificationStatus": pac_verification_status,
+            # "pacVersionStatus": pac_version_status,
+            "pacContent": pac_content,
+        }
+
+        # Add any additional optional parameters
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        # Step 4: Make the request to update the PAC file
+        response = self.rest.put(url, json=payload)
+        if isinstance(response, Response):
+            if response.status_code != 200:
+                raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
+            return Box(response.json())
+        return response
+
+    def delete_pac_file(self, pac_id):
+        """
+        Deletes the specified Pac File.
+
+        Args:
+            pac_id (str): The unique identifier of the Pac File that will be deleted.
+
+        Returns:
+            :obj:`int`: The response code for the request.
+
+        Examples
+            >>> user = zia.pac_files.delete_pac_file('99999')
+
+        """
+        return self.rest.delete(f"pacFiles/{pac_id}").status_code
+

{zscaler_sdk_python-0.9.6 → zscaler_sdk_python-0.10.0}/zscaler/zia/security.py

@@ -163,11 +163,23 @@ class SecurityPolicyAPI:
 
         payload = {"blacklistUrls": url_list}
 
-        resp = self.rest.post("security/advanced/blacklistUrls?action=ADD_TO_LIST", json=payload).status_code
-
-        # Return the object if it was updated successfully
-        if resp == 204:
-            return self.get_blacklist()
+        try:
+            # Send the POST request to add URLs to the blacklist
+            response = self.rest.post("security/advanced/blacklistUrls?action=ADD_TO_LIST", json=payload)
+
+            # Check if the response includes an empty 'blacklistUrls', signaling no update
+            if "blacklistUrls" in response and not response["blacklistUrls"]:
+                raise Exception("Failed to add URLs to blacklist: The API response returned an empty 'blacklistUrls' list.")
+
+            # Verify the URLs were added by checking the current blacklist
+            updated_blacklist = self.get_blacklist()
+            if all(url in updated_blacklist for url in url_list):
+                return updated_blacklist
+            else:
+                raise Exception("Failed to add URLs to blacklist: URLs were not present in the updated blacklist.")
+
+        except Exception as exc:
+            raise Exception(f"Failed to add URLs to blacklist: {exc}")
 
     def replace_blacklist(self, url_list: list) -> BoxList:
         """

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

@@ -17,7 +17,7 @@
 
 from box import Box, BoxList
 
-from zscaler.utils import Iterator, convert_keys, snake_to_camel
+from zscaler.utils import convert_keys, snake_to_camel
 from zscaler.zia import ZIAClient
 
 

{zscaler_sdk_python-0.9.6 → zscaler_sdk_python-0.10.0}/zscaler/zpa/__init__.py

@@ -378,7 +378,7 @@ class ZPAClientHelper(ZPAClient):
         search_field="name",
         max_pages=None,
         max_items=None,
-        all_entries=False,  # Return all SCIM groups including the deleted ones if set to true
+        all_entries=False,
         sort_order=None,
         sort_by=None,
         sort_dir=None,
@@ -432,15 +432,10 @@ class ZPAClientHelper(ZPAClient):
         if params is None:
             params = {}
 
-        if (page is not None or pagesize is not None) and (max_pages is not None or max_items is not None):
-            raise ValueError(
-                "Do not mix 'page' or 'pagesize' with 'max_pages' or 'max_items'. Choose either set of parameters."
-            )
-
-        params["page"] = page if page is not None else 1  # Default to page 1 if not specified
-        params["pagesize"] = min(pagesize if pagesize is not None else 20, 500)  # Apply maximum constraint and handle default
+        # Set initial pagination params
+        params["page"] = page or 1
+        params["pagesize"] = min(pagesize, 500) if pagesize else 500
 
-        # Check for microtenantId in function arguments first, then environment variable
         if microtenant_id:
             params["microtenantId"] = microtenant_id
         elif self.microtenant_id and "microtenantId" not in params:
@@ -472,7 +467,8 @@ class ZPAClientHelper(ZPAClient):
 
         try:
             while True:
-                if max_pages is not None and (page is not None and page > max_pages):
+                # Stop if max_pages reached
+                if max_pages is not None and params["page"] > max_pages:
                     break
 
                 should_wait, delay = self.rate_limiter.wait("GET")
@@ -490,23 +486,27 @@ class ZPAClientHelper(ZPAClient):
 
                 response_data = response.json()
                 data = response_data.get("list", [])
-                if not data and (params["page"] == 1):
+                if not data and params["page"] == 1:
                     error_msg = ERROR_MESSAGES["EMPTY_RESULTS"]
                     logger.warn(error_msg)
                     return BoxList([]), error_msg
 
+                # Convert and extend the collected data
                 data = convert_keys_to_snake(data)
                 ret_data.extend(data[: max_items - total_collected] if max_items is not None else data)
                 total_collected += len(data)
 
+                # Check if we’ve collected the max_items
                 if max_items is not None and total_collected >= max_items:
                     break
 
-                next_page = response_data.get("nextPage")
-                if not next_page or (max_pages is not None and params["page"] >= max_pages):
+                # Determine if there is a next page based on totalPages, converting totalPages to an integer if present
+                total_pages = int(response_data.get("totalPages", 0))  # Default to 0 if not provided
+                if not total_pages or params["page"] >= total_pages:
                     break
 
-                params["page"] = next_page if params["page"] is None else params["page"] + 1
+                # Move to the next page
+                params["page"] += 1
 
         finally:
             time.sleep(2)  # Ensure a delay between requests regardless of outcome

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

@@ -56,7 +56,7 @@ class PolicySetsAPI:
             conditions (list): List of condition dicts or tuples.
 
         Returns:
-            :obj:`dict`: The conditions template.
+            :obj:`list`: The conditions template.
 
         """
         template = []
@@ -78,75 +78,47 @@ class PolicySetsAPI:
             "COUNTRY_CODE": [],
         }
 
-        current_operator = "OR"  # Default operator
-        
+        operators_for_types = {}  # Dictionary to store specific operators for each object type
+
         for condition in conditions:
-            # Check if the first item is an operator, like "AND" or "OR"
+            # Check if the first item in a tuple 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
+                operator = condition[0].upper()
                 condition = condition[1]  # The second element is the actual condition
+            else:
+                operator = "OR"  # Default operator if none specified
 
+            # Process each condition and categorize by object type and operator
             if isinstance(condition, tuple) and len(condition) == 3:
-                # Handle each object type according to its pattern
                 object_type = condition[0].upper()
                 lhs = condition[1]
                 rhs = condition[2]
+                operand = {"objectType": object_type, "lhs": lhs, "rhs": rhs}
+
+                # Track the operator for the current object type
+                operators_for_types[object_type] = operator
 
                 if object_type in ["APP", "APP_GROUP"]:
-                    app_and_app_group_operands.append({"objectType": object_type, "lhs": "id", "rhs": rhs})
+                    app_and_app_group_operands.append(operand)
                 elif object_type in object_types_to_operands:
-                    if object_type == "CLIENT_TYPE":
-                        if rhs in {
-                            "zpn_client_type_exporter",
-                            "zpn_client_type_machine_tunnel",
-                            "zpn_client_type_ip_anchoring",
-                            "zpn_client_type_edge_connector",
-                            "zpn_client_type_zapp",
-                            "zpn_client_type_slogger",
-                        }:
-                            object_types_to_operands[object_type].append({"objectType": object_type, "lhs": "id", "rhs": rhs})
-                    elif object_type in [
-                        "PLATFORM",
-                        "POSTURE",
-                        "TRUSTED_NETWORK",
-                        "SAML",
-                        "SCIM",
-                        "SCIM_GROUP",
-                        "COUNTRY_CODE",
-                    ]:
-                        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})
-                        
+                    object_types_to_operands[object_type].append(operand)
+
             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
+                    operators_for_types["default"] = condition["operator"]
+                    continue  # Skip 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:
                         condition_template[key] = condition[key]
 
-                # Handling the operands
                 operands = condition.get("operands", [])
                 condition_template["operands"] = []
 
                 for operand in operands:
                     operand_template = {}
-
-                    # Extracting keys from the operand dictionary
-                    for operand_key in [
-                        "id",
-                        "idp_id",
-                        "name",
-                        "lhs",
-                        "rhs",
-                        "objectType",
-                    ]:
+                    for operand_key in ["id", "idp_id", "name", "lhs", "rhs", "objectType"]:
                         if operand_key in operand:
                             operand_template[operand_key] = operand[operand_key]
 
@@ -154,14 +126,16 @@ class PolicySetsAPI:
 
                 template.append(condition_template)
 
-        # Combine APP and APP_GROUP operands into one block
+        # Combine APP and APP_GROUP operands with their specific operator
         if app_and_app_group_operands:
-            template.append({"operator": current_operator, "operands": app_and_app_group_operands})
+            app_group_operator = operators_for_types.get("APP", "OR")
+            template.append({"operator": app_group_operator, "operands": app_and_app_group_operands})
 
-        # Combine other object types into their own blocks
+        # Combine other object types into their blocks with their respective operator
         for object_type, operands in object_types_to_operands.items():
             if operands:
-                template.append({"operator": current_operator, "operands": operands})
+                operator = operators_for_types.get(object_type, "OR")
+                template.append({"operator": operator, "operands": operands})
 
         return template