@obycode/neoncrm

2.3.0 • Public • Published

Neon CRM REST API Client for Node.js

This module provides a simple async/await interface to Neon CRM.

Installation

npm install @obycode/neoncrm

Setup

const neoncrm = require("@obycode/neoncrm");
let neon = new neoncrm.Client(
  process.env.NEON_ORG_ID,
  process.env.NEON_API_KEY
);

Usage

  • findAccount(email) Returns ID of user with matching email or null
  • createAccount(email, firstname, lastname, phone, source = '') Creates a new user with the given information and returns the ID
  • createPledge(accountId, campaignId, amount) Creates a new pledge with the given information

Testing

Create a file, .env with the following variables:

NEON_ORG_ID=<neon org id>
NEON_API_KEY=<neon api key>
NEON_CAMPAIGN_ID=<campaign id for testing>

Then run the tests using:

npm test

/@obycode/neoncrm/

    Package Sidebar

    Install

    npm i @obycode/neoncrm

    Weekly Downloads

    0

    Version

    2.3.0

    License

    ISC

    Unpacked Size

    7.6 kB

    Total Files

    5

    Last publish

    Collaborators

    • obycode