Update Python SDK (#150)

[bot](2026-03-27 14:06:27) Sync SDK with OpenAPI spec

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: vulncheck-oss-release-bot[bot]

README.md

@@ -46,6 +46,7 @@ pip install vulncheck-sdk
 ## Quickstart
 
 ```python
+import json
 import urllib.request
 import vulncheck_sdk
 import os
@@ -56,6 +57,7 @@ TOKEN = os.environ["VULNCHECK_API_TOKEN"]  # Remember to store your token secure
 # Now let's create a configuration object
 configuration = vulncheck_sdk.Configuration()
 configuration.api_key["Bearer"] = TOKEN
+configuration.ignore_operation_servers = True
 
 # Pass that config object to our API client and now...
 with vulncheck_sdk.ApiClient(configuration) as api_client:
@@ -77,10 +79,13 @@ with vulncheck_sdk.ApiClient(configuration) as api_client:
         print(cve)
 
     # Download a Backup
+    backup_client = vulncheck_sdk.BackupApi(api_client)
     index = "initial-access"
-    api_response = endpoints_client.backup_index_get(index)
+    raw = backup_client.backup_index_get_without_preload_content(index)
+    response_data = json.loads(raw.read())
+    download_url = response_data["data"][0]["url"]
     file_path = f"{index}.zip"
-    with urllib.request.urlopen(api_response.data[0].url) as response:
+    with urllib.request.urlopen(download_url) as response:
         with open(file_path, "wb") as file:
             file.write(response.read())
 
@@ -98,6 +103,7 @@ with vulncheck_sdk.ApiClient(configuration) as api_client:
 
 ```python
 import asyncio
+import json
 import os
 import aiohttp
 import vulncheck_sdk.aio as vcaio
@@ -107,13 +113,15 @@ TOKEN = os.environ.get("VULNCHECK_API_TOKEN")
 
 configuration = vcaio.Configuration()
 configuration.api_key["Bearer"] = TOKEN
+configuration.ignore_operation_servers = True
 
 
 async def run_vulnerability_checks():
     # Use 'async with' to manage the ApiClient connection pool
     async with vcaio.ApiClient(configuration) as api_client:
         endpoints_client = vcaio.EndpointsApi(api_client)
         indices_client = vcaio.IndicesApi(api_client)
+        backup_client = vcaio.BackupApi(api_client)
 
         # --- PURL Search ---
         # 'await' the coroutine to get results
@@ -138,11 +146,12 @@ async def run_vulnerability_checks():
 
         # --- Download Backup (Async) ---
         index_name = "initial-access"
-        # 'await' the coroutine to get results
-        backup_response = await endpoints_client.backup_index_get(index_name)
+        # 'await' the coroutine to get raw response bytes
+        raw = await backup_client.backup_index_get_without_preload_content(index_name)
+        response_data = json.loads(await raw.read())
 
-        if backup_response.data:
-            download_url = backup_response.data[0].url
+        if response_data.get("data"):
+            download_url = response_data["data"][0]["url"]
             file_path = f"{index_name}.zip"
 
             print(f"Downloading backup from {download_url}...")
@@ -314,6 +323,7 @@ if __name__ == "__main__":
 Download the backup for an index
 
 ```python
+import json
 import urllib.request
 import vulncheck_sdk
 import os
@@ -322,16 +332,19 @@ TOKEN = os.environ["VULNCHECK_API_TOKEN"]
 
 configuration = vulncheck_sdk.Configuration()
 configuration.api_key["Bearer"] = TOKEN
+configuration.ignore_operation_servers = True
 
 with vulncheck_sdk.ApiClient(configuration) as api_client:
-    endpoints_client = vulncheck_sdk.EndpointsApi(api_client)
+    backup_client = vulncheck_sdk.BackupApi(api_client)
 
     index = "initial-access"
 
-    api_response = endpoints_client.backup_index_get(index)
+    raw = backup_client.backup_index_get_without_preload_content(index)
+    response_data = json.loads(raw.read())
+    download_url = response_data["data"][0]["url"]
 
     file_path = f"{index}.zip"
-    with urllib.request.urlopen(api_response.data[0].url) as response:
+    with urllib.request.urlopen(download_url) as response:
         with open(file_path, "wb") as file:
             file.write(response.read())
 ```
@@ -341,6 +354,7 @@ with vulncheck_sdk.ApiClient(configuration) as api_client:
 
 ```python
 import asyncio
+import json
 import os
 import urllib.request
 import vulncheck_sdk.aio as vcaio
@@ -350,6 +364,7 @@ TOKEN = os.environ.get("VULNCHECK_API_TOKEN")
 
 configuration = vcaio.Configuration()
 configuration.api_key["Bearer"] = TOKEN
+configuration.ignore_operation_servers = True
 
 
 def download_sync(url, file_path):
@@ -365,23 +380,19 @@ def download_sync(url, file_path):
 async def main():
     # Use 'async with' to manage the connection life-cycle
     async with vcaio.ApiClient(configuration) as api_client:
-        endpoints_client = vcaio.EndpointsApi(api_client)
+        backup_client = vcaio.BackupApi(api_client)
         index = "initial-access"
 
-        # 'await' the coroutine to get the actual response data
-        api_response = await endpoints_client.backup_index_get(index)
-
-        if not api_response.data:
-            print("No backup URL found.")
-            return
+        # 'await' the coroutine to get the raw response bytes
+        raw = await backup_client.backup_index_get_without_preload_content(index)
+        response_data = json.loads(await raw.read())
+        download_url = response_data["data"][0]["url"]
 
-        download_url = api_response.data[0].url
         file_path = f"{index}.zip"
 
         print(f"Downloading {index} via urllib (offloaded to thread)...")
 
         # Use asyncio.to_thread to run the blocking call safely
-        # 'await' the coroutine to get the actual response data
         await asyncio.to_thread(download_sync, download_url, file_path)
 
         print(f"Successfully saved to {file_path}")

docs/AdvisoryASRG.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **problem_type** | **str** |  | [optional] 
 **references** | **List[str]** |  | [optional] 
 **title** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 
 ## Example

docs/AdvisoryApacheArrow.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **date_added** | **str** |  | [optional] 
 **summary** | **str** |  | [optional] 
 **title** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 
 ## Example

docs/AdvisoryApacheSuperset.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **cve** | **List[str]** |  | [optional] 
 **date_added** | **str** |  | [optional] 
 **title** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 
 ## Example

docs/AdvisoryCISAAlert.md

@@ -9,18 +9,17 @@ Name | Type | Description | Notes
 **affected_products** | **str** |  | [optional] 
 **alert_id** | **str** |  | [optional] 
 **archived** | **bool** |  | [optional] 
-**cve** | **List[str]** |  | [optional] 
-**cveexploited_itw** | **bool** |  | [optional] 
+**cve_exploited_itw** | **bool** |  | [optional] 
 **cvss** | **str** |  | [optional] 
-**date_added** | **str** |  | [optional] 
-**icsa** | **bool** |  | [optional] 
 **icsma** | **bool** |  | [optional] 
 **mitigations** | **str** |  | [optional] 
 **release_date** | **str** |  | [optional] 
 **title** | **str** |  | [optional] 
-**updated_at** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 **vendor** | **str** |  | [optional] 
+**cve** | **List[str]** |  | [optional] 
+**date_added** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 
 ## Example
 

docs/AdvisoryCustomCPE.md

@@ -0,0 +1,31 @@
+# AdvisoryCustomCPE
+
+advisory.CustomCPE
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mcpeapplicability** | [**AdvisoryMCPEApplicability**](AdvisoryMCPEApplicability.md) |  | [optional] 
+**string_value** | **str** |  | [optional] 
+
+## Example
+
+```python
+from vulncheck_sdk.models.advisory_custom_cpe import AdvisoryCustomCPE
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AdvisoryCustomCPE from a JSON string
+advisory_custom_cpe_instance = AdvisoryCustomCPE.from_json(json)
+# print the JSON string representation of the object
+print(AdvisoryCustomCPE.to_json())
+
+# convert the object into a dict
+advisory_custom_cpe_dict = advisory_custom_cpe_instance.to_dict()
+# create an instance of AdvisoryCustomCPE from a dict
+advisory_custom_cpe_from_dict = AdvisoryCustomCPE.from_dict(advisory_custom_cpe_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/AdvisoryFastly.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **date_added** | **str** |  | [optional] 
 **summary** | **str** |  | [optional] 
 **title** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 
 ## Example

docs/AdvisoryHaskellSADBAdvisory.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **keywords** | **List[str]** |  | [optional] 
 **references** | **Dict[str, List[str]]** |  | [optional] 
 **related_vulns** | **List[str]** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 
 ## Example
 

docs/AdvisoryMACert.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **risks_fr** | **str** |  | [optional] 
 **solution_fr** | **str** |  | [optional] 
 **title_fr** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
 **url** | **str** |  | [optional] 
 
 ## Example

docs/AdvisoryMCna.md

@@ -7,7 +7,7 @@ advisory.MCna
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **affected** | [**List[AdvisoryMAffected]**](AdvisoryMAffected.md) |  | [optional] 
-**cpe_applicability** | [**List[AdvisoryMCPEApplicability]**](AdvisoryMCPEApplicability.md) |  | [optional] 
+**cpe_applicability** | [**List[AdvisoryCustomCPE]**](AdvisoryCustomCPE.md) |  | [optional] 
 **credits** | [**List[AdvisoryCredit]**](AdvisoryCredit.md) |  | [optional] 
 **descriptions** | [**List[AdvisoryMDescriptions]**](AdvisoryMDescriptions.md) |  | [optional] 
 **impacts** | [**List[AdvisoryImpact]**](AdvisoryImpact.md) |  | [optional]