zscaler-sdk-python 1.9.21__tar.gz → 1.9.23__tar.gz

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.9.21
+Version: 1.9.23
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -45,15 +45,29 @@ Description-Content-Type: text/markdown
 [![Latest version released on PyPi](https://img.shields.io/pypi/v/zscaler-sdk-python.svg)](https://pypi.org/project/zscaler-sdk-python)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler-sdk-python.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
 [![codecov](https://codecov.io/gh/zscaler/zscaler-sdk-python/graph/badge.svg?token=56B53PITU8)](https://codecov.io/gh/zscaler/zscaler-sdk-python)
+[![Automation Hub](https://img.shields.io/badge/automation-hub-blue)](https://automate.zscaler.com/docs/tools/sdk-documentation/sdk-getting-started)
 [![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)
 
 ## Support Disclaimer
 
 -> **Disclaimer:** Please refer to our [General Support Statement](docsrc/zs/guides/support.rst) before proceeding with the use of this provider. You can also refer to our [troubleshooting guide](docsrc/zs/guides/troubleshooting.rst) for guidance on typical problems.
 
+> ## 🚧 Heads up: Zscaler Python SDK **v2.x is now in Public Preview / Beta**
+>
+> A new, **data-driven** version of the Zscaler Python SDK — generated directly from the official Zscaler OpenAPI specifications — is now available as a pre-release (`2.0.0bN`) on PyPI.
+>
+> - **v1.x (this README) is the current GA release** and remains the recommended choice for production workloads.
+> - **v2.x is OneAPI-only.** Legacy per-product authentication (ZIA `username`/`password`/`api_key`, ZPA `client_id`/`client_secret`, etc.) is **not** supported and will **not** be added.
+> - **Limited product coverage in v2.x today:** ZIA, ZDX, and ZIdentity. Other products are still being migrated.
+> - **Migrating existing v1.x code to v2.x will introduce breaking changes** — import paths, method signatures, and models all change.
+> - **Install the beta** with `pip install --pre --upgrade "zscaler-sdk-python>=2.0.0b1"` (the default `pip install zscaler-sdk-python` continues to install the latest v1.x GA release).
+>
+> **Get started with v2.x:** [Zscaler Automation Hub – Python SDK](https://automate.zscaler.com/docs/tools/sdk-documentation/sdk-getting-started) · **Migrate from v1.x:** [`UPGRADE_GUIDE.md`](./UPGRADE_GUIDE.md)
+
 # Official Zscaler Python SDK Overview
 
 * [Release status](#release-status)
+* [Migrating to v2.x (Beta)](#migrating-to-v2x-beta)
 * [Breaking Changes & Migration Guide to Multi-Client SDK](#breaking-changes--migration-guide-to-multi-client-sdk)
 * [Need help?](#need-help)
 * [Getting Started](#getting-started)
@@ -92,16 +106,44 @@ designed to handle failures on different levels by performing intelligent retrie
 
 This library uses semantic versioning and updates are posted in ([release notes](/docs/guides/release-notes.md)) |
 
-| Version | Status                           |
-| ------- | -------------------------------- |
-| 0.x     | :warning: Beta Release (Retired) |
-| 1.x     | :heavy_check_mark: Release       |
+| Version | Status                                                                       |
+| ------- | ---------------------------------------------------------------------------- |
+| 0.x     | :warning: Beta Release (Retired)                                             |
+| 1.x     | :heavy_check_mark: General Availability (recommended for production)         |
+| 2.x     | :test_tube: Public Preview / Beta — OneAPI only, limited product coverage    |
 
 The latest release can always be found on the ([releases page](github-releases))
 
 > Requires Python version 3.10 or higher.
 Zscaler SDK for Python is compatible with Python 3.10, 3.11, and 3.12.
 
+## Migrating to v2.x (Beta)
+
+The next major version of this SDK — `zscaler-sdk-python` **2.x** — is a complete redesign and is now available as a **public preview / beta** pre-release on PyPI. v2.x is **data-driven**: every model, request, and response is generated from the official Zscaler OpenAPI specifications, so the SDK stays in lock-step with the public API contract.
+
+> ⚠️ **Important — please read before adopting v2.x:**
+>
+> - **v2.x is in public preview / beta.** APIs, models, and import paths may change before GA. Do not use v2.x for production workloads.
+> - **v2.x supports OneAPI exclusively.** Legacy per-product authentication helpers (`LegacyZIAClient`, `LegacyZPAClient`, `LegacyZCCClient`, `LegacyZDXClient`, `LegacyZIdentityClient`, `LegacyZTWClient`, etc.) are **not** available in v2.x and will **not** be added. Your tenant must be on [Zidentity](https://help.zscaler.com/zidentity/what-zidentity) before you can adopt v2.x.
+> - **Limited product coverage today.** The v2.x beta currently supports **ZIA, ZDX, and ZIdentity**. Other Zscaler products (ZPA, ZCC, ZTW, ZTB, ZWA, …) remain available on **v1.x** and will be migrated to v2.x progressively.
+> - **Breaking changes.** Migrating existing v1.x code to v2.x will require code changes — import paths, method signatures, models, and error classes all change.
+
+**Install the v2.x beta**
+
+```bash
+pip install --pre --upgrade "zscaler-sdk-python>=2.0.0b1"
+```
+
+> The default `pip install zscaler-sdk-python` continues to install the latest **v1.x GA** release. Pre-releases (`2.0.0bN`) must be requested explicitly with `--pre` or by pinning a specific beta version.
+
+**Where to go next**
+
+- 📖 **Full v2.x documentation, getting-started, and per-product API reference:** [Zscaler Automation Hub – Python SDK](https://automate.zscaler.com/docs/tools/sdk-documentation/sdk-getting-started)
+- 🔁 **Migration guide from v1.x to v2.x:** [`UPGRADE_GUIDE.md`](./UPGRADE_GUIDE.md)
+- 🔐 **OneAPI / Zidentity onboarding:** [OneAPI Getting Started](https://automate.zscaler.com/docs/getting-started/getting-started)
+
+If your code depends on a product that is **not yet** in the v2.x beta — or if your tenant has **not** been migrated to Zidentity — continue to use the **v1.x** documentation in the rest of this README. v1.x will keep receiving bug fixes and security updates until v2.x reaches General Availability with full product parity.
+
 ## Need help?
 
 If you run into problems, please refer to our [General Support Statement](docs/guides/support.md) before proceeding with the use of this SDK. You can also refer to our [troubleshooting guide](docs/guides/troubleshooting.md) for guidance on typical problems. You can also raise an issue via ([github issues page](https://github.com/zscaler/zscaler-sdk-go/issues))

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/README.md

@@ -6,15 +6,29 @@
 [![Latest version released on PyPi](https://img.shields.io/pypi/v/zscaler-sdk-python.svg)](https://pypi.org/project/zscaler-sdk-python)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler-sdk-python.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
 [![codecov](https://codecov.io/gh/zscaler/zscaler-sdk-python/graph/badge.svg?token=56B53PITU8)](https://codecov.io/gh/zscaler/zscaler-sdk-python)
+[![Automation Hub](https://img.shields.io/badge/automation-hub-blue)](https://automate.zscaler.com/docs/tools/sdk-documentation/sdk-getting-started)
 [![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)
 
 ## Support Disclaimer
 
 -> **Disclaimer:** Please refer to our [General Support Statement](docsrc/zs/guides/support.rst) before proceeding with the use of this provider. You can also refer to our [troubleshooting guide](docsrc/zs/guides/troubleshooting.rst) for guidance on typical problems.
 
+> ## 🚧 Heads up: Zscaler Python SDK **v2.x is now in Public Preview / Beta**
+>
+> A new, **data-driven** version of the Zscaler Python SDK — generated directly from the official Zscaler OpenAPI specifications — is now available as a pre-release (`2.0.0bN`) on PyPI.
+>
+> - **v1.x (this README) is the current GA release** and remains the recommended choice for production workloads.
+> - **v2.x is OneAPI-only.** Legacy per-product authentication (ZIA `username`/`password`/`api_key`, ZPA `client_id`/`client_secret`, etc.) is **not** supported and will **not** be added.
+> - **Limited product coverage in v2.x today:** ZIA, ZDX, and ZIdentity. Other products are still being migrated.
+> - **Migrating existing v1.x code to v2.x will introduce breaking changes** — import paths, method signatures, and models all change.
+> - **Install the beta** with `pip install --pre --upgrade "zscaler-sdk-python>=2.0.0b1"` (the default `pip install zscaler-sdk-python` continues to install the latest v1.x GA release).
+>
+> **Get started with v2.x:** [Zscaler Automation Hub – Python SDK](https://automate.zscaler.com/docs/tools/sdk-documentation/sdk-getting-started) · **Migrate from v1.x:** [`UPGRADE_GUIDE.md`](./UPGRADE_GUIDE.md)
+
 # Official Zscaler Python SDK Overview
 
 * [Release status](#release-status)
+* [Migrating to v2.x (Beta)](#migrating-to-v2x-beta)
 * [Breaking Changes & Migration Guide to Multi-Client SDK](#breaking-changes--migration-guide-to-multi-client-sdk)
 * [Need help?](#need-help)
 * [Getting Started](#getting-started)
@@ -53,16 +67,44 @@ designed to handle failures on different levels by performing intelligent retrie
 
 This library uses semantic versioning and updates are posted in ([release notes](/docs/guides/release-notes.md)) |
 
-| Version | Status                           |
-| ------- | -------------------------------- |
-| 0.x     | :warning: Beta Release (Retired) |
-| 1.x     | :heavy_check_mark: Release       |
+| Version | Status                                                                       |
+| ------- | ---------------------------------------------------------------------------- |
+| 0.x     | :warning: Beta Release (Retired)                                             |
+| 1.x     | :heavy_check_mark: General Availability (recommended for production)         |
+| 2.x     | :test_tube: Public Preview / Beta — OneAPI only, limited product coverage    |
 
 The latest release can always be found on the ([releases page](github-releases))
 
 > Requires Python version 3.10 or higher.
 Zscaler SDK for Python is compatible with Python 3.10, 3.11, and 3.12.
 
+## Migrating to v2.x (Beta)
+
+The next major version of this SDK — `zscaler-sdk-python` **2.x** — is a complete redesign and is now available as a **public preview / beta** pre-release on PyPI. v2.x is **data-driven**: every model, request, and response is generated from the official Zscaler OpenAPI specifications, so the SDK stays in lock-step with the public API contract.
+
+> ⚠️ **Important — please read before adopting v2.x:**
+>
+> - **v2.x is in public preview / beta.** APIs, models, and import paths may change before GA. Do not use v2.x for production workloads.
+> - **v2.x supports OneAPI exclusively.** Legacy per-product authentication helpers (`LegacyZIAClient`, `LegacyZPAClient`, `LegacyZCCClient`, `LegacyZDXClient`, `LegacyZIdentityClient`, `LegacyZTWClient`, etc.) are **not** available in v2.x and will **not** be added. Your tenant must be on [Zidentity](https://help.zscaler.com/zidentity/what-zidentity) before you can adopt v2.x.
+> - **Limited product coverage today.** The v2.x beta currently supports **ZIA, ZDX, and ZIdentity**. Other Zscaler products (ZPA, ZCC, ZTW, ZTB, ZWA, …) remain available on **v1.x** and will be migrated to v2.x progressively.
+> - **Breaking changes.** Migrating existing v1.x code to v2.x will require code changes — import paths, method signatures, models, and error classes all change.
+
+**Install the v2.x beta**
+
+```bash
+pip install --pre --upgrade "zscaler-sdk-python>=2.0.0b1"
+```
+
+> The default `pip install zscaler-sdk-python` continues to install the latest **v1.x GA** release. Pre-releases (`2.0.0bN`) must be requested explicitly with `--pre` or by pinning a specific beta version.
+
+**Where to go next**
+
+- 📖 **Full v2.x documentation, getting-started, and per-product API reference:** [Zscaler Automation Hub – Python SDK](https://automate.zscaler.com/docs/tools/sdk-documentation/sdk-getting-started)
+- 🔁 **Migration guide from v1.x to v2.x:** [`UPGRADE_GUIDE.md`](./UPGRADE_GUIDE.md)
+- 🔐 **OneAPI / Zidentity onboarding:** [OneAPI Getting Started](https://automate.zscaler.com/docs/getting-started/getting-started)
+
+If your code depends on a product that is **not yet** in the v2.x beta — or if your tenant has **not** been migrated to Zidentity — continue to use the **v1.x** documentation in the rest of this README. v1.x will keep receiving bug fixes and security updates until v2.x reaches General Availability with full product parity.
+
 ## Need help?
 
 If you run into problems, please refer to our [General Support Statement](docs/guides/support.md) before proceeding with the use of this SDK. You can also refer to our [troubleshooting guide](docs/guides/troubleshooting.md) for guidance on typical problems. You can also raise an issue via ([github issues page](https://github.com/zscaler/zscaler-sdk-go/issues))

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/pyproject.toml

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

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/api_client.py

@@ -1,5 +1,29 @@
 from typing import Dict, Any, List, Union
-from pydash.strings import camel_case
+
+from zscaler.helpers import to_lower_camel_case
+
+
+def _to_camel(key: Any) -> Any:
+    """
+    Normalize a dict key to camelCase using the project's own ``to_lower_camel_case``
+    helper instead of ``pydash.strings.camel_case``.
+
+    ``pydash.camel_case`` tokenizes strings on every digit/letter boundary and
+    re-cases the tokens, which silently corrupts already-camelCase keys that
+    contain a digit-followed-by-lowercase-letter pattern. For example,
+    ``camel_case("isNameL10nTag")`` returns ``"isNameL10NTag"`` (capital ``N``),
+    so a downstream model lookup for ``config["isNameL10nTag"]`` fails and
+    the field comes back as ``None``.
+
+    ``to_lower_camel_case`` (from ``zscaler.helpers``) returns the string
+    unchanged when it contains no underscore, and consults a curated
+    ``FIELD_EXCEPTIONS`` map for snake_case keys that don't round-trip
+    cleanly (e.g. ``is_name_l10n_tag`` → ``isNameL10nTag``). Non-string
+    keys (rare, but possible) are returned untouched.
+    """
+    if not isinstance(key, str):
+        return key
+    return to_lower_camel_case(key)
 
 
 class APIClient:
@@ -23,7 +47,7 @@ class APIClient:
                     continue
                 # If val is a dict, process recursively
                 if isinstance(val, dict):
-                    result[camel_case(key)] = APIClient.form_response_body(val)
+                    result[_to_camel(key)] = APIClient.form_response_body(val)
                 # If val is a list, process each item inside it
                 elif isinstance(val, list):
                     processed_list = []
@@ -33,10 +57,10 @@ class APIClient:
                         else:
                             # Simple type inside the list, just append as is
                             processed_list.append(item)
-                    result[camel_case(key)] = processed_list
+                    result[_to_camel(key)] = processed_list
                 else:
                     # Simple type (string, int, etc.)
-                    result[camel_case(key)] = val
+                    result[_to_camel(key)] = val
             return result
 
         # If body is a list (which can happen if we ever pass a list directly),
@@ -65,7 +89,7 @@ class APIClient:
             if val is None:
                 continue
             if not isinstance(val, dict):
-                result[camel_case(key)] = val
+                result[_to_camel(key)] = val
             else:
-                result[camel_case(key)] = APIClient.format_request_body(val)
+                result[_to_camel(key)] = APIClient.format_request_body(val)
         return result

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/utils.py

@@ -117,8 +117,8 @@ def camel_to_snake(name: str):
     # Edge-cases where camelCase is breaking
     edge_cases = {
         "routableIP": "routable_ip",
-        "isNameL10nTag": "is_name_l10n_tag",
-        "nameL10nTag": "name_l10n_tag",
+        # "isNameL10nTag": "is_name_l10n_tag",
+        # "nameL10nTag": "name_l10n_tag",
         "surrogateIP": "surrogate_ip",
         "surrogateIPEnforcedForKnownBrowsers": "surrogate_ip_enforced_for_known_browsers",
         "startIPAddress": "start_ip_address",

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/zia/cloud_firewall.py

@@ -23,6 +23,7 @@ from zscaler.zia.models.cloud_firewall_nw_application_groups import NetworkAppli
 from zscaler.zia.models.cloud_firewall_nw_applications import NetworkApplications
 from zscaler.zia.models.cloud_firewall_nw_service_groups import NetworkServiceGroups
 from zscaler.zia.models.cloud_firewall_nw_service import NetworkServices
+from zscaler.zia.models.cloud_firewall_nw_service import NetworkServicesLite
 from zscaler.zia.models.cloud_firewall_time_windows import TimeWindows
 from zscaler.utils import format_url, transform_common_id_fields, reformat_params
 from zscaler.types import APIResult
@@ -1942,7 +1943,7 @@ class FirewallResourcesAPI(APIClient):
         try:
             results = []
             for item in response.get_results():
-                results.append(NetworkServices(self.form_response_body(item)))
+                results.append(NetworkServicesLite(self.form_response_body(item)))
         except Exception as exc:
             return (None, response, exc)
 

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/zia/models/advanced_settings.py

@@ -274,7 +274,8 @@ class AdvancedSettings(ZscalerObject):
             "trackHttpTunnelOnHttpPorts": self.track_http_tunnel_on_http_ports,
             "blockHttpTunnelOnNonHttpPorts": self.block_http_tunnel_on_non_http_ports,
             "blockDomainFrontingOnHostHeader": self.block_domain_fronting_on_host_header,
-            "zscalerClientConnector1AndPacRoadWarriorInFirewall": self.zscaler_client_connector1_and_pac_road_warrior_in_firewall,
+            "zscalerClientConnector1AndPacRoadWarriorInFirewall":
+                self.zscaler_client_connector1_and_pac_road_warrior_in_firewall,
             "cascadeUrlFiltering": self.cascade_url_filtering,
             "enablePolicyForUnauthenticatedTraffic": self.enable_policy_for_unauthenticated_traffic,
             "blockNonCompliantHttpRequestOnHttpPorts": self.block_non_compliant_http_request_on_http_ports,
@@ -300,8 +301,10 @@ class AdvancedSettings(ZscalerObject):
             "digestAuthBypassUrlCategories": self.digest_auth_bypass_url_categories,
             "digestAuthBypassUrls": self.digest_auth_bypass_urls,
             "digestAuthBypassApps": self.digest_auth_bypass_apps,
-            "dnsResolutionOnTransparentProxyExemptUrlCategories": self.dns_resolution_on_transparent_proxy_exempt_url_categories,
-            "dnsResolutionOnTransparentProxyIPv6ExemptUrlCategories": self.dns_resolution_on_transparent_proxy_ipv6_exempt_url_categories,
+            "dnsResolutionOnTransparentProxyExemptUrlCategories":
+                self.dns_resolution_on_transparent_proxy_exempt_url_categories,
+            "dnsResolutionOnTransparentProxyIPv6ExemptUrlCategories":
+                self.dns_resolution_on_transparent_proxy_ipv6_exempt_url_categories,
             "dnsResolutionOnTransparentProxyExemptUrls": self.dns_resolution_on_transparent_proxy_exempt_urls,
             "dnsResolutionOnTransparentProxyExemptApps": self.dns_resolution_on_transparent_proxy_exempt_apps,
             "dnsResolutionOnTransparentProxyIPv6ExemptApps": self.dns_resolution_on_transparent_proxy_ipv6_exempt_apps,

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/zia/models/cloud_firewall_nw_service.py

@@ -88,3 +88,55 @@ class PortRange(ZscalerObject):
 
     def request_format(self) -> Dict[str, Any]:
         return {"start": self.start, "end": self.end}
+
+
+class NetworkServiceExtensions(ZscalerObject):
+    """
+    A class representing the ``extensions`` block returned by the
+    Cloud Firewall Network Services /lite endpoint.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        super().__init__(config)
+        if config:
+            self.tag = config["tag"] if "tag" in config else None
+        else:
+            self.tag = None
+
+    def request_format(self) -> Dict[str, Any]:
+        return {"tag": self.tag}
+
+
+class NetworkServicesLite(ZscalerObject):
+    """
+    A class representing a Cloud Firewall Network Service Lite object
+    as returned by the /networkServices/lite endpoint.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        super().__init__(config)
+        if config:
+            self.id = config["id"] if "id" in config else None
+            self.name = config["name"] if "name" in config else None
+            self.is_name_l10n_tag = config["isNameL10nTag"] if "isNameL10nTag" in config else None
+            self.extensions = (
+                NetworkServiceExtensions(config["extensions"])
+                if "extensions" in config and config["extensions"] is not None
+                else None
+            )
+        else:
+            self.id = None
+            self.name = None
+            self.is_name_l10n_tag = True
+            self.extensions = None
+
+    def request_format(self) -> Dict[str, Any]:
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "id": self.id,
+            "name": self.name,
+            "isNameL10nTag": self.is_name_l10n_tag,
+            "extensions": self.extensions.request_format() if self.extensions else None,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format

{zscaler_sdk_python-1.9.21 → zscaler_sdk_python-1.9.23}/zscaler/zpa/models/app_connector_groups.py

@@ -70,6 +70,7 @@ class AppConnectorGroup(ZscalerObject):
             self.restriction_type = config["restrictionType"] if "restrictionType" in config else None
             self.zscaler_managed = config["zscalerManaged"] if "zscalerManaged" in config else None
             self.dc_hosting_info = config["dcHostingInfo"] if "dcHostingInfo" in config else None
+            self.enrollment_cert_id = config["enrollmentCertId"] if "enrollmentCertId" in config else None
 
             self.ip_acl = ZscalerCollection.form_list(config["ipAcl"] if "ipAcl" in config else [], str)
 
@@ -116,6 +117,7 @@ class AppConnectorGroup(ZscalerObject):
             self.restriction_type = None
             self.zscaler_managed = None
             self.dc_hosting_info = None
+            self.enrollment_cert_id = None
             self.server_groups = []
 
     def request_format(self) -> Dict[str, Any]:
@@ -158,6 +160,7 @@ class AppConnectorGroup(ZscalerObject):
             "restrictionType": self.restriction_type,
             "zscalerManaged": self.zscaler_managed,
             "dcHostingInfo": self.dc_hosting_info,
+            "enrollmentCertId": self.enrollment_cert_id,
             "serverGroups": [server_group.request_format() for server_group in self.server_groups],
         }
         parent_req_format.update(current_obj_format)