npm package: @rebornteam/reborn-api
Description: OpenAPI client for @rebornteam/reborn-api
Author: OpenAPI-Generator Contributors
Latest version: 2.5.1

## @rebornteam/reborn-api@2.5.1

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run `npm publish`

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install @rebornteam/reborn-api@2.5.1 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints

All URIs are relative to *https://api.smsh.sh*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminClientCredentialsApi* | [**disableClient**](docs/AdminClientCredentialsApi.md#disableclient) | **POST** /admin/client/{id}/disable | Disable client credentials
*AdminClientCredentialsApi* | [**enableClient**](docs/AdminClientCredentialsApi.md#enableclient) | **POST** /admin/client/{id}/enable | Enable client credentials
*AdminClientCredentialsApi* | [**generateClientCredentials**](docs/AdminClientCredentialsApi.md#generateclientcredentials) | **POST** /admin/client/generate | Generate new client credentials
*AdminClientCredentialsApi* | [**listClients**](docs/AdminClientCredentialsApi.md#listclients) | **GET** /admin/client | List client credentials
*AdminClientCredentialsApi* | [**revokeToken**](docs/AdminClientCredentialsApi.md#revoketoken) | **DELETE** /admin/client/{id} | Revoke client credentials
*AdminClientCredentialsApi* | [**rotateToken**](docs/AdminClientCredentialsApi.md#rotatetoken) | **POST** /admin/client/{id}/rotate | Rotate client credentials
*AdminClientCredentialsApi* | [**updateClient**](docs/AdminClientCredentialsApi.md#updateclient) | **PUT** /admin/client/{id} | Update client metadata
*AdminConnectionsApi* | [**createBypass**](docs/AdminConnectionsApi.md#createbypass) | **POST** /admin/connection/bypass | Create connection bypass
*AdminConnectionsApi* | [**listConnections**](docs/AdminConnectionsApi.md#listconnections) | **GET** /admin/connection/recent | List recent connections
*AdminDashboardApi* | [**dashboardStats**](docs/AdminDashboardApi.md#dashboardstats) | **GET** /admin/dashboard | Get dashboard statistics
*ConnectionApi* | [**getConnectionDetails**](docs/ConnectionApi.md#getconnectiondetails) | **GET** /v1/connection/get-connection-details/{ip} | Check Connection and Detect VPN/Proxy
*PlayerApi* | [**getPlayer**](docs/PlayerApi.md#getplayer) | **GET** /v1/player/{uuid} | Get Player Information
*PunishmentApi* | [**applyPunishment**](docs/PunishmentApi.md#applypunishment) | **POST** /v1/punishment/apply | Apply a punishment
*PunishmentApi* | [**createPunishmentDraft**](docs/PunishmentApi.md#createpunishmentdraft) | **POST** /v1/punishment/draft | Create a punishment draft
*PunishmentApi* | [**getPunishmentSeverities**](docs/PunishmentApi.md#getpunishmentseverities) | **GET** /v1/punishment/severities | Get punishment severities
*PunishmentApi* | [**getPunishments**](docs/PunishmentApi.md#getpunishments) | **GET** /v1/punishment | Get punishments by player
*PunishmentApi* | [**getPunishmentsByIp**](docs/PunishmentApi.md#getpunishmentsbyip) | **GET** /v1/punishment/ip | Get punishments by IP address
*PunishmentApi* | [**getRecentPunishments**](docs/PunishmentApi.md#getrecentpunishments) | **GET** /v1/punishment/recent | List recent punishments


### Documentation For Models

 - [AdminClientCredentialResponse](docs/AdminClientCredentialResponse.md)
 - [AdminConnectionBypassResponse](docs/AdminConnectionBypassResponse.md)
 - [AdminDashboardConnectionResponse](docs/AdminDashboardConnectionResponse.md)
 - [AdminGetDashboardStats](docs/AdminGetDashboardStats.md)
 - [ApplyPunishmentRequest](docs/ApplyPunishmentRequest.md)
 - [ApplyPunishmentResponse](docs/ApplyPunishmentResponse.md)
 - [ClientCredentialRequest](docs/ClientCredentialRequest.md)
 - [ConnectionGetConnectionDetailsResponse](docs/ConnectionGetConnectionDetailsResponse.md)
 - [CreateBypassRequest](docs/CreateBypassRequest.md)
 - [CreatePunishmentDraftRequest](docs/CreatePunishmentDraftRequest.md)
 - [PlayerGetPlayerInformation](docs/PlayerGetPlayerInformation.md)
 - [PunishmentDraftResponse](docs/PunishmentDraftResponse.md)
 - [PunishmentGetPunishmentResponse](docs/PunishmentGetPunishmentResponse.md)
 - [PunishmentSeveritiesResponse](docs/PunishmentSeveritiesResponse.md)
 - [PunishmentSeveritiesResponsePunishmentTypeInfo](docs/PunishmentSeveritiesResponsePunishmentTypeInfo.md)
 - [PunishmentSeveritiesResponseSeverityInfo](docs/PunishmentSeveritiesResponseSeverityInfo.md)
 - [UpdateClientRequest](docs/UpdateClientRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="CognitoAuth"></a>
### CognitoAuth

- **Type**: Bearer authentication (JWT)