README

poker_pal

PokerPal - JavaScript client for poker_pal PokerPal API This SDK is automatically generated by the Swagger Codegen project:

API version: v1
Package version: v1
Build package: io.swagger.codegen.v3.generators.javascript.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 poker_pal --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 PokerPal = require('poker_pal');

var api = new PokerPal.BadgesApi()
var id = 56; // {Number} The unique identifier of the badge.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.badgesIdGet(id, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
PokerPal.BadgesApi	badgesIdGet	GET /badges/{id}	Get the details of the badge with provided id.
PokerPal.BadgesApi	badgesPost	POST /badges	Create a new badge with the provided details.
PokerPal.UsersApi	usersGet	GET /users	Get the details of all users.
PokerPal.UsersApi	usersIdBadgesGet	GET /users/{id}/badges	Get the badges a user has.
PokerPal.UsersApi	usersIdBadgesPost	POST /users/{id}/badges	Give a user the specified badge.
PokerPal.UsersApi	usersIdGet	GET /users/{id}	Get the details of the user with the provided ID.
PokerPal.UsersApi	usersPost	POST /users	Create a new user with the provided details.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Usage no npm install needed!