npm package: @heatworks/hls-tests-api-js
Description: Javascript API for accessing and modifying tests in HLS.
Latest version: 0.0.2

# HLS Tests API

**Autogenerated ~ Sorry for the gibberish.**

HlsTests - JavaScript client for hls___tests
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 2017-06-20T13:31:11Z
- Package version: 2017-06-20T13:31:11Z
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install hls___tests --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/hls___tests
then install it via:

```shell
    npm install YOUR_USERNAME/hls___tests --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var HlsTests = require('hls___tests');

var defaultClient = HlsTests.ApiClient.instance;

// Configure API key authorization: oAuth_2_0
var oAuth_2_0 = defaultClient.authentications['oAuth_2_0'];
oAuth_2_0.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//oAuth_2_0.apiKeyPrefix['Authorization'] = "Token"

var api = new HlsTests.DefaultApi()

var opts = { 
  'name': "name_example" // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.testDelete(opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://d3kndyx4n9.execute-api.us-east-1.amazonaws.com/pre_alpha*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*HlsTests.DefaultApi* | [**testDelete**](docs/DefaultApi.md#testDelete) | **DELETE** /Test | 
*HlsTests.DefaultApi* | [**testGet**](docs/DefaultApi.md#testGet) | **GET** /Test | 
*HlsTests.DefaultApi* | [**testOptions**](docs/DefaultApi.md#testOptions) | **OPTIONS** /Test | 
*HlsTests.DefaultApi* | [**testPut**](docs/DefaultApi.md#testPut) | **PUT** /Test | 
*HlsTests.DefaultApi* | [**testsGet**](docs/DefaultApi.md#testsGet) | **GET** /Tests | 
*HlsTests.DefaultApi* | [**testsOptions**](docs/DefaultApi.md#testsOptions) | **OPTIONS** /Tests | 


## Documentation for Models

 - [HlsTests.Empty](docs/Empty.md)
 - [HlsTests.Test](docs/Test.md)
 - [HlsTests.TestMarkers](docs/TestMarkers.md)
 - [HlsTests.Tests](docs/Tests.md)


## Documentation for Authorization


### oAuth_2_0

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header