Code Monkey home page Code Monkey logo

groove-api's Introduction

GrooveHQ API (groove-api)

Node.js wrapper for Groove API (https://www.groovehq.com/docs)

Installation

npm install groove-api --save

Usage

var grooveClass = require('groove-api');
var groove = new grooveClass(YOUR_GROOVEHQ_ACCESS_TOKEN_HERE);

Supports promises

//Get all tickets for a specific customer
groove.getTickets(null, "[email protected]")
            .then(function (ticketsresult) {
                //success
                ...
            },
            function(err)
            {
              //error
              ...
            });

Also supports callbacks

//Get all messages for a specific ticket (page 1, 50 messages per page)
groove.getMessages(someTicketId, 1, 50, function(err, messagesresult) {
               if (err) {
                  //error
                  ..
                }
                //success
                ...
                });

Create a ticket example

groove.createTicket(ticketBodyText, "[email protected]", "[email protected]")
                    .then(function (result) {
                        //success
                        ..
                    },function(err){
                        //error
                        ..
                    });

Currently the following methods are supported

  • GetTickets
  • GetTicket
  • GetMessages
  • CreateTicket
  • CreateMessage

See https://www.groovehq.com/docs for more info about each method.

Future work

  • Add all available API methods

by silveridea

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.