face_poker_api v1.0.19
face_poker_api
FacePokerApi - JavaScript client for face_poker_api This is a documentation for the Face Poker application. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install face_poker_api --save
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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your face_poker_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('face_poker_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/face_poker_api then install it via:
npm install YOUR_USERNAME/face_poker_api --save
For browser
The library also works in the browser environment via npm and browserify. 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, that's to say your javascript file where you actually
use this library):
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:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var FacePokerApi = require('face_poker_api');
var api = new FacePokerApi.CandidateApi()
var tableId = "tableId_example"; // {String} ID of table
var body = new FacePokerApi.Candidate(); // {Candidate} Candidate parameters
api.addCandidate(tableId, body).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 https://virtserver.swaggerhub.com/krzynool/FacePokerSwag/1.0.0
Class | Method | HTTP request | Description |
---|---|---|---|
FacePokerApi.CandidateApi | addCandidate | POST /table/{tableId}/candidate | Request to play |
FacePokerApi.CandidateApi | deleteCandidate | DELETE /table/{tableId}/candidate/{candidateId} | See all player requests |
FacePokerApi.CandidateApi | getCandidates | GET /table/{tableId}/candidate | See all player requests |
FacePokerApi.CardsApi | getCards | GET /table/{tableId}/player/{playerId}/cards | Get my cards |
FacePokerApi.HeroApi | editHero | PUT /table/{tableId}/hero | Representation of me |
FacePokerApi.HeroApi | quitGame | DELETE /table/{tableId}/hero | Quit the game |
FacePokerApi.MovesApi | move | POST /table/{tableId}/player/{playerId}/move | Make a move |
FacePokerApi.ParticipantApi | addPlayer | POST /table/{tableId}/player | Add a player |
FacePokerApi.ParticipantApi | deletePlayer | DELETE /table/{tableId}/player/{playerId} | Delete a player |
FacePokerApi.ParticipantApi | editPlayer | PUT /table/{tableId}/player/{playerId} | Edit a player |
FacePokerApi.ParticipantApi | getPlayer | GET /table/{tableId}/player/{playerId} | Edit a player |
FacePokerApi.TableApi | createTable | POST /table | Create new table |
FacePokerApi.TableApi | getTable | GET /table/{tableId} | Fetch existing table by ID |
FacePokerApi.TableApi | updateTable | PUT /table/{tableId} | Update an existing table |
Documentation for Models
- FacePokerApi.Candidate
- FacePokerApi.Card
- FacePokerApi.CommunityCards
- FacePokerApi.Hand
- FacePokerApi.InlineResponse201
- FacePokerApi.Move
- FacePokerApi.NewTable
- FacePokerApi.Participant
- FacePokerApi.Player
- FacePokerApi.Table
Documentation for Authorization
All endpoints do not require authorization.
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago