npm package: @invi7x/api_documentation
Description: Api_Documentation
Latest version: 0.1.3

# api_documentation

ApiDocumentation - JavaScript client for api_documentation
Api Documentation
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.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 api_documentation --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 api_documentation 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/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.

### 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 ApiDocumentation = require('api_documentation');


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

```

## Documentation for API Endpoints

All URIs are relative to *http://master-7rqtwti-2fay4tys5mlti.de-2.platformsh.site*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingDELETE**](docs/BasicErrorControllerApi.md#errorUsingDELETE) | **DELETE** /error | error
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingGET**](docs/BasicErrorControllerApi.md#errorUsingGET) | **GET** /error | error
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingHEAD**](docs/BasicErrorControllerApi.md#errorUsingHEAD) | **HEAD** /error | error
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingOPTIONS**](docs/BasicErrorControllerApi.md#errorUsingOPTIONS) | **OPTIONS** /error | error
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingPATCH**](docs/BasicErrorControllerApi.md#errorUsingPATCH) | **PATCH** /error | error
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingPOST**](docs/BasicErrorControllerApi.md#errorUsingPOST) | **POST** /error | error
*ApiDocumentation.BasicErrorControllerApi* | [**errorUsingPUT**](docs/BasicErrorControllerApi.md#errorUsingPUT) | **PUT** /error | error
*ApiDocumentation.DiaryControllerApi* | [**deleteDiaryUsingDELETE**](docs/DiaryControllerApi.md#deleteDiaryUsingDELETE) | **DELETE** /api/diaries/{id} | Deletes diary object
*ApiDocumentation.DiaryControllerApi* | [**findDiariesUsingGET**](docs/DiaryControllerApi.md#findDiariesUsingGET) | **GET** /api/diaries | Responds with a list of diaries
*ApiDocumentation.DiaryControllerApi* | [**findDiaryUsingGET**](docs/DiaryControllerApi.md#findDiaryUsingGET) | **GET** /api/diaries/{id} | Responds with a diary object
*ApiDocumentation.DiaryControllerApi* | [**saveDiaryUsingPOST**](docs/DiaryControllerApi.md#saveDiaryUsingPOST) | **POST** /api/diaries/ | Saves new diary object
*ApiDocumentation.DiaryControllerApi* | [**updateDiaryUsingPUT**](docs/DiaryControllerApi.md#updateDiaryUsingPUT) | **PUT** /api/diaries/{id} | Updates a diary object
*ApiDocumentation.ExaminationControllerApi* | [**findExaminationUsingGET**](docs/ExaminationControllerApi.md#findExaminationUsingGET) | **GET** /api/examinations/{id} | Responds with an examination object
*ApiDocumentation.ExaminationControllerApi* | [**findExaminationsUsingGET**](docs/ExaminationControllerApi.md#findExaminationsUsingGET) | **GET** /api/examinations | Responds with a list of examinations
*ApiDocumentation.ExaminationControllerApi* | [**saveExaminationUsingPOST**](docs/ExaminationControllerApi.md#saveExaminationUsingPOST) | **POST** /api/examinations | Saves new Examination object
*ApiDocumentation.ExportControllerApi* | [**exportExaminationFeaturesUsingGET**](docs/ExportControllerApi.md#exportExaminationFeaturesUsingGET) | **GET** /api/export/examination_feature_set.csv | Responds with a list of diaries
*ApiDocumentation.LocationDataControllerApi* | [**getMatchingLocationsUsingPOST**](docs/LocationDataControllerApi.md#getMatchingLocationsUsingPOST) | **POST** /locations/check | Responds with a list of matched locations
*ApiDocumentation.LocationDataControllerApi* | [**getMatchingPlacesUsingPOST**](docs/LocationDataControllerApi.md#getMatchingPlacesUsingPOST) | **POST** /locations/checkp | Responds with a list of matched predefined places
*ApiDocumentation.LocationDataControllerApi* | [**uploadLocationDataUsingPOST**](docs/LocationDataControllerApi.md#uploadLocationDataUsingPOST) | **POST** /locations/upload | Responds with a list of diaries, if parameters are set it will respond with a list of contacts taken between start and finish
*ApiDocumentation.OperationHandlerApi* | [**handleUsingGET**](docs/OperationHandlerApi.md#handleUsingGET) | **GET** /actuator/health/** | handle
*ApiDocumentation.OperationHandlerApi* | [**handleUsingGET1**](docs/OperationHandlerApi.md#handleUsingGET1) | **GET** /actuator/health | handle
*ApiDocumentation.OperationHandlerApi* | [**handleUsingGET2**](docs/OperationHandlerApi.md#handleUsingGET2) | **GET** /actuator/info | handle
*ApiDocumentation.SymptomControllerApi* | [**findSymptomsUsingGET**](docs/SymptomControllerApi.md#findSymptomsUsingGET) | **GET** /api/symptoms | Responds with a list of symptoms
*ApiDocumentation.SymptomControllerApi* | [**findUserUsingGET**](docs/SymptomControllerApi.md#findUserUsingGET) | **GET** /api/symptoms/{id} | Responds with a symptom object
*ApiDocumentation.SymptomControllerApi* | [**saveSymptomUsingPOST**](docs/SymptomControllerApi.md#saveSymptomUsingPOST) | **POST** /api/symptoms | Saves new Symptom object
*ApiDocumentation.UserControllerApi* | [**deleteUserUsingDELETE**](docs/UserControllerApi.md#deleteUserUsingDELETE) | **DELETE** /api/users/{id} | Deletes user object
*ApiDocumentation.UserControllerApi* | [**findUserUsingGET1**](docs/UserControllerApi.md#findUserUsingGET1) | **GET** /api/users/{id} | Responds with a user object
*ApiDocumentation.UserControllerApi* | [**findUsersUsingGET**](docs/UserControllerApi.md#findUsersUsingGET) | **GET** /api/users | Responds with a list of users
*ApiDocumentation.UserControllerApi* | [**saveUserUsingPOST**](docs/UserControllerApi.md#saveUserUsingPOST) | **POST** /api/users | Saves new User object
*ApiDocumentation.UserControllerApi* | [**updateUserUsingPUT**](docs/UserControllerApi.md#updateUserUsingPUT) | **PUT** /api/users/{id} | Updates a user object
*ApiDocumentation.WebMvcLinksHandlerApi* | [**linksUsingGET**](docs/WebMvcLinksHandlerApi.md#linksUsingGET) | **GET** /actuator | links


## Documentation for Models

 - [ApiDocumentation.ContactEntry](docs/ContactEntry.md)
 - [ApiDocumentation.ContactEntryDTO](docs/ContactEntryDTO.md)
 - [ApiDocumentation.CorrespondenceDetails](docs/CorrespondenceDetails.md)
 - [ApiDocumentation.CorrespondenceDetailsDTO](docs/CorrespondenceDetailsDTO.md)
 - [ApiDocumentation.Diary](docs/Diary.md)
 - [ApiDocumentation.DiaryDTO](docs/DiaryDTO.md)
 - [ApiDocumentation.Duration](docs/Duration.md)
 - [ApiDocumentation.Examination](docs/Examination.md)
 - [ApiDocumentation.ExaminationDTO](docs/ExaminationDTO.md)
 - [ApiDocumentation.Link](docs/Link.md)
 - [ApiDocumentation.Location](docs/Location.md)
 - [ApiDocumentation.LocationMatch](docs/LocationMatch.md)
 - [ApiDocumentation.ModelAndView](docs/ModelAndView.md)
 - [ApiDocumentation.PlaceMatch](docs/PlaceMatch.md)
 - [ApiDocumentation.PlaceVisit](docs/PlaceVisit.md)
 - [ApiDocumentation.Symptom](docs/Symptom.md)
 - [ApiDocumentation.SymptomDTO](docs/SymptomDTO.md)
 - [ApiDocumentation.TimeLineObject](docs/TimeLineObject.md)
 - [ApiDocumentation.TimelineJsonRoot](docs/TimelineJsonRoot.md)
 - [ApiDocumentation.User](docs/User.md)
 - [ApiDocumentation.UserDTO](docs/UserDTO.md)
 - [ApiDocumentation.View](docs/View.md)


## Documentation for Authorization

All endpoints do not require authorization.