@fugashu/frontierwheel-api-client
v1.0.9
Published
OpenAPI client for @fugashu/frontierwheel-api-client
Downloads
14
Maintainers
Readme
@fugashu/[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 buildPublishing
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 @fugashu/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DefaultApi | appControllerGetHello | GET /app | Get a hello message DefaultApi | authControllerAuthenticate | POST /auth/authenticate | Authenticate a user with their Metamask wallet DefaultApi | authControllerGetNonce | GET /auth/nonce | Get a nonce message for wallet authentication DefaultApi | bettingControllerCompleteBettingRound | POST /betting/rounds/{id}/complete | Complete a betting round and determine a winner DefaultApi | bettingControllerCreateBettingRound | POST /betting/rounds | Create a new betting round DefaultApi | bettingControllerGetAllBettingRounds | GET /betting/rounds | Get all betting rounds DefaultApi | bettingControllerGetBettingRoundById | GET /betting/rounds/{id} | Get a betting round by ID DefaultApi | bettingControllerPlaceWager | POST /betting/wagers | Place a wager in the latest open betting round DefaultApi | lobbyControllerCreateLobby | POST /lobby | Create a new lobby DefaultApi | lobbyControllerGetAllLobbies | GET /lobby | Get all active lobbies DefaultApi | lobbyControllerGetLobbyById | GET /lobby/{id} | Get a lobby by ID DefaultApi | lobbyControllerJoinLobby | POST /lobby/{id}/join | Join a lobby DefaultApi | lobbyControllerLeaveLobby | DELETE /lobby/{id}/leave | Leave a lobby
Documentation For Models
- AuthenticateDto
- AuthenticateResponseDto
- BettingRoundDto
- CreateBettingRoundDto
- CreateLobbyDto
- LobbyDto
- NonceResponseDto
- PlaceWagerDto
- UserActionDto
- UserDto
- WagerDto
Documentation For Authorization
Endpoints do not require authorization.
