helpscout
v0.0.1
Published
Helpscout API for node
Downloads
48
Readme
helpscout
A Helpscout API for node.
Installation
$ npm install helpscout
Example
Create a new Helpscout instance and query for mailboxes:
var helpscout = require('helpscout')('apikey');
And query mailboxes:
helpscout.mailboxes.list(function (err, mailboxes) {
// ..
});
Or select a mailbox:
var mailbox = require('helpscout')('apikey', 6314);
Then you can query mailbox conversations:
mailbox.conversations.list(function (err, conversations) {
// ..
});
API
new Helpscout(apiKey)
Create a new Helpscout
client to query Mailboxes
.
#list([options,] callback)
Returns a list of mailboxes, with options defaulted to:
{
page: 1
}
new Helpscout(apiKey, mailboxId)
Create a new Mailbox
client.
#conversations.list([options,] callback)
Returns a list of conversations, with options defaulted to:
{
page: 1,
status: 'all'
tag: null
}
License
MIT