mds-carrotquest-client v1.2.0

mds-carrotquest-client

Simple carrotquest.io client with Promises for nodejs.

Carrot quest web api documentation: https://carrotquest.io/developers/webapi/

Installation

npm install mds-carrotquest-client or yarn add mds-carrotquest-client

Examples

const CarrotQuest = require('mds-carrotquest-client')
const client = new CarrotQuest(apiKey)

// Get all users
client.apps.users().then(users => {
  console.log(users)
}).catch(err => {
  console.error(err)
})

Methods

Get active users

client.apps.activeUsers()

Get app users

client.apps.users(query)

Get conversations

client.apps.conversations(query)

Get app channels

client.apps.channels()

Get user

client.users.get(id, query)

Get user events

client.users.events(id, query)

Get user conversations

client.users.conversations(id, query)

Create user event

client.users.createEvent(id, query)

Set user props

client.users.setProps(id, query)

Set user presence

client.users.setPresence(id, query)

Send a message to user

client.users.sendMessage(id, query)

Start a conversation with user

client.users.startConversation(id, query)

Unsubscribe user email

client.users.unsubscribeEmail(id, query)

Testing

Create .env file with your Carrot Quest API key and run yarn test:

echo API_KEY > .env
yarn install
yarn test