merge_hris_client

MergeHRISClient - the Ruby gem for the Merge HRIS API

The unified API for building rich integrations with multiple HR Information System platforms.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.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_hris_client.gemspec

Then either install the gem locally:

gem install ./merge_hris_client-1.0.0.gem

(for development, run gem install --dev ./merge_hris_client-1.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_hris_client', '~> 1.0.0'

Install from Git

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

gem 'merge_hris_client', :git => 'https://github.com/merge-api/merge-hris-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_hris_client'

# Setup authorization
MergeHRISClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = MergeHRISClient::AccountTokenApi.new
public_token = 'public_token_example' # String | 

begin
  result = api_instance.account_token_retrieve(public_token)
  p result
rescue MergeHRISClient::ApiError => e
  puts "Exception when calling AccountTokenApi->account_token_retrieve: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
MergeHRISClient::AccountTokenApi	account_token_retrieve	GET /account-token/public_token
MergeHRISClient::AvailableActionsApi	available_actions_retrieve	GET /available-actions
MergeHRISClient::BenefitsApi	benefits_create	POST /benefits
MergeHRISClient::BenefitsApi	benefits_list	GET /benefits
MergeHRISClient::BenefitsApi	benefits_retrieve	GET /benefits/id
MergeHRISClient::CompaniesApi	companies_list	GET /companies
MergeHRISClient::CompaniesApi	companies_retrieve	GET /companies/id
MergeHRISClient::DeleteAccountApi	delete_account_create	POST /delete-account
MergeHRISClient::EmployeePayrollRunsApi	employee_payroll_runs_list	GET /employee-payroll-runs
MergeHRISClient::EmployeePayrollRunsApi	employee_payroll_runs_retrieve	GET /employee-payroll-runs/id
MergeHRISClient::EmployeesApi	employees_create	POST /employees
MergeHRISClient::EmployeesApi	employees_list	GET /employees
MergeHRISClient::EmployeesApi	employees_retrieve	GET /employees/id
MergeHRISClient::EmploymentsApi	employments_create	POST /employments
MergeHRISClient::EmploymentsApi	employments_list	GET /employments
MergeHRISClient::EmploymentsApi	employments_retrieve	GET /employments/id
MergeHRISClient::GenerateKeyApi	generate_key_create	POST /generate-key
MergeHRISClient::IssuesApi	issues_list	GET /issues
MergeHRISClient::IssuesApi	issues_retrieve	GET /issues/id
MergeHRISClient::LinkTokenApi	link_token_create	POST /link-token
MergeHRISClient::LocationsApi	locations_list	GET /locations
MergeHRISClient::LocationsApi	locations_retrieve	GET /locations/id
MergeHRISClient::PassthroughApi	passthrough_create	POST /passthrough
MergeHRISClient::PayrollRunsApi	payroll_runs_list	GET /payroll-runs
MergeHRISClient::PayrollRunsApi	payroll_runs_retrieve	GET /payroll-runs/id
MergeHRISClient::RegenerateKeyApi	regenerate_key_create	POST /regenerate-key
MergeHRISClient::SyncStatusApi	sync_status_list	GET /sync-status
MergeHRISClient::SyncStatusApi	sync_status_resync_create	POST /sync-status/resync
MergeHRISClient::TeamsApi	teams_list	GET /teams
MergeHRISClient::TeamsApi	teams_retrieve	GET /teams/id
MergeHRISClient::TimeOffApi	time_off_list	GET /time-off
MergeHRISClient::TimeOffApi	time_off_retrieve	GET /time-off/id
MergeHRISClient::TimeOffBalanceApi	time_off_balance_list	GET /time-off-balance
MergeHRISClient::TimeOffBalanceApi	time_off_balance_retrieve	GET /time-off-balance/id

Documentation for Models

• MergeHRISClient::AccountIntegration
• MergeHRISClient::AccountToken
• MergeHRISClient::AvailableActions
• MergeHRISClient::Benefit
• MergeHRISClient::BenefitPlanTypeEnum
• MergeHRISClient::BenefitRequest
• MergeHRISClient::Company
• MergeHRISClient::CountryEnum
• MergeHRISClient::DataPassthroughRequest
• MergeHRISClient::Deduction
• MergeHRISClient::Earning
• MergeHRISClient::Employee
• MergeHRISClient::EmployeePayrollRun
• MergeHRISClient::EmployeeRequest
• MergeHRISClient::Employment
• MergeHRISClient::EmploymentRequest
• MergeHRISClient::EmploymentStatusEnum
• MergeHRISClient::EmploymentTypeEnum
• MergeHRISClient::EndUserDetailsRequest
• MergeHRISClient::EthnicityEnum
• MergeHRISClient::FlsaStatusEnum
• MergeHRISClient::GenderEnum
• MergeHRISClient::GenerateRemoteKeyRequest
• MergeHRISClient::Issue
• MergeHRISClient::IssueStatusEnum
• MergeHRISClient::LinkToken
• MergeHRISClient::Location
• MergeHRISClient::MaritalStatusEnum
• MergeHRISClient::MethodEnum
• MergeHRISClient::ModelOperation
• MergeHRISClient::PaginatedBenefitList
• MergeHRISClient::PaginatedCompanyList
• MergeHRISClient::PaginatedEmployeeList
• MergeHRISClient::PaginatedEmployeePayrollRunList
• MergeHRISClient::PaginatedEmploymentList
• MergeHRISClient::PaginatedIssueList
• MergeHRISClient::PaginatedLocationList
• MergeHRISClient::PaginatedPayrollRunList
• MergeHRISClient::PaginatedSyncStatusList
• MergeHRISClient::PaginatedTeamList
• MergeHRISClient::PaginatedTimeOffBalanceList
• MergeHRISClient::PaginatedTimeOffList
• MergeHRISClient::PayCurrencyEnum
• MergeHRISClient::PayFrequencyEnum
• MergeHRISClient::PayPeriodEnum
• MergeHRISClient::PayrollRun
• MergeHRISClient::RemoteData
• MergeHRISClient::RemoteDataRequest
• MergeHRISClient::RemoteKey
• MergeHRISClient::RemoteKeyForRegenerationRequest
• MergeHRISClient::RemoteResponse
• MergeHRISClient::RequestTypeEnum
• MergeHRISClient::RunStateEnum
• MergeHRISClient::RunTypeEnum
• MergeHRISClient::SyncStatus
• MergeHRISClient::SyncStatusStatusEnum
• MergeHRISClient::Tax
• MergeHRISClient::Team
• MergeHRISClient::TimeOff
• MergeHRISClient::TimeOffBalance
• MergeHRISClient::TimeOffStatusEnum
• MergeHRISClient::TypeEnum
• MergeHRISClient::UnitsEnum

Documentation for Authorization

tokenAuth

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