{"id":27296975,"url":"https://github.com/connorjacobsen/helpscout","last_synced_at":"2025-07-07T12:05:10.709Z","repository":{"id":41829613,"uuid":"228719148","full_name":"connorjacobsen/helpscout","owner":"connorjacobsen","description":"Ruby library for HelpScout Mailbox API 2.0","archived":false,"fork":false,"pushed_at":"2020-10-09T00:21:01.000Z","size":75,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T23:53:00.300Z","etag":null,"topics":["helpscout","helpscout-api","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/connorjacobsen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-17T23:28:03.000Z","updated_at":"2020-03-02T19:31:40.000Z","dependencies_parsed_at":"2022-08-11T18:41:16.154Z","dependency_job_id":null,"html_url":"https://github.com/connorjacobsen/helpscout","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connorjacobsen%2Fhelpscout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connorjacobsen%2Fhelpscout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connorjacobsen%2Fhelpscout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connorjacobsen%2Fhelpscout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/connorjacobsen","download_url":"https://codeload.github.com/connorjacobsen/helpscout/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497851,"owners_count":21113984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helpscout","helpscout-api","ruby"],"created_at":"2025-04-11T23:53:02.896Z","updated_at":"2025-04-11T23:53:03.394Z","avatar_url":"https://github.com/connorjacobsen.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Helpscout\n\nRuby client for the HelpScout Mailbox API v2.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'helpscout'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install helpscout\n\n## Usage\n\nConfigure the library:\n\n```ruby\nHelpScout.client_id = 'your-client-id'\nHelpScout.client_secret = 'your-client-secret'\n\n# Any `Moneta` cache is compatible so long as it supports Expiry.\nHelpScout.cache = Moneta.new(:Redis, url: ENV['REDIS_URL'])\n```\n\n### Basics\n\nAll responses have some basic properties:\n\n```ruby\nresp = HelpScout::Mailbox.list\n\n# The response object has a predicate method `success?` to indicate\n# success and `result` unwraps the response data.\nputs resp.result if resp.success?\n\n# Errors are available on the response object as well.\nputs resp.errors\n```\n\nPaginating list responses:\n\n```ruby\n# Pass the page number as a param.\nresp = HelpScout::Mailbox.list(page: 1)\n\nresp.result.page.total_pages\n# =\u003e 3\nresp.result.page.total_elements\n# =\u003e 124\n```\n\n### Conversations\n\nCreate a new Conversation:\n\n```ruby\nHelpScout::Conversation.create(conversation_params)\n```\n\nGet a Conversation by ID:\n\n```ruby\nHelpScout::Conversation.retrieve(conversation_id)\n```\n\nDelete a Conversation:\n\n```ruby\nHelpScout::Conversation.delete(conversation_id)\n```\n\nList Conversations:\n\n```ruby\nHelpScout::Conversation.list\n\n# Filter\nHelpScout::Conversation.list(mailbox: 34231, status: 'active', tag: 'red,blue')\n```\n\nUpdate Conversation:\n\n```ruby\n# The mechanism for this is a bit un-ergonomic, see the HelpScout\n# Mailbox API docs for full details.\nHelpScout::Conversation.update(conversation_id, update_params)\n```\n\n### Customers\n\nCreate a new Customer:\n\n```ruby\nHelpScout::Customer.create(customer_params)\n```\n\nGet a Customer by ID:\n\n```ruby\nHelpScout::Customer.retrieve(customer_id)\n```\n\nList Customers:\n\n```ruby\nHelpScout::Customer.list\n\n# Filter\n# See https://developer.helpscout.com/mailbox-api/endpoints/customers/list/#url-parameters\n# for all options.\nHelpScout::Customer.list(firstName: 'Bob', mailbox: 1234)\n```\n\nUpdate a Customer:\n\n```ruby\nHelpScout::Customer.update(customer_id, new_params)\n```\n\n### Mailboxes\n\nList mailboxes:\n\n```ruby\nHelpScout::Mailbox.list\n```\n\n### Tags\n\nList all Tags used across all Mailboxes:\n\n```ruby\nHelpScout::Tag.list\n```\n\n### Teams\n\nList Team members:\n\n```ruby\nHelpScout::Team.list_members\n```\n\nList Teams:\n\n```ruby\nHelpScout::Team.list\n```\n\n### Users\n\nGet User by ID:\n\n```ruby\nHelpScout::User.retrieve(user_id)\n```\n\nList Users:\n\n```ruby\nHelpScout::User.list\n\n# `email` and `mailbox` are valid request parameters\nHelpScout::User.list(email: 'me@example.com', mailbox: 1234)\n```\n\nGet the authenticated User:\n\n```ruby\nHelpScout::User.retrieve_resource_owner\n```\n\n## Progress\n\n| Models                        | List | Get | Create | Update | Delete |\n| :---------------------------- | :--: | :-: | :----: | :----: | :----: |\n| Conversations                 |  ✅  | ✅  |   ✅   |   ✅   |   ✅   |\n| Conversations::Attachment     |  ➖  | ✅  |   ✅   |   ➖   |   ✅   |\n| Conversations::Fields         |  ➖  | ➖  |   ➖   |   ✅   |   ➖   |\n| Conversations::Tags           |  ➖  | ➖  |   ➖   |   ✅   |   ➖   |\n| Conversation::Threads         |  ✅  | ➖  |   ➖   |   ✅   |   ➖   |\n| Conversation::Notes           |  ➖  | ➖  |   ✅   |   ➖   |   ➖   |\n| Conversation::ChatThreads     |  ➖  | ➖  |   ✅   |   ➖   |   ➖   |\n| Conversation::CustomerThreads |  ➖  | ➖  |   ✅   |   ➖   |   ➖   |\n| Conversation::PhoneThreads    |  ➖  | ➖  |   ✅   |   ➖   |   ➖   |\n| Customers                     |  ✅  | ✅  |   ✅   |   ✅   |   ➖   |\n| Customers::Address            |  ➖  | ✅  |   ✅   |   ✅   |   ✅   |\n| Customers::ChatHandles        |  ✅  | ➖  |   ✅   |   ✅   |   ✅   |\n| Customers::Emails             |  ✅  | ➖  |   ✅   |   ✅   |   ✅   |\n| Customers::Phones             |  ✅  | ➖  |   ✅   |   ✅   |   ✅   |\n| Customers::SocialProfiles     |  ✅  | ➖  |   ✅   |   ✅   |   ✅   |\n| Customers::Websites           |  ✅  | ➖  |   ✅   |   ✅   |   ✅   |\n| Mailboxes                     |  ✅  | ✅  |   ➖   |   ➖   |   ➖   |\n| Mailbox::Folders              |  ✅  | ➖  |   ➖   |   ➖   |   ➖   |\n| Mailbox::Fields               |  ✅  | ➖  |   ➖   |   ➖   |   ➖   |\n| Ratings                       |  ➖  | ✅  |   ➖   |   ➖   |   ➖   |\n| Tags                          |  ✅  | ➖  |   ➖   |   ➖   |   ➖   |\n| Teams                         |  ✅  | ➖  |   ➖   |   ➖   |   ➖   |\n| Team::Members                 |  ✅  | ➖  |   ➖   |   ➖   |   ➖   |\n| Users                         |  ✅  | ✅  |   ➖   |   ➖   |   ➖   |\n| Users::ResourceOwners         |  ➖  | ✅  |   ➖   |   ➖   |   ➖   |\n| Webhooks                      |  ✅  | ✅  |   ✅   |   ✅   |   ✅   |\n| Workflows                     |  ✅  | ➖  |   ➖   |   ✅   |   ➖   |\n\n| Endpoint | Supported |\n| -------- | :-------: |\n| Reports  |    ❌     |\n| Search   |    ❌     |\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/connorjacobsen/helpscout.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconnorjacobsen%2Fhelpscout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconnorjacobsen%2Fhelpscout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconnorjacobsen%2Fhelpscout/lists"}