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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.9.19
+Version: 1.9.21
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -23,6 +23,7 @@ Requires-Dist: PyJWT (>=2.10.1)
 Requires-Dist: aenum (>=3.1.11)
 Requires-Dist: arrow (>=1.3.0)
 Requires-Dist: cryptography (>=45.0.2)
+Requires-Dist: jmespath (>=1.0.0)
 Requires-Dist: jwcrypto (>=1.5.6)
 Requires-Dist: pydash (>=8.0.3)
 Requires-Dist: python-box (>=7.3.0)
@@ -63,6 +64,7 @@ Description-Content-Type: text/markdown
 * [Zscaler Legacy API Framework](#zscaler-legacy-api-framework)
 * [Configuration reference](#configuration-reference)
 * [Pagination](#pagination)
+* [Client-Side Filtering with JMESPath](#client-side-filtering-with-jmespath)
 * [Contributing](#contributing)
 
 The Zscaler SDK for Python includes functionality to accelerate development via [Python](https://www.python.org/). This SDK can be
@@ -77,10 +79,11 @@ used in your server-side code to interact with the Zscaler API platform across m
 * [ZTB API (Zero Trust Branch)](https://help.zscaler.com/)
 * [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 * [EASM API](https://hhttps://help.zscaler.com/easm/easm-api/api-developer-reference-guide/reference-guide)
-* Z-Insights (zins) — GraphQL Analytics API
-* ZMS (Zscaler Microsegmentation) — GraphQL Microsegmentation API
+* [Z-Insights - ZINS](https://help.zscaler.com/zscaler-analytics/getting-started) — GraphQL Analytics API
+* [ZMS - Zscaler Microsegmentation](https://help.zscaler.com/legacy-apis/using-zscaler-microsegmentation-api) — GraphQL Microsegmentation API
+* [Business Insights](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/bi)
 
-This SDK is designed to support the new Zscaler API framework [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi)
+This SDK is designed to support the new Zscaler API framework [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started)
 via a single OAuth2 HTTP client. The SDK is also backwards compatible with the previous
 Zscaler API framework, and each package is supported by an individual and robust HTTP client
 designed to handle failures on different levels by performing intelligent retries.
@@ -210,19 +213,24 @@ In most cases, you won't need to build the SDK from source. If you want to build
 ### You'll also need
 
 * An administrator account in the Zscaler products you want to interact with.
-* [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi): If you are using the OneAPI entrypoint you must have a API Client created in the [Zidentity platform](https://help.zscaler.com/zidentity/about-api-clients)
+* [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started): If you are using the OneAPI entrypoint you must have a API Client created in the [Zidentity platform](https://help.zscaler.com/zidentity/about-api-clients)
 * Legacy Framework: If using the legacy API framework you must have API Keys credentials in the the respective Zscaler cloud products.
 * For more information on getting started with Zscaler APIs visit one of the following links:
 
-* [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi)
-* [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
-* [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
-* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
-* [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
-* [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
-* [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
+* [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started)
+* [ZPA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zpa)
+* [ZIA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zia)
+* [ZDX API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zdx)
+* [ZCC API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcc)
+* [ZIdentity (ZID)](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zid)
+* [ZTW API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcloudconnector)
+* [ZTB API (Zero Trust Branch)](https://help.zscaler.com/)
 * [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 * [EASM API](https://hhttps://help.zscaler.com/easm/easm-api/api-developer-reference-guide/reference-guide)
+* [Z-Insights - ZINS](https://help.zscaler.com/zscaler-analytics/getting-started) — GraphQL Analytics API
+* [ZMS - Zscaler Microsegmentation](https://help.zscaler.com/legacy-apis/using-zscaler-microsegmentation-api) — GraphQL Microsegmentation API
+* [Zscaler AI Guard API](https://help.zscaler.com/ai-guard)
+* [Business Insights](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/bi)
 
 ## Usage guide
 
@@ -234,7 +242,7 @@ Once you initialize a specific service client, you can call methods to make requ
 
 ## Authentication
 
-The latest versions => 0.20.0 of this SDK provides dual API client capability and can be used to interact both with new Zscaler [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi) framework and the legacy API platform.
+The latest versions => 0.20.0 of this SDK provides dual API client capability and can be used to interact both with new Zscaler [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started) framework and the legacy API platform.
 
 If your Zscaler tenant has not been migrated to the new Zscaler [Zidentity platform](https://help.zscaler.com/zidentity/what-zidentity), you must use the respective Legacy API client described in the following section: [Zscaler Legacy API Framework](#zscaler-legacy-api-framework)
 
@@ -244,13 +252,19 @@ If your Zscaler tenant has not been migrated to the new Zscaler [Zidentity platf
 
 As of the publication of SDK version => 1.7.x, OneAPI is available for programmatic interaction with the following products:
 
-* [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
-* [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
-* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
-* [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
-* [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
-* [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
+* [ZPA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zpa)
+* [ZIA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zia)
+* [ZDX API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zdx)
+* [ZCC API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcc)
+* [ZIdentity (zid)](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zid)
+* [ZTW API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcloudconnector)
+* [ZTB API (Zero Trust Branch)](https://help.zscaler.com/)
+* [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 * [EASM API](https://hhttps://help.zscaler.com/easm/easm-api/api-developer-reference-guide/reference-guide)
+* [Z-Insights - ZINS](https://help.zscaler.com/zscaler-analytics/getting-started) — GraphQL Analytics API
+* [ZMS - Zscaler Microsegmentation](https://help.zscaler.com/legacy-apis/using-zscaler-microsegmentation-api) — GraphQL Microsegmentation API
+* [Zscaler AI Guard API](https://help.zscaler.com/ai-guard)
+* [Business Insights](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/bi)
 
 **NOTE** All other products such as Zscaler Cloud Connector (ZTW) and Zscaler Digital Experience (ZDX) are supported only via the legacy authentication method described in this README.
 
@@ -745,6 +759,95 @@ except StopIteration:
     print("All data fetched.")
 ```
 
+### Client-Side Filtering with JMESPath
+
+The SDK supports client-side filtering and projection of API results using [JMESPath](https://jmespath.org/) expressions. After any list call, you can use `resp.search(expression)` to filter, project, or reshape the response data without making additional API calls.
+
+JMESPath is a query language for JSON that lets you declaratively extract and transform elements from JSON documents. The `.search()` method applies a JMESPath expression to the current page of results and returns a list of matching items.
+
+#### Basic Filtering
+
+```py
+# Fetch users and filter admin users client-side
+users, resp, err = client.zia.user_management.list_users()
+admin_users = resp.search("[?adminUser==`true`]")
+print(f"Found {len(admin_users)} admin users")
+```
+
+#### Projection (Selecting Specific Fields)
+
+```py
+# Extract only names and emails
+users, resp, err = client.zia.user_management.list_users()
+names_emails = resp.search("[*].{name: name, email: email}")
+for item in names_emails:
+    print(f"{item['name']}: {item['email']}")
+```
+
+#### Combined Filtering and Projection
+
+```py
+# Filter by role and project specific fields
+users, resp, err = client.zia.user_management.list_users()
+result = resp.search("[?adminUser==`true`].{name: name, id: id}")
+```
+
+#### Nested Field Filtering
+
+```py
+# Filter users by department name
+users, resp, err = client.zia.user_management.list_users()
+eng_users = resp.search("[?department.name=='Engineering'].name")
+```
+
+#### Using with Paginated Results
+
+`.search()` operates on the current page. To filter across all pages, apply it to each page as you paginate:
+
+```py
+users, resp, err = client.zia.user_management.list_users(
+    query_params={"page_size": 1000}
+)
+all_admins = resp.search("[?adminUser==`true`]")
+
+while resp.has_next():
+    next_page, resp, err = resp.next()
+    if err:
+        break
+    if next_page:
+        all_admins.extend(resp.search("[?adminUser==`true`]"))
+
+print(f"Total admins across all pages: {len(all_admins)}")
+```
+
+#### Using with Wrapped Responses
+
+For APIs that wrap results in a named key (e.g., ZDX `items`, ZBI `reports`), reference the key in the expression:
+
+```py
+# ZDX software inventory
+items, resp, err = client.zdx.software.list_inventory()
+zscaler_sw = resp.search(
+    "items[?vendor=='Zscaler'].{name: software_name, devices: device_total}"
+)
+
+# ZBI reports
+reports, resp, err = client.zbi.reports.list_reports(report_type="APPLICATION")
+completed = resp.search("reports[?status=='COMPLETED']")
+```
+
+#### JMESPath Built-in Functions
+
+JMESPath supports built-in functions like `length()`, `sort_by()`, `max_by()`, and more:
+
+```py
+# Users with at least one group assigned
+users, resp, err = client.zia.user_management.list_users()
+with_groups = resp.search("[?length(groups || `[]`) > `0`]")
+```
+
+For the full JMESPath specification and function reference, see [jmespath.org](https://jmespath.org/).
+
 ## Logging
 
 The Zscaler SDK Python, provides robust logging for debug purposes.
@@ -1736,14 +1839,14 @@ At this moment we are not accepting contributions, but we welcome suggestions on
 [zenith]: https://community.zscaler.com/
 [zscaler-support]: https://help.zscaler.com/contact-support
 [github-issues]: https://github.com/zscaler/zscaler-sdk-python/issues
-[rate-limiting-zcc]: https://help.zscaler.com/zscaler-client-connector/understanding-rate-limiting
-[rate-limiting-ZTW]: https://help.zscaler.com/cloud-branch-connector/understanding-rate-limits
-[rate-limiting-zdx]: https://help.zscaler.com/zdx/understanding-rate-limiting
-[rate-limiting-zia]: https://help.zscaler.com/zia/understanding-rate-limiting
-[rate-limiting-zpa]: https://help.zscaler.com/zpa/understanding-rate-limiting
+[rate-limiting-zcc]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/client-connector
+[rate-limiting-ZTW]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/cloud-branch-connector
+[rate-limiting-zdx]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/zdx
+[rate-limiting-zia]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/zia
+[rate-limiting-zpa]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/zpa
+[rate-limiting-bi]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/bi
 [rate-limiting-zwa]: https://help.zscaler.com/workflow-automation/understanding-api-rate-limiting-workflow-automation-api
-[application-segment-api-docs]: https://help.zscaler.com/zpa/application-controller#/mgmtconfig/v1/admin/customers/{customerId}/application-post
-[application-segment]: zscaler/zpa/application_segment.py
+
 
 Contributors
 ------------

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

@@ -25,6 +25,7 @@
 * [Zscaler Legacy API Framework](#zscaler-legacy-api-framework)
 * [Configuration reference](#configuration-reference)
 * [Pagination](#pagination)
+* [Client-Side Filtering with JMESPath](#client-side-filtering-with-jmespath)
 * [Contributing](#contributing)
 
 The Zscaler SDK for Python includes functionality to accelerate development via [Python](https://www.python.org/). This SDK can be
@@ -39,10 +40,11 @@ used in your server-side code to interact with the Zscaler API platform across m
 * [ZTB API (Zero Trust Branch)](https://help.zscaler.com/)
 * [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 * [EASM API](https://hhttps://help.zscaler.com/easm/easm-api/api-developer-reference-guide/reference-guide)
-* Z-Insights (zins) — GraphQL Analytics API
-* ZMS (Zscaler Microsegmentation) — GraphQL Microsegmentation API
+* [Z-Insights - ZINS](https://help.zscaler.com/zscaler-analytics/getting-started) — GraphQL Analytics API
+* [ZMS - Zscaler Microsegmentation](https://help.zscaler.com/legacy-apis/using-zscaler-microsegmentation-api) — GraphQL Microsegmentation API
+* [Business Insights](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/bi)
 
-This SDK is designed to support the new Zscaler API framework [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi)
+This SDK is designed to support the new Zscaler API framework [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started)
 via a single OAuth2 HTTP client. The SDK is also backwards compatible with the previous
 Zscaler API framework, and each package is supported by an individual and robust HTTP client
 designed to handle failures on different levels by performing intelligent retries.
@@ -172,19 +174,24 @@ In most cases, you won't need to build the SDK from source. If you want to build
 ### You'll also need
 
 * An administrator account in the Zscaler products you want to interact with.
-* [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi): If you are using the OneAPI entrypoint you must have a API Client created in the [Zidentity platform](https://help.zscaler.com/zidentity/about-api-clients)
+* [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started): If you are using the OneAPI entrypoint you must have a API Client created in the [Zidentity platform](https://help.zscaler.com/zidentity/about-api-clients)
 * Legacy Framework: If using the legacy API framework you must have API Keys credentials in the the respective Zscaler cloud products.
 * For more information on getting started with Zscaler APIs visit one of the following links:
 
-* [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi)
-* [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
-* [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
-* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
-* [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
-* [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
-* [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
+* [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started)
+* [ZPA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zpa)
+* [ZIA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zia)
+* [ZDX API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zdx)
+* [ZCC API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcc)
+* [ZIdentity (ZID)](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zid)
+* [ZTW API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcloudconnector)
+* [ZTB API (Zero Trust Branch)](https://help.zscaler.com/)
 * [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 * [EASM API](https://hhttps://help.zscaler.com/easm/easm-api/api-developer-reference-guide/reference-guide)
+* [Z-Insights - ZINS](https://help.zscaler.com/zscaler-analytics/getting-started) — GraphQL Analytics API
+* [ZMS - Zscaler Microsegmentation](https://help.zscaler.com/legacy-apis/using-zscaler-microsegmentation-api) — GraphQL Microsegmentation API
+* [Zscaler AI Guard API](https://help.zscaler.com/ai-guard)
+* [Business Insights](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/bi)
 
 ## Usage guide
 
@@ -196,7 +203,7 @@ Once you initialize a specific service client, you can call methods to make requ
 
 ## Authentication
 
-The latest versions => 0.20.0 of this SDK provides dual API client capability and can be used to interact both with new Zscaler [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi) framework and the legacy API platform.
+The latest versions => 0.20.0 of this SDK provides dual API client capability and can be used to interact both with new Zscaler [OneAPI](https://automate.zscaler.com/docs/getting-started/getting-started) framework and the legacy API platform.
 
 If your Zscaler tenant has not been migrated to the new Zscaler [Zidentity platform](https://help.zscaler.com/zidentity/what-zidentity), you must use the respective Legacy API client described in the following section: [Zscaler Legacy API Framework](#zscaler-legacy-api-framework)
 
@@ -206,13 +213,19 @@ If your Zscaler tenant has not been migrated to the new Zscaler [Zidentity platf
 
 As of the publication of SDK version => 1.7.x, OneAPI is available for programmatic interaction with the following products:
 
-* [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
-* [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
-* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
-* [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
-* [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
-* [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
+* [ZPA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zpa)
+* [ZIA API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zia)
+* [ZDX API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zdx)
+* [ZCC API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcc)
+* [ZIdentity (zid)](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zid)
+* [ZTW API](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/zcloudconnector)
+* [ZTB API (Zero Trust Branch)](https://help.zscaler.com/)
+* [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 * [EASM API](https://hhttps://help.zscaler.com/easm/easm-api/api-developer-reference-guide/reference-guide)
+* [Z-Insights - ZINS](https://help.zscaler.com/zscaler-analytics/getting-started) — GraphQL Analytics API
+* [ZMS - Zscaler Microsegmentation](https://help.zscaler.com/legacy-apis/using-zscaler-microsegmentation-api) — GraphQL Microsegmentation API
+* [Zscaler AI Guard API](https://help.zscaler.com/ai-guard)
+* [Business Insights](https://automate.zscaler.com/docs/docs/api-reference-and-guides/api-reference/bi)
 
 **NOTE** All other products such as Zscaler Cloud Connector (ZTW) and Zscaler Digital Experience (ZDX) are supported only via the legacy authentication method described in this README.
 
@@ -707,6 +720,95 @@ except StopIteration:
     print("All data fetched.")
 ```
 
+### Client-Side Filtering with JMESPath
+
+The SDK supports client-side filtering and projection of API results using [JMESPath](https://jmespath.org/) expressions. After any list call, you can use `resp.search(expression)` to filter, project, or reshape the response data without making additional API calls.
+
+JMESPath is a query language for JSON that lets you declaratively extract and transform elements from JSON documents. The `.search()` method applies a JMESPath expression to the current page of results and returns a list of matching items.
+
+#### Basic Filtering
+
+```py
+# Fetch users and filter admin users client-side
+users, resp, err = client.zia.user_management.list_users()
+admin_users = resp.search("[?adminUser==`true`]")
+print(f"Found {len(admin_users)} admin users")
+```
+
+#### Projection (Selecting Specific Fields)
+
+```py
+# Extract only names and emails
+users, resp, err = client.zia.user_management.list_users()
+names_emails = resp.search("[*].{name: name, email: email}")
+for item in names_emails:
+    print(f"{item['name']}: {item['email']}")
+```
+
+#### Combined Filtering and Projection
+
+```py
+# Filter by role and project specific fields
+users, resp, err = client.zia.user_management.list_users()
+result = resp.search("[?adminUser==`true`].{name: name, id: id}")
+```
+
+#### Nested Field Filtering
+
+```py
+# Filter users by department name
+users, resp, err = client.zia.user_management.list_users()
+eng_users = resp.search("[?department.name=='Engineering'].name")
+```
+
+#### Using with Paginated Results
+
+`.search()` operates on the current page. To filter across all pages, apply it to each page as you paginate:
+
+```py
+users, resp, err = client.zia.user_management.list_users(
+    query_params={"page_size": 1000}
+)
+all_admins = resp.search("[?adminUser==`true`]")
+
+while resp.has_next():
+    next_page, resp, err = resp.next()
+    if err:
+        break
+    if next_page:
+        all_admins.extend(resp.search("[?adminUser==`true`]"))
+
+print(f"Total admins across all pages: {len(all_admins)}")
+```
+
+#### Using with Wrapped Responses
+
+For APIs that wrap results in a named key (e.g., ZDX `items`, ZBI `reports`), reference the key in the expression:
+
+```py
+# ZDX software inventory
+items, resp, err = client.zdx.software.list_inventory()
+zscaler_sw = resp.search(
+    "items[?vendor=='Zscaler'].{name: software_name, devices: device_total}"
+)
+
+# ZBI reports
+reports, resp, err = client.zbi.reports.list_reports(report_type="APPLICATION")
+completed = resp.search("reports[?status=='COMPLETED']")
+```
+
+#### JMESPath Built-in Functions
+
+JMESPath supports built-in functions like `length()`, `sort_by()`, `max_by()`, and more:
+
+```py
+# Users with at least one group assigned
+users, resp, err = client.zia.user_management.list_users()
+with_groups = resp.search("[?length(groups || `[]`) > `0`]")
+```
+
+For the full JMESPath specification and function reference, see [jmespath.org](https://jmespath.org/).
+
 ## Logging
 
 The Zscaler SDK Python, provides robust logging for debug purposes.
@@ -1698,14 +1800,14 @@ At this moment we are not accepting contributions, but we welcome suggestions on
 [zenith]: https://community.zscaler.com/
 [zscaler-support]: https://help.zscaler.com/contact-support
 [github-issues]: https://github.com/zscaler/zscaler-sdk-python/issues
-[rate-limiting-zcc]: https://help.zscaler.com/zscaler-client-connector/understanding-rate-limiting
-[rate-limiting-ZTW]: https://help.zscaler.com/cloud-branch-connector/understanding-rate-limits
-[rate-limiting-zdx]: https://help.zscaler.com/zdx/understanding-rate-limiting
-[rate-limiting-zia]: https://help.zscaler.com/zia/understanding-rate-limiting
-[rate-limiting-zpa]: https://help.zscaler.com/zpa/understanding-rate-limiting
+[rate-limiting-zcc]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/client-connector
+[rate-limiting-ZTW]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/cloud-branch-connector
+[rate-limiting-zdx]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/zdx
+[rate-limiting-zia]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/zia
+[rate-limiting-zpa]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/zpa
+[rate-limiting-bi]: https://automate.zscaler.com/docs/api-reference-and-guides/guides/rate-limiting/bi
 [rate-limiting-zwa]: https://help.zscaler.com/workflow-automation/understanding-api-rate-limiting-workflow-automation-api
-[application-segment-api-docs]: https://help.zscaler.com/zpa/application-controller#/mgmtconfig/v1/admin/customers/{customerId}/application-post
-[application-segment]: zscaler/zpa/application_segment.py
+
 
 Contributors
 ------------

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.19"
+version = "1.9.21"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -40,6 +40,7 @@ jwcrypto = ">=1.5.6"
 aenum = ">=3.1.11"
 pydash = ">=8.0.3"
 arrow = ">=1.3.0"
+jmespath = ">=1.0.0"
 
 [tool.poetry.group.dev.dependencies]
 black = ">=24.3.0"

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

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