@unified-api/typescript-sdk 2.79.0 → 2.80.1
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/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/package.json +1 -1
- package/sdk/models/shared/calendareventrecurrence.d.ts +2 -5
- package/sdk/models/shared/calendareventrecurrence.d.ts.map +1 -1
- package/sdk/models/shared/calendareventrecurrence.js +2 -2
- package/sdk/models/shared/calendareventrecurrence.js.map +1 -1
- package/sdk/models/shared/index.d.ts +5 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +5 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/integration.d.ts +3 -2
- package/sdk/models/shared/integration.d.ts.map +1 -1
- package/sdk/models/shared/integration.js +3 -2
- package/sdk/models/shared/integration.js.map +1 -1
- package/sdk/models/shared/integrationsupport.d.ts +2410 -0
- package/sdk/models/shared/integrationsupport.d.ts.map +1 -0
- package/sdk/models/shared/integrationsupport.js +3440 -0
- package/sdk/models/shared/integrationsupport.js.map +1 -0
- package/sdk/models/shared/kmspage.d.ts +2 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +4 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts +36 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.js +79 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js.map +1 -0
- package/sdk/models/shared/webhook.d.ts +2 -2
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +2 -2
- package/sdk/models/shared/webhook.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/sdk/models/shared/calendareventrecurrence.ts +4 -7
- package/src/sdk/models/shared/index.ts +5 -0
- package/src/sdk/models/shared/integration.ts +10 -4
- package/src/sdk/models/shared/integrationsupport.ts +4969 -0
- package/src/sdk/models/shared/kmspage.ts +6 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookevents.ts +109 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.ts +54 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.ts +54 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.ts +54 -0
- package/src/sdk/models/shared/webhook.ts +4 -4
- package/docs/sdks/account/README.md +0 -489
- package/docs/sdks/accounting/README.md +0 -7221
- package/docs/sdks/activity/README.md +0 -489
- package/docs/sdks/apicall/README.md +0 -159
- package/docs/sdks/application/README.md +0 -489
- package/docs/sdks/applicationstatus/README.md +0 -85
- package/docs/sdks/ats/README.md +0 -3953
- package/docs/sdks/auth/README.md +0 -167
- package/docs/sdks/balancesheet/README.md +0 -165
- package/docs/sdks/bill/README.md +0 -489
- package/docs/sdks/branch/README.md +0 -507
- package/docs/sdks/busy/README.md +0 -85
- package/docs/sdks/calendar/README.md +0 -1713
- package/docs/sdks/call/README.md +0 -85
- package/docs/sdks/candidate/README.md +0 -489
- package/docs/sdks/cashflow/README.md +0 -165
- package/docs/sdks/category/README.md +0 -971
- package/docs/sdks/change/README.md +0 -165
- package/docs/sdks/channel/README.md +0 -165
- package/docs/sdks/class/README.md +0 -507
- package/docs/sdks/collection/README.md +0 -501
- package/docs/sdks/comment/README.md +0 -1495
- package/docs/sdks/commerce/README.md +0 -2465
- package/docs/sdks/commit/README.md +0 -501
- package/docs/sdks/company/README.md +0 -1543
- package/docs/sdks/connection/README.md +0 -513
- package/docs/sdks/contact/README.md +0 -1453
- package/docs/sdks/course/README.md +0 -501
- package/docs/sdks/creditmemo/README.md +0 -489
- package/docs/sdks/crm/README.md +0 -2899
- package/docs/sdks/customer/README.md +0 -489
- package/docs/sdks/deal/README.md +0 -489
- package/docs/sdks/device/README.md +0 -501
- package/docs/sdks/document/README.md +0 -489
- package/docs/sdks/embedding/README.md +0 -87
- package/docs/sdks/employee/README.md +0 -489
- package/docs/sdks/enrich/README.md +0 -163
- package/docs/sdks/event/README.md +0 -971
- package/docs/sdks/expense/README.md +0 -489
- package/docs/sdks/file/README.md +0 -489
- package/docs/sdks/genai/README.md +0 -325
- package/docs/sdks/group/README.md +0 -983
- package/docs/sdks/hris/README.md +0 -3251
- package/docs/sdks/instructor/README.md +0 -489
- package/docs/sdks/integration/README.md +0 -239
- package/docs/sdks/interview/README.md +0 -489
- package/docs/sdks/inventory/README.md +0 -501
- package/docs/sdks/invoice/README.md +0 -489
- package/docs/sdks/issue/README.md +0 -159
- package/docs/sdks/item/README.md +0 -489
- package/docs/sdks/job/README.md +0 -489
- package/docs/sdks/journal/README.md +0 -489
- package/docs/sdks/kms/README.md +0 -1495
- package/docs/sdks/lead/README.md +0 -489
- package/docs/sdks/link/README.md +0 -983
- package/docs/sdks/list/README.md +0 -489
- package/docs/sdks/lms/README.md +0 -1965
- package/docs/sdks/location/README.md +0 -983
- package/docs/sdks/login/README.md +0 -87
- package/docs/sdks/martech/README.md +0 -971
- package/docs/sdks/member/README.md +0 -489
- package/docs/sdks/message/README.md +0 -489
- package/docs/sdks/messaging/README.md +0 -647
- package/docs/sdks/metadata/README.md +0 -507
- package/docs/sdks/model/README.md +0 -165
- package/docs/sdks/note/README.md +0 -489
- package/docs/sdks/order/README.md +0 -489
- package/docs/sdks/organization/README.md +0 -647
- package/docs/sdks/package/README.md +0 -165
- package/docs/sdks/page/README.md +0 -507
- package/docs/sdks/passthrough/README.md +0 -647
- package/docs/sdks/payment/README.md +0 -1769
- package/docs/sdks/payout/README.md +0 -165
- package/docs/sdks/payslip/README.md +0 -165
- package/docs/sdks/person/README.md +0 -85
- package/docs/sdks/pipeline/README.md +0 -489
- package/docs/sdks/profitloss/README.md +0 -165
- package/docs/sdks/project/README.md +0 -489
- package/docs/sdks/prompt/README.md +0 -87
- package/docs/sdks/pullrequest/README.md +0 -489
- package/docs/sdks/purchaseorder/README.md +0 -489
- package/docs/sdks/recording/README.md +0 -647
- package/docs/sdks/refund/README.md +0 -165
- package/docs/sdks/repo/README.md +0 -2459
- package/docs/sdks/report/README.md +0 -165
- package/docs/sdks/repository/README.md +0 -501
- package/docs/sdks/request/README.md +0 -489
- package/docs/sdks/review/README.md +0 -501
- package/docs/sdks/salesorder/README.md +0 -489
- package/docs/sdks/scim/README.md +0 -983
- package/docs/sdks/scorecard/README.md +0 -489
- package/docs/sdks/space/README.md +0 -501
- package/docs/sdks/storage/README.md +0 -489
- package/docs/sdks/student/README.md +0 -489
- package/docs/sdks/subscription/README.md +0 -489
- package/docs/sdks/task/README.md +0 -1629
- package/docs/sdks/taxrate/README.md +0 -489
- package/docs/sdks/ticket/README.md +0 -489
- package/docs/sdks/ticketing/README.md +0 -1935
- package/docs/sdks/timeoff/README.md +0 -165
- package/docs/sdks/timeshift/README.md +0 -513
- package/docs/sdks/transaction/README.md +0 -489
- package/docs/sdks/trialbalance/README.md +0 -165
- package/docs/sdks/uc/README.md +0 -1543
- package/docs/sdks/unified/README.md +0 -1697
- package/docs/sdks/user/README.md +0 -489
- package/docs/sdks/verification/README.md +0 -647
- package/docs/sdks/webhook/README.md +0 -655
- package/examples/README.md +0 -31
package/docs/sdks/hris/README.md
DELETED
|
@@ -1,3251 +0,0 @@
|
|
|
1
|
-
# Hris
|
|
2
|
-
(*hris*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [createHrisCompany](#createhriscompany) - Create a company
|
|
9
|
-
* [createHrisDevice](#createhrisdevice) - Create a device
|
|
10
|
-
* [createHrisEmployee](#createhrisemployee) - Create an employee
|
|
11
|
-
* [createHrisGroup](#createhrisgroup) - Create a group
|
|
12
|
-
* [createHrisLocation](#createhrislocation) - Create a location
|
|
13
|
-
* [createHrisTimeshift](#createhristimeshift) - Create a timeshift
|
|
14
|
-
* [getHrisCompany](#gethriscompany) - Retrieve a company
|
|
15
|
-
* [getHrisDevice](#gethrisdevice) - Retrieve a device
|
|
16
|
-
* [getHrisEmployee](#gethrisemployee) - Retrieve an employee
|
|
17
|
-
* [getHrisGroup](#gethrisgroup) - Retrieve a group
|
|
18
|
-
* [getHrisLocation](#gethrislocation) - Retrieve a location
|
|
19
|
-
* [getHrisPayslip](#gethrispayslip) - Retrieve a payslip
|
|
20
|
-
* [getHrisTimeoff](#gethristimeoff) - Retrieve a timeoff
|
|
21
|
-
* [getHrisTimeshift](#gethristimeshift) - Retrieve a timeshift
|
|
22
|
-
* [listHrisCompanies](#listhriscompanies) - List all companies
|
|
23
|
-
* [listHrisDevices](#listhrisdevices) - List all devices
|
|
24
|
-
* [listHrisEmployees](#listhrisemployees) - List all employees
|
|
25
|
-
* [listHrisGroups](#listhrisgroups) - List all groups
|
|
26
|
-
* [listHrisLocations](#listhrislocations) - List all locations
|
|
27
|
-
* [listHrisPayslips](#listhrispayslips) - List all payslips
|
|
28
|
-
* [listHrisTimeoffs](#listhristimeoffs) - List all timeoffs
|
|
29
|
-
* [listHrisTimeshifts](#listhristimeshifts) - List all timeshifts
|
|
30
|
-
* [patchHrisCompany](#patchhriscompany) - Update a company
|
|
31
|
-
* [patchHrisDevice](#patchhrisdevice) - Update a device
|
|
32
|
-
* [patchHrisEmployee](#patchhrisemployee) - Update an employee
|
|
33
|
-
* [patchHrisGroup](#patchhrisgroup) - Update a group
|
|
34
|
-
* [patchHrisLocation](#patchhrislocation) - Update a location
|
|
35
|
-
* [patchHrisTimeshift](#patchhristimeshift) - Update a timeshift
|
|
36
|
-
* [removeHrisCompany](#removehriscompany) - Remove a company
|
|
37
|
-
* [removeHrisDevice](#removehrisdevice) - Remove a device
|
|
38
|
-
* [removeHrisEmployee](#removehrisemployee) - Remove an employee
|
|
39
|
-
* [removeHrisGroup](#removehrisgroup) - Remove a group
|
|
40
|
-
* [removeHrisLocation](#removehrislocation) - Remove a location
|
|
41
|
-
* [removeHrisTimeshift](#removehristimeshift) - Remove a timeshift
|
|
42
|
-
* [updateHrisCompany](#updatehriscompany) - Update a company
|
|
43
|
-
* [updateHrisDevice](#updatehrisdevice) - Update a device
|
|
44
|
-
* [updateHrisEmployee](#updatehrisemployee) - Update an employee
|
|
45
|
-
* [updateHrisGroup](#updatehrisgroup) - Update a group
|
|
46
|
-
* [updateHrisLocation](#updatehrislocation) - Update a location
|
|
47
|
-
* [updateHrisTimeshift](#updatehristimeshift) - Update a timeshift
|
|
48
|
-
|
|
49
|
-
## createHrisCompany
|
|
50
|
-
|
|
51
|
-
Create a company
|
|
52
|
-
|
|
53
|
-
### Example Usage
|
|
54
|
-
|
|
55
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisCompany" method="post" path="/hris/{connection_id}/company" -->
|
|
56
|
-
```typescript
|
|
57
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
58
|
-
|
|
59
|
-
const unifiedTo = new UnifiedTo({
|
|
60
|
-
security: {
|
|
61
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
62
|
-
},
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
async function run() {
|
|
66
|
-
const result = await unifiedTo.hris.createHrisCompany({
|
|
67
|
-
hrisCompany: {},
|
|
68
|
-
connectionId: "<id>",
|
|
69
|
-
});
|
|
70
|
-
|
|
71
|
-
console.log(result);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
run();
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Standalone function
|
|
78
|
-
|
|
79
|
-
The standalone function version of this method:
|
|
80
|
-
|
|
81
|
-
```typescript
|
|
82
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
83
|
-
import { companyCreateHrisCompany } from "@unified-api/typescript-sdk/funcs/companyCreateHrisCompany.js";
|
|
84
|
-
|
|
85
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
86
|
-
// You can create one instance of it to use across an application.
|
|
87
|
-
const unifiedTo = new UnifiedToCore({
|
|
88
|
-
security: {
|
|
89
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
90
|
-
},
|
|
91
|
-
});
|
|
92
|
-
|
|
93
|
-
async function run() {
|
|
94
|
-
const res = await companyCreateHrisCompany(unifiedTo, {
|
|
95
|
-
hrisCompany: {},
|
|
96
|
-
connectionId: "<id>",
|
|
97
|
-
});
|
|
98
|
-
if (res.ok) {
|
|
99
|
-
const { value: result } = res;
|
|
100
|
-
console.log(result);
|
|
101
|
-
} else {
|
|
102
|
-
console.log("companyCreateHrisCompany failed:", res.error);
|
|
103
|
-
}
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
run();
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Parameters
|
|
110
|
-
|
|
111
|
-
| Parameter | Type | Required | Description |
|
|
112
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
113
|
-
| `request` | [operations.CreateHrisCompanyRequest](../../sdk/models/operations/createhriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
114
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
115
|
-
| `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. |
|
|
116
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
117
|
-
|
|
118
|
-
### Response
|
|
119
|
-
|
|
120
|
-
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
121
|
-
|
|
122
|
-
### Errors
|
|
123
|
-
|
|
124
|
-
| Error Type | Status Code | Content Type |
|
|
125
|
-
| --------------- | --------------- | --------------- |
|
|
126
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
127
|
-
|
|
128
|
-
## createHrisDevice
|
|
129
|
-
|
|
130
|
-
Create a device
|
|
131
|
-
|
|
132
|
-
### Example Usage
|
|
133
|
-
|
|
134
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisDevice" method="post" path="/hris/{connection_id}/device" -->
|
|
135
|
-
```typescript
|
|
136
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
137
|
-
|
|
138
|
-
const unifiedTo = new UnifiedTo({
|
|
139
|
-
security: {
|
|
140
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
141
|
-
},
|
|
142
|
-
});
|
|
143
|
-
|
|
144
|
-
async function run() {
|
|
145
|
-
const result = await unifiedTo.hris.createHrisDevice({
|
|
146
|
-
hrisDevice: {
|
|
147
|
-
name: "<value>",
|
|
148
|
-
},
|
|
149
|
-
connectionId: "<id>",
|
|
150
|
-
});
|
|
151
|
-
|
|
152
|
-
console.log(result);
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
run();
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Standalone function
|
|
159
|
-
|
|
160
|
-
The standalone function version of this method:
|
|
161
|
-
|
|
162
|
-
```typescript
|
|
163
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
164
|
-
import { hrisCreateHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisDevice.js";
|
|
165
|
-
|
|
166
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
167
|
-
// You can create one instance of it to use across an application.
|
|
168
|
-
const unifiedTo = new UnifiedToCore({
|
|
169
|
-
security: {
|
|
170
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
171
|
-
},
|
|
172
|
-
});
|
|
173
|
-
|
|
174
|
-
async function run() {
|
|
175
|
-
const res = await hrisCreateHrisDevice(unifiedTo, {
|
|
176
|
-
hrisDevice: {
|
|
177
|
-
name: "<value>",
|
|
178
|
-
},
|
|
179
|
-
connectionId: "<id>",
|
|
180
|
-
});
|
|
181
|
-
if (res.ok) {
|
|
182
|
-
const { value: result } = res;
|
|
183
|
-
console.log(result);
|
|
184
|
-
} else {
|
|
185
|
-
console.log("hrisCreateHrisDevice failed:", res.error);
|
|
186
|
-
}
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
run();
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
### Parameters
|
|
193
|
-
|
|
194
|
-
| Parameter | Type | Required | Description |
|
|
195
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
196
|
-
| `request` | [operations.CreateHrisDeviceRequest](../../sdk/models/operations/createhrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
197
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
198
|
-
| `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. |
|
|
199
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
200
|
-
|
|
201
|
-
### Response
|
|
202
|
-
|
|
203
|
-
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
204
|
-
|
|
205
|
-
### Errors
|
|
206
|
-
|
|
207
|
-
| Error Type | Status Code | Content Type |
|
|
208
|
-
| --------------- | --------------- | --------------- |
|
|
209
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
210
|
-
|
|
211
|
-
## createHrisEmployee
|
|
212
|
-
|
|
213
|
-
Create an employee
|
|
214
|
-
|
|
215
|
-
### Example Usage
|
|
216
|
-
|
|
217
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisEmployee" method="post" path="/hris/{connection_id}/employee" -->
|
|
218
|
-
```typescript
|
|
219
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
220
|
-
|
|
221
|
-
const unifiedTo = new UnifiedTo({
|
|
222
|
-
security: {
|
|
223
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
224
|
-
},
|
|
225
|
-
});
|
|
226
|
-
|
|
227
|
-
async function run() {
|
|
228
|
-
const result = await unifiedTo.hris.createHrisEmployee({
|
|
229
|
-
hrisEmployee: {},
|
|
230
|
-
connectionId: "<id>",
|
|
231
|
-
});
|
|
232
|
-
|
|
233
|
-
console.log(result);
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
run();
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
### Standalone function
|
|
240
|
-
|
|
241
|
-
The standalone function version of this method:
|
|
242
|
-
|
|
243
|
-
```typescript
|
|
244
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
245
|
-
import { hrisCreateHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisEmployee.js";
|
|
246
|
-
|
|
247
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
248
|
-
// You can create one instance of it to use across an application.
|
|
249
|
-
const unifiedTo = new UnifiedToCore({
|
|
250
|
-
security: {
|
|
251
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
252
|
-
},
|
|
253
|
-
});
|
|
254
|
-
|
|
255
|
-
async function run() {
|
|
256
|
-
const res = await hrisCreateHrisEmployee(unifiedTo, {
|
|
257
|
-
hrisEmployee: {},
|
|
258
|
-
connectionId: "<id>",
|
|
259
|
-
});
|
|
260
|
-
if (res.ok) {
|
|
261
|
-
const { value: result } = res;
|
|
262
|
-
console.log(result);
|
|
263
|
-
} else {
|
|
264
|
-
console.log("hrisCreateHrisEmployee failed:", res.error);
|
|
265
|
-
}
|
|
266
|
-
}
|
|
267
|
-
|
|
268
|
-
run();
|
|
269
|
-
```
|
|
270
|
-
|
|
271
|
-
### Parameters
|
|
272
|
-
|
|
273
|
-
| Parameter | Type | Required | Description |
|
|
274
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
275
|
-
| `request` | [operations.CreateHrisEmployeeRequest](../../sdk/models/operations/createhrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
276
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
277
|
-
| `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. |
|
|
278
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
279
|
-
|
|
280
|
-
### Response
|
|
281
|
-
|
|
282
|
-
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
283
|
-
|
|
284
|
-
### Errors
|
|
285
|
-
|
|
286
|
-
| Error Type | Status Code | Content Type |
|
|
287
|
-
| --------------- | --------------- | --------------- |
|
|
288
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
289
|
-
|
|
290
|
-
## createHrisGroup
|
|
291
|
-
|
|
292
|
-
Create a group
|
|
293
|
-
|
|
294
|
-
### Example Usage
|
|
295
|
-
|
|
296
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisGroup" method="post" path="/hris/{connection_id}/group" -->
|
|
297
|
-
```typescript
|
|
298
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
299
|
-
|
|
300
|
-
const unifiedTo = new UnifiedTo({
|
|
301
|
-
security: {
|
|
302
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
303
|
-
},
|
|
304
|
-
});
|
|
305
|
-
|
|
306
|
-
async function run() {
|
|
307
|
-
const result = await unifiedTo.hris.createHrisGroup({
|
|
308
|
-
hrisGroup: {},
|
|
309
|
-
connectionId: "<id>",
|
|
310
|
-
});
|
|
311
|
-
|
|
312
|
-
console.log(result);
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
run();
|
|
316
|
-
```
|
|
317
|
-
|
|
318
|
-
### Standalone function
|
|
319
|
-
|
|
320
|
-
The standalone function version of this method:
|
|
321
|
-
|
|
322
|
-
```typescript
|
|
323
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
324
|
-
import { hrisCreateHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisGroup.js";
|
|
325
|
-
|
|
326
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
327
|
-
// You can create one instance of it to use across an application.
|
|
328
|
-
const unifiedTo = new UnifiedToCore({
|
|
329
|
-
security: {
|
|
330
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
331
|
-
},
|
|
332
|
-
});
|
|
333
|
-
|
|
334
|
-
async function run() {
|
|
335
|
-
const res = await hrisCreateHrisGroup(unifiedTo, {
|
|
336
|
-
hrisGroup: {},
|
|
337
|
-
connectionId: "<id>",
|
|
338
|
-
});
|
|
339
|
-
if (res.ok) {
|
|
340
|
-
const { value: result } = res;
|
|
341
|
-
console.log(result);
|
|
342
|
-
} else {
|
|
343
|
-
console.log("hrisCreateHrisGroup failed:", res.error);
|
|
344
|
-
}
|
|
345
|
-
}
|
|
346
|
-
|
|
347
|
-
run();
|
|
348
|
-
```
|
|
349
|
-
|
|
350
|
-
### Parameters
|
|
351
|
-
|
|
352
|
-
| Parameter | Type | Required | Description |
|
|
353
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
354
|
-
| `request` | [operations.CreateHrisGroupRequest](../../sdk/models/operations/createhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
355
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
356
|
-
| `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. |
|
|
357
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
358
|
-
|
|
359
|
-
### Response
|
|
360
|
-
|
|
361
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
362
|
-
|
|
363
|
-
### Errors
|
|
364
|
-
|
|
365
|
-
| Error Type | Status Code | Content Type |
|
|
366
|
-
| --------------- | --------------- | --------------- |
|
|
367
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
368
|
-
|
|
369
|
-
## createHrisLocation
|
|
370
|
-
|
|
371
|
-
Create a location
|
|
372
|
-
|
|
373
|
-
### Example Usage
|
|
374
|
-
|
|
375
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisLocation" method="post" path="/hris/{connection_id}/location" -->
|
|
376
|
-
```typescript
|
|
377
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
378
|
-
|
|
379
|
-
const unifiedTo = new UnifiedTo({
|
|
380
|
-
security: {
|
|
381
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
382
|
-
},
|
|
383
|
-
});
|
|
384
|
-
|
|
385
|
-
async function run() {
|
|
386
|
-
const result = await unifiedTo.hris.createHrisLocation({
|
|
387
|
-
hrisLocation: {},
|
|
388
|
-
connectionId: "<id>",
|
|
389
|
-
});
|
|
390
|
-
|
|
391
|
-
console.log(result);
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
run();
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
### Standalone function
|
|
398
|
-
|
|
399
|
-
The standalone function version of this method:
|
|
400
|
-
|
|
401
|
-
```typescript
|
|
402
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
403
|
-
import { locationCreateHrisLocation } from "@unified-api/typescript-sdk/funcs/locationCreateHrisLocation.js";
|
|
404
|
-
|
|
405
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
406
|
-
// You can create one instance of it to use across an application.
|
|
407
|
-
const unifiedTo = new UnifiedToCore({
|
|
408
|
-
security: {
|
|
409
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
410
|
-
},
|
|
411
|
-
});
|
|
412
|
-
|
|
413
|
-
async function run() {
|
|
414
|
-
const res = await locationCreateHrisLocation(unifiedTo, {
|
|
415
|
-
hrisLocation: {},
|
|
416
|
-
connectionId: "<id>",
|
|
417
|
-
});
|
|
418
|
-
if (res.ok) {
|
|
419
|
-
const { value: result } = res;
|
|
420
|
-
console.log(result);
|
|
421
|
-
} else {
|
|
422
|
-
console.log("locationCreateHrisLocation failed:", res.error);
|
|
423
|
-
}
|
|
424
|
-
}
|
|
425
|
-
|
|
426
|
-
run();
|
|
427
|
-
```
|
|
428
|
-
|
|
429
|
-
### Parameters
|
|
430
|
-
|
|
431
|
-
| Parameter | Type | Required | Description |
|
|
432
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
433
|
-
| `request` | [operations.CreateHrisLocationRequest](../../sdk/models/operations/createhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
434
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
435
|
-
| `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. |
|
|
436
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
437
|
-
|
|
438
|
-
### Response
|
|
439
|
-
|
|
440
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
441
|
-
|
|
442
|
-
### Errors
|
|
443
|
-
|
|
444
|
-
| Error Type | Status Code | Content Type |
|
|
445
|
-
| --------------- | --------------- | --------------- |
|
|
446
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
447
|
-
|
|
448
|
-
## createHrisTimeshift
|
|
449
|
-
|
|
450
|
-
Create a timeshift
|
|
451
|
-
|
|
452
|
-
### Example Usage
|
|
453
|
-
|
|
454
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisTimeshift" method="post" path="/hris/{connection_id}/timeshift" -->
|
|
455
|
-
```typescript
|
|
456
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
457
|
-
|
|
458
|
-
const unifiedTo = new UnifiedTo({
|
|
459
|
-
security: {
|
|
460
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
461
|
-
},
|
|
462
|
-
});
|
|
463
|
-
|
|
464
|
-
async function run() {
|
|
465
|
-
const result = await unifiedTo.hris.createHrisTimeshift({
|
|
466
|
-
hrisTimeshift: {
|
|
467
|
-
employeeUserId: "<id>",
|
|
468
|
-
endAt: new Date("2025-10-18T00:03:45.822Z"),
|
|
469
|
-
startAt: new Date("2024-06-03T05:33:48.715Z"),
|
|
470
|
-
},
|
|
471
|
-
connectionId: "<id>",
|
|
472
|
-
});
|
|
473
|
-
|
|
474
|
-
console.log(result);
|
|
475
|
-
}
|
|
476
|
-
|
|
477
|
-
run();
|
|
478
|
-
```
|
|
479
|
-
|
|
480
|
-
### Standalone function
|
|
481
|
-
|
|
482
|
-
The standalone function version of this method:
|
|
483
|
-
|
|
484
|
-
```typescript
|
|
485
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
486
|
-
import { hrisCreateHrisTimeshift } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisTimeshift.js";
|
|
487
|
-
|
|
488
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
489
|
-
// You can create one instance of it to use across an application.
|
|
490
|
-
const unifiedTo = new UnifiedToCore({
|
|
491
|
-
security: {
|
|
492
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
493
|
-
},
|
|
494
|
-
});
|
|
495
|
-
|
|
496
|
-
async function run() {
|
|
497
|
-
const res = await hrisCreateHrisTimeshift(unifiedTo, {
|
|
498
|
-
hrisTimeshift: {
|
|
499
|
-
employeeUserId: "<id>",
|
|
500
|
-
endAt: new Date("2025-10-18T00:03:45.822Z"),
|
|
501
|
-
startAt: new Date("2024-06-03T05:33:48.715Z"),
|
|
502
|
-
},
|
|
503
|
-
connectionId: "<id>",
|
|
504
|
-
});
|
|
505
|
-
if (res.ok) {
|
|
506
|
-
const { value: result } = res;
|
|
507
|
-
console.log(result);
|
|
508
|
-
} else {
|
|
509
|
-
console.log("hrisCreateHrisTimeshift failed:", res.error);
|
|
510
|
-
}
|
|
511
|
-
}
|
|
512
|
-
|
|
513
|
-
run();
|
|
514
|
-
```
|
|
515
|
-
|
|
516
|
-
### Parameters
|
|
517
|
-
|
|
518
|
-
| Parameter | Type | Required | Description |
|
|
519
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
520
|
-
| `request` | [operations.CreateHrisTimeshiftRequest](../../sdk/models/operations/createhristimeshiftrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
521
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
522
|
-
| `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. |
|
|
523
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
524
|
-
|
|
525
|
-
### Response
|
|
526
|
-
|
|
527
|
-
**Promise\<[shared.HrisTimeshift](../../sdk/models/shared/hristimeshift.md)\>**
|
|
528
|
-
|
|
529
|
-
### Errors
|
|
530
|
-
|
|
531
|
-
| Error Type | Status Code | Content Type |
|
|
532
|
-
| --------------- | --------------- | --------------- |
|
|
533
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
534
|
-
|
|
535
|
-
## getHrisCompany
|
|
536
|
-
|
|
537
|
-
Retrieve a company
|
|
538
|
-
|
|
539
|
-
### Example Usage
|
|
540
|
-
|
|
541
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisCompany" method="get" path="/hris/{connection_id}/company/{id}" -->
|
|
542
|
-
```typescript
|
|
543
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
544
|
-
|
|
545
|
-
const unifiedTo = new UnifiedTo({
|
|
546
|
-
security: {
|
|
547
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
548
|
-
},
|
|
549
|
-
});
|
|
550
|
-
|
|
551
|
-
async function run() {
|
|
552
|
-
const result = await unifiedTo.hris.getHrisCompany({
|
|
553
|
-
connectionId: "<id>",
|
|
554
|
-
id: "<id>",
|
|
555
|
-
});
|
|
556
|
-
|
|
557
|
-
console.log(result);
|
|
558
|
-
}
|
|
559
|
-
|
|
560
|
-
run();
|
|
561
|
-
```
|
|
562
|
-
|
|
563
|
-
### Standalone function
|
|
564
|
-
|
|
565
|
-
The standalone function version of this method:
|
|
566
|
-
|
|
567
|
-
```typescript
|
|
568
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
569
|
-
import { companyGetHrisCompany } from "@unified-api/typescript-sdk/funcs/companyGetHrisCompany.js";
|
|
570
|
-
|
|
571
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
572
|
-
// You can create one instance of it to use across an application.
|
|
573
|
-
const unifiedTo = new UnifiedToCore({
|
|
574
|
-
security: {
|
|
575
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
576
|
-
},
|
|
577
|
-
});
|
|
578
|
-
|
|
579
|
-
async function run() {
|
|
580
|
-
const res = await companyGetHrisCompany(unifiedTo, {
|
|
581
|
-
connectionId: "<id>",
|
|
582
|
-
id: "<id>",
|
|
583
|
-
});
|
|
584
|
-
if (res.ok) {
|
|
585
|
-
const { value: result } = res;
|
|
586
|
-
console.log(result);
|
|
587
|
-
} else {
|
|
588
|
-
console.log("companyGetHrisCompany failed:", res.error);
|
|
589
|
-
}
|
|
590
|
-
}
|
|
591
|
-
|
|
592
|
-
run();
|
|
593
|
-
```
|
|
594
|
-
|
|
595
|
-
### Parameters
|
|
596
|
-
|
|
597
|
-
| Parameter | Type | Required | Description |
|
|
598
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
599
|
-
| `request` | [operations.GetHrisCompanyRequest](../../sdk/models/operations/gethriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
600
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
601
|
-
| `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. |
|
|
602
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
603
|
-
|
|
604
|
-
### Response
|
|
605
|
-
|
|
606
|
-
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
607
|
-
|
|
608
|
-
### Errors
|
|
609
|
-
|
|
610
|
-
| Error Type | Status Code | Content Type |
|
|
611
|
-
| --------------- | --------------- | --------------- |
|
|
612
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
613
|
-
|
|
614
|
-
## getHrisDevice
|
|
615
|
-
|
|
616
|
-
Retrieve a device
|
|
617
|
-
|
|
618
|
-
### Example Usage
|
|
619
|
-
|
|
620
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisDevice" method="get" path="/hris/{connection_id}/device/{id}" -->
|
|
621
|
-
```typescript
|
|
622
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
623
|
-
|
|
624
|
-
const unifiedTo = new UnifiedTo({
|
|
625
|
-
security: {
|
|
626
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
627
|
-
},
|
|
628
|
-
});
|
|
629
|
-
|
|
630
|
-
async function run() {
|
|
631
|
-
const result = await unifiedTo.hris.getHrisDevice({
|
|
632
|
-
connectionId: "<id>",
|
|
633
|
-
id: "<id>",
|
|
634
|
-
});
|
|
635
|
-
|
|
636
|
-
console.log(result);
|
|
637
|
-
}
|
|
638
|
-
|
|
639
|
-
run();
|
|
640
|
-
```
|
|
641
|
-
|
|
642
|
-
### Standalone function
|
|
643
|
-
|
|
644
|
-
The standalone function version of this method:
|
|
645
|
-
|
|
646
|
-
```typescript
|
|
647
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
648
|
-
import { hrisGetHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisGetHrisDevice.js";
|
|
649
|
-
|
|
650
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
651
|
-
// You can create one instance of it to use across an application.
|
|
652
|
-
const unifiedTo = new UnifiedToCore({
|
|
653
|
-
security: {
|
|
654
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
655
|
-
},
|
|
656
|
-
});
|
|
657
|
-
|
|
658
|
-
async function run() {
|
|
659
|
-
const res = await hrisGetHrisDevice(unifiedTo, {
|
|
660
|
-
connectionId: "<id>",
|
|
661
|
-
id: "<id>",
|
|
662
|
-
});
|
|
663
|
-
if (res.ok) {
|
|
664
|
-
const { value: result } = res;
|
|
665
|
-
console.log(result);
|
|
666
|
-
} else {
|
|
667
|
-
console.log("hrisGetHrisDevice failed:", res.error);
|
|
668
|
-
}
|
|
669
|
-
}
|
|
670
|
-
|
|
671
|
-
run();
|
|
672
|
-
```
|
|
673
|
-
|
|
674
|
-
### Parameters
|
|
675
|
-
|
|
676
|
-
| Parameter | Type | Required | Description |
|
|
677
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
678
|
-
| `request` | [operations.GetHrisDeviceRequest](../../sdk/models/operations/gethrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
679
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
680
|
-
| `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. |
|
|
681
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
682
|
-
|
|
683
|
-
### Response
|
|
684
|
-
|
|
685
|
-
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
686
|
-
|
|
687
|
-
### Errors
|
|
688
|
-
|
|
689
|
-
| Error Type | Status Code | Content Type |
|
|
690
|
-
| --------------- | --------------- | --------------- |
|
|
691
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
692
|
-
|
|
693
|
-
## getHrisEmployee
|
|
694
|
-
|
|
695
|
-
Retrieve an employee
|
|
696
|
-
|
|
697
|
-
### Example Usage
|
|
698
|
-
|
|
699
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisEmployee" method="get" path="/hris/{connection_id}/employee/{id}" -->
|
|
700
|
-
```typescript
|
|
701
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
702
|
-
|
|
703
|
-
const unifiedTo = new UnifiedTo({
|
|
704
|
-
security: {
|
|
705
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
706
|
-
},
|
|
707
|
-
});
|
|
708
|
-
|
|
709
|
-
async function run() {
|
|
710
|
-
const result = await unifiedTo.hris.getHrisEmployee({
|
|
711
|
-
connectionId: "<id>",
|
|
712
|
-
id: "<id>",
|
|
713
|
-
});
|
|
714
|
-
|
|
715
|
-
console.log(result);
|
|
716
|
-
}
|
|
717
|
-
|
|
718
|
-
run();
|
|
719
|
-
```
|
|
720
|
-
|
|
721
|
-
### Standalone function
|
|
722
|
-
|
|
723
|
-
The standalone function version of this method:
|
|
724
|
-
|
|
725
|
-
```typescript
|
|
726
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
727
|
-
import { hrisGetHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisGetHrisEmployee.js";
|
|
728
|
-
|
|
729
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
730
|
-
// You can create one instance of it to use across an application.
|
|
731
|
-
const unifiedTo = new UnifiedToCore({
|
|
732
|
-
security: {
|
|
733
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
734
|
-
},
|
|
735
|
-
});
|
|
736
|
-
|
|
737
|
-
async function run() {
|
|
738
|
-
const res = await hrisGetHrisEmployee(unifiedTo, {
|
|
739
|
-
connectionId: "<id>",
|
|
740
|
-
id: "<id>",
|
|
741
|
-
});
|
|
742
|
-
if (res.ok) {
|
|
743
|
-
const { value: result } = res;
|
|
744
|
-
console.log(result);
|
|
745
|
-
} else {
|
|
746
|
-
console.log("hrisGetHrisEmployee failed:", res.error);
|
|
747
|
-
}
|
|
748
|
-
}
|
|
749
|
-
|
|
750
|
-
run();
|
|
751
|
-
```
|
|
752
|
-
|
|
753
|
-
### Parameters
|
|
754
|
-
|
|
755
|
-
| Parameter | Type | Required | Description |
|
|
756
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
757
|
-
| `request` | [operations.GetHrisEmployeeRequest](../../sdk/models/operations/gethrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
758
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
759
|
-
| `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. |
|
|
760
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
761
|
-
|
|
762
|
-
### Response
|
|
763
|
-
|
|
764
|
-
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
765
|
-
|
|
766
|
-
### Errors
|
|
767
|
-
|
|
768
|
-
| Error Type | Status Code | Content Type |
|
|
769
|
-
| --------------- | --------------- | --------------- |
|
|
770
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
771
|
-
|
|
772
|
-
## getHrisGroup
|
|
773
|
-
|
|
774
|
-
Retrieve a group
|
|
775
|
-
|
|
776
|
-
### Example Usage
|
|
777
|
-
|
|
778
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisGroup" method="get" path="/hris/{connection_id}/group/{id}" -->
|
|
779
|
-
```typescript
|
|
780
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
781
|
-
|
|
782
|
-
const unifiedTo = new UnifiedTo({
|
|
783
|
-
security: {
|
|
784
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
785
|
-
},
|
|
786
|
-
});
|
|
787
|
-
|
|
788
|
-
async function run() {
|
|
789
|
-
const result = await unifiedTo.hris.getHrisGroup({
|
|
790
|
-
connectionId: "<id>",
|
|
791
|
-
id: "<id>",
|
|
792
|
-
});
|
|
793
|
-
|
|
794
|
-
console.log(result);
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
run();
|
|
798
|
-
```
|
|
799
|
-
|
|
800
|
-
### Standalone function
|
|
801
|
-
|
|
802
|
-
The standalone function version of this method:
|
|
803
|
-
|
|
804
|
-
```typescript
|
|
805
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
806
|
-
import { hrisGetHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisGetHrisGroup.js";
|
|
807
|
-
|
|
808
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
809
|
-
// You can create one instance of it to use across an application.
|
|
810
|
-
const unifiedTo = new UnifiedToCore({
|
|
811
|
-
security: {
|
|
812
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
813
|
-
},
|
|
814
|
-
});
|
|
815
|
-
|
|
816
|
-
async function run() {
|
|
817
|
-
const res = await hrisGetHrisGroup(unifiedTo, {
|
|
818
|
-
connectionId: "<id>",
|
|
819
|
-
id: "<id>",
|
|
820
|
-
});
|
|
821
|
-
if (res.ok) {
|
|
822
|
-
const { value: result } = res;
|
|
823
|
-
console.log(result);
|
|
824
|
-
} else {
|
|
825
|
-
console.log("hrisGetHrisGroup failed:", res.error);
|
|
826
|
-
}
|
|
827
|
-
}
|
|
828
|
-
|
|
829
|
-
run();
|
|
830
|
-
```
|
|
831
|
-
|
|
832
|
-
### Parameters
|
|
833
|
-
|
|
834
|
-
| Parameter | Type | Required | Description |
|
|
835
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
836
|
-
| `request` | [operations.GetHrisGroupRequest](../../sdk/models/operations/gethrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
837
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
838
|
-
| `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. |
|
|
839
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
840
|
-
|
|
841
|
-
### Response
|
|
842
|
-
|
|
843
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
844
|
-
|
|
845
|
-
### Errors
|
|
846
|
-
|
|
847
|
-
| Error Type | Status Code | Content Type |
|
|
848
|
-
| --------------- | --------------- | --------------- |
|
|
849
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
850
|
-
|
|
851
|
-
## getHrisLocation
|
|
852
|
-
|
|
853
|
-
Retrieve a location
|
|
854
|
-
|
|
855
|
-
### Example Usage
|
|
856
|
-
|
|
857
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisLocation" method="get" path="/hris/{connection_id}/location/{id}" -->
|
|
858
|
-
```typescript
|
|
859
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
860
|
-
|
|
861
|
-
const unifiedTo = new UnifiedTo({
|
|
862
|
-
security: {
|
|
863
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
864
|
-
},
|
|
865
|
-
});
|
|
866
|
-
|
|
867
|
-
async function run() {
|
|
868
|
-
const result = await unifiedTo.hris.getHrisLocation({
|
|
869
|
-
connectionId: "<id>",
|
|
870
|
-
id: "<id>",
|
|
871
|
-
});
|
|
872
|
-
|
|
873
|
-
console.log(result);
|
|
874
|
-
}
|
|
875
|
-
|
|
876
|
-
run();
|
|
877
|
-
```
|
|
878
|
-
|
|
879
|
-
### Standalone function
|
|
880
|
-
|
|
881
|
-
The standalone function version of this method:
|
|
882
|
-
|
|
883
|
-
```typescript
|
|
884
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
885
|
-
import { locationGetHrisLocation } from "@unified-api/typescript-sdk/funcs/locationGetHrisLocation.js";
|
|
886
|
-
|
|
887
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
888
|
-
// You can create one instance of it to use across an application.
|
|
889
|
-
const unifiedTo = new UnifiedToCore({
|
|
890
|
-
security: {
|
|
891
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
892
|
-
},
|
|
893
|
-
});
|
|
894
|
-
|
|
895
|
-
async function run() {
|
|
896
|
-
const res = await locationGetHrisLocation(unifiedTo, {
|
|
897
|
-
connectionId: "<id>",
|
|
898
|
-
id: "<id>",
|
|
899
|
-
});
|
|
900
|
-
if (res.ok) {
|
|
901
|
-
const { value: result } = res;
|
|
902
|
-
console.log(result);
|
|
903
|
-
} else {
|
|
904
|
-
console.log("locationGetHrisLocation failed:", res.error);
|
|
905
|
-
}
|
|
906
|
-
}
|
|
907
|
-
|
|
908
|
-
run();
|
|
909
|
-
```
|
|
910
|
-
|
|
911
|
-
### Parameters
|
|
912
|
-
|
|
913
|
-
| Parameter | Type | Required | Description |
|
|
914
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
915
|
-
| `request` | [operations.GetHrisLocationRequest](../../sdk/models/operations/gethrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
916
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
917
|
-
| `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. |
|
|
918
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
919
|
-
|
|
920
|
-
### Response
|
|
921
|
-
|
|
922
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
923
|
-
|
|
924
|
-
### Errors
|
|
925
|
-
|
|
926
|
-
| Error Type | Status Code | Content Type |
|
|
927
|
-
| --------------- | --------------- | --------------- |
|
|
928
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
929
|
-
|
|
930
|
-
## getHrisPayslip
|
|
931
|
-
|
|
932
|
-
Retrieve a payslip
|
|
933
|
-
|
|
934
|
-
### Example Usage
|
|
935
|
-
|
|
936
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisPayslip" method="get" path="/hris/{connection_id}/payslip/{id}" -->
|
|
937
|
-
```typescript
|
|
938
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
939
|
-
|
|
940
|
-
const unifiedTo = new UnifiedTo({
|
|
941
|
-
security: {
|
|
942
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
943
|
-
},
|
|
944
|
-
});
|
|
945
|
-
|
|
946
|
-
async function run() {
|
|
947
|
-
const result = await unifiedTo.hris.getHrisPayslip({
|
|
948
|
-
connectionId: "<id>",
|
|
949
|
-
id: "<id>",
|
|
950
|
-
});
|
|
951
|
-
|
|
952
|
-
console.log(result);
|
|
953
|
-
}
|
|
954
|
-
|
|
955
|
-
run();
|
|
956
|
-
```
|
|
957
|
-
|
|
958
|
-
### Standalone function
|
|
959
|
-
|
|
960
|
-
The standalone function version of this method:
|
|
961
|
-
|
|
962
|
-
```typescript
|
|
963
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
964
|
-
import { hrisGetHrisPayslip } from "@unified-api/typescript-sdk/funcs/hrisGetHrisPayslip.js";
|
|
965
|
-
|
|
966
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
967
|
-
// You can create one instance of it to use across an application.
|
|
968
|
-
const unifiedTo = new UnifiedToCore({
|
|
969
|
-
security: {
|
|
970
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
971
|
-
},
|
|
972
|
-
});
|
|
973
|
-
|
|
974
|
-
async function run() {
|
|
975
|
-
const res = await hrisGetHrisPayslip(unifiedTo, {
|
|
976
|
-
connectionId: "<id>",
|
|
977
|
-
id: "<id>",
|
|
978
|
-
});
|
|
979
|
-
if (res.ok) {
|
|
980
|
-
const { value: result } = res;
|
|
981
|
-
console.log(result);
|
|
982
|
-
} else {
|
|
983
|
-
console.log("hrisGetHrisPayslip failed:", res.error);
|
|
984
|
-
}
|
|
985
|
-
}
|
|
986
|
-
|
|
987
|
-
run();
|
|
988
|
-
```
|
|
989
|
-
|
|
990
|
-
### Parameters
|
|
991
|
-
|
|
992
|
-
| Parameter | Type | Required | Description |
|
|
993
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
994
|
-
| `request` | [operations.GetHrisPayslipRequest](../../sdk/models/operations/gethrispaysliprequest.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.HrisPayslip](../../sdk/models/shared/hrispayslip.md)\>**
|
|
1002
|
-
|
|
1003
|
-
### Errors
|
|
1004
|
-
|
|
1005
|
-
| Error Type | Status Code | Content Type |
|
|
1006
|
-
| --------------- | --------------- | --------------- |
|
|
1007
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1008
|
-
|
|
1009
|
-
## getHrisTimeoff
|
|
1010
|
-
|
|
1011
|
-
Retrieve a timeoff
|
|
1012
|
-
|
|
1013
|
-
### Example Usage
|
|
1014
|
-
|
|
1015
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisTimeoff" method="get" path="/hris/{connection_id}/timeoff/{id}" -->
|
|
1016
|
-
```typescript
|
|
1017
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1018
|
-
|
|
1019
|
-
const unifiedTo = new UnifiedTo({
|
|
1020
|
-
security: {
|
|
1021
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1022
|
-
},
|
|
1023
|
-
});
|
|
1024
|
-
|
|
1025
|
-
async function run() {
|
|
1026
|
-
const result = await unifiedTo.hris.getHrisTimeoff({
|
|
1027
|
-
connectionId: "<id>",
|
|
1028
|
-
id: "<id>",
|
|
1029
|
-
});
|
|
1030
|
-
|
|
1031
|
-
console.log(result);
|
|
1032
|
-
}
|
|
1033
|
-
|
|
1034
|
-
run();
|
|
1035
|
-
```
|
|
1036
|
-
|
|
1037
|
-
### Standalone function
|
|
1038
|
-
|
|
1039
|
-
The standalone function version of this method:
|
|
1040
|
-
|
|
1041
|
-
```typescript
|
|
1042
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1043
|
-
import { hrisGetHrisTimeoff } from "@unified-api/typescript-sdk/funcs/hrisGetHrisTimeoff.js";
|
|
1044
|
-
|
|
1045
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1046
|
-
// You can create one instance of it to use across an application.
|
|
1047
|
-
const unifiedTo = new UnifiedToCore({
|
|
1048
|
-
security: {
|
|
1049
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1050
|
-
},
|
|
1051
|
-
});
|
|
1052
|
-
|
|
1053
|
-
async function run() {
|
|
1054
|
-
const res = await hrisGetHrisTimeoff(unifiedTo, {
|
|
1055
|
-
connectionId: "<id>",
|
|
1056
|
-
id: "<id>",
|
|
1057
|
-
});
|
|
1058
|
-
if (res.ok) {
|
|
1059
|
-
const { value: result } = res;
|
|
1060
|
-
console.log(result);
|
|
1061
|
-
} else {
|
|
1062
|
-
console.log("hrisGetHrisTimeoff failed:", res.error);
|
|
1063
|
-
}
|
|
1064
|
-
}
|
|
1065
|
-
|
|
1066
|
-
run();
|
|
1067
|
-
```
|
|
1068
|
-
|
|
1069
|
-
### Parameters
|
|
1070
|
-
|
|
1071
|
-
| Parameter | Type | Required | Description |
|
|
1072
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1073
|
-
| `request` | [operations.GetHrisTimeoffRequest](../../sdk/models/operations/gethristimeoffrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1074
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1075
|
-
| `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. |
|
|
1076
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1077
|
-
|
|
1078
|
-
### Response
|
|
1079
|
-
|
|
1080
|
-
**Promise\<[shared.HrisTimeoff](../../sdk/models/shared/hristimeoff.md)\>**
|
|
1081
|
-
|
|
1082
|
-
### Errors
|
|
1083
|
-
|
|
1084
|
-
| Error Type | Status Code | Content Type |
|
|
1085
|
-
| --------------- | --------------- | --------------- |
|
|
1086
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1087
|
-
|
|
1088
|
-
## getHrisTimeshift
|
|
1089
|
-
|
|
1090
|
-
Retrieve a timeshift
|
|
1091
|
-
|
|
1092
|
-
### Example Usage
|
|
1093
|
-
|
|
1094
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisTimeshift" method="get" path="/hris/{connection_id}/timeshift/{id}" -->
|
|
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.getHrisTimeshift({
|
|
1106
|
-
connectionId: "<id>",
|
|
1107
|
-
id: "<id>",
|
|
1108
|
-
});
|
|
1109
|
-
|
|
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 { hrisGetHrisTimeshift } from "@unified-api/typescript-sdk/funcs/hrisGetHrisTimeshift.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 hrisGetHrisTimeshift(unifiedTo, {
|
|
1134
|
-
connectionId: "<id>",
|
|
1135
|
-
id: "<id>",
|
|
1136
|
-
});
|
|
1137
|
-
if (res.ok) {
|
|
1138
|
-
const { value: result } = res;
|
|
1139
|
-
console.log(result);
|
|
1140
|
-
} else {
|
|
1141
|
-
console.log("hrisGetHrisTimeshift failed:", res.error);
|
|
1142
|
-
}
|
|
1143
|
-
}
|
|
1144
|
-
|
|
1145
|
-
run();
|
|
1146
|
-
```
|
|
1147
|
-
|
|
1148
|
-
### Parameters
|
|
1149
|
-
|
|
1150
|
-
| Parameter | Type | Required | Description |
|
|
1151
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1152
|
-
| `request` | [operations.GetHrisTimeshiftRequest](../../sdk/models/operations/gethristimeshiftrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1153
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1154
|
-
| `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. |
|
|
1155
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1156
|
-
|
|
1157
|
-
### Response
|
|
1158
|
-
|
|
1159
|
-
**Promise\<[shared.HrisTimeshift](../../sdk/models/shared/hristimeshift.md)\>**
|
|
1160
|
-
|
|
1161
|
-
### Errors
|
|
1162
|
-
|
|
1163
|
-
| Error Type | Status Code | Content Type |
|
|
1164
|
-
| --------------- | --------------- | --------------- |
|
|
1165
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1166
|
-
|
|
1167
|
-
## listHrisCompanies
|
|
1168
|
-
|
|
1169
|
-
List all companies
|
|
1170
|
-
|
|
1171
|
-
### Example Usage
|
|
1172
|
-
|
|
1173
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisCompanies" method="get" path="/hris/{connection_id}/company" -->
|
|
1174
|
-
```typescript
|
|
1175
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1176
|
-
|
|
1177
|
-
const unifiedTo = new UnifiedTo({
|
|
1178
|
-
security: {
|
|
1179
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1180
|
-
},
|
|
1181
|
-
});
|
|
1182
|
-
|
|
1183
|
-
async function run() {
|
|
1184
|
-
const result = await unifiedTo.hris.listHrisCompanies({
|
|
1185
|
-
connectionId: "<id>",
|
|
1186
|
-
});
|
|
1187
|
-
|
|
1188
|
-
console.log(result);
|
|
1189
|
-
}
|
|
1190
|
-
|
|
1191
|
-
run();
|
|
1192
|
-
```
|
|
1193
|
-
|
|
1194
|
-
### Standalone function
|
|
1195
|
-
|
|
1196
|
-
The standalone function version of this method:
|
|
1197
|
-
|
|
1198
|
-
```typescript
|
|
1199
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1200
|
-
import { companyListHrisCompanies } from "@unified-api/typescript-sdk/funcs/companyListHrisCompanies.js";
|
|
1201
|
-
|
|
1202
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1203
|
-
// You can create one instance of it to use across an application.
|
|
1204
|
-
const unifiedTo = new UnifiedToCore({
|
|
1205
|
-
security: {
|
|
1206
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1207
|
-
},
|
|
1208
|
-
});
|
|
1209
|
-
|
|
1210
|
-
async function run() {
|
|
1211
|
-
const res = await companyListHrisCompanies(unifiedTo, {
|
|
1212
|
-
connectionId: "<id>",
|
|
1213
|
-
});
|
|
1214
|
-
if (res.ok) {
|
|
1215
|
-
const { value: result } = res;
|
|
1216
|
-
console.log(result);
|
|
1217
|
-
} else {
|
|
1218
|
-
console.log("companyListHrisCompanies failed:", res.error);
|
|
1219
|
-
}
|
|
1220
|
-
}
|
|
1221
|
-
|
|
1222
|
-
run();
|
|
1223
|
-
```
|
|
1224
|
-
|
|
1225
|
-
### Parameters
|
|
1226
|
-
|
|
1227
|
-
| Parameter | Type | Required | Description |
|
|
1228
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1229
|
-
| `request` | [operations.ListHrisCompaniesRequest](../../sdk/models/operations/listhriscompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1230
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1231
|
-
| `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. |
|
|
1232
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1233
|
-
|
|
1234
|
-
### Response
|
|
1235
|
-
|
|
1236
|
-
**Promise\<[shared.HrisCompany[]](../../models/.md)\>**
|
|
1237
|
-
|
|
1238
|
-
### Errors
|
|
1239
|
-
|
|
1240
|
-
| Error Type | Status Code | Content Type |
|
|
1241
|
-
| --------------- | --------------- | --------------- |
|
|
1242
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1243
|
-
|
|
1244
|
-
## listHrisDevices
|
|
1245
|
-
|
|
1246
|
-
List all devices
|
|
1247
|
-
|
|
1248
|
-
### Example Usage
|
|
1249
|
-
|
|
1250
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisDevices" method="get" path="/hris/{connection_id}/device" -->
|
|
1251
|
-
```typescript
|
|
1252
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1253
|
-
|
|
1254
|
-
const unifiedTo = new UnifiedTo({
|
|
1255
|
-
security: {
|
|
1256
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1257
|
-
},
|
|
1258
|
-
});
|
|
1259
|
-
|
|
1260
|
-
async function run() {
|
|
1261
|
-
const result = await unifiedTo.hris.listHrisDevices({
|
|
1262
|
-
connectionId: "<id>",
|
|
1263
|
-
});
|
|
1264
|
-
|
|
1265
|
-
console.log(result);
|
|
1266
|
-
}
|
|
1267
|
-
|
|
1268
|
-
run();
|
|
1269
|
-
```
|
|
1270
|
-
|
|
1271
|
-
### Standalone function
|
|
1272
|
-
|
|
1273
|
-
The standalone function version of this method:
|
|
1274
|
-
|
|
1275
|
-
```typescript
|
|
1276
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1277
|
-
import { hrisListHrisDevices } from "@unified-api/typescript-sdk/funcs/hrisListHrisDevices.js";
|
|
1278
|
-
|
|
1279
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1280
|
-
// You can create one instance of it to use across an application.
|
|
1281
|
-
const unifiedTo = new UnifiedToCore({
|
|
1282
|
-
security: {
|
|
1283
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1284
|
-
},
|
|
1285
|
-
});
|
|
1286
|
-
|
|
1287
|
-
async function run() {
|
|
1288
|
-
const res = await hrisListHrisDevices(unifiedTo, {
|
|
1289
|
-
connectionId: "<id>",
|
|
1290
|
-
});
|
|
1291
|
-
if (res.ok) {
|
|
1292
|
-
const { value: result } = res;
|
|
1293
|
-
console.log(result);
|
|
1294
|
-
} else {
|
|
1295
|
-
console.log("hrisListHrisDevices failed:", res.error);
|
|
1296
|
-
}
|
|
1297
|
-
}
|
|
1298
|
-
|
|
1299
|
-
run();
|
|
1300
|
-
```
|
|
1301
|
-
|
|
1302
|
-
### Parameters
|
|
1303
|
-
|
|
1304
|
-
| Parameter | Type | Required | Description |
|
|
1305
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1306
|
-
| `request` | [operations.ListHrisDevicesRequest](../../sdk/models/operations/listhrisdevicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1307
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1308
|
-
| `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. |
|
|
1309
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1310
|
-
|
|
1311
|
-
### Response
|
|
1312
|
-
|
|
1313
|
-
**Promise\<[shared.HrisDevice[]](../../models/.md)\>**
|
|
1314
|
-
|
|
1315
|
-
### Errors
|
|
1316
|
-
|
|
1317
|
-
| Error Type | Status Code | Content Type |
|
|
1318
|
-
| --------------- | --------------- | --------------- |
|
|
1319
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1320
|
-
|
|
1321
|
-
## listHrisEmployees
|
|
1322
|
-
|
|
1323
|
-
List all employees
|
|
1324
|
-
|
|
1325
|
-
### Example Usage
|
|
1326
|
-
|
|
1327
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisEmployees" method="get" path="/hris/{connection_id}/employee" -->
|
|
1328
|
-
```typescript
|
|
1329
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1330
|
-
|
|
1331
|
-
const unifiedTo = new UnifiedTo({
|
|
1332
|
-
security: {
|
|
1333
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1334
|
-
},
|
|
1335
|
-
});
|
|
1336
|
-
|
|
1337
|
-
async function run() {
|
|
1338
|
-
const result = await unifiedTo.hris.listHrisEmployees({
|
|
1339
|
-
connectionId: "<id>",
|
|
1340
|
-
});
|
|
1341
|
-
|
|
1342
|
-
console.log(result);
|
|
1343
|
-
}
|
|
1344
|
-
|
|
1345
|
-
run();
|
|
1346
|
-
```
|
|
1347
|
-
|
|
1348
|
-
### Standalone function
|
|
1349
|
-
|
|
1350
|
-
The standalone function version of this method:
|
|
1351
|
-
|
|
1352
|
-
```typescript
|
|
1353
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1354
|
-
import { hrisListHrisEmployees } from "@unified-api/typescript-sdk/funcs/hrisListHrisEmployees.js";
|
|
1355
|
-
|
|
1356
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1357
|
-
// You can create one instance of it to use across an application.
|
|
1358
|
-
const unifiedTo = new UnifiedToCore({
|
|
1359
|
-
security: {
|
|
1360
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1361
|
-
},
|
|
1362
|
-
});
|
|
1363
|
-
|
|
1364
|
-
async function run() {
|
|
1365
|
-
const res = await hrisListHrisEmployees(unifiedTo, {
|
|
1366
|
-
connectionId: "<id>",
|
|
1367
|
-
});
|
|
1368
|
-
if (res.ok) {
|
|
1369
|
-
const { value: result } = res;
|
|
1370
|
-
console.log(result);
|
|
1371
|
-
} else {
|
|
1372
|
-
console.log("hrisListHrisEmployees failed:", res.error);
|
|
1373
|
-
}
|
|
1374
|
-
}
|
|
1375
|
-
|
|
1376
|
-
run();
|
|
1377
|
-
```
|
|
1378
|
-
|
|
1379
|
-
### Parameters
|
|
1380
|
-
|
|
1381
|
-
| Parameter | Type | Required | Description |
|
|
1382
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1383
|
-
| `request` | [operations.ListHrisEmployeesRequest](../../sdk/models/operations/listhrisemployeesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1384
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1385
|
-
| `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. |
|
|
1386
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1387
|
-
|
|
1388
|
-
### Response
|
|
1389
|
-
|
|
1390
|
-
**Promise\<[shared.HrisEmployee[]](../../models/.md)\>**
|
|
1391
|
-
|
|
1392
|
-
### Errors
|
|
1393
|
-
|
|
1394
|
-
| Error Type | Status Code | Content Type |
|
|
1395
|
-
| --------------- | --------------- | --------------- |
|
|
1396
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1397
|
-
|
|
1398
|
-
## listHrisGroups
|
|
1399
|
-
|
|
1400
|
-
List all groups
|
|
1401
|
-
|
|
1402
|
-
### Example Usage
|
|
1403
|
-
|
|
1404
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisGroups" method="get" path="/hris/{connection_id}/group" -->
|
|
1405
|
-
```typescript
|
|
1406
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1407
|
-
|
|
1408
|
-
const unifiedTo = new UnifiedTo({
|
|
1409
|
-
security: {
|
|
1410
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1411
|
-
},
|
|
1412
|
-
});
|
|
1413
|
-
|
|
1414
|
-
async function run() {
|
|
1415
|
-
const result = await unifiedTo.hris.listHrisGroups({
|
|
1416
|
-
connectionId: "<id>",
|
|
1417
|
-
});
|
|
1418
|
-
|
|
1419
|
-
console.log(result);
|
|
1420
|
-
}
|
|
1421
|
-
|
|
1422
|
-
run();
|
|
1423
|
-
```
|
|
1424
|
-
|
|
1425
|
-
### Standalone function
|
|
1426
|
-
|
|
1427
|
-
The standalone function version of this method:
|
|
1428
|
-
|
|
1429
|
-
```typescript
|
|
1430
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1431
|
-
import { hrisListHrisGroups } from "@unified-api/typescript-sdk/funcs/hrisListHrisGroups.js";
|
|
1432
|
-
|
|
1433
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1434
|
-
// You can create one instance of it to use across an application.
|
|
1435
|
-
const unifiedTo = new UnifiedToCore({
|
|
1436
|
-
security: {
|
|
1437
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1438
|
-
},
|
|
1439
|
-
});
|
|
1440
|
-
|
|
1441
|
-
async function run() {
|
|
1442
|
-
const res = await hrisListHrisGroups(unifiedTo, {
|
|
1443
|
-
connectionId: "<id>",
|
|
1444
|
-
});
|
|
1445
|
-
if (res.ok) {
|
|
1446
|
-
const { value: result } = res;
|
|
1447
|
-
console.log(result);
|
|
1448
|
-
} else {
|
|
1449
|
-
console.log("hrisListHrisGroups failed:", res.error);
|
|
1450
|
-
}
|
|
1451
|
-
}
|
|
1452
|
-
|
|
1453
|
-
run();
|
|
1454
|
-
```
|
|
1455
|
-
|
|
1456
|
-
### Parameters
|
|
1457
|
-
|
|
1458
|
-
| Parameter | Type | Required | Description |
|
|
1459
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1460
|
-
| `request` | [operations.ListHrisGroupsRequest](../../sdk/models/operations/listhrisgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1461
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1462
|
-
| `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. |
|
|
1463
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1464
|
-
|
|
1465
|
-
### Response
|
|
1466
|
-
|
|
1467
|
-
**Promise\<[shared.HrisGroup[]](../../models/.md)\>**
|
|
1468
|
-
|
|
1469
|
-
### Errors
|
|
1470
|
-
|
|
1471
|
-
| Error Type | Status Code | Content Type |
|
|
1472
|
-
| --------------- | --------------- | --------------- |
|
|
1473
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1474
|
-
|
|
1475
|
-
## listHrisLocations
|
|
1476
|
-
|
|
1477
|
-
List all locations
|
|
1478
|
-
|
|
1479
|
-
### Example Usage
|
|
1480
|
-
|
|
1481
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisLocations" method="get" path="/hris/{connection_id}/location" -->
|
|
1482
|
-
```typescript
|
|
1483
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1484
|
-
|
|
1485
|
-
const unifiedTo = new UnifiedTo({
|
|
1486
|
-
security: {
|
|
1487
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1488
|
-
},
|
|
1489
|
-
});
|
|
1490
|
-
|
|
1491
|
-
async function run() {
|
|
1492
|
-
const result = await unifiedTo.hris.listHrisLocations({
|
|
1493
|
-
connectionId: "<id>",
|
|
1494
|
-
});
|
|
1495
|
-
|
|
1496
|
-
console.log(result);
|
|
1497
|
-
}
|
|
1498
|
-
|
|
1499
|
-
run();
|
|
1500
|
-
```
|
|
1501
|
-
|
|
1502
|
-
### Standalone function
|
|
1503
|
-
|
|
1504
|
-
The standalone function version of this method:
|
|
1505
|
-
|
|
1506
|
-
```typescript
|
|
1507
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1508
|
-
import { locationListHrisLocations } from "@unified-api/typescript-sdk/funcs/locationListHrisLocations.js";
|
|
1509
|
-
|
|
1510
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1511
|
-
// You can create one instance of it to use across an application.
|
|
1512
|
-
const unifiedTo = new UnifiedToCore({
|
|
1513
|
-
security: {
|
|
1514
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1515
|
-
},
|
|
1516
|
-
});
|
|
1517
|
-
|
|
1518
|
-
async function run() {
|
|
1519
|
-
const res = await locationListHrisLocations(unifiedTo, {
|
|
1520
|
-
connectionId: "<id>",
|
|
1521
|
-
});
|
|
1522
|
-
if (res.ok) {
|
|
1523
|
-
const { value: result } = res;
|
|
1524
|
-
console.log(result);
|
|
1525
|
-
} else {
|
|
1526
|
-
console.log("locationListHrisLocations failed:", res.error);
|
|
1527
|
-
}
|
|
1528
|
-
}
|
|
1529
|
-
|
|
1530
|
-
run();
|
|
1531
|
-
```
|
|
1532
|
-
|
|
1533
|
-
### Parameters
|
|
1534
|
-
|
|
1535
|
-
| Parameter | Type | Required | Description |
|
|
1536
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1537
|
-
| `request` | [operations.ListHrisLocationsRequest](../../sdk/models/operations/listhrislocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1538
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1539
|
-
| `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. |
|
|
1540
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1541
|
-
|
|
1542
|
-
### Response
|
|
1543
|
-
|
|
1544
|
-
**Promise\<[shared.HrisLocation[]](../../models/.md)\>**
|
|
1545
|
-
|
|
1546
|
-
### Errors
|
|
1547
|
-
|
|
1548
|
-
| Error Type | Status Code | Content Type |
|
|
1549
|
-
| --------------- | --------------- | --------------- |
|
|
1550
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1551
|
-
|
|
1552
|
-
## listHrisPayslips
|
|
1553
|
-
|
|
1554
|
-
List all payslips
|
|
1555
|
-
|
|
1556
|
-
### Example Usage
|
|
1557
|
-
|
|
1558
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisPayslips" method="get" path="/hris/{connection_id}/payslip" -->
|
|
1559
|
-
```typescript
|
|
1560
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1561
|
-
|
|
1562
|
-
const unifiedTo = new UnifiedTo({
|
|
1563
|
-
security: {
|
|
1564
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1565
|
-
},
|
|
1566
|
-
});
|
|
1567
|
-
|
|
1568
|
-
async function run() {
|
|
1569
|
-
const result = await unifiedTo.hris.listHrisPayslips({
|
|
1570
|
-
connectionId: "<id>",
|
|
1571
|
-
});
|
|
1572
|
-
|
|
1573
|
-
console.log(result);
|
|
1574
|
-
}
|
|
1575
|
-
|
|
1576
|
-
run();
|
|
1577
|
-
```
|
|
1578
|
-
|
|
1579
|
-
### Standalone function
|
|
1580
|
-
|
|
1581
|
-
The standalone function version of this method:
|
|
1582
|
-
|
|
1583
|
-
```typescript
|
|
1584
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1585
|
-
import { hrisListHrisPayslips } from "@unified-api/typescript-sdk/funcs/hrisListHrisPayslips.js";
|
|
1586
|
-
|
|
1587
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1588
|
-
// You can create one instance of it to use across an application.
|
|
1589
|
-
const unifiedTo = new UnifiedToCore({
|
|
1590
|
-
security: {
|
|
1591
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1592
|
-
},
|
|
1593
|
-
});
|
|
1594
|
-
|
|
1595
|
-
async function run() {
|
|
1596
|
-
const res = await hrisListHrisPayslips(unifiedTo, {
|
|
1597
|
-
connectionId: "<id>",
|
|
1598
|
-
});
|
|
1599
|
-
if (res.ok) {
|
|
1600
|
-
const { value: result } = res;
|
|
1601
|
-
console.log(result);
|
|
1602
|
-
} else {
|
|
1603
|
-
console.log("hrisListHrisPayslips failed:", res.error);
|
|
1604
|
-
}
|
|
1605
|
-
}
|
|
1606
|
-
|
|
1607
|
-
run();
|
|
1608
|
-
```
|
|
1609
|
-
|
|
1610
|
-
### Parameters
|
|
1611
|
-
|
|
1612
|
-
| Parameter | Type | Required | Description |
|
|
1613
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1614
|
-
| `request` | [operations.ListHrisPayslipsRequest](../../sdk/models/operations/listhrispayslipsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1615
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1616
|
-
| `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. |
|
|
1617
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1618
|
-
|
|
1619
|
-
### Response
|
|
1620
|
-
|
|
1621
|
-
**Promise\<[shared.HrisPayslip[]](../../models/.md)\>**
|
|
1622
|
-
|
|
1623
|
-
### Errors
|
|
1624
|
-
|
|
1625
|
-
| Error Type | Status Code | Content Type |
|
|
1626
|
-
| --------------- | --------------- | --------------- |
|
|
1627
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1628
|
-
|
|
1629
|
-
## listHrisTimeoffs
|
|
1630
|
-
|
|
1631
|
-
List all timeoffs
|
|
1632
|
-
|
|
1633
|
-
### Example Usage
|
|
1634
|
-
|
|
1635
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisTimeoffs" method="get" path="/hris/{connection_id}/timeoff" -->
|
|
1636
|
-
```typescript
|
|
1637
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1638
|
-
|
|
1639
|
-
const unifiedTo = new UnifiedTo({
|
|
1640
|
-
security: {
|
|
1641
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1642
|
-
},
|
|
1643
|
-
});
|
|
1644
|
-
|
|
1645
|
-
async function run() {
|
|
1646
|
-
const result = await unifiedTo.hris.listHrisTimeoffs({
|
|
1647
|
-
connectionId: "<id>",
|
|
1648
|
-
});
|
|
1649
|
-
|
|
1650
|
-
console.log(result);
|
|
1651
|
-
}
|
|
1652
|
-
|
|
1653
|
-
run();
|
|
1654
|
-
```
|
|
1655
|
-
|
|
1656
|
-
### Standalone function
|
|
1657
|
-
|
|
1658
|
-
The standalone function version of this method:
|
|
1659
|
-
|
|
1660
|
-
```typescript
|
|
1661
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1662
|
-
import { hrisListHrisTimeoffs } from "@unified-api/typescript-sdk/funcs/hrisListHrisTimeoffs.js";
|
|
1663
|
-
|
|
1664
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1665
|
-
// You can create one instance of it to use across an application.
|
|
1666
|
-
const unifiedTo = new UnifiedToCore({
|
|
1667
|
-
security: {
|
|
1668
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1669
|
-
},
|
|
1670
|
-
});
|
|
1671
|
-
|
|
1672
|
-
async function run() {
|
|
1673
|
-
const res = await hrisListHrisTimeoffs(unifiedTo, {
|
|
1674
|
-
connectionId: "<id>",
|
|
1675
|
-
});
|
|
1676
|
-
if (res.ok) {
|
|
1677
|
-
const { value: result } = res;
|
|
1678
|
-
console.log(result);
|
|
1679
|
-
} else {
|
|
1680
|
-
console.log("hrisListHrisTimeoffs failed:", res.error);
|
|
1681
|
-
}
|
|
1682
|
-
}
|
|
1683
|
-
|
|
1684
|
-
run();
|
|
1685
|
-
```
|
|
1686
|
-
|
|
1687
|
-
### Parameters
|
|
1688
|
-
|
|
1689
|
-
| Parameter | Type | Required | Description |
|
|
1690
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1691
|
-
| `request` | [operations.ListHrisTimeoffsRequest](../../sdk/models/operations/listhristimeoffsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1692
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1693
|
-
| `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. |
|
|
1694
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1695
|
-
|
|
1696
|
-
### Response
|
|
1697
|
-
|
|
1698
|
-
**Promise\<[shared.HrisTimeoff[]](../../models/.md)\>**
|
|
1699
|
-
|
|
1700
|
-
### Errors
|
|
1701
|
-
|
|
1702
|
-
| Error Type | Status Code | Content Type |
|
|
1703
|
-
| --------------- | --------------- | --------------- |
|
|
1704
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1705
|
-
|
|
1706
|
-
## listHrisTimeshifts
|
|
1707
|
-
|
|
1708
|
-
List all timeshifts
|
|
1709
|
-
|
|
1710
|
-
### Example Usage
|
|
1711
|
-
|
|
1712
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisTimeshifts" method="get" path="/hris/{connection_id}/timeshift" -->
|
|
1713
|
-
```typescript
|
|
1714
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1715
|
-
|
|
1716
|
-
const unifiedTo = new UnifiedTo({
|
|
1717
|
-
security: {
|
|
1718
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1719
|
-
},
|
|
1720
|
-
});
|
|
1721
|
-
|
|
1722
|
-
async function run() {
|
|
1723
|
-
const result = await unifiedTo.hris.listHrisTimeshifts({
|
|
1724
|
-
connectionId: "<id>",
|
|
1725
|
-
});
|
|
1726
|
-
|
|
1727
|
-
console.log(result);
|
|
1728
|
-
}
|
|
1729
|
-
|
|
1730
|
-
run();
|
|
1731
|
-
```
|
|
1732
|
-
|
|
1733
|
-
### Standalone function
|
|
1734
|
-
|
|
1735
|
-
The standalone function version of this method:
|
|
1736
|
-
|
|
1737
|
-
```typescript
|
|
1738
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1739
|
-
import { hrisListHrisTimeshifts } from "@unified-api/typescript-sdk/funcs/hrisListHrisTimeshifts.js";
|
|
1740
|
-
|
|
1741
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1742
|
-
// You can create one instance of it to use across an application.
|
|
1743
|
-
const unifiedTo = new UnifiedToCore({
|
|
1744
|
-
security: {
|
|
1745
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1746
|
-
},
|
|
1747
|
-
});
|
|
1748
|
-
|
|
1749
|
-
async function run() {
|
|
1750
|
-
const res = await hrisListHrisTimeshifts(unifiedTo, {
|
|
1751
|
-
connectionId: "<id>",
|
|
1752
|
-
});
|
|
1753
|
-
if (res.ok) {
|
|
1754
|
-
const { value: result } = res;
|
|
1755
|
-
console.log(result);
|
|
1756
|
-
} else {
|
|
1757
|
-
console.log("hrisListHrisTimeshifts failed:", res.error);
|
|
1758
|
-
}
|
|
1759
|
-
}
|
|
1760
|
-
|
|
1761
|
-
run();
|
|
1762
|
-
```
|
|
1763
|
-
|
|
1764
|
-
### Parameters
|
|
1765
|
-
|
|
1766
|
-
| Parameter | Type | Required | Description |
|
|
1767
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1768
|
-
| `request` | [operations.ListHrisTimeshiftsRequest](../../sdk/models/operations/listhristimeshiftsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1769
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1770
|
-
| `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. |
|
|
1771
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1772
|
-
|
|
1773
|
-
### Response
|
|
1774
|
-
|
|
1775
|
-
**Promise\<[shared.HrisTimeshift[]](../../models/.md)\>**
|
|
1776
|
-
|
|
1777
|
-
### Errors
|
|
1778
|
-
|
|
1779
|
-
| Error Type | Status Code | Content Type |
|
|
1780
|
-
| --------------- | --------------- | --------------- |
|
|
1781
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1782
|
-
|
|
1783
|
-
## patchHrisCompany
|
|
1784
|
-
|
|
1785
|
-
Update a company
|
|
1786
|
-
|
|
1787
|
-
### Example Usage
|
|
1788
|
-
|
|
1789
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisCompany" method="patch" path="/hris/{connection_id}/company/{id}" -->
|
|
1790
|
-
```typescript
|
|
1791
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1792
|
-
|
|
1793
|
-
const unifiedTo = new UnifiedTo({
|
|
1794
|
-
security: {
|
|
1795
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1796
|
-
},
|
|
1797
|
-
});
|
|
1798
|
-
|
|
1799
|
-
async function run() {
|
|
1800
|
-
const result = await unifiedTo.hris.patchHrisCompany({
|
|
1801
|
-
hrisCompany: {},
|
|
1802
|
-
connectionId: "<id>",
|
|
1803
|
-
id: "<id>",
|
|
1804
|
-
});
|
|
1805
|
-
|
|
1806
|
-
console.log(result);
|
|
1807
|
-
}
|
|
1808
|
-
|
|
1809
|
-
run();
|
|
1810
|
-
```
|
|
1811
|
-
|
|
1812
|
-
### Standalone function
|
|
1813
|
-
|
|
1814
|
-
The standalone function version of this method:
|
|
1815
|
-
|
|
1816
|
-
```typescript
|
|
1817
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1818
|
-
import { companyPatchHrisCompany } from "@unified-api/typescript-sdk/funcs/companyPatchHrisCompany.js";
|
|
1819
|
-
|
|
1820
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1821
|
-
// You can create one instance of it to use across an application.
|
|
1822
|
-
const unifiedTo = new UnifiedToCore({
|
|
1823
|
-
security: {
|
|
1824
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1825
|
-
},
|
|
1826
|
-
});
|
|
1827
|
-
|
|
1828
|
-
async function run() {
|
|
1829
|
-
const res = await companyPatchHrisCompany(unifiedTo, {
|
|
1830
|
-
hrisCompany: {},
|
|
1831
|
-
connectionId: "<id>",
|
|
1832
|
-
id: "<id>",
|
|
1833
|
-
});
|
|
1834
|
-
if (res.ok) {
|
|
1835
|
-
const { value: result } = res;
|
|
1836
|
-
console.log(result);
|
|
1837
|
-
} else {
|
|
1838
|
-
console.log("companyPatchHrisCompany failed:", res.error);
|
|
1839
|
-
}
|
|
1840
|
-
}
|
|
1841
|
-
|
|
1842
|
-
run();
|
|
1843
|
-
```
|
|
1844
|
-
|
|
1845
|
-
### Parameters
|
|
1846
|
-
|
|
1847
|
-
| Parameter | Type | Required | Description |
|
|
1848
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1849
|
-
| `request` | [operations.PatchHrisCompanyRequest](../../sdk/models/operations/patchhriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1850
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1851
|
-
| `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. |
|
|
1852
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1853
|
-
|
|
1854
|
-
### Response
|
|
1855
|
-
|
|
1856
|
-
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
1857
|
-
|
|
1858
|
-
### Errors
|
|
1859
|
-
|
|
1860
|
-
| Error Type | Status Code | Content Type |
|
|
1861
|
-
| --------------- | --------------- | --------------- |
|
|
1862
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1863
|
-
|
|
1864
|
-
## patchHrisDevice
|
|
1865
|
-
|
|
1866
|
-
Update a device
|
|
1867
|
-
|
|
1868
|
-
### Example Usage
|
|
1869
|
-
|
|
1870
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisDevice" method="patch" path="/hris/{connection_id}/device/{id}" -->
|
|
1871
|
-
```typescript
|
|
1872
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1873
|
-
|
|
1874
|
-
const unifiedTo = new UnifiedTo({
|
|
1875
|
-
security: {
|
|
1876
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1877
|
-
},
|
|
1878
|
-
});
|
|
1879
|
-
|
|
1880
|
-
async function run() {
|
|
1881
|
-
const result = await unifiedTo.hris.patchHrisDevice({
|
|
1882
|
-
hrisDevice: {
|
|
1883
|
-
name: "<value>",
|
|
1884
|
-
},
|
|
1885
|
-
connectionId: "<id>",
|
|
1886
|
-
id: "<id>",
|
|
1887
|
-
});
|
|
1888
|
-
|
|
1889
|
-
console.log(result);
|
|
1890
|
-
}
|
|
1891
|
-
|
|
1892
|
-
run();
|
|
1893
|
-
```
|
|
1894
|
-
|
|
1895
|
-
### Standalone function
|
|
1896
|
-
|
|
1897
|
-
The standalone function version of this method:
|
|
1898
|
-
|
|
1899
|
-
```typescript
|
|
1900
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1901
|
-
import { hrisPatchHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisDevice.js";
|
|
1902
|
-
|
|
1903
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1904
|
-
// You can create one instance of it to use across an application.
|
|
1905
|
-
const unifiedTo = new UnifiedToCore({
|
|
1906
|
-
security: {
|
|
1907
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1908
|
-
},
|
|
1909
|
-
});
|
|
1910
|
-
|
|
1911
|
-
async function run() {
|
|
1912
|
-
const res = await hrisPatchHrisDevice(unifiedTo, {
|
|
1913
|
-
hrisDevice: {
|
|
1914
|
-
name: "<value>",
|
|
1915
|
-
},
|
|
1916
|
-
connectionId: "<id>",
|
|
1917
|
-
id: "<id>",
|
|
1918
|
-
});
|
|
1919
|
-
if (res.ok) {
|
|
1920
|
-
const { value: result } = res;
|
|
1921
|
-
console.log(result);
|
|
1922
|
-
} else {
|
|
1923
|
-
console.log("hrisPatchHrisDevice failed:", res.error);
|
|
1924
|
-
}
|
|
1925
|
-
}
|
|
1926
|
-
|
|
1927
|
-
run();
|
|
1928
|
-
```
|
|
1929
|
-
|
|
1930
|
-
### Parameters
|
|
1931
|
-
|
|
1932
|
-
| Parameter | Type | Required | Description |
|
|
1933
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1934
|
-
| `request` | [operations.PatchHrisDeviceRequest](../../sdk/models/operations/patchhrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1935
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1936
|
-
| `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. |
|
|
1937
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1938
|
-
|
|
1939
|
-
### Response
|
|
1940
|
-
|
|
1941
|
-
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
1942
|
-
|
|
1943
|
-
### Errors
|
|
1944
|
-
|
|
1945
|
-
| Error Type | Status Code | Content Type |
|
|
1946
|
-
| --------------- | --------------- | --------------- |
|
|
1947
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1948
|
-
|
|
1949
|
-
## patchHrisEmployee
|
|
1950
|
-
|
|
1951
|
-
Update an employee
|
|
1952
|
-
|
|
1953
|
-
### Example Usage
|
|
1954
|
-
|
|
1955
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisEmployee" method="patch" path="/hris/{connection_id}/employee/{id}" -->
|
|
1956
|
-
```typescript
|
|
1957
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1958
|
-
|
|
1959
|
-
const unifiedTo = new UnifiedTo({
|
|
1960
|
-
security: {
|
|
1961
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1962
|
-
},
|
|
1963
|
-
});
|
|
1964
|
-
|
|
1965
|
-
async function run() {
|
|
1966
|
-
const result = await unifiedTo.hris.patchHrisEmployee({
|
|
1967
|
-
hrisEmployee: {},
|
|
1968
|
-
connectionId: "<id>",
|
|
1969
|
-
id: "<id>",
|
|
1970
|
-
});
|
|
1971
|
-
|
|
1972
|
-
console.log(result);
|
|
1973
|
-
}
|
|
1974
|
-
|
|
1975
|
-
run();
|
|
1976
|
-
```
|
|
1977
|
-
|
|
1978
|
-
### Standalone function
|
|
1979
|
-
|
|
1980
|
-
The standalone function version of this method:
|
|
1981
|
-
|
|
1982
|
-
```typescript
|
|
1983
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1984
|
-
import { hrisPatchHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisEmployee.js";
|
|
1985
|
-
|
|
1986
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1987
|
-
// You can create one instance of it to use across an application.
|
|
1988
|
-
const unifiedTo = new UnifiedToCore({
|
|
1989
|
-
security: {
|
|
1990
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1991
|
-
},
|
|
1992
|
-
});
|
|
1993
|
-
|
|
1994
|
-
async function run() {
|
|
1995
|
-
const res = await hrisPatchHrisEmployee(unifiedTo, {
|
|
1996
|
-
hrisEmployee: {},
|
|
1997
|
-
connectionId: "<id>",
|
|
1998
|
-
id: "<id>",
|
|
1999
|
-
});
|
|
2000
|
-
if (res.ok) {
|
|
2001
|
-
const { value: result } = res;
|
|
2002
|
-
console.log(result);
|
|
2003
|
-
} else {
|
|
2004
|
-
console.log("hrisPatchHrisEmployee failed:", res.error);
|
|
2005
|
-
}
|
|
2006
|
-
}
|
|
2007
|
-
|
|
2008
|
-
run();
|
|
2009
|
-
```
|
|
2010
|
-
|
|
2011
|
-
### Parameters
|
|
2012
|
-
|
|
2013
|
-
| Parameter | Type | Required | Description |
|
|
2014
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2015
|
-
| `request` | [operations.PatchHrisEmployeeRequest](../../sdk/models/operations/patchhrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2016
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2017
|
-
| `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. |
|
|
2018
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2019
|
-
|
|
2020
|
-
### Response
|
|
2021
|
-
|
|
2022
|
-
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
2023
|
-
|
|
2024
|
-
### Errors
|
|
2025
|
-
|
|
2026
|
-
| Error Type | Status Code | Content Type |
|
|
2027
|
-
| --------------- | --------------- | --------------- |
|
|
2028
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2029
|
-
|
|
2030
|
-
## patchHrisGroup
|
|
2031
|
-
|
|
2032
|
-
Update a group
|
|
2033
|
-
|
|
2034
|
-
### Example Usage
|
|
2035
|
-
|
|
2036
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisGroup" method="patch" path="/hris/{connection_id}/group/{id}" -->
|
|
2037
|
-
```typescript
|
|
2038
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2039
|
-
|
|
2040
|
-
const unifiedTo = new UnifiedTo({
|
|
2041
|
-
security: {
|
|
2042
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2043
|
-
},
|
|
2044
|
-
});
|
|
2045
|
-
|
|
2046
|
-
async function run() {
|
|
2047
|
-
const result = await unifiedTo.hris.patchHrisGroup({
|
|
2048
|
-
hrisGroup: {},
|
|
2049
|
-
connectionId: "<id>",
|
|
2050
|
-
id: "<id>",
|
|
2051
|
-
});
|
|
2052
|
-
|
|
2053
|
-
console.log(result);
|
|
2054
|
-
}
|
|
2055
|
-
|
|
2056
|
-
run();
|
|
2057
|
-
```
|
|
2058
|
-
|
|
2059
|
-
### Standalone function
|
|
2060
|
-
|
|
2061
|
-
The standalone function version of this method:
|
|
2062
|
-
|
|
2063
|
-
```typescript
|
|
2064
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2065
|
-
import { hrisPatchHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisGroup.js";
|
|
2066
|
-
|
|
2067
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2068
|
-
// You can create one instance of it to use across an application.
|
|
2069
|
-
const unifiedTo = new UnifiedToCore({
|
|
2070
|
-
security: {
|
|
2071
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2072
|
-
},
|
|
2073
|
-
});
|
|
2074
|
-
|
|
2075
|
-
async function run() {
|
|
2076
|
-
const res = await hrisPatchHrisGroup(unifiedTo, {
|
|
2077
|
-
hrisGroup: {},
|
|
2078
|
-
connectionId: "<id>",
|
|
2079
|
-
id: "<id>",
|
|
2080
|
-
});
|
|
2081
|
-
if (res.ok) {
|
|
2082
|
-
const { value: result } = res;
|
|
2083
|
-
console.log(result);
|
|
2084
|
-
} else {
|
|
2085
|
-
console.log("hrisPatchHrisGroup failed:", res.error);
|
|
2086
|
-
}
|
|
2087
|
-
}
|
|
2088
|
-
|
|
2089
|
-
run();
|
|
2090
|
-
```
|
|
2091
|
-
|
|
2092
|
-
### Parameters
|
|
2093
|
-
|
|
2094
|
-
| Parameter | Type | Required | Description |
|
|
2095
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2096
|
-
| `request` | [operations.PatchHrisGroupRequest](../../sdk/models/operations/patchhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2097
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2098
|
-
| `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. |
|
|
2099
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2100
|
-
|
|
2101
|
-
### Response
|
|
2102
|
-
|
|
2103
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
2104
|
-
|
|
2105
|
-
### Errors
|
|
2106
|
-
|
|
2107
|
-
| Error Type | Status Code | Content Type |
|
|
2108
|
-
| --------------- | --------------- | --------------- |
|
|
2109
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2110
|
-
|
|
2111
|
-
## patchHrisLocation
|
|
2112
|
-
|
|
2113
|
-
Update a location
|
|
2114
|
-
|
|
2115
|
-
### Example Usage
|
|
2116
|
-
|
|
2117
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisLocation" method="patch" path="/hris/{connection_id}/location/{id}" -->
|
|
2118
|
-
```typescript
|
|
2119
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2120
|
-
|
|
2121
|
-
const unifiedTo = new UnifiedTo({
|
|
2122
|
-
security: {
|
|
2123
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2124
|
-
},
|
|
2125
|
-
});
|
|
2126
|
-
|
|
2127
|
-
async function run() {
|
|
2128
|
-
const result = await unifiedTo.hris.patchHrisLocation({
|
|
2129
|
-
hrisLocation: {},
|
|
2130
|
-
connectionId: "<id>",
|
|
2131
|
-
id: "<id>",
|
|
2132
|
-
});
|
|
2133
|
-
|
|
2134
|
-
console.log(result);
|
|
2135
|
-
}
|
|
2136
|
-
|
|
2137
|
-
run();
|
|
2138
|
-
```
|
|
2139
|
-
|
|
2140
|
-
### Standalone function
|
|
2141
|
-
|
|
2142
|
-
The standalone function version of this method:
|
|
2143
|
-
|
|
2144
|
-
```typescript
|
|
2145
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2146
|
-
import { locationPatchHrisLocation } from "@unified-api/typescript-sdk/funcs/locationPatchHrisLocation.js";
|
|
2147
|
-
|
|
2148
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2149
|
-
// You can create one instance of it to use across an application.
|
|
2150
|
-
const unifiedTo = new UnifiedToCore({
|
|
2151
|
-
security: {
|
|
2152
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2153
|
-
},
|
|
2154
|
-
});
|
|
2155
|
-
|
|
2156
|
-
async function run() {
|
|
2157
|
-
const res = await locationPatchHrisLocation(unifiedTo, {
|
|
2158
|
-
hrisLocation: {},
|
|
2159
|
-
connectionId: "<id>",
|
|
2160
|
-
id: "<id>",
|
|
2161
|
-
});
|
|
2162
|
-
if (res.ok) {
|
|
2163
|
-
const { value: result } = res;
|
|
2164
|
-
console.log(result);
|
|
2165
|
-
} else {
|
|
2166
|
-
console.log("locationPatchHrisLocation failed:", res.error);
|
|
2167
|
-
}
|
|
2168
|
-
}
|
|
2169
|
-
|
|
2170
|
-
run();
|
|
2171
|
-
```
|
|
2172
|
-
|
|
2173
|
-
### Parameters
|
|
2174
|
-
|
|
2175
|
-
| Parameter | Type | Required | Description |
|
|
2176
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2177
|
-
| `request` | [operations.PatchHrisLocationRequest](../../sdk/models/operations/patchhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2178
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2179
|
-
| `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. |
|
|
2180
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2181
|
-
|
|
2182
|
-
### Response
|
|
2183
|
-
|
|
2184
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
2185
|
-
|
|
2186
|
-
### Errors
|
|
2187
|
-
|
|
2188
|
-
| Error Type | Status Code | Content Type |
|
|
2189
|
-
| --------------- | --------------- | --------------- |
|
|
2190
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2191
|
-
|
|
2192
|
-
## patchHrisTimeshift
|
|
2193
|
-
|
|
2194
|
-
Update a timeshift
|
|
2195
|
-
|
|
2196
|
-
### Example Usage
|
|
2197
|
-
|
|
2198
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisTimeshift" method="patch" path="/hris/{connection_id}/timeshift/{id}" -->
|
|
2199
|
-
```typescript
|
|
2200
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2201
|
-
|
|
2202
|
-
const unifiedTo = new UnifiedTo({
|
|
2203
|
-
security: {
|
|
2204
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2205
|
-
},
|
|
2206
|
-
});
|
|
2207
|
-
|
|
2208
|
-
async function run() {
|
|
2209
|
-
const result = await unifiedTo.hris.patchHrisTimeshift({
|
|
2210
|
-
hrisTimeshift: {
|
|
2211
|
-
employeeUserId: "<id>",
|
|
2212
|
-
endAt: new Date("2023-11-17T18:53:02.172Z"),
|
|
2213
|
-
startAt: new Date("2023-01-19T02:48:41.002Z"),
|
|
2214
|
-
},
|
|
2215
|
-
connectionId: "<id>",
|
|
2216
|
-
id: "<id>",
|
|
2217
|
-
});
|
|
2218
|
-
|
|
2219
|
-
console.log(result);
|
|
2220
|
-
}
|
|
2221
|
-
|
|
2222
|
-
run();
|
|
2223
|
-
```
|
|
2224
|
-
|
|
2225
|
-
### Standalone function
|
|
2226
|
-
|
|
2227
|
-
The standalone function version of this method:
|
|
2228
|
-
|
|
2229
|
-
```typescript
|
|
2230
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2231
|
-
import { hrisPatchHrisTimeshift } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisTimeshift.js";
|
|
2232
|
-
|
|
2233
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2234
|
-
// You can create one instance of it to use across an application.
|
|
2235
|
-
const unifiedTo = new UnifiedToCore({
|
|
2236
|
-
security: {
|
|
2237
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2238
|
-
},
|
|
2239
|
-
});
|
|
2240
|
-
|
|
2241
|
-
async function run() {
|
|
2242
|
-
const res = await hrisPatchHrisTimeshift(unifiedTo, {
|
|
2243
|
-
hrisTimeshift: {
|
|
2244
|
-
employeeUserId: "<id>",
|
|
2245
|
-
endAt: new Date("2023-11-17T18:53:02.172Z"),
|
|
2246
|
-
startAt: new Date("2023-01-19T02:48:41.002Z"),
|
|
2247
|
-
},
|
|
2248
|
-
connectionId: "<id>",
|
|
2249
|
-
id: "<id>",
|
|
2250
|
-
});
|
|
2251
|
-
if (res.ok) {
|
|
2252
|
-
const { value: result } = res;
|
|
2253
|
-
console.log(result);
|
|
2254
|
-
} else {
|
|
2255
|
-
console.log("hrisPatchHrisTimeshift failed:", res.error);
|
|
2256
|
-
}
|
|
2257
|
-
}
|
|
2258
|
-
|
|
2259
|
-
run();
|
|
2260
|
-
```
|
|
2261
|
-
|
|
2262
|
-
### Parameters
|
|
2263
|
-
|
|
2264
|
-
| Parameter | Type | Required | Description |
|
|
2265
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2266
|
-
| `request` | [operations.PatchHrisTimeshiftRequest](../../sdk/models/operations/patchhristimeshiftrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2267
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2268
|
-
| `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. |
|
|
2269
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2270
|
-
|
|
2271
|
-
### Response
|
|
2272
|
-
|
|
2273
|
-
**Promise\<[shared.HrisTimeshift](../../sdk/models/shared/hristimeshift.md)\>**
|
|
2274
|
-
|
|
2275
|
-
### Errors
|
|
2276
|
-
|
|
2277
|
-
| Error Type | Status Code | Content Type |
|
|
2278
|
-
| --------------- | --------------- | --------------- |
|
|
2279
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2280
|
-
|
|
2281
|
-
## removeHrisCompany
|
|
2282
|
-
|
|
2283
|
-
Remove a company
|
|
2284
|
-
|
|
2285
|
-
### Example Usage
|
|
2286
|
-
|
|
2287
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisCompany" method="delete" path="/hris/{connection_id}/company/{id}" -->
|
|
2288
|
-
```typescript
|
|
2289
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2290
|
-
|
|
2291
|
-
const unifiedTo = new UnifiedTo({
|
|
2292
|
-
security: {
|
|
2293
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2294
|
-
},
|
|
2295
|
-
});
|
|
2296
|
-
|
|
2297
|
-
async function run() {
|
|
2298
|
-
const result = await unifiedTo.hris.removeHrisCompany({
|
|
2299
|
-
connectionId: "<id>",
|
|
2300
|
-
id: "<id>",
|
|
2301
|
-
});
|
|
2302
|
-
|
|
2303
|
-
console.log(result);
|
|
2304
|
-
}
|
|
2305
|
-
|
|
2306
|
-
run();
|
|
2307
|
-
```
|
|
2308
|
-
|
|
2309
|
-
### Standalone function
|
|
2310
|
-
|
|
2311
|
-
The standalone function version of this method:
|
|
2312
|
-
|
|
2313
|
-
```typescript
|
|
2314
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2315
|
-
import { companyRemoveHrisCompany } from "@unified-api/typescript-sdk/funcs/companyRemoveHrisCompany.js";
|
|
2316
|
-
|
|
2317
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2318
|
-
// You can create one instance of it to use across an application.
|
|
2319
|
-
const unifiedTo = new UnifiedToCore({
|
|
2320
|
-
security: {
|
|
2321
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2322
|
-
},
|
|
2323
|
-
});
|
|
2324
|
-
|
|
2325
|
-
async function run() {
|
|
2326
|
-
const res = await companyRemoveHrisCompany(unifiedTo, {
|
|
2327
|
-
connectionId: "<id>",
|
|
2328
|
-
id: "<id>",
|
|
2329
|
-
});
|
|
2330
|
-
if (res.ok) {
|
|
2331
|
-
const { value: result } = res;
|
|
2332
|
-
console.log(result);
|
|
2333
|
-
} else {
|
|
2334
|
-
console.log("companyRemoveHrisCompany failed:", res.error);
|
|
2335
|
-
}
|
|
2336
|
-
}
|
|
2337
|
-
|
|
2338
|
-
run();
|
|
2339
|
-
```
|
|
2340
|
-
|
|
2341
|
-
### Parameters
|
|
2342
|
-
|
|
2343
|
-
| Parameter | Type | Required | Description |
|
|
2344
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2345
|
-
| `request` | [operations.RemoveHrisCompanyRequest](../../sdk/models/operations/removehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2346
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2347
|
-
| `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. |
|
|
2348
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2349
|
-
|
|
2350
|
-
### Response
|
|
2351
|
-
|
|
2352
|
-
**Promise\<[operations.RemoveHrisCompanyResponse](../../sdk/models/operations/removehriscompanyresponse.md)\>**
|
|
2353
|
-
|
|
2354
|
-
### Errors
|
|
2355
|
-
|
|
2356
|
-
| Error Type | Status Code | Content Type |
|
|
2357
|
-
| --------------- | --------------- | --------------- |
|
|
2358
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2359
|
-
|
|
2360
|
-
## removeHrisDevice
|
|
2361
|
-
|
|
2362
|
-
Remove a device
|
|
2363
|
-
|
|
2364
|
-
### Example Usage
|
|
2365
|
-
|
|
2366
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisDevice" method="delete" path="/hris/{connection_id}/device/{id}" -->
|
|
2367
|
-
```typescript
|
|
2368
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2369
|
-
|
|
2370
|
-
const unifiedTo = new UnifiedTo({
|
|
2371
|
-
security: {
|
|
2372
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2373
|
-
},
|
|
2374
|
-
});
|
|
2375
|
-
|
|
2376
|
-
async function run() {
|
|
2377
|
-
const result = await unifiedTo.hris.removeHrisDevice({
|
|
2378
|
-
connectionId: "<id>",
|
|
2379
|
-
id: "<id>",
|
|
2380
|
-
});
|
|
2381
|
-
|
|
2382
|
-
console.log(result);
|
|
2383
|
-
}
|
|
2384
|
-
|
|
2385
|
-
run();
|
|
2386
|
-
```
|
|
2387
|
-
|
|
2388
|
-
### Standalone function
|
|
2389
|
-
|
|
2390
|
-
The standalone function version of this method:
|
|
2391
|
-
|
|
2392
|
-
```typescript
|
|
2393
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2394
|
-
import { hrisRemoveHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisDevice.js";
|
|
2395
|
-
|
|
2396
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2397
|
-
// You can create one instance of it to use across an application.
|
|
2398
|
-
const unifiedTo = new UnifiedToCore({
|
|
2399
|
-
security: {
|
|
2400
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2401
|
-
},
|
|
2402
|
-
});
|
|
2403
|
-
|
|
2404
|
-
async function run() {
|
|
2405
|
-
const res = await hrisRemoveHrisDevice(unifiedTo, {
|
|
2406
|
-
connectionId: "<id>",
|
|
2407
|
-
id: "<id>",
|
|
2408
|
-
});
|
|
2409
|
-
if (res.ok) {
|
|
2410
|
-
const { value: result } = res;
|
|
2411
|
-
console.log(result);
|
|
2412
|
-
} else {
|
|
2413
|
-
console.log("hrisRemoveHrisDevice failed:", res.error);
|
|
2414
|
-
}
|
|
2415
|
-
}
|
|
2416
|
-
|
|
2417
|
-
run();
|
|
2418
|
-
```
|
|
2419
|
-
|
|
2420
|
-
### Parameters
|
|
2421
|
-
|
|
2422
|
-
| Parameter | Type | Required | Description |
|
|
2423
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2424
|
-
| `request` | [operations.RemoveHrisDeviceRequest](../../sdk/models/operations/removehrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2425
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2426
|
-
| `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. |
|
|
2427
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2428
|
-
|
|
2429
|
-
### Response
|
|
2430
|
-
|
|
2431
|
-
**Promise\<[operations.RemoveHrisDeviceResponse](../../sdk/models/operations/removehrisdeviceresponse.md)\>**
|
|
2432
|
-
|
|
2433
|
-
### Errors
|
|
2434
|
-
|
|
2435
|
-
| Error Type | Status Code | Content Type |
|
|
2436
|
-
| --------------- | --------------- | --------------- |
|
|
2437
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2438
|
-
|
|
2439
|
-
## removeHrisEmployee
|
|
2440
|
-
|
|
2441
|
-
Remove an employee
|
|
2442
|
-
|
|
2443
|
-
### Example Usage
|
|
2444
|
-
|
|
2445
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisEmployee" method="delete" path="/hris/{connection_id}/employee/{id}" -->
|
|
2446
|
-
```typescript
|
|
2447
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2448
|
-
|
|
2449
|
-
const unifiedTo = new UnifiedTo({
|
|
2450
|
-
security: {
|
|
2451
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2452
|
-
},
|
|
2453
|
-
});
|
|
2454
|
-
|
|
2455
|
-
async function run() {
|
|
2456
|
-
const result = await unifiedTo.hris.removeHrisEmployee({
|
|
2457
|
-
connectionId: "<id>",
|
|
2458
|
-
id: "<id>",
|
|
2459
|
-
});
|
|
2460
|
-
|
|
2461
|
-
console.log(result);
|
|
2462
|
-
}
|
|
2463
|
-
|
|
2464
|
-
run();
|
|
2465
|
-
```
|
|
2466
|
-
|
|
2467
|
-
### Standalone function
|
|
2468
|
-
|
|
2469
|
-
The standalone function version of this method:
|
|
2470
|
-
|
|
2471
|
-
```typescript
|
|
2472
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2473
|
-
import { hrisRemoveHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisEmployee.js";
|
|
2474
|
-
|
|
2475
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2476
|
-
// You can create one instance of it to use across an application.
|
|
2477
|
-
const unifiedTo = new UnifiedToCore({
|
|
2478
|
-
security: {
|
|
2479
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2480
|
-
},
|
|
2481
|
-
});
|
|
2482
|
-
|
|
2483
|
-
async function run() {
|
|
2484
|
-
const res = await hrisRemoveHrisEmployee(unifiedTo, {
|
|
2485
|
-
connectionId: "<id>",
|
|
2486
|
-
id: "<id>",
|
|
2487
|
-
});
|
|
2488
|
-
if (res.ok) {
|
|
2489
|
-
const { value: result } = res;
|
|
2490
|
-
console.log(result);
|
|
2491
|
-
} else {
|
|
2492
|
-
console.log("hrisRemoveHrisEmployee failed:", res.error);
|
|
2493
|
-
}
|
|
2494
|
-
}
|
|
2495
|
-
|
|
2496
|
-
run();
|
|
2497
|
-
```
|
|
2498
|
-
|
|
2499
|
-
### Parameters
|
|
2500
|
-
|
|
2501
|
-
| Parameter | Type | Required | Description |
|
|
2502
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2503
|
-
| `request` | [operations.RemoveHrisEmployeeRequest](../../sdk/models/operations/removehrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2504
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2505
|
-
| `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. |
|
|
2506
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2507
|
-
|
|
2508
|
-
### Response
|
|
2509
|
-
|
|
2510
|
-
**Promise\<[operations.RemoveHrisEmployeeResponse](../../sdk/models/operations/removehrisemployeeresponse.md)\>**
|
|
2511
|
-
|
|
2512
|
-
### Errors
|
|
2513
|
-
|
|
2514
|
-
| Error Type | Status Code | Content Type |
|
|
2515
|
-
| --------------- | --------------- | --------------- |
|
|
2516
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2517
|
-
|
|
2518
|
-
## removeHrisGroup
|
|
2519
|
-
|
|
2520
|
-
Remove a group
|
|
2521
|
-
|
|
2522
|
-
### Example Usage
|
|
2523
|
-
|
|
2524
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisGroup" method="delete" path="/hris/{connection_id}/group/{id}" -->
|
|
2525
|
-
```typescript
|
|
2526
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2527
|
-
|
|
2528
|
-
const unifiedTo = new UnifiedTo({
|
|
2529
|
-
security: {
|
|
2530
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2531
|
-
},
|
|
2532
|
-
});
|
|
2533
|
-
|
|
2534
|
-
async function run() {
|
|
2535
|
-
const result = await unifiedTo.hris.removeHrisGroup({
|
|
2536
|
-
connectionId: "<id>",
|
|
2537
|
-
id: "<id>",
|
|
2538
|
-
});
|
|
2539
|
-
|
|
2540
|
-
console.log(result);
|
|
2541
|
-
}
|
|
2542
|
-
|
|
2543
|
-
run();
|
|
2544
|
-
```
|
|
2545
|
-
|
|
2546
|
-
### Standalone function
|
|
2547
|
-
|
|
2548
|
-
The standalone function version of this method:
|
|
2549
|
-
|
|
2550
|
-
```typescript
|
|
2551
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2552
|
-
import { hrisRemoveHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisGroup.js";
|
|
2553
|
-
|
|
2554
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2555
|
-
// You can create one instance of it to use across an application.
|
|
2556
|
-
const unifiedTo = new UnifiedToCore({
|
|
2557
|
-
security: {
|
|
2558
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2559
|
-
},
|
|
2560
|
-
});
|
|
2561
|
-
|
|
2562
|
-
async function run() {
|
|
2563
|
-
const res = await hrisRemoveHrisGroup(unifiedTo, {
|
|
2564
|
-
connectionId: "<id>",
|
|
2565
|
-
id: "<id>",
|
|
2566
|
-
});
|
|
2567
|
-
if (res.ok) {
|
|
2568
|
-
const { value: result } = res;
|
|
2569
|
-
console.log(result);
|
|
2570
|
-
} else {
|
|
2571
|
-
console.log("hrisRemoveHrisGroup failed:", res.error);
|
|
2572
|
-
}
|
|
2573
|
-
}
|
|
2574
|
-
|
|
2575
|
-
run();
|
|
2576
|
-
```
|
|
2577
|
-
|
|
2578
|
-
### Parameters
|
|
2579
|
-
|
|
2580
|
-
| Parameter | Type | Required | Description |
|
|
2581
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2582
|
-
| `request` | [operations.RemoveHrisGroupRequest](../../sdk/models/operations/removehrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2583
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2584
|
-
| `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. |
|
|
2585
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2586
|
-
|
|
2587
|
-
### Response
|
|
2588
|
-
|
|
2589
|
-
**Promise\<[operations.RemoveHrisGroupResponse](../../sdk/models/operations/removehrisgroupresponse.md)\>**
|
|
2590
|
-
|
|
2591
|
-
### Errors
|
|
2592
|
-
|
|
2593
|
-
| Error Type | Status Code | Content Type |
|
|
2594
|
-
| --------------- | --------------- | --------------- |
|
|
2595
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2596
|
-
|
|
2597
|
-
## removeHrisLocation
|
|
2598
|
-
|
|
2599
|
-
Remove a location
|
|
2600
|
-
|
|
2601
|
-
### Example Usage
|
|
2602
|
-
|
|
2603
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisLocation" method="delete" path="/hris/{connection_id}/location/{id}" -->
|
|
2604
|
-
```typescript
|
|
2605
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2606
|
-
|
|
2607
|
-
const unifiedTo = new UnifiedTo({
|
|
2608
|
-
security: {
|
|
2609
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2610
|
-
},
|
|
2611
|
-
});
|
|
2612
|
-
|
|
2613
|
-
async function run() {
|
|
2614
|
-
const result = await unifiedTo.hris.removeHrisLocation({
|
|
2615
|
-
connectionId: "<id>",
|
|
2616
|
-
id: "<id>",
|
|
2617
|
-
});
|
|
2618
|
-
|
|
2619
|
-
console.log(result);
|
|
2620
|
-
}
|
|
2621
|
-
|
|
2622
|
-
run();
|
|
2623
|
-
```
|
|
2624
|
-
|
|
2625
|
-
### Standalone function
|
|
2626
|
-
|
|
2627
|
-
The standalone function version of this method:
|
|
2628
|
-
|
|
2629
|
-
```typescript
|
|
2630
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2631
|
-
import { locationRemoveHrisLocation } from "@unified-api/typescript-sdk/funcs/locationRemoveHrisLocation.js";
|
|
2632
|
-
|
|
2633
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2634
|
-
// You can create one instance of it to use across an application.
|
|
2635
|
-
const unifiedTo = new UnifiedToCore({
|
|
2636
|
-
security: {
|
|
2637
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2638
|
-
},
|
|
2639
|
-
});
|
|
2640
|
-
|
|
2641
|
-
async function run() {
|
|
2642
|
-
const res = await locationRemoveHrisLocation(unifiedTo, {
|
|
2643
|
-
connectionId: "<id>",
|
|
2644
|
-
id: "<id>",
|
|
2645
|
-
});
|
|
2646
|
-
if (res.ok) {
|
|
2647
|
-
const { value: result } = res;
|
|
2648
|
-
console.log(result);
|
|
2649
|
-
} else {
|
|
2650
|
-
console.log("locationRemoveHrisLocation failed:", res.error);
|
|
2651
|
-
}
|
|
2652
|
-
}
|
|
2653
|
-
|
|
2654
|
-
run();
|
|
2655
|
-
```
|
|
2656
|
-
|
|
2657
|
-
### Parameters
|
|
2658
|
-
|
|
2659
|
-
| Parameter | Type | Required | Description |
|
|
2660
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2661
|
-
| `request` | [operations.RemoveHrisLocationRequest](../../sdk/models/operations/removehrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2662
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2663
|
-
| `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. |
|
|
2664
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2665
|
-
|
|
2666
|
-
### Response
|
|
2667
|
-
|
|
2668
|
-
**Promise\<[operations.RemoveHrisLocationResponse](../../sdk/models/operations/removehrislocationresponse.md)\>**
|
|
2669
|
-
|
|
2670
|
-
### Errors
|
|
2671
|
-
|
|
2672
|
-
| Error Type | Status Code | Content Type |
|
|
2673
|
-
| --------------- | --------------- | --------------- |
|
|
2674
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2675
|
-
|
|
2676
|
-
## removeHrisTimeshift
|
|
2677
|
-
|
|
2678
|
-
Remove a timeshift
|
|
2679
|
-
|
|
2680
|
-
### Example Usage
|
|
2681
|
-
|
|
2682
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisTimeshift" method="delete" path="/hris/{connection_id}/timeshift/{id}" -->
|
|
2683
|
-
```typescript
|
|
2684
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2685
|
-
|
|
2686
|
-
const unifiedTo = new UnifiedTo({
|
|
2687
|
-
security: {
|
|
2688
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2689
|
-
},
|
|
2690
|
-
});
|
|
2691
|
-
|
|
2692
|
-
async function run() {
|
|
2693
|
-
const result = await unifiedTo.hris.removeHrisTimeshift({
|
|
2694
|
-
connectionId: "<id>",
|
|
2695
|
-
id: "<id>",
|
|
2696
|
-
});
|
|
2697
|
-
|
|
2698
|
-
console.log(result);
|
|
2699
|
-
}
|
|
2700
|
-
|
|
2701
|
-
run();
|
|
2702
|
-
```
|
|
2703
|
-
|
|
2704
|
-
### Standalone function
|
|
2705
|
-
|
|
2706
|
-
The standalone function version of this method:
|
|
2707
|
-
|
|
2708
|
-
```typescript
|
|
2709
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2710
|
-
import { hrisRemoveHrisTimeshift } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisTimeshift.js";
|
|
2711
|
-
|
|
2712
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2713
|
-
// You can create one instance of it to use across an application.
|
|
2714
|
-
const unifiedTo = new UnifiedToCore({
|
|
2715
|
-
security: {
|
|
2716
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2717
|
-
},
|
|
2718
|
-
});
|
|
2719
|
-
|
|
2720
|
-
async function run() {
|
|
2721
|
-
const res = await hrisRemoveHrisTimeshift(unifiedTo, {
|
|
2722
|
-
connectionId: "<id>",
|
|
2723
|
-
id: "<id>",
|
|
2724
|
-
});
|
|
2725
|
-
if (res.ok) {
|
|
2726
|
-
const { value: result } = res;
|
|
2727
|
-
console.log(result);
|
|
2728
|
-
} else {
|
|
2729
|
-
console.log("hrisRemoveHrisTimeshift failed:", res.error);
|
|
2730
|
-
}
|
|
2731
|
-
}
|
|
2732
|
-
|
|
2733
|
-
run();
|
|
2734
|
-
```
|
|
2735
|
-
|
|
2736
|
-
### Parameters
|
|
2737
|
-
|
|
2738
|
-
| Parameter | Type | Required | Description |
|
|
2739
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2740
|
-
| `request` | [operations.RemoveHrisTimeshiftRequest](../../sdk/models/operations/removehristimeshiftrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2741
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2742
|
-
| `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. |
|
|
2743
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2744
|
-
|
|
2745
|
-
### Response
|
|
2746
|
-
|
|
2747
|
-
**Promise\<[operations.RemoveHrisTimeshiftResponse](../../sdk/models/operations/removehristimeshiftresponse.md)\>**
|
|
2748
|
-
|
|
2749
|
-
### Errors
|
|
2750
|
-
|
|
2751
|
-
| Error Type | Status Code | Content Type |
|
|
2752
|
-
| --------------- | --------------- | --------------- |
|
|
2753
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2754
|
-
|
|
2755
|
-
## updateHrisCompany
|
|
2756
|
-
|
|
2757
|
-
Update a company
|
|
2758
|
-
|
|
2759
|
-
### Example Usage
|
|
2760
|
-
|
|
2761
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisCompany" method="put" path="/hris/{connection_id}/company/{id}" -->
|
|
2762
|
-
```typescript
|
|
2763
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2764
|
-
|
|
2765
|
-
const unifiedTo = new UnifiedTo({
|
|
2766
|
-
security: {
|
|
2767
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2768
|
-
},
|
|
2769
|
-
});
|
|
2770
|
-
|
|
2771
|
-
async function run() {
|
|
2772
|
-
const result = await unifiedTo.hris.updateHrisCompany({
|
|
2773
|
-
hrisCompany: {},
|
|
2774
|
-
connectionId: "<id>",
|
|
2775
|
-
id: "<id>",
|
|
2776
|
-
});
|
|
2777
|
-
|
|
2778
|
-
console.log(result);
|
|
2779
|
-
}
|
|
2780
|
-
|
|
2781
|
-
run();
|
|
2782
|
-
```
|
|
2783
|
-
|
|
2784
|
-
### Standalone function
|
|
2785
|
-
|
|
2786
|
-
The standalone function version of this method:
|
|
2787
|
-
|
|
2788
|
-
```typescript
|
|
2789
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2790
|
-
import { companyUpdateHrisCompany } from "@unified-api/typescript-sdk/funcs/companyUpdateHrisCompany.js";
|
|
2791
|
-
|
|
2792
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2793
|
-
// You can create one instance of it to use across an application.
|
|
2794
|
-
const unifiedTo = new UnifiedToCore({
|
|
2795
|
-
security: {
|
|
2796
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2797
|
-
},
|
|
2798
|
-
});
|
|
2799
|
-
|
|
2800
|
-
async function run() {
|
|
2801
|
-
const res = await companyUpdateHrisCompany(unifiedTo, {
|
|
2802
|
-
hrisCompany: {},
|
|
2803
|
-
connectionId: "<id>",
|
|
2804
|
-
id: "<id>",
|
|
2805
|
-
});
|
|
2806
|
-
if (res.ok) {
|
|
2807
|
-
const { value: result } = res;
|
|
2808
|
-
console.log(result);
|
|
2809
|
-
} else {
|
|
2810
|
-
console.log("companyUpdateHrisCompany failed:", res.error);
|
|
2811
|
-
}
|
|
2812
|
-
}
|
|
2813
|
-
|
|
2814
|
-
run();
|
|
2815
|
-
```
|
|
2816
|
-
|
|
2817
|
-
### Parameters
|
|
2818
|
-
|
|
2819
|
-
| Parameter | Type | Required | Description |
|
|
2820
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2821
|
-
| `request` | [operations.UpdateHrisCompanyRequest](../../sdk/models/operations/updatehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2822
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2823
|
-
| `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. |
|
|
2824
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2825
|
-
|
|
2826
|
-
### Response
|
|
2827
|
-
|
|
2828
|
-
**Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
|
|
2829
|
-
|
|
2830
|
-
### Errors
|
|
2831
|
-
|
|
2832
|
-
| Error Type | Status Code | Content Type |
|
|
2833
|
-
| --------------- | --------------- | --------------- |
|
|
2834
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2835
|
-
|
|
2836
|
-
## updateHrisDevice
|
|
2837
|
-
|
|
2838
|
-
Update a device
|
|
2839
|
-
|
|
2840
|
-
### Example Usage
|
|
2841
|
-
|
|
2842
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisDevice" method="put" path="/hris/{connection_id}/device/{id}" -->
|
|
2843
|
-
```typescript
|
|
2844
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2845
|
-
|
|
2846
|
-
const unifiedTo = new UnifiedTo({
|
|
2847
|
-
security: {
|
|
2848
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2849
|
-
},
|
|
2850
|
-
});
|
|
2851
|
-
|
|
2852
|
-
async function run() {
|
|
2853
|
-
const result = await unifiedTo.hris.updateHrisDevice({
|
|
2854
|
-
hrisDevice: {
|
|
2855
|
-
name: "<value>",
|
|
2856
|
-
},
|
|
2857
|
-
connectionId: "<id>",
|
|
2858
|
-
id: "<id>",
|
|
2859
|
-
});
|
|
2860
|
-
|
|
2861
|
-
console.log(result);
|
|
2862
|
-
}
|
|
2863
|
-
|
|
2864
|
-
run();
|
|
2865
|
-
```
|
|
2866
|
-
|
|
2867
|
-
### Standalone function
|
|
2868
|
-
|
|
2869
|
-
The standalone function version of this method:
|
|
2870
|
-
|
|
2871
|
-
```typescript
|
|
2872
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2873
|
-
import { hrisUpdateHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisDevice.js";
|
|
2874
|
-
|
|
2875
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2876
|
-
// You can create one instance of it to use across an application.
|
|
2877
|
-
const unifiedTo = new UnifiedToCore({
|
|
2878
|
-
security: {
|
|
2879
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2880
|
-
},
|
|
2881
|
-
});
|
|
2882
|
-
|
|
2883
|
-
async function run() {
|
|
2884
|
-
const res = await hrisUpdateHrisDevice(unifiedTo, {
|
|
2885
|
-
hrisDevice: {
|
|
2886
|
-
name: "<value>",
|
|
2887
|
-
},
|
|
2888
|
-
connectionId: "<id>",
|
|
2889
|
-
id: "<id>",
|
|
2890
|
-
});
|
|
2891
|
-
if (res.ok) {
|
|
2892
|
-
const { value: result } = res;
|
|
2893
|
-
console.log(result);
|
|
2894
|
-
} else {
|
|
2895
|
-
console.log("hrisUpdateHrisDevice failed:", res.error);
|
|
2896
|
-
}
|
|
2897
|
-
}
|
|
2898
|
-
|
|
2899
|
-
run();
|
|
2900
|
-
```
|
|
2901
|
-
|
|
2902
|
-
### Parameters
|
|
2903
|
-
|
|
2904
|
-
| Parameter | Type | Required | Description |
|
|
2905
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2906
|
-
| `request` | [operations.UpdateHrisDeviceRequest](../../sdk/models/operations/updatehrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2907
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2908
|
-
| `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. |
|
|
2909
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2910
|
-
|
|
2911
|
-
### Response
|
|
2912
|
-
|
|
2913
|
-
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
2914
|
-
|
|
2915
|
-
### Errors
|
|
2916
|
-
|
|
2917
|
-
| Error Type | Status Code | Content Type |
|
|
2918
|
-
| --------------- | --------------- | --------------- |
|
|
2919
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2920
|
-
|
|
2921
|
-
## updateHrisEmployee
|
|
2922
|
-
|
|
2923
|
-
Update an employee
|
|
2924
|
-
|
|
2925
|
-
### Example Usage
|
|
2926
|
-
|
|
2927
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisEmployee" method="put" path="/hris/{connection_id}/employee/{id}" -->
|
|
2928
|
-
```typescript
|
|
2929
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2930
|
-
|
|
2931
|
-
const unifiedTo = new UnifiedTo({
|
|
2932
|
-
security: {
|
|
2933
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2934
|
-
},
|
|
2935
|
-
});
|
|
2936
|
-
|
|
2937
|
-
async function run() {
|
|
2938
|
-
const result = await unifiedTo.hris.updateHrisEmployee({
|
|
2939
|
-
hrisEmployee: {},
|
|
2940
|
-
connectionId: "<id>",
|
|
2941
|
-
id: "<id>",
|
|
2942
|
-
});
|
|
2943
|
-
|
|
2944
|
-
console.log(result);
|
|
2945
|
-
}
|
|
2946
|
-
|
|
2947
|
-
run();
|
|
2948
|
-
```
|
|
2949
|
-
|
|
2950
|
-
### Standalone function
|
|
2951
|
-
|
|
2952
|
-
The standalone function version of this method:
|
|
2953
|
-
|
|
2954
|
-
```typescript
|
|
2955
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2956
|
-
import { hrisUpdateHrisEmployee } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisEmployee.js";
|
|
2957
|
-
|
|
2958
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2959
|
-
// You can create one instance of it to use across an application.
|
|
2960
|
-
const unifiedTo = new UnifiedToCore({
|
|
2961
|
-
security: {
|
|
2962
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
2963
|
-
},
|
|
2964
|
-
});
|
|
2965
|
-
|
|
2966
|
-
async function run() {
|
|
2967
|
-
const res = await hrisUpdateHrisEmployee(unifiedTo, {
|
|
2968
|
-
hrisEmployee: {},
|
|
2969
|
-
connectionId: "<id>",
|
|
2970
|
-
id: "<id>",
|
|
2971
|
-
});
|
|
2972
|
-
if (res.ok) {
|
|
2973
|
-
const { value: result } = res;
|
|
2974
|
-
console.log(result);
|
|
2975
|
-
} else {
|
|
2976
|
-
console.log("hrisUpdateHrisEmployee failed:", res.error);
|
|
2977
|
-
}
|
|
2978
|
-
}
|
|
2979
|
-
|
|
2980
|
-
run();
|
|
2981
|
-
```
|
|
2982
|
-
|
|
2983
|
-
### Parameters
|
|
2984
|
-
|
|
2985
|
-
| Parameter | Type | Required | Description |
|
|
2986
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2987
|
-
| `request` | [operations.UpdateHrisEmployeeRequest](../../sdk/models/operations/updatehrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2988
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2989
|
-
| `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. |
|
|
2990
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2991
|
-
|
|
2992
|
-
### Response
|
|
2993
|
-
|
|
2994
|
-
**Promise\<[shared.HrisEmployee](../../sdk/models/shared/hrisemployee.md)\>**
|
|
2995
|
-
|
|
2996
|
-
### Errors
|
|
2997
|
-
|
|
2998
|
-
| Error Type | Status Code | Content Type |
|
|
2999
|
-
| --------------- | --------------- | --------------- |
|
|
3000
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3001
|
-
|
|
3002
|
-
## updateHrisGroup
|
|
3003
|
-
|
|
3004
|
-
Update a group
|
|
3005
|
-
|
|
3006
|
-
### Example Usage
|
|
3007
|
-
|
|
3008
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisGroup" method="put" path="/hris/{connection_id}/group/{id}" -->
|
|
3009
|
-
```typescript
|
|
3010
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3011
|
-
|
|
3012
|
-
const unifiedTo = new UnifiedTo({
|
|
3013
|
-
security: {
|
|
3014
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
3015
|
-
},
|
|
3016
|
-
});
|
|
3017
|
-
|
|
3018
|
-
async function run() {
|
|
3019
|
-
const result = await unifiedTo.hris.updateHrisGroup({
|
|
3020
|
-
hrisGroup: {},
|
|
3021
|
-
connectionId: "<id>",
|
|
3022
|
-
id: "<id>",
|
|
3023
|
-
});
|
|
3024
|
-
|
|
3025
|
-
console.log(result);
|
|
3026
|
-
}
|
|
3027
|
-
|
|
3028
|
-
run();
|
|
3029
|
-
```
|
|
3030
|
-
|
|
3031
|
-
### Standalone function
|
|
3032
|
-
|
|
3033
|
-
The standalone function version of this method:
|
|
3034
|
-
|
|
3035
|
-
```typescript
|
|
3036
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3037
|
-
import { hrisUpdateHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisGroup.js";
|
|
3038
|
-
|
|
3039
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3040
|
-
// You can create one instance of it to use across an application.
|
|
3041
|
-
const unifiedTo = new UnifiedToCore({
|
|
3042
|
-
security: {
|
|
3043
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
3044
|
-
},
|
|
3045
|
-
});
|
|
3046
|
-
|
|
3047
|
-
async function run() {
|
|
3048
|
-
const res = await hrisUpdateHrisGroup(unifiedTo, {
|
|
3049
|
-
hrisGroup: {},
|
|
3050
|
-
connectionId: "<id>",
|
|
3051
|
-
id: "<id>",
|
|
3052
|
-
});
|
|
3053
|
-
if (res.ok) {
|
|
3054
|
-
const { value: result } = res;
|
|
3055
|
-
console.log(result);
|
|
3056
|
-
} else {
|
|
3057
|
-
console.log("hrisUpdateHrisGroup failed:", res.error);
|
|
3058
|
-
}
|
|
3059
|
-
}
|
|
3060
|
-
|
|
3061
|
-
run();
|
|
3062
|
-
```
|
|
3063
|
-
|
|
3064
|
-
### Parameters
|
|
3065
|
-
|
|
3066
|
-
| Parameter | Type | Required | Description |
|
|
3067
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3068
|
-
| `request` | [operations.UpdateHrisGroupRequest](../../sdk/models/operations/updatehrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3069
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3070
|
-
| `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. |
|
|
3071
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3072
|
-
|
|
3073
|
-
### Response
|
|
3074
|
-
|
|
3075
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
3076
|
-
|
|
3077
|
-
### Errors
|
|
3078
|
-
|
|
3079
|
-
| Error Type | Status Code | Content Type |
|
|
3080
|
-
| --------------- | --------------- | --------------- |
|
|
3081
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3082
|
-
|
|
3083
|
-
## updateHrisLocation
|
|
3084
|
-
|
|
3085
|
-
Update a location
|
|
3086
|
-
|
|
3087
|
-
### Example Usage
|
|
3088
|
-
|
|
3089
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisLocation" method="put" path="/hris/{connection_id}/location/{id}" -->
|
|
3090
|
-
```typescript
|
|
3091
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3092
|
-
|
|
3093
|
-
const unifiedTo = new UnifiedTo({
|
|
3094
|
-
security: {
|
|
3095
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
3096
|
-
},
|
|
3097
|
-
});
|
|
3098
|
-
|
|
3099
|
-
async function run() {
|
|
3100
|
-
const result = await unifiedTo.hris.updateHrisLocation({
|
|
3101
|
-
hrisLocation: {},
|
|
3102
|
-
connectionId: "<id>",
|
|
3103
|
-
id: "<id>",
|
|
3104
|
-
});
|
|
3105
|
-
|
|
3106
|
-
console.log(result);
|
|
3107
|
-
}
|
|
3108
|
-
|
|
3109
|
-
run();
|
|
3110
|
-
```
|
|
3111
|
-
|
|
3112
|
-
### Standalone function
|
|
3113
|
-
|
|
3114
|
-
The standalone function version of this method:
|
|
3115
|
-
|
|
3116
|
-
```typescript
|
|
3117
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3118
|
-
import { locationUpdateHrisLocation } from "@unified-api/typescript-sdk/funcs/locationUpdateHrisLocation.js";
|
|
3119
|
-
|
|
3120
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3121
|
-
// You can create one instance of it to use across an application.
|
|
3122
|
-
const unifiedTo = new UnifiedToCore({
|
|
3123
|
-
security: {
|
|
3124
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
3125
|
-
},
|
|
3126
|
-
});
|
|
3127
|
-
|
|
3128
|
-
async function run() {
|
|
3129
|
-
const res = await locationUpdateHrisLocation(unifiedTo, {
|
|
3130
|
-
hrisLocation: {},
|
|
3131
|
-
connectionId: "<id>",
|
|
3132
|
-
id: "<id>",
|
|
3133
|
-
});
|
|
3134
|
-
if (res.ok) {
|
|
3135
|
-
const { value: result } = res;
|
|
3136
|
-
console.log(result);
|
|
3137
|
-
} else {
|
|
3138
|
-
console.log("locationUpdateHrisLocation failed:", res.error);
|
|
3139
|
-
}
|
|
3140
|
-
}
|
|
3141
|
-
|
|
3142
|
-
run();
|
|
3143
|
-
```
|
|
3144
|
-
|
|
3145
|
-
### Parameters
|
|
3146
|
-
|
|
3147
|
-
| Parameter | Type | Required | Description |
|
|
3148
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3149
|
-
| `request` | [operations.UpdateHrisLocationRequest](../../sdk/models/operations/updatehrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3150
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3151
|
-
| `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. |
|
|
3152
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3153
|
-
|
|
3154
|
-
### Response
|
|
3155
|
-
|
|
3156
|
-
**Promise\<[shared.HrisLocation](../../sdk/models/shared/hrislocation.md)\>**
|
|
3157
|
-
|
|
3158
|
-
### Errors
|
|
3159
|
-
|
|
3160
|
-
| Error Type | Status Code | Content Type |
|
|
3161
|
-
| --------------- | --------------- | --------------- |
|
|
3162
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3163
|
-
|
|
3164
|
-
## updateHrisTimeshift
|
|
3165
|
-
|
|
3166
|
-
Update a timeshift
|
|
3167
|
-
|
|
3168
|
-
### Example Usage
|
|
3169
|
-
|
|
3170
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisTimeshift" method="put" path="/hris/{connection_id}/timeshift/{id}" -->
|
|
3171
|
-
```typescript
|
|
3172
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3173
|
-
|
|
3174
|
-
const unifiedTo = new UnifiedTo({
|
|
3175
|
-
security: {
|
|
3176
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
3177
|
-
},
|
|
3178
|
-
});
|
|
3179
|
-
|
|
3180
|
-
async function run() {
|
|
3181
|
-
const result = await unifiedTo.hris.updateHrisTimeshift({
|
|
3182
|
-
hrisTimeshift: {
|
|
3183
|
-
employeeUserId: "<id>",
|
|
3184
|
-
endAt: new Date("2025-03-03T22:04:09.340Z"),
|
|
3185
|
-
startAt: new Date("2024-05-30T21:19:58.772Z"),
|
|
3186
|
-
},
|
|
3187
|
-
connectionId: "<id>",
|
|
3188
|
-
id: "<id>",
|
|
3189
|
-
});
|
|
3190
|
-
|
|
3191
|
-
console.log(result);
|
|
3192
|
-
}
|
|
3193
|
-
|
|
3194
|
-
run();
|
|
3195
|
-
```
|
|
3196
|
-
|
|
3197
|
-
### Standalone function
|
|
3198
|
-
|
|
3199
|
-
The standalone function version of this method:
|
|
3200
|
-
|
|
3201
|
-
```typescript
|
|
3202
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3203
|
-
import { hrisUpdateHrisTimeshift } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisTimeshift.js";
|
|
3204
|
-
|
|
3205
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3206
|
-
// You can create one instance of it to use across an application.
|
|
3207
|
-
const unifiedTo = new UnifiedToCore({
|
|
3208
|
-
security: {
|
|
3209
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
3210
|
-
},
|
|
3211
|
-
});
|
|
3212
|
-
|
|
3213
|
-
async function run() {
|
|
3214
|
-
const res = await hrisUpdateHrisTimeshift(unifiedTo, {
|
|
3215
|
-
hrisTimeshift: {
|
|
3216
|
-
employeeUserId: "<id>",
|
|
3217
|
-
endAt: new Date("2025-03-03T22:04:09.340Z"),
|
|
3218
|
-
startAt: new Date("2024-05-30T21:19:58.772Z"),
|
|
3219
|
-
},
|
|
3220
|
-
connectionId: "<id>",
|
|
3221
|
-
id: "<id>",
|
|
3222
|
-
});
|
|
3223
|
-
if (res.ok) {
|
|
3224
|
-
const { value: result } = res;
|
|
3225
|
-
console.log(result);
|
|
3226
|
-
} else {
|
|
3227
|
-
console.log("hrisUpdateHrisTimeshift failed:", res.error);
|
|
3228
|
-
}
|
|
3229
|
-
}
|
|
3230
|
-
|
|
3231
|
-
run();
|
|
3232
|
-
```
|
|
3233
|
-
|
|
3234
|
-
### Parameters
|
|
3235
|
-
|
|
3236
|
-
| Parameter | Type | Required | Description |
|
|
3237
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3238
|
-
| `request` | [operations.UpdateHrisTimeshiftRequest](../../sdk/models/operations/updatehristimeshiftrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3239
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3240
|
-
| `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. |
|
|
3241
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3242
|
-
|
|
3243
|
-
### Response
|
|
3244
|
-
|
|
3245
|
-
**Promise\<[shared.HrisTimeshift](../../sdk/models/shared/hristimeshift.md)\>**
|
|
3246
|
-
|
|
3247
|
-
### Errors
|
|
3248
|
-
|
|
3249
|
-
| Error Type | Status Code | Content Type |
|
|
3250
|
-
| --------------- | --------------- | --------------- |
|
|
3251
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|