zscaler-sdk-python 1.2.3__tar.gz → 1.2.4__tar.gz

{zscaler_sdk_python-1.2.3 → zscaler_sdk_python-1.2.4}/PKG-INFO

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

{zscaler_sdk_python-1.2.3 → zscaler_sdk_python-1.2.4}/pyproject.toml

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

{zscaler_sdk_python-1.2.3 → zscaler_sdk_python-1.2.4}/zscaler/__init__.py

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

{zscaler_sdk_python-1.2.3 → zscaler_sdk_python-1.2.4}/zscaler/zcc/devices.py

@@ -38,20 +38,13 @@ class DevicesAPI(APIClient):
         Downloads the list of devices as a CSV file from the ZCC portal.
 
         Args:
-            query_params (dict, optional): A dictionary containing supported filters:
-                ``[query_params.os_types]`` {str}: Filter by device operating system type. Valid options are:
-                    - ios
-                    - android
-                    - windows
-                    - macos
-                    - linux
-                ``[query_params.registration_types]`` {str}: Filter by device operating system type. Valid options are:
-                    - all
-                    - registered
-                    - unregistered
-                    - removal_pending
-                    - removed
-                    - quarantined
+            query_params (dict, optional): A dictionary containing supported filters.
+
+                ``[query_params.os_types]`` {str}: Filter by OS type. Valid values:
+                    ios, android, windows, macos, linux.
+
+                ``[query_params.registration_types]`` {str}: Filter by registration type. Valid values:
+                    all, registered, unregistered, removal_pending, removed, quarantined.
 
             filename (str, optional): Custom filename for the CSV file. Defaults to timestamped name.
 
@@ -73,7 +66,6 @@ class DevicesAPI(APIClient):
             ... except Exception as e:
             ...     print(f"Error during download: {e}")
         """
-
         query_params = query_params or {}
 
         if not filename:
@@ -131,22 +123,13 @@ class DevicesAPI(APIClient):
         Downloads service status for all devices from the ZCC portal.
 
         Args:
-            query_params (dict, optional): A dictionary containing supported filters:
-        Args:
-            query_params (dict, optional): A dictionary containing supported filters:
-                ``[query_params.os_types]`` {str}: Filter by device operating system type. Valid options are:
-                    - ios
-                    - android
-                    - windows
-                    - macos
-                    - linux
-                ``[query_params.registration_types]`` {str}: Filter by device operating system type. Valid options are:
-                    - all
-                    - registered
-                    - unregistered
-                    - removal_pending
-                    - removed
-                    - quarantined
+            query_params (dict, optional): A dictionary containing supported filters.
+
+                ``[query_params.os_types]`` {str}: Filter by OS type. Valid values:
+                    ios, android, windows, macos, linux.
+
+                ``[query_params.registration_types]`` {str}: Filter by registration type. Valid values:
+                    all, registered, unregistered, removal_pending, removed, quarantined.
 
                 filename (str, optional): Custom filename for the CSV file. Defaults to timestamped name.
 
@@ -226,18 +209,17 @@ class DevicesAPI(APIClient):
         Returns the list of devices enrolled in the Client Connector Portal.
 
         Args:
-            query_params {dict}: Map of query parameters for the request.
+            query_params (dict, optional): A dictionary containing supported filters.
 
                 ``[query_params.os_type]`` {str}: Filter by device operating system type. Valid options are:
-                    - ios
-                    - android
-                    - windows
-                    - macos
-                    - linux
-                ``[query_params.username]`` {str}: Filter by enrolled user name for the device.
+                    ios, android, windows, macos, linux.
+
+                ``[query_params.username]`` {str}:  Filter by enrolled username for the device.
 
                 ``[query_params.page]`` {str}: Specifies the page number.
-                ``[query_params.page_size]`` {str}: Specifies the page size. The default page size is 50.
+
+                ``[query_params.page_size]`` {str}: Specifies the page size.
+                    The default page size is 50.
                     The max page size is 5000.
 
         Returns:
@@ -445,7 +427,9 @@ class DevicesAPI(APIClient):
 
         Args:
             query_params {dict}: Map of query parameters for the request.
-                ``[query_params.page_size]`` {int}: Specifies the page size.  If not provided, the default page size is 30.
+
+                ``[query_params.page_size]`` {int}: Specifies the page size.
+                    If not provided, the default page size is 30.
                     The max page size is 5000.
 
         Returns:
@@ -506,7 +490,9 @@ class DevicesAPI(APIClient):
 
         Args:
             query_params {dict}: Map of query parameters for the request.
-                ``[query_params.page_size]`` {int}: Specifies the page size. If not provided, the default page size is 30.
+
+                ``[query_params.page_size]`` {int}: Specifies the page size.
+                    If not provided, the default page size is 30.
                     The max page size is 5000.
 
         Returns:

{zscaler_sdk_python-1.2.3 → zscaler_sdk_python-1.2.4}/zscaler/zcc/secrets.py

@@ -86,10 +86,12 @@ class SecretsAPI(APIClient):
         Return passwords for the specified username and device OS type.
 
         Args:
-            query_params (dict): Optional parameters.
-                - username (str): The username associated with the device.
-                - os_type (str): Device OS. One of:
-                    - ios, android, windows, macos, linux
+            query_params (dict, optional): A dictionary containing supported filters.
+
+                ``[query_params.os_type]`` {str}: Filter by device operating system type. Valid options are:
+                    ios, android, windows, macos, linux.
+
+                ``[query_params.username]`` {str}:  Filter by enrolled username for the device.
 
         Returns:
             tuple: (Passwords object, response, error)

{zscaler_sdk_python-1.2.3 → zscaler_sdk_python-1.2.4}/zscaler/zcc/web_policy.py

@@ -35,14 +35,14 @@ class WebPolicyAPI(APIClient):
         Args:
             query_params {dict}: Map of query parameters for the request.
                 ``[query_params.page]`` {int}: Specifies the page offset.
+
                 ``[query_params.page_size]`` {int}: Specifies the page size.
+
                 ``[query_params.device_type]`` {str}: Filter by device operating system type. Valid options are:
-                    - ios
-                    - android
-                    - windows
-                    - macos
-                    - linux
+                    ios, android, windows, macos, linux.
+
                 ``[query_params.search]`` {str}: The search string used to partially match.
+
                 ``[query_params.search_type]`` {str}: The search string used to partially match.
 
         Returns: