gitea-admin/thousandeyes-sdk-python
1
0
Fork 0
mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 06:26:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[GitHub Bot] Generated python SDK

Browse Source
This commit is contained in:
API Team 2024-10-08 15:15:43 +00:00
parent 71cf7d5a51
commit 092ea613d1
26 changed files with 55 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
thousandeyes-sdk-administrative/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-agents/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-alerts/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

6
thousandeyes-sdk-alerts/docs/AlertsApi.md
View File

@ -94,7 +94,7 @@ 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)
# **get_alerts**
> Alerts get_alerts(aid=aid, window=window, start_date=start_date, end_date=end_date, max=max, state=state)
> Alerts get_alerts(aid=aid, window=window, start_date=start_date, end_date=end_date, max=max, cursor=cursor, state=state)
List active alerts
@ -135,11 +135,12 @@ with thousandeyes_sdk.alerts.ApiClient(configuration) as api_client:
start_date = '2022-07-17T22:00:54Z' # datetime | Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
end_date = '2022-07-18T22:00:54Z' # datetime | Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
max = 5 # int | (Optional) Maximum number of objects to return. (optional)
cursor = 'cursor_example' # str | (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter. (optional)
state = thousandeyes_sdk.alerts.State() # State | Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`. (optional)
try:
# List active alerts
api_response = api_instance.get_alerts(aid=aid, window=window, start_date=start_date, end_date=end_date, max=max, state=state)
api_response = api_instance.get_alerts(aid=aid, window=window, start_date=start_date, end_date=end_date, max=max, cursor=cursor, state=state)
print("The response of AlertsApi->get_alerts:\n")
pprint(api_response)
except Exception as e:
@ -158,6 +159,7 @@ Name | Type | Description | Notes
**start_date** | **datetime**| Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. | [optional]
**end_date** | **datetime**| Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. | [optional]
**max** | **int**| (Optional) Maximum number of objects to return. | [optional]
**cursor** | **str**| (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter. | [optional]
**state** | [**State**](.md)| Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`. | [optional]
### Return type

17
thousandeyes-sdk-alerts/src/thousandeyes_sdk/alerts/api/alerts_api.py
View File

@ -346,6 +346,7 @@ class AlertsApi:
start_date: Annotated[Optional[datetime], Field(description="Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.")] = None,
end_date: Annotated[Optional[datetime], Field(description="Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.")] = None,
max: Annotated[Optional[StrictInt], Field(description="(Optional) Maximum number of objects to return.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.")] = None,
state: Annotated[Optional[Any], Field(description="Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`.")] = None,
_request_timeout: Union[
None,
@ -374,6 +375,8 @@ class AlertsApi:
:type end_date: datetime
:param max: (Optional) Maximum number of objects to return.
:type max: int
:param cursor: (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.
:type cursor: str
:param state: Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`.
:type state: State
:param _request_timeout: timeout setting for this request. If one
@ -404,6 +407,7 @@ class AlertsApi:
start_date=start_date,
end_date=end_date,
max=max,
cursor=cursor,
state=state,
_request_auth=_request_auth,
_content_type=_content_type,
@ -439,6 +443,7 @@ class AlertsApi:
start_date: Annotated[Optional[datetime], Field(description="Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.")] = None,
end_date: Annotated[Optional[datetime], Field(description="Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.")] = None,
max: Annotated[Optional[StrictInt], Field(description="(Optional) Maximum number of objects to return.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.")] = None,
state: Annotated[Optional[Any], Field(description="Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`.")] = None,
_request_timeout: Union[
None,
@ -467,6 +472,8 @@ class AlertsApi:
:type end_date: datetime
:param max: (Optional) Maximum number of objects to return.
:type max: int
:param cursor: (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.
:type cursor: str
:param state: Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`.
:type state: State
:param _request_timeout: timeout setting for this request. If one
@ -497,6 +504,7 @@ class AlertsApi:
start_date=start_date,
end_date=end_date,
max=max,
cursor=cursor,
state=state,
_request_auth=_request_auth,
_content_type=_content_type,
@ -532,6 +540,7 @@ class AlertsApi:
start_date: Annotated[Optional[datetime], Field(description="Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.")] = None,
end_date: Annotated[Optional[datetime], Field(description="Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.")] = None,
max: Annotated[Optional[StrictInt], Field(description="(Optional) Maximum number of objects to return.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.")] = None,
state: Annotated[Optional[Any], Field(description="Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`.")] = None,
_request_timeout: Union[
None,
@ -560,6 +569,8 @@ class AlertsApi:
:type end_date: datetime
:param max: (Optional) Maximum number of objects to return.
:type max: int
:param cursor: (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.
:type cursor: str
:param state: Optional parameter to match a specific alert state. If not specified, it defaults to `trigger`.
:type state: State
:param _request_timeout: timeout setting for this request. If one
@ -590,6 +601,7 @@ class AlertsApi:
start_date=start_date,
end_date=end_date,
max=max,
cursor=cursor,
state=state,
_request_auth=_request_auth,
_content_type=_content_type,
@ -619,6 +631,7 @@ class AlertsApi:
start_date,
end_date,
max,
cursor,
state,
_request_auth,
_content_type,
@ -678,6 +691,10 @@ class AlertsApi:
_query_params.append(('max', max))
if cursor is not None:
_query_params.append(('cursor', cursor))
if state is not None:
_query_params.append(('state', state))

1
thousandeyes-sdk-alerts/src/thousandeyes_sdk/alerts/models/third_party_integration_type.py
View File

@ -28,6 +28,7 @@ class ThirdPartyIntegrationType(str, Enum):
PAGER_MINUS_DUTY = 'pager-duty'
SLACK = 'slack'
APP_MINUS_DYNAMICS = 'app-dynamics'
SERVICE_MINUS_NOW = 'service-now'
UNKNOWN = 'unknown'
@classmethod

20
thousandeyes-sdk-alerts/test/test_alert_rules_api.py
View File

@ -69,12 +69,12 @@ class TestAlertRulesApi(unittest.TestCase):
"customWebhook" : [ {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
}, {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
} ]
},
@ -136,12 +136,12 @@ class TestAlertRulesApi(unittest.TestCase):
"customWebhook" : [ {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
}, {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
} ]
},
@ -272,12 +272,12 @@ class TestAlertRulesApi(unittest.TestCase):
"customWebhook" : [ {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
}, {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
} ]
},
@ -385,12 +385,12 @@ class TestAlertRulesApi(unittest.TestCase):
"customWebhook" : [ {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
}, {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
} ]
},
@ -452,12 +452,12 @@ class TestAlertRulesApi(unittest.TestCase):
"customWebhook" : [ {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
}, {
"integrationType" : "custom-webhook",
"integrationName" : "My webhook",
"integrationId" : "cwb-201",
"integrationId" : "6e069ae9-8537-4120-b988-61bf8e0d8b87",
"target" : "https://example.com/test/webhooks/notifications"
} ]
},

2
thousandeyes-sdk-bgp-monitors/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-credentials/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-dashboards/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-emulation/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-endpoint-agents/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-endpoint-instant-tests/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-endpoint-labels/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-endpoint-test-results/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

4
thousandeyes-sdk-endpoint-test-results/test/test_real_user_endpoint_test_results_api.py
View File

@ -380,11 +380,11 @@ class TestRealUserEndpointTestResultsApi(unittest.TestCase):
"log" : {
"browser" : {
"name" : "Google Chrome",
"version" : "7.0.22.98"
"version" : "7.0.25.98"
},
"creator" : {
"name" : "ThousandEyes Endpoint Agent",
"version" : "7.0.22"
"version" : "7.0.25"
},
"entries" : [ {
"pageref" : "page_1",

2
thousandeyes-sdk-endpoint-tests/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-event-detection/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-instant-tests/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-internet-insights/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-snapshots/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-streaming/README.md
View File

@ -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.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-tags/README.md
View File

@ -16,7 +16,7 @@ Things to note with the ThousandEyes Tags API:
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-test-results/README.md
View File

@ -3,7 +3,7 @@ Get test result metrics for Cloud and Enterprise Agent tests.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-tests/README.md
View File

@ -4,7 +4,7 @@ This API supports listing, creating, editing, and deleting Cloud and Enterprise
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

2
thousandeyes-sdk-usage/README.md
View File

@ -17,7 +17,7 @@ Refer to the Usage API operations for detailed usage instructions and optional p
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.22
- API version: 7.0.25
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator