@mergeapi/merge_hris_api

v1.0.13

Published

a year ago

The_unified_API_for_building_rich_integrations_with_multiple_HR_Information_System_platforms_

Downloads

6,150

0High
0Medium
0Low

merge_hris_api

MergeHrisApi - JavaScript client for 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.13
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.merge.dev/

Installation

For Node.js

npm

Install the library via:

npm install @mergeapi/merge_hris_api --save

Finally, you need to build the module:

npm run build

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var MergeHrisApi = require('merge_hris_api');

var defaultClient = MergeHrisApi.ApiClient.instance;
// Configure API key authorization: tokenAuth
defaultClient.authentications['tokenAuth'] = {type: "bearer", accessToken: "YOUR_API_KEY"}

var api = new MergeHrisApi.AccountTokenApi()
var publicToken = "publicToken_example"; // {String}
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountTokenRetrieve(publicToken, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MergeHrisApi.AccountDetailsApi | accountDetailsRetrieve | GET /account-details | MergeHrisApi.AccountTokenApi | accountTokenRetrieve | GET /account-token/{public_token} | MergeHrisApi.AvailableActionsApi | availableActionsRetrieve | GET /available-actions | MergeHrisApi.BankInfoApi | bankInfoList | GET /bank-info | MergeHrisApi.BankInfoApi | bankInfoRetrieve | GET /bank-info/{id} | MergeHrisApi.BenefitsApi | benefitsList | GET /benefits | MergeHrisApi.BenefitsApi | benefitsRetrieve | GET /benefits/{id} | MergeHrisApi.CompaniesApi | companiesList | GET /companies | MergeHrisApi.CompaniesApi | companiesRetrieve | GET /companies/{id} | MergeHrisApi.DeductionsApi | deductionsList | GET /deductions | MergeHrisApi.DeductionsApi | deductionsRetrieve | GET /deductions/{id} | MergeHrisApi.DeleteAccountApi | deleteAccountCreate | POST /delete-account | MergeHrisApi.EmployeePayrollRunsApi | employeePayrollRunsList | GET /employee-payroll-runs | MergeHrisApi.EmployeePayrollRunsApi | employeePayrollRunsRetrieve | GET /employee-payroll-runs/{id} | MergeHrisApi.EmployeesApi | employeesCreate | POST /employees | MergeHrisApi.EmployeesApi | employeesIgnoreCreate | POST /employees/ignore/{model_id} | MergeHrisApi.EmployeesApi | employeesList | GET /employees | MergeHrisApi.EmployeesApi | employeesMetaPostRetrieve | GET /employees/meta/post | MergeHrisApi.EmployeesApi | employeesRetrieve | GET /employees/{id} | MergeHrisApi.EmploymentsApi | employmentsList | GET /employments | MergeHrisApi.EmploymentsApi | employmentsRetrieve | GET /employments/{id} | MergeHrisApi.ForceResyncApi | syncStatusResyncCreate | POST /sync-status/resync | MergeHrisApi.GenerateKeyApi | generateKeyCreate | POST /generate-key | MergeHrisApi.GroupsApi | groupsList | GET /groups | MergeHrisApi.GroupsApi | groupsRetrieve | GET /groups/{id} | MergeHrisApi.IssuesApi | issuesList | GET /issues | MergeHrisApi.IssuesApi | issuesRetrieve | GET /issues/{id} | MergeHrisApi.LinkTokenApi | linkTokenCreate | POST /link-token | MergeHrisApi.LinkedAccountsApi | linkedAccountsList | GET /linked-accounts | MergeHrisApi.LocationsApi | locationsList | GET /locations | MergeHrisApi.LocationsApi | locationsRetrieve | GET /locations/{id} | MergeHrisApi.PassthroughApi | passthroughCreate | POST /passthrough | MergeHrisApi.PayGroupsApi | payGroupsList | GET /pay-groups | MergeHrisApi.PayGroupsApi | payGroupsRetrieve | GET /pay-groups/{id} | MergeHrisApi.PayrollRunsApi | payrollRunsList | GET /payroll-runs | MergeHrisApi.PayrollRunsApi | payrollRunsRetrieve | GET /payroll-runs/{id} | MergeHrisApi.RegenerateKeyApi | regenerateKeyCreate | POST /regenerate-key | MergeHrisApi.SyncStatusApi | syncStatusList | GET /sync-status | MergeHrisApi.TeamsApi | teamsList | GET /teams | MergeHrisApi.TeamsApi | teamsRetrieve | GET /teams/{id} | MergeHrisApi.TimeOffApi | timeOffCreate | POST /time-off | MergeHrisApi.TimeOffApi | timeOffList | GET /time-off | MergeHrisApi.TimeOffApi | timeOffMetaPostRetrieve | GET /time-off/meta/post | MergeHrisApi.TimeOffApi | timeOffRetrieve | GET /time-off/{id} | MergeHrisApi.TimeOffBalancesApi | timeOffBalancesList | GET /time-off-balances | MergeHrisApi.TimeOffBalancesApi | timeOffBalancesRetrieve | GET /time-off-balances/{id} | MergeHrisApi.WebhookReceiversApi | webhookReceiversCreate | POST /webhook-receivers | MergeHrisApi.WebhookReceiversApi | webhookReceiversList | GET /webhook-receivers |

Documentation for Models

Documentation for Authorization

tokenAuth

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

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme