EAL JS
Library to interact with EAL API from any JS based project.
Installation
With NPM
npm install --save bardog-eal-js
With YARN
yarn add bardog-eal-js
First steps
Import the package from your JS project:
Use it on your project:
const EventManager = user: 'YOUR_EAL_USERNAME' password: 'YOUR_EAL_PASSWORD'; // Adding an eventEventManager;
Supported methods
:: addEvent
- Description: adds a single event through EAL API.
- Returns a Promise.
- Params:
{ user: { //optional id, username, email, firstName, //optional lastName, //optional phone, //optional extraFields: {}, //optional }, business: { id, name, email, //optional phone, //optional website, //optional extraFields: {} //optional }, action: { datetime, name, category, //optional object: { //optional id, className, before, //optional after, //optional }, extraFields: {}, //optional } }
:: addEvents
- Description: adds multiple events through EAL API.
- Returns a Promise.
- Params:
{ user: { //optional id, username, email, firstName, //optional lastName, //optional phone, //optional extraFields: {}, //optional }, business: { id, name, email, //optional phone, //optional website, //optional extraFields: {} //optional }, actions: [{ datetime, name, category, //optional object: { //optional id, className, before, //optional after, //optional }, extraFields: {}, //optional }] }
:: resetSessionToken
- Description: reset the EAL activity session token.
- Returns nothing.
- Params: none.