Skip to content

Latest commit

 

History

History
304 lines (264 loc) · 20.9 KB

README.md

File metadata and controls

304 lines (264 loc) · 20.9 KB
Raw

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: 3.2.2
  • 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-3.2.2.gem

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

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['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 = MergeHRISClient::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 MergeHRISClient::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/hris/v1

Class Method HTTP request Description
MergeHRISClient::AccountDetailsApi account_details_retrieve GET /account-details
MergeHRISClient::AccountTokenApi account_token_retrieve GET /account-token/{public_token}
MergeHRISClient::AsyncPassthroughApi async_passthrough_create POST /async-passthrough
MergeHRISClient::AsyncPassthroughApi async_passthrough_retrieve GET /async-passthrough/{async_passthrough_receipt_id}
MergeHRISClient::AuditTrailApi audit_trail_list GET /audit-trail
MergeHRISClient::AvailableActionsApi available_actions_retrieve GET /available-actions
MergeHRISClient::BankInfoApi bank_info_list GET /bank-info
MergeHRISClient::BankInfoApi bank_info_retrieve GET /bank-info/{id}
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_delete POST /delete-account
MergeHRISClient::DependentsApi dependents_list GET /dependents
MergeHRISClient::DependentsApi dependents_retrieve GET /dependents/{id}
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_ignore_create POST /employees/ignore/{model_id}
MergeHRISClient::EmployeesApi employees_list GET /employees
MergeHRISClient::EmployeesApi employees_meta_post_retrieve GET /employees/meta/post
MergeHRISClient::EmployeesApi employees_retrieve GET /employees/{id}
MergeHRISClient::EmployerBenefitsApi employer_benefits_list GET /employer-benefits
MergeHRISClient::EmployerBenefitsApi employer_benefits_retrieve GET /employer-benefits/{id}
MergeHRISClient::EmploymentsApi employments_list GET /employments
MergeHRISClient::EmploymentsApi employments_retrieve GET /employments/{id}
MergeHRISClient::FieldMappingApi field_mappings_create POST /field-mappings
MergeHRISClient::FieldMappingApi field_mappings_destroy DELETE /field-mappings/{field_mapping_id}
MergeHRISClient::FieldMappingApi field_mappings_partial_update PATCH /field-mappings/{field_mapping_id}
MergeHRISClient::FieldMappingApi field_mappings_retrieve GET /field-mappings
MergeHRISClient::FieldMappingApi remote_fields_retrieve GET /remote-fields
MergeHRISClient::FieldMappingApi target_fields_retrieve GET /target-fields
MergeHRISClient::ForceResyncApi sync_status_resync_create POST /sync-status/resync
MergeHRISClient::GenerateKeyApi generate_key_create POST /generate-key
MergeHRISClient::GroupsApi groups_list GET /groups
MergeHRISClient::GroupsApi groups_retrieve GET /groups/{id}
MergeHRISClient::IssuesApi issues_list GET /issues
MergeHRISClient::IssuesApi issues_retrieve GET /issues/{id}
MergeHRISClient::LinkTokenApi link_token_create POST /link-token
MergeHRISClient::LinkedAccountsApi linked_accounts_list GET /linked-accounts
MergeHRISClient::LocationsApi locations_list GET /locations
MergeHRISClient::LocationsApi locations_retrieve GET /locations/{id}
MergeHRISClient::PassthroughApi passthrough_create POST /passthrough
MergeHRISClient::PayGroupsApi pay_groups_list GET /pay-groups
MergeHRISClient::PayGroupsApi pay_groups_retrieve GET /pay-groups/{id}
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::ScopesApi default_scopes_retrieve GET /default-scopes
MergeHRISClient::ScopesApi linked_account_scopes_create POST /linked-account-scopes
MergeHRISClient::ScopesApi linked_account_scopes_retrieve GET /linked-account-scopes
MergeHRISClient::SyncStatusApi sync_status_list GET /sync-status
MergeHRISClient::TeamsApi teams_list GET /teams
MergeHRISClient::TeamsApi teams_retrieve GET /teams/{id}
MergeHRISClient::TimeOffApi time_off_create POST /time-off
MergeHRISClient::TimeOffApi time_off_list GET /time-off
MergeHRISClient::TimeOffApi time_off_meta_post_retrieve GET /time-off/meta/post
MergeHRISClient::TimeOffApi time_off_retrieve GET /time-off/{id}
MergeHRISClient::TimeOffBalancesApi time_off_balances_list GET /time-off-balances
MergeHRISClient::TimeOffBalancesApi time_off_balances_retrieve GET /time-off-balances/{id}
MergeHRISClient::TimesheetEntriesApi timesheet_entries_create POST /timesheet-entries
MergeHRISClient::TimesheetEntriesApi timesheet_entries_list GET /timesheet-entries
MergeHRISClient::TimesheetEntriesApi timesheet_entries_meta_post_retrieve GET /timesheet-entries/meta/post
MergeHRISClient::TimesheetEntriesApi timesheet_entries_retrieve GET /timesheet-entries/{id}
MergeHRISClient::WebhookReceiversApi webhook_receivers_create POST /webhook-receivers
MergeHRISClient::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