@dimrev4/[email protected]

This generator creates TypeScript/JavaScript client that utilizes 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)

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 @dimrev4/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthV1Api | login | POST /api/v1/auth/login | Login a user AuthV1Api | loginSession | POST /api/v1/auth/login-session | Login a user from session AuthV1Api | loginSession_0 | POST /api/v1/auth/login-session | Login a user from session AuthV1Api | login_0 | POST /api/v1/auth/login | Login a user AuthV1Api | logout | POST /api/v1/auth/logout | Logout user AuthV1Api | logout_0 | POST /api/v1/auth/logout | Logout user AuthV1Api | refresh | POST /api/v1/auth/refresh | Refresh access token AuthV1Api | refresh_0 | POST /api/v1/auth/refresh | Refresh access token AuthV1Api | register | POST /api/v1/auth/register | Register a new user AuthV1Api | register_0 | POST /api/v1/auth/register | Register a new user GameV1Api | createGame | POST /api/v1/game | Create a new game GameV1Api | createGame_0 | POST /api/v1/game | Create a new game GameV1Api | getFullGameById | GET /api/v1/game/{id} | Get full game by id GameV1Api | getFullGameById_0 | GET /api/v1/game/{id} | Get full game by id GameV1Api | getGames | GET /api/v1/game | Get all games GameV1Api | getGames_0 | GET /api/v1/game | Get all games GameV1Api | updateGame | PUT /api/v1/game/{id} | Update a game GameV1Api | updateGame_0 | PUT /api/v1/game/{id} | Update a game ReviewV1Api | getUserGameReviewByGameId | GET /api/v1/review/game/{gameId} | Get user game review by game id ReviewV1Api | getUserGameReviewByGameId_0 | GET /api/v1/review/game/{gameId} | Get user game review by game id ReviewV1Api | upsertUserGameReview | POST /api/v1/review/game/{gameId} | Upsert user game review ReviewV1Api | upsertUserGameReview_0 | POST /api/v1/review/game/{gameId} | Upsert user game review

Documentation For Models

• CreateGameDto
• FullGameDto
• FullGameResponseDto
• GameDto
• GameGenreEnum
• GamePlatformEnum
• GamesResponseDto
• GetUserGameReviewByGameId401Response
• GetUserGameReviewByGameId404Response
• GetUserGameReviewByGameId500Response
• GetUserGameReviewByGameIdResponseDto
• Login400Response
• Login401Response
• LoginRequestBodyDto
• LoginResponseDto
• LoginSession400Response
• LoginSession401Response
• LoginSessionResponseDto
• RefreshResponseDto
• Register400Response
• Register500Response
• RegistrationRequestBodyDto
• RegistrationResponseDto
• ReviewDto
• UpdateGameDto
• UpsertUserGameReview500Response
• UpsertUserGameReviewRequest
• UpsertUserGameReviewResponse
• UserDto

Documentation For Authorization

Authentication schemes defined for the API:

access

• Type: Bearer authentication (JWT)

refresh

• Type: Bearer authentication (JWT)

api-key

• Type: Bearer authentication (API-Key)