Kickserv

A Ruby wrapper for the Kickserv REST API.

Installation

Add this line to your application's Gemfile:

gem 'kickserv'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kickserv

Usage

Configuration

Before you can make calls to Kickserv you must configure the library with a valid API Token and a valid subdomain. An employee’s unique API token can be found in the employee management section of your Kickserv account.

There are two ways to configure the gem. You can pass a hash of configuration options when you create a client, or you can use a configure block.

client = Kickserv.client(api_key: "YOUR_TOKEN_HERE", subdomain: "YOUR_SUBDOMAIN_HERE")

Kickserv.configure do |config|
  config.api_key = "YOUR_TOKEN_HERE"
  config.subdomain = "YOUR_SUBDOMAIN_HERE"
end

client = Kickserv.client

Get customers

client.customers
client.customers(page: 2)

Get jobs

client.jobs
client.jobs(page: 2, only: %w{total subtotal})

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request