0.3.0 • Published 9 years ago

baabedo v0.3.0

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

Baabedo API JS-Client for Node and Browser

The package can be used in node.js and browser environments. Just require('baabedo'). If you want to use it in your client/browser app, just browserify your app, which requires baabedo.

Installation

npm install baabedo

To get a js file you can use in the frontend run

$ npm install -g browserify
$ browserify lib/baabedo.js -o bundle.js -s Baabedo

Note: You can specify a custom API url by providing the ENV variable BAABEDO_API_URL

API Overview

Every resource is accessed via your baabedo instance:

var baabedo = require('baabedo')(' your baabedo access_token ');
// baabedo.{ RESOURCE_NAME }.{ METHOD_NAME }

Every resource method accepts an optional callback as the last argument:

baabedo.channels.create(
  { marketplace_type: 'Amazon' },
  function(err, channel) {
    err; // null if no error occurred
    channel; // the created channel object
  }
);

Additionally, every resource method returns a promise, so you don't have to use the regular callback. E.g.

// Create a new customer and then a new charge for that customer:
baabedo.channels.create({
  marketplace_type: 'Amazon'
}).then(function(channel) {
  return baabedo.channel.createProduct(channel.id, {
    name: 'Blue Socks',
    min_price: 1600,
    currency: 'usd',
  });
}).then(function(charge) {
  // New charge created on a new customer
}, function(err) {
  // Deal with an error
});

Available resources & methods

Where you see params it is a plain JavaScript object, e.g. { email: 'foo@example.com' }

  • Channels
  • create(params)
  • list([params])
  • retrieve(channelId)
  • del(channelId)
  • Products
  • createProduct(channelId)
  • createProducts(channelId)
  • updateProducts(channelId)
  • listProducts(channelId)
  • retrieveProduct(channelId, productId)
  • updateProduct(channelId, productId)
  • ProductOrders
  • createProductOrders(channelId)
  • updateProductOrders(channelId)
  • listProductOrders(channelId)
  • updateProductOrder(channelId, OrderItemId)
  • Statistics
  • retrieveStatisticsProfit(channelId)
  • retrieveStatisticsRevenue(channelId)
  • Search
  • searchProducts(channelId)
  • Payment_Plans
  • list([params])
  • updateSubscription(params) not yet implemented
  • cancelSubscription(params) not yet implemented
  • Payment_Information
  • list([params])
  • update(params) not yet implemented
  • retrieveClientToken(params) not yet implemented

Configuration

  • baabedo.setApiKey(' your secret api key ');
  • baabedo.setTimeout(20000); // in ms (default is node's default: 120000ms)

Development

Run the tests using npm:

$ npm install
$ npm test

License

Copyright (C) 2015 Storeness

0.3.0

9 years ago

0.2.2

9 years ago

0.2.1

9 years ago

0.2.0

9 years ago

0.1.1

9 years ago

0.1.0

9 years ago

0.0.5

9 years ago

0.0.4

9 years ago

0.0.3

9 years ago

0.0.2

9 years ago