zscaler-sdk-python 1.4.2__tar.gz → 1.4.4__tar.gz

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.4.2
+Version: 1.4.4
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -980,6 +980,7 @@ You can provide credentials via the `ZDX_CLIENT_ID`, `ZDX_CLIENT_SECRET` environ
 |--------------|-------------|-------------------|
 | `key_id`       | _(String)_ A string that contains the key_id for the ZDX Portal.| `ZDX_CLIENT_ID` |
 | `key_secret`       | _(String)_ A string that contains the key_secret key for the ZDX Portal.| `ZDX_CLIENT_SECRET` |
+| `cloud`            | _(String)_ The cloud name prefix that identifies the correct API endpoint.| `ZDX_CLOUD` |
 
 ### ZDX Legacy Client Initialization
 

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/README.md

@@ -941,6 +941,7 @@ You can provide credentials via the `ZDX_CLIENT_ID`, `ZDX_CLIENT_SECRET` environ
 |--------------|-------------|-------------------|
 | `key_id`       | _(String)_ A string that contains the key_id for the ZDX Portal.| `ZDX_CLIENT_ID` |
 | `key_secret`       | _(String)_ A string that contains the key_secret key for the ZDX Portal.| `ZDX_CLIENT_SECRET` |
+| `cloud`            | _(String)_ The cloud name prefix that identifies the correct API endpoint.| `ZDX_CLOUD` |
 
 ### ZDX Legacy Client Initialization
 

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/pyproject.toml

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

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/__init__.py

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

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/oneapi_client.py

@@ -431,7 +431,7 @@ class LegacyZWAClient(Client):
     ):
         key_id = config.get("key_id", os.getenv("ZWA_CLIENT_ID"))
         key_secret = config.get("key_secret", os.getenv("ZWA_CLIENT_SECRET"))
-        cloud = config.get("cloud", os.getenv("ZWACLOUD", "us1"))
+        cloud = config.get("cloud", os.getenv("ZWA_CLOUD", "us1"))
         timeout = config.get("timeout", 240)
         request_executor_impl = config.get("requestExecutor", None)
         # Initialize the LegacyZWAClientHelper with the extracted parameters

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/request_executor.py

@@ -77,13 +77,6 @@ class RequestExecutor:
         self._config = config
         self._cache = cache
 
-        # ✅ Setup logging based on config flags
-        # log_config = self._config["client"].get("logging", {})
-        # setup_logging(
-        #     enabled=log_config.get("enabled", False),
-        #     verbose=log_config.get("verbose", False),
-        # )
-
         # Retrieve cloud, service, and customer ID (optional)
         self.cloud = self._config["client"].get("cloud", "production").lower()
         self.sandbox_cloud = self._config["client"].get("sandboxCloud", "").lower()

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/utils.py

@@ -78,6 +78,7 @@ reformat_params = [
     ("workload_groups", "workloadGroups"),
     ("service_ids", "services"),
     ("bandwidth_class_ids", "bandwidthClasses"),
+    ("virtual_zen_node_ids", "virtualZenNodes"),
 ]
 
 

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/activate.py

@@ -76,7 +76,7 @@ class ActivationAPI(APIClient):
             :obj:`Activation`, response object, and error if any.
 
         Examples:
-            >>> config_activate, response, error = zia.config.activate()
+            >>> config_activate, response, error = zia.activate.activate()
         """
         http_method = "post".upper()
         api_url = format_url(

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/alert_subscriptions.py

@@ -72,8 +72,8 @@ class AlertSubscriptionsAPI(APIClient):
             return (None, response, error)
 
         try:
-            advanced_settings = AlertSubscriptions(response.get_body())
-            return (advanced_settings, response, None)
+            results = [AlertSubscriptions(item) for item in response.get_body()]
+            return (results, response, None)
         except Exception as ex:
             return (None, response, ex)
 
@@ -237,7 +237,7 @@ class AlertSubscriptionsAPI(APIClient):
             """
         )
 
-        body = kwargs.copy()
+        body = kwargs
         body["id"] = subscription_id
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, {})
@@ -257,3 +257,41 @@ class AlertSubscriptionsAPI(APIClient):
             return (None, response, error)
 
         return (result, response, None)
+
+    def delete_alert_subscription(self, subscription_id: int) -> tuple:
+        """
+        Deletes the specified Alert Subscription
+
+        Args:
+            subscription_id (str): The unique identifier of the Alert Subscription.
+
+        Returns:
+            tuple: A tuple containing the response object and error (if any).
+
+        Examples:
+            Delete a Alert Subscription:
+
+            >>> _, _, error = client.zia.alert_subscriptions.delete_alert_subscription('73459')
+            >>> if error:
+            ...     print(f"Error deleting Alert Subscription: {error}")
+            ...     return
+            ... print(f"Alert Subscription with ID {'73459' deleted successfully.")
+        """
+        http_method = "delete".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /alertSubscriptions/{subscription_id}
+        """
+        )
+
+        params = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, params=params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+        if error:
+            return (None, response, error)
+        return (None, response, None)

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/authentication_settings.py

@@ -41,13 +41,7 @@ class AuthenticationSettingsAPI(APIClient):
                 - list[str]: List of domains or URLs which are exempted from SSL Inspection
                 - Response: The raw HTTP response from the API.
                 - error: Error details if the request fails.
-
-        Examples:
-            >>> urls, response, err = client.zia.authentication_settings.get_exempted_urls()
-            >>> if not err:
-            ...     print("Listed URLs:", urls)
         """
-
         http_method = "get".upper()
         api_url = format_url(
             f"""
@@ -60,7 +54,7 @@ class AuthenticationSettingsAPI(APIClient):
         if error:
             return (None, None, error)
 
-        response, error = self._request_executor.execute(request)
+        response, error = self._request_executor.execute(request, dict)
         if error:
             return (None, response, error)
 

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/bandwidth_control_rules.py

@@ -268,6 +268,7 @@ class BandwidthControlRulesAPI(APIClient):
 
         body = kwargs
 
+        # Convert 'enabled' to 'state' (ENABLED/DISABLED) if it's present in the payload
         if "enabled" in kwargs:
             kwargs["state"] = "ENABLED" if kwargs.pop("enabled") else "DISABLED"
 
@@ -348,7 +349,7 @@ class BandwidthControlRulesAPI(APIClient):
         """
         )
 
-        body = kwargs.copy()
+        body = kwargs
         body["id"] = rule_id
 
         if "enabled" in kwargs:

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/cloud_firewall.py

@@ -978,7 +978,7 @@ class FirewallResourcesAPI(APIClient):
 
         Args:
             name (str): The name of the IP Source Group.
-            ip_addresses (str): The list of IP addresses for the IP Source Group.
+            ip_addresses (list): The list of IP addresses for the IP Source Group.
             description (str): Additional information for the IP Source Group.
 
         Returns:
@@ -987,10 +987,15 @@ class FirewallResourcesAPI(APIClient):
         Examples:
             Add a new IP Source Group:
 
-            >>> zia.cloud_firewall.add_ip_source_group(name='My IP Source Group',
-            ...    ip_addresses=['198.51.100.0/24', '192.0.2.1'],
-            ...    description='Contains the IP addresses for the local network.')
-
+            >>> added_group, _, error = client.zia.cloud_firewall.add_ip_source_group(
+            ...     name=f"AddNewGroup_{random.randint(1000, 10000)}",
+            ...     description=f"AddNewGroup_{random.randint(1000, 10000)}",
+            ...     ip_addresses=["192.168.1.1", "192.168.1.2"],
+            ... )
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {added_group.as_dict()}")
         """
         http_method = "post".upper()
         api_url = format_url(
@@ -1040,16 +1045,18 @@ class FirewallResourcesAPI(APIClient):
             :obj:`Tuple`: The updated IP Source Group resource record.
 
         Examples:
-            Update the name of an IP Source Group:
-
-            >>> zia.cloud_firewall.update_ip_source_group('9032674',
-            ...    name='Updated Name')
 
-            Update the description and IP addresses of an IP Source Group:
+            Update ip_addresses list of the IP Source Group:
 
-            >>> zia.cloud_firewall.update_ip_source_group('9032674',
-            ...    description='Local subnets, updated on 3 JUL 21'
-            ...    ip_addresses=['192.0.2.0/29', '192.0.2.8/29', '192.0.2.128/25'])
+            >>> update_group, _, error = client.zia.cloud_firewall.add_ip_source_group(
+            ...     name=f"UpdateNewGroup_{random.randint(1000, 10000)}",
+            ...     description=f"UpdateNewGroup_{random.randint(1000, 10000)}",
+            ...     ip_addresses=["192.168.1.1", "192.168.1.2", "192.168.1.4"],
+            ... )
+            >>> if error:
+            ...     print(f"Error updating group: {error}")
+            ...     return
+            ... print(f"Group updated successfully: {update_group.as_dict()}")
 
         """
         http_method = "put".upper()
@@ -1093,11 +1100,11 @@ class FirewallResourcesAPI(APIClient):
             :obj:`int`: The status code for the operation.
 
         Examples:
-            >>> _, response, error = client.zia.cloud_firewall.delete_ip_source_group(updated_group.id)
-            ... if error:
+            >>> _, _, error = client.zia.cloud_firewall.delete_ip_source_group('18382907')
+            >>> if error:
             ...     print(f"Error deleting group: {error}")
-            ... return
-
+            ...     return
+            ... print(f"Group with ID 18382907 deleted successfully.")
         """
         http_method = "delete".upper()
         api_url = format_url(
@@ -1154,7 +1161,6 @@ class FirewallResourcesAPI(APIClient):
             ... print(f"Total groups found: {len(group_list)}")
             ... for group in group_list:
             ...     print(group.as_dict())
-
         """
         http_method = "get".upper()
         api_url = format_url(
@@ -1250,10 +1256,15 @@ class FirewallResourcesAPI(APIClient):
         Examples:
             Add a new Network Application Group:
 
-            >>> zia.cloud_firewall.add_network_app_group(name='New Network Application Group',
-            ...    network_applications=['SALESFORCE', 'GOOGLEANALYTICS', 'OFFICE365'],
-            ...    description='Additional information about the Network Application Group.')
-
+            >>> added_group, _, error = client.zia.cloud_firewall.add_network_app_group(
+            ...     name=f"AddNewGroup_{random.randint(1000, 10000)}",
+            ...     description=f"AddNewGroup_{random.randint(1000, 10000)}",
+            ...     network_applications=['SALESFORCE', 'GOOGLEANALYTICS', 'OFFICE365'],
+            ... )
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {added_group.as_dict()}")
         """
         http_method = "post".upper()
         api_url = format_url(
@@ -1305,14 +1316,15 @@ class FirewallResourcesAPI(APIClient):
         Examples:
             Update the name of an Network Application Group:
 
-            >>> zia.cloud_firewall.update_network_app_group('9032674',
-            ...    name='Updated Network Application Group Name')
-
-            Update the description and applications for a Network Application Group:
-
-            >>> zia.cloud_firewall.update_network_app_group('9032674',
-            ...    description='Network Application Group, updated on May 27, 2023'
-            ...    network_applications=['SALESFORCE', 'GOOGLEANALYTICS', 'OFFICE365'])
+            >>> update_group, _, error = client.zia.cloud_firewall.add_network_app_group(
+            ...     name=f"UpdateNewGroup_{random.randint(1000, 10000)}",
+            ...     description=f"UpdateNewGroup_{random.randint(1000, 10000)}",
+            ...     network_applications=['SALESFORCE', 'GOOGLEANALYTICS'],
+            ... )
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {update_group.as_dict()}")
 
         """
         http_method = "put".upper()
@@ -1355,11 +1367,11 @@ class FirewallResourcesAPI(APIClient):
             :obj:`int`: The response code for the operation.
 
         Examples:
-            >>> _, response, error = client.zia.cloud_firewall.delete_network_app_group('18382907')
-            ... if error:
+            >>> _, _, error = client.zia.cloud_firewall.delete_network_app_group('18382907')
+            >>> if error:
             ...     print(f"Error deleting group: {error}")
             ...     return
-
+            ... print(f"Group with ID {updated_group.id} deleted successfully.")
         """
         http_method = "delete".upper()
         api_url = format_url(
@@ -1700,10 +1712,14 @@ class FirewallResourcesAPI(APIClient):
         Examples:
             Add a new Network Service Group:
 
-            >>> zia.cloud_firewall.add_network_svc_group(name='New Network Service Group',
+            >>> added_group, _, error = client.zia.cloud_firewall.add_network_svc_group(
+            ...    name=f"AddNewGroup_{random.randint(1000, 10000)}",
+            ...    description=f"AddNewGroup_{random.randint(1000, 10000)}",
             ...    service_ids=['159143', '159144', '159145'],
-            ...    description='Group for the new Network Service.')
-
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {added_group.as_dict()}")
         """
         http_method = "post".upper()
         api_url = format_url(
@@ -1726,7 +1742,6 @@ class FirewallResourcesAPI(APIClient):
         if error:
             return (None, None, error)
 
-        # Execute the request
         response, error = self._request_executor.execute(request, NetworkServiceGroups)
 
         if error:
@@ -1757,10 +1772,14 @@ class FirewallResourcesAPI(APIClient):
         Examples:
             Update the name Network Service Group:
 
-            >>> zia.cloud_firewall.update_network_svc_group(name='Update Network Service Group',
-            ...    service_ids=['159143', '159144', '159145'],
-            ...    description='Group for the new Network Service.')
-
+            >>> update_group, _, error = client.zia.cloud_firewall.update_network_svc_group(
+            ...    name=f"UpdateNewGroup_{random.randint(1000, 10000)}",
+            ...    description=f"UpdateNewGroup_{random.randint(1000, 10000)}",
+            ...    service_ids=['159143', '159144'],
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {update_group.as_dict()}")
         """
         http_method = "put".upper()
         api_url = format_url(
@@ -1774,7 +1793,6 @@ class FirewallResourcesAPI(APIClient):
 
         transform_common_id_fields(reformat_params, body, body)
 
-        # Create the request
         request, error = self._request_executor.create_request(
             method=http_method,
             endpoint=api_url,
@@ -1805,10 +1823,11 @@ class FirewallResourcesAPI(APIClient):
             :obj:`int`: The response code for the operation.
 
         Examples:
-            >>> _, response, error = client.zia.cloud_firewall.delete_network_svc_group(updated_group.id)
-            ... if error:
+            >>> _, _, error = client.zia.cloud_firewall.delete_network_svc_group('18382907')
+            >>> if error:
             ...     print(f"Error deleting group: {error}")
-            ... return
+            ...     return
+            ... print(f"Group with ID {updated_group.id} deleted successfully.")
 
         """
         http_method = "delete".upper()
@@ -2027,7 +2046,7 @@ class FirewallResourcesAPI(APIClient):
 
     def add_network_service(self, ports: list = None, **kwargs) -> tuple:
         """
-        Adds a new Network Service.
+        Adds a new Network Service
 
         Args:
             name: The name of the Network Service
@@ -2052,24 +2071,21 @@ class FirewallResourcesAPI(APIClient):
             :obj:`Tuple`: The newly created Network Service resource record.
 
         Examples:
-            Add Network Service for Microsoft Exchange:
 
-            >>> zia.cloud_firewall.add_network_service('MS LDAP',
-            ...    description='Covers all ports used by MS LDAP',
-            ...    ports=[
-            ...        ('dest', 'tcp', '389'),
-            ...        ('dest', 'udp', '389'),
-            ...        ('dest', 'tcp', '636'),
-            ...        ('dest', 'tcp', '3268', '3269')])
-
-            Add Network Service designed to match inbound SSH traffic:
-
-            >>> zia.cloud_firewall.add_network_service('Inbound SSH',
-            ...    description='Inbound SSH',
-            ...    ports=[
-            ...        ('src', 'tcp', '22'),
-            ...        ('dest', 'tcp', '1024', '65535')])
+            Add Network Services:
 
+            >>> added_service, _, error = client.zia.cloud_firewall.add_network_service(
+            ...     name=f"NewService {random.randint(1000, 10000)}",
+            ...     description=f"NewService {random.randint(1000, 10000)}",
+            ...     ports=[
+            ...         ('dest', 'tcp', '389'),
+            ...         ('dest', 'udp', '389'),
+            ...         ('dest', 'tcp', '636'),
+            ...         ('dest', 'tcp', '3268', '3269')])
+            >>> if error:
+            ...     print(f"Error adding network services: {error}")
+            ...     return
+            ... print(f"Service added successfully: {added_service.as_dict()}")
         """
         http_method = "post".upper()
         api_url = format_url(
@@ -2097,7 +2113,6 @@ class FirewallResourcesAPI(APIClient):
         if error:
             return (None, None, error)
 
-        # Execute the request
         response, error = self._request_executor.execute(request, NetworkServices)
 
         if error:
@@ -2140,15 +2155,18 @@ class FirewallResourcesAPI(APIClient):
         Examples:
             Update the name and description for a Network Service:
 
-            >>> zia.cloud_firewall.update_network_service('959093',
-            ...    name='MS Exchange',
-            ...    description='All ports related to the MS Exchange service.')
-
-            Updates the ports for a Network Service, leaving other fields intact:
-
-            >>> zia.cloud_firewall.update_network_service('959093',
-            ...    ports=[
-            ...        ('dest', 'tcp', '500', '510')])
+            >>> update_service, _, error = client.zia.cloud_firewall.update_network_service(
+            ...     name=f"UpdateNewService_{random.randint(1000, 10000)}",
+            ...     description=f"UpdateNewService_{random.randint(1000, 10000)}",
+            ...     ports=[
+            ...         ('dest', 'tcp', '389'),
+            ...         ('dest', 'udp', '389'),
+            ...         ('dest', 'tcp', '636'),
+            ...         ('dest', 'tcp', '3268', '3269')])
+            >>> if error:
+            ...     print(f"Error updating network services: {error}")
+            ...     return
+            ... print(f"Service updated successfully: {added_service.as_dict()}")
 
         """
         http_method = "put".upper()
@@ -2197,10 +2215,11 @@ class FirewallResourcesAPI(APIClient):
             :obj:`int`: The status code for the operation.
 
         Examples:
-            >>> _, response, error = client.zia.cloud_firewall.delete_network_service(updated_group.id)
-            ... if error:
-            ...     print(f"Error deleting group: {error}")
-            ... return
+            >>> _, _, error = client.zia.cloud_firewall.delete_network_service('18382907')
+            >>> if error:
+            ...     print(f"Error deleting network service: {error}")
+            ...     return
+            ... print(f"Network service with ID 18382907 deleted successfully.")
 
         """
         http_method = "delete".upper()

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/dns_gatways.py

@@ -264,7 +264,7 @@ class DNSGatewayAPI(APIClient):
             /dnsGateways/{gateway_id}
         """
         )
-        body = kwargs.copy()
+        body = kwargs
         body["id"] = gateway_id
 
         request, error = self._request_executor.create_request(

{zscaler_sdk_python-1.4.2 → zscaler_sdk_python-1.4.4}/zscaler/zia/legacy.py

@@ -936,6 +936,17 @@ class LegacyZIAClientHelper:
 
         return NatControlPolicyAPI(self.request_executor)
 
+    @property
+    def vzen_clusters(self):
+        """
+        The interface object for the :ref:`Virtual ZEN Clusters interface <zia-vzen_clusters>`.
+
+        """
+
+        from zscaler.zia.vzen_clusters import VZENClustersAPI
+
+        return VZENClustersAPI(self.request_executor)
+
     """
     Misc
     """