[GitHub Bot] Generated python SDK (#67)

Co-authored-by: API Team <api-team@thousandeyes.com>
thousandeyes · Oct 2, 2024 · 8d0c01b · 8d0c01b
1 parent ffa07ce
commit 8d0c01b
Show file tree

Hide file tree

Showing 51 changed files with 925 additions and 155 deletions.
diff --git a/thousandeyes-sdk-administrative/README.md b/thousandeyes-sdk-administrative/README.md
@@ -12,7 +12,7 @@ This API provides the following operations to manage your organization:
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-agents/README.md b/thousandeyes-sdk-agents/README.md
@@ -5,7 +5,7 @@ Manage all agents available to your account in ThousandEyes, including both Clou
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-alerts/README.md b/thousandeyes-sdk-alerts/README.md
@@ -12,7 +12,7 @@ For more information about the alerts, see [Alerts](https://docs.thousandeyes.co
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-bgp-monitors/README.md b/thousandeyes-sdk-bgp-monitors/README.md
@@ -9,7 +9,7 @@ For more information about monitors, see [Inside-Out BGP Visibility](https://doc
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-credentials/README.md b/thousandeyes-sdk-credentials/README.md
@@ -13,7 +13,7 @@ For more information about credentials, see [Working With Secure Credentials](ht
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-dashboards/README.md b/thousandeyes-sdk-dashboards/README.md
@@ -3,7 +3,7 @@ Manage ThousandEyes Dashboards.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-emulation/README.md b/thousandeyes-sdk-emulation/README.md
@@ -9,7 +9,7 @@ To access Emulation API operations, the following permissions are required:
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-endpoint-agents/README.md b/thousandeyes-sdk-endpoint-agents/README.md
@@ -5,7 +5,7 @@ For more information about Endpoint Agents, see [Endpoint Agents](https://docs.t
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-endpoint-instant-tests/README.md b/thousandeyes-sdk-endpoint-instant-tests/README.md
@@ -13,7 +13,7 @@ The URLs for these API test data endpoints are provided within the test definiti
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/...sandeyes-sdk-endpoint-instant-tests/docs/RunEndpointInstantScheduledTestsApi.md b/...sandeyes-sdk-endpoint-instant-tests/docs/RunEndpointInstantScheduledTestsApi.md
@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **run_endpoint_scheduled_instant_test**
-> run_endpoint_scheduled_instant_test(test_id, aid=aid)
+> EndpointRunScheduledInstantTestResult run_endpoint_scheduled_instant_test(test_id, aid=aid)
 
 Run endpoint instant scheduled test
 
@@ -20,6 +20,7 @@ Runs an existing endpoint instant scheduled test in ThousandEyes.
 
 ```python
 import thousandeyes_sdk.endpoint_instant_tests
+from thousandeyes_sdk.endpoint_instant_tests.models.endpoint_run_scheduled_instant_test_result import EndpointRunScheduledInstantTestResult
 from thousandeyes_sdk.endpoint_instant_tests.rest import ApiException
 from pprint import pprint
 
@@ -48,7 +49,9 @@ with thousandeyes_sdk.endpoint_instant_tests.ApiClient(configuration) as api_cli
 
     try:
         # Run endpoint instant scheduled test
-        api_instance.run_endpoint_scheduled_instant_test(test_id, aid=aid)
+        api_response = api_instance.run_endpoint_scheduled_instant_test(test_id, aid=aid)
+        print("The response of RunEndpointInstantScheduledTestsApi->run_endpoint_scheduled_instant_test:\n")
+        pprint(api_response)
     except Exception as e:
         print("Exception when calling RunEndpointInstantScheduledTestsApi->run_endpoint_scheduled_instant_test: %s\n" % e)
 ```
@@ -65,7 +68,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-void (empty response body)
+[**EndpointRunScheduledInstantTestResult**](EndpointRunScheduledInstantTestResult.md)
 
 ### Authorization
 

diff --git a/...c/thousandeyes_sdk/endpoint_instant_tests/api/run_endpoint_instant_scheduled_tests_api.py b/...c/thousandeyes_sdk/endpoint_instant_tests/api/run_endpoint_instant_scheduled_tests_api.py
@@ -21,6 +21,7 @@
 from pydantic import Field, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
+from thousandeyes_sdk.endpoint_instant_tests.models.endpoint_run_scheduled_instant_test_result import EndpointRunScheduledInstantTestResult
 
 from thousandeyes_sdk.core.api_client import ApiClient, RequestSerialized
 from thousandeyes_sdk.core.api_response import ApiResponse
@@ -58,7 +59,7 @@ def run_endpoint_scheduled_instant_test(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> None:
+    ) -> EndpointRunScheduledInstantTestResult:
         """Run endpoint instant scheduled test
 
         Runs an existing endpoint instant scheduled test in ThousandEyes.
@@ -99,7 +100,7 @@ def run_endpoint_scheduled_instant_test(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "EndpointRunScheduledInstantTestResult",
             '400': "ValidationError",
             '401': "UnauthorizedError",
             '403': "Error",
@@ -137,7 +138,7 @@ def run_endpoint_scheduled_instant_test_with_http_info(
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[None]:
+    ) -> ApiResponse[EndpointRunScheduledInstantTestResult]:
         """Run endpoint instant scheduled test
 
         Runs an existing endpoint instant scheduled test in ThousandEyes.
@@ -178,7 +179,7 @@ def run_endpoint_scheduled_instant_test_with_http_info(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "EndpointRunScheduledInstantTestResult",
             '400': "ValidationError",
             '401': "UnauthorizedError",
             '403': "Error",
@@ -257,7 +258,7 @@ def run_endpoint_scheduled_instant_test_without_preload_content(
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "EndpointRunScheduledInstantTestResult",
             '400': "ValidationError",
             '401': "UnauthorizedError",
             '403': "Error",

diff --git a/...sandeyes-sdk-endpoint-instant-tests/test/test_run_endpoint_instant_scheduled_tests_api.py b/...sandeyes-sdk-endpoint-instant-tests/test/test_run_endpoint_instant_scheduled_tests_api.py
@@ -31,6 +31,14 @@ def tearDown(self) -> None:
     def test_run_endpoint_scheduled_instant_test_models_validation(self) -> None:
         """Test case for run_endpoint_scheduled_instant_test request and response models"""
 
+        response_body_json = """
+                {
+                  "message" : "Successfully reran the instant scheduled test with testId=765231567"
+                }"""
+
+        response_loaded_json = json.loads(response_body_json)
+        response_from_json = thousandeyes_sdk.endpoint_instant_tests.models.EndpointRunScheduledInstantTestResult.from_json(response_body_json)
+        assert_constructed_model_matches_example_json(response_from_json, response_loaded_json)
 
 
 if __name__ == '__main__':

diff --git a/thousandeyes-sdk-endpoint-labels/README.md b/thousandeyes-sdk-endpoint-labels/README.md
@@ -4,7 +4,7 @@ Manage labels applied to endpoint agents using this API.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-endpoint-test-results/README.md b/thousandeyes-sdk-endpoint-test-results/README.md
@@ -3,7 +3,7 @@ Retrieve results for scheduled and dynamic tests on endpoint agents.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-endpoint-test-results/test/test_real_user_endpoint_test_results_api.py b/thousandeyes-sdk-endpoint-test-results/test/test_real_user_endpoint_test_results_api.py
@@ -380,11 +380,11 @@ def test_get_real_user_test_page_results_models_validation(self) -> None:
                     "log" : {
                       "browser" : {
                         "name" : "Google Chrome",
-                        "version" : "7.0.20.98"
+                        "version" : "7.0.21.98"
                       },
                       "creator" : {
                         "name" : "ThousandEyes Endpoint Agent",
-                        "version" : "7.0.20"
+                        "version" : "7.0.21"
                       },
                       "entries" : [ {
                         "pageref" : "page_1",

diff --git a/thousandeyes-sdk-endpoint-tests/README.md b/thousandeyes-sdk-endpoint-tests/README.md
@@ -5,7 +5,7 @@ Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-event-detection/README.md b/thousandeyes-sdk-event-detection/README.md
@@ -12,7 +12,7 @@ With the Events API, you can perform the following tasks on the ThousandEyes pla
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-instant-tests/README.md b/thousandeyes-sdk-instant-tests/README.md
@@ -8,7 +8,7 @@ The response does not include the immediate test results. Use the Test Results e
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-internet-insights/README.md b/thousandeyes-sdk-internet-insights/README.md
@@ -14,7 +14,7 @@ For more information about Internet Insights, see the [Internet Insights](https:
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-snapshots/README.md b/thousandeyes-sdk-snapshots/README.md
@@ -3,7 +3,7 @@ Creates a new test snapshot in ThousandEyes.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 

diff --git a/thousandeyes-sdk-streaming/.openapi-generator/FILES b/thousandeyes-sdk-streaming/.openapi-generator/FILES
@@ -11,6 +11,8 @@ docs/DataModelVersion.md
 docs/EndpointType.md
 docs/ExporterConfig.md
 docs/ExporterConfigSplunkHec.md
+docs/Filters.md
+docs/FiltersTestTypes.md
 docs/GetStreamResponse.md
 docs/PutStream.md
 docs/Stream.md
@@ -23,6 +25,7 @@ docs/TagMatch.md
 docs/TagMatchObjectType.md
 docs/TestMatch.md
 docs/TestMatchDomain.md
+docs/TestType.md
 docs/UnauthorizedError.md
 pyproject.toml
 setup.cfg
@@ -40,6 +43,8 @@ src/thousandeyes_sdk/streaming/models/data_model_version.py
 src/thousandeyes_sdk/streaming/models/endpoint_type.py
 src/thousandeyes_sdk/streaming/models/exporter_config.py
 src/thousandeyes_sdk/streaming/models/exporter_config_splunk_hec.py
+src/thousandeyes_sdk/streaming/models/filters.py
+src/thousandeyes_sdk/streaming/models/filters_test_types.py
 src/thousandeyes_sdk/streaming/models/get_stream_response.py
 src/thousandeyes_sdk/streaming/models/put_stream.py
 src/thousandeyes_sdk/streaming/models/stream.py
@@ -51,6 +56,7 @@ src/thousandeyes_sdk/streaming/models/tag_match.py
 src/thousandeyes_sdk/streaming/models/tag_match_object_type.py
 src/thousandeyes_sdk/streaming/models/test_match.py
 src/thousandeyes_sdk/streaming/models/test_match_domain.py
+src/thousandeyes_sdk/streaming/models/test_type.py
 src/thousandeyes_sdk/streaming/models/unauthorized_error.py
 src/thousandeyes_sdk/streaming/py.typed
 test/__init__.py

diff --git a/thousandeyes-sdk-streaming/README.md b/thousandeyes-sdk-streaming/README.md
@@ -15,7 +15,7 @@ For more information about ThousandEyes for OpenTelemetry, see the [documentatio
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 7.0.20
+- API version: 7.0.21
 - Generator version: 7.6.0
 - Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
 
@@ -126,6 +126,8 @@ Class | Method | HTTP request | Description
  - [EndpointType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/EndpointType.md)
  - [ExporterConfig](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/ExporterConfig.md)
  - [ExporterConfigSplunkHec](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/ExporterConfigSplunkHec.md)
+ - [Filters](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/Filters.md)
+ - [FiltersTestTypes](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/FiltersTestTypes.md)
  - [GetStreamResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/GetStreamResponse.md)
  - [PutStream](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/PutStream.md)
  - [Stream](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/Stream.md)
@@ -137,6 +139,7 @@ Class | Method | HTTP request | Description
  - [TagMatchObjectType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/TagMatchObjectType.md)
  - [TestMatch](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/TestMatch.md)
  - [TestMatchDomain](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/TestMatchDomain.md)
+ - [TestType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/TestType.md)
  - [UnauthorizedError](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/UnauthorizedError.md)
 
 

diff --git a/thousandeyes-sdk-streaming/docs/CreateStreamResponse.md b/thousandeyes-sdk-streaming/docs/CreateStreamResponse.md
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **custom_headers** | **Dict[str, str]** | Custom headers. **Note**: When using the &#x60;splunk-hec&#x60; &#x60;type&#x60;, the &#x60;customHeaders&#x60; must contain just one element with the key &#x60;token&#x60; and the value of the *Splunk HEC Token*. | [optional] 
 **tag_match** | [**List[TagMatch]**](TagMatch.md) | A collection of tags that determine what tests are included in the data stream. These tag values are also included as attributes in the data stream metrics. | [optional] 
 **test_match** | [**List[TestMatch]**](TestMatch.md) | A collection of tests to be included in the data stream. | [optional] 
+**filters** | [**Filters**](Filters.md) |  | [optional] 
 **exporter_config** | [**ExporterConfig**](ExporterConfig.md) |  | [optional] 
 **audit_operation** | [**AuditOperation**](AuditOperation.md) |  | [optional] 
 

diff --git a/thousandeyes-sdk-streaming/docs/Filters.md b/thousandeyes-sdk-streaming/docs/Filters.md
@@ -0,0 +1,30 @@
+# Filters
+
+Provides the ability to filter data points based on the specified test types.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test_types** | [**FiltersTestTypes**](FiltersTestTypes.md) |  | [optional] 
+
+## Example
+
+```python
+from thousandeyes_sdk.streaming.models.filters import Filters
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Filters from a JSON string
+filters_instance = Filters.from_json(json)
+# print the JSON string representation of the object
+print(Filters.to_json())
+
+# convert the object into a dict
+filters_dict = filters_instance.to_dict()
+# create an instance of Filters from a dict
+filters_from_dict = Filters.from_dict(filters_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)
+
+
diff --git a/thousandeyes-sdk-streaming/docs/FiltersTestTypes.md b/thousandeyes-sdk-streaming/docs/FiltersTestTypes.md
@@ -0,0 +1,30 @@
+# FiltersTestTypes
+
+Test types that can be used for filtering data points.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | [**List[TestType]**](TestType.md) | A list of test types to filter data points. | [optional] 
+
+## Example
+
+```python
+from thousandeyes_sdk.streaming.models.filters_test_types import FiltersTestTypes
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FiltersTestTypes from a JSON string
+filters_test_types_instance = FiltersTestTypes.from_json(json)
+# print the JSON string representation of the object
+print(FiltersTestTypes.to_json())
+
+# convert the object into a dict
+filters_test_types_dict = filters_test_types_instance.to_dict()
+# create an instance of FiltersTestTypes from a dict
+filters_test_types_from_dict = FiltersTestTypes.from_dict(filters_test_types_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)
+
+