Classy API for node.js
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
src
test
.babelrc
.gitignore
.jscsrc
.npmignore
.snyk
.travis.yml
LICENSE
README.md
gulpfile.babel.js
package-lock.json
package.json

README.md

Classy Node Build Status Known Vulnerabilities Coverage Status

Built for the creativity and flexibility of the world's most innovative minds, create impactful apps and integrations that make social enterprises more efficient and effective. Engineer the world for good with the Classy API.

Request access and learn more by visiting developers.classy.org.

Important notice

Classy Node is currently in development and is not ready for use on production.

Installation

npm install classy-node

Overview

Start by instantiating your classy instance. We recommend storing your client ID and client secret as environment variables.

var Classy = require('classy-node');

var classy = new Classy({
  clientId: process.env.CLIENT_ID,
  clientSecret: process.env.CLIENT_SECRET
});

Then, use classy.app() to obtain an application token and make calls as a trusted Classy application:

classy.app().then(function() {
  // Make calls on behalf of the application
});

Every resource method returns a promise:

classy.campaigns.retrieve(19, {
  token: 'app'
}).then(function(response) {
  // Do something with the response
}).catch(function(error) {
  // Do something with the error
});

Each resource can contain several basic methods (retrieve, update, delete). Each resource might also include additional custom methods that act upon related resources or perform specialized operations:

  • create()
  • retrieve()
  • update()
  • del()
  • create{RelatedResource}() e.g., createCampaign()
  • list{RelatedResources}() e.g. listCampaigns()
  • Other/specialized e.g., publish(), unpublish(), & deactivate()

Contributing

When submitting a pull request, please make sure you've written good commit messages that include references to issues and clearly describe what the commit achieves. Use the commit body to explain what you did and why you did it. Thanks!

You can run our tests with npm test and get coverage reports with npm run coverage.

You can run the example with babel-node example/index.js. Make sure you have your environment variables for CLIENT_ID and CLIENT_SECRET set up!

More information

Classy Node was built by the developers at Classy in San Diego, CA. We're on a mission to mobilize and empower the world for good.

The code was heavily inspired by Stripe's awesome stripe-node.