npm package: @rekon-oss/multi-translate
Description: Multi_Translate_is_a_unified_interface_on_top_of_various_translate_APIs_providing_optimal_translations_persistence_fallback_
Latest version: 0.7.0

# @rekon-oss/multi-translate

@RekonOssMultiTranslate - JavaScript client for @rekon-oss/multi-translate
Multi-Translate is a unified interface on top of various translate APIs providing optimal translations, persistence, fallback.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.7.0
- Package version: 0.7.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 @rekon-oss/multi-translate --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your @rekon-oss/multi-translate from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/rekon-oss/multi-translate
then install it via:

```shell
    npm install rekon-oss/multi-translate --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.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

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

```javascript
var @RekonOssMultiTranslate = require('@rekon-oss/multi-translate');


var api = new @RekonOssMultiTranslate.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSupportedEnginesAvailableEnginesGet(callback);

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*@RekonOssMultiTranslate.DefaultApi* | [**getSupportedEnginesAvailableEnginesGet**](docs/DefaultApi.md#getSupportedEnginesAvailableEnginesGet) | **GET** /available-engines | Get Supported Engines
*@RekonOssMultiTranslate.DefaultApi* | [**getSupportedLanguagesSupportedLanguagesGet**](docs/DefaultApi.md#getSupportedLanguagesSupportedLanguagesGet) | **GET** /supported-languages | Get Supported Languages
*@RekonOssMultiTranslate.DefaultApi* | [**readyGet**](docs/DefaultApi.md#readyGet) | **GET** / | Ready
*@RekonOssMultiTranslate.DefaultApi* | [**translatePostTranslatePost**](docs/DefaultApi.md#translatePostTranslatePost) | **POST** /translate | Translate Post
*@RekonOssMultiTranslate.DefaultApi* | [**translateTranslateGet**](docs/DefaultApi.md#translateTranslateGet) | **GET** /translate | Translate


## Documentation for Models

 - [@RekonOssMultiTranslate.HTTPValidationError](docs/HTTPValidationError.md)
 - [@RekonOssMultiTranslate.TranslationRequest](docs/TranslationRequest.md)
 - [@RekonOssMultiTranslate.TranslationResponse](docs/TranslationResponse.md)
 - [@RekonOssMultiTranslate.ValidationError](docs/ValidationError.md)


## Documentation for Authorization

All endpoints do not require authorization.