# {{&title}}

{{&description}}

JavaScript client for {{&moduleName}} reference

This SDK is automatically generated by the Swagger Codegen project:

* API version: {{&apiVersion}}
* Package version: {{&version}}

## 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 jobsy_api_references --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.

### 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
const api = require('{{&moduleName}}')

let requestParams = {}

// Example request
let res = await api.exampleRequest(requestParams)
if (res) {
    // Response
} else {
    // Error
}
```

## Documentation for API Endpoints

{{#each tagsGroup}}

## {{@key}} Requests
| Class | Method | Http Request | Description |
| ----- | ------ | ------------ | ----------- |
{{#this}}
{{> methodList }}
{{/this}}
{{/each}}

{{#each definitions}}
## [{{@key}} Model]({{../modelPath}}/{{@key}}.md)
{{&title}}
{{/each}}

## Documentation for authorization

{{#each security}}
### {{@key}}
{{> securityDefinitions}}
{{/each}}