zscaler-sdk-python 1.9.1__tar.gz → 1.9.3__tar.gz

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.9.1
+Version: 1.9.3
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -16,7 +16,6 @@ Classifier: Programming Language :: Python :: 3
 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: Programming Language :: Python :: 3.9
 Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -28,7 +27,7 @@ Requires-Dist: flatdict (>=4.0.0)
 Requires-Dist: pydash (>=8.0.3)
 Requires-Dist: python-box (>=7.3.0)
 Requires-Dist: python-dateutil (>=2.9.0)
-Requires-Dist: python-jose[cryptography] (>=3.3.0)
+Requires-Dist: python-jose[cryptography] (>=3.5.0)
 Requires-Dist: pytz (>=2024.2)
 Requires-Dist: pyyaml (>=6.0.0)
 Requires-Dist: requests (>=2.32.3)

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.1"
+version = "1.9.3"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -13,10 +13,10 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Operating System :: OS Independent",
     "Topic :: Security",
     "Topic :: Software Development :: Libraries :: Python Modules", ]
@@ -36,7 +36,7 @@ pytz = ">=2024.2"
 python-box = ">=7.3.0"
 python-dateutil = ">=2.9.0"
 flatdict = ">=4.0.0"
-python-jose = {extras = ["cryptography"], version = ">=3.3.0"}
+python-jose = {extras = ["cryptography"], version = ">=3.5.0"}
 aenum = ">=3.1.11"
 pydash = ">=8.0.3"
 arrow = ">=1.3.0"

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/oneapi_response.py

@@ -54,6 +54,7 @@ class ZscalerAPIResponse:
         self._limit = self.validate_page_size(self._params.get("limit"), service_type)
         self._next_offset = None
         self._list = []
+        self._is_flat_list_response = False  # Track if response is a flat list (no pagination metadata)
 
         if all_entries:
             self._params["allEntries"] = True
@@ -160,7 +161,10 @@ class ZscalerAPIResponse:
 
         if isinstance(self._body, list):
             # Handle direct list responses (ZIA, ZPA simple lists, etc.)
+            # A flat list response means the API returned all results in one response
+            # without pagination metadata - pagination should NOT continue
             self._list = self._body
+            self._is_flat_list_response = True  # Mark as flat list - no pagination
             # Check if this is a list of simple types (strings, numbers, etc.) vs dicts
             # If it's a list of simple types, skip the cleaning logic
             if self._body and len(self._body) > 0 and not isinstance(self._body[0], dict):
@@ -315,6 +319,11 @@ class ZscalerAPIResponse:
         return self._list, None
 
     def _has_next(self) -> bool:
+        # If the response was a flat list (no pagination metadata), there are no more pages
+        # This handles ZIA endpoints that return all results in a single response
+        if self._is_flat_list_response:
+            logger.debug("Has next page: False (flat list response - all results returned in single response)")
+            return False
 
         if self._service_type == "ZPA":
             # More pages if current page < total_pages
@@ -332,7 +341,7 @@ class ZscalerAPIResponse:
             logger.debug("Has next page for ZIDENTITY: %s", has_next)
             return has_next
         else:
-            # For ZIA/ZCC:
+            # For ZIA/ZCC with paginated responses (dict with "list" field):
             # - If we're on the first page and got results, try next page
             # - If we're on a subsequent page and the last fetch returned results equal to or greater than limit, try next page
             # - If the last fetch returned fewer results than limit (or 0), we're done

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/admin_user.py

@@ -30,7 +30,7 @@ class AdminUserAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         self._zcc_base_endpoint = "/zcc/papi/public/v1"
 
-    def list_admin_users(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_admin_users(self, query_params: Optional[dict] = None) -> APIResult[List[AdminUser]]:
         """
         Returns the list of Admin Users enrolled in the Client Connector Portal.
 
@@ -129,7 +129,7 @@ class AdminUserAPI(APIClient):
 
         return result, response, None
 
-    def list_admin_roles(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_admin_roles(self, query_params: Optional[dict] = None) -> APIResult[List[AdminRoles]]:
         """
         Returns the list admin roles in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/devices.py

@@ -310,7 +310,7 @@ class DevicesAPI(APIClient):
         return filename
 
     @zcc_param_mapper
-    def list_devices(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_devices(self, query_params: Optional[dict] = None) -> APIResult[List[Device]]:
         """
         Returns the list of devices enrolled in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/fail_open_policy.py

@@ -29,7 +29,7 @@ class FailOpenPolicyAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         self._zcc_base_endpoint = "/zcc/papi/public/v1"
 
-    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[List[FailOpenPolicy]]:
         """
         Returns the list of Fail Open Policy By Company in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/forwarding_profile.py

@@ -29,7 +29,7 @@ class ForwardingProfileAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         self._zcc_base_endpoint = "/zcc/papi/public/v1"
 
-    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[List[ForwardingProfile]]:
         """
         Returns the list of Forwarding Profiles By Company ID in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/trusted_networks.py

@@ -29,7 +29,7 @@ class TrustedNetworksAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         self._zcc_base_endpoint = "/zcc/papi/public/v1"
 
-    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[List[TrustedNetworks]]:
         """
         Returns the list of Trusted Networks By Company ID in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/web_app_service.py

@@ -29,7 +29,7 @@ class WebAppServiceAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         self._zcc_base_endpoint = "/zcc/papi/public/v1"
 
-    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[List[WebAppService]]:
         """
         Returns the list of Fail Open Policy By Company in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zcc/web_policy.py

@@ -30,7 +30,7 @@ class WebPolicyAPI(APIClient):
         self._zcc_base_endpoint = "/zcc/papi/public/v1"
 
     @zcc_param_mapper
-    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_by_company(self, query_params: Optional[dict] = None) -> APIResult[List[WebPolicy]]:
         """
         Returns the list of Web Policy By Company ID in the Client Connector Portal.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/admin.py

@@ -30,7 +30,7 @@ class AdminAPI(APIClient):
         self._zdx_base_endpoint = "/zdx/v1"
 
     @zdx_params
-    def list_departments(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_departments(self, query_params: Optional[dict] = None) -> APIResult[List[Administration]]:
         """
         Returns the list of Admin Users enrolled in the Client Connector Portal.
 
@@ -97,7 +97,7 @@ class AdminAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_locations(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_locations(self, query_params: Optional[dict] = None) -> APIResult[List[Administration]]:
         """
         Returns the list of all configured Zscaler locations if the search filters are not specified.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/alerts.py

@@ -32,7 +32,7 @@ class AlertsAPI(APIClient):
         self._zdx_base_endpoint = "/zdx/v1"
 
     @zdx_params
-    def list_ongoing(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_ongoing(self, query_params: Optional[dict] = None) -> APIResult[List[Alerts]]:
         """
         Returns a list of all ongoing alert rules across an organization in ZDX.
         All ongoing alert rules are returned if the search filter is not specified.
@@ -158,7 +158,7 @@ class AlertsAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_historical(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_historical(self, query_params: Optional[dict] = None) -> APIResult[List[Alerts]]:
         """
         Returns a list of alert history rules defined across an organization.
         All alert history rules are returned if the search filter is not specified.
@@ -239,7 +239,7 @@ class AlertsAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_affected_devices(self, alert_id, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_affected_devices(self, alert_id, query_params: Optional[dict] = None) -> APIResult[List[AffectedDevices]]:
         """
         Returns a list of all affected devices associated with
         an alert rule in conjunction with provided filters.

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/apps.py

@@ -35,7 +35,7 @@ class AppsAPI(APIClient):
         self._zdx_base_endpoint = "/zdx/v1"
 
     @zdx_params
-    def list_apps(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_apps(self, query_params: Optional[dict] = None) -> APIResult[List[ActiveApplications]]:
         """
         Returns a list of all active applications configured within the ZDX tenant.
 
@@ -316,7 +316,7 @@ class AppsAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_app_users(self, app_id: str, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_app_users(self, app_id: str, query_params: Optional[dict] = None) -> APIResult[List[ApplicationActiveUsers]]:
         """
         Returns a list of users and devices that were used to access the specified application configured within
         the ZDX tenant.

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/devices.py

@@ -42,7 +42,7 @@ class DevicesAPI(APIClient):
         self._zdx_base_endpoint = "/zdx/v1"
 
     @zdx_params
-    def list_devices(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_devices(self, query_params: Optional[dict] = None) -> APIResult[List[Devices]]:
         """
         Returns a list of all active devices and its basic details.
         If the time range is not specified, the endpoint defaults to the previous 2 hours.
@@ -453,7 +453,7 @@ class DevicesAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_cloudpath_probes(self, device_id: str, app_id: str, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_cloudpath_probes(self, device_id: str, app_id: str, query_params: Optional[dict] = None) -> APIResult[List[DeviceAppCloudPathProbes]]:
         """
         Returns a list of all active cloudpath probes for a specific application being used by a device.
 
@@ -801,7 +801,7 @@ class DevicesAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_geolocations(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_geolocations(self, query_params: Optional[dict] = None) -> APIResult[List[DeviceActiveGeo]]:
         """
         Returns a list of all active geolocations configured within the ZDX tenant.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/inventory.py

@@ -31,7 +31,7 @@ class InventoryAPI(APIClient):
         self._zdx_base_endpoint = "/zdx/v1"
 
     @zdx_params
-    def list_softwares(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_softwares(self, query_params: Optional[dict] = None) -> APIResult[List[DeviceSoftwareInventory]]:
         """
         Returns a list of all software in ZDX.
 
@@ -102,7 +102,7 @@ class InventoryAPI(APIClient):
         return (result, response, None)
 
     @zdx_params
-    def list_software_keys(self, software_key: str, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_software_keys(self, software_key: str, query_params: Optional[dict] = None) -> APIResult[List[DeviceSoftwareInventory]]:
         """
         Returns a list of all users and devices for the given software name and version.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/troubleshooting.py

@@ -36,7 +36,7 @@ class TroubleshootingAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         self._zdx_base_endpoint = "/zdx/v1"
 
-    def list_deeptraces(self, device_id: str) -> APIResult[dict]:
+    def list_deeptraces(self, device_id: str) -> APIResult[List[DeviceDeepTraces]]:
         """
         Returns a list of all deep traces for a specific device.
 
@@ -238,7 +238,7 @@ class TroubleshootingAPI(APIClient):
         self,
         device_id: str,
         trace_id: str,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[DeviceTopProcesses]]:
         """
         Returns a list of all deep traces for a specific device.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zdx/users.py

@@ -31,7 +31,7 @@ class UsersAPI(APIClient):
         self._zdx_base_endpoint = "/zdx/v1"
 
     @zdx_params
-    def list_users(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_users(self, query_params: Optional[dict] = None) -> APIResult[List[ActiveUsers]]:
         """
         Returns a list of all active users configured within the ZDX tenant.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/bandwidth_classes.py

@@ -33,7 +33,7 @@ class BandwidthClassesAPI(APIClient):
         super().__init__()
         self._request_executor: RequestExecutor = request_executor
 
-    def list_classes(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_classes(self, query_params: Optional[dict] = None) -> APIResult[List[BandwidthClasses]]:
         """
         Retrieves a list of bandwidth classes for an organization.
 
@@ -93,7 +93,7 @@ class BandwidthClassesAPI(APIClient):
 
         return (results, response, None)
 
-    def list_classes_lite(self) -> APIResult[dict]:
+    def list_classes_lite(self) -> APIResult[List[BandwidthClasses]]:
         """
         Fetches a specific bandwidth class lite by ID.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/bandwidth_control_rules.py

@@ -33,7 +33,7 @@ class BandwidthControlRulesAPI(APIClient):
     def list_rules(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[BandwidthControlRules]]:
         """
         List bandwidth control rules in your organization.
         If the `search` parameter is provided, the function filters the rules client-side.
@@ -107,7 +107,7 @@ class BandwidthControlRulesAPI(APIClient):
 
         return (results, response, None)
 
-    def list_rules_lite(self) -> APIResult[dict]:
+    def list_rules_lite(self) -> APIResult[List[BandwidthControlRules]]:
         """
         Fetches a specific bandwidth control rule lite.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/casb_dlp_rules.py

@@ -33,7 +33,7 @@ class CasbdDlpRulesAPI(APIClient):
     def list_rules(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[CasbdDlpRules]]:
         """
         Returns a list of all Casb DLP Rules for the specified rule type.
 
@@ -158,7 +158,7 @@ class CasbdDlpRulesAPI(APIClient):
 
     def list_all_rules(
         self,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[CasbdDlpRules]]:
         """
         Returns a list of all Casb DLP Rules.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/casb_malware_rules.py

@@ -33,7 +33,7 @@ class CasbMalwareRulesAPI(APIClient):
     def list_rules(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[CasbMalwareRules]]:
         """
         Returns a list of all Casb Malware Rules for the specified rule type.
 
@@ -157,7 +157,7 @@ class CasbMalwareRulesAPI(APIClient):
 
     def list_all_rules(
         self,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[CasbMalwareRules]]:
         """
         Returns a list of all Casb Malware Rules.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/cloud_app_instances.py

@@ -33,7 +33,7 @@ class CloudApplicationInstancesAPI(APIClient):
     def list_cloud_app_instances(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[CloudApplicationInstances]]:
         """
         Retrieves the list of cloud application instances configured in the ZIA Admin Portal
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/cloud_applications.py

@@ -33,7 +33,7 @@ class CloudApplicationsAPI(APIClient):
         super().__init__()
         self._request_executor: RequestExecutor = request_executor
 
-    def list_cloud_app_policy(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_cloud_app_policy(self, query_params: Optional[dict] = None) -> APIResult[List[CloudApplicationPolicy]]:
         """
         Return a list of of Predefined and User Defined Cloud Applications associated with the DLP rules,
         Cloud App Control rules, Advanced Settings, Bandwidth Classes, and File Type Control rules.
@@ -108,7 +108,7 @@ class CloudApplicationsAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
-    def list_cloud_app_ssl_policy(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_cloud_app_ssl_policy(self, query_params: Optional[dict] = None) -> APIResult[List[CloudApplicationPolicy]]:
         """
         Retrieves a list of Predefined and User Defined Cloud Applications associated with the SSL Inspection rules.
         Retrives AppInfo when groupResults is set to false and retrieves the application count grouped by application

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/cloud_browser_isolation.py

@@ -36,7 +36,7 @@ class CBIProfileAPI(APIClient):
     def list_isolation_profiles(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[CBIProfile]]:
         """
         Lists isolation profiles in your organization with pagination.
         A subset of isolation profiles  can be returned that match a supported

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/cloud_firewall.py

@@ -14,7 +14,7 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 """
 
-from typing import Dict, List, Optional, Any, Union
+from typing import List, Optional
 from zscaler.request_executor import RequestExecutor
 from zscaler.api_client import APIClient
 from zscaler.zia.models.cloud_firewall_destination_groups import IPDestinationGroups
@@ -36,7 +36,9 @@ class FirewallResourcesAPI(APIClient):
         super().__init__()
         self._request_executor: RequestExecutor = request_executor
 
-    def list_ip_destination_groups(self, exclude_type: str = None, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_ip_destination_groups(
+        self, exclude_type: str = None, query_params: Optional[dict] = None
+    ) -> APIResult[List[IPDestinationGroups]]:
         """
         Returns a list of IP Destination Groups.
 
@@ -118,7 +120,9 @@ class FirewallResourcesAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
-    def list_ipv6_destination_groups(self, exclude_type: str = None, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_ipv6_destination_groups(
+        self, exclude_type: str = None, query_params: Optional[dict] = None
+    ) -> APIResult[List[IPDestinationGroups]]:
         """
         Lists IPv6 Destination Groups name and ID  all IPv6 Source Groups.
         `Note`: User-defined groups for IPv6 addresses are currently not supported,
@@ -206,7 +210,7 @@ class FirewallResourcesAPI(APIClient):
         self,
         exclude_type: str = None,
         query_params: Optional[dict] = None
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[IPDestinationGroups]]:
         """
         Lists IP Destination Groups name and ID  all IP Destination Groups.
         This endpoint retrieves only IPv4 destination address groups.
@@ -300,7 +304,7 @@ class FirewallResourcesAPI(APIClient):
         self,
         exclude_type: str = None,
         query_params: Optional[dict] = None
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[IPDestinationGroups]]:
         """
         Lists IPv6 Destination Groups name and ID  all IPv6 Source Groups.
         `Note`: User-defined groups for IPv6 addresses are currently not supported,
@@ -663,7 +667,7 @@ class FirewallResourcesAPI(APIClient):
     def list_ip_source_groups(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[IPSourceGroup]]:
         """
         List IP Source Groups in your organization.
 
@@ -731,7 +735,7 @@ class FirewallResourcesAPI(APIClient):
     def list_ipv6_source_groups(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[IPSourceGroup]]:
         """
         List IPv6 Source Groups in your organization.
         `Note`: User-defined groups for IPv6 addresses are currently not supported,
@@ -801,7 +805,7 @@ class FirewallResourcesAPI(APIClient):
     def list_ip_source_groups_lite(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[IPSourceGroup]]:
         """
         Lists IP Source Groups name and ID  all IP Source Groups.
         This endpoint retrieves only IPv4 source address groups.
@@ -876,7 +880,7 @@ class FirewallResourcesAPI(APIClient):
     def list_ipv6_source_groups_lite(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[IPSourceGroup]]:
         """
         Lists IPv6 Source Groups name and ID all IPv6 Source Groups.
         `Note`: User-defined groups for IPv6 addresses are currently not supported,
@@ -1150,7 +1154,7 @@ class FirewallResourcesAPI(APIClient):
     def list_network_app_groups(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[NetworkApplicationGroups]]:
         """
         List Network Application Groups in your organization.
 
@@ -1417,7 +1421,7 @@ class FirewallResourcesAPI(APIClient):
     def list_network_apps(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[NetworkApplications]]:
         """
         Lists Network Applications in your organization with pagination.
         A subset of Network Applications can be returned that match a supported
@@ -1533,7 +1537,7 @@ class FirewallResourcesAPI(APIClient):
     def list_network_svc_groups(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[NetworkServiceGroups]]:
         """
         Lists network service groups in your organization with pagination.
         A subset of network service groups can be returned that match a supported
@@ -1604,7 +1608,7 @@ class FirewallResourcesAPI(APIClient):
     def list_network_svc_groups_lite(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[NetworkServiceGroups]]:
         """
         Lists Network Service Groups name and ID  all network service groups.
         If the `search` parameter is provided, the function filters the rules client-side.
@@ -1871,7 +1875,7 @@ class FirewallResourcesAPI(APIClient):
             return (None, response, error)
         return (None, response, None)
 
-    def list_network_services(self, query_params: Optional[dict] = None) -> APIResult[dict]:
+    def list_network_services(self, query_params: Optional[dict] = None) -> APIResult[List[NetworkServices]]:
         """
         Lists network services in your organization with pagination.
         A subset of network services  can be returned that match a supported
@@ -1945,7 +1949,7 @@ class FirewallResourcesAPI(APIClient):
     def list_network_services_lite(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[NetworkServices]]:
         """
         Lists network services name and ID all network services.
         A subset of network service groups can be returned that match a supported
@@ -2263,7 +2267,7 @@ class FirewallResourcesAPI(APIClient):
             return (None, response, error)
         return (None, response, None)
 
-    def list_time_windows(self) -> APIResult[dict]:
+    def list_time_windows(self) -> APIResult[List[TimeWindows]]:
         """
         Returns a list of time intervals used by the Firewall policy or the URL Filtering policy.
 
@@ -2304,7 +2308,7 @@ class FirewallResourcesAPI(APIClient):
 
         return (result, response, None)
 
-    def list_time_windows_lite(self) -> APIResult[dict]:
+    def list_time_windows_lite(self) -> APIResult[List[TimeWindows]]:
         """
         Returns name and ID dictionary of time intervals used by the Firewall policy or the URL Filtering policy.
 

{zscaler_sdk_python-1.9.1 → zscaler_sdk_python-1.9.3}/zscaler/zia/cloud_firewall_dns.py

@@ -14,7 +14,7 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 """
 
-from typing import Dict, List, Optional, Any, Union
+from typing import List, Optional
 from zscaler.request_executor import RequestExecutor
 from zscaler.utils import format_url, transform_common_id_fields, reformat_params
 from zscaler.api_client import APIClient
@@ -33,7 +33,7 @@ class FirewallDNSRulesAPI(APIClient):
     def list_rules(
         self,
         query_params: Optional[dict] = None,
-    ) -> APIResult[dict]:
+    ) -> APIResult[List[FirewallDNSRules]]:
         """
         List firewall dns rules in your organization.
         If the `search` parameter is provided, the function filters the rules client-side.
@@ -107,7 +107,7 @@ class FirewallDNSRulesAPI(APIClient):
     def get_rule(
         self,
         rule_id: int,
-    ) -> APIResult[dict]:
+    ) -> APIResult[FirewallDNSRules]:
         """
         Returns information for the specified cloud firewall dns filter rule.
 
@@ -157,7 +157,7 @@ class FirewallDNSRulesAPI(APIClient):
     def add_rule(
         self,
         **kwargs,
-    ) -> APIResult[dict]:
+    ) -> APIResult[FirewallDNSRules]:
         """
         Adds a new cloud firewall dns rule.
 
@@ -259,7 +259,7 @@ class FirewallDNSRulesAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
-    def update_rule(self, rule_id: int, **kwargs) -> APIResult[dict]:
+    def update_rule(self, rule_id: int, **kwargs) -> APIResult[FirewallDNSRules]:
         """
         Updates an existing cloud firewall dns rule.
 
@@ -367,7 +367,7 @@ class FirewallDNSRulesAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
-    def delete_rule(self, rule_id: int) -> APIResult[dict]:
+    def delete_rule(self, rule_id: int) -> APIResult[None]:
         """
         Deletes the specified cloud firewall dns filter rule.