@unified-api/typescript-sdk 2.9.4 → 2.9.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +108 -0
- package/README.md +36 -15
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +501 -0
- package/docs/sdks/accounting/README.md +3629 -0
- package/docs/sdks/activity/README.md +501 -0
- package/docs/sdks/apicall/README.md +165 -0
- package/docs/sdks/application/README.md +501 -0
- package/docs/sdks/applicationstatus/README.md +88 -0
- package/docs/sdks/ats/README.md +3710 -0
- package/docs/sdks/auth/README.md +173 -0
- package/docs/sdks/branch/README.md +501 -0
- package/docs/sdks/call/README.md +88 -0
- package/docs/sdks/candidate/README.md +501 -0
- package/docs/sdks/channel/README.md +171 -0
- package/docs/sdks/class/README.md +501 -0
- package/docs/sdks/collection/README.md +501 -0
- package/docs/sdks/commerce/README.md +2477 -0
- package/docs/sdks/commit/README.md +501 -0
- package/docs/sdks/company/README.md +1240 -0
- package/docs/sdks/connection/README.md +485 -0
- package/docs/sdks/contact/README.md +1489 -0
- package/docs/sdks/course/README.md +501 -0
- package/docs/sdks/crm/README.md +2971 -0
- package/docs/sdks/customer/README.md +501 -0
- package/docs/sdks/deal/README.md +501 -0
- package/docs/sdks/document/README.md +501 -0
- package/docs/sdks/employee/README.md +501 -0
- package/docs/sdks/enrich/README.md +169 -0
- package/docs/sdks/event/README.md +501 -0
- package/docs/sdks/file/README.md +501 -0
- package/docs/sdks/genai/README.md +169 -0
- package/docs/sdks/group/README.md +995 -0
- package/docs/sdks/hris/README.md +2311 -0
- package/docs/sdks/instructor/README.md +501 -0
- package/docs/sdks/integration/README.md +248 -0
- package/docs/sdks/interview/README.md +501 -0
- package/docs/sdks/inventory/README.md +501 -0
- package/docs/sdks/invoice/README.md +501 -0
- package/docs/sdks/issue/README.md +84 -0
- package/docs/sdks/item/README.md +501 -0
- package/docs/sdks/job/README.md +501 -0
- package/docs/sdks/journal/README.md +501 -0
- package/docs/sdks/kms/README.md +995 -0
- package/docs/sdks/lead/README.md +501 -0
- package/docs/sdks/link/README.md +501 -0
- package/docs/sdks/list/README.md +501 -0
- package/docs/sdks/lms/README.md +1983 -0
- package/docs/sdks/location/README.md +995 -0
- package/docs/sdks/login/README.md +90 -0
- package/docs/sdks/martech/README.md +995 -0
- package/docs/sdks/member/README.md +501 -0
- package/docs/sdks/message/README.md +501 -0
- package/docs/sdks/messaging/README.md +665 -0
- package/docs/sdks/metadata/README.md +501 -0
- package/docs/sdks/model/README.md +88 -0
- package/docs/sdks/note/README.md +501 -0
- package/docs/sdks/order/README.md +501 -0
- package/docs/sdks/organization/README.md +665 -0
- package/docs/sdks/page/README.md +501 -0
- package/docs/sdks/passthrough/README.md +671 -0
- package/docs/sdks/payment/README.md +1323 -0
- package/docs/sdks/payout/README.md +171 -0
- package/docs/sdks/payslip/README.md +171 -0
- package/docs/sdks/person/README.md +88 -0
- package/docs/sdks/pipeline/README.md +501 -0
- package/docs/sdks/project/README.md +501 -0
- package/docs/sdks/prompt/README.md +88 -0
- package/docs/sdks/pullrequest/README.md +501 -0
- package/docs/sdks/refund/README.md +171 -0
- package/docs/sdks/repo/README.md +2477 -0
- package/docs/sdks/repository/README.md +501 -0
- package/docs/sdks/scim/README.md +995 -0
- package/docs/sdks/scorecard/README.md +501 -0
- package/docs/sdks/space/README.md +501 -0
- package/docs/sdks/storage/README.md +501 -0
- package/docs/sdks/student/README.md +501 -0
- package/docs/sdks/task/README.md +995 -0
- package/docs/sdks/taxrate/README.md +501 -0
- package/docs/sdks/ticket/README.md +501 -0
- package/docs/sdks/ticketing/README.md +1489 -0
- package/docs/sdks/timeoff/README.md +171 -0
- package/docs/sdks/transaction/README.md +501 -0
- package/docs/sdks/uc/README.md +582 -0
- package/docs/sdks/unified/README.md +1601 -0
- package/docs/sdks/unifiedto/README.md +7 -0
- package/docs/sdks/user/README.md +501 -0
- package/docs/sdks/webhook/README.md +647 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/package.json +3 -1
- package/sdk/models/shared/crmcontact.d.ts +2 -0
- package/sdk/models/shared/crmcontact.d.ts.map +1 -1
- package/sdk/models/shared/crmcontact.js +4 -0
- package/sdk/models/shared/crmcontact.js.map +1 -1
- package/sdk/models/shared/crmlead.d.ts +2 -0
- package/sdk/models/shared/crmlead.d.ts.map +1 -1
- package/sdk/models/shared/crmlead.js +4 -0
- package/sdk/models/shared/crmlead.js.map +1 -1
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/kmspage.d.ts +5 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +7 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
- package/sdk/models/shared/kmspagemetadata.js +63 -0
- package/sdk/models/shared/kmspagemetadata.js.map +1 -0
- package/sdk/models/shared/kmsspace.d.ts +2 -0
- package/sdk/models/shared/kmsspace.d.ts.map +1 -1
- package/sdk/models/shared/kmsspace.js +4 -0
- package/sdk/models/shared/kmsspace.js.map +1 -1
- package/sdk/models/shared/security.d.ts +2 -2
- package/sdk/models/shared/security.d.ts.map +1 -1
- package/sdk/models/shared/security.js +2 -2
- package/sdk/models/shared/security.js.map +1 -1
- package/sdk/types/operations.d.ts +5 -3
- package/sdk/types/operations.d.ts.map +1 -1
- package/sdk/types/operations.js +3 -0
- package/sdk/types/operations.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/sdk/models/shared/crmcontact.ts +6 -0
- package/src/sdk/models/shared/crmlead.ts +6 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/kmspage.ts +16 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
- package/src/sdk/models/shared/kmsspace.ts +6 -0
- package/src/sdk/models/shared/security.ts +4 -4
- package/src/sdk/types/operations.ts +11 -5
|
@@ -0,0 +1,1601 @@
|
|
|
1
|
+
# Unified
|
|
2
|
+
(*unified*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createUnifiedConnection](#createunifiedconnection) - Create connection
|
|
9
|
+
* [createUnifiedWebhook](#createunifiedwebhook) - Create webhook subscription
|
|
10
|
+
* [getUnifiedApicall](#getunifiedapicall) - Retrieve specific API Call by its ID
|
|
11
|
+
* [getUnifiedConnection](#getunifiedconnection) - Retrieve connection
|
|
12
|
+
* [getUnifiedIntegrationAuth](#getunifiedintegrationauth) - Create connection indirectly
|
|
13
|
+
* [getUnifiedWebhook](#getunifiedwebhook) - Retrieve webhook by its ID
|
|
14
|
+
* [listUnifiedApicalls](#listunifiedapicalls) - Returns API Calls
|
|
15
|
+
* [listUnifiedConnections](#listunifiedconnections) - List all connections
|
|
16
|
+
* [listUnifiedIntegrationWorkspaces](#listunifiedintegrationworkspaces) - Returns all activated integrations in a workspace
|
|
17
|
+
* [listUnifiedIntegrations](#listunifiedintegrations) - Returns all integrations
|
|
18
|
+
* [listUnifiedIssues](#listunifiedissues) - List support issues
|
|
19
|
+
* [listUnifiedWebhooks](#listunifiedwebhooks) - Returns all registered webhooks
|
|
20
|
+
* [patchUnifiedConnection](#patchunifiedconnection) - Update connection
|
|
21
|
+
* [patchUnifiedWebhook](#patchunifiedwebhook) - Update webhook subscription
|
|
22
|
+
* [patchUnifiedWebhookTrigger](#patchunifiedwebhooktrigger) - Trigger webhook
|
|
23
|
+
* [removeUnifiedConnection](#removeunifiedconnection) - Remove connection
|
|
24
|
+
* [removeUnifiedWebhook](#removeunifiedwebhook) - Remove webhook subscription
|
|
25
|
+
* [updateUnifiedConnection](#updateunifiedconnection) - Update connection
|
|
26
|
+
* [updateUnifiedWebhook](#updateunifiedwebhook) - Update webhook subscription
|
|
27
|
+
* [updateUnifiedWebhookTrigger](#updateunifiedwebhooktrigger) - Trigger webhook
|
|
28
|
+
|
|
29
|
+
## createUnifiedConnection
|
|
30
|
+
|
|
31
|
+
Used only to import existing customer credentials; use "Create connection indirectly" instead
|
|
32
|
+
|
|
33
|
+
### Example Usage
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
37
|
+
|
|
38
|
+
const unifiedTo = new UnifiedTo({
|
|
39
|
+
security: {
|
|
40
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
41
|
+
},
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
async function run() {
|
|
45
|
+
const result = await unifiedTo.unified.createUnifiedConnection();
|
|
46
|
+
|
|
47
|
+
// Handle the result
|
|
48
|
+
console.log(result);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
run();
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Standalone function
|
|
55
|
+
|
|
56
|
+
The standalone function version of this method:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
60
|
+
import { unifiedCreateUnifiedConnection } from "@unified-api/typescript-sdk/funcs/unifiedCreateUnifiedConnection.js";
|
|
61
|
+
|
|
62
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
63
|
+
// You can create one instance of it to use across an application.
|
|
64
|
+
const unifiedTo = new UnifiedToCore({
|
|
65
|
+
security: {
|
|
66
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
67
|
+
},
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
async function run() {
|
|
71
|
+
const res = await unifiedCreateUnifiedConnection(unifiedTo);
|
|
72
|
+
|
|
73
|
+
if (!res.ok) {
|
|
74
|
+
throw res.error;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
const { value: result } = res;
|
|
78
|
+
|
|
79
|
+
// Handle the result
|
|
80
|
+
console.log(result);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
run();
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Parameters
|
|
87
|
+
|
|
88
|
+
| Parameter | Type | Required | Description |
|
|
89
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
90
|
+
| `request` | [shared.Connection](../../sdk/models/shared/connection.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
91
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
92
|
+
| `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. |
|
|
93
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
94
|
+
|
|
95
|
+
### Response
|
|
96
|
+
|
|
97
|
+
**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
|
|
98
|
+
|
|
99
|
+
### Errors
|
|
100
|
+
|
|
101
|
+
| Error Type | Status Code | Content Type |
|
|
102
|
+
| --------------- | --------------- | --------------- |
|
|
103
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
104
|
+
|
|
105
|
+
## createUnifiedWebhook
|
|
106
|
+
|
|
107
|
+
The data payload received by your server is described at https://docs.unified.to/unified/overview. The `interval` field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.
|
|
108
|
+
|
|
109
|
+
### Example Usage
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
113
|
+
|
|
114
|
+
const unifiedTo = new UnifiedTo({
|
|
115
|
+
security: {
|
|
116
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
117
|
+
},
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
async function run() {
|
|
121
|
+
const result = await unifiedTo.unified.createUnifiedWebhook({});
|
|
122
|
+
|
|
123
|
+
// Handle the result
|
|
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 { unifiedCreateUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/unifiedCreateUnifiedWebhook.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 unifiedCreateUnifiedWebhook(unifiedTo, {});
|
|
148
|
+
|
|
149
|
+
if (!res.ok) {
|
|
150
|
+
throw res.error;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
const { value: result } = res;
|
|
154
|
+
|
|
155
|
+
// Handle the result
|
|
156
|
+
console.log(result);
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
run();
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
| Parameter | Type | Required | Description |
|
|
165
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
166
|
+
| `request` | [operations.CreateUnifiedWebhookRequest](../../sdk/models/operations/createunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
167
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
168
|
+
| `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. |
|
|
169
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
170
|
+
|
|
171
|
+
### Response
|
|
172
|
+
|
|
173
|
+
**Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
|
|
174
|
+
|
|
175
|
+
### Errors
|
|
176
|
+
|
|
177
|
+
| Error Type | Status Code | Content Type |
|
|
178
|
+
| --------------- | --------------- | --------------- |
|
|
179
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
180
|
+
|
|
181
|
+
## getUnifiedApicall
|
|
182
|
+
|
|
183
|
+
Retrieve specific API Call by its ID
|
|
184
|
+
|
|
185
|
+
### Example Usage
|
|
186
|
+
|
|
187
|
+
```typescript
|
|
188
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
189
|
+
|
|
190
|
+
const unifiedTo = new UnifiedTo({
|
|
191
|
+
security: {
|
|
192
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
193
|
+
},
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
async function run() {
|
|
197
|
+
const result = await unifiedTo.unified.getUnifiedApicall({
|
|
198
|
+
id: "<id>",
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
// Handle the result
|
|
202
|
+
console.log(result);
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
run();
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Standalone function
|
|
209
|
+
|
|
210
|
+
The standalone function version of this method:
|
|
211
|
+
|
|
212
|
+
```typescript
|
|
213
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
214
|
+
import { unifiedGetUnifiedApicall } from "@unified-api/typescript-sdk/funcs/unifiedGetUnifiedApicall.js";
|
|
215
|
+
|
|
216
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
217
|
+
// You can create one instance of it to use across an application.
|
|
218
|
+
const unifiedTo = new UnifiedToCore({
|
|
219
|
+
security: {
|
|
220
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
221
|
+
},
|
|
222
|
+
});
|
|
223
|
+
|
|
224
|
+
async function run() {
|
|
225
|
+
const res = await unifiedGetUnifiedApicall(unifiedTo, {
|
|
226
|
+
id: "<id>",
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
if (!res.ok) {
|
|
230
|
+
throw res.error;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
const { value: result } = res;
|
|
234
|
+
|
|
235
|
+
// Handle the result
|
|
236
|
+
console.log(result);
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
run();
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### Parameters
|
|
243
|
+
|
|
244
|
+
| Parameter | Type | Required | Description |
|
|
245
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
246
|
+
| `request` | [operations.GetUnifiedApicallRequest](../../sdk/models/operations/getunifiedapicallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
247
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
248
|
+
| `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. |
|
|
249
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
250
|
+
|
|
251
|
+
### Response
|
|
252
|
+
|
|
253
|
+
**Promise\<[shared.ApiCall](../../sdk/models/shared/apicall.md)\>**
|
|
254
|
+
|
|
255
|
+
### Errors
|
|
256
|
+
|
|
257
|
+
| Error Type | Status Code | Content Type |
|
|
258
|
+
| --------------- | --------------- | --------------- |
|
|
259
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
260
|
+
|
|
261
|
+
## getUnifiedConnection
|
|
262
|
+
|
|
263
|
+
Retrieve connection
|
|
264
|
+
|
|
265
|
+
### Example Usage
|
|
266
|
+
|
|
267
|
+
```typescript
|
|
268
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
269
|
+
|
|
270
|
+
const unifiedTo = new UnifiedTo({
|
|
271
|
+
security: {
|
|
272
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
273
|
+
},
|
|
274
|
+
});
|
|
275
|
+
|
|
276
|
+
async function run() {
|
|
277
|
+
const result = await unifiedTo.unified.getUnifiedConnection({
|
|
278
|
+
id: "<id>",
|
|
279
|
+
});
|
|
280
|
+
|
|
281
|
+
// Handle the result
|
|
282
|
+
console.log(result);
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
run();
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### Standalone function
|
|
289
|
+
|
|
290
|
+
The standalone function version of this method:
|
|
291
|
+
|
|
292
|
+
```typescript
|
|
293
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
294
|
+
import { unifiedGetUnifiedConnection } from "@unified-api/typescript-sdk/funcs/unifiedGetUnifiedConnection.js";
|
|
295
|
+
|
|
296
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
297
|
+
// You can create one instance of it to use across an application.
|
|
298
|
+
const unifiedTo = new UnifiedToCore({
|
|
299
|
+
security: {
|
|
300
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
301
|
+
},
|
|
302
|
+
});
|
|
303
|
+
|
|
304
|
+
async function run() {
|
|
305
|
+
const res = await unifiedGetUnifiedConnection(unifiedTo, {
|
|
306
|
+
id: "<id>",
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
if (!res.ok) {
|
|
310
|
+
throw res.error;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
const { value: result } = res;
|
|
314
|
+
|
|
315
|
+
// Handle the result
|
|
316
|
+
console.log(result);
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
run();
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### Parameters
|
|
323
|
+
|
|
324
|
+
| Parameter | Type | Required | Description |
|
|
325
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
326
|
+
| `request` | [operations.GetUnifiedConnectionRequest](../../sdk/models/operations/getunifiedconnectionrequest.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.Connection](../../sdk/models/shared/connection.md)\>**
|
|
334
|
+
|
|
335
|
+
### Errors
|
|
336
|
+
|
|
337
|
+
| Error Type | Status Code | Content Type |
|
|
338
|
+
| --------------- | --------------- | --------------- |
|
|
339
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
340
|
+
|
|
341
|
+
## getUnifiedIntegrationAuth
|
|
342
|
+
|
|
343
|
+
Returns an authorization URL for the specified integration. Once a successful authorization occurs, a new connection is created.
|
|
344
|
+
|
|
345
|
+
### Example Usage
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
349
|
+
|
|
350
|
+
const unifiedTo = new UnifiedTo({
|
|
351
|
+
security: {
|
|
352
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
353
|
+
},
|
|
354
|
+
});
|
|
355
|
+
|
|
356
|
+
async function run() {
|
|
357
|
+
const result = await unifiedTo.unified.getUnifiedIntegrationAuth({
|
|
358
|
+
integrationType: "<value>",
|
|
359
|
+
workspaceId: "<value>",
|
|
360
|
+
});
|
|
361
|
+
|
|
362
|
+
// Handle the result
|
|
363
|
+
console.log(result);
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
run();
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Standalone function
|
|
370
|
+
|
|
371
|
+
The standalone function version of this method:
|
|
372
|
+
|
|
373
|
+
```typescript
|
|
374
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
375
|
+
import { unifiedGetUnifiedIntegrationAuth } from "@unified-api/typescript-sdk/funcs/unifiedGetUnifiedIntegrationAuth.js";
|
|
376
|
+
|
|
377
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
378
|
+
// You can create one instance of it to use across an application.
|
|
379
|
+
const unifiedTo = new UnifiedToCore({
|
|
380
|
+
security: {
|
|
381
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
382
|
+
},
|
|
383
|
+
});
|
|
384
|
+
|
|
385
|
+
async function run() {
|
|
386
|
+
const res = await unifiedGetUnifiedIntegrationAuth(unifiedTo, {
|
|
387
|
+
integrationType: "<value>",
|
|
388
|
+
workspaceId: "<value>",
|
|
389
|
+
});
|
|
390
|
+
|
|
391
|
+
if (!res.ok) {
|
|
392
|
+
throw res.error;
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
const { value: result } = res;
|
|
396
|
+
|
|
397
|
+
// Handle the result
|
|
398
|
+
console.log(result);
|
|
399
|
+
}
|
|
400
|
+
|
|
401
|
+
run();
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
### Parameters
|
|
405
|
+
|
|
406
|
+
| Parameter | Type | Required | Description |
|
|
407
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
408
|
+
| `request` | [operations.GetUnifiedIntegrationAuthRequest](../../sdk/models/operations/getunifiedintegrationauthrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
409
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
410
|
+
| `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. |
|
|
411
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
412
|
+
|
|
413
|
+
### Response
|
|
414
|
+
|
|
415
|
+
**Promise\<[string](../../models/.md)\>**
|
|
416
|
+
|
|
417
|
+
### Errors
|
|
418
|
+
|
|
419
|
+
| Error Type | Status Code | Content Type |
|
|
420
|
+
| --------------- | --------------- | --------------- |
|
|
421
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
422
|
+
|
|
423
|
+
## getUnifiedWebhook
|
|
424
|
+
|
|
425
|
+
Retrieve webhook by its ID
|
|
426
|
+
|
|
427
|
+
### Example Usage
|
|
428
|
+
|
|
429
|
+
```typescript
|
|
430
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
431
|
+
|
|
432
|
+
const unifiedTo = new UnifiedTo({
|
|
433
|
+
security: {
|
|
434
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
435
|
+
},
|
|
436
|
+
});
|
|
437
|
+
|
|
438
|
+
async function run() {
|
|
439
|
+
const result = await unifiedTo.unified.getUnifiedWebhook({
|
|
440
|
+
id: "<id>",
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
// Handle the result
|
|
444
|
+
console.log(result);
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
run();
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### Standalone function
|
|
451
|
+
|
|
452
|
+
The standalone function version of this method:
|
|
453
|
+
|
|
454
|
+
```typescript
|
|
455
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
456
|
+
import { unifiedGetUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/unifiedGetUnifiedWebhook.js";
|
|
457
|
+
|
|
458
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
459
|
+
// You can create one instance of it to use across an application.
|
|
460
|
+
const unifiedTo = new UnifiedToCore({
|
|
461
|
+
security: {
|
|
462
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
463
|
+
},
|
|
464
|
+
});
|
|
465
|
+
|
|
466
|
+
async function run() {
|
|
467
|
+
const res = await unifiedGetUnifiedWebhook(unifiedTo, {
|
|
468
|
+
id: "<id>",
|
|
469
|
+
});
|
|
470
|
+
|
|
471
|
+
if (!res.ok) {
|
|
472
|
+
throw res.error;
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
const { value: result } = res;
|
|
476
|
+
|
|
477
|
+
// Handle the result
|
|
478
|
+
console.log(result);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
run();
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Parameters
|
|
485
|
+
|
|
486
|
+
| Parameter | Type | Required | Description |
|
|
487
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
488
|
+
| `request` | [operations.GetUnifiedWebhookRequest](../../sdk/models/operations/getunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
489
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
490
|
+
| `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. |
|
|
491
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
492
|
+
|
|
493
|
+
### Response
|
|
494
|
+
|
|
495
|
+
**Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
|
|
496
|
+
|
|
497
|
+
### Errors
|
|
498
|
+
|
|
499
|
+
| Error Type | Status Code | Content Type |
|
|
500
|
+
| --------------- | --------------- | --------------- |
|
|
501
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
502
|
+
|
|
503
|
+
## listUnifiedApicalls
|
|
504
|
+
|
|
505
|
+
Returns API Calls
|
|
506
|
+
|
|
507
|
+
### Example Usage
|
|
508
|
+
|
|
509
|
+
```typescript
|
|
510
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
511
|
+
|
|
512
|
+
const unifiedTo = new UnifiedTo({
|
|
513
|
+
security: {
|
|
514
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
515
|
+
},
|
|
516
|
+
});
|
|
517
|
+
|
|
518
|
+
async function run() {
|
|
519
|
+
const result = await unifiedTo.unified.listUnifiedApicalls({});
|
|
520
|
+
|
|
521
|
+
// Handle the result
|
|
522
|
+
console.log(result);
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
run();
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
### Standalone function
|
|
529
|
+
|
|
530
|
+
The standalone function version of this method:
|
|
531
|
+
|
|
532
|
+
```typescript
|
|
533
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
534
|
+
import { unifiedListUnifiedApicalls } from "@unified-api/typescript-sdk/funcs/unifiedListUnifiedApicalls.js";
|
|
535
|
+
|
|
536
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
537
|
+
// You can create one instance of it to use across an application.
|
|
538
|
+
const unifiedTo = new UnifiedToCore({
|
|
539
|
+
security: {
|
|
540
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
541
|
+
},
|
|
542
|
+
});
|
|
543
|
+
|
|
544
|
+
async function run() {
|
|
545
|
+
const res = await unifiedListUnifiedApicalls(unifiedTo, {});
|
|
546
|
+
|
|
547
|
+
if (!res.ok) {
|
|
548
|
+
throw res.error;
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
const { value: result } = res;
|
|
552
|
+
|
|
553
|
+
// Handle the result
|
|
554
|
+
console.log(result);
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
run();
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
### Parameters
|
|
561
|
+
|
|
562
|
+
| Parameter | Type | Required | Description |
|
|
563
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
564
|
+
| `request` | [operations.ListUnifiedApicallsRequest](../../sdk/models/operations/listunifiedapicallsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
565
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
566
|
+
| `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. |
|
|
567
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
568
|
+
|
|
569
|
+
### Response
|
|
570
|
+
|
|
571
|
+
**Promise\<[shared.ApiCall[]](../../models/.md)\>**
|
|
572
|
+
|
|
573
|
+
### Errors
|
|
574
|
+
|
|
575
|
+
| Error Type | Status Code | Content Type |
|
|
576
|
+
| --------------- | --------------- | --------------- |
|
|
577
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
578
|
+
|
|
579
|
+
## listUnifiedConnections
|
|
580
|
+
|
|
581
|
+
List all connections
|
|
582
|
+
|
|
583
|
+
### Example Usage
|
|
584
|
+
|
|
585
|
+
```typescript
|
|
586
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
587
|
+
|
|
588
|
+
const unifiedTo = new UnifiedTo({
|
|
589
|
+
security: {
|
|
590
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
591
|
+
},
|
|
592
|
+
});
|
|
593
|
+
|
|
594
|
+
async function run() {
|
|
595
|
+
const result = await unifiedTo.unified.listUnifiedConnections({});
|
|
596
|
+
|
|
597
|
+
// Handle the result
|
|
598
|
+
console.log(result);
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
run();
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
### Standalone function
|
|
605
|
+
|
|
606
|
+
The standalone function version of this method:
|
|
607
|
+
|
|
608
|
+
```typescript
|
|
609
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
610
|
+
import { unifiedListUnifiedConnections } from "@unified-api/typescript-sdk/funcs/unifiedListUnifiedConnections.js";
|
|
611
|
+
|
|
612
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
613
|
+
// You can create one instance of it to use across an application.
|
|
614
|
+
const unifiedTo = new UnifiedToCore({
|
|
615
|
+
security: {
|
|
616
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
617
|
+
},
|
|
618
|
+
});
|
|
619
|
+
|
|
620
|
+
async function run() {
|
|
621
|
+
const res = await unifiedListUnifiedConnections(unifiedTo, {});
|
|
622
|
+
|
|
623
|
+
if (!res.ok) {
|
|
624
|
+
throw res.error;
|
|
625
|
+
}
|
|
626
|
+
|
|
627
|
+
const { value: result } = res;
|
|
628
|
+
|
|
629
|
+
// Handle the result
|
|
630
|
+
console.log(result);
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
run();
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
### Parameters
|
|
637
|
+
|
|
638
|
+
| Parameter | Type | Required | Description |
|
|
639
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
640
|
+
| `request` | [operations.ListUnifiedConnectionsRequest](../../sdk/models/operations/listunifiedconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
641
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
642
|
+
| `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. |
|
|
643
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
644
|
+
|
|
645
|
+
### Response
|
|
646
|
+
|
|
647
|
+
**Promise\<[shared.Connection[]](../../models/.md)\>**
|
|
648
|
+
|
|
649
|
+
### Errors
|
|
650
|
+
|
|
651
|
+
| Error Type | Status Code | Content Type |
|
|
652
|
+
| --------------- | --------------- | --------------- |
|
|
653
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
654
|
+
|
|
655
|
+
## listUnifiedIntegrationWorkspaces
|
|
656
|
+
|
|
657
|
+
No authentication required as this is to be used by front-end interface
|
|
658
|
+
|
|
659
|
+
### Example Usage
|
|
660
|
+
|
|
661
|
+
```typescript
|
|
662
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
663
|
+
|
|
664
|
+
const unifiedTo = new UnifiedTo({
|
|
665
|
+
security: {
|
|
666
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
667
|
+
},
|
|
668
|
+
});
|
|
669
|
+
|
|
670
|
+
async function run() {
|
|
671
|
+
const result = await unifiedTo.unified.listUnifiedIntegrationWorkspaces({
|
|
672
|
+
workspaceId: "<value>",
|
|
673
|
+
});
|
|
674
|
+
|
|
675
|
+
// Handle the result
|
|
676
|
+
console.log(result);
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
run();
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
### Standalone function
|
|
683
|
+
|
|
684
|
+
The standalone function version of this method:
|
|
685
|
+
|
|
686
|
+
```typescript
|
|
687
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
688
|
+
import { unifiedListUnifiedIntegrationWorkspaces } from "@unified-api/typescript-sdk/funcs/unifiedListUnifiedIntegrationWorkspaces.js";
|
|
689
|
+
|
|
690
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
691
|
+
// You can create one instance of it to use across an application.
|
|
692
|
+
const unifiedTo = new UnifiedToCore({
|
|
693
|
+
security: {
|
|
694
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
695
|
+
},
|
|
696
|
+
});
|
|
697
|
+
|
|
698
|
+
async function run() {
|
|
699
|
+
const res = await unifiedListUnifiedIntegrationWorkspaces(unifiedTo, {
|
|
700
|
+
workspaceId: "<value>",
|
|
701
|
+
});
|
|
702
|
+
|
|
703
|
+
if (!res.ok) {
|
|
704
|
+
throw res.error;
|
|
705
|
+
}
|
|
706
|
+
|
|
707
|
+
const { value: result } = res;
|
|
708
|
+
|
|
709
|
+
// Handle the result
|
|
710
|
+
console.log(result);
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
run();
|
|
714
|
+
```
|
|
715
|
+
|
|
716
|
+
### Parameters
|
|
717
|
+
|
|
718
|
+
| Parameter | Type | Required | Description |
|
|
719
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
720
|
+
| `request` | [operations.ListUnifiedIntegrationWorkspacesRequest](../../sdk/models/operations/listunifiedintegrationworkspacesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
721
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
722
|
+
| `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. |
|
|
723
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
724
|
+
|
|
725
|
+
### Response
|
|
726
|
+
|
|
727
|
+
**Promise\<[shared.Integration[]](../../models/.md)\>**
|
|
728
|
+
|
|
729
|
+
### Errors
|
|
730
|
+
|
|
731
|
+
| Error Type | Status Code | Content Type |
|
|
732
|
+
| --------------- | --------------- | --------------- |
|
|
733
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
734
|
+
|
|
735
|
+
## listUnifiedIntegrations
|
|
736
|
+
|
|
737
|
+
Returns all integrations
|
|
738
|
+
|
|
739
|
+
### Example Usage
|
|
740
|
+
|
|
741
|
+
```typescript
|
|
742
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
743
|
+
|
|
744
|
+
const unifiedTo = new UnifiedTo({
|
|
745
|
+
security: {
|
|
746
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
747
|
+
},
|
|
748
|
+
});
|
|
749
|
+
|
|
750
|
+
async function run() {
|
|
751
|
+
const result = await unifiedTo.unified.listUnifiedIntegrations({});
|
|
752
|
+
|
|
753
|
+
// Handle the result
|
|
754
|
+
console.log(result);
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
run();
|
|
758
|
+
```
|
|
759
|
+
|
|
760
|
+
### Standalone function
|
|
761
|
+
|
|
762
|
+
The standalone function version of this method:
|
|
763
|
+
|
|
764
|
+
```typescript
|
|
765
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
766
|
+
import { unifiedListUnifiedIntegrations } from "@unified-api/typescript-sdk/funcs/unifiedListUnifiedIntegrations.js";
|
|
767
|
+
|
|
768
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
769
|
+
// You can create one instance of it to use across an application.
|
|
770
|
+
const unifiedTo = new UnifiedToCore({
|
|
771
|
+
security: {
|
|
772
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
773
|
+
},
|
|
774
|
+
});
|
|
775
|
+
|
|
776
|
+
async function run() {
|
|
777
|
+
const res = await unifiedListUnifiedIntegrations(unifiedTo, {});
|
|
778
|
+
|
|
779
|
+
if (!res.ok) {
|
|
780
|
+
throw res.error;
|
|
781
|
+
}
|
|
782
|
+
|
|
783
|
+
const { value: result } = res;
|
|
784
|
+
|
|
785
|
+
// Handle the result
|
|
786
|
+
console.log(result);
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
run();
|
|
790
|
+
```
|
|
791
|
+
|
|
792
|
+
### Parameters
|
|
793
|
+
|
|
794
|
+
| Parameter | Type | Required | Description |
|
|
795
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
796
|
+
| `request` | [operations.ListUnifiedIntegrationsRequest](../../sdk/models/operations/listunifiedintegrationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
797
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
798
|
+
| `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. |
|
|
799
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
800
|
+
|
|
801
|
+
### Response
|
|
802
|
+
|
|
803
|
+
**Promise\<[shared.Integration[]](../../models/.md)\>**
|
|
804
|
+
|
|
805
|
+
### Errors
|
|
806
|
+
|
|
807
|
+
| Error Type | Status Code | Content Type |
|
|
808
|
+
| --------------- | --------------- | --------------- |
|
|
809
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
810
|
+
|
|
811
|
+
## listUnifiedIssues
|
|
812
|
+
|
|
813
|
+
List support issues
|
|
814
|
+
|
|
815
|
+
### Example Usage
|
|
816
|
+
|
|
817
|
+
```typescript
|
|
818
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
819
|
+
|
|
820
|
+
const unifiedTo = new UnifiedTo({
|
|
821
|
+
security: {
|
|
822
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
823
|
+
},
|
|
824
|
+
});
|
|
825
|
+
|
|
826
|
+
async function run() {
|
|
827
|
+
const result = await unifiedTo.unified.listUnifiedIssues({});
|
|
828
|
+
|
|
829
|
+
// Handle the result
|
|
830
|
+
console.log(result);
|
|
831
|
+
}
|
|
832
|
+
|
|
833
|
+
run();
|
|
834
|
+
```
|
|
835
|
+
|
|
836
|
+
### Standalone function
|
|
837
|
+
|
|
838
|
+
The standalone function version of this method:
|
|
839
|
+
|
|
840
|
+
```typescript
|
|
841
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
842
|
+
import { unifiedListUnifiedIssues } from "@unified-api/typescript-sdk/funcs/unifiedListUnifiedIssues.js";
|
|
843
|
+
|
|
844
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
845
|
+
// You can create one instance of it to use across an application.
|
|
846
|
+
const unifiedTo = new UnifiedToCore({
|
|
847
|
+
security: {
|
|
848
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
849
|
+
},
|
|
850
|
+
});
|
|
851
|
+
|
|
852
|
+
async function run() {
|
|
853
|
+
const res = await unifiedListUnifiedIssues(unifiedTo, {});
|
|
854
|
+
|
|
855
|
+
if (!res.ok) {
|
|
856
|
+
throw res.error;
|
|
857
|
+
}
|
|
858
|
+
|
|
859
|
+
const { value: result } = res;
|
|
860
|
+
|
|
861
|
+
// Handle the result
|
|
862
|
+
console.log(result);
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
run();
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
### Parameters
|
|
869
|
+
|
|
870
|
+
| Parameter | Type | Required | Description |
|
|
871
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
872
|
+
| `request` | [operations.ListUnifiedIssuesRequest](../../sdk/models/operations/listunifiedissuesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
873
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
874
|
+
| `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. |
|
|
875
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
876
|
+
|
|
877
|
+
### Response
|
|
878
|
+
|
|
879
|
+
**Promise\<[shared.Issue[]](../../models/.md)\>**
|
|
880
|
+
|
|
881
|
+
### Errors
|
|
882
|
+
|
|
883
|
+
| Error Type | Status Code | Content Type |
|
|
884
|
+
| --------------- | --------------- | --------------- |
|
|
885
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
886
|
+
|
|
887
|
+
## listUnifiedWebhooks
|
|
888
|
+
|
|
889
|
+
Returns all registered webhooks
|
|
890
|
+
|
|
891
|
+
### Example Usage
|
|
892
|
+
|
|
893
|
+
```typescript
|
|
894
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
895
|
+
|
|
896
|
+
const unifiedTo = new UnifiedTo({
|
|
897
|
+
security: {
|
|
898
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
899
|
+
},
|
|
900
|
+
});
|
|
901
|
+
|
|
902
|
+
async function run() {
|
|
903
|
+
const result = await unifiedTo.unified.listUnifiedWebhooks({});
|
|
904
|
+
|
|
905
|
+
// Handle the result
|
|
906
|
+
console.log(result);
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
run();
|
|
910
|
+
```
|
|
911
|
+
|
|
912
|
+
### Standalone function
|
|
913
|
+
|
|
914
|
+
The standalone function version of this method:
|
|
915
|
+
|
|
916
|
+
```typescript
|
|
917
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
918
|
+
import { unifiedListUnifiedWebhooks } from "@unified-api/typescript-sdk/funcs/unifiedListUnifiedWebhooks.js";
|
|
919
|
+
|
|
920
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
921
|
+
// You can create one instance of it to use across an application.
|
|
922
|
+
const unifiedTo = new UnifiedToCore({
|
|
923
|
+
security: {
|
|
924
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
925
|
+
},
|
|
926
|
+
});
|
|
927
|
+
|
|
928
|
+
async function run() {
|
|
929
|
+
const res = await unifiedListUnifiedWebhooks(unifiedTo, {});
|
|
930
|
+
|
|
931
|
+
if (!res.ok) {
|
|
932
|
+
throw res.error;
|
|
933
|
+
}
|
|
934
|
+
|
|
935
|
+
const { value: result } = res;
|
|
936
|
+
|
|
937
|
+
// Handle the result
|
|
938
|
+
console.log(result);
|
|
939
|
+
}
|
|
940
|
+
|
|
941
|
+
run();
|
|
942
|
+
```
|
|
943
|
+
|
|
944
|
+
### Parameters
|
|
945
|
+
|
|
946
|
+
| Parameter | Type | Required | Description |
|
|
947
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
948
|
+
| `request` | [operations.ListUnifiedWebhooksRequest](../../sdk/models/operations/listunifiedwebhooksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
949
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
950
|
+
| `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. |
|
|
951
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
952
|
+
|
|
953
|
+
### Response
|
|
954
|
+
|
|
955
|
+
**Promise\<[shared.Webhook[]](../../models/.md)\>**
|
|
956
|
+
|
|
957
|
+
### Errors
|
|
958
|
+
|
|
959
|
+
| Error Type | Status Code | Content Type |
|
|
960
|
+
| --------------- | --------------- | --------------- |
|
|
961
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
962
|
+
|
|
963
|
+
## patchUnifiedConnection
|
|
964
|
+
|
|
965
|
+
Update connection
|
|
966
|
+
|
|
967
|
+
### Example Usage
|
|
968
|
+
|
|
969
|
+
```typescript
|
|
970
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
971
|
+
|
|
972
|
+
const unifiedTo = new UnifiedTo({
|
|
973
|
+
security: {
|
|
974
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
975
|
+
},
|
|
976
|
+
});
|
|
977
|
+
|
|
978
|
+
async function run() {
|
|
979
|
+
const result = await unifiedTo.unified.patchUnifiedConnection({
|
|
980
|
+
id: "<id>",
|
|
981
|
+
});
|
|
982
|
+
|
|
983
|
+
// Handle the result
|
|
984
|
+
console.log(result);
|
|
985
|
+
}
|
|
986
|
+
|
|
987
|
+
run();
|
|
988
|
+
```
|
|
989
|
+
|
|
990
|
+
### Standalone function
|
|
991
|
+
|
|
992
|
+
The standalone function version of this method:
|
|
993
|
+
|
|
994
|
+
```typescript
|
|
995
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
996
|
+
import { unifiedPatchUnifiedConnection } from "@unified-api/typescript-sdk/funcs/unifiedPatchUnifiedConnection.js";
|
|
997
|
+
|
|
998
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
999
|
+
// You can create one instance of it to use across an application.
|
|
1000
|
+
const unifiedTo = new UnifiedToCore({
|
|
1001
|
+
security: {
|
|
1002
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1003
|
+
},
|
|
1004
|
+
});
|
|
1005
|
+
|
|
1006
|
+
async function run() {
|
|
1007
|
+
const res = await unifiedPatchUnifiedConnection(unifiedTo, {
|
|
1008
|
+
id: "<id>",
|
|
1009
|
+
});
|
|
1010
|
+
|
|
1011
|
+
if (!res.ok) {
|
|
1012
|
+
throw res.error;
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
const { value: result } = res;
|
|
1016
|
+
|
|
1017
|
+
// Handle the result
|
|
1018
|
+
console.log(result);
|
|
1019
|
+
}
|
|
1020
|
+
|
|
1021
|
+
run();
|
|
1022
|
+
```
|
|
1023
|
+
|
|
1024
|
+
### Parameters
|
|
1025
|
+
|
|
1026
|
+
| Parameter | Type | Required | Description |
|
|
1027
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1028
|
+
| `request` | [operations.PatchUnifiedConnectionRequest](../../sdk/models/operations/patchunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1029
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1030
|
+
| `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. |
|
|
1031
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1032
|
+
|
|
1033
|
+
### Response
|
|
1034
|
+
|
|
1035
|
+
**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
|
|
1036
|
+
|
|
1037
|
+
### Errors
|
|
1038
|
+
|
|
1039
|
+
| Error Type | Status Code | Content Type |
|
|
1040
|
+
| --------------- | --------------- | --------------- |
|
|
1041
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1042
|
+
|
|
1043
|
+
## patchUnifiedWebhook
|
|
1044
|
+
|
|
1045
|
+
Update webhook subscription
|
|
1046
|
+
|
|
1047
|
+
### Example Usage
|
|
1048
|
+
|
|
1049
|
+
```typescript
|
|
1050
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1051
|
+
|
|
1052
|
+
const unifiedTo = new UnifiedTo({
|
|
1053
|
+
security: {
|
|
1054
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1055
|
+
},
|
|
1056
|
+
});
|
|
1057
|
+
|
|
1058
|
+
async function run() {
|
|
1059
|
+
const result = await unifiedTo.unified.patchUnifiedWebhook({
|
|
1060
|
+
id: "<id>",
|
|
1061
|
+
});
|
|
1062
|
+
|
|
1063
|
+
// Handle the result
|
|
1064
|
+
console.log(result);
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
run();
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
### Standalone function
|
|
1071
|
+
|
|
1072
|
+
The standalone function version of this method:
|
|
1073
|
+
|
|
1074
|
+
```typescript
|
|
1075
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1076
|
+
import { unifiedPatchUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/unifiedPatchUnifiedWebhook.js";
|
|
1077
|
+
|
|
1078
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1079
|
+
// You can create one instance of it to use across an application.
|
|
1080
|
+
const unifiedTo = new UnifiedToCore({
|
|
1081
|
+
security: {
|
|
1082
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1083
|
+
},
|
|
1084
|
+
});
|
|
1085
|
+
|
|
1086
|
+
async function run() {
|
|
1087
|
+
const res = await unifiedPatchUnifiedWebhook(unifiedTo, {
|
|
1088
|
+
id: "<id>",
|
|
1089
|
+
});
|
|
1090
|
+
|
|
1091
|
+
if (!res.ok) {
|
|
1092
|
+
throw res.error;
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
const { value: result } = res;
|
|
1096
|
+
|
|
1097
|
+
// Handle the result
|
|
1098
|
+
console.log(result);
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
run();
|
|
1102
|
+
```
|
|
1103
|
+
|
|
1104
|
+
### Parameters
|
|
1105
|
+
|
|
1106
|
+
| Parameter | Type | Required | Description |
|
|
1107
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1108
|
+
| `request` | [operations.PatchUnifiedWebhookRequest](../../sdk/models/operations/patchunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1109
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1110
|
+
| `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. |
|
|
1111
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1112
|
+
|
|
1113
|
+
### Response
|
|
1114
|
+
|
|
1115
|
+
**Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
|
|
1116
|
+
|
|
1117
|
+
### Errors
|
|
1118
|
+
|
|
1119
|
+
| Error Type | Status Code | Content Type |
|
|
1120
|
+
| --------------- | --------------- | --------------- |
|
|
1121
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1122
|
+
|
|
1123
|
+
## patchUnifiedWebhookTrigger
|
|
1124
|
+
|
|
1125
|
+
Trigger webhook
|
|
1126
|
+
|
|
1127
|
+
### Example Usage
|
|
1128
|
+
|
|
1129
|
+
```typescript
|
|
1130
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1131
|
+
|
|
1132
|
+
const unifiedTo = new UnifiedTo({
|
|
1133
|
+
security: {
|
|
1134
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1135
|
+
},
|
|
1136
|
+
});
|
|
1137
|
+
|
|
1138
|
+
async function run() {
|
|
1139
|
+
const result = await unifiedTo.unified.patchUnifiedWebhookTrigger({
|
|
1140
|
+
id: "<id>",
|
|
1141
|
+
});
|
|
1142
|
+
|
|
1143
|
+
// Handle the result
|
|
1144
|
+
console.log(result);
|
|
1145
|
+
}
|
|
1146
|
+
|
|
1147
|
+
run();
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
### Standalone function
|
|
1151
|
+
|
|
1152
|
+
The standalone function version of this method:
|
|
1153
|
+
|
|
1154
|
+
```typescript
|
|
1155
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1156
|
+
import { unifiedPatchUnifiedWebhookTrigger } from "@unified-api/typescript-sdk/funcs/unifiedPatchUnifiedWebhookTrigger.js";
|
|
1157
|
+
|
|
1158
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1159
|
+
// You can create one instance of it to use across an application.
|
|
1160
|
+
const unifiedTo = new UnifiedToCore({
|
|
1161
|
+
security: {
|
|
1162
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1163
|
+
},
|
|
1164
|
+
});
|
|
1165
|
+
|
|
1166
|
+
async function run() {
|
|
1167
|
+
const res = await unifiedPatchUnifiedWebhookTrigger(unifiedTo, {
|
|
1168
|
+
id: "<id>",
|
|
1169
|
+
});
|
|
1170
|
+
|
|
1171
|
+
if (!res.ok) {
|
|
1172
|
+
throw res.error;
|
|
1173
|
+
}
|
|
1174
|
+
|
|
1175
|
+
const { value: result } = res;
|
|
1176
|
+
|
|
1177
|
+
// Handle the result
|
|
1178
|
+
console.log(result);
|
|
1179
|
+
}
|
|
1180
|
+
|
|
1181
|
+
run();
|
|
1182
|
+
```
|
|
1183
|
+
|
|
1184
|
+
### Parameters
|
|
1185
|
+
|
|
1186
|
+
| Parameter | Type | Required | Description |
|
|
1187
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1188
|
+
| `request` | [operations.PatchUnifiedWebhookTriggerRequest](../../sdk/models/operations/patchunifiedwebhooktriggerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1189
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1190
|
+
| `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. |
|
|
1191
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1192
|
+
|
|
1193
|
+
### Response
|
|
1194
|
+
|
|
1195
|
+
**Promise\<[operations.PatchUnifiedWebhookTriggerResponse](../../sdk/models/operations/patchunifiedwebhooktriggerresponse.md)\>**
|
|
1196
|
+
|
|
1197
|
+
### Errors
|
|
1198
|
+
|
|
1199
|
+
| Error Type | Status Code | Content Type |
|
|
1200
|
+
| --------------- | --------------- | --------------- |
|
|
1201
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1202
|
+
|
|
1203
|
+
## removeUnifiedConnection
|
|
1204
|
+
|
|
1205
|
+
Remove connection
|
|
1206
|
+
|
|
1207
|
+
### Example Usage
|
|
1208
|
+
|
|
1209
|
+
```typescript
|
|
1210
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1211
|
+
|
|
1212
|
+
const unifiedTo = new UnifiedTo({
|
|
1213
|
+
security: {
|
|
1214
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1215
|
+
},
|
|
1216
|
+
});
|
|
1217
|
+
|
|
1218
|
+
async function run() {
|
|
1219
|
+
const result = await unifiedTo.unified.removeUnifiedConnection({
|
|
1220
|
+
id: "<id>",
|
|
1221
|
+
});
|
|
1222
|
+
|
|
1223
|
+
// Handle the result
|
|
1224
|
+
console.log(result);
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1227
|
+
run();
|
|
1228
|
+
```
|
|
1229
|
+
|
|
1230
|
+
### Standalone function
|
|
1231
|
+
|
|
1232
|
+
The standalone function version of this method:
|
|
1233
|
+
|
|
1234
|
+
```typescript
|
|
1235
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1236
|
+
import { unifiedRemoveUnifiedConnection } from "@unified-api/typescript-sdk/funcs/unifiedRemoveUnifiedConnection.js";
|
|
1237
|
+
|
|
1238
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1239
|
+
// You can create one instance of it to use across an application.
|
|
1240
|
+
const unifiedTo = new UnifiedToCore({
|
|
1241
|
+
security: {
|
|
1242
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1243
|
+
},
|
|
1244
|
+
});
|
|
1245
|
+
|
|
1246
|
+
async function run() {
|
|
1247
|
+
const res = await unifiedRemoveUnifiedConnection(unifiedTo, {
|
|
1248
|
+
id: "<id>",
|
|
1249
|
+
});
|
|
1250
|
+
|
|
1251
|
+
if (!res.ok) {
|
|
1252
|
+
throw res.error;
|
|
1253
|
+
}
|
|
1254
|
+
|
|
1255
|
+
const { value: result } = res;
|
|
1256
|
+
|
|
1257
|
+
// Handle the result
|
|
1258
|
+
console.log(result);
|
|
1259
|
+
}
|
|
1260
|
+
|
|
1261
|
+
run();
|
|
1262
|
+
```
|
|
1263
|
+
|
|
1264
|
+
### Parameters
|
|
1265
|
+
|
|
1266
|
+
| Parameter | Type | Required | Description |
|
|
1267
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1268
|
+
| `request` | [operations.RemoveUnifiedConnectionRequest](../../sdk/models/operations/removeunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1269
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1270
|
+
| `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. |
|
|
1271
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1272
|
+
|
|
1273
|
+
### Response
|
|
1274
|
+
|
|
1275
|
+
**Promise\<[operations.RemoveUnifiedConnectionResponse](../../sdk/models/operations/removeunifiedconnectionresponse.md)\>**
|
|
1276
|
+
|
|
1277
|
+
### Errors
|
|
1278
|
+
|
|
1279
|
+
| Error Type | Status Code | Content Type |
|
|
1280
|
+
| --------------- | --------------- | --------------- |
|
|
1281
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1282
|
+
|
|
1283
|
+
## removeUnifiedWebhook
|
|
1284
|
+
|
|
1285
|
+
Remove webhook subscription
|
|
1286
|
+
|
|
1287
|
+
### Example Usage
|
|
1288
|
+
|
|
1289
|
+
```typescript
|
|
1290
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1291
|
+
|
|
1292
|
+
const unifiedTo = new UnifiedTo({
|
|
1293
|
+
security: {
|
|
1294
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1295
|
+
},
|
|
1296
|
+
});
|
|
1297
|
+
|
|
1298
|
+
async function run() {
|
|
1299
|
+
const result = await unifiedTo.unified.removeUnifiedWebhook({
|
|
1300
|
+
id: "<id>",
|
|
1301
|
+
});
|
|
1302
|
+
|
|
1303
|
+
// Handle the result
|
|
1304
|
+
console.log(result);
|
|
1305
|
+
}
|
|
1306
|
+
|
|
1307
|
+
run();
|
|
1308
|
+
```
|
|
1309
|
+
|
|
1310
|
+
### Standalone function
|
|
1311
|
+
|
|
1312
|
+
The standalone function version of this method:
|
|
1313
|
+
|
|
1314
|
+
```typescript
|
|
1315
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1316
|
+
import { unifiedRemoveUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/unifiedRemoveUnifiedWebhook.js";
|
|
1317
|
+
|
|
1318
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1319
|
+
// You can create one instance of it to use across an application.
|
|
1320
|
+
const unifiedTo = new UnifiedToCore({
|
|
1321
|
+
security: {
|
|
1322
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1323
|
+
},
|
|
1324
|
+
});
|
|
1325
|
+
|
|
1326
|
+
async function run() {
|
|
1327
|
+
const res = await unifiedRemoveUnifiedWebhook(unifiedTo, {
|
|
1328
|
+
id: "<id>",
|
|
1329
|
+
});
|
|
1330
|
+
|
|
1331
|
+
if (!res.ok) {
|
|
1332
|
+
throw res.error;
|
|
1333
|
+
}
|
|
1334
|
+
|
|
1335
|
+
const { value: result } = res;
|
|
1336
|
+
|
|
1337
|
+
// Handle the result
|
|
1338
|
+
console.log(result);
|
|
1339
|
+
}
|
|
1340
|
+
|
|
1341
|
+
run();
|
|
1342
|
+
```
|
|
1343
|
+
|
|
1344
|
+
### Parameters
|
|
1345
|
+
|
|
1346
|
+
| Parameter | Type | Required | Description |
|
|
1347
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1348
|
+
| `request` | [operations.RemoveUnifiedWebhookRequest](../../sdk/models/operations/removeunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1349
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1350
|
+
| `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. |
|
|
1351
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1352
|
+
|
|
1353
|
+
### Response
|
|
1354
|
+
|
|
1355
|
+
**Promise\<[operations.RemoveUnifiedWebhookResponse](../../sdk/models/operations/removeunifiedwebhookresponse.md)\>**
|
|
1356
|
+
|
|
1357
|
+
### Errors
|
|
1358
|
+
|
|
1359
|
+
| Error Type | Status Code | Content Type |
|
|
1360
|
+
| --------------- | --------------- | --------------- |
|
|
1361
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1362
|
+
|
|
1363
|
+
## updateUnifiedConnection
|
|
1364
|
+
|
|
1365
|
+
Update connection
|
|
1366
|
+
|
|
1367
|
+
### Example Usage
|
|
1368
|
+
|
|
1369
|
+
```typescript
|
|
1370
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1371
|
+
|
|
1372
|
+
const unifiedTo = new UnifiedTo({
|
|
1373
|
+
security: {
|
|
1374
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1375
|
+
},
|
|
1376
|
+
});
|
|
1377
|
+
|
|
1378
|
+
async function run() {
|
|
1379
|
+
const result = await unifiedTo.unified.updateUnifiedConnection({
|
|
1380
|
+
id: "<id>",
|
|
1381
|
+
});
|
|
1382
|
+
|
|
1383
|
+
// Handle the result
|
|
1384
|
+
console.log(result);
|
|
1385
|
+
}
|
|
1386
|
+
|
|
1387
|
+
run();
|
|
1388
|
+
```
|
|
1389
|
+
|
|
1390
|
+
### Standalone function
|
|
1391
|
+
|
|
1392
|
+
The standalone function version of this method:
|
|
1393
|
+
|
|
1394
|
+
```typescript
|
|
1395
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1396
|
+
import { unifiedUpdateUnifiedConnection } from "@unified-api/typescript-sdk/funcs/unifiedUpdateUnifiedConnection.js";
|
|
1397
|
+
|
|
1398
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1399
|
+
// You can create one instance of it to use across an application.
|
|
1400
|
+
const unifiedTo = new UnifiedToCore({
|
|
1401
|
+
security: {
|
|
1402
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1403
|
+
},
|
|
1404
|
+
});
|
|
1405
|
+
|
|
1406
|
+
async function run() {
|
|
1407
|
+
const res = await unifiedUpdateUnifiedConnection(unifiedTo, {
|
|
1408
|
+
id: "<id>",
|
|
1409
|
+
});
|
|
1410
|
+
|
|
1411
|
+
if (!res.ok) {
|
|
1412
|
+
throw res.error;
|
|
1413
|
+
}
|
|
1414
|
+
|
|
1415
|
+
const { value: result } = res;
|
|
1416
|
+
|
|
1417
|
+
// Handle the result
|
|
1418
|
+
console.log(result);
|
|
1419
|
+
}
|
|
1420
|
+
|
|
1421
|
+
run();
|
|
1422
|
+
```
|
|
1423
|
+
|
|
1424
|
+
### Parameters
|
|
1425
|
+
|
|
1426
|
+
| Parameter | Type | Required | Description |
|
|
1427
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1428
|
+
| `request` | [operations.UpdateUnifiedConnectionRequest](../../sdk/models/operations/updateunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1429
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1430
|
+
| `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. |
|
|
1431
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1432
|
+
|
|
1433
|
+
### Response
|
|
1434
|
+
|
|
1435
|
+
**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
|
|
1436
|
+
|
|
1437
|
+
### Errors
|
|
1438
|
+
|
|
1439
|
+
| Error Type | Status Code | Content Type |
|
|
1440
|
+
| --------------- | --------------- | --------------- |
|
|
1441
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1442
|
+
|
|
1443
|
+
## updateUnifiedWebhook
|
|
1444
|
+
|
|
1445
|
+
Update webhook subscription
|
|
1446
|
+
|
|
1447
|
+
### Example Usage
|
|
1448
|
+
|
|
1449
|
+
```typescript
|
|
1450
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1451
|
+
|
|
1452
|
+
const unifiedTo = new UnifiedTo({
|
|
1453
|
+
security: {
|
|
1454
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1455
|
+
},
|
|
1456
|
+
});
|
|
1457
|
+
|
|
1458
|
+
async function run() {
|
|
1459
|
+
const result = await unifiedTo.unified.updateUnifiedWebhook({
|
|
1460
|
+
id: "<id>",
|
|
1461
|
+
});
|
|
1462
|
+
|
|
1463
|
+
// Handle the result
|
|
1464
|
+
console.log(result);
|
|
1465
|
+
}
|
|
1466
|
+
|
|
1467
|
+
run();
|
|
1468
|
+
```
|
|
1469
|
+
|
|
1470
|
+
### Standalone function
|
|
1471
|
+
|
|
1472
|
+
The standalone function version of this method:
|
|
1473
|
+
|
|
1474
|
+
```typescript
|
|
1475
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1476
|
+
import { unifiedUpdateUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/unifiedUpdateUnifiedWebhook.js";
|
|
1477
|
+
|
|
1478
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1479
|
+
// You can create one instance of it to use across an application.
|
|
1480
|
+
const unifiedTo = new UnifiedToCore({
|
|
1481
|
+
security: {
|
|
1482
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1483
|
+
},
|
|
1484
|
+
});
|
|
1485
|
+
|
|
1486
|
+
async function run() {
|
|
1487
|
+
const res = await unifiedUpdateUnifiedWebhook(unifiedTo, {
|
|
1488
|
+
id: "<id>",
|
|
1489
|
+
});
|
|
1490
|
+
|
|
1491
|
+
if (!res.ok) {
|
|
1492
|
+
throw res.error;
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1495
|
+
const { value: result } = res;
|
|
1496
|
+
|
|
1497
|
+
// Handle the result
|
|
1498
|
+
console.log(result);
|
|
1499
|
+
}
|
|
1500
|
+
|
|
1501
|
+
run();
|
|
1502
|
+
```
|
|
1503
|
+
|
|
1504
|
+
### Parameters
|
|
1505
|
+
|
|
1506
|
+
| Parameter | Type | Required | Description |
|
|
1507
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1508
|
+
| `request` | [operations.UpdateUnifiedWebhookRequest](../../sdk/models/operations/updateunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1509
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1510
|
+
| `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. |
|
|
1511
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1512
|
+
|
|
1513
|
+
### Response
|
|
1514
|
+
|
|
1515
|
+
**Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
|
|
1516
|
+
|
|
1517
|
+
### Errors
|
|
1518
|
+
|
|
1519
|
+
| Error Type | Status Code | Content Type |
|
|
1520
|
+
| --------------- | --------------- | --------------- |
|
|
1521
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1522
|
+
|
|
1523
|
+
## updateUnifiedWebhookTrigger
|
|
1524
|
+
|
|
1525
|
+
Trigger webhook
|
|
1526
|
+
|
|
1527
|
+
### Example Usage
|
|
1528
|
+
|
|
1529
|
+
```typescript
|
|
1530
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1531
|
+
|
|
1532
|
+
const unifiedTo = new UnifiedTo({
|
|
1533
|
+
security: {
|
|
1534
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1535
|
+
},
|
|
1536
|
+
});
|
|
1537
|
+
|
|
1538
|
+
async function run() {
|
|
1539
|
+
const result = await unifiedTo.unified.updateUnifiedWebhookTrigger({
|
|
1540
|
+
id: "<id>",
|
|
1541
|
+
});
|
|
1542
|
+
|
|
1543
|
+
// Handle the result
|
|
1544
|
+
console.log(result);
|
|
1545
|
+
}
|
|
1546
|
+
|
|
1547
|
+
run();
|
|
1548
|
+
```
|
|
1549
|
+
|
|
1550
|
+
### Standalone function
|
|
1551
|
+
|
|
1552
|
+
The standalone function version of this method:
|
|
1553
|
+
|
|
1554
|
+
```typescript
|
|
1555
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1556
|
+
import { unifiedUpdateUnifiedWebhookTrigger } from "@unified-api/typescript-sdk/funcs/unifiedUpdateUnifiedWebhookTrigger.js";
|
|
1557
|
+
|
|
1558
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1559
|
+
// You can create one instance of it to use across an application.
|
|
1560
|
+
const unifiedTo = new UnifiedToCore({
|
|
1561
|
+
security: {
|
|
1562
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1563
|
+
},
|
|
1564
|
+
});
|
|
1565
|
+
|
|
1566
|
+
async function run() {
|
|
1567
|
+
const res = await unifiedUpdateUnifiedWebhookTrigger(unifiedTo, {
|
|
1568
|
+
id: "<id>",
|
|
1569
|
+
});
|
|
1570
|
+
|
|
1571
|
+
if (!res.ok) {
|
|
1572
|
+
throw res.error;
|
|
1573
|
+
}
|
|
1574
|
+
|
|
1575
|
+
const { value: result } = res;
|
|
1576
|
+
|
|
1577
|
+
// Handle the result
|
|
1578
|
+
console.log(result);
|
|
1579
|
+
}
|
|
1580
|
+
|
|
1581
|
+
run();
|
|
1582
|
+
```
|
|
1583
|
+
|
|
1584
|
+
### Parameters
|
|
1585
|
+
|
|
1586
|
+
| Parameter | Type | Required | Description |
|
|
1587
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1588
|
+
| `request` | [operations.UpdateUnifiedWebhookTriggerRequest](../../sdk/models/operations/updateunifiedwebhooktriggerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1589
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1590
|
+
| `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. |
|
|
1591
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1592
|
+
|
|
1593
|
+
### Response
|
|
1594
|
+
|
|
1595
|
+
**Promise\<[operations.UpdateUnifiedWebhookTriggerResponse](../../sdk/models/operations/updateunifiedwebhooktriggerresponse.md)\>**
|
|
1596
|
+
|
|
1597
|
+
### Errors
|
|
1598
|
+
|
|
1599
|
+
| Error Type | Status Code | Content Type |
|
|
1600
|
+
| --------------- | --------------- | --------------- |
|
|
1601
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|