lib |
4y .gitignore |
4y .rspec |
4y CHANGELOG |
4y Gemfile |
4y LICENSE.txt |
4y README.md |
4y Rakefile |
4y kickserv.gemspec |
A Ruby wrapper for the Kickserv REST API.
Add this line to your application's Gemfile:
gem 'kickserv'
And then execute:
$ bundle
Or install it yourself as:
$ gem install kickserv
Before you can make calls to Kickserv you must configure the library with a valid API Token and a valid account_slug. 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", account_slug: "YOUR_ACCOUNT_SLUG_HERE" )
Kickserv.configure do |config| config.api_key = "YOUR_TOKEN_HERE" config.account_slug = "YOUR_ACCOUNT_SLUG_HERE" end client = Kickserv.client
client.customers client.customers(page: 2) client.customers(service_zip_code: '30102') client.customers(name: 'Aime Pavao') client.customer(2)
client.jobs client.jobs(page: 2, only: %w{total subtotal}) client.jobs(scheduled: 'today') client.jobs(state: 'completed') client.jobs(job_type_id: 14761) client.jobs(only: 'job_number,id,customer_id,name,status') client.jobs(page: 1, scheduled: 'today', state: 'uncompleted') client.job(3)
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)