thousandeyes-sdk-python/thousandeyes-sdk-labels/README.md

# thousandeyes-sdk-labels
### Overview
This is API for the Labels API (formerly called groups).

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.0.8
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-labels\&subdirectory=thousandeyes-sdk-labels
```
(you may need to run `pip` with root permission: `sudo pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-labels\&subdirectory=thousandeyes-sdk-labels`)

Then import the package:
```python
import thousandeyes_sdk.labels
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import thousandeyes_sdk.labels
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import thousandeyes_sdk.core
import thousandeyes_sdk.labels
from thousandeyes_sdk.core.exceptions 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.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.labels.AgentApi(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)
    label_request = thousandeyes_sdk.labels.LabelRequest() # LabelRequest | Label resource (optional)

    try:
        # Create a Label of type `agent`
        api_response = api_instance.create_agent_label(aid=aid, label_request=label_request)
        print("The response of AgentApi->create_agent_label:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentApi->create_agent_label: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AgentApi* | [**create_agent_label**](docs/AgentApi.md#create_agent_label) | **POST** /v7/labels/agent | Create a Label of type `agent`
*AgentApi* | [**delete_agent_label**](docs/AgentApi.md#delete_agent_label) | **DELETE** /v7/labels/agent/{labelId} | Delete a Label object of type `agent`
*AgentApi* | [**get_agent_label**](docs/AgentApi.md#get_agent_label) | **GET** /v7/labels/agent/{labelId} | Get a Label object of type `agent`
*AgentApi* | [**get_agent_labels**](docs/AgentApi.md#get_agent_labels) | **GET** /v7/labels/agent | Get list of Labels of type `agent`
*AgentApi* | [**update_agent_label**](docs/AgentApi.md#update_agent_label) | **PUT** /v7/labels/agent/{labelId} | Update a Label object of type `agent`
*AllLabelsApi* | [**get_labels**](docs/AllLabelsApi.md#get_labels) | **GET** /v7/labels | Get list of Labels
*DashboardApi* | [**create_dashboard_label**](docs/DashboardApi.md#create_dashboard_label) | **POST** /v7/labels/dashboard | Create a Label of type `dashboard`
*DashboardApi* | [**delete_dashboard_label**](docs/DashboardApi.md#delete_dashboard_label) | **DELETE** /v7/labels/dashboard/{labelId} | Delete a Label object of type `dashboard`
*DashboardApi* | [**get_dashboard_label**](docs/DashboardApi.md#get_dashboard_label) | **GET** /v7/labels/dashboard/{labelId} | Get a Label object of type `dashboard`
*DashboardApi* | [**get_dashboard_labels**](docs/DashboardApi.md#get_dashboard_labels) | **GET** /v7/labels/dashboard | Get list of Labels of type `dashboard`
*DashboardApi* | [**update_dashboard_label**](docs/DashboardApi.md#update_dashboard_label) | **PUT** /v7/labels/dashboard/{labelId} | Update a Label object of type `dashboard`
*EndpointTestApi* | [**create_endpoint_test_label**](docs/EndpointTestApi.md#create_endpoint_test_label) | **POST** /v7/labels/endpoint-test | Create a Label of type `endpoint-test`
*EndpointTestApi* | [**delete_endpoint_test_label**](docs/EndpointTestApi.md#delete_endpoint_test_label) | **DELETE** /v7/labels/endpoint-test/{labelId} | Delete a Label object of type `endpoint-test`
*EndpointTestApi* | [**get_endpoint_test_label**](docs/EndpointTestApi.md#get_endpoint_test_label) | **GET** /v7/labels/endpoint-test/{labelId} | Get a Label object of type `endpoint-test`
*EndpointTestApi* | [**get_endpoint_test_labels**](docs/EndpointTestApi.md#get_endpoint_test_labels) | **GET** /v7/labels/endpoint-test | Get list of Labels of type `endpoint-test`
*EndpointTestApi* | [**update_endpoint_test_label**](docs/EndpointTestApi.md#update_endpoint_test_label) | **PUT** /v7/labels/endpoint-test/{labelId} | Update a Label object of type `endpoint-test`
*TestApi* | [**create_test_label**](docs/TestApi.md#create_test_label) | **POST** /v7/labels/test | Create a Label of type `test`
*TestApi* | [**delete_test_label**](docs/TestApi.md#delete_test_label) | **DELETE** /v7/labels/test/{labelId} | Delete a Label object of type `test`
*TestApi* | [**get_test_label**](docs/TestApi.md#get_test_label) | **GET** /v7/labels/test/{labelId} | Get a Label object of type `test`
*TestApi* | [**get_test_labels**](docs/TestApi.md#get_test_labels) | **GET** /v7/labels/test | Get list of Labels of type `test`
*TestApi* | [**update_test_label**](docs/TestApi.md#update_test_label) | **PUT** /v7/labels/test/{labelId} | Update a Label object of type `test`


## Documentation For Models

 - [Error](docs/Error.md)
 - [Label](docs/Label.md)
 - [LabelDetail](docs/LabelDetail.md)
 - [LabelRequest](docs/LabelRequest.md)
 - [LabelType](docs/LabelType.md)
 - [Labels](docs/Labels.md)
 - [Link](docs/Link.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorItem](docs/ValidationErrorItem.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author