# face_poker_api > This_is_a_documentation_for_the_Face_Poker_application_ Latest version **1.0.19** (published 2021-07-23) · Unlicense license · 0 weekly downloads ## Install ```sh npm install face_poker_api pnpm add face_poker_api yarn add face_poker_api bun add face_poker_api ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.19 | | Published | 2021-07-23 | | First published | 2020-04-10 | | Weekly downloads | 0 | | License | Unlicense | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 182.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | marekkrzynowek, oleh.zakharchuk, franek-montrose, ania-montrose, szymon.solecki | ## Links - npm: https://www.npmjs.com/package/face_poker_api - npm.io page: https://npm.io/package/face_poker_api ## Dependencies (2) - [superagent](https://npm.io/package/superagent.md) 3.7.0 - [querystring](https://npm.io/package/querystring.md) 0.2.0 ## Recent versions - 1.0.19 (latest) — 2021-07-23 - 1.0.18 — 2021-06-09 - 1.0.17 — 2021-06-08 - 1.0.16 — 2021-06-08 - 1.0.15 — 2021-06-08 - 1.0.14 — 2021-05-20 - 1.0.13 — 2020-09-18 - 1.0.12 — 2020-08-19 - 1.0.11 — 2020-08-12 - 1.0.10 — 2020-08-05 - 1.0.9 — 2020-06-08 - 1.0.8 — 2020-06-07 - 1.0.7 — 2020-05-21 - 1.0.6 — 2020-05-07 - 1.0.5 — 2020-05-07 - … 5 more at https://npm.io/package/face_poker_api/versions ## README # 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](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.0 - Package version: 1.0.0 - Build package: io.swagger.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 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: ```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 ``` Finally, switch to the directory you want to use your face_poker_api from, and run: ```shell npm link /path/to/ ``` 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: ```shell npm install YOUR_USERNAME/face_poker_api --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, that's to say your javascript file where you actually use this library): ```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 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**](docs/CandidateApi.md#addCandidate) | **POST** /table/{tableId}/candidate | Request to play *FacePokerApi.CandidateApi* | [**deleteCandidate**](docs/CandidateApi.md#deleteCandidate) | **DELETE** /table/{tableId}/candidate/{candidateId} | See all player requests *FacePokerApi.CandidateApi* | [**getCandidates**](docs/CandidateApi.md#getCandidates) | **GET** /table/{tableId}/candidate | See all player requests *FacePokerApi.CardsApi* | [**getCards**](docs/CardsApi.md#getCards) | **GET** /table/{tableId}/player/{playerId}/cards | Get my cards *FacePokerApi.HeroApi* | [**editHero**](docs/HeroApi.md#editHero) | **PUT** /table/{tableId}/hero | Representation of me *FacePokerApi.HeroApi* | [**quitGame**](docs/HeroApi.md#quitGame) | **DELETE** /table/{tableId}/hero | Quit the game *FacePokerApi.MovesApi* | [**move**](docs/MovesApi.md#move) | **POST** /table/{tableId}/player/{playerId}/move | Make a move *FacePokerApi.ParticipantApi* | [**addPlayer**](docs/ParticipantApi.md#addPlayer) | **POST** /table/{tableId}/player | Add a player *FacePokerApi.ParticipantApi* | [**deletePlayer**](docs/ParticipantApi.md#deletePlayer) | **DELETE** /table/{tableId}/player/{playerId} | Delete a player *FacePokerApi.ParticipantApi* | [**editPlayer**](docs/ParticipantApi.md#editPlayer) | **PUT** /table/{tableId}/player/{playerId} | Edit a player *FacePokerApi.ParticipantApi* | [**getPlayer**](docs/ParticipantApi.md#getPlayer) | **GET** /table/{tableId}/player/{playerId} | Edit a player *FacePokerApi.TableApi* | [**createTable**](docs/TableApi.md#createTable) | **POST** /table | Create new table *FacePokerApi.TableApi* | [**getTable**](docs/TableApi.md#getTable) | **GET** /table/{tableId} | Fetch existing table by ID *FacePokerApi.TableApi* | [**updateTable**](docs/TableApi.md#updateTable) | **PUT** /table/{tableId} | Update an existing table ## Documentation for Models - [FacePokerApi.Candidate](docs/Candidate.md) - [FacePokerApi.Card](docs/Card.md) - [FacePokerApi.CommunityCards](docs/CommunityCards.md) - [FacePokerApi.Hand](docs/Hand.md) - [FacePokerApi.InlineResponse201](docs/InlineResponse201.md) - [FacePokerApi.Move](docs/Move.md) - [FacePokerApi.NewTable](docs/NewTable.md) - [FacePokerApi.Participant](docs/Participant.md) - [FacePokerApi.Player](docs/Player.md) - [FacePokerApi.Table](docs/Table.md) ## Documentation for Authorization All endpoints do not require authorization. --- _Source: https://npm.io/package/face_poker_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._