# rrhet_quality_star_api

RrhetQualityStarApi - JavaScript client for rrhet_quality_star_api
Analyses MDS data and generates reports
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- 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 rrhet_quality_star_api --save
```

##### 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
```

Finally, switch to the directory you want to use your rrhet_quality_star_api from, and run:

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

You should now be able to `require('rrhet_quality_star_api')` in javascript files from the directory you ran the last 
command above from.

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

```shell
    npm install YOUR_USERNAME/rrhet_quality_star_api --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, that's to say your javascript file where you actually 
use this library):

```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 RrhetQualityStarApi = require('rrhet_quality_star_api');

var api = new RrhetQualityStarApi.DefaultApi()

var location = "location_example"; // {String} facility ID

var type = "type_example"; // {String} Type of chart (qm/4q/qm-gap/qm-risk)

var start = "start_example"; // {String} Start date in the format yyyy-MM-dd

var end = "end_example"; // {String} End date in the format yyyy-MM-dd

var token = "token_example"; // {String} The authorization token

var opts = { 
  'measure': "all", // {String} Quality measure
  'calculationType': "average" // {String} Type of calculation(Average/Predicitve)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.chartLocationTypeStartEndGet(location, type, start, end, token, opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://localhost:8079/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*RrhetQualityStarApi.DefaultApi* | [**chartLocationTypeStartEndGet**](docs/DefaultApi.md#chartLocationTypeStartEndGet) | **GET** /chart/{location}/{type}/{start}/{end} | Returns array of measures for individual quarters in the specified period.
*RrhetQualityStarApi.DefaultApi* | [**fileDownloadGet**](docs/DefaultApi.md#fileDownloadGet) | **GET** /file-download | download file
*RrhetQualityStarApi.DefaultApi* | [**fileUploadPost**](docs/DefaultApi.md#fileUploadPost) | **POST** /file-upload | upload a file
*RrhetQualityStarApi.DefaultApi* | [**getDummyGraphDataGet**](docs/DefaultApi.md#getDummyGraphDataGet) | **GET** /getDummyGraphData | Returns dummy data for homepage graph
*RrhetQualityStarApi.DefaultApi* | [**improvementPlanGet**](docs/DefaultApi.md#improvementPlanGet) | **GET** /improvement-plan | Improvement Plan
*RrhetQualityStarApi.DefaultApi* | [**improvementPlanIdDelete**](docs/DefaultApi.md#improvementPlanIdDelete) | **DELETE** /improvement-plan/{id} | Deleting improvement plan
*RrhetQualityStarApi.DefaultApi* | [**improvementPlanIdGet**](docs/DefaultApi.md#improvementPlanIdGet) | **GET** /improvement-plan/{id} | Improvement Plan
*RrhetQualityStarApi.DefaultApi* | [**improvementPlanIdPut**](docs/DefaultApi.md#improvementPlanIdPut) | **PUT** /improvement-plan/{id} | Updating improvement plan
*RrhetQualityStarApi.DefaultApi* | [**improvementPlanPost**](docs/DefaultApi.md#improvementPlanPost) | **POST** /improvement-plan | Adding improcement plan
*RrhetQualityStarApi.DefaultApi* | [**measurePost**](docs/DefaultApi.md#measurePost) | **POST** /measure | Measure
*RrhetQualityStarApi.DefaultApi* | [**qualityMeasureGet**](docs/DefaultApi.md#qualityMeasureGet) | **GET** /quality-measure | Quality Measure
*RrhetQualityStarApi.DefaultApi* | [**qualityMeasureIdGet**](docs/DefaultApi.md#qualityMeasureIdGet) | **GET** /quality-measure/{id} | Quality Measure
*RrhetQualityStarApi.DefaultApi* | [**quickTipsLocationGet**](docs/DefaultApi.md#quickTipsLocationGet) | **GET** /quick-tips/{location} | Returns an array of quick tips
*RrhetQualityStarApi.DefaultApi* | [**reportPost**](docs/DefaultApi.md#reportPost) | **POST** /report | QM report
*RrhetQualityStarApi.DefaultApi* | [**uploadMDSGet**](docs/DefaultApi.md#uploadMDSGet) | **GET** /uploadMDS | Getting all MDS upload history
*RrhetQualityStarApi.DefaultApi* | [**uploadMDSLocationYearQuarterPost**](docs/DefaultApi.md#uploadMDSLocationYearQuarterPost) | **POST** /uploadMDS/{location}/{year}/{quarter} | upload MDS zip file
*RrhetQualityStarApi.DefaultApi* | [**usersGet**](docs/DefaultApi.md#usersGet) | **GET** /users | returns users


## Documentation for Models

 - [RrhetQualityStarApi.Axis](docs/Axis.md)
 - [RrhetQualityStarApi.Chart](docs/Chart.md)
 - [RrhetQualityStarApi.Error](docs/Error.md)
 - [RrhetQualityStarApi.GraphBar](docs/GraphBar.md)
 - [RrhetQualityStarApi.ImprovementPlan](docs/ImprovementPlan.md)
 - [RrhetQualityStarApi.ImprovementPlanProjectApproval](docs/ImprovementPlanProjectApproval.md)
 - [RrhetQualityStarApi.ImprovementPlanReviewFrequency](docs/ImprovementPlanReviewFrequency.md)
 - [RrhetQualityStarApi.Location](docs/Location.md)
 - [RrhetQualityStarApi.MDSHistory](docs/MDSHistory.md)
 - [RrhetQualityStarApi.Measure](docs/Measure.md)
 - [RrhetQualityStarApi.MeasureRequestParam](docs/MeasureRequestParam.md)
 - [RrhetQualityStarApi.Point](docs/Point.md)
 - [RrhetQualityStarApi.PointsComparisonData](docs/PointsComparisonData.md)
 - [RrhetQualityStarApi.QM](docs/QM.md)
 - [RrhetQualityStarApi.QuickTip](docs/QuickTip.md)
 - [RrhetQualityStarApi.RateTrend](docs/RateTrend.md)
 - [RrhetQualityStarApi.Report](docs/Report.md)
 - [RrhetQualityStarApi.ReportRequestParam](docs/ReportRequestParam.md)
 - [RrhetQualityStarApi.UploadFile](docs/UploadFile.md)
 - [RrhetQualityStarApi.User](docs/User.md)


## Documentation for Authorization

 All endpoints do not require authorization.

