https://github.com/merge-api/merge-hris-node
The Node API Client for the Merge HRIS API.
https://github.com/merge-api/merge-hris-node
Last synced: 4 months ago
JSON representation
The Node API Client for the Merge HRIS API.
- Host: GitHub
- URL: https://github.com/merge-api/merge-hris-node
- Owner: merge-api
- Created: 2021-03-11T22:01:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-09T20:32:21.000Z (almost 3 years ago)
- Last Synced: 2025-10-30T01:56:20.183Z (8 months ago)
- Language: TypeScript
- Size: 752 KB
- Stars: 4
- Watchers: 9
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.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 Typescript 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 TypeScript SDK
The unified API for building rich integrations with multiple HR Information System platforms.
This TypeScript package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
* API version: 1.0
* Package version: 1.3.0
* Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen For more information, please visit https://www.merge.dev/
### Dependencies
* bluebird: ^3.5.0
* request: ^2.81.0
* @types/bluebird: *
* @types/request: *
* rewire: ^3.0.2
### Dev Dependencies
* typescript: ^4.3.3
* @types/node: ^15.12.2
Here is an example auth configuration for calling a Merge API:
```
import { AccountDetailsApi, HttpBearerAuth } from "@mergeapi/merge-hris-node";
const auth = new HttpBearerAuth();
auth.accessToken = "YOUR_API_KEY";
// Substitute AccountDetailsApi with the API you're trying to use
const apiInstance = new AccountDetailsApi();
apiInstance.setDefaultAuthentication(auth);
```