mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 06:26:51 +00:00

Shahid Hussain Khan 745e74afc4

CP-2189 Update SDK names for admin and monitors modules (#9 )

* CP-2189 Update SDK names for admin and monitors modules

* CP-2189 Move client to core

* CP-2189 Change client to core

2024-06-04 16:09:40 +01:00

20 KiB

Raw Blame History

thousandeyes_sdk.tests.VoiceApi

All URIs are relative to https://api.thousandeyes.com

Method	HTTP request	Description
create_voice_test	POST /v7/tests/voice	Create Voice test
delete_voice_test	DELETE /v7/tests/voice/{testId}	Delete Voice test
get_voice_test	GET /v7/tests/voice/{testId}	Get Voice test
get_voice_tests	GET /v7/tests/voice	List Voice tests
update_voice_test	PUT /v7/tests/voice/{testId}	Update Voice test

create_voice_test

VoiceTest create_voice_test(update_voice_test, aid=aid, expand=expand)

Create Voice test

Creates a new Voice test. This method requires Account Admin permissions.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.expand import Expand
from thousandeyes_sdk.tests.models.update_voice_test import UpdateVoiceTest
from thousandeyes_sdk.tests.models.voice_test import VoiceTest
from thousandeyes_sdk.tests.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com"
)

# 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 Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with thousandeyes_sdk.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.VoiceApi(api_client)
    update_voice_test = thousandeyes_sdk.tests.UpdateVoiceTest() # UpdateVoiceTest | 
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
    expand = [thousandeyes_sdk.tests.Expand()] # List[Expand] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

    try:
        # Create Voice test
        api_response = api_instance.create_voice_test(update_voice_test, aid=aid, expand=expand)
        print("The response of VoiceApi->create_voice_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VoiceApi->create_voice_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
update_voice_test	UpdateVoiceTest
aid	str	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]
expand	List[Expand]	Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.	[optional]

Return type

VoiceTest

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
201	Created	* Location -
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_voice_test

delete_voice_test(test_id, aid=aid)

Delete Voice test

Deletes the specified Voice test. This method requires Account Admin permissions.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com"
)

# 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 Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with thousandeyes_sdk.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.VoiceApi(api_client)
    test_id = '281474976710706' # str | ID of the test
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # Delete Voice test
        api_instance.delete_voice_test(test_id, aid=aid)
    except Exception as e:
        print("Exception when calling VoiceApi->delete_voice_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	ID of the test
aid	str	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
204	No content	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_voice_test

VoiceTest get_voice_test(test_id, aid=aid, expand=expand)

Get Voice test

Returns details for a Voice test, including name, intervals, targets, alert rules and agents.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.expand import Expand
from thousandeyes_sdk.tests.models.voice_test import VoiceTest
from thousandeyes_sdk.tests.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com"
)

# 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 Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with thousandeyes_sdk.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.VoiceApi(api_client)
    test_id = '281474976710706' # str | ID of the test
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
    expand = [thousandeyes_sdk.tests.Expand()] # List[Expand] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

    try:
        # Get Voice test
        api_response = api_instance.get_voice_test(test_id, aid=aid, expand=expand)
        print("The response of VoiceApi->get_voice_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VoiceApi->get_voice_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	ID of the test
aid	str	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]
expand	List[Expand]	Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.	[optional]

Return type

VoiceTest

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_voice_tests

VoiceTests get_voice_tests(aid=aid)

List Voice tests

Returns a list of Voice tests and saved events.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.voice_tests import VoiceTests
from thousandeyes_sdk.tests.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com"
)

# 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 Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with thousandeyes_sdk.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.VoiceApi(api_client)
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # List Voice tests
        api_response = api_instance.get_voice_tests(aid=aid)
        print("The response of VoiceApi->get_voice_tests:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VoiceApi->get_voice_tests: %s\n" % e)

Parameters

Name	Type	Description	Notes
aid	str	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

VoiceTests

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_voice_test

VoiceTest update_voice_test(test_id, update_voice_test, aid=aid, expand=expand)

Update Voice test

Updates a Voice test. The target test cannot be a live share or saved event. This method requires Account Admin permissions.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.expand import Expand
from thousandeyes_sdk.tests.models.update_voice_test import UpdateVoiceTest
from thousandeyes_sdk.tests.models.voice_test import VoiceTest
from thousandeyes_sdk.tests.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com"
)

# 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 Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with thousandeyes_sdk.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.VoiceApi(api_client)
    test_id = '281474976710706' # str | ID of the test
    update_voice_test = thousandeyes_sdk.tests.UpdateVoiceTest() # UpdateVoiceTest | 
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
    expand = [thousandeyes_sdk.tests.Expand()] # List[Expand] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

    try:
        # Update Voice test
        api_response = api_instance.update_voice_test(test_id, update_voice_test, aid=aid, expand=expand)
        print("The response of VoiceApi->update_voice_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VoiceApi->update_voice_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	ID of the test
update_voice_test	UpdateVoiceTest
aid	str	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]
expand	List[Expand]	Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.	[optional]

Return type

VoiceTest

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

20 KiB Raw Blame History

thousandeyes_sdk.tests.VoiceApi

create_voice_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_voice_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_voice_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_voice_tests

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_voice_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

20 KiB

Raw Blame History