0.0
The project is in a healthy, maintained state
API client for SmartRecruiters
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

~> 2.2
~> 5.14
~> 13.0

Runtime

 Project Readme

SmartRecruiters

API wrapper for the SmartRecruiters API

Installation

Add this line to your application's Gemfile:

gem 'smartrecruiters'

And then execute:

$ bundle

Or install it yourself as:

$ gem install smartrecruiters

Usage

To access the API, you'll need to create a SmartRecruiters::Client

client = SmartRecruiters::Client.new(api_key: ENV["SMARTRECRUITERS_API_KEY"])

To configure for the sandbox environment

client = SmartRecruiters::Client.new(api_key: ENV["SMARTRECRUITERS_API_KEY"], environment: "sandbox")

Resources

Access Groups

client.access_groups.list
client.access_groups.assign_users(group_id: "id", user_ids: ["user_id"])
client.access_groups.remove_user(group_id: "id", user_id: "id")

Candidates

client.candidates.list
client.candidates.create({})
client.candidates.retrieve(candidate_id: "id")
client.candidates.update(candidate_id: "id", {})
client.candidates.delete(candidate_id: "id")
client.candidates.retrieve_consent(candidate_id: "id")
client.candidates.retrieve_consents(candidate_id: "id")
client.candidates.retrieve_application(candidate_id: "id", job_id: "id")
client.candidates.retrieve_application_attachments(candidate_id: "id", job_id: "id")
client.candidates.retrieve_status_history(candidate_id: "id", job_id: "id")

Interviews

client.interviews.create({})
client.interviews.retrieve(interview_id: "id")
client.interviews.update(interview_id: "id", {})
client.interviews.delete(interview_id:)

Interview Types

client.interview_types.list
client.interview_types.create(interview_types: ["type"])
client.interview_types.delete(interview_type: "type")

Jobs

client.jobs.list
client.jobs.retrieve(job_id: "id")
client.jobs.list_hiring_team(job_id: "id")

Offers

client.offers.list
client.offers.retrieve(offer_id: "id", candidate_id: "id", job_id: "id")
client.offers.retrieve_offers(candidate_id: "id", job_id: "id")

Reports

client.reports.list
client.reports.retrieve(report_id: "id")
client.reports.retrieve_files(report_id: "id")
client.reports.generate_report(report_id: "id")
client.reports.retrieve_recent_file(report_id: "id")
client.reports.retrieve_recent_file_data(report_id: "id")

Reviews

client.reviews.list
client.reviews.create({})
client.reviews.retrieve(review_id: "id")
client.reviews.update(review_id: "id", {})
client.reviews.delete(review_id: "id", reviewer_id: "id")

System Roles

client.system_roles.list

Users

client.users.list
client.users.create({})
client.users.retrieve(user_id: "id")
client.users.update(user_id: "id", changes: ['changes'])
client.users.activate(user_id: "id")
client.users.activation_email(user_id: "id")
client.users.deactivate(user_id: "id")

Webhooks

client.webhooks.list
client.webhooks.create({})
client.webhooks.retrieve(webhook_id: "id")
client.webhooks.delete(webhook_id: "id")
client.webhooks.activate(webhook_id: "id")
client.webhooks.callbacks_log(webhook_id: "id")
client.webhooks.generate_secret(webhook_id: "id")
client.webhooks.retrieve_secret(webhook_id: "id")

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/davejcameron/smartrecruiters. 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 SmartRecruiters project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.