@unified-api/typescript-sdk 2.9.4 → 2.9.5
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/FUNCTIONS.md +108 -0
- package/README.md +36 -15
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +501 -0
- package/docs/sdks/accounting/README.md +3629 -0
- package/docs/sdks/activity/README.md +501 -0
- package/docs/sdks/apicall/README.md +165 -0
- package/docs/sdks/application/README.md +501 -0
- package/docs/sdks/applicationstatus/README.md +88 -0
- package/docs/sdks/ats/README.md +3710 -0
- package/docs/sdks/auth/README.md +173 -0
- package/docs/sdks/branch/README.md +501 -0
- package/docs/sdks/call/README.md +88 -0
- package/docs/sdks/candidate/README.md +501 -0
- package/docs/sdks/channel/README.md +171 -0
- package/docs/sdks/class/README.md +501 -0
- package/docs/sdks/collection/README.md +501 -0
- package/docs/sdks/commerce/README.md +2477 -0
- package/docs/sdks/commit/README.md +501 -0
- package/docs/sdks/company/README.md +1240 -0
- package/docs/sdks/connection/README.md +485 -0
- package/docs/sdks/contact/README.md +1489 -0
- package/docs/sdks/course/README.md +501 -0
- package/docs/sdks/crm/README.md +2971 -0
- package/docs/sdks/customer/README.md +501 -0
- package/docs/sdks/deal/README.md +501 -0
- package/docs/sdks/document/README.md +501 -0
- package/docs/sdks/employee/README.md +501 -0
- package/docs/sdks/enrich/README.md +169 -0
- package/docs/sdks/event/README.md +501 -0
- package/docs/sdks/file/README.md +501 -0
- package/docs/sdks/genai/README.md +169 -0
- package/docs/sdks/group/README.md +995 -0
- package/docs/sdks/hris/README.md +2311 -0
- package/docs/sdks/instructor/README.md +501 -0
- package/docs/sdks/integration/README.md +248 -0
- package/docs/sdks/interview/README.md +501 -0
- package/docs/sdks/inventory/README.md +501 -0
- package/docs/sdks/invoice/README.md +501 -0
- package/docs/sdks/issue/README.md +84 -0
- package/docs/sdks/item/README.md +501 -0
- package/docs/sdks/job/README.md +501 -0
- package/docs/sdks/journal/README.md +501 -0
- package/docs/sdks/kms/README.md +995 -0
- package/docs/sdks/lead/README.md +501 -0
- package/docs/sdks/link/README.md +501 -0
- package/docs/sdks/list/README.md +501 -0
- package/docs/sdks/lms/README.md +1983 -0
- package/docs/sdks/location/README.md +995 -0
- package/docs/sdks/login/README.md +90 -0
- package/docs/sdks/martech/README.md +995 -0
- package/docs/sdks/member/README.md +501 -0
- package/docs/sdks/message/README.md +501 -0
- package/docs/sdks/messaging/README.md +665 -0
- package/docs/sdks/metadata/README.md +501 -0
- package/docs/sdks/model/README.md +88 -0
- package/docs/sdks/note/README.md +501 -0
- package/docs/sdks/order/README.md +501 -0
- package/docs/sdks/organization/README.md +665 -0
- package/docs/sdks/page/README.md +501 -0
- package/docs/sdks/passthrough/README.md +671 -0
- package/docs/sdks/payment/README.md +1323 -0
- package/docs/sdks/payout/README.md +171 -0
- package/docs/sdks/payslip/README.md +171 -0
- package/docs/sdks/person/README.md +88 -0
- package/docs/sdks/pipeline/README.md +501 -0
- package/docs/sdks/project/README.md +501 -0
- package/docs/sdks/prompt/README.md +88 -0
- package/docs/sdks/pullrequest/README.md +501 -0
- package/docs/sdks/refund/README.md +171 -0
- package/docs/sdks/repo/README.md +2477 -0
- package/docs/sdks/repository/README.md +501 -0
- package/docs/sdks/scim/README.md +995 -0
- package/docs/sdks/scorecard/README.md +501 -0
- package/docs/sdks/space/README.md +501 -0
- package/docs/sdks/storage/README.md +501 -0
- package/docs/sdks/student/README.md +501 -0
- package/docs/sdks/task/README.md +995 -0
- package/docs/sdks/taxrate/README.md +501 -0
- package/docs/sdks/ticket/README.md +501 -0
- package/docs/sdks/ticketing/README.md +1489 -0
- package/docs/sdks/timeoff/README.md +171 -0
- package/docs/sdks/transaction/README.md +501 -0
- package/docs/sdks/uc/README.md +582 -0
- package/docs/sdks/unified/README.md +1601 -0
- package/docs/sdks/unifiedto/README.md +7 -0
- package/docs/sdks/user/README.md +501 -0
- package/docs/sdks/webhook/README.md +647 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/package.json +3 -1
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/kmspage.d.ts +5 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +7 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
- package/sdk/models/shared/kmspagemetadata.js +63 -0
- package/sdk/models/shared/kmspagemetadata.js.map +1 -0
- package/sdk/models/shared/kmsspace.d.ts +2 -0
- package/sdk/models/shared/kmsspace.d.ts.map +1 -1
- package/sdk/models/shared/kmsspace.js +4 -0
- package/sdk/models/shared/kmsspace.js.map +1 -1
- package/sdk/models/shared/security.d.ts +2 -2
- package/sdk/models/shared/security.d.ts.map +1 -1
- package/sdk/models/shared/security.js +2 -2
- package/sdk/models/shared/security.js.map +1 -1
- package/sdk/types/operations.d.ts +5 -3
- package/sdk/types/operations.d.ts.map +1 -1
- package/sdk/types/operations.js +3 -0
- package/sdk/types/operations.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/kmspage.ts +16 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
- package/src/sdk/models/shared/kmsspace.ts +6 -0
- package/src/sdk/models/shared/security.ts +4 -4
- package/src/sdk/types/operations.ts +11 -5
|
@@ -0,0 +1,2311 @@
|
|
|
1
|
+
# Hris
|
|
2
|
+
(*hris*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createHrisCompany](#createhriscompany) - Create a company
|
|
9
|
+
* [createHrisEmployee](#createhrisemployee) - Create an employee
|
|
10
|
+
* [createHrisGroup](#createhrisgroup) - Create a group
|
|
11
|
+
* [createHrisLocation](#createhrislocation) - Create a location
|
|
12
|
+
* [getHrisCompany](#gethriscompany) - Retrieve a company
|
|
13
|
+
* [getHrisEmployee](#gethrisemployee) - Retrieve an employee
|
|
14
|
+
* [getHrisGroup](#gethrisgroup) - Retrieve a group
|
|
15
|
+
* [getHrisLocation](#gethrislocation) - Retrieve a location
|
|
16
|
+
* [getHrisPayslip](#gethrispayslip) - Retrieve a payslip
|
|
17
|
+
* [getHrisTimeoff](#gethristimeoff) - Retrieve a timeoff
|
|
18
|
+
* [listHrisCompanies](#listhriscompanies) - List all companies
|
|
19
|
+
* [listHrisEmployees](#listhrisemployees) - List all employees
|
|
20
|
+
* [listHrisGroups](#listhrisgroups) - List all groups
|
|
21
|
+
* [listHrisLocations](#listhrislocations) - List all locations
|
|
22
|
+
* [listHrisPayslips](#listhrispayslips) - List all payslips
|
|
23
|
+
* [listHrisTimeoffs](#listhristimeoffs) - List all timeoffs
|
|
24
|
+
* [patchHrisCompany](#patchhriscompany) - Update a company
|
|
25
|
+
* [patchHrisEmployee](#patchhrisemployee) - Update an employee
|
|
26
|
+
* [patchHrisGroup](#patchhrisgroup) - Update a group
|
|
27
|
+
* [patchHrisLocation](#patchhrislocation) - Update a location
|
|
28
|
+
* [removeHrisCompany](#removehriscompany) - Remove a company
|
|
29
|
+
* [removeHrisEmployee](#removehrisemployee) - Remove an employee
|
|
30
|
+
* [removeHrisGroup](#removehrisgroup) - Remove a group
|
|
31
|
+
* [removeHrisLocation](#removehrislocation) - Remove a location
|
|
32
|
+
* [updateHrisCompany](#updatehriscompany) - Update a company
|
|
33
|
+
* [updateHrisEmployee](#updatehrisemployee) - Update an employee
|
|
34
|
+
* [updateHrisGroup](#updatehrisgroup) - Update a group
|
|
35
|
+
* [updateHrisLocation](#updatehrislocation) - Update a location
|
|
36
|
+
|
|
37
|
+
## createHrisCompany
|
|
38
|
+
|
|
39
|
+
Create a company
|
|
40
|
+
|
|
41
|
+
### Example Usage
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
45
|
+
|
|
46
|
+
const unifiedTo = new UnifiedTo({
|
|
47
|
+
security: {
|
|
48
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
async function run() {
|
|
53
|
+
const result = await unifiedTo.hris.createHrisCompany({
|
|
54
|
+
connectionId: "<value>",
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
// Handle the result
|
|
58
|
+
console.log(result);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
run();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Standalone function
|
|
65
|
+
|
|
66
|
+
The standalone function version of this method:
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
70
|
+
import { hrisCreateHrisCompany } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisCompany.js";
|
|
71
|
+
|
|
72
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
73
|
+
// You can create one instance of it to use across an application.
|
|
74
|
+
const unifiedTo = new UnifiedToCore({
|
|
75
|
+
security: {
|
|
76
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
77
|
+
},
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
async function run() {
|
|
81
|
+
const res = await hrisCreateHrisCompany(unifiedTo, {
|
|
82
|
+
connectionId: "<value>",
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
if (!res.ok) {
|
|
86
|
+
throw res.error;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
const { value: result } = res;
|
|
90
|
+
|
|
91
|
+
// Handle the result
|
|
92
|
+
console.log(result);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
run();
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
| Parameter | Type | Required | Description |
|
|
101
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
102
|
+
| `request` | [operations.CreateHrisCompanyRequest](../../sdk/models/operations/createhriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
103
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
104
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
105
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
106
|
+
|
|
107
|
+
### Response
|
|
108
|
+
|
|
109
|
+
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
110
|
+
|
|
111
|
+
### Errors
|
|
112
|
+
|
|
113
|
+
| Error Type | Status Code | Content Type |
|
|
114
|
+
| --------------- | --------------- | --------------- |
|
|
115
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
116
|
+
|
|
117
|
+
## createHrisEmployee
|
|
118
|
+
|
|
119
|
+
Create an employee
|
|
120
|
+
|
|
121
|
+
### Example Usage
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
125
|
+
|
|
126
|
+
const unifiedTo = new UnifiedTo({
|
|
127
|
+
security: {
|
|
128
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
129
|
+
},
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
async function run() {
|
|
133
|
+
const result = await unifiedTo.hris.createHrisEmployee({
|
|
134
|
+
connectionId: "<value>",
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
// Handle the result
|
|
138
|
+
console.log(result);
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
run();
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Standalone function
|
|
145
|
+
|
|
146
|
+
The standalone function version of this method:
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
150
|
+
import { hrisCreateHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisEmployee.js";
|
|
151
|
+
|
|
152
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
153
|
+
// You can create one instance of it to use across an application.
|
|
154
|
+
const unifiedTo = new UnifiedToCore({
|
|
155
|
+
security: {
|
|
156
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
157
|
+
},
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
async function run() {
|
|
161
|
+
const res = await hrisCreateHrisEmployee(unifiedTo, {
|
|
162
|
+
connectionId: "<value>",
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
if (!res.ok) {
|
|
166
|
+
throw res.error;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
const { value: result } = res;
|
|
170
|
+
|
|
171
|
+
// Handle the result
|
|
172
|
+
console.log(result);
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
run();
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Parameters
|
|
179
|
+
|
|
180
|
+
| Parameter | Type | Required | Description |
|
|
181
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
182
|
+
| `request` | [operations.CreateHrisEmployeeRequest](../../sdk/models/operations/createhrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
183
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
184
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
185
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
186
|
+
|
|
187
|
+
### Response
|
|
188
|
+
|
|
189
|
+
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
190
|
+
|
|
191
|
+
### Errors
|
|
192
|
+
|
|
193
|
+
| Error Type | Status Code | Content Type |
|
|
194
|
+
| --------------- | --------------- | --------------- |
|
|
195
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
196
|
+
|
|
197
|
+
## createHrisGroup
|
|
198
|
+
|
|
199
|
+
Create a group
|
|
200
|
+
|
|
201
|
+
### Example Usage
|
|
202
|
+
|
|
203
|
+
```typescript
|
|
204
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
205
|
+
|
|
206
|
+
const unifiedTo = new UnifiedTo({
|
|
207
|
+
security: {
|
|
208
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
209
|
+
},
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
async function run() {
|
|
213
|
+
const result = await unifiedTo.hris.createHrisGroup({
|
|
214
|
+
connectionId: "<value>",
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
// Handle the result
|
|
218
|
+
console.log(result);
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
run();
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Standalone function
|
|
225
|
+
|
|
226
|
+
The standalone function version of this method:
|
|
227
|
+
|
|
228
|
+
```typescript
|
|
229
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
230
|
+
import { hrisCreateHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisGroup.js";
|
|
231
|
+
|
|
232
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
233
|
+
// You can create one instance of it to use across an application.
|
|
234
|
+
const unifiedTo = new UnifiedToCore({
|
|
235
|
+
security: {
|
|
236
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
237
|
+
},
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
async function run() {
|
|
241
|
+
const res = await hrisCreateHrisGroup(unifiedTo, {
|
|
242
|
+
connectionId: "<value>",
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
if (!res.ok) {
|
|
246
|
+
throw res.error;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
const { value: result } = res;
|
|
250
|
+
|
|
251
|
+
// Handle the result
|
|
252
|
+
console.log(result);
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
run();
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Parameters
|
|
259
|
+
|
|
260
|
+
| Parameter | Type | Required | Description |
|
|
261
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
262
|
+
| `request` | [operations.CreateHrisGroupRequest](../../sdk/models/operations/createhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
263
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
264
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
265
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
266
|
+
|
|
267
|
+
### Response
|
|
268
|
+
|
|
269
|
+
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
270
|
+
|
|
271
|
+
### Errors
|
|
272
|
+
|
|
273
|
+
| Error Type | Status Code | Content Type |
|
|
274
|
+
| --------------- | --------------- | --------------- |
|
|
275
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
276
|
+
|
|
277
|
+
## createHrisLocation
|
|
278
|
+
|
|
279
|
+
Create a location
|
|
280
|
+
|
|
281
|
+
### Example Usage
|
|
282
|
+
|
|
283
|
+
```typescript
|
|
284
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
285
|
+
|
|
286
|
+
const unifiedTo = new UnifiedTo({
|
|
287
|
+
security: {
|
|
288
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
289
|
+
},
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
async function run() {
|
|
293
|
+
const result = await unifiedTo.hris.createHrisLocation({
|
|
294
|
+
connectionId: "<value>",
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
// Handle the result
|
|
298
|
+
console.log(result);
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
run();
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
### Standalone function
|
|
305
|
+
|
|
306
|
+
The standalone function version of this method:
|
|
307
|
+
|
|
308
|
+
```typescript
|
|
309
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
310
|
+
import { hrisCreateHrisLocation } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisLocation.js";
|
|
311
|
+
|
|
312
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
313
|
+
// You can create one instance of it to use across an application.
|
|
314
|
+
const unifiedTo = new UnifiedToCore({
|
|
315
|
+
security: {
|
|
316
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
317
|
+
},
|
|
318
|
+
});
|
|
319
|
+
|
|
320
|
+
async function run() {
|
|
321
|
+
const res = await hrisCreateHrisLocation(unifiedTo, {
|
|
322
|
+
connectionId: "<value>",
|
|
323
|
+
});
|
|
324
|
+
|
|
325
|
+
if (!res.ok) {
|
|
326
|
+
throw res.error;
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
const { value: result } = res;
|
|
330
|
+
|
|
331
|
+
// Handle the result
|
|
332
|
+
console.log(result);
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
run();
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Parameters
|
|
339
|
+
|
|
340
|
+
| Parameter | Type | Required | Description |
|
|
341
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
342
|
+
| `request` | [operations.CreateHrisLocationRequest](../../sdk/models/operations/createhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
343
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
344
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
345
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
346
|
+
|
|
347
|
+
### Response
|
|
348
|
+
|
|
349
|
+
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
350
|
+
|
|
351
|
+
### Errors
|
|
352
|
+
|
|
353
|
+
| Error Type | Status Code | Content Type |
|
|
354
|
+
| --------------- | --------------- | --------------- |
|
|
355
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
356
|
+
|
|
357
|
+
## getHrisCompany
|
|
358
|
+
|
|
359
|
+
Retrieve a company
|
|
360
|
+
|
|
361
|
+
### Example Usage
|
|
362
|
+
|
|
363
|
+
```typescript
|
|
364
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
365
|
+
|
|
366
|
+
const unifiedTo = new UnifiedTo({
|
|
367
|
+
security: {
|
|
368
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
369
|
+
},
|
|
370
|
+
});
|
|
371
|
+
|
|
372
|
+
async function run() {
|
|
373
|
+
const result = await unifiedTo.hris.getHrisCompany({
|
|
374
|
+
connectionId: "<value>",
|
|
375
|
+
id: "<id>",
|
|
376
|
+
});
|
|
377
|
+
|
|
378
|
+
// Handle the result
|
|
379
|
+
console.log(result);
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
run();
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
### Standalone function
|
|
386
|
+
|
|
387
|
+
The standalone function version of this method:
|
|
388
|
+
|
|
389
|
+
```typescript
|
|
390
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
391
|
+
import { hrisGetHrisCompany } from "@unified-api/typescript-sdk/funcs/hrisGetHrisCompany.js";
|
|
392
|
+
|
|
393
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
394
|
+
// You can create one instance of it to use across an application.
|
|
395
|
+
const unifiedTo = new UnifiedToCore({
|
|
396
|
+
security: {
|
|
397
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
398
|
+
},
|
|
399
|
+
});
|
|
400
|
+
|
|
401
|
+
async function run() {
|
|
402
|
+
const res = await hrisGetHrisCompany(unifiedTo, {
|
|
403
|
+
connectionId: "<value>",
|
|
404
|
+
id: "<id>",
|
|
405
|
+
});
|
|
406
|
+
|
|
407
|
+
if (!res.ok) {
|
|
408
|
+
throw res.error;
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
const { value: result } = res;
|
|
412
|
+
|
|
413
|
+
// Handle the result
|
|
414
|
+
console.log(result);
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
run();
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### Parameters
|
|
421
|
+
|
|
422
|
+
| Parameter | Type | Required | Description |
|
|
423
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
424
|
+
| `request` | [operations.GetHrisCompanyRequest](../../sdk/models/operations/gethriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
425
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
426
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
427
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
428
|
+
|
|
429
|
+
### Response
|
|
430
|
+
|
|
431
|
+
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
432
|
+
|
|
433
|
+
### Errors
|
|
434
|
+
|
|
435
|
+
| Error Type | Status Code | Content Type |
|
|
436
|
+
| --------------- | --------------- | --------------- |
|
|
437
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
438
|
+
|
|
439
|
+
## getHrisEmployee
|
|
440
|
+
|
|
441
|
+
Retrieve an employee
|
|
442
|
+
|
|
443
|
+
### Example Usage
|
|
444
|
+
|
|
445
|
+
```typescript
|
|
446
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
447
|
+
|
|
448
|
+
const unifiedTo = new UnifiedTo({
|
|
449
|
+
security: {
|
|
450
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
451
|
+
},
|
|
452
|
+
});
|
|
453
|
+
|
|
454
|
+
async function run() {
|
|
455
|
+
const result = await unifiedTo.hris.getHrisEmployee({
|
|
456
|
+
connectionId: "<value>",
|
|
457
|
+
id: "<id>",
|
|
458
|
+
});
|
|
459
|
+
|
|
460
|
+
// Handle the result
|
|
461
|
+
console.log(result);
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
run();
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### Standalone function
|
|
468
|
+
|
|
469
|
+
The standalone function version of this method:
|
|
470
|
+
|
|
471
|
+
```typescript
|
|
472
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
473
|
+
import { hrisGetHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisGetHrisEmployee.js";
|
|
474
|
+
|
|
475
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
476
|
+
// You can create one instance of it to use across an application.
|
|
477
|
+
const unifiedTo = new UnifiedToCore({
|
|
478
|
+
security: {
|
|
479
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
480
|
+
},
|
|
481
|
+
});
|
|
482
|
+
|
|
483
|
+
async function run() {
|
|
484
|
+
const res = await hrisGetHrisEmployee(unifiedTo, {
|
|
485
|
+
connectionId: "<value>",
|
|
486
|
+
id: "<id>",
|
|
487
|
+
});
|
|
488
|
+
|
|
489
|
+
if (!res.ok) {
|
|
490
|
+
throw res.error;
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
const { value: result } = res;
|
|
494
|
+
|
|
495
|
+
// Handle the result
|
|
496
|
+
console.log(result);
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
run();
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
### Parameters
|
|
503
|
+
|
|
504
|
+
| Parameter | Type | Required | Description |
|
|
505
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
506
|
+
| `request` | [operations.GetHrisEmployeeRequest](../../sdk/models/operations/gethrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
507
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
508
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
509
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
510
|
+
|
|
511
|
+
### Response
|
|
512
|
+
|
|
513
|
+
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
514
|
+
|
|
515
|
+
### Errors
|
|
516
|
+
|
|
517
|
+
| Error Type | Status Code | Content Type |
|
|
518
|
+
| --------------- | --------------- | --------------- |
|
|
519
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
520
|
+
|
|
521
|
+
## getHrisGroup
|
|
522
|
+
|
|
523
|
+
Retrieve a group
|
|
524
|
+
|
|
525
|
+
### Example Usage
|
|
526
|
+
|
|
527
|
+
```typescript
|
|
528
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
529
|
+
|
|
530
|
+
const unifiedTo = new UnifiedTo({
|
|
531
|
+
security: {
|
|
532
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
533
|
+
},
|
|
534
|
+
});
|
|
535
|
+
|
|
536
|
+
async function run() {
|
|
537
|
+
const result = await unifiedTo.hris.getHrisGroup({
|
|
538
|
+
connectionId: "<value>",
|
|
539
|
+
id: "<id>",
|
|
540
|
+
});
|
|
541
|
+
|
|
542
|
+
// Handle the result
|
|
543
|
+
console.log(result);
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
run();
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### Standalone function
|
|
550
|
+
|
|
551
|
+
The standalone function version of this method:
|
|
552
|
+
|
|
553
|
+
```typescript
|
|
554
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
555
|
+
import { hrisGetHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisGetHrisGroup.js";
|
|
556
|
+
|
|
557
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
558
|
+
// You can create one instance of it to use across an application.
|
|
559
|
+
const unifiedTo = new UnifiedToCore({
|
|
560
|
+
security: {
|
|
561
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
562
|
+
},
|
|
563
|
+
});
|
|
564
|
+
|
|
565
|
+
async function run() {
|
|
566
|
+
const res = await hrisGetHrisGroup(unifiedTo, {
|
|
567
|
+
connectionId: "<value>",
|
|
568
|
+
id: "<id>",
|
|
569
|
+
});
|
|
570
|
+
|
|
571
|
+
if (!res.ok) {
|
|
572
|
+
throw res.error;
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
const { value: result } = res;
|
|
576
|
+
|
|
577
|
+
// Handle the result
|
|
578
|
+
console.log(result);
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
run();
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
### Parameters
|
|
585
|
+
|
|
586
|
+
| Parameter | Type | Required | Description |
|
|
587
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
588
|
+
| `request` | [operations.GetHrisGroupRequest](../../sdk/models/operations/gethrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
589
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
590
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
591
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
592
|
+
|
|
593
|
+
### Response
|
|
594
|
+
|
|
595
|
+
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
596
|
+
|
|
597
|
+
### Errors
|
|
598
|
+
|
|
599
|
+
| Error Type | Status Code | Content Type |
|
|
600
|
+
| --------------- | --------------- | --------------- |
|
|
601
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
602
|
+
|
|
603
|
+
## getHrisLocation
|
|
604
|
+
|
|
605
|
+
Retrieve a location
|
|
606
|
+
|
|
607
|
+
### Example Usage
|
|
608
|
+
|
|
609
|
+
```typescript
|
|
610
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
611
|
+
|
|
612
|
+
const unifiedTo = new UnifiedTo({
|
|
613
|
+
security: {
|
|
614
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
615
|
+
},
|
|
616
|
+
});
|
|
617
|
+
|
|
618
|
+
async function run() {
|
|
619
|
+
const result = await unifiedTo.hris.getHrisLocation({
|
|
620
|
+
connectionId: "<value>",
|
|
621
|
+
id: "<id>",
|
|
622
|
+
});
|
|
623
|
+
|
|
624
|
+
// Handle the result
|
|
625
|
+
console.log(result);
|
|
626
|
+
}
|
|
627
|
+
|
|
628
|
+
run();
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
### Standalone function
|
|
632
|
+
|
|
633
|
+
The standalone function version of this method:
|
|
634
|
+
|
|
635
|
+
```typescript
|
|
636
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
637
|
+
import { hrisGetHrisLocation } from "@unified-api/typescript-sdk/funcs/hrisGetHrisLocation.js";
|
|
638
|
+
|
|
639
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
640
|
+
// You can create one instance of it to use across an application.
|
|
641
|
+
const unifiedTo = new UnifiedToCore({
|
|
642
|
+
security: {
|
|
643
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
644
|
+
},
|
|
645
|
+
});
|
|
646
|
+
|
|
647
|
+
async function run() {
|
|
648
|
+
const res = await hrisGetHrisLocation(unifiedTo, {
|
|
649
|
+
connectionId: "<value>",
|
|
650
|
+
id: "<id>",
|
|
651
|
+
});
|
|
652
|
+
|
|
653
|
+
if (!res.ok) {
|
|
654
|
+
throw res.error;
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
const { value: result } = res;
|
|
658
|
+
|
|
659
|
+
// Handle the result
|
|
660
|
+
console.log(result);
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
run();
|
|
664
|
+
```
|
|
665
|
+
|
|
666
|
+
### Parameters
|
|
667
|
+
|
|
668
|
+
| Parameter | Type | Required | Description |
|
|
669
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
670
|
+
| `request` | [operations.GetHrisLocationRequest](../../sdk/models/operations/gethrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
671
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
672
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
673
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
674
|
+
|
|
675
|
+
### Response
|
|
676
|
+
|
|
677
|
+
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
678
|
+
|
|
679
|
+
### Errors
|
|
680
|
+
|
|
681
|
+
| Error Type | Status Code | Content Type |
|
|
682
|
+
| --------------- | --------------- | --------------- |
|
|
683
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
684
|
+
|
|
685
|
+
## getHrisPayslip
|
|
686
|
+
|
|
687
|
+
Retrieve a payslip
|
|
688
|
+
|
|
689
|
+
### Example Usage
|
|
690
|
+
|
|
691
|
+
```typescript
|
|
692
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
693
|
+
|
|
694
|
+
const unifiedTo = new UnifiedTo({
|
|
695
|
+
security: {
|
|
696
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
697
|
+
},
|
|
698
|
+
});
|
|
699
|
+
|
|
700
|
+
async function run() {
|
|
701
|
+
const result = await unifiedTo.hris.getHrisPayslip({
|
|
702
|
+
connectionId: "<value>",
|
|
703
|
+
id: "<id>",
|
|
704
|
+
});
|
|
705
|
+
|
|
706
|
+
// Handle the result
|
|
707
|
+
console.log(result);
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
run();
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
### Standalone function
|
|
714
|
+
|
|
715
|
+
The standalone function version of this method:
|
|
716
|
+
|
|
717
|
+
```typescript
|
|
718
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
719
|
+
import { hrisGetHrisPayslip } from "@unified-api/typescript-sdk/funcs/hrisGetHrisPayslip.js";
|
|
720
|
+
|
|
721
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
722
|
+
// You can create one instance of it to use across an application.
|
|
723
|
+
const unifiedTo = new UnifiedToCore({
|
|
724
|
+
security: {
|
|
725
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
726
|
+
},
|
|
727
|
+
});
|
|
728
|
+
|
|
729
|
+
async function run() {
|
|
730
|
+
const res = await hrisGetHrisPayslip(unifiedTo, {
|
|
731
|
+
connectionId: "<value>",
|
|
732
|
+
id: "<id>",
|
|
733
|
+
});
|
|
734
|
+
|
|
735
|
+
if (!res.ok) {
|
|
736
|
+
throw res.error;
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
const { value: result } = res;
|
|
740
|
+
|
|
741
|
+
// Handle the result
|
|
742
|
+
console.log(result);
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
run();
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
### Parameters
|
|
749
|
+
|
|
750
|
+
| Parameter | Type | Required | Description |
|
|
751
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
752
|
+
| `request` | [operations.GetHrisPayslipRequest](../../sdk/models/operations/gethrispaysliprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
753
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
754
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
755
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
756
|
+
|
|
757
|
+
### Response
|
|
758
|
+
|
|
759
|
+
**Promise\<[shared.HrisPayslip](../../sdk/models/shared/hrispayslip.md)\>**
|
|
760
|
+
|
|
761
|
+
### Errors
|
|
762
|
+
|
|
763
|
+
| Error Type | Status Code | Content Type |
|
|
764
|
+
| --------------- | --------------- | --------------- |
|
|
765
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
766
|
+
|
|
767
|
+
## getHrisTimeoff
|
|
768
|
+
|
|
769
|
+
Retrieve a timeoff
|
|
770
|
+
|
|
771
|
+
### Example Usage
|
|
772
|
+
|
|
773
|
+
```typescript
|
|
774
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
775
|
+
|
|
776
|
+
const unifiedTo = new UnifiedTo({
|
|
777
|
+
security: {
|
|
778
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
779
|
+
},
|
|
780
|
+
});
|
|
781
|
+
|
|
782
|
+
async function run() {
|
|
783
|
+
const result = await unifiedTo.hris.getHrisTimeoff({
|
|
784
|
+
connectionId: "<value>",
|
|
785
|
+
id: "<id>",
|
|
786
|
+
});
|
|
787
|
+
|
|
788
|
+
// Handle the result
|
|
789
|
+
console.log(result);
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
run();
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
### Standalone function
|
|
796
|
+
|
|
797
|
+
The standalone function version of this method:
|
|
798
|
+
|
|
799
|
+
```typescript
|
|
800
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
801
|
+
import { hrisGetHrisTimeoff } from "@unified-api/typescript-sdk/funcs/hrisGetHrisTimeoff.js";
|
|
802
|
+
|
|
803
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
804
|
+
// You can create one instance of it to use across an application.
|
|
805
|
+
const unifiedTo = new UnifiedToCore({
|
|
806
|
+
security: {
|
|
807
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
808
|
+
},
|
|
809
|
+
});
|
|
810
|
+
|
|
811
|
+
async function run() {
|
|
812
|
+
const res = await hrisGetHrisTimeoff(unifiedTo, {
|
|
813
|
+
connectionId: "<value>",
|
|
814
|
+
id: "<id>",
|
|
815
|
+
});
|
|
816
|
+
|
|
817
|
+
if (!res.ok) {
|
|
818
|
+
throw res.error;
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
const { value: result } = res;
|
|
822
|
+
|
|
823
|
+
// Handle the result
|
|
824
|
+
console.log(result);
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
run();
|
|
828
|
+
```
|
|
829
|
+
|
|
830
|
+
### Parameters
|
|
831
|
+
|
|
832
|
+
| Parameter | Type | Required | Description |
|
|
833
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
834
|
+
| `request` | [operations.GetHrisTimeoffRequest](../../sdk/models/operations/gethristimeoffrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
835
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
836
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
837
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
838
|
+
|
|
839
|
+
### Response
|
|
840
|
+
|
|
841
|
+
**Promise\<[shared.HrisTimeoff](../../sdk/models/shared/hristimeoff.md)\>**
|
|
842
|
+
|
|
843
|
+
### Errors
|
|
844
|
+
|
|
845
|
+
| Error Type | Status Code | Content Type |
|
|
846
|
+
| --------------- | --------------- | --------------- |
|
|
847
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
848
|
+
|
|
849
|
+
## listHrisCompanies
|
|
850
|
+
|
|
851
|
+
List all companies
|
|
852
|
+
|
|
853
|
+
### Example Usage
|
|
854
|
+
|
|
855
|
+
```typescript
|
|
856
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
857
|
+
|
|
858
|
+
const unifiedTo = new UnifiedTo({
|
|
859
|
+
security: {
|
|
860
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
861
|
+
},
|
|
862
|
+
});
|
|
863
|
+
|
|
864
|
+
async function run() {
|
|
865
|
+
const result = await unifiedTo.hris.listHrisCompanies({
|
|
866
|
+
connectionId: "<value>",
|
|
867
|
+
});
|
|
868
|
+
|
|
869
|
+
// Handle the result
|
|
870
|
+
console.log(result);
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
run();
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
### Standalone function
|
|
877
|
+
|
|
878
|
+
The standalone function version of this method:
|
|
879
|
+
|
|
880
|
+
```typescript
|
|
881
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
882
|
+
import { hrisListHrisCompanies } from "@unified-api/typescript-sdk/funcs/hrisListHrisCompanies.js";
|
|
883
|
+
|
|
884
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
885
|
+
// You can create one instance of it to use across an application.
|
|
886
|
+
const unifiedTo = new UnifiedToCore({
|
|
887
|
+
security: {
|
|
888
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
889
|
+
},
|
|
890
|
+
});
|
|
891
|
+
|
|
892
|
+
async function run() {
|
|
893
|
+
const res = await hrisListHrisCompanies(unifiedTo, {
|
|
894
|
+
connectionId: "<value>",
|
|
895
|
+
});
|
|
896
|
+
|
|
897
|
+
if (!res.ok) {
|
|
898
|
+
throw res.error;
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
const { value: result } = res;
|
|
902
|
+
|
|
903
|
+
// Handle the result
|
|
904
|
+
console.log(result);
|
|
905
|
+
}
|
|
906
|
+
|
|
907
|
+
run();
|
|
908
|
+
```
|
|
909
|
+
|
|
910
|
+
### Parameters
|
|
911
|
+
|
|
912
|
+
| Parameter | Type | Required | Description |
|
|
913
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
914
|
+
| `request` | [operations.ListHrisCompaniesRequest](../../sdk/models/operations/listhriscompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
915
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
916
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
917
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
918
|
+
|
|
919
|
+
### Response
|
|
920
|
+
|
|
921
|
+
**Promise\<[shared.HrisCompany[]](../../models/.md)\>**
|
|
922
|
+
|
|
923
|
+
### Errors
|
|
924
|
+
|
|
925
|
+
| Error Type | Status Code | Content Type |
|
|
926
|
+
| --------------- | --------------- | --------------- |
|
|
927
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
928
|
+
|
|
929
|
+
## listHrisEmployees
|
|
930
|
+
|
|
931
|
+
List all employees
|
|
932
|
+
|
|
933
|
+
### Example Usage
|
|
934
|
+
|
|
935
|
+
```typescript
|
|
936
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
937
|
+
|
|
938
|
+
const unifiedTo = new UnifiedTo({
|
|
939
|
+
security: {
|
|
940
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
941
|
+
},
|
|
942
|
+
});
|
|
943
|
+
|
|
944
|
+
async function run() {
|
|
945
|
+
const result = await unifiedTo.hris.listHrisEmployees({
|
|
946
|
+
connectionId: "<value>",
|
|
947
|
+
});
|
|
948
|
+
|
|
949
|
+
// Handle the result
|
|
950
|
+
console.log(result);
|
|
951
|
+
}
|
|
952
|
+
|
|
953
|
+
run();
|
|
954
|
+
```
|
|
955
|
+
|
|
956
|
+
### Standalone function
|
|
957
|
+
|
|
958
|
+
The standalone function version of this method:
|
|
959
|
+
|
|
960
|
+
```typescript
|
|
961
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
962
|
+
import { hrisListHrisEmployees } from "@unified-api/typescript-sdk/funcs/hrisListHrisEmployees.js";
|
|
963
|
+
|
|
964
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
965
|
+
// You can create one instance of it to use across an application.
|
|
966
|
+
const unifiedTo = new UnifiedToCore({
|
|
967
|
+
security: {
|
|
968
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
969
|
+
},
|
|
970
|
+
});
|
|
971
|
+
|
|
972
|
+
async function run() {
|
|
973
|
+
const res = await hrisListHrisEmployees(unifiedTo, {
|
|
974
|
+
connectionId: "<value>",
|
|
975
|
+
});
|
|
976
|
+
|
|
977
|
+
if (!res.ok) {
|
|
978
|
+
throw res.error;
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
const { value: result } = res;
|
|
982
|
+
|
|
983
|
+
// Handle the result
|
|
984
|
+
console.log(result);
|
|
985
|
+
}
|
|
986
|
+
|
|
987
|
+
run();
|
|
988
|
+
```
|
|
989
|
+
|
|
990
|
+
### Parameters
|
|
991
|
+
|
|
992
|
+
| Parameter | Type | Required | Description |
|
|
993
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
994
|
+
| `request` | [operations.ListHrisEmployeesRequest](../../sdk/models/operations/listhrisemployeesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
995
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
996
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
997
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
998
|
+
|
|
999
|
+
### Response
|
|
1000
|
+
|
|
1001
|
+
**Promise\<[shared.HrisEmployee[]](../../models/.md)\>**
|
|
1002
|
+
|
|
1003
|
+
### Errors
|
|
1004
|
+
|
|
1005
|
+
| Error Type | Status Code | Content Type |
|
|
1006
|
+
| --------------- | --------------- | --------------- |
|
|
1007
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1008
|
+
|
|
1009
|
+
## listHrisGroups
|
|
1010
|
+
|
|
1011
|
+
List all groups
|
|
1012
|
+
|
|
1013
|
+
### Example Usage
|
|
1014
|
+
|
|
1015
|
+
```typescript
|
|
1016
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1017
|
+
|
|
1018
|
+
const unifiedTo = new UnifiedTo({
|
|
1019
|
+
security: {
|
|
1020
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1021
|
+
},
|
|
1022
|
+
});
|
|
1023
|
+
|
|
1024
|
+
async function run() {
|
|
1025
|
+
const result = await unifiedTo.hris.listHrisGroups({
|
|
1026
|
+
connectionId: "<value>",
|
|
1027
|
+
});
|
|
1028
|
+
|
|
1029
|
+
// Handle the result
|
|
1030
|
+
console.log(result);
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
run();
|
|
1034
|
+
```
|
|
1035
|
+
|
|
1036
|
+
### Standalone function
|
|
1037
|
+
|
|
1038
|
+
The standalone function version of this method:
|
|
1039
|
+
|
|
1040
|
+
```typescript
|
|
1041
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1042
|
+
import { hrisListHrisGroups } from "@unified-api/typescript-sdk/funcs/hrisListHrisGroups.js";
|
|
1043
|
+
|
|
1044
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1045
|
+
// You can create one instance of it to use across an application.
|
|
1046
|
+
const unifiedTo = new UnifiedToCore({
|
|
1047
|
+
security: {
|
|
1048
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1049
|
+
},
|
|
1050
|
+
});
|
|
1051
|
+
|
|
1052
|
+
async function run() {
|
|
1053
|
+
const res = await hrisListHrisGroups(unifiedTo, {
|
|
1054
|
+
connectionId: "<value>",
|
|
1055
|
+
});
|
|
1056
|
+
|
|
1057
|
+
if (!res.ok) {
|
|
1058
|
+
throw res.error;
|
|
1059
|
+
}
|
|
1060
|
+
|
|
1061
|
+
const { value: result } = res;
|
|
1062
|
+
|
|
1063
|
+
// Handle the result
|
|
1064
|
+
console.log(result);
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
run();
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
### Parameters
|
|
1071
|
+
|
|
1072
|
+
| Parameter | Type | Required | Description |
|
|
1073
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1074
|
+
| `request` | [operations.ListHrisGroupsRequest](../../sdk/models/operations/listhrisgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1075
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1076
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1077
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1078
|
+
|
|
1079
|
+
### Response
|
|
1080
|
+
|
|
1081
|
+
**Promise\<[shared.HrisGroup[]](../../models/.md)\>**
|
|
1082
|
+
|
|
1083
|
+
### Errors
|
|
1084
|
+
|
|
1085
|
+
| Error Type | Status Code | Content Type |
|
|
1086
|
+
| --------------- | --------------- | --------------- |
|
|
1087
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1088
|
+
|
|
1089
|
+
## listHrisLocations
|
|
1090
|
+
|
|
1091
|
+
List all locations
|
|
1092
|
+
|
|
1093
|
+
### Example Usage
|
|
1094
|
+
|
|
1095
|
+
```typescript
|
|
1096
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1097
|
+
|
|
1098
|
+
const unifiedTo = new UnifiedTo({
|
|
1099
|
+
security: {
|
|
1100
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1101
|
+
},
|
|
1102
|
+
});
|
|
1103
|
+
|
|
1104
|
+
async function run() {
|
|
1105
|
+
const result = await unifiedTo.hris.listHrisLocations({
|
|
1106
|
+
connectionId: "<value>",
|
|
1107
|
+
});
|
|
1108
|
+
|
|
1109
|
+
// Handle the result
|
|
1110
|
+
console.log(result);
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
run();
|
|
1114
|
+
```
|
|
1115
|
+
|
|
1116
|
+
### Standalone function
|
|
1117
|
+
|
|
1118
|
+
The standalone function version of this method:
|
|
1119
|
+
|
|
1120
|
+
```typescript
|
|
1121
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1122
|
+
import { hrisListHrisLocations } from "@unified-api/typescript-sdk/funcs/hrisListHrisLocations.js";
|
|
1123
|
+
|
|
1124
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1125
|
+
// You can create one instance of it to use across an application.
|
|
1126
|
+
const unifiedTo = new UnifiedToCore({
|
|
1127
|
+
security: {
|
|
1128
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1129
|
+
},
|
|
1130
|
+
});
|
|
1131
|
+
|
|
1132
|
+
async function run() {
|
|
1133
|
+
const res = await hrisListHrisLocations(unifiedTo, {
|
|
1134
|
+
connectionId: "<value>",
|
|
1135
|
+
});
|
|
1136
|
+
|
|
1137
|
+
if (!res.ok) {
|
|
1138
|
+
throw res.error;
|
|
1139
|
+
}
|
|
1140
|
+
|
|
1141
|
+
const { value: result } = res;
|
|
1142
|
+
|
|
1143
|
+
// Handle the result
|
|
1144
|
+
console.log(result);
|
|
1145
|
+
}
|
|
1146
|
+
|
|
1147
|
+
run();
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
### Parameters
|
|
1151
|
+
|
|
1152
|
+
| Parameter | Type | Required | Description |
|
|
1153
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1154
|
+
| `request` | [operations.ListHrisLocationsRequest](../../sdk/models/operations/listhrislocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1155
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1156
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1157
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1158
|
+
|
|
1159
|
+
### Response
|
|
1160
|
+
|
|
1161
|
+
**Promise\<[shared.HrisLocation[]](../../models/.md)\>**
|
|
1162
|
+
|
|
1163
|
+
### Errors
|
|
1164
|
+
|
|
1165
|
+
| Error Type | Status Code | Content Type |
|
|
1166
|
+
| --------------- | --------------- | --------------- |
|
|
1167
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1168
|
+
|
|
1169
|
+
## listHrisPayslips
|
|
1170
|
+
|
|
1171
|
+
List all payslips
|
|
1172
|
+
|
|
1173
|
+
### Example Usage
|
|
1174
|
+
|
|
1175
|
+
```typescript
|
|
1176
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1177
|
+
|
|
1178
|
+
const unifiedTo = new UnifiedTo({
|
|
1179
|
+
security: {
|
|
1180
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1181
|
+
},
|
|
1182
|
+
});
|
|
1183
|
+
|
|
1184
|
+
async function run() {
|
|
1185
|
+
const result = await unifiedTo.hris.listHrisPayslips({
|
|
1186
|
+
connectionId: "<value>",
|
|
1187
|
+
});
|
|
1188
|
+
|
|
1189
|
+
// Handle the result
|
|
1190
|
+
console.log(result);
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
run();
|
|
1194
|
+
```
|
|
1195
|
+
|
|
1196
|
+
### Standalone function
|
|
1197
|
+
|
|
1198
|
+
The standalone function version of this method:
|
|
1199
|
+
|
|
1200
|
+
```typescript
|
|
1201
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1202
|
+
import { hrisListHrisPayslips } from "@unified-api/typescript-sdk/funcs/hrisListHrisPayslips.js";
|
|
1203
|
+
|
|
1204
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1205
|
+
// You can create one instance of it to use across an application.
|
|
1206
|
+
const unifiedTo = new UnifiedToCore({
|
|
1207
|
+
security: {
|
|
1208
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1209
|
+
},
|
|
1210
|
+
});
|
|
1211
|
+
|
|
1212
|
+
async function run() {
|
|
1213
|
+
const res = await hrisListHrisPayslips(unifiedTo, {
|
|
1214
|
+
connectionId: "<value>",
|
|
1215
|
+
});
|
|
1216
|
+
|
|
1217
|
+
if (!res.ok) {
|
|
1218
|
+
throw res.error;
|
|
1219
|
+
}
|
|
1220
|
+
|
|
1221
|
+
const { value: result } = res;
|
|
1222
|
+
|
|
1223
|
+
// Handle the result
|
|
1224
|
+
console.log(result);
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1227
|
+
run();
|
|
1228
|
+
```
|
|
1229
|
+
|
|
1230
|
+
### Parameters
|
|
1231
|
+
|
|
1232
|
+
| Parameter | Type | Required | Description |
|
|
1233
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1234
|
+
| `request` | [operations.ListHrisPayslipsRequest](../../sdk/models/operations/listhrispayslipsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1235
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1236
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1237
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1238
|
+
|
|
1239
|
+
### Response
|
|
1240
|
+
|
|
1241
|
+
**Promise\<[shared.HrisPayslip[]](../../models/.md)\>**
|
|
1242
|
+
|
|
1243
|
+
### Errors
|
|
1244
|
+
|
|
1245
|
+
| Error Type | Status Code | Content Type |
|
|
1246
|
+
| --------------- | --------------- | --------------- |
|
|
1247
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1248
|
+
|
|
1249
|
+
## listHrisTimeoffs
|
|
1250
|
+
|
|
1251
|
+
List all timeoffs
|
|
1252
|
+
|
|
1253
|
+
### Example Usage
|
|
1254
|
+
|
|
1255
|
+
```typescript
|
|
1256
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1257
|
+
|
|
1258
|
+
const unifiedTo = new UnifiedTo({
|
|
1259
|
+
security: {
|
|
1260
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1261
|
+
},
|
|
1262
|
+
});
|
|
1263
|
+
|
|
1264
|
+
async function run() {
|
|
1265
|
+
const result = await unifiedTo.hris.listHrisTimeoffs({
|
|
1266
|
+
connectionId: "<value>",
|
|
1267
|
+
});
|
|
1268
|
+
|
|
1269
|
+
// Handle the result
|
|
1270
|
+
console.log(result);
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
run();
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
### Standalone function
|
|
1277
|
+
|
|
1278
|
+
The standalone function version of this method:
|
|
1279
|
+
|
|
1280
|
+
```typescript
|
|
1281
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1282
|
+
import { hrisListHrisTimeoffs } from "@unified-api/typescript-sdk/funcs/hrisListHrisTimeoffs.js";
|
|
1283
|
+
|
|
1284
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1285
|
+
// You can create one instance of it to use across an application.
|
|
1286
|
+
const unifiedTo = new UnifiedToCore({
|
|
1287
|
+
security: {
|
|
1288
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1289
|
+
},
|
|
1290
|
+
});
|
|
1291
|
+
|
|
1292
|
+
async function run() {
|
|
1293
|
+
const res = await hrisListHrisTimeoffs(unifiedTo, {
|
|
1294
|
+
connectionId: "<value>",
|
|
1295
|
+
});
|
|
1296
|
+
|
|
1297
|
+
if (!res.ok) {
|
|
1298
|
+
throw res.error;
|
|
1299
|
+
}
|
|
1300
|
+
|
|
1301
|
+
const { value: result } = res;
|
|
1302
|
+
|
|
1303
|
+
// Handle the result
|
|
1304
|
+
console.log(result);
|
|
1305
|
+
}
|
|
1306
|
+
|
|
1307
|
+
run();
|
|
1308
|
+
```
|
|
1309
|
+
|
|
1310
|
+
### Parameters
|
|
1311
|
+
|
|
1312
|
+
| Parameter | Type | Required | Description |
|
|
1313
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1314
|
+
| `request` | [operations.ListHrisTimeoffsRequest](../../sdk/models/operations/listhristimeoffsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1315
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1316
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1317
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1318
|
+
|
|
1319
|
+
### Response
|
|
1320
|
+
|
|
1321
|
+
**Promise\<[shared.HrisTimeoff[]](../../models/.md)\>**
|
|
1322
|
+
|
|
1323
|
+
### Errors
|
|
1324
|
+
|
|
1325
|
+
| Error Type | Status Code | Content Type |
|
|
1326
|
+
| --------------- | --------------- | --------------- |
|
|
1327
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1328
|
+
|
|
1329
|
+
## patchHrisCompany
|
|
1330
|
+
|
|
1331
|
+
Update a company
|
|
1332
|
+
|
|
1333
|
+
### Example Usage
|
|
1334
|
+
|
|
1335
|
+
```typescript
|
|
1336
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1337
|
+
|
|
1338
|
+
const unifiedTo = new UnifiedTo({
|
|
1339
|
+
security: {
|
|
1340
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1341
|
+
},
|
|
1342
|
+
});
|
|
1343
|
+
|
|
1344
|
+
async function run() {
|
|
1345
|
+
const result = await unifiedTo.hris.patchHrisCompany({
|
|
1346
|
+
connectionId: "<value>",
|
|
1347
|
+
id: "<id>",
|
|
1348
|
+
});
|
|
1349
|
+
|
|
1350
|
+
// Handle the result
|
|
1351
|
+
console.log(result);
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
run();
|
|
1355
|
+
```
|
|
1356
|
+
|
|
1357
|
+
### Standalone function
|
|
1358
|
+
|
|
1359
|
+
The standalone function version of this method:
|
|
1360
|
+
|
|
1361
|
+
```typescript
|
|
1362
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1363
|
+
import { hrisPatchHrisCompany } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisCompany.js";
|
|
1364
|
+
|
|
1365
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1366
|
+
// You can create one instance of it to use across an application.
|
|
1367
|
+
const unifiedTo = new UnifiedToCore({
|
|
1368
|
+
security: {
|
|
1369
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1370
|
+
},
|
|
1371
|
+
});
|
|
1372
|
+
|
|
1373
|
+
async function run() {
|
|
1374
|
+
const res = await hrisPatchHrisCompany(unifiedTo, {
|
|
1375
|
+
connectionId: "<value>",
|
|
1376
|
+
id: "<id>",
|
|
1377
|
+
});
|
|
1378
|
+
|
|
1379
|
+
if (!res.ok) {
|
|
1380
|
+
throw res.error;
|
|
1381
|
+
}
|
|
1382
|
+
|
|
1383
|
+
const { value: result } = res;
|
|
1384
|
+
|
|
1385
|
+
// Handle the result
|
|
1386
|
+
console.log(result);
|
|
1387
|
+
}
|
|
1388
|
+
|
|
1389
|
+
run();
|
|
1390
|
+
```
|
|
1391
|
+
|
|
1392
|
+
### Parameters
|
|
1393
|
+
|
|
1394
|
+
| Parameter | Type | Required | Description |
|
|
1395
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1396
|
+
| `request` | [operations.PatchHrisCompanyRequest](../../sdk/models/operations/patchhriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1397
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1398
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1399
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1400
|
+
|
|
1401
|
+
### Response
|
|
1402
|
+
|
|
1403
|
+
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
1404
|
+
|
|
1405
|
+
### Errors
|
|
1406
|
+
|
|
1407
|
+
| Error Type | Status Code | Content Type |
|
|
1408
|
+
| --------------- | --------------- | --------------- |
|
|
1409
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1410
|
+
|
|
1411
|
+
## patchHrisEmployee
|
|
1412
|
+
|
|
1413
|
+
Update an employee
|
|
1414
|
+
|
|
1415
|
+
### Example Usage
|
|
1416
|
+
|
|
1417
|
+
```typescript
|
|
1418
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1419
|
+
|
|
1420
|
+
const unifiedTo = new UnifiedTo({
|
|
1421
|
+
security: {
|
|
1422
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1423
|
+
},
|
|
1424
|
+
});
|
|
1425
|
+
|
|
1426
|
+
async function run() {
|
|
1427
|
+
const result = await unifiedTo.hris.patchHrisEmployee({
|
|
1428
|
+
connectionId: "<value>",
|
|
1429
|
+
id: "<id>",
|
|
1430
|
+
});
|
|
1431
|
+
|
|
1432
|
+
// Handle the result
|
|
1433
|
+
console.log(result);
|
|
1434
|
+
}
|
|
1435
|
+
|
|
1436
|
+
run();
|
|
1437
|
+
```
|
|
1438
|
+
|
|
1439
|
+
### Standalone function
|
|
1440
|
+
|
|
1441
|
+
The standalone function version of this method:
|
|
1442
|
+
|
|
1443
|
+
```typescript
|
|
1444
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1445
|
+
import { hrisPatchHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisEmployee.js";
|
|
1446
|
+
|
|
1447
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1448
|
+
// You can create one instance of it to use across an application.
|
|
1449
|
+
const unifiedTo = new UnifiedToCore({
|
|
1450
|
+
security: {
|
|
1451
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1452
|
+
},
|
|
1453
|
+
});
|
|
1454
|
+
|
|
1455
|
+
async function run() {
|
|
1456
|
+
const res = await hrisPatchHrisEmployee(unifiedTo, {
|
|
1457
|
+
connectionId: "<value>",
|
|
1458
|
+
id: "<id>",
|
|
1459
|
+
});
|
|
1460
|
+
|
|
1461
|
+
if (!res.ok) {
|
|
1462
|
+
throw res.error;
|
|
1463
|
+
}
|
|
1464
|
+
|
|
1465
|
+
const { value: result } = res;
|
|
1466
|
+
|
|
1467
|
+
// Handle the result
|
|
1468
|
+
console.log(result);
|
|
1469
|
+
}
|
|
1470
|
+
|
|
1471
|
+
run();
|
|
1472
|
+
```
|
|
1473
|
+
|
|
1474
|
+
### Parameters
|
|
1475
|
+
|
|
1476
|
+
| Parameter | Type | Required | Description |
|
|
1477
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1478
|
+
| `request` | [operations.PatchHrisEmployeeRequest](../../sdk/models/operations/patchhrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1479
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1480
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1481
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1482
|
+
|
|
1483
|
+
### Response
|
|
1484
|
+
|
|
1485
|
+
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
1486
|
+
|
|
1487
|
+
### Errors
|
|
1488
|
+
|
|
1489
|
+
| Error Type | Status Code | Content Type |
|
|
1490
|
+
| --------------- | --------------- | --------------- |
|
|
1491
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1492
|
+
|
|
1493
|
+
## patchHrisGroup
|
|
1494
|
+
|
|
1495
|
+
Update a group
|
|
1496
|
+
|
|
1497
|
+
### Example Usage
|
|
1498
|
+
|
|
1499
|
+
```typescript
|
|
1500
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1501
|
+
|
|
1502
|
+
const unifiedTo = new UnifiedTo({
|
|
1503
|
+
security: {
|
|
1504
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1505
|
+
},
|
|
1506
|
+
});
|
|
1507
|
+
|
|
1508
|
+
async function run() {
|
|
1509
|
+
const result = await unifiedTo.hris.patchHrisGroup({
|
|
1510
|
+
connectionId: "<value>",
|
|
1511
|
+
id: "<id>",
|
|
1512
|
+
});
|
|
1513
|
+
|
|
1514
|
+
// Handle the result
|
|
1515
|
+
console.log(result);
|
|
1516
|
+
}
|
|
1517
|
+
|
|
1518
|
+
run();
|
|
1519
|
+
```
|
|
1520
|
+
|
|
1521
|
+
### Standalone function
|
|
1522
|
+
|
|
1523
|
+
The standalone function version of this method:
|
|
1524
|
+
|
|
1525
|
+
```typescript
|
|
1526
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1527
|
+
import { hrisPatchHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisGroup.js";
|
|
1528
|
+
|
|
1529
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1530
|
+
// You can create one instance of it to use across an application.
|
|
1531
|
+
const unifiedTo = new UnifiedToCore({
|
|
1532
|
+
security: {
|
|
1533
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1534
|
+
},
|
|
1535
|
+
});
|
|
1536
|
+
|
|
1537
|
+
async function run() {
|
|
1538
|
+
const res = await hrisPatchHrisGroup(unifiedTo, {
|
|
1539
|
+
connectionId: "<value>",
|
|
1540
|
+
id: "<id>",
|
|
1541
|
+
});
|
|
1542
|
+
|
|
1543
|
+
if (!res.ok) {
|
|
1544
|
+
throw res.error;
|
|
1545
|
+
}
|
|
1546
|
+
|
|
1547
|
+
const { value: result } = res;
|
|
1548
|
+
|
|
1549
|
+
// Handle the result
|
|
1550
|
+
console.log(result);
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1553
|
+
run();
|
|
1554
|
+
```
|
|
1555
|
+
|
|
1556
|
+
### Parameters
|
|
1557
|
+
|
|
1558
|
+
| Parameter | Type | Required | Description |
|
|
1559
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1560
|
+
| `request` | [operations.PatchHrisGroupRequest](../../sdk/models/operations/patchhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1561
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1562
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1563
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1564
|
+
|
|
1565
|
+
### Response
|
|
1566
|
+
|
|
1567
|
+
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
1568
|
+
|
|
1569
|
+
### Errors
|
|
1570
|
+
|
|
1571
|
+
| Error Type | Status Code | Content Type |
|
|
1572
|
+
| --------------- | --------------- | --------------- |
|
|
1573
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1574
|
+
|
|
1575
|
+
## patchHrisLocation
|
|
1576
|
+
|
|
1577
|
+
Update a location
|
|
1578
|
+
|
|
1579
|
+
### Example Usage
|
|
1580
|
+
|
|
1581
|
+
```typescript
|
|
1582
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1583
|
+
|
|
1584
|
+
const unifiedTo = new UnifiedTo({
|
|
1585
|
+
security: {
|
|
1586
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1587
|
+
},
|
|
1588
|
+
});
|
|
1589
|
+
|
|
1590
|
+
async function run() {
|
|
1591
|
+
const result = await unifiedTo.hris.patchHrisLocation({
|
|
1592
|
+
connectionId: "<value>",
|
|
1593
|
+
id: "<id>",
|
|
1594
|
+
});
|
|
1595
|
+
|
|
1596
|
+
// Handle the result
|
|
1597
|
+
console.log(result);
|
|
1598
|
+
}
|
|
1599
|
+
|
|
1600
|
+
run();
|
|
1601
|
+
```
|
|
1602
|
+
|
|
1603
|
+
### Standalone function
|
|
1604
|
+
|
|
1605
|
+
The standalone function version of this method:
|
|
1606
|
+
|
|
1607
|
+
```typescript
|
|
1608
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1609
|
+
import { hrisPatchHrisLocation } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisLocation.js";
|
|
1610
|
+
|
|
1611
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1612
|
+
// You can create one instance of it to use across an application.
|
|
1613
|
+
const unifiedTo = new UnifiedToCore({
|
|
1614
|
+
security: {
|
|
1615
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1616
|
+
},
|
|
1617
|
+
});
|
|
1618
|
+
|
|
1619
|
+
async function run() {
|
|
1620
|
+
const res = await hrisPatchHrisLocation(unifiedTo, {
|
|
1621
|
+
connectionId: "<value>",
|
|
1622
|
+
id: "<id>",
|
|
1623
|
+
});
|
|
1624
|
+
|
|
1625
|
+
if (!res.ok) {
|
|
1626
|
+
throw res.error;
|
|
1627
|
+
}
|
|
1628
|
+
|
|
1629
|
+
const { value: result } = res;
|
|
1630
|
+
|
|
1631
|
+
// Handle the result
|
|
1632
|
+
console.log(result);
|
|
1633
|
+
}
|
|
1634
|
+
|
|
1635
|
+
run();
|
|
1636
|
+
```
|
|
1637
|
+
|
|
1638
|
+
### Parameters
|
|
1639
|
+
|
|
1640
|
+
| Parameter | Type | Required | Description |
|
|
1641
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1642
|
+
| `request` | [operations.PatchHrisLocationRequest](../../sdk/models/operations/patchhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1643
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1644
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1645
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1646
|
+
|
|
1647
|
+
### Response
|
|
1648
|
+
|
|
1649
|
+
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
1650
|
+
|
|
1651
|
+
### Errors
|
|
1652
|
+
|
|
1653
|
+
| Error Type | Status Code | Content Type |
|
|
1654
|
+
| --------------- | --------------- | --------------- |
|
|
1655
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1656
|
+
|
|
1657
|
+
## removeHrisCompany
|
|
1658
|
+
|
|
1659
|
+
Remove a company
|
|
1660
|
+
|
|
1661
|
+
### Example Usage
|
|
1662
|
+
|
|
1663
|
+
```typescript
|
|
1664
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1665
|
+
|
|
1666
|
+
const unifiedTo = new UnifiedTo({
|
|
1667
|
+
security: {
|
|
1668
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1669
|
+
},
|
|
1670
|
+
});
|
|
1671
|
+
|
|
1672
|
+
async function run() {
|
|
1673
|
+
const result = await unifiedTo.hris.removeHrisCompany({
|
|
1674
|
+
connectionId: "<value>",
|
|
1675
|
+
id: "<id>",
|
|
1676
|
+
});
|
|
1677
|
+
|
|
1678
|
+
// Handle the result
|
|
1679
|
+
console.log(result);
|
|
1680
|
+
}
|
|
1681
|
+
|
|
1682
|
+
run();
|
|
1683
|
+
```
|
|
1684
|
+
|
|
1685
|
+
### Standalone function
|
|
1686
|
+
|
|
1687
|
+
The standalone function version of this method:
|
|
1688
|
+
|
|
1689
|
+
```typescript
|
|
1690
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1691
|
+
import { hrisRemoveHrisCompany } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisCompany.js";
|
|
1692
|
+
|
|
1693
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1694
|
+
// You can create one instance of it to use across an application.
|
|
1695
|
+
const unifiedTo = new UnifiedToCore({
|
|
1696
|
+
security: {
|
|
1697
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1698
|
+
},
|
|
1699
|
+
});
|
|
1700
|
+
|
|
1701
|
+
async function run() {
|
|
1702
|
+
const res = await hrisRemoveHrisCompany(unifiedTo, {
|
|
1703
|
+
connectionId: "<value>",
|
|
1704
|
+
id: "<id>",
|
|
1705
|
+
});
|
|
1706
|
+
|
|
1707
|
+
if (!res.ok) {
|
|
1708
|
+
throw res.error;
|
|
1709
|
+
}
|
|
1710
|
+
|
|
1711
|
+
const { value: result } = res;
|
|
1712
|
+
|
|
1713
|
+
// Handle the result
|
|
1714
|
+
console.log(result);
|
|
1715
|
+
}
|
|
1716
|
+
|
|
1717
|
+
run();
|
|
1718
|
+
```
|
|
1719
|
+
|
|
1720
|
+
### Parameters
|
|
1721
|
+
|
|
1722
|
+
| Parameter | Type | Required | Description |
|
|
1723
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1724
|
+
| `request` | [operations.RemoveHrisCompanyRequest](../../sdk/models/operations/removehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1725
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1726
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1727
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1728
|
+
|
|
1729
|
+
### Response
|
|
1730
|
+
|
|
1731
|
+
**Promise\<[operations.RemoveHrisCompanyResponse](../../sdk/models/operations/removehriscompanyresponse.md)\>**
|
|
1732
|
+
|
|
1733
|
+
### Errors
|
|
1734
|
+
|
|
1735
|
+
| Error Type | Status Code | Content Type |
|
|
1736
|
+
| --------------- | --------------- | --------------- |
|
|
1737
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1738
|
+
|
|
1739
|
+
## removeHrisEmployee
|
|
1740
|
+
|
|
1741
|
+
Remove an employee
|
|
1742
|
+
|
|
1743
|
+
### Example Usage
|
|
1744
|
+
|
|
1745
|
+
```typescript
|
|
1746
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1747
|
+
|
|
1748
|
+
const unifiedTo = new UnifiedTo({
|
|
1749
|
+
security: {
|
|
1750
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1751
|
+
},
|
|
1752
|
+
});
|
|
1753
|
+
|
|
1754
|
+
async function run() {
|
|
1755
|
+
const result = await unifiedTo.hris.removeHrisEmployee({
|
|
1756
|
+
connectionId: "<value>",
|
|
1757
|
+
id: "<id>",
|
|
1758
|
+
});
|
|
1759
|
+
|
|
1760
|
+
// Handle the result
|
|
1761
|
+
console.log(result);
|
|
1762
|
+
}
|
|
1763
|
+
|
|
1764
|
+
run();
|
|
1765
|
+
```
|
|
1766
|
+
|
|
1767
|
+
### Standalone function
|
|
1768
|
+
|
|
1769
|
+
The standalone function version of this method:
|
|
1770
|
+
|
|
1771
|
+
```typescript
|
|
1772
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1773
|
+
import { hrisRemoveHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisEmployee.js";
|
|
1774
|
+
|
|
1775
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1776
|
+
// You can create one instance of it to use across an application.
|
|
1777
|
+
const unifiedTo = new UnifiedToCore({
|
|
1778
|
+
security: {
|
|
1779
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1780
|
+
},
|
|
1781
|
+
});
|
|
1782
|
+
|
|
1783
|
+
async function run() {
|
|
1784
|
+
const res = await hrisRemoveHrisEmployee(unifiedTo, {
|
|
1785
|
+
connectionId: "<value>",
|
|
1786
|
+
id: "<id>",
|
|
1787
|
+
});
|
|
1788
|
+
|
|
1789
|
+
if (!res.ok) {
|
|
1790
|
+
throw res.error;
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1793
|
+
const { value: result } = res;
|
|
1794
|
+
|
|
1795
|
+
// Handle the result
|
|
1796
|
+
console.log(result);
|
|
1797
|
+
}
|
|
1798
|
+
|
|
1799
|
+
run();
|
|
1800
|
+
```
|
|
1801
|
+
|
|
1802
|
+
### Parameters
|
|
1803
|
+
|
|
1804
|
+
| Parameter | Type | Required | Description |
|
|
1805
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1806
|
+
| `request` | [operations.RemoveHrisEmployeeRequest](../../sdk/models/operations/removehrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1807
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1808
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1809
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1810
|
+
|
|
1811
|
+
### Response
|
|
1812
|
+
|
|
1813
|
+
**Promise\<[operations.RemoveHrisEmployeeResponse](../../sdk/models/operations/removehrisemployeeresponse.md)\>**
|
|
1814
|
+
|
|
1815
|
+
### Errors
|
|
1816
|
+
|
|
1817
|
+
| Error Type | Status Code | Content Type |
|
|
1818
|
+
| --------------- | --------------- | --------------- |
|
|
1819
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1820
|
+
|
|
1821
|
+
## removeHrisGroup
|
|
1822
|
+
|
|
1823
|
+
Remove a group
|
|
1824
|
+
|
|
1825
|
+
### Example Usage
|
|
1826
|
+
|
|
1827
|
+
```typescript
|
|
1828
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1829
|
+
|
|
1830
|
+
const unifiedTo = new UnifiedTo({
|
|
1831
|
+
security: {
|
|
1832
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1833
|
+
},
|
|
1834
|
+
});
|
|
1835
|
+
|
|
1836
|
+
async function run() {
|
|
1837
|
+
const result = await unifiedTo.hris.removeHrisGroup({
|
|
1838
|
+
connectionId: "<value>",
|
|
1839
|
+
id: "<id>",
|
|
1840
|
+
});
|
|
1841
|
+
|
|
1842
|
+
// Handle the result
|
|
1843
|
+
console.log(result);
|
|
1844
|
+
}
|
|
1845
|
+
|
|
1846
|
+
run();
|
|
1847
|
+
```
|
|
1848
|
+
|
|
1849
|
+
### Standalone function
|
|
1850
|
+
|
|
1851
|
+
The standalone function version of this method:
|
|
1852
|
+
|
|
1853
|
+
```typescript
|
|
1854
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1855
|
+
import { hrisRemoveHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisGroup.js";
|
|
1856
|
+
|
|
1857
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1858
|
+
// You can create one instance of it to use across an application.
|
|
1859
|
+
const unifiedTo = new UnifiedToCore({
|
|
1860
|
+
security: {
|
|
1861
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1862
|
+
},
|
|
1863
|
+
});
|
|
1864
|
+
|
|
1865
|
+
async function run() {
|
|
1866
|
+
const res = await hrisRemoveHrisGroup(unifiedTo, {
|
|
1867
|
+
connectionId: "<value>",
|
|
1868
|
+
id: "<id>",
|
|
1869
|
+
});
|
|
1870
|
+
|
|
1871
|
+
if (!res.ok) {
|
|
1872
|
+
throw res.error;
|
|
1873
|
+
}
|
|
1874
|
+
|
|
1875
|
+
const { value: result } = res;
|
|
1876
|
+
|
|
1877
|
+
// Handle the result
|
|
1878
|
+
console.log(result);
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
run();
|
|
1882
|
+
```
|
|
1883
|
+
|
|
1884
|
+
### Parameters
|
|
1885
|
+
|
|
1886
|
+
| Parameter | Type | Required | Description |
|
|
1887
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1888
|
+
| `request` | [operations.RemoveHrisGroupRequest](../../sdk/models/operations/removehrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1889
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1890
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1891
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1892
|
+
|
|
1893
|
+
### Response
|
|
1894
|
+
|
|
1895
|
+
**Promise\<[operations.RemoveHrisGroupResponse](../../sdk/models/operations/removehrisgroupresponse.md)\>**
|
|
1896
|
+
|
|
1897
|
+
### Errors
|
|
1898
|
+
|
|
1899
|
+
| Error Type | Status Code | Content Type |
|
|
1900
|
+
| --------------- | --------------- | --------------- |
|
|
1901
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1902
|
+
|
|
1903
|
+
## removeHrisLocation
|
|
1904
|
+
|
|
1905
|
+
Remove a location
|
|
1906
|
+
|
|
1907
|
+
### Example Usage
|
|
1908
|
+
|
|
1909
|
+
```typescript
|
|
1910
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1911
|
+
|
|
1912
|
+
const unifiedTo = new UnifiedTo({
|
|
1913
|
+
security: {
|
|
1914
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1915
|
+
},
|
|
1916
|
+
});
|
|
1917
|
+
|
|
1918
|
+
async function run() {
|
|
1919
|
+
const result = await unifiedTo.hris.removeHrisLocation({
|
|
1920
|
+
connectionId: "<value>",
|
|
1921
|
+
id: "<id>",
|
|
1922
|
+
});
|
|
1923
|
+
|
|
1924
|
+
// Handle the result
|
|
1925
|
+
console.log(result);
|
|
1926
|
+
}
|
|
1927
|
+
|
|
1928
|
+
run();
|
|
1929
|
+
```
|
|
1930
|
+
|
|
1931
|
+
### Standalone function
|
|
1932
|
+
|
|
1933
|
+
The standalone function version of this method:
|
|
1934
|
+
|
|
1935
|
+
```typescript
|
|
1936
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1937
|
+
import { hrisRemoveHrisLocation } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisLocation.js";
|
|
1938
|
+
|
|
1939
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1940
|
+
// You can create one instance of it to use across an application.
|
|
1941
|
+
const unifiedTo = new UnifiedToCore({
|
|
1942
|
+
security: {
|
|
1943
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1944
|
+
},
|
|
1945
|
+
});
|
|
1946
|
+
|
|
1947
|
+
async function run() {
|
|
1948
|
+
const res = await hrisRemoveHrisLocation(unifiedTo, {
|
|
1949
|
+
connectionId: "<value>",
|
|
1950
|
+
id: "<id>",
|
|
1951
|
+
});
|
|
1952
|
+
|
|
1953
|
+
if (!res.ok) {
|
|
1954
|
+
throw res.error;
|
|
1955
|
+
}
|
|
1956
|
+
|
|
1957
|
+
const { value: result } = res;
|
|
1958
|
+
|
|
1959
|
+
// Handle the result
|
|
1960
|
+
console.log(result);
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
run();
|
|
1964
|
+
```
|
|
1965
|
+
|
|
1966
|
+
### Parameters
|
|
1967
|
+
|
|
1968
|
+
| Parameter | Type | Required | Description |
|
|
1969
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1970
|
+
| `request` | [operations.RemoveHrisLocationRequest](../../sdk/models/operations/removehrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1971
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1972
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1973
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1974
|
+
|
|
1975
|
+
### Response
|
|
1976
|
+
|
|
1977
|
+
**Promise\<[operations.RemoveHrisLocationResponse](../../sdk/models/operations/removehrislocationresponse.md)\>**
|
|
1978
|
+
|
|
1979
|
+
### Errors
|
|
1980
|
+
|
|
1981
|
+
| Error Type | Status Code | Content Type |
|
|
1982
|
+
| --------------- | --------------- | --------------- |
|
|
1983
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1984
|
+
|
|
1985
|
+
## updateHrisCompany
|
|
1986
|
+
|
|
1987
|
+
Update a company
|
|
1988
|
+
|
|
1989
|
+
### Example Usage
|
|
1990
|
+
|
|
1991
|
+
```typescript
|
|
1992
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1993
|
+
|
|
1994
|
+
const unifiedTo = new UnifiedTo({
|
|
1995
|
+
security: {
|
|
1996
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1997
|
+
},
|
|
1998
|
+
});
|
|
1999
|
+
|
|
2000
|
+
async function run() {
|
|
2001
|
+
const result = await unifiedTo.hris.updateHrisCompany({
|
|
2002
|
+
connectionId: "<value>",
|
|
2003
|
+
id: "<id>",
|
|
2004
|
+
});
|
|
2005
|
+
|
|
2006
|
+
// Handle the result
|
|
2007
|
+
console.log(result);
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
run();
|
|
2011
|
+
```
|
|
2012
|
+
|
|
2013
|
+
### Standalone function
|
|
2014
|
+
|
|
2015
|
+
The standalone function version of this method:
|
|
2016
|
+
|
|
2017
|
+
```typescript
|
|
2018
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2019
|
+
import { hrisUpdateHrisCompany } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisCompany.js";
|
|
2020
|
+
|
|
2021
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2022
|
+
// You can create one instance of it to use across an application.
|
|
2023
|
+
const unifiedTo = new UnifiedToCore({
|
|
2024
|
+
security: {
|
|
2025
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2026
|
+
},
|
|
2027
|
+
});
|
|
2028
|
+
|
|
2029
|
+
async function run() {
|
|
2030
|
+
const res = await hrisUpdateHrisCompany(unifiedTo, {
|
|
2031
|
+
connectionId: "<value>",
|
|
2032
|
+
id: "<id>",
|
|
2033
|
+
});
|
|
2034
|
+
|
|
2035
|
+
if (!res.ok) {
|
|
2036
|
+
throw res.error;
|
|
2037
|
+
}
|
|
2038
|
+
|
|
2039
|
+
const { value: result } = res;
|
|
2040
|
+
|
|
2041
|
+
// Handle the result
|
|
2042
|
+
console.log(result);
|
|
2043
|
+
}
|
|
2044
|
+
|
|
2045
|
+
run();
|
|
2046
|
+
```
|
|
2047
|
+
|
|
2048
|
+
### Parameters
|
|
2049
|
+
|
|
2050
|
+
| Parameter | Type | Required | Description |
|
|
2051
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2052
|
+
| `request` | [operations.UpdateHrisCompanyRequest](../../sdk/models/operations/updatehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2053
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2054
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2055
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2056
|
+
|
|
2057
|
+
### Response
|
|
2058
|
+
|
|
2059
|
+
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
2060
|
+
|
|
2061
|
+
### Errors
|
|
2062
|
+
|
|
2063
|
+
| Error Type | Status Code | Content Type |
|
|
2064
|
+
| --------------- | --------------- | --------------- |
|
|
2065
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2066
|
+
|
|
2067
|
+
## updateHrisEmployee
|
|
2068
|
+
|
|
2069
|
+
Update an employee
|
|
2070
|
+
|
|
2071
|
+
### Example Usage
|
|
2072
|
+
|
|
2073
|
+
```typescript
|
|
2074
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2075
|
+
|
|
2076
|
+
const unifiedTo = new UnifiedTo({
|
|
2077
|
+
security: {
|
|
2078
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2079
|
+
},
|
|
2080
|
+
});
|
|
2081
|
+
|
|
2082
|
+
async function run() {
|
|
2083
|
+
const result = await unifiedTo.hris.updateHrisEmployee({
|
|
2084
|
+
connectionId: "<value>",
|
|
2085
|
+
id: "<id>",
|
|
2086
|
+
});
|
|
2087
|
+
|
|
2088
|
+
// Handle the result
|
|
2089
|
+
console.log(result);
|
|
2090
|
+
}
|
|
2091
|
+
|
|
2092
|
+
run();
|
|
2093
|
+
```
|
|
2094
|
+
|
|
2095
|
+
### Standalone function
|
|
2096
|
+
|
|
2097
|
+
The standalone function version of this method:
|
|
2098
|
+
|
|
2099
|
+
```typescript
|
|
2100
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2101
|
+
import { hrisUpdateHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisEmployee.js";
|
|
2102
|
+
|
|
2103
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2104
|
+
// You can create one instance of it to use across an application.
|
|
2105
|
+
const unifiedTo = new UnifiedToCore({
|
|
2106
|
+
security: {
|
|
2107
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2108
|
+
},
|
|
2109
|
+
});
|
|
2110
|
+
|
|
2111
|
+
async function run() {
|
|
2112
|
+
const res = await hrisUpdateHrisEmployee(unifiedTo, {
|
|
2113
|
+
connectionId: "<value>",
|
|
2114
|
+
id: "<id>",
|
|
2115
|
+
});
|
|
2116
|
+
|
|
2117
|
+
if (!res.ok) {
|
|
2118
|
+
throw res.error;
|
|
2119
|
+
}
|
|
2120
|
+
|
|
2121
|
+
const { value: result } = res;
|
|
2122
|
+
|
|
2123
|
+
// Handle the result
|
|
2124
|
+
console.log(result);
|
|
2125
|
+
}
|
|
2126
|
+
|
|
2127
|
+
run();
|
|
2128
|
+
```
|
|
2129
|
+
|
|
2130
|
+
### Parameters
|
|
2131
|
+
|
|
2132
|
+
| Parameter | Type | Required | Description |
|
|
2133
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2134
|
+
| `request` | [operations.UpdateHrisEmployeeRequest](../../sdk/models/operations/updatehrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2135
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2136
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2137
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2138
|
+
|
|
2139
|
+
### Response
|
|
2140
|
+
|
|
2141
|
+
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
2142
|
+
|
|
2143
|
+
### Errors
|
|
2144
|
+
|
|
2145
|
+
| Error Type | Status Code | Content Type |
|
|
2146
|
+
| --------------- | --------------- | --------------- |
|
|
2147
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2148
|
+
|
|
2149
|
+
## updateHrisGroup
|
|
2150
|
+
|
|
2151
|
+
Update a group
|
|
2152
|
+
|
|
2153
|
+
### Example Usage
|
|
2154
|
+
|
|
2155
|
+
```typescript
|
|
2156
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2157
|
+
|
|
2158
|
+
const unifiedTo = new UnifiedTo({
|
|
2159
|
+
security: {
|
|
2160
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2161
|
+
},
|
|
2162
|
+
});
|
|
2163
|
+
|
|
2164
|
+
async function run() {
|
|
2165
|
+
const result = await unifiedTo.hris.updateHrisGroup({
|
|
2166
|
+
connectionId: "<value>",
|
|
2167
|
+
id: "<id>",
|
|
2168
|
+
});
|
|
2169
|
+
|
|
2170
|
+
// Handle the result
|
|
2171
|
+
console.log(result);
|
|
2172
|
+
}
|
|
2173
|
+
|
|
2174
|
+
run();
|
|
2175
|
+
```
|
|
2176
|
+
|
|
2177
|
+
### Standalone function
|
|
2178
|
+
|
|
2179
|
+
The standalone function version of this method:
|
|
2180
|
+
|
|
2181
|
+
```typescript
|
|
2182
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2183
|
+
import { hrisUpdateHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisGroup.js";
|
|
2184
|
+
|
|
2185
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2186
|
+
// You can create one instance of it to use across an application.
|
|
2187
|
+
const unifiedTo = new UnifiedToCore({
|
|
2188
|
+
security: {
|
|
2189
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2190
|
+
},
|
|
2191
|
+
});
|
|
2192
|
+
|
|
2193
|
+
async function run() {
|
|
2194
|
+
const res = await hrisUpdateHrisGroup(unifiedTo, {
|
|
2195
|
+
connectionId: "<value>",
|
|
2196
|
+
id: "<id>",
|
|
2197
|
+
});
|
|
2198
|
+
|
|
2199
|
+
if (!res.ok) {
|
|
2200
|
+
throw res.error;
|
|
2201
|
+
}
|
|
2202
|
+
|
|
2203
|
+
const { value: result } = res;
|
|
2204
|
+
|
|
2205
|
+
// Handle the result
|
|
2206
|
+
console.log(result);
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
run();
|
|
2210
|
+
```
|
|
2211
|
+
|
|
2212
|
+
### Parameters
|
|
2213
|
+
|
|
2214
|
+
| Parameter | Type | Required | Description |
|
|
2215
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2216
|
+
| `request` | [operations.UpdateHrisGroupRequest](../../sdk/models/operations/updatehrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2217
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2218
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2219
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2220
|
+
|
|
2221
|
+
### Response
|
|
2222
|
+
|
|
2223
|
+
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
2224
|
+
|
|
2225
|
+
### Errors
|
|
2226
|
+
|
|
2227
|
+
| Error Type | Status Code | Content Type |
|
|
2228
|
+
| --------------- | --------------- | --------------- |
|
|
2229
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2230
|
+
|
|
2231
|
+
## updateHrisLocation
|
|
2232
|
+
|
|
2233
|
+
Update a location
|
|
2234
|
+
|
|
2235
|
+
### Example Usage
|
|
2236
|
+
|
|
2237
|
+
```typescript
|
|
2238
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2239
|
+
|
|
2240
|
+
const unifiedTo = new UnifiedTo({
|
|
2241
|
+
security: {
|
|
2242
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2243
|
+
},
|
|
2244
|
+
});
|
|
2245
|
+
|
|
2246
|
+
async function run() {
|
|
2247
|
+
const result = await unifiedTo.hris.updateHrisLocation({
|
|
2248
|
+
connectionId: "<value>",
|
|
2249
|
+
id: "<id>",
|
|
2250
|
+
});
|
|
2251
|
+
|
|
2252
|
+
// Handle the result
|
|
2253
|
+
console.log(result);
|
|
2254
|
+
}
|
|
2255
|
+
|
|
2256
|
+
run();
|
|
2257
|
+
```
|
|
2258
|
+
|
|
2259
|
+
### Standalone function
|
|
2260
|
+
|
|
2261
|
+
The standalone function version of this method:
|
|
2262
|
+
|
|
2263
|
+
```typescript
|
|
2264
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2265
|
+
import { hrisUpdateHrisLocation } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisLocation.js";
|
|
2266
|
+
|
|
2267
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2268
|
+
// You can create one instance of it to use across an application.
|
|
2269
|
+
const unifiedTo = new UnifiedToCore({
|
|
2270
|
+
security: {
|
|
2271
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2272
|
+
},
|
|
2273
|
+
});
|
|
2274
|
+
|
|
2275
|
+
async function run() {
|
|
2276
|
+
const res = await hrisUpdateHrisLocation(unifiedTo, {
|
|
2277
|
+
connectionId: "<value>",
|
|
2278
|
+
id: "<id>",
|
|
2279
|
+
});
|
|
2280
|
+
|
|
2281
|
+
if (!res.ok) {
|
|
2282
|
+
throw res.error;
|
|
2283
|
+
}
|
|
2284
|
+
|
|
2285
|
+
const { value: result } = res;
|
|
2286
|
+
|
|
2287
|
+
// Handle the result
|
|
2288
|
+
console.log(result);
|
|
2289
|
+
}
|
|
2290
|
+
|
|
2291
|
+
run();
|
|
2292
|
+
```
|
|
2293
|
+
|
|
2294
|
+
### Parameters
|
|
2295
|
+
|
|
2296
|
+
| Parameter | Type | Required | Description |
|
|
2297
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2298
|
+
| `request` | [operations.UpdateHrisLocationRequest](../../sdk/models/operations/updatehrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2299
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2300
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2301
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2302
|
+
|
|
2303
|
+
### Response
|
|
2304
|
+
|
|
2305
|
+
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
2306
|
+
|
|
2307
|
+
### Errors
|
|
2308
|
+
|
|
2309
|
+
| Error Type | Status Code | Content Type |
|
|
2310
|
+
| --------------- | --------------- | --------------- |
|
|
2311
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|