HelpscoutApi
A simple ruby wrapper for the Helpscout API.
Installation
Add this line to your application's Gemfile:
gem 'helpscout_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install helpscout_api
Usage
# Set your api_token
HelpscoutApi::Client.api_token = YOUR_API_TOKEN
# Create your client
client = HelpscoutApi::Client.new()
# List resources
client.<resource>.list(<params>)
# e.g. client.mailboxes.list(<params>)
# Get resources
client.<resource>.get(<id>, <params>)
# e.g. client.mailboxes.get(123)
# Create resource
client.<resource>.create(<params>)
# e.g. client.conversations.get({ conversation_params })
# CONVERSATIONS
# List all
client.conversations.list(mailbox_id: <mailbox_id>, <params>)
# Create
client.conversations.create(<params>)
# See https://developer.helpscout.com/help-desk-api/conversations/create/ for required params
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bitbond/helpscout_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the HelpscoutApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.