@orchesty/connector-sage-hr 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -0
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Sage HR Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-sage-hr)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Sage HR, a cloud-based human resources management solution that helps you remotely track, manage, and engage your employees.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using an API key sent via the `X-Auth-Token` header. The base URL is built dynamically from your company subdomain: `https://{subdomain}.sage.hr/api/`.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `subdomain` | Your Sage HR company subdomain (e.g. `my-company`) |
|
|
17
|
+
| `api_key` | Your Sage HR API key |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `SageHrGetProjectsBatch` | Batch | Paginates through all timesheet projects via `GET /timesheets/projects` |
|
|
24
|
+
| `SageHrListEmployeesBatch` | Batch | Paginates through all employees via `GET /employees` |
|
|
25
|
+
|
|
26
|
+
## Setup
|
|
27
|
+
|
|
28
|
+
### Credentials
|
|
29
|
+
|
|
30
|
+
1. Log in to your [Sage HR](https://sagehr.com/) account as an admin.
|
|
31
|
+
2. Navigate to **Settings → Integrations → API** and click **Enable API Access**.
|
|
32
|
+
3. Copy the generated **API key**.
|
|
33
|
+
4. Your **subdomain** is the part of your Sage HR URL before `.sage.hr` (e.g. `my-company` from `my-company.sage.hr`).
|
|
34
|
+
5. In Orchesty, open the Sage HR application settings and fill in both fields.
|
|
35
|
+
|
|
36
|
+
### API Documentation
|
|
37
|
+
|
|
38
|
+
Sage HR Developer Portal: [https://developer.sage.com/hr/](https://developer.sage.com/hr/)
|
|
39
|
+
|
|
40
|
+
## Installation & Usage
|
|
41
|
+
|
|
42
|
+
Install the package:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm install @orchesty/connector-sage-hr @orchesty/nodejs-sdk
|
|
46
|
+
# or
|
|
47
|
+
pnpm add @orchesty/connector-sage-hr @orchesty/nodejs-sdk
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Register the application and nodes in your Orchesty DI container:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
54
|
+
import SageHrApplication from '@orchesty/connector-sage-hr/dist/SageHrApplication';
|
|
55
|
+
import SageHrGetProjectsBatch from '@orchesty/connector-sage-hr/dist/Batch/SageHrGetProjectsBatch';
|
|
56
|
+
import SageHrListEmployeesBatch from '@orchesty/connector-sage-hr/dist/Batch/SageHrListEmployeesBatch';
|
|
57
|
+
|
|
58
|
+
const app = new SageHrApplication();
|
|
59
|
+
container.setApplication(app);
|
|
60
|
+
container.setNode(new SageHrGetProjectsBatch(), app);
|
|
61
|
+
container.setNode(new SageHrListEmployeesBatch(), app);
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
67
|
+
|
|
68
|
+
## Contributing
|
|
69
|
+
|
|
70
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
71
|
+
|
|
72
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
73
|
+
|
|
74
|
+
All contributions should include:
|
|
75
|
+
- Source code in `src/` following the existing connector structure
|
|
76
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
77
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-sage-hr",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.8"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-sage-hr",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"keywords": [],
|
|
12
12
|
"author": "info@hanaboso.com",
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
14
|
+
"@orchesty/nodejs-sdk": "^5.0.8"
|
|
15
15
|
},
|
|
16
16
|
"engines": {
|
|
17
17
|
"node": ">=24"
|