/merge-ats-ruby

The Ruby API Client for the Merge ATS API.

Primary LanguageRuby

merge_ats_client

MergeATSClient - the Ruby gem for the Merge ATS API

The unified API for building rich integrations with multiple Applicant Tracking System platforms.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 2.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.merge.dev/

Installation

Build a gem

To build the Ruby code into a gem:

gem build merge_ats_client.gemspec

Then either install the gem locally:

gem install ./merge_ats_client-2.0.0.gem

(for development, run gem install --dev ./merge_ats_client-2.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'merge_ats_client', '~> 2.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/merge-api/merge-ats-ruby, then add the following in the Gemfile:

gem 'merge_ats_client', :git => 'https://github.com/merge-api/merge-ats-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'merge_ats_client'

# Setup authorization
MergeATSClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeATSClient::AccountDetailsApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.

begin
  result = api_instance.account_details_retrieve(x_account_token)
  p result
rescue MergeATSClient::ApiError => e
  puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/ats/v1

Class Method HTTP request Description
MergeATSClient::AccountDetailsApi account_details_retrieve GET /account-details
MergeATSClient::AccountTokenApi account_token_retrieve GET /account-token/{public_token}
MergeATSClient::ActivitiesApi activities_list GET /activities
MergeATSClient::ActivitiesApi activities_retrieve GET /activities/{id}
MergeATSClient::ApplicationsApi applications_create POST /applications
MergeATSClient::ApplicationsApi applications_list GET /applications
MergeATSClient::ApplicationsApi applications_meta_post_retrieve GET /applications/meta/post
MergeATSClient::ApplicationsApi applications_retrieve GET /applications/{id}
MergeATSClient::AttachmentsApi attachments_create POST /attachments
MergeATSClient::AttachmentsApi attachments_list GET /attachments
MergeATSClient::AttachmentsApi attachments_meta_post_retrieve GET /attachments/meta/post
MergeATSClient::AttachmentsApi attachments_retrieve GET /attachments/{id}
MergeATSClient::AvailableActionsApi available_actions_retrieve GET /available-actions
MergeATSClient::CandidatesApi candidates_create POST /candidates
MergeATSClient::CandidatesApi candidates_ignore_create POST /candidates/ignore/{model_id}
MergeATSClient::CandidatesApi candidates_list GET /candidates
MergeATSClient::CandidatesApi candidates_meta_post_retrieve GET /candidates/meta/post
MergeATSClient::CandidatesApi candidates_retrieve GET /candidates/{id}
MergeATSClient::DeleteAccountApi delete_account_create POST /delete-account
MergeATSClient::DepartmentsApi departments_list GET /departments
MergeATSClient::DepartmentsApi departments_retrieve GET /departments/{id}
MergeATSClient::EeocsApi eeocs_list GET /eeocs
MergeATSClient::EeocsApi eeocs_retrieve GET /eeocs/{id}
MergeATSClient::ForceResyncApi sync_status_resync_create POST /sync-status/resync
MergeATSClient::GenerateKeyApi generate_key_create POST /generate-key
MergeATSClient::InterviewsApi interviews_list GET /interviews
MergeATSClient::InterviewsApi interviews_retrieve GET /interviews/{id}
MergeATSClient::IssuesApi issues_list GET /issues
MergeATSClient::IssuesApi issues_retrieve GET /issues/{id}
MergeATSClient::JobInterviewStagesApi job_interview_stages_list GET /job-interview-stages
MergeATSClient::JobInterviewStagesApi job_interview_stages_retrieve GET /job-interview-stages/{id}
MergeATSClient::JobsApi jobs_list GET /jobs
MergeATSClient::JobsApi jobs_retrieve GET /jobs/{id}
MergeATSClient::LinkTokenApi link_token_create POST /link-token
MergeATSClient::LinkedAccountsApi linked_accounts_list GET /linked-accounts
MergeATSClient::OffersApi offers_list GET /offers
MergeATSClient::OffersApi offers_retrieve GET /offers/{id}
MergeATSClient::OfficesApi offices_list GET /offices
MergeATSClient::OfficesApi offices_retrieve GET /offices/{id}
MergeATSClient::PassthroughApi passthrough_create POST /passthrough
MergeATSClient::RegenerateKeyApi regenerate_key_create POST /regenerate-key
MergeATSClient::RejectReasonsApi reject_reasons_list GET /reject-reasons
MergeATSClient::RejectReasonsApi reject_reasons_retrieve GET /reject-reasons/{id}
MergeATSClient::ScorecardsApi scorecards_list GET /scorecards
MergeATSClient::ScorecardsApi scorecards_retrieve GET /scorecards/{id}
MergeATSClient::SyncStatusApi sync_status_list GET /sync-status
MergeATSClient::TagsApi tags_list GET /tags
MergeATSClient::UsersApi users_list GET /users
MergeATSClient::UsersApi users_retrieve GET /users/{id}
MergeATSClient::WebhookReceiversApi webhook_receivers_create POST /webhook-receivers
MergeATSClient::WebhookReceiversApi webhook_receivers_list GET /webhook-receivers

Documentation for Models

Documentation for Authorization

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header