Chargehound bindings for Node.js
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
lib
test Add support for API version override Nov 3, 2017
.babelrc
.eslintignore
.gitignore
.node-version
.npmignore
.travis.yml
CHANGELOG
LICENSE
README.md
package.json

README.md

Chargehound node.js bindings

Build Status npm version

Installation

npm install chargehound

Usage

Every resource is accessed via the chargehound instance:

var chargehound = require('chargehound')('{ YOUR_API_KEY }');

Requests

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

chargehound.Disputes.submit('dp_123', {fields: {customer_name: 'Susie'}},
  function (err, dispute) {
    err; // null if no error occurred
    dispute; // the submitted dispute object
  }
);

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

chargehound.Disputes.submit('dp_123', {fields: {customer_name: 'Susie'}})
  .then(function (dispute) {
    // Success
  .catch(function (err) {
    // Deal with an error
  });

Responses

Responses from the API are automatically parsed from JSON and returned as JavaScript objects.

Responses also include the HTTP status code on the response object as the status field.

chargehound.Disputes.retrieve('dp_123').then(dispute => {
  console.log(dispute.state)
  // 'needs_response'
  console.log(dispute.response.status)
  // 200
});

Documentation

Disputes

Errors

Development

To build and install from the latest source:

$ git clone git@github.com:chargehound/chargehound-node.git
$ npm install

The source code is written in ES6. For development you will need Node.js >= v4.4.3.

Run the tests using npm:

$ npm test

Deployment

To deploy a new version of the SDK, perform the following steps:

  1. Update the CHANGELOG to describe what feature have been added.
  2. Bump the version number in package.json
  3. Rebuild and deploy the package with: npm publish
  4. Confirm the new package version is available at https://www.npmjs.com/package/chargehound