giveback_ninja

GivebackNinja - JavaScript client for giveback_ninja No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Package version: 2.0.0
• Build package: org.openapitools.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 giveback_ninja --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your giveback_ninja from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 GivebackNinja = require('giveback_ninja');


var api = new GivebackNinja.DefaultApi()
var user = {"username":"new_ninja","displayName":"New Ninja","githubUsername":"new_ninja"}; // {User} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUser(user, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- GivebackNinja.DefaultApi | createUser | POST /user | Registers a new user in the system. GivebackNinja.DefaultApi | levelGet | GET /level | Obtain all available Levels GivebackNinja.DefaultApi | scorecardGet | GET /scorecard | Get all user scorecards. GivebackNinja.DefaultApi | scorecardUsernameGet | GET /scorecard/{username} | Get UserScorecard info for a specific user. GivebackNinja.DefaultApi | scorecardUsernamePoolPost | POST /scorecard/{username}/{pool} |

Documentation for Models

• GivebackNinja.ErrorResponse
• GivebackNinja.Event
• GivebackNinja.Level
• GivebackNinja.Period
• GivebackNinja.Record
• GivebackNinja.Scorecard
• GivebackNinja.User

Documentation for Authorization

All endpoints do not require authorization.