open-index/open-npm huggingface dataset:
npm package: @robsa/test_client
Description: full_definition_Common_Alarm
Author: Robin.Seifert@isax.com
Latest version: 0.0.2

# test_client

TestClient - client for test_client
full definition for Common-API  Alarms
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0
- Package version: 2.0
- Build package: org.openapitools.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 @dxq/client --save
```

Finally, you need to build the module:

```shell
npm run build
```

## Getting Started

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

```javascript
var TestClient = require('test_client');


var api = new TestClient.AlarmMSApi()
var opts = {
  'currentPage': 0, // {Number} 
  'pageSize': 5 // {Number} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAlarms(opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8080/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TestClient.AlarmMSApi* | [**listAlarms**](docs/AlarmMSApi.md#listAlarms) | **GET** /alarm/alarms | 


## Documentation for Models

 - [TestClient.Alarm](docs/Alarm.md)
 - [TestClient.AlarmList](docs/AlarmList.md)
 - [TestClient.ObjectRef](docs/ObjectRef.md)


## Documentation for Authorization

All endpoints do not require authorization.