cleverreach-wrapper v0.4.6

cleverreach-wrapper

Promise based npm module for using CleverReach REST API

Install

$ npm install --save cleverreach-wrapper

Usage

var CleverReach = require('cleverreach-wrapper');

// Login credentials
var cr = new CleverReach({
	client_id: '123456',
	login: 'john.doe@foo.bar',
	password: 'abc123'
});

// Get all mailings
cr.mailings().getAll().then(function(mailings) {
	console.log(mailings);
});

// Get single mailing with specified ID
cr.mailings().get(1234567).then(function(mailing) {
	console.log(mailing);
}).catch(function(error) {
	console.log(error);
})

// Create new mailing
var newMailing = {
	'mailingData': {
		'name': 'This is the title',
		'type': 'html/text',
		'subject': 'subject line',
		'sender_name': 'Bruce Whayne (Whayne corp.)',
		'sender_email': 'bruce.whayne@gotham.com',
		'group_id': '#',
		'html': 'Newsletter Content',
		'text': 'this is the Text only'
	}
};

cr.mailings().create(newMailing).then(function(mailing) {
	console.log(mailing)
});

API

You find detailed infos about the CleverReach REST API here

Here is a list of all implemented functions:

Groups

.groups().getAll(data)

.groups().getAttributes(id)

.groups().getBlacklist(id)

.groups().getFilters(id)

.groups().getFilter(id, filterId)

.groups().getFilterReceivers(id, filterId)

.groups().getFilterStats(id, filterId)

.groups().getReceivers(id)

.groups().getReceiver(id, receiverId)

.groups().getReceiverEvents(id, receiverId)

.groups().getReceiverOrders(id, receiverId)

.groups().getReceiverAttributes(id, poolId)

.groups().get(id)

.groups().getAdvancedStats(id)

.groups().getForms(id)

.groups().getStats(id)

.groups().create(name)

.groups().createReceiver(id, data)

.groups().createReceivers(id, data)

.groups().deleteReceiver(groupId, receiverId)

.groups().delete(id)

Receivers

.receivers().get(id, data)

.receivers().getEvents(id, data)

.receivers().getOrders(id, data)

.receivers().getAttributes(id, data)

.receivers().getTags(id, data)

.receivers().createEvent(id, data)

.receivers().createOrder(id, data)

.receivers().createTag(id, data)

.receivers().checkValid(data)

Reports

.reports().getAll(data)

.reports().get(id, data)

.reports().getOrders(id)

.reports().getReceivers(id, data)

.reports().getStats(id, data)

Mailings

.mailings().getAll(data)

.mailings().get(id)

.mailings().getLinks(id)

.mailings().getOrders(id)

.mailings().create(data)

.mailings().update(id, data)

.mailings().getChannels()

.mailings().getChannel(id)

.mailings().deleteChannel(id)