1.0.2 • Published 7 years ago

unwaffle v1.0.2

Weekly downloads
1
License
Apache-2.0
Repository
-
Last release
7 years ago

unwaffle

Unwaffle - JavaScript client for unwaffle The Unwaffle API. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-10-12T09:37:32.013Z
  • Build package: class 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 unwaffle --save

git

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

    npm install YOUR_USERNAME/unwaffle --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.

Getting Started

Please follow the installation instruction and execute the following JS code:

var Unwaffle = require('unwaffle');

var defaultClient = Unwaffle.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new Unwaffle.ActionApi()

var opts = { 
  'body': new Unwaffle.TransportObject() // {TransportObject} A TransportObject describing the action. The API will also happily consume a CSV or TSV with one record per line and no header row.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addAction(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.unwaffle.com/v1

ClassMethodHTTP requestDescription
Unwaffle.ActionApiaddActionPOST /actionAdd an action
Unwaffle.LabelApiaddLabelPOST /labelAdd or update a Label
Unwaffle.ParticipantApiaddParticipantPOST /participantAdd or update a Participant

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication
1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago