Update Python SDK (#100)

[bot](2025-12-03 20:23:10) 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]

.openapi-generator/FILES

@@ -261,6 +261,7 @@ docs/AdvisoryFortinetAdvisory.md
 docs/AdvisoryFortinetIPS.md
 docs/AdvisoryFoxit.md
 docs/AdvisoryFoxitAffected.md
+docs/AdvisoryFresenius.md
 docs/AdvisoryGCP.md
 docs/AdvisoryGEGas.md
 docs/AdvisoryGEHealthcareAdvisory.md
@@ -1014,6 +1015,7 @@ docs/RenderResponseWithMetadataArrayAdvisoryForgeRockPaginatePagination.md
 docs/RenderResponseWithMetadataArrayAdvisoryFortinetAdvisoryPaginatePagination.md
 docs/RenderResponseWithMetadataArrayAdvisoryFortinetIPSPaginatePagination.md
 docs/RenderResponseWithMetadataArrayAdvisoryFoxitPaginatePagination.md
+docs/RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination.md
 docs/RenderResponseWithMetadataArrayAdvisoryGCPPaginatePagination.md
 docs/RenderResponseWithMetadataArrayAdvisoryGEGasPaginatePagination.md
 docs/RenderResponseWithMetadataArrayAdvisoryGEHealthcareAdvisoryPaginatePagination.md
@@ -1582,6 +1584,7 @@ test/test_advisory_fortinet_advisory.py
 test/test_advisory_fortinet_ips.py
 test/test_advisory_foxit.py
 test/test_advisory_foxit_affected.py
+test/test_advisory_fresenius.py
 test/test_advisory_gallagher.py
 test/test_advisory_gcp.py
 test/test_advisory_ge_gas.py
@@ -2335,6 +2338,7 @@ test/test_render_response_with_metadata_array_advisory_forge_rock_paginate_pagin
 test/test_render_response_with_metadata_array_advisory_fortinet_advisory_paginate_pagination.py
 test/test_render_response_with_metadata_array_advisory_fortinet_ips_paginate_pagination.py
 test/test_render_response_with_metadata_array_advisory_foxit_paginate_pagination.py
+test/test_render_response_with_metadata_array_advisory_fresenius_paginate_pagination.py
 test/test_render_response_with_metadata_array_advisory_gallagher_paginate_pagination.py
 test/test_render_response_with_metadata_array_advisory_gcp_paginate_pagination.py
 test/test_render_response_with_metadata_array_advisory_ge_gas_paginate_pagination.py
@@ -2906,6 +2910,7 @@ vulncheck_sdk/models/advisory_fortinet_advisory.py
 vulncheck_sdk/models/advisory_fortinet_ips.py
 vulncheck_sdk/models/advisory_foxit.py
 vulncheck_sdk/models/advisory_foxit_affected.py
+vulncheck_sdk/models/advisory_fresenius.py
 vulncheck_sdk/models/advisory_gallagher.py
 vulncheck_sdk/models/advisory_gcp.py
 vulncheck_sdk/models/advisory_ge_gas.py
@@ -3657,6 +3662,7 @@ vulncheck_sdk/models/render_response_with_metadata_array_advisory_forge_rock_pag
 vulncheck_sdk/models/render_response_with_metadata_array_advisory_fortinet_advisory_paginate_pagination.py
 vulncheck_sdk/models/render_response_with_metadata_array_advisory_fortinet_ips_paginate_pagination.py
 vulncheck_sdk/models/render_response_with_metadata_array_advisory_foxit_paginate_pagination.py
+vulncheck_sdk/models/render_response_with_metadata_array_advisory_fresenius_paginate_pagination.py
 vulncheck_sdk/models/render_response_with_metadata_array_advisory_gallagher_paginate_pagination.py
 vulncheck_sdk/models/render_response_with_metadata_array_advisory_gcp_paginate_pagination.py
 vulncheck_sdk/models/render_response_with_metadata_array_advisory_ge_gas_paginate_pagination.py

docs/AdvisoryFresenius.md

@@ -0,0 +1,37 @@
+# AdvisoryFresenius
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cve** | **List[str]** |  | [optional] 
+**date_added** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**mitigation** | **str** |  | [optional] 
+**references** | **List[str]** |  | [optional] 
+**summary** | **str** |  | [optional] 
+**title** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
+**url** | **str** |  | [optional] 
+
+## Example
+
+```python
+from vulncheck_sdk.models.advisory_fresenius import AdvisoryFresenius
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AdvisoryFresenius from a JSON string
+advisory_fresenius_instance = AdvisoryFresenius.from_json(json)
+# print the JSON string representation of the object
+print(AdvisoryFresenius.to_json())
+
+# convert the object into a dict
+advisory_fresenius_dict = advisory_fresenius_instance.to_dict()
+# create an instance of AdvisoryFresenius from a dict
+advisory_fresenius_from_dict = AdvisoryFresenius.from_dict(advisory_fresenius_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/IndicesApi.md

@@ -182,6 +182,7 @@ Method | HTTP request | Description
 [**index_fortinet_ips_get**](IndicesApi.md#index_fortinet_ips_get) | **GET** /index/fortinet-ips | Return vulnerability data stored in index \"fortinet-ips\"
 [**index_foxit_get**](IndicesApi.md#index_foxit_get) | **GET** /index/foxit | Return vulnerability data stored in index \"foxit\"
 [**index_freebsd_get**](IndicesApi.md#index_freebsd_get) | **GET** /index/freebsd | Return vulnerability data stored in index \"freebsd\"
+[**index_fresenius_get**](IndicesApi.md#index_fresenius_get) | **GET** /index/fresenius | Return vulnerability data stored in index \"fresenius\"
 [**index_gallagher_get**](IndicesApi.md#index_gallagher_get) | **GET** /index/gallagher | Return vulnerability data stored in index \"gallagher\"
 [**index_gcp_get**](IndicesApi.md#index_gcp_get) | **GET** /index/gcp | Return vulnerability data stored in index \"gcp\"
 [**index_ge_gas_get**](IndicesApi.md#index_ge_gas_get) | **GET** /index/ge-gas | Return vulnerability data stored in index \"ge-gas\"
@@ -24696,6 +24697,142 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **index_fresenius_get**
+> RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination index_fresenius_get(page=page, limit=limit, cursor=cursor, start_cursor=start_cursor, cve=cve, alias=alias, iava=iava, jvndb=jvndb, ilvn=ilvn, threat_actor=threat_actor, mitre_id=mitre_id, misp_id=misp_id, ransomware=ransomware, botnet=botnet, published=published, var_date=var_date, var_date2=var_date2, updated_at_start_date=updated_at_start_date, updated_at_end_date=updated_at_end_date, last_mod_start_date=last_mod_start_date, last_mod_end_date=last_mod_end_date, pub_start_date=pub_start_date, pub_end_date=pub_end_date)
+
+Return vulnerability data stored in index \"fresenius\"
+
+### Overview
+This endpoint allows you to retrieve a paginated list of all documents from the fresenius index. \
+By default, a maximum of 100 documents are shown per page.
+
+**Index Description:** Fresenius Security Advisories
+
+### Paging Over Large Data (cursor)
+In order to allow users to iterate over large index datasets, this endpoint provides a server-side
+"cursor" mechanism. To use the cursor, first call `GET /index/fresenius?start_cursor`, the response will
+have a `next_cursor` id that clients will need to pass as a query parameter to the next request like
+`GET /index/fresenius?cursor=<next_cursor_id>`
+
+
+### Example
+
+* Api Key Authentication (Bearer):
+
+```python
+import vulncheck_sdk
+from vulncheck_sdk.models.render_response_with_metadata_array_advisory_fresenius_paginate_pagination import RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination
+from vulncheck_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /v3
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vulncheck_sdk.Configuration(
+    host = "/v3"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: Bearer
+configuration.api_key['Bearer'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['Bearer'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with vulncheck_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vulncheck_sdk.IndicesApi(api_client)
+    page = 56 # int | set the page number of the response (optional)
+    limit = 56 # int | limit the number of findings in the response (optional)
+    cursor = 'cursor_example' # str | continue server-side paging using a cursor id (optional)
+    start_cursor = 'start_cursor_example' # str | request server-side paging (optional)
+    cve = 'cve_example' # str | Specify a CVE ID to search with. (optional)
+    alias = 'alias_example' # str | Specify a vulnerability alias to search with. (optional)
+    iava = 'iava_example' # str | Specify an IAVA ID to search with. (optional)
+    jvndb = 'jvndb_example' # str | Specify a JVNDB ID to search with. (optional)
+    ilvn = 'ilvn_example' # str | Specify an ILVN ID to search with. (optional)
+    threat_actor = 'threat_actor_example' # str | Specify a threat actor name to search with. (optional)
+    mitre_id = 'mitre_id_example' # str | Specify a MITRE ID to search with. (optional)
+    misp_id = 'misp_id_example' # str | Specify a MISP ID to search with. (optional)
+    ransomware = 'ransomware_example' # str | Specify a ransomeware family name to search with. (optional)
+    botnet = 'botnet_example' # str | Specify a botnet name to search with. (optional)
+    published = 'published_example' # str | Specify a published date (optional)
+    var_date = 'var_date_example' # str | Specify a starting published date to filter with. (optional)
+    var_date2 = 'var_date_example' # str | Specify an ending published date to filter with. (optional)
+    updated_at_start_date = 'updated_at_start_date_example' # str | Specify a starting 'updated-at' date to filter with. (optional)
+    updated_at_end_date = 'updated_at_end_date_example' # str | Specify an ending 'updated-at' date to filter with. (optional)
+    last_mod_start_date = 'last_mod_start_date_example' # str | Specify a starting last modified date to filter with. (optional)
+    last_mod_end_date = 'last_mod_end_date_example' # str | Specify an ending last modified date to filter with. (optional)
+    pub_start_date = 'pub_start_date_example' # str | Specify a starting published date to filter with. (optional)
+    pub_end_date = 'pub_end_date_example' # str | Specify an ending published date to filter with. (optional)
+
+    try:
+        # Return vulnerability data stored in index \"fresenius\"
+        api_response = api_instance.index_fresenius_get(page=page, limit=limit, cursor=cursor, start_cursor=start_cursor, cve=cve, alias=alias, iava=iava, jvndb=jvndb, ilvn=ilvn, threat_actor=threat_actor, mitre_id=mitre_id, misp_id=misp_id, ransomware=ransomware, botnet=botnet, published=published, var_date=var_date, var_date2=var_date2, updated_at_start_date=updated_at_start_date, updated_at_end_date=updated_at_end_date, last_mod_start_date=last_mod_start_date, last_mod_end_date=last_mod_end_date, pub_start_date=pub_start_date, pub_end_date=pub_end_date)
+        print("The response of IndicesApi->index_fresenius_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling IndicesApi->index_fresenius_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **int**| set the page number of the response | [optional] 
+ **limit** | **int**| limit the number of findings in the response | [optional] 
+ **cursor** | **str**| continue server-side paging using a cursor id | [optional] 
+ **start_cursor** | **str**| request server-side paging | [optional] 
+ **cve** | **str**| Specify a CVE ID to search with. | [optional] 
+ **alias** | **str**| Specify a vulnerability alias to search with. | [optional] 
+ **iava** | **str**| Specify an IAVA ID to search with. | [optional] 
+ **jvndb** | **str**| Specify a JVNDB ID to search with. | [optional] 
+ **ilvn** | **str**| Specify an ILVN ID to search with. | [optional] 
+ **threat_actor** | **str**| Specify a threat actor name to search with. | [optional] 
+ **mitre_id** | **str**| Specify a MITRE ID to search with. | [optional] 
+ **misp_id** | **str**| Specify a MISP ID to search with. | [optional] 
+ **ransomware** | **str**| Specify a ransomeware family name to search with. | [optional] 
+ **botnet** | **str**| Specify a botnet name to search with. | [optional] 
+ **published** | **str**| Specify a published date | [optional] 
+ **var_date** | **str**| Specify a starting published date to filter with. | [optional] 
+ **var_date2** | **str**| Specify an ending published date to filter with. | [optional] 
+ **updated_at_start_date** | **str**| Specify a starting &#39;updated-at&#39; date to filter with. | [optional] 
+ **updated_at_end_date** | **str**| Specify an ending &#39;updated-at&#39; date to filter with. | [optional] 
+ **last_mod_start_date** | **str**| Specify a starting last modified date to filter with. | [optional] 
+ **last_mod_end_date** | **str**| Specify an ending last modified date to filter with. | [optional] 
+ **pub_start_date** | **str**| Specify a starting published date to filter with. | [optional] 
+ **pub_end_date** | **str**| Specify an ending published date to filter with. | [optional] 
+
+### Return type
+
+[**RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination**](RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**404** | Not Found |  -  |
+**500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **index_gallagher_get**
 > RenderResponseWithMetadataArrayAdvisoryGallagherPaginatePagination index_gallagher_get(page=page, limit=limit, cursor=cursor, start_cursor=start_cursor, cve=cve, alias=alias, iava=iava, jvndb=jvndb, ilvn=ilvn, threat_actor=threat_actor, mitre_id=mitre_id, misp_id=misp_id, ransomware=ransomware, botnet=botnet, published=published, var_date=var_date, var_date2=var_date2, updated_at_start_date=updated_at_start_date, updated_at_end_date=updated_at_end_date, last_mod_start_date=last_mod_start_date, last_mod_end_date=last_mod_end_date, pub_start_date=pub_start_date, pub_end_date=pub_end_date)
 

docs/RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination.md

@@ -0,0 +1,31 @@
+# RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**benchmark** | **float** |  | [optional] 
+**meta** | [**PaginatePagination**](PaginatePagination.md) |  | [optional] 
+**data** | [**List[AdvisoryFresenius]**](AdvisoryFresenius.md) |  | [optional] 
+
+## Example
+
+```python
+from vulncheck_sdk.models.render_response_with_metadata_array_advisory_fresenius_paginate_pagination import RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination from a JSON string
+render_response_with_metadata_array_advisory_fresenius_paginate_pagination_instance = RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination.from_json(json)
+# print the JSON string representation of the object
+print(RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination.to_json())
+
+# convert the object into a dict
+render_response_with_metadata_array_advisory_fresenius_paginate_pagination_dict = render_response_with_metadata_array_advisory_fresenius_paginate_pagination_instance.to_dict()
+# create an instance of RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination from a dict
+render_response_with_metadata_array_advisory_fresenius_paginate_pagination_from_dict = RenderResponseWithMetadataArrayAdvisoryFreseniusPaginatePagination.from_dict(render_response_with_metadata_array_advisory_fresenius_paginate_pagination_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)
+
+

openapi.json

@@ -1,6 +1,6 @@
 [project]
 name = "vulncheck_sdk"
-version = "0.0.33"
+version = "0.0.34"
 description = "VulnCheck API"
 authors = [
   {name = "VulnCheck API Support",email = "support@vulncheck.com"},

pyproject.toml

@@ -2,4 +2,4 @@ additionalProperties:
   projectName: "vulncheck-sdk"
   packageName: "vulncheck_sdk"
   packageUrl: "https://github.com/vulncheck-oss/sdk-python/tree/main"
-  packageVersion: "0.0.33"
+  packageVersion: "0.0.34"

python-generator-config.yaml

@@ -22,7 +22,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "vulncheck-sdk"
-VERSION = "0.0.33"
+VERSION = "0.0.34"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

setup.py

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+"""
+    VulnCheck API
+
+    Version 3 of the VulnCheck API
+
+    The version of the OpenAPI document: 3.0
+    Contact: support@vulncheck.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from vulncheck_sdk.models.advisory_fresenius import AdvisoryFresenius
+
+class TestAdvisoryFresenius(unittest.TestCase):
+    """AdvisoryFresenius unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AdvisoryFresenius:
+        """Test AdvisoryFresenius
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `AdvisoryFresenius`
+        """
+        model = AdvisoryFresenius()
+        if include_optional:
+            return AdvisoryFresenius(
+                cve = [
+                    ''
+                    ],
+                date_added = '',
+                description = '',
+                mitigation = '',
+                references = [
+                    ''
+                    ],
+                summary = '',
+                title = '',
+                updated_at = '',
+                url = ''
+            )
+        else:
+            return AdvisoryFresenius(
+        )
+        """
+
+    def testAdvisoryFresenius(self):
+        """Test AdvisoryFresenius"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

test/test_advisory_fresenius.py

@@ -1273,6 +1273,13 @@ def test_index_freebsd_get(self) -> None:
         """
         pass
 
+    def test_index_fresenius_get(self) -> None:
+        """Test case for index_fresenius_get
+
+        Return vulnerability data stored in index \"fresenius\"
+        """
+        pass
+
     def test_index_gallagher_get(self) -> None:
         """Test case for index_gallagher_get