https://github.com/merge-api/merge-hris-javascript

The Javascript API Client for the Merge HRIS API.
https://github.com/merge-api/merge-hris-javascript
Last synced: 4 months ago
JSON representation
The Javascript API Client for the Merge HRIS API.
Host: GitHub
URL: https://github.com/merge-api/merge-hris-javascript
Owner: merge-api
License: other
Created: 2021-03-12T02:17:03.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2023-01-24T04:59:13.000Z (over 3 years ago)
Last Synced: 2023-08-02T08:59:42.145Z (almost 3 years ago)
Language: JavaScript
Size: 521 KB
Stars: 1
Watchers: 11
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project

README

          ## Deprecation Notice

Merge has released a new version of our [Typescript SDK](https://github.com/merge-api/merge-node-client/). As part of that release, we are providing a deprecation notice of our legacy SDKs.

To help give you time to plan your migration to our latest SDK:

- August 2023: SDK deprecation notice on our legacy Javascript SDKs.

- Until February 2024: we’ll support updates as needed and address bugs in priority order

- After February 2024: we’ll no longer make updates or bug fixes to the deprecated SDKs

For information about the deprecation notice see our [help center](https://help.merge.dev/en/collections/4258952-sdks) and for information about migrating to the Typescript SDK, see the [Typescript Migration Guide](https://help.merge.dev/en/articles/8229417-advanced-node-sdk-migration-guide).

# 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](https://openapi-generator.tech) 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/](https://www.merge.dev/)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

Install the library via:

```shell

npm install @mergeapi/merge_hris_api --save

```

Finally, you need to build the module:

```shell

npm run build

```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell

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:

```javascript

module: {

  rules: [

    {

      parser: {

        amd: false

      }

    }

  ]

}

```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript

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**](docs/AccountDetailsApi.md#accountDetailsRetrieve) | **GET** /account-details | 

*MergeHrisApi.AccountTokenApi* | [**accountTokenRetrieve**](docs/AccountTokenApi.md#accountTokenRetrieve) | **GET** /account-token/{public_token} | 

*MergeHrisApi.AvailableActionsApi* | [**availableActionsRetrieve**](docs/AvailableActionsApi.md#availableActionsRetrieve) | **GET** /available-actions | 

*MergeHrisApi.BankInfoApi* | [**bankInfoList**](docs/BankInfoApi.md#bankInfoList) | **GET** /bank-info | 

*MergeHrisApi.BankInfoApi* | [**bankInfoRetrieve**](docs/BankInfoApi.md#bankInfoRetrieve) | **GET** /bank-info/{id} | 

*MergeHrisApi.BenefitsApi* | [**benefitsList**](docs/BenefitsApi.md#benefitsList) | **GET** /benefits | 

*MergeHrisApi.BenefitsApi* | [**benefitsRetrieve**](docs/BenefitsApi.md#benefitsRetrieve) | **GET** /benefits/{id} | 

*MergeHrisApi.CompaniesApi* | [**companiesList**](docs/CompaniesApi.md#companiesList) | **GET** /companies | 

*MergeHrisApi.CompaniesApi* | [**companiesRetrieve**](docs/CompaniesApi.md#companiesRetrieve) | **GET** /companies/{id} | 

*MergeHrisApi.DeductionsApi* | [**deductionsList**](docs/DeductionsApi.md#deductionsList) | **GET** /deductions | 

*MergeHrisApi.DeductionsApi* | [**deductionsRetrieve**](docs/DeductionsApi.md#deductionsRetrieve) | **GET** /deductions/{id} | 

*MergeHrisApi.DeleteAccountApi* | [**deleteAccountCreate**](docs/DeleteAccountApi.md#deleteAccountCreate) | **POST** /delete-account | 

*MergeHrisApi.EmployeePayrollRunsApi* | [**employeePayrollRunsList**](docs/EmployeePayrollRunsApi.md#employeePayrollRunsList) | **GET** /employee-payroll-runs | 

*MergeHrisApi.EmployeePayrollRunsApi* | [**employeePayrollRunsRetrieve**](docs/EmployeePayrollRunsApi.md#employeePayrollRunsRetrieve) | **GET** /employee-payroll-runs/{id} | 

*MergeHrisApi.EmployeesApi* | [**employeesCreate**](docs/EmployeesApi.md#employeesCreate) | **POST** /employees | 

*MergeHrisApi.EmployeesApi* | [**employeesIgnoreCreate**](docs/EmployeesApi.md#employeesIgnoreCreate) | **POST** /employees/ignore/{model_id} | 

*MergeHrisApi.EmployeesApi* | [**employeesList**](docs/EmployeesApi.md#employeesList) | **GET** /employees | 

*MergeHrisApi.EmployeesApi* | [**employeesMetaPostRetrieve**](docs/EmployeesApi.md#employeesMetaPostRetrieve) | **GET** /employees/meta/post | 

*MergeHrisApi.EmployeesApi* | [**employeesRetrieve**](docs/EmployeesApi.md#employeesRetrieve) | **GET** /employees/{id} | 

*MergeHrisApi.EmploymentsApi* | [**employmentsList**](docs/EmploymentsApi.md#employmentsList) | **GET** /employments | 

*MergeHrisApi.EmploymentsApi* | [**employmentsRetrieve**](docs/EmploymentsApi.md#employmentsRetrieve) | **GET** /employments/{id} | 

*MergeHrisApi.ForceResyncApi* | [**syncStatusResyncCreate**](docs/ForceResyncApi.md#syncStatusResyncCreate) | **POST** /sync-status/resync | 

*MergeHrisApi.GenerateKeyApi* | [**generateKeyCreate**](docs/GenerateKeyApi.md#generateKeyCreate) | **POST** /generate-key | 

*MergeHrisApi.GroupsApi* | [**groupsList**](docs/GroupsApi.md#groupsList) | **GET** /groups | 

*MergeHrisApi.GroupsApi* | [**groupsRetrieve**](docs/GroupsApi.md#groupsRetrieve) | **GET** /groups/{id} | 

*MergeHrisApi.IssuesApi* | [**issuesList**](docs/IssuesApi.md#issuesList) | **GET** /issues | 

*MergeHrisApi.IssuesApi* | [**issuesRetrieve**](docs/IssuesApi.md#issuesRetrieve) | **GET** /issues/{id} | 

*MergeHrisApi.LinkTokenApi* | [**linkTokenCreate**](docs/LinkTokenApi.md#linkTokenCreate) | **POST** /link-token | 

*MergeHrisApi.LinkedAccountsApi* | [**linkedAccountsList**](docs/LinkedAccountsApi.md#linkedAccountsList) | **GET** /linked-accounts | 

*MergeHrisApi.LocationsApi* | [**locationsList**](docs/LocationsApi.md#locationsList) | **GET** /locations | 

*MergeHrisApi.LocationsApi* | [**locationsRetrieve**](docs/LocationsApi.md#locationsRetrieve) | **GET** /locations/{id} | 

*MergeHrisApi.PassthroughApi* | [**passthroughCreate**](docs/PassthroughApi.md#passthroughCreate) | **POST** /passthrough | 

*MergeHrisApi.PayGroupsApi* | [**payGroupsList**](docs/PayGroupsApi.md#payGroupsList) | **GET** /pay-groups | 

*MergeHrisApi.PayGroupsApi* | [**payGroupsRetrieve**](docs/PayGroupsApi.md#payGroupsRetrieve) | **GET** /pay-groups/{id} | 

*MergeHrisApi.PayrollRunsApi* | [**payrollRunsList**](docs/PayrollRunsApi.md#payrollRunsList) | **GET** /payroll-runs | 

*MergeHrisApi.PayrollRunsApi* | [**payrollRunsRetrieve**](docs/PayrollRunsApi.md#payrollRunsRetrieve) | **GET** /payroll-runs/{id} | 

*MergeHrisApi.RegenerateKeyApi* | [**regenerateKeyCreate**](docs/RegenerateKeyApi.md#regenerateKeyCreate) | **POST** /regenerate-key | 

*MergeHrisApi.SyncStatusApi* | [**syncStatusList**](docs/SyncStatusApi.md#syncStatusList) | **GET** /sync-status | 

*MergeHrisApi.TeamsApi* | [**teamsList**](docs/TeamsApi.md#teamsList) | **GET** /teams | 

*MergeHrisApi.TeamsApi* | [**teamsRetrieve**](docs/TeamsApi.md#teamsRetrieve) | **GET** /teams/{id} | 

*MergeHrisApi.TimeOffApi* | [**timeOffCreate**](docs/TimeOffApi.md#timeOffCreate) | **POST** /time-off | 

*MergeHrisApi.TimeOffApi* | [**timeOffList**](docs/TimeOffApi.md#timeOffList) | **GET** /time-off | 

*MergeHrisApi.TimeOffApi* | [**timeOffMetaPostRetrieve**](docs/TimeOffApi.md#timeOffMetaPostRetrieve) | **GET** /time-off/meta/post | 

*MergeHrisApi.TimeOffApi* | [**timeOffRetrieve**](docs/TimeOffApi.md#timeOffRetrieve) | **GET** /time-off/{id} | 

*MergeHrisApi.TimeOffBalancesApi* | [**timeOffBalancesList**](docs/TimeOffBalancesApi.md#timeOffBalancesList) | **GET** /time-off-balances | 

*MergeHrisApi.TimeOffBalancesApi* | [**timeOffBalancesRetrieve**](docs/TimeOffBalancesApi.md#timeOffBalancesRetrieve) | **GET** /time-off-balances/{id} | 

*MergeHrisApi.WebhookReceiversApi* | [**webhookReceiversCreate**](docs/WebhookReceiversApi.md#webhookReceiversCreate) | **POST** /webhook-receivers | 

*MergeHrisApi.WebhookReceiversApi* | [**webhookReceiversList**](docs/WebhookReceiversApi.md#webhookReceiversList) | **GET** /webhook-receivers | 

## Documentation for Models

 - [MergeHrisApi.AccountDetails](docs/AccountDetails.md)

 - [MergeHrisApi.AccountDetailsAndActions](docs/AccountDetailsAndActions.md)

 - [MergeHrisApi.AccountDetailsAndActionsIntegration](docs/AccountDetailsAndActionsIntegration.md)

 - [MergeHrisApi.AccountDetailsAndActionsStatusEnum](docs/AccountDetailsAndActionsStatusEnum.md)

 - [MergeHrisApi.AccountIntegration](docs/AccountIntegration.md)

 - [MergeHrisApi.AccountToken](docs/AccountToken.md)

 - [MergeHrisApi.AccountTypeEnum](docs/AccountTypeEnum.md)

 - [MergeHrisApi.AvailableActions](docs/AvailableActions.md)

 - [MergeHrisApi.BankInfo](docs/BankInfo.md)

 - [MergeHrisApi.Benefit](docs/Benefit.md)

 - [MergeHrisApi.CategoriesEnum](docs/CategoriesEnum.md)

 - [MergeHrisApi.CategoryEnum](docs/CategoryEnum.md)

 - [MergeHrisApi.Company](docs/Company.md)

 - [MergeHrisApi.CountryEnum](docs/CountryEnum.md)

 - [MergeHrisApi.DataPassthroughRequest](docs/DataPassthroughRequest.md)

 - [MergeHrisApi.DebugModeLog](docs/DebugModeLog.md)

 - [MergeHrisApi.DebugModelLogSummary](docs/DebugModelLogSummary.md)

 - [MergeHrisApi.Deduction](docs/Deduction.md)

 - [MergeHrisApi.Earning](docs/Earning.md)

 - [MergeHrisApi.EarningTypeEnum](docs/EarningTypeEnum.md)

 - [MergeHrisApi.Employee](docs/Employee.md)

 - [MergeHrisApi.EmployeeEndpointRequest](docs/EmployeeEndpointRequest.md)

 - [MergeHrisApi.EmployeePayrollRun](docs/EmployeePayrollRun.md)

 - [MergeHrisApi.EmployeeRequest](docs/EmployeeRequest.md)

 - [MergeHrisApi.EmployeeResponse](docs/EmployeeResponse.md)

 - [MergeHrisApi.Employment](docs/Employment.md)

 - [MergeHrisApi.EmploymentStatusEnum](docs/EmploymentStatusEnum.md)

 - [MergeHrisApi.EmploymentTypeEnum](docs/EmploymentTypeEnum.md)

 - [MergeHrisApi.EncodingEnum](docs/EncodingEnum.md)

 - [MergeHrisApi.EndUserDetailsRequest](docs/EndUserDetailsRequest.md)

 - [MergeHrisApi.ErrorValidationProblem](docs/ErrorValidationProblem.md)

 - [MergeHrisApi.EthnicityEnum](docs/EthnicityEnum.md)

 - [MergeHrisApi.FlsaStatusEnum](docs/FlsaStatusEnum.md)

 - [MergeHrisApi.GenderEnum](docs/GenderEnum.md)

 - [MergeHrisApi.GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)

 - [MergeHrisApi.Group](docs/Group.md)

 - [MergeHrisApi.GroupTypeEnum](docs/GroupTypeEnum.md)

 - [MergeHrisApi.IgnoreCommonModel](docs/IgnoreCommonModel.md)

 - [MergeHrisApi.IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)

 - [MergeHrisApi.Issue](docs/Issue.md)

 - [MergeHrisApi.IssueStatusEnum](docs/IssueStatusEnum.md)

 - [MergeHrisApi.LinkToken](docs/LinkToken.md)

 - [MergeHrisApi.LinkedAccountStatus](docs/LinkedAccountStatus.md)

 - [MergeHrisApi.Location](docs/Location.md)

 - [MergeHrisApi.LocationTypeEnum](docs/LocationTypeEnum.md)

 - [MergeHrisApi.MaritalStatusEnum](docs/MaritalStatusEnum.md)

 - [MergeHrisApi.MetaResponse](docs/MetaResponse.md)

 - [MergeHrisApi.MethodEnum](docs/MethodEnum.md)

 - [MergeHrisApi.ModelOperation](docs/ModelOperation.md)

 - [MergeHrisApi.MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)

 - [MergeHrisApi.PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)

 - [MergeHrisApi.PaginatedBankInfoList](docs/PaginatedBankInfoList.md)

 - [MergeHrisApi.PaginatedBenefitList](docs/PaginatedBenefitList.md)

 - [MergeHrisApi.PaginatedCompanyList](docs/PaginatedCompanyList.md)

 - [MergeHrisApi.PaginatedDeductionList](docs/PaginatedDeductionList.md)

 - [MergeHrisApi.PaginatedEmployeeList](docs/PaginatedEmployeeList.md)

 - [MergeHrisApi.PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)

 - [MergeHrisApi.PaginatedEmploymentList](docs/PaginatedEmploymentList.md)

 - [MergeHrisApi.PaginatedGroupList](docs/PaginatedGroupList.md)

 - [MergeHrisApi.PaginatedIssueList](docs/PaginatedIssueList.md)

 - [MergeHrisApi.PaginatedLocationList](docs/PaginatedLocationList.md)

 - [MergeHrisApi.PaginatedPayGroupList](docs/PaginatedPayGroupList.md)

 - [MergeHrisApi.PaginatedPayrollRunList](docs/PaginatedPayrollRunList.md)

 - [MergeHrisApi.PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)

 - [MergeHrisApi.PaginatedTeamList](docs/PaginatedTeamList.md)

 - [MergeHrisApi.PaginatedTimeOffBalanceList](docs/PaginatedTimeOffBalanceList.md)

 - [MergeHrisApi.PaginatedTimeOffList](docs/PaginatedTimeOffList.md)

 - [MergeHrisApi.PayCurrencyEnum](docs/PayCurrencyEnum.md)

 - [MergeHrisApi.PayFrequencyEnum](docs/PayFrequencyEnum.md)

 - [MergeHrisApi.PayGroup](docs/PayGroup.md)

 - [MergeHrisApi.PayPeriodEnum](docs/PayPeriodEnum.md)

 - [MergeHrisApi.PayrollRun](docs/PayrollRun.md)

 - [MergeHrisApi.PolicyTypeEnum](docs/PolicyTypeEnum.md)

 - [MergeHrisApi.ReasonEnum](docs/ReasonEnum.md)

 - [MergeHrisApi.RemoteData](docs/RemoteData.md)

 - [MergeHrisApi.RemoteKey](docs/RemoteKey.md)

 - [MergeHrisApi.RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)

 - [MergeHrisApi.RemoteResponse](docs/RemoteResponse.md)

 - [MergeHrisApi.RequestFormatEnum](docs/RequestFormatEnum.md)

 - [MergeHrisApi.RequestTypeEnum](docs/RequestTypeEnum.md)

 - [MergeHrisApi.RunStateEnum](docs/RunStateEnum.md)

 - [MergeHrisApi.RunTypeEnum](docs/RunTypeEnum.md)

 - [MergeHrisApi.SyncStatus](docs/SyncStatus.md)

 - [MergeHrisApi.SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)

 - [MergeHrisApi.Tax](docs/Tax.md)

 - [MergeHrisApi.Team](docs/Team.md)

 - [MergeHrisApi.TimeOff](docs/TimeOff.md)

 - [MergeHrisApi.TimeOffBalance](docs/TimeOffBalance.md)

 - [MergeHrisApi.TimeOffEndpointRequest](docs/TimeOffEndpointRequest.md)

 - [MergeHrisApi.TimeOffRequest](docs/TimeOffRequest.md)

 - [MergeHrisApi.TimeOffResponse](docs/TimeOffResponse.md)

 - [MergeHrisApi.TimeOffStatusEnum](docs/TimeOffStatusEnum.md)

 - [MergeHrisApi.UnitsEnum](docs/UnitsEnum.md)

 - [MergeHrisApi.ValidationProblemSource](docs/ValidationProblemSource.md)

 - [MergeHrisApi.WarningValidationProblem](docs/WarningValidationProblem.md)

 - [MergeHrisApi.WebhookReceiver](docs/WebhookReceiver.md)

 - [MergeHrisApi.WebhookReceiverRequest](docs/WebhookReceiverRequest.md)

## Documentation for Authorization

### tokenAuth

- **Type**: API key

- **API key parameter name**: Authorization

- **Location**: HTTP header
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/merge-api/merge-hris-javascript

Awesome Lists containing this project

README
