zscaler-sdk-python 0.9.3__tar.gz → 0.9.5__tar.gz

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.9.3
+Version: 0.9.5
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -32,7 +32,7 @@ Requires-Dist: flake8
 Requires-Dist: flatdict
 Requires-Dist: idna (>=3.10)
 Requires-Dist: okta (>=2.9.7)
-Requires-Dist: pycryptodomex
+Requires-Dist: pycryptodomex (>=3.20.0)
 Requires-Dist: pydash (>=8.0.3) ; extra == "dev"
 Requires-Dist: python-box (>=7.2.0)
 Requires-Dist: python-dateutil
@@ -40,7 +40,7 @@ Requires-Dist: pytz (>=2024.2)
 Requires-Dist: pyyaml
 Requires-Dist: requests (>=2.32.3)
 Requires-Dist: responses (>=0.25.3)
-Requires-Dist: restfly
+Requires-Dist: restfly (>=1.5.0)
 Requires-Dist: six
 Requires-Dist: xmltodict
 Requires-Dist: yarl

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.9.3"
+version = "0.9.5"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -37,13 +37,13 @@ python-box = ">=7.2.0"
 python-dateutil = "*"
 requests = ">=2.32.3"
 responses = ">=0.25.3"
-restfly = "*"
+restfly = ">=1.5.0"
 six = "*"
 flatdict = "*"
 pyyaml = "*"
 xmltodict = "*"
 yarl = "*"
-pycryptodomex = "*"
+pycryptodomex = ">=3.20.0"
 aenum = "*"
 pydash = ">=8.0.3"
 flake8 = "*"

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/zscaler/__init__.py

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

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/zscaler/zia/__init__.py

@@ -382,13 +382,16 @@ class ZIAClientHelper(ZIAClient):
         formatted_resp = format_json_response(resp, box_attrs=dict())
         return formatted_resp
 
-    def post(self, path, json=None, params=None, data=None, headers=None):
+    def post(self, path, json=None, params=None, data=None, headers=None, parse_json=True):
         should_wait, delay = self.rate_limiter.wait("POST")
         if should_wait:
             time.sleep(delay)
         resp = self.send("POST", path, json, params, data=data, headers=headers)
-        formatted_resp = format_json_response(resp, box_attrs=dict())
-        return formatted_resp
+        if parse_json:
+            formatted_resp = format_json_response(resp, box_attrs=dict())
+            return formatted_resp
+        else:
+            return resp
 
     def delete(self, path, json=None, params=None):
         should_wait, delay = self.rate_limiter.wait("DELETE")

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/zscaler/zia/locations.py

@@ -43,8 +43,6 @@ class LocationsAPI:
                 Specifies the page size. The default size is 100, but the maximum size is 1000.
             **search (str, optional):
                 The search string used to partially match against a location's name and port attributes.
-            **xff_enabled (bool, optional):
-                Filter based on whether the Enforce XFF Forwarding setting is enabled or disabled for a location.
 
         Returns:
             :obj:`BoxList`: List of configured locations.
@@ -188,7 +186,8 @@ class LocationsAPI:
             description (str, optional):
                 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
 
@@ -483,7 +482,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.
 
@@ -491,7 +490,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.
@@ -500,7 +503,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:
         """
@@ -518,25 +528,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.
@@ -545,7 +536,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.
@@ -573,25 +564,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.
@@ -600,7 +572,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.
@@ -612,7 +584,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"]
@@ -693,5 +665,4 @@ class LocationsAPI:
 
         """
         return BoxList(Iterator(self.rest, "region/search", **kwargs))
-        # data, _ = self.rest.get_paginated_data(path="region/search", params=kwargs)
-        # return BoxList([Box(city) for city in data])
+

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/zscaler/zia/traffic.py

@@ -523,13 +523,12 @@ class TrafficForwardingAPI:
         payload = {
             "ipAddress": ip_address,
         }
-        response = self.rest.post("staticIP/validate", json=payload)
+        response = self.rest.post("staticIP/validate", json=payload, parse_json=False)
 
         # Check if the status code is 200 and the response body text is "SUCCESS"
         if response.status_code == 200 and response.text.strip().upper() == "SUCCESS":
             return True
         else:
-            # Optionally, you could log response.text or response.status_code here for debugging
             return False
 
     def update_static_ip(self, static_ip_id: str, **kwargs) -> Box:

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/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:
         """
@@ -590,4 +599,4 @@ class AppConnectorControllerAPI:
 
         """
         list, _ = self.rest.get_paginated_data(path="/visible/versionProfiles", **kwargs, api_version="v1")
-        return list
+        return list

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/zscaler/zpa/microtenants.py

@@ -60,10 +60,14 @@ class MicrotenantsAPI:
 
         """
         response = self.rest.get("/microtenants/%s" % (microtenant_id))
+
+        # If the response is not a Box (indicating an error), return None or handle the error
         if isinstance(response, Response):
             status_code = response.status_code
             if status_code != 200:
-                return None
+                raise Exception(f"Failed to retrieve microtenant: {status_code} - {response.text}")
+
+        # Otherwise, return the formatted Box object
         return response
 
     def get_microtenant_summary(self) -> Box:
@@ -189,17 +193,44 @@ class MicrotenantsAPI:
             ... )
 
         """
-        # Set payload to value of existing record
-        payload = {snake_to_camel(k): v for k, v in self.get_microtenant(microtenant_id).items()}
-
-        # Add optional parameters to payload
+        # Retrieve existing microtenant data
+        existing_microtenant_response = self.get_microtenant(microtenant_id)
+
+        # Handle Response object (in case of error)
+        if isinstance(existing_microtenant_response, Response):
+            if existing_microtenant_response.status_code != 200:
+                raise Exception(f"Failed to retrieve microtenant: {existing_microtenant_response.status_code}")
+            # If there's content, parse the response as JSON
+            if existing_microtenant_response.text.strip():
+                existing_microtenant = existing_microtenant_response.json()
+            else:
+                existing_microtenant = {}  # Treat as empty, no error
+        else:
+            existing_microtenant = existing_microtenant_response
+
+        # Prepare the payload
+        payload = {snake_to_camel(k): v for k, v in existing_microtenant.items()}
+
+        # Add optional parameters from kwargs
         for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
-        resp = self.rest.put(f"microtenants/{microtenant_id}", json=payload).status_code
-        if not isinstance(resp, Response):
+        # Send the PUT request to update the microtenant
+        resp = self.rest.put(f"microtenants/{microtenant_id}", json=payload)
+
+        # Handle 204 No Content as success
+        if resp.status_code == 204:
+            print(f"Update successful for microtenant {microtenant_id} (204 No Content).")
+            return self.get_microtenant(microtenant_id)
+
+        # Handle 200 OK as success
+        if resp.status_code == 200:
+            print(f"Update successful for microtenant {microtenant_id} (200 OK).")
             return self.get_microtenant(microtenant_id)
 
+        # Raise exception for any other status code
+        raise Exception(f"Failed to update microtenant: {resp.status_code}, {resp.text}")
+
     def delete_microtenant(self, microtenant_id: str) -> int:
         """
         Delete the specified microtenant.

{zscaler_sdk_python-0.9.3 → zscaler_sdk_python-0.9.5}/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.