Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@mergeapi/merge_hris_api

Package Overview
Dependencies
Maintainers
4
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mergeapi/merge_hris_api

The_unified_API_for_building_rich_integrations_with_multiple_HR_Information_System_platforms_

  • 1.0.13
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
1.2K
increased by7.17%
Maintainers
4
Weekly downloads
 
Created
Source

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

ClassMethodHTTP requestDescription
MergeHrisApi.AccountDetailsApiaccountDetailsRetrieveGET /account-details
MergeHrisApi.AccountTokenApiaccountTokenRetrieveGET /account-token/{public_token}
MergeHrisApi.AvailableActionsApiavailableActionsRetrieveGET /available-actions
MergeHrisApi.BankInfoApibankInfoListGET /bank-info
MergeHrisApi.BankInfoApibankInfoRetrieveGET /bank-info/{id}
MergeHrisApi.BenefitsApibenefitsListGET /benefits
MergeHrisApi.BenefitsApibenefitsRetrieveGET /benefits/{id}
MergeHrisApi.CompaniesApicompaniesListGET /companies
MergeHrisApi.CompaniesApicompaniesRetrieveGET /companies/{id}
MergeHrisApi.DeductionsApideductionsListGET /deductions
MergeHrisApi.DeductionsApideductionsRetrieveGET /deductions/{id}
MergeHrisApi.DeleteAccountApideleteAccountCreatePOST /delete-account
MergeHrisApi.EmployeePayrollRunsApiemployeePayrollRunsListGET /employee-payroll-runs
MergeHrisApi.EmployeePayrollRunsApiemployeePayrollRunsRetrieveGET /employee-payroll-runs/{id}
MergeHrisApi.EmployeesApiemployeesCreatePOST /employees
MergeHrisApi.EmployeesApiemployeesIgnoreCreatePOST /employees/ignore/{model_id}
MergeHrisApi.EmployeesApiemployeesListGET /employees
MergeHrisApi.EmployeesApiemployeesMetaPostRetrieveGET /employees/meta/post
MergeHrisApi.EmployeesApiemployeesRetrieveGET /employees/{id}
MergeHrisApi.EmploymentsApiemploymentsListGET /employments
MergeHrisApi.EmploymentsApiemploymentsRetrieveGET /employments/{id}
MergeHrisApi.ForceResyncApisyncStatusResyncCreatePOST /sync-status/resync
MergeHrisApi.GenerateKeyApigenerateKeyCreatePOST /generate-key
MergeHrisApi.GroupsApigroupsListGET /groups
MergeHrisApi.GroupsApigroupsRetrieveGET /groups/{id}
MergeHrisApi.IssuesApiissuesListGET /issues
MergeHrisApi.IssuesApiissuesRetrieveGET /issues/{id}
MergeHrisApi.LinkTokenApilinkTokenCreatePOST /link-token
MergeHrisApi.LinkedAccountsApilinkedAccountsListGET /linked-accounts
MergeHrisApi.LocationsApilocationsListGET /locations
MergeHrisApi.LocationsApilocationsRetrieveGET /locations/{id}
MergeHrisApi.PassthroughApipassthroughCreatePOST /passthrough
MergeHrisApi.PayGroupsApipayGroupsListGET /pay-groups
MergeHrisApi.PayGroupsApipayGroupsRetrieveGET /pay-groups/{id}
MergeHrisApi.PayrollRunsApipayrollRunsListGET /payroll-runs
MergeHrisApi.PayrollRunsApipayrollRunsRetrieveGET /payroll-runs/{id}
MergeHrisApi.RegenerateKeyApiregenerateKeyCreatePOST /regenerate-key
MergeHrisApi.SyncStatusApisyncStatusListGET /sync-status
MergeHrisApi.TeamsApiteamsListGET /teams
MergeHrisApi.TeamsApiteamsRetrieveGET /teams/{id}
MergeHrisApi.TimeOffApitimeOffCreatePOST /time-off
MergeHrisApi.TimeOffApitimeOffListGET /time-off
MergeHrisApi.TimeOffApitimeOffMetaPostRetrieveGET /time-off/meta/post
MergeHrisApi.TimeOffApitimeOffRetrieveGET /time-off/{id}
MergeHrisApi.TimeOffBalancesApitimeOffBalancesListGET /time-off-balances
MergeHrisApi.TimeOffBalancesApitimeOffBalancesRetrieveGET /time-off-balances/{id}
MergeHrisApi.WebhookReceiversApiwebhookReceiversCreatePOST /webhook-receivers
MergeHrisApi.WebhookReceiversApiwebhookReceiversListGET /webhook-receivers

Documentation for Models

Documentation for Authorization

tokenAuth

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

Keywords

FAQs

Package last updated on 20 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc