zscaler-sdk-python 1.5.4__tar.gz → 1.5.6__tar.gz

{zscaler_sdk_python-1.5.4 → zscaler_sdk_python-1.5.6}/PKG-INFO

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

{zscaler_sdk_python-1.5.4 → zscaler_sdk_python-1.5.6}/pyproject.toml

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

{zscaler_sdk_python-1.5.4 → zscaler_sdk_python-1.5.6}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "1.5.4"
+__version__ = "1.5.6"
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa

{zscaler_sdk_python-1.5.4 → zscaler_sdk_python-1.5.6}/zscaler/oneapi_response.py

@@ -211,6 +211,35 @@ class ZscalerAPIResponse:
         return results, self, None
 
 
+    # def _fetch_next_page(self):
+    #     if not self._has_next():
+    #         logger.debug("No more pages to fetch")
+    #         return [], None
+
+    #     if self._service_type == "ZDX":
+    #         self._params["offset"] = self._next_offset
+    #     else:
+    #         self._page += 1
+    #         self._params["page"] = self._page
+
+    #     logger.debug(f"Requesting next page with params: {self._params}")
+
+    #     req = {
+    #         "method": "GET",
+    #         "url": self._url,
+    #         "headers": self._headers,
+    #         "params": self._params,
+    #         "uuid": uuid.uuid4(),
+    #     }
+    #     _, _, response_body, error = self._request_executor.fire_request(req)
+
+    #     if error:
+    #         logger.error(f"Error fetching the next page: {error}")
+    #         return None, error
+
+    #     self._build_json_response(response_body)
+    #     return self._list, None
+
     def _fetch_next_page(self):
         if not self._has_next():
             logger.debug("No more pages to fetch")
@@ -220,7 +249,13 @@ class ZscalerAPIResponse:
             self._params["offset"] = self._next_offset
         else:
             self._page += 1
-            self._params["page"] = self._page
+
+            # ✅ Patch: support alternate pagination keys (e.g., Shadow IT)
+            if "pageNumber" in self._params:
+                self._params["pageNumber"] = str(self._page)
+                self._params.pop("page", None)  # Ensure no conflict
+            else:
+                self._params["page"] = self._page
 
         logger.debug(f"Requesting next page with params: {self._params}")
 
@@ -263,3 +298,9 @@ class ZscalerAPIResponse:
             # If the API doesn't give a clear signal that there's another page, we may need a heuristic.
             logger.debug("Has next page for ZIA/ZCC: %s", has_next)
             return has_next
+
+    def __str__(self):
+        try:
+            return json.dumps(self.get_results(), indent=2)
+        except Exception as e:
+            return f"<ZscalerAPIResponse error displaying results: {e}>"

{zscaler_sdk_python-1.5.4 → zscaler_sdk_python-1.5.6}/zscaler/zia/models/shadow_it_report.py

@@ -251,15 +251,33 @@ class ShadowITReport(ZscalerObject):
 
 class CloudapplicationsAndTags(ZscalerObject):
     def __init__(self, config=None):
+        """
+        Initialize the Cloud Applications and Tags model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the Cloud Applications and Tags configuration.
+        """
         super().__init__(config)
-        self.id = config["id"] if "id" in config else None
-        self.name = config["name"] if "name" in config else None
+
+        if config:
+            self.id = config["id"] if "id" in config else None
+            self.name = config["name"] if "name" in config else None
+        else:
+            # Initialize with default None or 0 values
+            self.id = None
+            self.name = None
 
     def request_format(self):
-        return {
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
             "id": self.id,
             "name": self.name,
         }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
 
 
 class CloudApplicationBulkUpdate(ZscalerObject):

{zscaler_sdk_python-1.5.4 → zscaler_sdk_python-1.5.6}/zscaler/zia/shadow_it_report.py

@@ -47,13 +47,22 @@ class ShadowITAPI(APIClient):
         """
         Gets the list of predefined and custom cloud applications
 
+        Args:
+            query_params (dict):
+                Map of query parameters for the request.
+
+                ``[query_params.page_number]`` (int): Specifies the page number. The numbering starts at 0.
+
+                ``[query_params.limit]`` (int): Specifies the max number of cloud applications that must be retrieved in a page
+
         Returns:
             obj:`Tuple`: A list of cloud applications.
 
         Examples:
             Get a list of 10 custom cloud applications:
 
-            >>> app_list, response, error = client.zia.shadow_it_report.list_apps(query_params={'limit': '10'})
+            >>> app_list, response, error = client.zia.shadow_it_report.list_apps(
+            ... query_params={'page_number': 1, 'limit': '10'})
             ... if error:
             ...     print(f"Error listing custom cloud applications: {error}")
             ...     return
@@ -103,7 +112,7 @@ class ShadowITAPI(APIClient):
         Examples:
             Get a list of 10 custom cloud applications:
 
-            >>> app_list, response, error = client.zia.shadow_it_report.list_custom_tags(query_params={'limit': '10'})
+            >>> app_list, response, error = client.zia.shadow_it_report.list_custom_tags()
             ... if error:
             ...     print(f"Error listing custom tags: {error}")
             ...     return
@@ -166,14 +175,27 @@ class ShadowITAPI(APIClient):
             :obj:`dict`: The response from the ZIA API.
 
         Examples:
-            Update the sanction state of a cloud application::
-
-                zia.cloud_apps.bulk_update("sanctioned", application_ids=["12345"])
-
-            Update the sanction state and custom tags of a cloud application::
+            Update the sanction state to sanctioned of a cloud application:
+
+            >>> updated_application, _, error = client.zia.shadow_it_report.bulk_update("sanctioned",
+            ...     application_ids=["2228401"],
+            ...     custom_tag_ids=["1"]
+            ... )
+            >>> if error:
+            ...     print(f"Error updating applications: {error}")
+            ...     return
+            ... print(f"Applications updated successfully: {updated_application.as_dict()}")
 
-                zia.cloud_apps.bulk_update("sanctioned", application_ids=["12345"], custom_tag_ids=["67890"])
+            Update the sanction state and custom tags of a cloud application:
 
+            >>> updated_application, _, error = client.zia.shadow_it_report.bulk_update("unsanctioned",
+            ...     application_ids=["2228401"],
+            ...     custom_tag_ids=["1"]
+            ... )
+            >>> if error:
+            ...     print(f"Error updating applications: {error}")
+            ...     return
+            ... print(f"Applications updated successfully: {updated_application.as_dict()}")
         """
         http_method = "put".upper()
         api_url = format_url(
@@ -214,10 +236,12 @@ class ShadowITAPI(APIClient):
 
         response, error = self._request_executor.execute(request)
 
-        if error:
+        try:
+            body = response.get_body()
+            result = self.form_response_body(body) if body else {}
+        except Exception as error:
             return (None, response, error)
-
-        return (response.get_body(), response, None)
+        return (result, response, None)
 
     def export_shadow_it_report(self, duration: str = "LAST_1_DAYS", **kwargs) -> tuple:
         """