araslanov-e/groovehq

Ruby gem for GrooveHQ api

GrooveHQ ruby client library

Client library for talking to GrooveHQ API. Supports all endpoints, as well as chaining API requests for hypermedia links.

Usage

First of all, initialize client:

client = GrooveHQ::Client.new("MY_API_TOKEN")

And then talk to API:

client.tickets(page: 2).first.number

Hypermedia support

Gem supports hypermedia links and allows to chain unlimited amount of requests like this:

client.tickets(page: 2).rels[:next].get.first.rels[:customer].get.email

List of all methods

Client methods really just map 1 to 1 to API, see all of them beyond. Check API docs for list of available options.

agent(email)
agents(options = {})
update_customer(options = {})
customer(email)
customers(options = {})
folders(options = {})
groups(options = {})
mailboxes(options = {})
create_message(options)
message(message_id)
messages(ticket_number, options = {})
tickets_count(options = {})
create_ticket(options)
ticket(ticket_number)
tickets(options = {})
ticket_state(ticket_number)
update_ticket_state(ticket_number, state)
ticket_assignee(ticket_number)
update_ticket_assignee(ticket_number, assignee)
update_ticket_priority(ticket_number, priority)
update_ticket_assigned_group(ticket_number, assigned_group)