Helpscout::Mailbox::V2::Client

Super simple REST client for the HelpScout V2 Mailbox API

It uses the following gems to work with HelpScout

• Helpscout::Api::Auth
• Helpscout::Mailbox::Paths

Add this line to your application's Gemfile:

gem 'helpscout-mailbox-v2-client'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install helpscout-mailbox-v2-client

Creates a new Client class and authorises the client with HelpScout

require 'helpscout/mailbox/client'

client = Helpscout::Mailbox::V2::Client::Http.new(client_id: 'some id', client_secret: 'keep it secret')
# => 'BMEv1lmcNgDBpOFNHo8TPlODMrF3BG5T'

Generates path and method mappings for the api - see Helpscout::Mailbox::Paths

path_map = client.generate_path :v2_conversation, {conversation_id: 1089909636}
# => {:method=>"GET", :path=>"/v2/conversations/1089909636"}

Sends a request

path_map = client.generate_path :v2_conversation, {conversation_id: 1089909636}
# => {:method=>"GET", :path=>"/v2/conversations/1089909636"}

response = client.request path_map[:method], path_map[:path], {eat: 'cheese'}
# => <Net::HTTPOK 200  readbody=true>

Sends a JSON request

path_map = client.generate_path :v2_conversations_tags_update, {conversation_id: 1089909636}
# => {:method=>"PUT", :path=>"/v2/conversations/1089909636/tags"}

response = client.json_request path_map[:method], path_map[:path], { tags: ['clam'] }, {eat: 'cheese'}
# => <Net::HTTPOK 200  readbody=true>

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/helpscout-mailbox-v2-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Helpscout::Mailbox::V2::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.