# ipoet-client

ipoet_client - JavaScript client for ipoet-client
IPOET Web Application
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.0.1
- Package version: 1.0.0
- 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 ipoet-client --save
```

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

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --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 ipoet_client = require('ipoet-client');

var api = new ipoet_client.IPOETServiceApi()

var opts = { 
  'instance': "instance_example" // {String} Instance
};
api.getAnnexObjectiveResults(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ipoet_client.IPOETServiceApi* | [**getAnnexObjectiveResults**](docs/IPOETServiceApi.md#getAnnexObjectiveResults) | **GET** /annexObjectives | get annexe objectives
*ipoet_client.IPOETServiceApi* | [**getDEASimilarityResults**](docs/IPOETServiceApi.md#getDEASimilarityResults) | **GET** /similarAnnexes | get similar annexes
*ipoet_client.IPOETServiceApi* | [**getEngineResults**](docs/IPOETServiceApi.md#getEngineResults) | **GET** /engines | get engine results
*ipoet_client.IPOETServiceApi* | [**getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults**](docs/IPOETServiceApi.md#getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults) | **GET** /evaluate | get EvaluateAllGHWB2019TaskGroup_CurrentCapAndModsResults results
*ipoet_client.IPOETServiceApi* | [**getLineItemSpending**](docs/IPOETServiceApi.md#getLineItemSpending) | **GET** /spending | get line item spending
*ipoet_client.IPOETServiceApi* | [**getObjectiveResults**](docs/IPOETServiceApi.md#getObjectiveResults) | **GET** /objectives | get Objectives
*ipoet_client.IPOETServiceApi* | [**getRootInfo**](docs/IPOETServiceApi.md#getRootInfo) | **GET** / | get service information
*ipoet_client.IPOETServiceApi* | [**getShowShipsResults**](docs/IPOETServiceApi.md#getShowShipsResults) | **GET** /showships | get showships results
*ipoet_client.IPOETServiceApi* | [**getSimilarityValues**](docs/IPOETServiceApi.md#getSimilarityValues) | **GET** /similarities | get similarity values


## Documentation for Models

 - [ipoet_client.AnnexObjectiveResult](docs/AnnexObjectiveResult.md)
 - [ipoet_client.DEASimilarityResult](docs/DEASimilarityResult.md)
 - [ipoet_client.EngineResult](docs/EngineResult.md)
 - [ipoet_client.ObjectiveResult](docs/ObjectiveResult.md)
 - [ipoet_client.ShipSolutionResult](docs/ShipSolutionResult.md)
 - [ipoet_client.ShowShipsResult](docs/ShowShipsResult.md)
 - [ipoet_client.SimilarityResult](docs/SimilarityResult.md)


## Documentation for Authorization

 All endpoints do not require authorization.