npm package: @nsctool/api-client-js
Description: JS API client generated by OpenAPI Generator
Latest version: 0.1.100

# @nsctool/api-client-js

@NsctoolApiClientJs - JavaScript client for @nsctool/api-client-js
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v0
- Package version: 0.1.100
- 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 @nsctool/api-client-js --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 @nsctool/api-client-js 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 @NsctoolApiClientJs = require('@nsctool/api-client-js');


var api = new @NsctoolApiClientJs.CharacterControllerApi()
var character = new @NsctoolApiClientJs.Character(); // {Character} 
api.create1(character).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:7090*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*@NsctoolApiClientJs.CharacterControllerApi* | [**create1**](docs/CharacterControllerApi.md#create1) | **POST** /characters | 
*@NsctoolApiClientJs.CharacterControllerApi* | [**delete1**](docs/CharacterControllerApi.md#delete1) | **DELETE** /characters/{uuid} | 
*@NsctoolApiClientJs.CharacterControllerApi* | [**getAll**](docs/CharacterControllerApi.md#getAll) | **GET** /characters | 
*@NsctoolApiClientJs.CharacterControllerApi* | [**getById**](docs/CharacterControllerApi.md#getById) | **GET** /characters/{uuid} | 
*@NsctoolApiClientJs.HealthControllerApi* | [**health**](docs/HealthControllerApi.md#health) | **GET** /health | 
*@NsctoolApiClientJs.UserControllerApi* | [**callDelete**](docs/UserControllerApi.md#callDelete) | **DELETE** /users/{id} | 
*@NsctoolApiClientJs.UserControllerApi* | [**create**](docs/UserControllerApi.md#create) | **POST** /users | 


## Documentation for Models

 - [@NsctoolApiClientJs.Character](docs/Character.md)
 - [@NsctoolApiClientJs.CreateUserRequest](docs/CreateUserRequest.md)
 - [@NsctoolApiClientJs.User](docs/User.md)


## Documentation for Authorization

All endpoints do not require authorization.