@unified-api/typescript-sdk 2.52.0 → 2.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/docs/sdks/device/README.md +519 -0
- package/docs/sdks/hris/README.md +512 -0
- package/funcs/deviceCreateHrisDevice.d.ts +14 -0
- package/funcs/deviceCreateHrisDevice.d.ts.map +1 -0
- package/funcs/deviceCreateHrisDevice.js +109 -0
- package/funcs/deviceCreateHrisDevice.js.map +1 -0
- package/funcs/deviceGetHrisDevice.d.ts +14 -0
- package/funcs/deviceGetHrisDevice.d.ts.map +1 -0
- package/funcs/deviceGetHrisDevice.js +112 -0
- package/funcs/deviceGetHrisDevice.js.map +1 -0
- package/funcs/deviceListHrisDevices.d.ts +14 -0
- package/funcs/deviceListHrisDevices.d.ts.map +1 -0
- package/funcs/deviceListHrisDevices.js +116 -0
- package/funcs/deviceListHrisDevices.js.map +1 -0
- package/funcs/devicePatchHrisDevice.d.ts +14 -0
- package/funcs/devicePatchHrisDevice.d.ts.map +1 -0
- package/funcs/devicePatchHrisDevice.js +113 -0
- package/funcs/devicePatchHrisDevice.js.map +1 -0
- package/funcs/deviceRemoveHrisDevice.d.ts +13 -0
- package/funcs/deviceRemoveHrisDevice.d.ts.map +1 -0
- package/funcs/deviceRemoveHrisDevice.js +110 -0
- package/funcs/deviceRemoveHrisDevice.js.map +1 -0
- package/funcs/deviceUpdateHrisDevice.d.ts +14 -0
- package/funcs/deviceUpdateHrisDevice.d.ts.map +1 -0
- package/funcs/deviceUpdateHrisDevice.js +113 -0
- package/funcs/deviceUpdateHrisDevice.js.map +1 -0
- package/funcs/fileListStorageFiles.js +1 -0
- package/funcs/fileListStorageFiles.js.map +1 -1
- package/funcs/hrisCreateHrisDevice.d.ts +14 -0
- package/funcs/hrisCreateHrisDevice.d.ts.map +1 -0
- package/funcs/hrisCreateHrisDevice.js +109 -0
- package/funcs/hrisCreateHrisDevice.js.map +1 -0
- package/funcs/hrisGetHrisDevice.d.ts +14 -0
- package/funcs/hrisGetHrisDevice.d.ts.map +1 -0
- package/funcs/hrisGetHrisDevice.js +112 -0
- package/funcs/hrisGetHrisDevice.js.map +1 -0
- package/funcs/hrisListHrisDevices.d.ts +14 -0
- package/funcs/hrisListHrisDevices.d.ts.map +1 -0
- package/funcs/hrisListHrisDevices.js +116 -0
- package/funcs/hrisListHrisDevices.js.map +1 -0
- package/funcs/hrisPatchHrisDevice.d.ts +14 -0
- package/funcs/hrisPatchHrisDevice.d.ts.map +1 -0
- package/funcs/hrisPatchHrisDevice.js +113 -0
- package/funcs/hrisPatchHrisDevice.js.map +1 -0
- package/funcs/hrisRemoveHrisDevice.d.ts +13 -0
- package/funcs/hrisRemoveHrisDevice.d.ts.map +1 -0
- package/funcs/hrisRemoveHrisDevice.js +110 -0
- package/funcs/hrisRemoveHrisDevice.js.map +1 -0
- package/funcs/hrisUpdateHrisDevice.d.ts +14 -0
- package/funcs/hrisUpdateHrisDevice.d.ts.map +1 -0
- package/funcs/hrisUpdateHrisDevice.js +113 -0
- package/funcs/hrisUpdateHrisDevice.js.map +1 -0
- package/funcs/storageListStorageFiles.js +1 -0
- package/funcs/storageListStorageFiles.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/package.json +1 -1
- package/sdk/device.d.ts +30 -0
- package/sdk/device.d.ts.map +1 -0
- package/sdk/device.js +54 -0
- package/sdk/device.js.map +1 -0
- package/sdk/hris.d.ts +24 -0
- package/sdk/hris.d.ts.map +1 -1
- package/sdk/hris.js +42 -0
- package/sdk/hris.js.map +1 -1
- package/sdk/models/operations/createhrisdevice.d.ts +40 -0
- package/sdk/models/operations/createhrisdevice.d.ts.map +1 -0
- package/sdk/models/operations/createhrisdevice.js +75 -0
- package/sdk/models/operations/createhrisdevice.js.map +1 -0
- package/sdk/models/operations/gethrisdevice.d.ts +42 -0
- package/sdk/models/operations/gethrisdevice.d.ts.map +1 -0
- package/sdk/models/operations/gethrisdevice.js +72 -0
- package/sdk/models/operations/gethrisdevice.js.map +1 -0
- package/sdk/models/operations/index.d.ts +6 -0
- package/sdk/models/operations/index.d.ts.map +1 -1
- package/sdk/models/operations/index.js +6 -0
- package/sdk/models/operations/index.js.map +1 -1
- package/sdk/models/operations/listhrisdevices.d.ts +57 -0
- package/sdk/models/operations/listhrisdevices.d.ts.map +1 -0
- package/sdk/models/operations/listhrisdevices.js +89 -0
- package/sdk/models/operations/listhrisdevices.js.map +1 -0
- package/sdk/models/operations/liststoragefiles.d.ts +2 -0
- package/sdk/models/operations/liststoragefiles.d.ts.map +1 -1
- package/sdk/models/operations/liststoragefiles.js +2 -0
- package/sdk/models/operations/liststoragefiles.js.map +1 -1
- package/sdk/models/operations/patchhrisdevice.d.ts +45 -0
- package/sdk/models/operations/patchhrisdevice.d.ts.map +1 -0
- package/sdk/models/operations/patchhrisdevice.js +77 -0
- package/sdk/models/operations/patchhrisdevice.js.map +1 -0
- package/sdk/models/operations/removehrisdevice.d.ts +66 -0
- package/sdk/models/operations/removehrisdevice.d.ts.map +1 -0
- package/sdk/models/operations/removehrisdevice.js +105 -0
- package/sdk/models/operations/removehrisdevice.js.map +1 -0
- package/sdk/models/operations/updatehrisdevice.d.ts +45 -0
- package/sdk/models/operations/updatehrisdevice.d.ts.map +1 -0
- package/sdk/models/operations/updatehrisdevice.js +77 -0
- package/sdk/models/operations/updatehrisdevice.js.map +1 -0
- package/sdk/models/shared/accountingassociatedcontact.d.ts +34 -0
- package/sdk/models/shared/accountingassociatedcontact.d.ts.map +1 -0
- package/sdk/models/shared/accountingassociatedcontact.js +64 -0
- package/sdk/models/shared/accountingassociatedcontact.js.map +1 -0
- package/sdk/models/shared/accountingcontact.d.ts +3 -0
- package/sdk/models/shared/accountingcontact.d.ts.map +1 -1
- package/sdk/models/shared/accountingcontact.js +7 -0
- package/sdk/models/shared/accountingcontact.js.map +1 -1
- package/sdk/models/shared/accountinginvoice.d.ts +2 -0
- package/sdk/models/shared/accountinginvoice.d.ts.map +1 -1
- package/sdk/models/shared/accountinginvoice.js +2 -0
- package/sdk/models/shared/accountinginvoice.js.map +1 -1
- package/sdk/models/shared/atsjob.d.ts +3 -0
- package/sdk/models/shared/atsjob.d.ts.map +1 -1
- package/sdk/models/shared/atsjob.js +3 -0
- package/sdk/models/shared/atsjob.js.map +1 -1
- package/sdk/models/shared/atsjobopening.d.ts +63 -0
- package/sdk/models/shared/atsjobopening.d.ts.map +1 -0
- package/sdk/models/shared/atsjobopening.js +103 -0
- package/sdk/models/shared/atsjobopening.js.map +1 -0
- package/sdk/models/shared/hrisdevice.d.ts +74 -0
- package/sdk/models/shared/hrisdevice.d.ts.map +1 -0
- package/sdk/models/shared/hrisdevice.js +132 -0
- package/sdk/models/shared/hrisdevice.js.map +1 -0
- package/sdk/models/shared/index.d.ts +3 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +3 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.d.ts +6 -0
- package/sdk/models/shared/propertyconnectionpermissions.d.ts.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.js +2 -0
- package/sdk/models/shared/propertyconnectionpermissions.js.map +1 -1
- package/sdk/models/shared/webhook.d.ts +3 -0
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +1 -0
- package/sdk/models/shared/webhook.js.map +1 -1
- package/sdk/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/deviceCreateHrisDevice.ts +163 -0
- package/src/funcs/deviceGetHrisDevice.ts +166 -0
- package/src/funcs/deviceListHrisDevices.ts +170 -0
- package/src/funcs/devicePatchHrisDevice.ts +167 -0
- package/src/funcs/deviceRemoveHrisDevice.ts +169 -0
- package/src/funcs/deviceUpdateHrisDevice.ts +167 -0
- package/src/funcs/fileListStorageFiles.ts +1 -0
- package/src/funcs/hrisCreateHrisDevice.ts +163 -0
- package/src/funcs/hrisGetHrisDevice.ts +166 -0
- package/src/funcs/hrisListHrisDevices.ts +170 -0
- package/src/funcs/hrisPatchHrisDevice.ts +167 -0
- package/src/funcs/hrisRemoveHrisDevice.ts +169 -0
- package/src/funcs/hrisUpdateHrisDevice.ts +167 -0
- package/src/funcs/storageListStorageFiles.ts +1 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/device.ts +100 -0
- package/src/sdk/hris.ts +90 -0
- package/src/sdk/models/operations/createhrisdevice.ts +92 -0
- package/src/sdk/models/operations/gethrisdevice.ts +92 -0
- package/src/sdk/models/operations/index.ts +6 -0
- package/src/sdk/models/operations/listhrisdevices.ts +124 -0
- package/src/sdk/models/operations/liststoragefiles.ts +4 -0
- package/src/sdk/models/operations/patchhrisdevice.ts +99 -0
- package/src/sdk/models/operations/removehrisdevice.ts +151 -0
- package/src/sdk/models/operations/updatehrisdevice.ts +99 -0
- package/src/sdk/models/shared/accountingassociatedcontact.ts +82 -0
- package/src/sdk/models/shared/accountingcontact.ts +14 -0
- package/src/sdk/models/shared/accountinginvoice.ts +4 -0
- package/src/sdk/models/shared/atsjob.ts +10 -0
- package/src/sdk/models/shared/atsjobopening.ts +123 -0
- package/src/sdk/models/shared/hrisdevice.ts +176 -0
- package/src/sdk/models/shared/index.ts +3 -0
- package/src/sdk/models/shared/propertyconnectionpermissions.ts +2 -0
- package/src/sdk/models/shared/webhook.ts +1 -0
- package/src/sdk/sdk.ts +6 -0
package/docs/sdks/hris/README.md
CHANGED
|
@@ -6,30 +6,36 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [createHrisCompany](#createhriscompany) - Create a company
|
|
9
|
+
* [createHrisDevice](#createhrisdevice) - Create a device
|
|
9
10
|
* [createHrisEmployee](#createhrisemployee) - Create an employee
|
|
10
11
|
* [createHrisGroup](#createhrisgroup) - Create a group
|
|
11
12
|
* [createHrisLocation](#createhrislocation) - Create a location
|
|
12
13
|
* [getHrisCompany](#gethriscompany) - Retrieve a company
|
|
14
|
+
* [getHrisDevice](#gethrisdevice) - Retrieve a device
|
|
13
15
|
* [getHrisEmployee](#gethrisemployee) - Retrieve an employee
|
|
14
16
|
* [getHrisGroup](#gethrisgroup) - Retrieve a group
|
|
15
17
|
* [getHrisLocation](#gethrislocation) - Retrieve a location
|
|
16
18
|
* [getHrisPayslip](#gethrispayslip) - Retrieve a payslip
|
|
17
19
|
* [getHrisTimeoff](#gethristimeoff) - Retrieve a timeoff
|
|
18
20
|
* [listHrisCompanies](#listhriscompanies) - List all companies
|
|
21
|
+
* [listHrisDevices](#listhrisdevices) - List all devices
|
|
19
22
|
* [listHrisEmployees](#listhrisemployees) - List all employees
|
|
20
23
|
* [listHrisGroups](#listhrisgroups) - List all groups
|
|
21
24
|
* [listHrisLocations](#listhrislocations) - List all locations
|
|
22
25
|
* [listHrisPayslips](#listhrispayslips) - List all payslips
|
|
23
26
|
* [listHrisTimeoffs](#listhristimeoffs) - List all timeoffs
|
|
24
27
|
* [patchHrisCompany](#patchhriscompany) - Update a company
|
|
28
|
+
* [patchHrisDevice](#patchhrisdevice) - Update a device
|
|
25
29
|
* [patchHrisEmployee](#patchhrisemployee) - Update an employee
|
|
26
30
|
* [patchHrisGroup](#patchhrisgroup) - Update a group
|
|
27
31
|
* [patchHrisLocation](#patchhrislocation) - Update a location
|
|
28
32
|
* [removeHrisCompany](#removehriscompany) - Remove a company
|
|
33
|
+
* [removeHrisDevice](#removehrisdevice) - Remove a device
|
|
29
34
|
* [removeHrisEmployee](#removehrisemployee) - Remove an employee
|
|
30
35
|
* [removeHrisGroup](#removehrisgroup) - Remove a group
|
|
31
36
|
* [removeHrisLocation](#removehrislocation) - Remove a location
|
|
32
37
|
* [updateHrisCompany](#updatehriscompany) - Update a company
|
|
38
|
+
* [updateHrisDevice](#updatehrisdevice) - Update a device
|
|
33
39
|
* [updateHrisEmployee](#updatehrisemployee) - Update an employee
|
|
34
40
|
* [updateHrisGroup](#updatehrisgroup) - Update a group
|
|
35
41
|
* [updateHrisLocation](#updatehrislocation) - Update a location
|
|
@@ -116,6 +122,92 @@ run();
|
|
|
116
122
|
| --------------- | --------------- | --------------- |
|
|
117
123
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
118
124
|
|
|
125
|
+
## createHrisDevice
|
|
126
|
+
|
|
127
|
+
Create a device
|
|
128
|
+
|
|
129
|
+
### Example Usage
|
|
130
|
+
|
|
131
|
+
```typescript
|
|
132
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
133
|
+
|
|
134
|
+
const unifiedTo = new UnifiedTo({
|
|
135
|
+
security: {
|
|
136
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
137
|
+
},
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
async function run() {
|
|
141
|
+
const result = await unifiedTo.hris.createHrisDevice({
|
|
142
|
+
hrisDevice: {
|
|
143
|
+
name: "<value>",
|
|
144
|
+
},
|
|
145
|
+
connectionId: "<id>",
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
// Handle the result
|
|
149
|
+
console.log(result);
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
run();
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Standalone function
|
|
156
|
+
|
|
157
|
+
The standalone function version of this method:
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
161
|
+
import { hrisCreateHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisDevice.js";
|
|
162
|
+
|
|
163
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
164
|
+
// You can create one instance of it to use across an application.
|
|
165
|
+
const unifiedTo = new UnifiedToCore({
|
|
166
|
+
security: {
|
|
167
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
168
|
+
},
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
async function run() {
|
|
172
|
+
const res = await hrisCreateHrisDevice(unifiedTo, {
|
|
173
|
+
hrisDevice: {
|
|
174
|
+
name: "<value>",
|
|
175
|
+
},
|
|
176
|
+
connectionId: "<id>",
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
if (!res.ok) {
|
|
180
|
+
throw res.error;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
const { value: result } = res;
|
|
184
|
+
|
|
185
|
+
// Handle the result
|
|
186
|
+
console.log(result);
|
|
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
|
+
|
|
119
211
|
## createHrisEmployee
|
|
120
212
|
|
|
121
213
|
Create an employee
|
|
@@ -444,6 +536,88 @@ run();
|
|
|
444
536
|
| --------------- | --------------- | --------------- |
|
|
445
537
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
446
538
|
|
|
539
|
+
## getHrisDevice
|
|
540
|
+
|
|
541
|
+
Retrieve a device
|
|
542
|
+
|
|
543
|
+
### Example Usage
|
|
544
|
+
|
|
545
|
+
```typescript
|
|
546
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
547
|
+
|
|
548
|
+
const unifiedTo = new UnifiedTo({
|
|
549
|
+
security: {
|
|
550
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
551
|
+
},
|
|
552
|
+
});
|
|
553
|
+
|
|
554
|
+
async function run() {
|
|
555
|
+
const result = await unifiedTo.hris.getHrisDevice({
|
|
556
|
+
connectionId: "<id>",
|
|
557
|
+
id: "<id>",
|
|
558
|
+
});
|
|
559
|
+
|
|
560
|
+
// Handle the result
|
|
561
|
+
console.log(result);
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
run();
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
### Standalone function
|
|
568
|
+
|
|
569
|
+
The standalone function version of this method:
|
|
570
|
+
|
|
571
|
+
```typescript
|
|
572
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
573
|
+
import { hrisGetHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisGetHrisDevice.js";
|
|
574
|
+
|
|
575
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
576
|
+
// You can create one instance of it to use across an application.
|
|
577
|
+
const unifiedTo = new UnifiedToCore({
|
|
578
|
+
security: {
|
|
579
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
580
|
+
},
|
|
581
|
+
});
|
|
582
|
+
|
|
583
|
+
async function run() {
|
|
584
|
+
const res = await hrisGetHrisDevice(unifiedTo, {
|
|
585
|
+
connectionId: "<id>",
|
|
586
|
+
id: "<id>",
|
|
587
|
+
});
|
|
588
|
+
|
|
589
|
+
if (!res.ok) {
|
|
590
|
+
throw res.error;
|
|
591
|
+
}
|
|
592
|
+
|
|
593
|
+
const { value: result } = res;
|
|
594
|
+
|
|
595
|
+
// Handle the result
|
|
596
|
+
console.log(result);
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
run();
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
### Parameters
|
|
603
|
+
|
|
604
|
+
| Parameter | Type | Required | Description |
|
|
605
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
606
|
+
| `request` | [operations.GetHrisDeviceRequest](../../sdk/models/operations/gethrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
607
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
608
|
+
| `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. |
|
|
609
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
610
|
+
|
|
611
|
+
### Response
|
|
612
|
+
|
|
613
|
+
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
614
|
+
|
|
615
|
+
### Errors
|
|
616
|
+
|
|
617
|
+
| Error Type | Status Code | Content Type |
|
|
618
|
+
| --------------- | --------------- | --------------- |
|
|
619
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
620
|
+
|
|
447
621
|
## getHrisEmployee
|
|
448
622
|
|
|
449
623
|
Retrieve an employee
|
|
@@ -934,6 +1108,86 @@ run();
|
|
|
934
1108
|
| --------------- | --------------- | --------------- |
|
|
935
1109
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
936
1110
|
|
|
1111
|
+
## listHrisDevices
|
|
1112
|
+
|
|
1113
|
+
List all devices
|
|
1114
|
+
|
|
1115
|
+
### Example Usage
|
|
1116
|
+
|
|
1117
|
+
```typescript
|
|
1118
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1119
|
+
|
|
1120
|
+
const unifiedTo = new UnifiedTo({
|
|
1121
|
+
security: {
|
|
1122
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1123
|
+
},
|
|
1124
|
+
});
|
|
1125
|
+
|
|
1126
|
+
async function run() {
|
|
1127
|
+
const result = await unifiedTo.hris.listHrisDevices({
|
|
1128
|
+
connectionId: "<id>",
|
|
1129
|
+
});
|
|
1130
|
+
|
|
1131
|
+
// Handle the result
|
|
1132
|
+
console.log(result);
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
run();
|
|
1136
|
+
```
|
|
1137
|
+
|
|
1138
|
+
### Standalone function
|
|
1139
|
+
|
|
1140
|
+
The standalone function version of this method:
|
|
1141
|
+
|
|
1142
|
+
```typescript
|
|
1143
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1144
|
+
import { hrisListHrisDevices } from "@unified-api/typescript-sdk/funcs/hrisListHrisDevices.js";
|
|
1145
|
+
|
|
1146
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1147
|
+
// You can create one instance of it to use across an application.
|
|
1148
|
+
const unifiedTo = new UnifiedToCore({
|
|
1149
|
+
security: {
|
|
1150
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1151
|
+
},
|
|
1152
|
+
});
|
|
1153
|
+
|
|
1154
|
+
async function run() {
|
|
1155
|
+
const res = await hrisListHrisDevices(unifiedTo, {
|
|
1156
|
+
connectionId: "<id>",
|
|
1157
|
+
});
|
|
1158
|
+
|
|
1159
|
+
if (!res.ok) {
|
|
1160
|
+
throw res.error;
|
|
1161
|
+
}
|
|
1162
|
+
|
|
1163
|
+
const { value: result } = res;
|
|
1164
|
+
|
|
1165
|
+
// Handle the result
|
|
1166
|
+
console.log(result);
|
|
1167
|
+
}
|
|
1168
|
+
|
|
1169
|
+
run();
|
|
1170
|
+
```
|
|
1171
|
+
|
|
1172
|
+
### Parameters
|
|
1173
|
+
|
|
1174
|
+
| Parameter | Type | Required | Description |
|
|
1175
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1176
|
+
| `request` | [operations.ListHrisDevicesRequest](../../sdk/models/operations/listhrisdevicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1177
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1178
|
+
| `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. |
|
|
1179
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1180
|
+
|
|
1181
|
+
### Response
|
|
1182
|
+
|
|
1183
|
+
**Promise\<[shared.HrisDevice[]](../../models/.md)\>**
|
|
1184
|
+
|
|
1185
|
+
### Errors
|
|
1186
|
+
|
|
1187
|
+
| Error Type | Status Code | Content Type |
|
|
1188
|
+
| --------------- | --------------- | --------------- |
|
|
1189
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1190
|
+
|
|
937
1191
|
## listHrisEmployees
|
|
938
1192
|
|
|
939
1193
|
List all employees
|
|
@@ -1418,6 +1672,94 @@ run();
|
|
|
1418
1672
|
| --------------- | --------------- | --------------- |
|
|
1419
1673
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1420
1674
|
|
|
1675
|
+
## patchHrisDevice
|
|
1676
|
+
|
|
1677
|
+
Update a device
|
|
1678
|
+
|
|
1679
|
+
### Example Usage
|
|
1680
|
+
|
|
1681
|
+
```typescript
|
|
1682
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1683
|
+
|
|
1684
|
+
const unifiedTo = new UnifiedTo({
|
|
1685
|
+
security: {
|
|
1686
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1687
|
+
},
|
|
1688
|
+
});
|
|
1689
|
+
|
|
1690
|
+
async function run() {
|
|
1691
|
+
const result = await unifiedTo.hris.patchHrisDevice({
|
|
1692
|
+
hrisDevice: {
|
|
1693
|
+
name: "<value>",
|
|
1694
|
+
},
|
|
1695
|
+
connectionId: "<id>",
|
|
1696
|
+
id: "<id>",
|
|
1697
|
+
});
|
|
1698
|
+
|
|
1699
|
+
// Handle the result
|
|
1700
|
+
console.log(result);
|
|
1701
|
+
}
|
|
1702
|
+
|
|
1703
|
+
run();
|
|
1704
|
+
```
|
|
1705
|
+
|
|
1706
|
+
### Standalone function
|
|
1707
|
+
|
|
1708
|
+
The standalone function version of this method:
|
|
1709
|
+
|
|
1710
|
+
```typescript
|
|
1711
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1712
|
+
import { hrisPatchHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisDevice.js";
|
|
1713
|
+
|
|
1714
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1715
|
+
// You can create one instance of it to use across an application.
|
|
1716
|
+
const unifiedTo = new UnifiedToCore({
|
|
1717
|
+
security: {
|
|
1718
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1719
|
+
},
|
|
1720
|
+
});
|
|
1721
|
+
|
|
1722
|
+
async function run() {
|
|
1723
|
+
const res = await hrisPatchHrisDevice(unifiedTo, {
|
|
1724
|
+
hrisDevice: {
|
|
1725
|
+
name: "<value>",
|
|
1726
|
+
},
|
|
1727
|
+
connectionId: "<id>",
|
|
1728
|
+
id: "<id>",
|
|
1729
|
+
});
|
|
1730
|
+
|
|
1731
|
+
if (!res.ok) {
|
|
1732
|
+
throw res.error;
|
|
1733
|
+
}
|
|
1734
|
+
|
|
1735
|
+
const { value: result } = res;
|
|
1736
|
+
|
|
1737
|
+
// Handle the result
|
|
1738
|
+
console.log(result);
|
|
1739
|
+
}
|
|
1740
|
+
|
|
1741
|
+
run();
|
|
1742
|
+
```
|
|
1743
|
+
|
|
1744
|
+
### Parameters
|
|
1745
|
+
|
|
1746
|
+
| Parameter | Type | Required | Description |
|
|
1747
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1748
|
+
| `request` | [operations.PatchHrisDeviceRequest](../../sdk/models/operations/patchhrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1749
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1750
|
+
| `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. |
|
|
1751
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1752
|
+
|
|
1753
|
+
### Response
|
|
1754
|
+
|
|
1755
|
+
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
1756
|
+
|
|
1757
|
+
### Errors
|
|
1758
|
+
|
|
1759
|
+
| Error Type | Status Code | Content Type |
|
|
1760
|
+
| --------------- | --------------- | --------------- |
|
|
1761
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1762
|
+
|
|
1421
1763
|
## patchHrisEmployee
|
|
1422
1764
|
|
|
1423
1765
|
Update an employee
|
|
@@ -1752,6 +2094,88 @@ run();
|
|
|
1752
2094
|
| --------------- | --------------- | --------------- |
|
|
1753
2095
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1754
2096
|
|
|
2097
|
+
## removeHrisDevice
|
|
2098
|
+
|
|
2099
|
+
Remove a device
|
|
2100
|
+
|
|
2101
|
+
### Example Usage
|
|
2102
|
+
|
|
2103
|
+
```typescript
|
|
2104
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2105
|
+
|
|
2106
|
+
const unifiedTo = new UnifiedTo({
|
|
2107
|
+
security: {
|
|
2108
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2109
|
+
},
|
|
2110
|
+
});
|
|
2111
|
+
|
|
2112
|
+
async function run() {
|
|
2113
|
+
const result = await unifiedTo.hris.removeHrisDevice({
|
|
2114
|
+
connectionId: "<id>",
|
|
2115
|
+
id: "<id>",
|
|
2116
|
+
});
|
|
2117
|
+
|
|
2118
|
+
// Handle the result
|
|
2119
|
+
console.log(result);
|
|
2120
|
+
}
|
|
2121
|
+
|
|
2122
|
+
run();
|
|
2123
|
+
```
|
|
2124
|
+
|
|
2125
|
+
### Standalone function
|
|
2126
|
+
|
|
2127
|
+
The standalone function version of this method:
|
|
2128
|
+
|
|
2129
|
+
```typescript
|
|
2130
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2131
|
+
import { hrisRemoveHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisDevice.js";
|
|
2132
|
+
|
|
2133
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2134
|
+
// You can create one instance of it to use across an application.
|
|
2135
|
+
const unifiedTo = new UnifiedToCore({
|
|
2136
|
+
security: {
|
|
2137
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2138
|
+
},
|
|
2139
|
+
});
|
|
2140
|
+
|
|
2141
|
+
async function run() {
|
|
2142
|
+
const res = await hrisRemoveHrisDevice(unifiedTo, {
|
|
2143
|
+
connectionId: "<id>",
|
|
2144
|
+
id: "<id>",
|
|
2145
|
+
});
|
|
2146
|
+
|
|
2147
|
+
if (!res.ok) {
|
|
2148
|
+
throw res.error;
|
|
2149
|
+
}
|
|
2150
|
+
|
|
2151
|
+
const { value: result } = res;
|
|
2152
|
+
|
|
2153
|
+
// Handle the result
|
|
2154
|
+
console.log(result);
|
|
2155
|
+
}
|
|
2156
|
+
|
|
2157
|
+
run();
|
|
2158
|
+
```
|
|
2159
|
+
|
|
2160
|
+
### Parameters
|
|
2161
|
+
|
|
2162
|
+
| Parameter | Type | Required | Description |
|
|
2163
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2164
|
+
| `request` | [operations.RemoveHrisDeviceRequest](../../sdk/models/operations/removehrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2165
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2166
|
+
| `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. |
|
|
2167
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2168
|
+
|
|
2169
|
+
### Response
|
|
2170
|
+
|
|
2171
|
+
**Promise\<[operations.RemoveHrisDeviceResponse](../../sdk/models/operations/removehrisdeviceresponse.md)\>**
|
|
2172
|
+
|
|
2173
|
+
### Errors
|
|
2174
|
+
|
|
2175
|
+
| Error Type | Status Code | Content Type |
|
|
2176
|
+
| --------------- | --------------- | --------------- |
|
|
2177
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2178
|
+
|
|
1755
2179
|
## removeHrisEmployee
|
|
1756
2180
|
|
|
1757
2181
|
Remove an employee
|
|
@@ -2082,6 +2506,94 @@ run();
|
|
|
2082
2506
|
| --------------- | --------------- | --------------- |
|
|
2083
2507
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2084
2508
|
|
|
2509
|
+
## updateHrisDevice
|
|
2510
|
+
|
|
2511
|
+
Update a device
|
|
2512
|
+
|
|
2513
|
+
### Example Usage
|
|
2514
|
+
|
|
2515
|
+
```typescript
|
|
2516
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2517
|
+
|
|
2518
|
+
const unifiedTo = new UnifiedTo({
|
|
2519
|
+
security: {
|
|
2520
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2521
|
+
},
|
|
2522
|
+
});
|
|
2523
|
+
|
|
2524
|
+
async function run() {
|
|
2525
|
+
const result = await unifiedTo.hris.updateHrisDevice({
|
|
2526
|
+
hrisDevice: {
|
|
2527
|
+
name: "<value>",
|
|
2528
|
+
},
|
|
2529
|
+
connectionId: "<id>",
|
|
2530
|
+
id: "<id>",
|
|
2531
|
+
});
|
|
2532
|
+
|
|
2533
|
+
// Handle the result
|
|
2534
|
+
console.log(result);
|
|
2535
|
+
}
|
|
2536
|
+
|
|
2537
|
+
run();
|
|
2538
|
+
```
|
|
2539
|
+
|
|
2540
|
+
### Standalone function
|
|
2541
|
+
|
|
2542
|
+
The standalone function version of this method:
|
|
2543
|
+
|
|
2544
|
+
```typescript
|
|
2545
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2546
|
+
import { hrisUpdateHrisDevice } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisDevice.js";
|
|
2547
|
+
|
|
2548
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2549
|
+
// You can create one instance of it to use across an application.
|
|
2550
|
+
const unifiedTo = new UnifiedToCore({
|
|
2551
|
+
security: {
|
|
2552
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2553
|
+
},
|
|
2554
|
+
});
|
|
2555
|
+
|
|
2556
|
+
async function run() {
|
|
2557
|
+
const res = await hrisUpdateHrisDevice(unifiedTo, {
|
|
2558
|
+
hrisDevice: {
|
|
2559
|
+
name: "<value>",
|
|
2560
|
+
},
|
|
2561
|
+
connectionId: "<id>",
|
|
2562
|
+
id: "<id>",
|
|
2563
|
+
});
|
|
2564
|
+
|
|
2565
|
+
if (!res.ok) {
|
|
2566
|
+
throw res.error;
|
|
2567
|
+
}
|
|
2568
|
+
|
|
2569
|
+
const { value: result } = res;
|
|
2570
|
+
|
|
2571
|
+
// Handle the result
|
|
2572
|
+
console.log(result);
|
|
2573
|
+
}
|
|
2574
|
+
|
|
2575
|
+
run();
|
|
2576
|
+
```
|
|
2577
|
+
|
|
2578
|
+
### Parameters
|
|
2579
|
+
|
|
2580
|
+
| Parameter | Type | Required | Description |
|
|
2581
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2582
|
+
| `request` | [operations.UpdateHrisDeviceRequest](../../sdk/models/operations/updatehrisdevicerequest.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\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
2590
|
+
|
|
2591
|
+
### Errors
|
|
2592
|
+
|
|
2593
|
+
| Error Type | Status Code | Content Type |
|
|
2594
|
+
| --------------- | --------------- | --------------- |
|
|
2595
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2596
|
+
|
|
2085
2597
|
## updateHrisEmployee
|
|
2086
2598
|
|
|
2087
2599
|
Update an employee
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { UnifiedToCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/errors/httpclienterrors.js";
|
|
4
|
+
import { SDKError } from "../sdk/models/errors/sdkerror.js";
|
|
5
|
+
import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
|
|
6
|
+
import * as operations from "../sdk/models/operations/index.js";
|
|
7
|
+
import * as shared from "../sdk/models/shared/index.js";
|
|
8
|
+
import { APIPromise } from "../sdk/types/async.js";
|
|
9
|
+
import { Result } from "../sdk/types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* Create a device
|
|
12
|
+
*/
|
|
13
|
+
export declare function deviceCreateHrisDevice(client: UnifiedToCore, request: operations.CreateHrisDeviceRequest, options?: RequestOptions): APIPromise<Result<shared.HrisDevice, SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
14
|
+
//# sourceMappingURL=deviceCreateHrisDevice.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deviceCreateHrisDevice.d.ts","sourceRoot":"","sources":["../src/funcs/deviceCreateHrisDevice.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,UAAU,MAAM,mCAAmC,CAAC;AAChE,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,UAAU,EACf,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}
|