zscaler-sdk-python 0.1.1__tar.gz → 0.1.2__tar.gz

zscaler-sdk-python-0.1.2/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Zscaler Python SDK Changelog
+
+## 0.1.2 (April, 20 2024)
+
+### Notes
+
+- Python Versions: **v3.8, v3.9, v3.10, v3.11**
+
+### Bug Fixes
+
+* Fixed ZIA `list_dlp_incident_receiver` method to return proper `Box` response ([#67](https://github.com/zscaler/zscaler-sdk-python/pull/67))
+* Fixed ZIA sandbox `get_file_hash_count` to properly parse the API response ([#67](https://github.com/zscaler/zscaler-sdk-python/pull/67))
+* Removed pre-shared-key randomization from `add_vpn_credential` ([#67](https://github.com/zscaler/zscaler-sdk-python/pull/67))
+
+## 0.1.1 (April, 19 2024)
+
+### Notes
+
+- Python Versions: **v3.8, v3.9, v3.10, v3.11**
+
+### Internal Changes
+
+* Refactored `setup.py` for better packaging and improved long description through README.md ([#57](https://github.com/zscaler/zscaler-sdk-python/pull/57))
+* Refactored Integration Tests by removing `async` decorators ([#63](https://github.com/zscaler/zscaler-sdk-python/pull/63))
+
+
+## 0.1.0 (April, 18 2024)
+
+### Notes
+
+- Python Versions: **v3.8, v3.9, v3.10, v3.11**
+
+🎉 **Initial Release** 🎉

{zscaler-sdk-python-0.1.1/zscaler_sdk_python.egg-info → zscaler-sdk-python-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.1.1
+Version: 0.1.2
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://zscaler-sdk-python.readthedocs.io
 Author: Zscaler, Inc.

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/docsrc/conf.py

@@ -28,9 +28,9 @@ author = "Zscaler Technology Alliances"
 html_title = ""
 
 # The short X.Y version
-version = '0.1.1'
+version = '0.1.2'
 # The full version, including alpha/beta/rc tags
-release = '0.1.1'
+release = '0.1.2'
 
 # -- General configuration ---------------------------------------------------
 

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/setup.cfg

@@ -2,7 +2,7 @@
 universal = 1
 
 [metadata]
-license_file = LICENSE.md
+license_files = LICENSE.md
 
 [egg_info]
 tag_build = 

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/setup.py

@@ -15,7 +15,7 @@ packages = [
 package_data = {"": ["*"]}
 
 setup(name="zscaler-sdk-python",
-      version='0.1.1',
+      version='0.1.2',
       packages=find_packages(exclude=["tests", "*tests.*", "*tests"]),
       package_data=package_data,
       python_requires=">=3.8,<4.0",

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/tests/integration/zia/test_dlp_incident_receiver.py

@@ -46,27 +46,17 @@ class TestDLPIncidentReceiver:
                 # Fetch the selected receiver by its ID
                 try:
                     fetched_receiver = client.dlp.get_dlp_incident_receiver(receiver_id)
-                    assert (
-                        fetched_receiver is not None
-                    ), "Expected a valid receiver object"
-                    assert (
-                        fetched_receiver.get("id") == receiver_id
-                    ), "Mismatch in receiver ID"
+                    assert fetched_receiver is not None, "Expected a valid receiver object"
+                    assert fetched_receiver.get("id") == receiver_id, "Mismatch in receiver ID"
                 except Exception as exc:
                     errors.append(f"Fetching receiver by ID failed: {exc}")
 
                 # Attempt to retrieve the receiver by name
                 try:
-                    receiver_name = first_receiver.dlp("name")
-                    receiver_by_name = client.dlp.get_dlp_incident_receiver_by_name(
-                        receiver_name
-                    )
-                    assert (
-                        receiver_by_name is not None
-                    ), "Expected a valid receiver object when searching by name"
-                    assert (
-                        receiver_by_name.get("id") == receiver_id
-                    ), "Mismatch in receiver ID when searching by name"
+                    receiver_name = first_receiver.get("name")  # Corrected this line
+                    receiver_by_name = client.dlp.get_dlp_incident_receiver_by_name(receiver_name)
+                    assert receiver_by_name is not None, "Expected a valid receiver object when searching by name"
+                    assert receiver_by_name.get("id") == receiver_id, "Mismatch in receiver ID when searching by name"
                 except Exception as exc:
                     errors.append(f"Fetching receiver by name failed: {exc}")
 

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/zscaler/__init__.py

@@ -20,7 +20,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.1.1"
+__version__ = "0.1.2"
 
 from zscaler.zia import ZIAClientHelper  # noqa
 from zscaler.zpa import ZPAClientHelper  # noqa

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/zscaler/zia/dlp.py

@@ -466,11 +466,15 @@ class DLPAPI:
             >>> pprint(zia.dlp.list_dlp_icap_servers('ZS_ICAP'))
 
         """
-        payload = {"search": query}
-        list = self.rest.get(path="/icapServers", params=payload)
-        if isinstance(list, Response):
+        response = self.rest.get("/icapServers")
+        if isinstance(response, Response):
             return None
-        return list
+        return response
+        # payload = {"search": query}
+        # list = self.rest.get(path="/icapServers", params=payload)
+        # if isinstance(list, Response):
+        #     return None
+        # return list
 
     def get_dlp_icap_servers(self, icap_server_id: str) -> Box:
         """
@@ -511,19 +515,18 @@ class DLPAPI:
         Examples:
             Print all incident receivers
 
-            >>> for dlp incident receiver in zia.dlp.list_dlp_incident_receiver():
-            ...    pprint(receiver)
+            >>> for receiver in zia.dlp.list_dlp_incident_receiver():
+            ...    pprint(dlp)
 
             Print Incident Receiver that match the name or description 'ZS_INC_RECEIVER_01'
 
             >>> pprint(zia.dlp.list_dlp_incident_receiver('ZS_INC_RECEIVER_01'))
 
         """
-        payload = {"search": query}
-        response = self.rest.get(path="/incidentReceiverServers", params=payload)
-        if isinstance(response, Response) and response.ok:
-            return response.json()
-        return []  # Return an empty list in case of no data or error
+        response = self.rest.get("/incidentReceiverServers")
+        if isinstance(response, Response):
+            return None
+        return response
 
     def get_dlp_incident_receiver(self, receiver_id: str) -> Box:
         """
@@ -545,13 +548,23 @@ class DLPAPI:
         return response
 
     def get_dlp_incident_receiver_by_name(self, name):
-        # Fetch all receivers (assuming the API doesn't support server-side filtering by name)
+        """
+        Retrieves a specific DLP Incident Receiver by its name.
+
+        Args:
+            name (str): The name of the dlp incident receiver to retrieve.
+
+        Returns:
+            :obj:`Box`: The incident receiver if found, otherwise None.
+
+        Examples:
+            >>> receiver = zia.dlp.get_dlp_incident_receiver_by_name('ZS_INC_RECEIVER_01')
+            ...    pprint(receiver)
+        """
         receivers = self.list_dlp_incident_receiver()
-        # Iterate through the receivers to find a match by name
         for receiver in receivers:
             if receiver.get("name") == name:
                 return receiver
-        # If no receiver matches the given name
         return None
 
     def list_dlp_idm_profiles(self, query: str = None) -> BoxList:

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/zscaler/zia/sandbox.py

@@ -154,6 +154,27 @@ class CloudSandboxAPI:
         """
         return self.rest.get("behavioralAnalysisAdvancedSettings")
 
+    def get_file_hash_count(self) -> Box:
+        """
+        Retrieves the Cloud Sandbox used and unused quota for blocking MD5 file hashes.
+
+        This method fetches the count of MD5 hashes currently blocked by the Sandbox and the remaining
+        quota available for blocking additional hashes.
+
+        Returns:
+            Box: A Box object containing the used and unused quotas for MD5 hash blocking.
+
+        Examples:
+            >>> file_hash_quota = zia.sandbox.get_file_hash_count()
+            >>> pprint(file_hash_quota)
+
+        The returned Box object contains the following keys:
+        - blocked_file_hashes_count: The number of unique MD5 file hashes that are currently blocked.
+        - remaining_file_hashes: The remaining quota available for blocking additional MD5 file hashes.
+        """
+        response = self.rest.get("behavioralAnalysisAdvancedSettings/fileHashCount")
+        return response
+
     def add_hash_to_custom_list(self, file_hashes_to_be_blocked: list) -> Box:
         """
         Updates the custom list of MD5 file hashes that are blocked by Sandbox.

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2}/zscaler/zia/traffic.py

@@ -693,10 +693,6 @@ class TrafficForwardingAPI:
             :obj:`Box`: The newly created VPN credential resource record.
         """
 
-        # Generate a random PSK if not provided
-        if not pre_shared_key:
-            pre_shared_key = self.randomize_psk()
-
         payload = {
             "type": authentication_type,
             "preSharedKey": pre_shared_key,

{zscaler-sdk-python-0.1.1 → zscaler-sdk-python-0.1.2/zscaler_sdk_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.1.1
+Version: 0.1.2
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://zscaler-sdk-python.readthedocs.io
 Author: Zscaler, Inc.

zscaler-sdk-python-0.1.1/CHANGELOG.md

@@ -1,20 +0,0 @@
-# Zscaler Python SDK Changelog
-
-## 0.1.1 (April, 19 2024)
-
-### Notes
-
-- Python Versions: **v3.8, v3.9, v3.10, v3.11**
-
-### Internal Changes
-* Refactored `setup.py` for better packaging and improved long description through README.md ([#57](https://github.com/zscaler/zscaler-sdk-python/pull/57))
-* Refactored Integration Tests by removing `async` decorators ([#63](https://github.com/zscaler/zscaler-sdk-python/pull/63))
-
-
-## 0.1.0 (April, 18 2024)
-
-### Notes
-
-- Python Versions: **v3.8, v3.9, v3.10, v3.11**
-
-🎉 **Initial Release** 🎉