@unified-api/typescript-sdk 2.50.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/atsListAtsCandidates.js +0 -1
- package/funcs/atsListAtsCandidates.js.map +1 -1
- package/funcs/candidateListAtsCandidates.js +0 -1
- package/funcs/candidateListAtsCandidates.js.map +1 -1
- 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/listatscandidates.d.ts +0 -2
- package/sdk/models/operations/listatscandidates.d.ts.map +1 -1
- package/sdk/models/operations/listatscandidates.js +0 -4
- package/sdk/models/operations/listatscandidates.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/atsListAtsCandidates.ts +0 -1
- package/src/funcs/candidateListAtsCandidates.ts +0 -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/listatscandidates.ts +0 -6
- 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/README.md
CHANGED
|
@@ -750,6 +750,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
750
750
|
- [`dealPatchCrmDeal`](docs/sdks/deal/README.md#patchcrmdeal) - Update a deal
|
|
751
751
|
- [`dealRemoveCrmDeal`](docs/sdks/deal/README.md#removecrmdeal) - Remove a deal
|
|
752
752
|
- [`dealUpdateCrmDeal`](docs/sdks/deal/README.md#updatecrmdeal) - Update a deal
|
|
753
|
+
- [`deviceCreateHrisDevice`](docs/sdks/device/README.md#createhrisdevice) - Create a device
|
|
754
|
+
- [`deviceGetHrisDevice`](docs/sdks/device/README.md#gethrisdevice) - Retrieve a device
|
|
755
|
+
- [`deviceListHrisDevices`](docs/sdks/device/README.md#listhrisdevices) - List all devices
|
|
756
|
+
- [`devicePatchHrisDevice`](docs/sdks/device/README.md#patchhrisdevice) - Update a device
|
|
757
|
+
- [`deviceRemoveHrisDevice`](docs/sdks/device/README.md#removehrisdevice) - Remove a device
|
|
758
|
+
- [`deviceUpdateHrisDevice`](docs/sdks/device/README.md#updatehrisdevice) - Update a device
|
|
753
759
|
- [`documentCreateAtsDocument`](docs/sdks/document/README.md#createatsdocument) - Create a document
|
|
754
760
|
- [`documentGetAtsDocument`](docs/sdks/document/README.md#getatsdocument) - Retrieve a document
|
|
755
761
|
- [`documentListAtsDocuments`](docs/sdks/document/README.md#listatsdocuments) - List all documents
|
|
@@ -797,30 +803,36 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
797
803
|
- [`groupUpdateHrisGroup`](docs/sdks/group/README.md#updatehrisgroup) - Update a group
|
|
798
804
|
- [`groupUpdateScimGroups`](docs/sdks/group/README.md#updatescimgroups) - Update group
|
|
799
805
|
- [`hrisCreateHrisCompany`](docs/sdks/hris/README.md#createhriscompany) - Create a company
|
|
806
|
+
- [`hrisCreateHrisDevice`](docs/sdks/hris/README.md#createhrisdevice) - Create a device
|
|
800
807
|
- [`hrisCreateHrisEmployee`](docs/sdks/hris/README.md#createhrisemployee) - Create an employee
|
|
801
808
|
- [`hrisCreateHrisGroup`](docs/sdks/hris/README.md#createhrisgroup) - Create a group
|
|
802
809
|
- [`hrisCreateHrisLocation`](docs/sdks/hris/README.md#createhrislocation) - Create a location
|
|
803
810
|
- [`hrisGetHrisCompany`](docs/sdks/hris/README.md#gethriscompany) - Retrieve a company
|
|
811
|
+
- [`hrisGetHrisDevice`](docs/sdks/hris/README.md#gethrisdevice) - Retrieve a device
|
|
804
812
|
- [`hrisGetHrisEmployee`](docs/sdks/hris/README.md#gethrisemployee) - Retrieve an employee
|
|
805
813
|
- [`hrisGetHrisGroup`](docs/sdks/hris/README.md#gethrisgroup) - Retrieve a group
|
|
806
814
|
- [`hrisGetHrisLocation`](docs/sdks/hris/README.md#gethrislocation) - Retrieve a location
|
|
807
815
|
- [`hrisGetHrisPayslip`](docs/sdks/hris/README.md#gethrispayslip) - Retrieve a payslip
|
|
808
816
|
- [`hrisGetHrisTimeoff`](docs/sdks/hris/README.md#gethristimeoff) - Retrieve a timeoff
|
|
809
817
|
- [`hrisListHrisCompanies`](docs/sdks/hris/README.md#listhriscompanies) - List all companies
|
|
818
|
+
- [`hrisListHrisDevices`](docs/sdks/hris/README.md#listhrisdevices) - List all devices
|
|
810
819
|
- [`hrisListHrisEmployees`](docs/sdks/hris/README.md#listhrisemployees) - List all employees
|
|
811
820
|
- [`hrisListHrisGroups`](docs/sdks/hris/README.md#listhrisgroups) - List all groups
|
|
812
821
|
- [`hrisListHrisLocations`](docs/sdks/hris/README.md#listhrislocations) - List all locations
|
|
813
822
|
- [`hrisListHrisPayslips`](docs/sdks/hris/README.md#listhrispayslips) - List all payslips
|
|
814
823
|
- [`hrisListHrisTimeoffs`](docs/sdks/hris/README.md#listhristimeoffs) - List all timeoffs
|
|
815
824
|
- [`hrisPatchHrisCompany`](docs/sdks/hris/README.md#patchhriscompany) - Update a company
|
|
825
|
+
- [`hrisPatchHrisDevice`](docs/sdks/hris/README.md#patchhrisdevice) - Update a device
|
|
816
826
|
- [`hrisPatchHrisEmployee`](docs/sdks/hris/README.md#patchhrisemployee) - Update an employee
|
|
817
827
|
- [`hrisPatchHrisGroup`](docs/sdks/hris/README.md#patchhrisgroup) - Update a group
|
|
818
828
|
- [`hrisPatchHrisLocation`](docs/sdks/hris/README.md#patchhrislocation) - Update a location
|
|
819
829
|
- [`hrisRemoveHrisCompany`](docs/sdks/hris/README.md#removehriscompany) - Remove a company
|
|
830
|
+
- [`hrisRemoveHrisDevice`](docs/sdks/hris/README.md#removehrisdevice) - Remove a device
|
|
820
831
|
- [`hrisRemoveHrisEmployee`](docs/sdks/hris/README.md#removehrisemployee) - Remove an employee
|
|
821
832
|
- [`hrisRemoveHrisGroup`](docs/sdks/hris/README.md#removehrisgroup) - Remove a group
|
|
822
833
|
- [`hrisRemoveHrisLocation`](docs/sdks/hris/README.md#removehrislocation) - Remove a location
|
|
823
834
|
- [`hrisUpdateHrisCompany`](docs/sdks/hris/README.md#updatehriscompany) - Update a company
|
|
835
|
+
- [`hrisUpdateHrisDevice`](docs/sdks/hris/README.md#updatehrisdevice) - Update a device
|
|
824
836
|
- [`hrisUpdateHrisEmployee`](docs/sdks/hris/README.md#updatehrisemployee) - Update an employee
|
|
825
837
|
- [`hrisUpdateHrisGroup`](docs/sdks/hris/README.md#updatehrisgroup) - Update a group
|
|
826
838
|
- [`hrisUpdateHrisLocation`](docs/sdks/hris/README.md#updatehrislocation) - Update a location
|
|
@@ -0,0 +1,519 @@
|
|
|
1
|
+
# Device
|
|
2
|
+
(*device*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createHrisDevice](#createhrisdevice) - Create a device
|
|
9
|
+
* [getHrisDevice](#gethrisdevice) - Retrieve a device
|
|
10
|
+
* [listHrisDevices](#listhrisdevices) - List all devices
|
|
11
|
+
* [patchHrisDevice](#patchhrisdevice) - Update a device
|
|
12
|
+
* [removeHrisDevice](#removehrisdevice) - Remove a device
|
|
13
|
+
* [updateHrisDevice](#updatehrisdevice) - Update a device
|
|
14
|
+
|
|
15
|
+
## createHrisDevice
|
|
16
|
+
|
|
17
|
+
Create a device
|
|
18
|
+
|
|
19
|
+
### Example Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
23
|
+
|
|
24
|
+
const unifiedTo = new UnifiedTo({
|
|
25
|
+
security: {
|
|
26
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
27
|
+
},
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
async function run() {
|
|
31
|
+
const result = await unifiedTo.device.createHrisDevice({
|
|
32
|
+
hrisDevice: {
|
|
33
|
+
name: "<value>",
|
|
34
|
+
},
|
|
35
|
+
connectionId: "<id>",
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
// Handle the result
|
|
39
|
+
console.log(result);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
run();
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Standalone function
|
|
46
|
+
|
|
47
|
+
The standalone function version of this method:
|
|
48
|
+
|
|
49
|
+
```typescript
|
|
50
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
51
|
+
import { deviceCreateHrisDevice } from "@unified-api/typescript-sdk/funcs/deviceCreateHrisDevice.js";
|
|
52
|
+
|
|
53
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
54
|
+
// You can create one instance of it to use across an application.
|
|
55
|
+
const unifiedTo = new UnifiedToCore({
|
|
56
|
+
security: {
|
|
57
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
58
|
+
},
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
async function run() {
|
|
62
|
+
const res = await deviceCreateHrisDevice(unifiedTo, {
|
|
63
|
+
hrisDevice: {
|
|
64
|
+
name: "<value>",
|
|
65
|
+
},
|
|
66
|
+
connectionId: "<id>",
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
if (!res.ok) {
|
|
70
|
+
throw res.error;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
const { value: result } = res;
|
|
74
|
+
|
|
75
|
+
// Handle the result
|
|
76
|
+
console.log(result);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
run();
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Parameters
|
|
83
|
+
|
|
84
|
+
| Parameter | Type | Required | Description |
|
|
85
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
86
|
+
| `request` | [operations.CreateHrisDeviceRequest](../../sdk/models/operations/createhrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
87
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
88
|
+
| `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. |
|
|
89
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
90
|
+
|
|
91
|
+
### Response
|
|
92
|
+
|
|
93
|
+
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
94
|
+
|
|
95
|
+
### Errors
|
|
96
|
+
|
|
97
|
+
| Error Type | Status Code | Content Type |
|
|
98
|
+
| --------------- | --------------- | --------------- |
|
|
99
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
100
|
+
|
|
101
|
+
## getHrisDevice
|
|
102
|
+
|
|
103
|
+
Retrieve a device
|
|
104
|
+
|
|
105
|
+
### Example Usage
|
|
106
|
+
|
|
107
|
+
```typescript
|
|
108
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
109
|
+
|
|
110
|
+
const unifiedTo = new UnifiedTo({
|
|
111
|
+
security: {
|
|
112
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
113
|
+
},
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
async function run() {
|
|
117
|
+
const result = await unifiedTo.device.getHrisDevice({
|
|
118
|
+
connectionId: "<id>",
|
|
119
|
+
id: "<id>",
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
// Handle the result
|
|
123
|
+
console.log(result);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
run();
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Standalone function
|
|
130
|
+
|
|
131
|
+
The standalone function version of this method:
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
135
|
+
import { deviceGetHrisDevice } from "@unified-api/typescript-sdk/funcs/deviceGetHrisDevice.js";
|
|
136
|
+
|
|
137
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
138
|
+
// You can create one instance of it to use across an application.
|
|
139
|
+
const unifiedTo = new UnifiedToCore({
|
|
140
|
+
security: {
|
|
141
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
142
|
+
},
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
async function run() {
|
|
146
|
+
const res = await deviceGetHrisDevice(unifiedTo, {
|
|
147
|
+
connectionId: "<id>",
|
|
148
|
+
id: "<id>",
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
if (!res.ok) {
|
|
152
|
+
throw res.error;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
const { value: result } = res;
|
|
156
|
+
|
|
157
|
+
// Handle the result
|
|
158
|
+
console.log(result);
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
run();
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Parameters
|
|
165
|
+
|
|
166
|
+
| Parameter | Type | Required | Description |
|
|
167
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
168
|
+
| `request` | [operations.GetHrisDeviceRequest](../../sdk/models/operations/gethrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
169
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
170
|
+
| `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. |
|
|
171
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
172
|
+
|
|
173
|
+
### Response
|
|
174
|
+
|
|
175
|
+
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
176
|
+
|
|
177
|
+
### Errors
|
|
178
|
+
|
|
179
|
+
| Error Type | Status Code | Content Type |
|
|
180
|
+
| --------------- | --------------- | --------------- |
|
|
181
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
182
|
+
|
|
183
|
+
## listHrisDevices
|
|
184
|
+
|
|
185
|
+
List all devices
|
|
186
|
+
|
|
187
|
+
### Example Usage
|
|
188
|
+
|
|
189
|
+
```typescript
|
|
190
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
191
|
+
|
|
192
|
+
const unifiedTo = new UnifiedTo({
|
|
193
|
+
security: {
|
|
194
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
195
|
+
},
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
async function run() {
|
|
199
|
+
const result = await unifiedTo.device.listHrisDevices({
|
|
200
|
+
connectionId: "<id>",
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
// Handle the result
|
|
204
|
+
console.log(result);
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
run();
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Standalone function
|
|
211
|
+
|
|
212
|
+
The standalone function version of this method:
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
216
|
+
import { deviceListHrisDevices } from "@unified-api/typescript-sdk/funcs/deviceListHrisDevices.js";
|
|
217
|
+
|
|
218
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
219
|
+
// You can create one instance of it to use across an application.
|
|
220
|
+
const unifiedTo = new UnifiedToCore({
|
|
221
|
+
security: {
|
|
222
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
223
|
+
},
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
async function run() {
|
|
227
|
+
const res = await deviceListHrisDevices(unifiedTo, {
|
|
228
|
+
connectionId: "<id>",
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
if (!res.ok) {
|
|
232
|
+
throw res.error;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
const { value: result } = res;
|
|
236
|
+
|
|
237
|
+
// Handle the result
|
|
238
|
+
console.log(result);
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
run();
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Parameters
|
|
245
|
+
|
|
246
|
+
| Parameter | Type | Required | Description |
|
|
247
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
248
|
+
| `request` | [operations.ListHrisDevicesRequest](../../sdk/models/operations/listhrisdevicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
249
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
250
|
+
| `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. |
|
|
251
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
252
|
+
|
|
253
|
+
### Response
|
|
254
|
+
|
|
255
|
+
**Promise\<[shared.HrisDevice[]](../../models/.md)\>**
|
|
256
|
+
|
|
257
|
+
### Errors
|
|
258
|
+
|
|
259
|
+
| Error Type | Status Code | Content Type |
|
|
260
|
+
| --------------- | --------------- | --------------- |
|
|
261
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
262
|
+
|
|
263
|
+
## patchHrisDevice
|
|
264
|
+
|
|
265
|
+
Update a device
|
|
266
|
+
|
|
267
|
+
### Example Usage
|
|
268
|
+
|
|
269
|
+
```typescript
|
|
270
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
271
|
+
|
|
272
|
+
const unifiedTo = new UnifiedTo({
|
|
273
|
+
security: {
|
|
274
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
275
|
+
},
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
async function run() {
|
|
279
|
+
const result = await unifiedTo.device.patchHrisDevice({
|
|
280
|
+
hrisDevice: {
|
|
281
|
+
name: "<value>",
|
|
282
|
+
},
|
|
283
|
+
connectionId: "<id>",
|
|
284
|
+
id: "<id>",
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
// Handle the result
|
|
288
|
+
console.log(result);
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
run();
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Standalone function
|
|
295
|
+
|
|
296
|
+
The standalone function version of this method:
|
|
297
|
+
|
|
298
|
+
```typescript
|
|
299
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
300
|
+
import { devicePatchHrisDevice } from "@unified-api/typescript-sdk/funcs/devicePatchHrisDevice.js";
|
|
301
|
+
|
|
302
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
303
|
+
// You can create one instance of it to use across an application.
|
|
304
|
+
const unifiedTo = new UnifiedToCore({
|
|
305
|
+
security: {
|
|
306
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
307
|
+
},
|
|
308
|
+
});
|
|
309
|
+
|
|
310
|
+
async function run() {
|
|
311
|
+
const res = await devicePatchHrisDevice(unifiedTo, {
|
|
312
|
+
hrisDevice: {
|
|
313
|
+
name: "<value>",
|
|
314
|
+
},
|
|
315
|
+
connectionId: "<id>",
|
|
316
|
+
id: "<id>",
|
|
317
|
+
});
|
|
318
|
+
|
|
319
|
+
if (!res.ok) {
|
|
320
|
+
throw res.error;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
const { value: result } = res;
|
|
324
|
+
|
|
325
|
+
// Handle the result
|
|
326
|
+
console.log(result);
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
run();
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
| Parameter | Type | Required | Description |
|
|
335
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
336
|
+
| `request` | [operations.PatchHrisDeviceRequest](../../sdk/models/operations/patchhrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
337
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
338
|
+
| `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. |
|
|
339
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
340
|
+
|
|
341
|
+
### Response
|
|
342
|
+
|
|
343
|
+
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
344
|
+
|
|
345
|
+
### Errors
|
|
346
|
+
|
|
347
|
+
| Error Type | Status Code | Content Type |
|
|
348
|
+
| --------------- | --------------- | --------------- |
|
|
349
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
350
|
+
|
|
351
|
+
## removeHrisDevice
|
|
352
|
+
|
|
353
|
+
Remove a device
|
|
354
|
+
|
|
355
|
+
### Example Usage
|
|
356
|
+
|
|
357
|
+
```typescript
|
|
358
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
359
|
+
|
|
360
|
+
const unifiedTo = new UnifiedTo({
|
|
361
|
+
security: {
|
|
362
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
363
|
+
},
|
|
364
|
+
});
|
|
365
|
+
|
|
366
|
+
async function run() {
|
|
367
|
+
const result = await unifiedTo.device.removeHrisDevice({
|
|
368
|
+
connectionId: "<id>",
|
|
369
|
+
id: "<id>",
|
|
370
|
+
});
|
|
371
|
+
|
|
372
|
+
// Handle the result
|
|
373
|
+
console.log(result);
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
run();
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Standalone function
|
|
380
|
+
|
|
381
|
+
The standalone function version of this method:
|
|
382
|
+
|
|
383
|
+
```typescript
|
|
384
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
385
|
+
import { deviceRemoveHrisDevice } from "@unified-api/typescript-sdk/funcs/deviceRemoveHrisDevice.js";
|
|
386
|
+
|
|
387
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
388
|
+
// You can create one instance of it to use across an application.
|
|
389
|
+
const unifiedTo = new UnifiedToCore({
|
|
390
|
+
security: {
|
|
391
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
392
|
+
},
|
|
393
|
+
});
|
|
394
|
+
|
|
395
|
+
async function run() {
|
|
396
|
+
const res = await deviceRemoveHrisDevice(unifiedTo, {
|
|
397
|
+
connectionId: "<id>",
|
|
398
|
+
id: "<id>",
|
|
399
|
+
});
|
|
400
|
+
|
|
401
|
+
if (!res.ok) {
|
|
402
|
+
throw res.error;
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
const { value: result } = res;
|
|
406
|
+
|
|
407
|
+
// Handle the result
|
|
408
|
+
console.log(result);
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
run();
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### Parameters
|
|
415
|
+
|
|
416
|
+
| Parameter | Type | Required | Description |
|
|
417
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
418
|
+
| `request` | [operations.RemoveHrisDeviceRequest](../../sdk/models/operations/removehrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
419
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
420
|
+
| `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. |
|
|
421
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
422
|
+
|
|
423
|
+
### Response
|
|
424
|
+
|
|
425
|
+
**Promise\<[operations.RemoveHrisDeviceResponse](../../sdk/models/operations/removehrisdeviceresponse.md)\>**
|
|
426
|
+
|
|
427
|
+
### Errors
|
|
428
|
+
|
|
429
|
+
| Error Type | Status Code | Content Type |
|
|
430
|
+
| --------------- | --------------- | --------------- |
|
|
431
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
432
|
+
|
|
433
|
+
## updateHrisDevice
|
|
434
|
+
|
|
435
|
+
Update a device
|
|
436
|
+
|
|
437
|
+
### Example Usage
|
|
438
|
+
|
|
439
|
+
```typescript
|
|
440
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
441
|
+
|
|
442
|
+
const unifiedTo = new UnifiedTo({
|
|
443
|
+
security: {
|
|
444
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
445
|
+
},
|
|
446
|
+
});
|
|
447
|
+
|
|
448
|
+
async function run() {
|
|
449
|
+
const result = await unifiedTo.device.updateHrisDevice({
|
|
450
|
+
hrisDevice: {
|
|
451
|
+
name: "<value>",
|
|
452
|
+
},
|
|
453
|
+
connectionId: "<id>",
|
|
454
|
+
id: "<id>",
|
|
455
|
+
});
|
|
456
|
+
|
|
457
|
+
// Handle the result
|
|
458
|
+
console.log(result);
|
|
459
|
+
}
|
|
460
|
+
|
|
461
|
+
run();
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
### Standalone function
|
|
465
|
+
|
|
466
|
+
The standalone function version of this method:
|
|
467
|
+
|
|
468
|
+
```typescript
|
|
469
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
470
|
+
import { deviceUpdateHrisDevice } from "@unified-api/typescript-sdk/funcs/deviceUpdateHrisDevice.js";
|
|
471
|
+
|
|
472
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
473
|
+
// You can create one instance of it to use across an application.
|
|
474
|
+
const unifiedTo = new UnifiedToCore({
|
|
475
|
+
security: {
|
|
476
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
477
|
+
},
|
|
478
|
+
});
|
|
479
|
+
|
|
480
|
+
async function run() {
|
|
481
|
+
const res = await deviceUpdateHrisDevice(unifiedTo, {
|
|
482
|
+
hrisDevice: {
|
|
483
|
+
name: "<value>",
|
|
484
|
+
},
|
|
485
|
+
connectionId: "<id>",
|
|
486
|
+
id: "<id>",
|
|
487
|
+
});
|
|
488
|
+
|
|
489
|
+
if (!res.ok) {
|
|
490
|
+
throw res.error;
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
const { value: result } = res;
|
|
494
|
+
|
|
495
|
+
// Handle the result
|
|
496
|
+
console.log(result);
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
run();
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
### Parameters
|
|
503
|
+
|
|
504
|
+
| Parameter | Type | Required | Description |
|
|
505
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
506
|
+
| `request` | [operations.UpdateHrisDeviceRequest](../../sdk/models/operations/updatehrisdevicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
507
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
508
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
509
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
510
|
+
|
|
511
|
+
### Response
|
|
512
|
+
|
|
513
|
+
**Promise\<[shared.HrisDevice](../../sdk/models/shared/hrisdevice.md)\>**
|
|
514
|
+
|
|
515
|
+
### Errors
|
|
516
|
+
|
|
517
|
+
| Error Type | Status Code | Content Type |
|
|
518
|
+
| --------------- | --------------- | --------------- |
|
|
519
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|