@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
|
@@ -1,983 +0,0 @@
|
|
|
1
|
-
# Group
|
|
2
|
-
(*group*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [createHrisGroup](#createhrisgroup) - Create a group
|
|
9
|
-
* [createScimGroups](#createscimgroups) - Create group
|
|
10
|
-
* [getHrisGroup](#gethrisgroup) - Retrieve a group
|
|
11
|
-
* [getScimGroups](#getscimgroups) - Get group
|
|
12
|
-
* [listHrisGroups](#listhrisgroups) - List all groups
|
|
13
|
-
* [listScimGroups](#listscimgroups) - List groups
|
|
14
|
-
* [patchHrisGroup](#patchhrisgroup) - Update a group
|
|
15
|
-
* [patchScimGroups](#patchscimgroups) - Update group
|
|
16
|
-
* [removeHrisGroup](#removehrisgroup) - Remove a group
|
|
17
|
-
* [removeScimGroups](#removescimgroups) - Delete group
|
|
18
|
-
* [updateHrisGroup](#updatehrisgroup) - Update a group
|
|
19
|
-
* [updateScimGroups](#updatescimgroups) - Update group
|
|
20
|
-
|
|
21
|
-
## createHrisGroup
|
|
22
|
-
|
|
23
|
-
Create a group
|
|
24
|
-
|
|
25
|
-
### Example Usage
|
|
26
|
-
|
|
27
|
-
<!-- UsageSnippet language="typescript" operationID="createHrisGroup" method="post" path="/hris/{connection_id}/group" -->
|
|
28
|
-
```typescript
|
|
29
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
30
|
-
|
|
31
|
-
const unifiedTo = new UnifiedTo({
|
|
32
|
-
security: {
|
|
33
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
34
|
-
},
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
async function run() {
|
|
38
|
-
const result = await unifiedTo.group.createHrisGroup({
|
|
39
|
-
hrisGroup: {},
|
|
40
|
-
connectionId: "<id>",
|
|
41
|
-
});
|
|
42
|
-
|
|
43
|
-
console.log(result);
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
run();
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
### Standalone function
|
|
50
|
-
|
|
51
|
-
The standalone function version of this method:
|
|
52
|
-
|
|
53
|
-
```typescript
|
|
54
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
55
|
-
import { hrisCreateHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisCreateHrisGroup.js";
|
|
56
|
-
|
|
57
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
58
|
-
// You can create one instance of it to use across an application.
|
|
59
|
-
const unifiedTo = new UnifiedToCore({
|
|
60
|
-
security: {
|
|
61
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
62
|
-
},
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
async function run() {
|
|
66
|
-
const res = await hrisCreateHrisGroup(unifiedTo, {
|
|
67
|
-
hrisGroup: {},
|
|
68
|
-
connectionId: "<id>",
|
|
69
|
-
});
|
|
70
|
-
if (res.ok) {
|
|
71
|
-
const { value: result } = res;
|
|
72
|
-
console.log(result);
|
|
73
|
-
} else {
|
|
74
|
-
console.log("hrisCreateHrisGroup failed:", res.error);
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
run();
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
### Parameters
|
|
82
|
-
|
|
83
|
-
| Parameter | Type | Required | Description |
|
|
84
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
85
|
-
| `request` | [operations.CreateHrisGroupRequest](../../sdk/models/operations/createhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
86
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
87
|
-
| `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. |
|
|
88
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
89
|
-
|
|
90
|
-
### Response
|
|
91
|
-
|
|
92
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
93
|
-
|
|
94
|
-
### Errors
|
|
95
|
-
|
|
96
|
-
| Error Type | Status Code | Content Type |
|
|
97
|
-
| --------------- | --------------- | --------------- |
|
|
98
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
99
|
-
|
|
100
|
-
## createScimGroups
|
|
101
|
-
|
|
102
|
-
Create group
|
|
103
|
-
|
|
104
|
-
### Example Usage
|
|
105
|
-
|
|
106
|
-
<!-- UsageSnippet language="typescript" operationID="createScimGroups" method="post" path="/scim/{connection_id}/groups" -->
|
|
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.group.createScimGroups({
|
|
118
|
-
scimGroup: {
|
|
119
|
-
displayName: "Nina.Tremblay",
|
|
120
|
-
},
|
|
121
|
-
connectionId: "<id>",
|
|
122
|
-
});
|
|
123
|
-
|
|
124
|
-
console.log(result);
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
run();
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
### Standalone function
|
|
131
|
-
|
|
132
|
-
The standalone function version of this method:
|
|
133
|
-
|
|
134
|
-
```typescript
|
|
135
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
136
|
-
import { groupCreateScimGroups } from "@unified-api/typescript-sdk/funcs/groupCreateScimGroups.js";
|
|
137
|
-
|
|
138
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
139
|
-
// You can create one instance of it to use across an application.
|
|
140
|
-
const unifiedTo = new UnifiedToCore({
|
|
141
|
-
security: {
|
|
142
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
143
|
-
},
|
|
144
|
-
});
|
|
145
|
-
|
|
146
|
-
async function run() {
|
|
147
|
-
const res = await groupCreateScimGroups(unifiedTo, {
|
|
148
|
-
scimGroup: {
|
|
149
|
-
displayName: "Nina.Tremblay",
|
|
150
|
-
},
|
|
151
|
-
connectionId: "<id>",
|
|
152
|
-
});
|
|
153
|
-
if (res.ok) {
|
|
154
|
-
const { value: result } = res;
|
|
155
|
-
console.log(result);
|
|
156
|
-
} else {
|
|
157
|
-
console.log("groupCreateScimGroups failed:", res.error);
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
run();
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
### Parameters
|
|
165
|
-
|
|
166
|
-
| Parameter | Type | Required | Description |
|
|
167
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
168
|
-
| `request` | [operations.CreateScimGroupsRequest](../../sdk/models/operations/createscimgroupsrequest.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.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
176
|
-
|
|
177
|
-
### Errors
|
|
178
|
-
|
|
179
|
-
| Error Type | Status Code | Content Type |
|
|
180
|
-
| --------------- | --------------- | --------------- |
|
|
181
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
182
|
-
|
|
183
|
-
## getHrisGroup
|
|
184
|
-
|
|
185
|
-
Retrieve a group
|
|
186
|
-
|
|
187
|
-
### Example Usage
|
|
188
|
-
|
|
189
|
-
<!-- UsageSnippet language="typescript" operationID="getHrisGroup" method="get" path="/hris/{connection_id}/group/{id}" -->
|
|
190
|
-
```typescript
|
|
191
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
192
|
-
|
|
193
|
-
const unifiedTo = new UnifiedTo({
|
|
194
|
-
security: {
|
|
195
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
196
|
-
},
|
|
197
|
-
});
|
|
198
|
-
|
|
199
|
-
async function run() {
|
|
200
|
-
const result = await unifiedTo.group.getHrisGroup({
|
|
201
|
-
connectionId: "<id>",
|
|
202
|
-
id: "<id>",
|
|
203
|
-
});
|
|
204
|
-
|
|
205
|
-
console.log(result);
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
run();
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
### Standalone function
|
|
212
|
-
|
|
213
|
-
The standalone function version of this method:
|
|
214
|
-
|
|
215
|
-
```typescript
|
|
216
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
217
|
-
import { hrisGetHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisGetHrisGroup.js";
|
|
218
|
-
|
|
219
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
220
|
-
// You can create one instance of it to use across an application.
|
|
221
|
-
const unifiedTo = new UnifiedToCore({
|
|
222
|
-
security: {
|
|
223
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
224
|
-
},
|
|
225
|
-
});
|
|
226
|
-
|
|
227
|
-
async function run() {
|
|
228
|
-
const res = await hrisGetHrisGroup(unifiedTo, {
|
|
229
|
-
connectionId: "<id>",
|
|
230
|
-
id: "<id>",
|
|
231
|
-
});
|
|
232
|
-
if (res.ok) {
|
|
233
|
-
const { value: result } = res;
|
|
234
|
-
console.log(result);
|
|
235
|
-
} else {
|
|
236
|
-
console.log("hrisGetHrisGroup failed:", res.error);
|
|
237
|
-
}
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
run();
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
### Parameters
|
|
244
|
-
|
|
245
|
-
| Parameter | Type | Required | Description |
|
|
246
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
247
|
-
| `request` | [operations.GetHrisGroupRequest](../../sdk/models/operations/gethrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
248
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
249
|
-
| `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. |
|
|
250
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
251
|
-
|
|
252
|
-
### Response
|
|
253
|
-
|
|
254
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
255
|
-
|
|
256
|
-
### Errors
|
|
257
|
-
|
|
258
|
-
| Error Type | Status Code | Content Type |
|
|
259
|
-
| --------------- | --------------- | --------------- |
|
|
260
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
261
|
-
|
|
262
|
-
## getScimGroups
|
|
263
|
-
|
|
264
|
-
Get group
|
|
265
|
-
|
|
266
|
-
### Example Usage
|
|
267
|
-
|
|
268
|
-
<!-- UsageSnippet language="typescript" operationID="getScimGroups" method="get" path="/scim/{connection_id}/groups/{id}" -->
|
|
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.group.getScimGroups({
|
|
280
|
-
connectionId: "<id>",
|
|
281
|
-
id: "<id>",
|
|
282
|
-
});
|
|
283
|
-
|
|
284
|
-
console.log(result);
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
run();
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### Standalone function
|
|
291
|
-
|
|
292
|
-
The standalone function version of this method:
|
|
293
|
-
|
|
294
|
-
```typescript
|
|
295
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
296
|
-
import { groupGetScimGroups } from "@unified-api/typescript-sdk/funcs/groupGetScimGroups.js";
|
|
297
|
-
|
|
298
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
299
|
-
// You can create one instance of it to use across an application.
|
|
300
|
-
const unifiedTo = new UnifiedToCore({
|
|
301
|
-
security: {
|
|
302
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
303
|
-
},
|
|
304
|
-
});
|
|
305
|
-
|
|
306
|
-
async function run() {
|
|
307
|
-
const res = await groupGetScimGroups(unifiedTo, {
|
|
308
|
-
connectionId: "<id>",
|
|
309
|
-
id: "<id>",
|
|
310
|
-
});
|
|
311
|
-
if (res.ok) {
|
|
312
|
-
const { value: result } = res;
|
|
313
|
-
console.log(result);
|
|
314
|
-
} else {
|
|
315
|
-
console.log("groupGetScimGroups failed:", res.error);
|
|
316
|
-
}
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
run();
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
### Parameters
|
|
323
|
-
|
|
324
|
-
| Parameter | Type | Required | Description |
|
|
325
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
326
|
-
| `request` | [operations.GetScimGroupsRequest](../../sdk/models/operations/getscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
327
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
328
|
-
| `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. |
|
|
329
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
330
|
-
|
|
331
|
-
### Response
|
|
332
|
-
|
|
333
|
-
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
334
|
-
|
|
335
|
-
### Errors
|
|
336
|
-
|
|
337
|
-
| Error Type | Status Code | Content Type |
|
|
338
|
-
| --------------- | --------------- | --------------- |
|
|
339
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
340
|
-
|
|
341
|
-
## listHrisGroups
|
|
342
|
-
|
|
343
|
-
List all groups
|
|
344
|
-
|
|
345
|
-
### Example Usage
|
|
346
|
-
|
|
347
|
-
<!-- UsageSnippet language="typescript" operationID="listHrisGroups" method="get" path="/hris/{connection_id}/group" -->
|
|
348
|
-
```typescript
|
|
349
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
350
|
-
|
|
351
|
-
const unifiedTo = new UnifiedTo({
|
|
352
|
-
security: {
|
|
353
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
354
|
-
},
|
|
355
|
-
});
|
|
356
|
-
|
|
357
|
-
async function run() {
|
|
358
|
-
const result = await unifiedTo.group.listHrisGroups({
|
|
359
|
-
connectionId: "<id>",
|
|
360
|
-
});
|
|
361
|
-
|
|
362
|
-
console.log(result);
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
run();
|
|
366
|
-
```
|
|
367
|
-
|
|
368
|
-
### Standalone function
|
|
369
|
-
|
|
370
|
-
The standalone function version of this method:
|
|
371
|
-
|
|
372
|
-
```typescript
|
|
373
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
374
|
-
import { hrisListHrisGroups } from "@unified-api/typescript-sdk/funcs/hrisListHrisGroups.js";
|
|
375
|
-
|
|
376
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
377
|
-
// You can create one instance of it to use across an application.
|
|
378
|
-
const unifiedTo = new UnifiedToCore({
|
|
379
|
-
security: {
|
|
380
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
381
|
-
},
|
|
382
|
-
});
|
|
383
|
-
|
|
384
|
-
async function run() {
|
|
385
|
-
const res = await hrisListHrisGroups(unifiedTo, {
|
|
386
|
-
connectionId: "<id>",
|
|
387
|
-
});
|
|
388
|
-
if (res.ok) {
|
|
389
|
-
const { value: result } = res;
|
|
390
|
-
console.log(result);
|
|
391
|
-
} else {
|
|
392
|
-
console.log("hrisListHrisGroups failed:", res.error);
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
run();
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
### Parameters
|
|
400
|
-
|
|
401
|
-
| Parameter | Type | Required | Description |
|
|
402
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
-
| `request` | [operations.ListHrisGroupsRequest](../../sdk/models/operations/listhrisgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
|
-
| `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. |
|
|
406
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
|
-
|
|
408
|
-
### Response
|
|
409
|
-
|
|
410
|
-
**Promise\<[shared.HrisGroup[]](../../models/.md)\>**
|
|
411
|
-
|
|
412
|
-
### Errors
|
|
413
|
-
|
|
414
|
-
| Error Type | Status Code | Content Type |
|
|
415
|
-
| --------------- | --------------- | --------------- |
|
|
416
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
417
|
-
|
|
418
|
-
## listScimGroups
|
|
419
|
-
|
|
420
|
-
List groups
|
|
421
|
-
|
|
422
|
-
### Example Usage
|
|
423
|
-
|
|
424
|
-
<!-- UsageSnippet language="typescript" operationID="listScimGroups" method="get" path="/scim/{connection_id}/groups" -->
|
|
425
|
-
```typescript
|
|
426
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
427
|
-
|
|
428
|
-
const unifiedTo = new UnifiedTo({
|
|
429
|
-
security: {
|
|
430
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
431
|
-
},
|
|
432
|
-
});
|
|
433
|
-
|
|
434
|
-
async function run() {
|
|
435
|
-
const result = await unifiedTo.group.listScimGroups({
|
|
436
|
-
connectionId: "<id>",
|
|
437
|
-
});
|
|
438
|
-
|
|
439
|
-
console.log(result);
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
run();
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
### Standalone function
|
|
446
|
-
|
|
447
|
-
The standalone function version of this method:
|
|
448
|
-
|
|
449
|
-
```typescript
|
|
450
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
451
|
-
import { groupListScimGroups } from "@unified-api/typescript-sdk/funcs/groupListScimGroups.js";
|
|
452
|
-
|
|
453
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
454
|
-
// You can create one instance of it to use across an application.
|
|
455
|
-
const unifiedTo = new UnifiedToCore({
|
|
456
|
-
security: {
|
|
457
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
458
|
-
},
|
|
459
|
-
});
|
|
460
|
-
|
|
461
|
-
async function run() {
|
|
462
|
-
const res = await groupListScimGroups(unifiedTo, {
|
|
463
|
-
connectionId: "<id>",
|
|
464
|
-
});
|
|
465
|
-
if (res.ok) {
|
|
466
|
-
const { value: result } = res;
|
|
467
|
-
console.log(result);
|
|
468
|
-
} else {
|
|
469
|
-
console.log("groupListScimGroups failed:", res.error);
|
|
470
|
-
}
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
run();
|
|
474
|
-
```
|
|
475
|
-
|
|
476
|
-
### Parameters
|
|
477
|
-
|
|
478
|
-
| Parameter | Type | Required | Description |
|
|
479
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
480
|
-
| `request` | [operations.ListScimGroupsRequest](../../sdk/models/operations/listscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
481
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
482
|
-
| `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. |
|
|
483
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
484
|
-
|
|
485
|
-
### Response
|
|
486
|
-
|
|
487
|
-
**Promise\<[shared.ScimGroup[]](../../models/.md)\>**
|
|
488
|
-
|
|
489
|
-
### Errors
|
|
490
|
-
|
|
491
|
-
| Error Type | Status Code | Content Type |
|
|
492
|
-
| --------------- | --------------- | --------------- |
|
|
493
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
494
|
-
|
|
495
|
-
## patchHrisGroup
|
|
496
|
-
|
|
497
|
-
Update a group
|
|
498
|
-
|
|
499
|
-
### Example Usage
|
|
500
|
-
|
|
501
|
-
<!-- UsageSnippet language="typescript" operationID="patchHrisGroup" method="patch" path="/hris/{connection_id}/group/{id}" -->
|
|
502
|
-
```typescript
|
|
503
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
504
|
-
|
|
505
|
-
const unifiedTo = new UnifiedTo({
|
|
506
|
-
security: {
|
|
507
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
508
|
-
},
|
|
509
|
-
});
|
|
510
|
-
|
|
511
|
-
async function run() {
|
|
512
|
-
const result = await unifiedTo.group.patchHrisGroup({
|
|
513
|
-
hrisGroup: {},
|
|
514
|
-
connectionId: "<id>",
|
|
515
|
-
id: "<id>",
|
|
516
|
-
});
|
|
517
|
-
|
|
518
|
-
console.log(result);
|
|
519
|
-
}
|
|
520
|
-
|
|
521
|
-
run();
|
|
522
|
-
```
|
|
523
|
-
|
|
524
|
-
### Standalone function
|
|
525
|
-
|
|
526
|
-
The standalone function version of this method:
|
|
527
|
-
|
|
528
|
-
```typescript
|
|
529
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
530
|
-
import { hrisPatchHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisPatchHrisGroup.js";
|
|
531
|
-
|
|
532
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
533
|
-
// You can create one instance of it to use across an application.
|
|
534
|
-
const unifiedTo = new UnifiedToCore({
|
|
535
|
-
security: {
|
|
536
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
537
|
-
},
|
|
538
|
-
});
|
|
539
|
-
|
|
540
|
-
async function run() {
|
|
541
|
-
const res = await hrisPatchHrisGroup(unifiedTo, {
|
|
542
|
-
hrisGroup: {},
|
|
543
|
-
connectionId: "<id>",
|
|
544
|
-
id: "<id>",
|
|
545
|
-
});
|
|
546
|
-
if (res.ok) {
|
|
547
|
-
const { value: result } = res;
|
|
548
|
-
console.log(result);
|
|
549
|
-
} else {
|
|
550
|
-
console.log("hrisPatchHrisGroup failed:", res.error);
|
|
551
|
-
}
|
|
552
|
-
}
|
|
553
|
-
|
|
554
|
-
run();
|
|
555
|
-
```
|
|
556
|
-
|
|
557
|
-
### Parameters
|
|
558
|
-
|
|
559
|
-
| Parameter | Type | Required | Description |
|
|
560
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
561
|
-
| `request` | [operations.PatchHrisGroupRequest](../../sdk/models/operations/patchhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
562
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
563
|
-
| `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. |
|
|
564
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
565
|
-
|
|
566
|
-
### Response
|
|
567
|
-
|
|
568
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
569
|
-
|
|
570
|
-
### Errors
|
|
571
|
-
|
|
572
|
-
| Error Type | Status Code | Content Type |
|
|
573
|
-
| --------------- | --------------- | --------------- |
|
|
574
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
575
|
-
|
|
576
|
-
## patchScimGroups
|
|
577
|
-
|
|
578
|
-
Update group
|
|
579
|
-
|
|
580
|
-
### Example Usage
|
|
581
|
-
|
|
582
|
-
<!-- UsageSnippet language="typescript" operationID="patchScimGroups" method="patch" path="/scim/{connection_id}/groups/{id}" -->
|
|
583
|
-
```typescript
|
|
584
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
585
|
-
|
|
586
|
-
const unifiedTo = new UnifiedTo({
|
|
587
|
-
security: {
|
|
588
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
589
|
-
},
|
|
590
|
-
});
|
|
591
|
-
|
|
592
|
-
async function run() {
|
|
593
|
-
const result = await unifiedTo.group.patchScimGroups({
|
|
594
|
-
scimGroup: {
|
|
595
|
-
displayName: "Newell.Hoeger",
|
|
596
|
-
},
|
|
597
|
-
connectionId: "<id>",
|
|
598
|
-
id: "<id>",
|
|
599
|
-
});
|
|
600
|
-
|
|
601
|
-
console.log(result);
|
|
602
|
-
}
|
|
603
|
-
|
|
604
|
-
run();
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
### Standalone function
|
|
608
|
-
|
|
609
|
-
The standalone function version of this method:
|
|
610
|
-
|
|
611
|
-
```typescript
|
|
612
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
613
|
-
import { groupPatchScimGroups } from "@unified-api/typescript-sdk/funcs/groupPatchScimGroups.js";
|
|
614
|
-
|
|
615
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
616
|
-
// You can create one instance of it to use across an application.
|
|
617
|
-
const unifiedTo = new UnifiedToCore({
|
|
618
|
-
security: {
|
|
619
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
620
|
-
},
|
|
621
|
-
});
|
|
622
|
-
|
|
623
|
-
async function run() {
|
|
624
|
-
const res = await groupPatchScimGroups(unifiedTo, {
|
|
625
|
-
scimGroup: {
|
|
626
|
-
displayName: "Newell.Hoeger",
|
|
627
|
-
},
|
|
628
|
-
connectionId: "<id>",
|
|
629
|
-
id: "<id>",
|
|
630
|
-
});
|
|
631
|
-
if (res.ok) {
|
|
632
|
-
const { value: result } = res;
|
|
633
|
-
console.log(result);
|
|
634
|
-
} else {
|
|
635
|
-
console.log("groupPatchScimGroups failed:", res.error);
|
|
636
|
-
}
|
|
637
|
-
}
|
|
638
|
-
|
|
639
|
-
run();
|
|
640
|
-
```
|
|
641
|
-
|
|
642
|
-
### Parameters
|
|
643
|
-
|
|
644
|
-
| Parameter | Type | Required | Description |
|
|
645
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
646
|
-
| `request` | [operations.PatchScimGroupsRequest](../../sdk/models/operations/patchscimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
647
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
648
|
-
| `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. |
|
|
649
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
650
|
-
|
|
651
|
-
### Response
|
|
652
|
-
|
|
653
|
-
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
654
|
-
|
|
655
|
-
### Errors
|
|
656
|
-
|
|
657
|
-
| Error Type | Status Code | Content Type |
|
|
658
|
-
| --------------- | --------------- | --------------- |
|
|
659
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
660
|
-
|
|
661
|
-
## removeHrisGroup
|
|
662
|
-
|
|
663
|
-
Remove a group
|
|
664
|
-
|
|
665
|
-
### Example Usage
|
|
666
|
-
|
|
667
|
-
<!-- UsageSnippet language="typescript" operationID="removeHrisGroup" method="delete" path="/hris/{connection_id}/group/{id}" -->
|
|
668
|
-
```typescript
|
|
669
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
670
|
-
|
|
671
|
-
const unifiedTo = new UnifiedTo({
|
|
672
|
-
security: {
|
|
673
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
674
|
-
},
|
|
675
|
-
});
|
|
676
|
-
|
|
677
|
-
async function run() {
|
|
678
|
-
const result = await unifiedTo.group.removeHrisGroup({
|
|
679
|
-
connectionId: "<id>",
|
|
680
|
-
id: "<id>",
|
|
681
|
-
});
|
|
682
|
-
|
|
683
|
-
console.log(result);
|
|
684
|
-
}
|
|
685
|
-
|
|
686
|
-
run();
|
|
687
|
-
```
|
|
688
|
-
|
|
689
|
-
### Standalone function
|
|
690
|
-
|
|
691
|
-
The standalone function version of this method:
|
|
692
|
-
|
|
693
|
-
```typescript
|
|
694
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
695
|
-
import { hrisRemoveHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisRemoveHrisGroup.js";
|
|
696
|
-
|
|
697
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
698
|
-
// You can create one instance of it to use across an application.
|
|
699
|
-
const unifiedTo = new UnifiedToCore({
|
|
700
|
-
security: {
|
|
701
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
702
|
-
},
|
|
703
|
-
});
|
|
704
|
-
|
|
705
|
-
async function run() {
|
|
706
|
-
const res = await hrisRemoveHrisGroup(unifiedTo, {
|
|
707
|
-
connectionId: "<id>",
|
|
708
|
-
id: "<id>",
|
|
709
|
-
});
|
|
710
|
-
if (res.ok) {
|
|
711
|
-
const { value: result } = res;
|
|
712
|
-
console.log(result);
|
|
713
|
-
} else {
|
|
714
|
-
console.log("hrisRemoveHrisGroup failed:", res.error);
|
|
715
|
-
}
|
|
716
|
-
}
|
|
717
|
-
|
|
718
|
-
run();
|
|
719
|
-
```
|
|
720
|
-
|
|
721
|
-
### Parameters
|
|
722
|
-
|
|
723
|
-
| Parameter | Type | Required | Description |
|
|
724
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
725
|
-
| `request` | [operations.RemoveHrisGroupRequest](../../sdk/models/operations/removehrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
726
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
727
|
-
| `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. |
|
|
728
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
729
|
-
|
|
730
|
-
### Response
|
|
731
|
-
|
|
732
|
-
**Promise\<[operations.RemoveHrisGroupResponse](../../sdk/models/operations/removehrisgroupresponse.md)\>**
|
|
733
|
-
|
|
734
|
-
### Errors
|
|
735
|
-
|
|
736
|
-
| Error Type | Status Code | Content Type |
|
|
737
|
-
| --------------- | --------------- | --------------- |
|
|
738
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
739
|
-
|
|
740
|
-
## removeScimGroups
|
|
741
|
-
|
|
742
|
-
Delete group
|
|
743
|
-
|
|
744
|
-
### Example Usage
|
|
745
|
-
|
|
746
|
-
<!-- UsageSnippet language="typescript" operationID="removeScimGroups" method="delete" path="/scim/{connection_id}/groups/{id}" -->
|
|
747
|
-
```typescript
|
|
748
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
749
|
-
|
|
750
|
-
const unifiedTo = new UnifiedTo({
|
|
751
|
-
security: {
|
|
752
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
753
|
-
},
|
|
754
|
-
});
|
|
755
|
-
|
|
756
|
-
async function run() {
|
|
757
|
-
const result = await unifiedTo.group.removeScimGroups({
|
|
758
|
-
connectionId: "<id>",
|
|
759
|
-
id: "<id>",
|
|
760
|
-
});
|
|
761
|
-
|
|
762
|
-
console.log(result);
|
|
763
|
-
}
|
|
764
|
-
|
|
765
|
-
run();
|
|
766
|
-
```
|
|
767
|
-
|
|
768
|
-
### Standalone function
|
|
769
|
-
|
|
770
|
-
The standalone function version of this method:
|
|
771
|
-
|
|
772
|
-
```typescript
|
|
773
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
774
|
-
import { groupRemoveScimGroups } from "@unified-api/typescript-sdk/funcs/groupRemoveScimGroups.js";
|
|
775
|
-
|
|
776
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
777
|
-
// You can create one instance of it to use across an application.
|
|
778
|
-
const unifiedTo = new UnifiedToCore({
|
|
779
|
-
security: {
|
|
780
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
781
|
-
},
|
|
782
|
-
});
|
|
783
|
-
|
|
784
|
-
async function run() {
|
|
785
|
-
const res = await groupRemoveScimGroups(unifiedTo, {
|
|
786
|
-
connectionId: "<id>",
|
|
787
|
-
id: "<id>",
|
|
788
|
-
});
|
|
789
|
-
if (res.ok) {
|
|
790
|
-
const { value: result } = res;
|
|
791
|
-
console.log(result);
|
|
792
|
-
} else {
|
|
793
|
-
console.log("groupRemoveScimGroups failed:", res.error);
|
|
794
|
-
}
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
run();
|
|
798
|
-
```
|
|
799
|
-
|
|
800
|
-
### Parameters
|
|
801
|
-
|
|
802
|
-
| Parameter | Type | Required | Description |
|
|
803
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
804
|
-
| `request` | [operations.RemoveScimGroupsRequest](../../sdk/models/operations/removescimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
805
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
806
|
-
| `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. |
|
|
807
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
808
|
-
|
|
809
|
-
### Response
|
|
810
|
-
|
|
811
|
-
**Promise\<[operations.RemoveScimGroupsResponse](../../sdk/models/operations/removescimgroupsresponse.md)\>**
|
|
812
|
-
|
|
813
|
-
### Errors
|
|
814
|
-
|
|
815
|
-
| Error Type | Status Code | Content Type |
|
|
816
|
-
| --------------- | --------------- | --------------- |
|
|
817
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
818
|
-
|
|
819
|
-
## updateHrisGroup
|
|
820
|
-
|
|
821
|
-
Update a group
|
|
822
|
-
|
|
823
|
-
### Example Usage
|
|
824
|
-
|
|
825
|
-
<!-- UsageSnippet language="typescript" operationID="updateHrisGroup" method="put" path="/hris/{connection_id}/group/{id}" -->
|
|
826
|
-
```typescript
|
|
827
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
828
|
-
|
|
829
|
-
const unifiedTo = new UnifiedTo({
|
|
830
|
-
security: {
|
|
831
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
832
|
-
},
|
|
833
|
-
});
|
|
834
|
-
|
|
835
|
-
async function run() {
|
|
836
|
-
const result = await unifiedTo.group.updateHrisGroup({
|
|
837
|
-
hrisGroup: {},
|
|
838
|
-
connectionId: "<id>",
|
|
839
|
-
id: "<id>",
|
|
840
|
-
});
|
|
841
|
-
|
|
842
|
-
console.log(result);
|
|
843
|
-
}
|
|
844
|
-
|
|
845
|
-
run();
|
|
846
|
-
```
|
|
847
|
-
|
|
848
|
-
### Standalone function
|
|
849
|
-
|
|
850
|
-
The standalone function version of this method:
|
|
851
|
-
|
|
852
|
-
```typescript
|
|
853
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
854
|
-
import { hrisUpdateHrisGroup } from "@unified-api/typescript-sdk/funcs/hrisUpdateHrisGroup.js";
|
|
855
|
-
|
|
856
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
857
|
-
// You can create one instance of it to use across an application.
|
|
858
|
-
const unifiedTo = new UnifiedToCore({
|
|
859
|
-
security: {
|
|
860
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
861
|
-
},
|
|
862
|
-
});
|
|
863
|
-
|
|
864
|
-
async function run() {
|
|
865
|
-
const res = await hrisUpdateHrisGroup(unifiedTo, {
|
|
866
|
-
hrisGroup: {},
|
|
867
|
-
connectionId: "<id>",
|
|
868
|
-
id: "<id>",
|
|
869
|
-
});
|
|
870
|
-
if (res.ok) {
|
|
871
|
-
const { value: result } = res;
|
|
872
|
-
console.log(result);
|
|
873
|
-
} else {
|
|
874
|
-
console.log("hrisUpdateHrisGroup failed:", res.error);
|
|
875
|
-
}
|
|
876
|
-
}
|
|
877
|
-
|
|
878
|
-
run();
|
|
879
|
-
```
|
|
880
|
-
|
|
881
|
-
### Parameters
|
|
882
|
-
|
|
883
|
-
| Parameter | Type | Required | Description |
|
|
884
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
885
|
-
| `request` | [operations.UpdateHrisGroupRequest](../../sdk/models/operations/updatehrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
886
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
887
|
-
| `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. |
|
|
888
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
889
|
-
|
|
890
|
-
### Response
|
|
891
|
-
|
|
892
|
-
**Promise\<[shared.HrisGroup](../../sdk/models/shared/hrisgroup.md)\>**
|
|
893
|
-
|
|
894
|
-
### Errors
|
|
895
|
-
|
|
896
|
-
| Error Type | Status Code | Content Type |
|
|
897
|
-
| --------------- | --------------- | --------------- |
|
|
898
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
899
|
-
|
|
900
|
-
## updateScimGroups
|
|
901
|
-
|
|
902
|
-
Update group
|
|
903
|
-
|
|
904
|
-
### Example Usage
|
|
905
|
-
|
|
906
|
-
<!-- UsageSnippet language="typescript" operationID="updateScimGroups" method="put" path="/scim/{connection_id}/groups/{id}" -->
|
|
907
|
-
```typescript
|
|
908
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
909
|
-
|
|
910
|
-
const unifiedTo = new UnifiedTo({
|
|
911
|
-
security: {
|
|
912
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
913
|
-
},
|
|
914
|
-
});
|
|
915
|
-
|
|
916
|
-
async function run() {
|
|
917
|
-
const result = await unifiedTo.group.updateScimGroups({
|
|
918
|
-
scimGroup: {
|
|
919
|
-
displayName: "Reynold90",
|
|
920
|
-
},
|
|
921
|
-
connectionId: "<id>",
|
|
922
|
-
id: "<id>",
|
|
923
|
-
});
|
|
924
|
-
|
|
925
|
-
console.log(result);
|
|
926
|
-
}
|
|
927
|
-
|
|
928
|
-
run();
|
|
929
|
-
```
|
|
930
|
-
|
|
931
|
-
### Standalone function
|
|
932
|
-
|
|
933
|
-
The standalone function version of this method:
|
|
934
|
-
|
|
935
|
-
```typescript
|
|
936
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
937
|
-
import { groupUpdateScimGroups } from "@unified-api/typescript-sdk/funcs/groupUpdateScimGroups.js";
|
|
938
|
-
|
|
939
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
940
|
-
// You can create one instance of it to use across an application.
|
|
941
|
-
const unifiedTo = new UnifiedToCore({
|
|
942
|
-
security: {
|
|
943
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
944
|
-
},
|
|
945
|
-
});
|
|
946
|
-
|
|
947
|
-
async function run() {
|
|
948
|
-
const res = await groupUpdateScimGroups(unifiedTo, {
|
|
949
|
-
scimGroup: {
|
|
950
|
-
displayName: "Reynold90",
|
|
951
|
-
},
|
|
952
|
-
connectionId: "<id>",
|
|
953
|
-
id: "<id>",
|
|
954
|
-
});
|
|
955
|
-
if (res.ok) {
|
|
956
|
-
const { value: result } = res;
|
|
957
|
-
console.log(result);
|
|
958
|
-
} else {
|
|
959
|
-
console.log("groupUpdateScimGroups failed:", res.error);
|
|
960
|
-
}
|
|
961
|
-
}
|
|
962
|
-
|
|
963
|
-
run();
|
|
964
|
-
```
|
|
965
|
-
|
|
966
|
-
### Parameters
|
|
967
|
-
|
|
968
|
-
| Parameter | Type | Required | Description |
|
|
969
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
970
|
-
| `request` | [operations.UpdateScimGroupsRequest](../../sdk/models/operations/updatescimgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
971
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
972
|
-
| `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. |
|
|
973
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
974
|
-
|
|
975
|
-
### Response
|
|
976
|
-
|
|
977
|
-
**Promise\<[shared.ScimGroup](../../sdk/models/shared/scimgroup.md)\>**
|
|
978
|
-
|
|
979
|
-
### Errors
|
|
980
|
-
|
|
981
|
-
| Error Type | Status Code | Content Type |
|
|
982
|
-
| --------------- | --------------- | --------------- |
|
|
983
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|