Nonprofit Pizza Maker

    @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

    Keywords

    Install

    npm i @bufferapp/helpscout

    DownloadsWeekly Downloads

    0

    Version

    0.1.2

    License

    MIT

    Last publish

    Collaborators

    • egomezd
    • cheahenry
    • jacobchadwell
    • boristroja
    • philippemiguet
    • josemdev
    • msanroman
    • daisymarie128
    • hamstu
    • stevenc81
    • bufferbot
    • albennett
    • mayauribe
    • ssvmvss
    • gomezjuliana
    • esclapes
    • ay8s
    • mickmahady
    • dinostheo
    • hitherejoe
    • dace
    • erickhun
    • kmbriseno
    • hackertronix
    • kiriappeee
    • ethaneisenhard
    • cmunozgar
    • gtangbuffer
    • heatheryou
    • peteremilbuffer
    • arekpn
    • abeeb
    • buffermw
    • gisete