@bufferapp/helpscout

0.1.2 • Public • Published

MIRROR FOR https://github.com/segmentio/helpscout

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

Dependents (0)

Package Sidebar

Install

npm i @bufferapp/helpscout

Weekly Downloads

3

Version

0.1.2

License

MIT

Last publish

Collaborators

  • davidluhr
  • egomezd
  • jacobchadwell
  • boristroja
  • philippemiguet
  • josemdev
  • msanroman
  • daisymarie128
  • hamstu
  • stevenc81
  • bufferbot
  • mayauribe
  • esclapes
  • ay8s
  • mickmahady
  • dinostheo
  • hitherejoe
  • dace
  • erickhun
  • kmbriseno
  • kiriappeee
  • cmunozgar
  • peteremilbuffer
  • arekpn
  • abeeb
  • buffermw