Skip to content

Commit 013a10f

Browse files
committed
Update README.md
1 parent e8aea62 commit 013a10f

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
1-
# example-api-client
1+
# hailey-api-client
22

3-
**ExampleApiClient** is a third party [Example API](https://example.com/docs/) client for NodeJS. It is a wrapper around an API client that has been [automatically generated](https://www.npmjs.com/package/swagger-typescript-api) using the [OpenAPI schema](https://example.com/openapi.json) provided by Example.
3+
**HaileyApiClient** is a third party [Hailey API](https://api.haileyhr.app/docs/) client for NodeJS. It is a wrapper around an API client that has been [automatically generated](https://www.npmjs.com/package/swagger-typescript-api) using the [OpenAPI schema](https://api.haileyhr.app/docs/v1/docs.json) provided by Hailey.
44

55
## Installation
66

77
Add to project's package.json:
88

99
```
10-
npm install @rantalainen/example-api-client
10+
npm install @rantalainen/hailey-api-client
1111
```
1212

1313
### Import
1414

1515
```javascript
16-
import { ExampleApiClient } from '@rantalainen/example-api-client';
16+
import { HaileyApiClient } from '@rantalainen/hailey-api-client';
1717
```
1818

1919
## Setup client with options
2020

21-
In order to obtain an API key, please contact Example Support. An API key is needed to access all API functions.
21+
In order to obtain an API key, please contact Hailey Support. An API key is needed to access all API functions.
2222

2323
```javascript
24-
const example = new ExampleApiClient(
24+
const hailey = new HaileyApiClient(
2525
{
26-
apiKey: 'api_key'
26+
accessToken: 'accessToken'
2727
},
2828
{
29-
baseURL: 'https://dev.example.com'
29+
baseURL: 'https://api.demo.haileyhr.app/'
3030
}
3131
);
32+
33+
const response = await hailey.api.employees.employeesList();
3234
```
3335

34-
Available methods can be found in the [API documentation](https://example.com/docs/).
36+
Available methods can be found in the [API documentation](https://api.haileyhr.app/docs/).
3537

3638
## Resources
3739

38-
- Example: https://example.com/
39-
- Example Developer Guide: https://example.com/docs/
40+
- Hailey HR: https://haileyhr.com/
41+
- Hailey HR API Guide: https://docs.haileyhr.com/
42+
- Hailey HR Integration Docs: https://docs.haileyhr.com/integrations/

0 commit comments

Comments
 (0)