@unified-api/typescript-sdk 2.79.0 → 2.80.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/package.json +1 -1
- package/sdk/models/shared/calendareventrecurrence.d.ts +2 -5
- package/sdk/models/shared/calendareventrecurrence.d.ts.map +1 -1
- package/sdk/models/shared/calendareventrecurrence.js +2 -2
- package/sdk/models/shared/calendareventrecurrence.js.map +1 -1
- package/sdk/models/shared/index.d.ts +5 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +5 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/integration.d.ts +3 -2
- package/sdk/models/shared/integration.d.ts.map +1 -1
- package/sdk/models/shared/integration.js +3 -2
- package/sdk/models/shared/integration.js.map +1 -1
- package/sdk/models/shared/integrationsupport.d.ts +2410 -0
- package/sdk/models/shared/integrationsupport.d.ts.map +1 -0
- package/sdk/models/shared/integrationsupport.js +3440 -0
- package/sdk/models/shared/integrationsupport.js.map +1 -0
- package/sdk/models/shared/kmspage.d.ts +2 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +4 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts +36 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.js +79 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js.map +1 -0
- package/sdk/models/shared/webhook.d.ts +2 -2
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +2 -2
- package/sdk/models/shared/webhook.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/sdk/models/shared/calendareventrecurrence.ts +4 -7
- package/src/sdk/models/shared/index.ts +5 -0
- package/src/sdk/models/shared/integration.ts +10 -4
- package/src/sdk/models/shared/integrationsupport.ts +4969 -0
- package/src/sdk/models/shared/kmspage.ts +6 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookevents.ts +109 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.ts +54 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.ts +54 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.ts +54 -0
- package/src/sdk/models/shared/webhook.ts +4 -4
- package/docs/sdks/account/README.md +0 -489
- package/docs/sdks/accounting/README.md +0 -7221
- package/docs/sdks/activity/README.md +0 -489
- package/docs/sdks/apicall/README.md +0 -159
- package/docs/sdks/application/README.md +0 -489
- package/docs/sdks/applicationstatus/README.md +0 -85
- package/docs/sdks/ats/README.md +0 -3953
- package/docs/sdks/auth/README.md +0 -167
- package/docs/sdks/balancesheet/README.md +0 -165
- package/docs/sdks/bill/README.md +0 -489
- package/docs/sdks/branch/README.md +0 -507
- package/docs/sdks/busy/README.md +0 -85
- package/docs/sdks/calendar/README.md +0 -1713
- package/docs/sdks/call/README.md +0 -85
- package/docs/sdks/candidate/README.md +0 -489
- package/docs/sdks/cashflow/README.md +0 -165
- package/docs/sdks/category/README.md +0 -971
- package/docs/sdks/change/README.md +0 -165
- package/docs/sdks/channel/README.md +0 -165
- package/docs/sdks/class/README.md +0 -507
- package/docs/sdks/collection/README.md +0 -501
- package/docs/sdks/comment/README.md +0 -1495
- package/docs/sdks/commerce/README.md +0 -2465
- package/docs/sdks/commit/README.md +0 -501
- package/docs/sdks/company/README.md +0 -1543
- package/docs/sdks/connection/README.md +0 -513
- package/docs/sdks/contact/README.md +0 -1453
- package/docs/sdks/course/README.md +0 -501
- package/docs/sdks/creditmemo/README.md +0 -489
- package/docs/sdks/crm/README.md +0 -2899
- package/docs/sdks/customer/README.md +0 -489
- package/docs/sdks/deal/README.md +0 -489
- package/docs/sdks/device/README.md +0 -501
- package/docs/sdks/document/README.md +0 -489
- package/docs/sdks/embedding/README.md +0 -87
- package/docs/sdks/employee/README.md +0 -489
- package/docs/sdks/enrich/README.md +0 -163
- package/docs/sdks/event/README.md +0 -971
- package/docs/sdks/expense/README.md +0 -489
- package/docs/sdks/file/README.md +0 -489
- package/docs/sdks/genai/README.md +0 -325
- package/docs/sdks/group/README.md +0 -983
- package/docs/sdks/hris/README.md +0 -3251
- package/docs/sdks/instructor/README.md +0 -489
- package/docs/sdks/integration/README.md +0 -239
- package/docs/sdks/interview/README.md +0 -489
- package/docs/sdks/inventory/README.md +0 -501
- package/docs/sdks/invoice/README.md +0 -489
- package/docs/sdks/issue/README.md +0 -159
- package/docs/sdks/item/README.md +0 -489
- package/docs/sdks/job/README.md +0 -489
- package/docs/sdks/journal/README.md +0 -489
- package/docs/sdks/kms/README.md +0 -1495
- package/docs/sdks/lead/README.md +0 -489
- package/docs/sdks/link/README.md +0 -983
- package/docs/sdks/list/README.md +0 -489
- package/docs/sdks/lms/README.md +0 -1965
- package/docs/sdks/location/README.md +0 -983
- package/docs/sdks/login/README.md +0 -87
- package/docs/sdks/martech/README.md +0 -971
- package/docs/sdks/member/README.md +0 -489
- package/docs/sdks/message/README.md +0 -489
- package/docs/sdks/messaging/README.md +0 -647
- package/docs/sdks/metadata/README.md +0 -507
- package/docs/sdks/model/README.md +0 -165
- package/docs/sdks/note/README.md +0 -489
- package/docs/sdks/order/README.md +0 -489
- package/docs/sdks/organization/README.md +0 -647
- package/docs/sdks/package/README.md +0 -165
- package/docs/sdks/page/README.md +0 -507
- package/docs/sdks/passthrough/README.md +0 -647
- package/docs/sdks/payment/README.md +0 -1769
- package/docs/sdks/payout/README.md +0 -165
- package/docs/sdks/payslip/README.md +0 -165
- package/docs/sdks/person/README.md +0 -85
- package/docs/sdks/pipeline/README.md +0 -489
- package/docs/sdks/profitloss/README.md +0 -165
- package/docs/sdks/project/README.md +0 -489
- package/docs/sdks/prompt/README.md +0 -87
- package/docs/sdks/pullrequest/README.md +0 -489
- package/docs/sdks/purchaseorder/README.md +0 -489
- package/docs/sdks/recording/README.md +0 -647
- package/docs/sdks/refund/README.md +0 -165
- package/docs/sdks/repo/README.md +0 -2459
- package/docs/sdks/report/README.md +0 -165
- package/docs/sdks/repository/README.md +0 -501
- package/docs/sdks/request/README.md +0 -489
- package/docs/sdks/review/README.md +0 -501
- package/docs/sdks/salesorder/README.md +0 -489
- package/docs/sdks/scim/README.md +0 -983
- package/docs/sdks/scorecard/README.md +0 -489
- package/docs/sdks/space/README.md +0 -501
- package/docs/sdks/storage/README.md +0 -489
- package/docs/sdks/student/README.md +0 -489
- package/docs/sdks/subscription/README.md +0 -489
- package/docs/sdks/task/README.md +0 -1629
- package/docs/sdks/taxrate/README.md +0 -489
- package/docs/sdks/ticket/README.md +0 -489
- package/docs/sdks/ticketing/README.md +0 -1935
- package/docs/sdks/timeoff/README.md +0 -165
- package/docs/sdks/timeshift/README.md +0 -513
- package/docs/sdks/transaction/README.md +0 -489
- package/docs/sdks/trialbalance/README.md +0 -165
- package/docs/sdks/uc/README.md +0 -1543
- package/docs/sdks/unified/README.md +0 -1697
- package/docs/sdks/user/README.md +0 -489
- package/docs/sdks/verification/README.md +0 -647
- package/docs/sdks/webhook/README.md +0 -655
- package/examples/README.md +0 -31
package/docs/sdks/uc/README.md
DELETED
|
@@ -1,1543 +0,0 @@
|
|
|
1
|
-
# Uc
|
|
2
|
-
(*uc*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [createUcComment](#createuccomment) - Create a comment
|
|
9
|
-
* [createUcContact](#createuccontact) - Create a contact
|
|
10
|
-
* [createUcRecording](#createucrecording) - Create a recording
|
|
11
|
-
* [getUcComment](#getuccomment) - Retrieve a comment
|
|
12
|
-
* [getUcContact](#getuccontact) - Retrieve a contact
|
|
13
|
-
* [getUcRecording](#getucrecording) - Retrieve a recording
|
|
14
|
-
* [listUcCalls](#listuccalls) - List all calls
|
|
15
|
-
* [listUcComments](#listuccomments) - List all comments
|
|
16
|
-
* [listUcContacts](#listuccontacts) - List all contacts
|
|
17
|
-
* [listUcRecordings](#listucrecordings) - List all recordings
|
|
18
|
-
* [patchUcComment](#patchuccomment) - Update a comment
|
|
19
|
-
* [patchUcContact](#patchuccontact) - Update a contact
|
|
20
|
-
* [patchUcRecording](#patchucrecording) - Update a recording
|
|
21
|
-
* [removeUcComment](#removeuccomment) - Remove a comment
|
|
22
|
-
* [removeUcContact](#removeuccontact) - Remove a contact
|
|
23
|
-
* [removeUcRecording](#removeucrecording) - Remove a recording
|
|
24
|
-
* [updateUcComment](#updateuccomment) - Update a comment
|
|
25
|
-
* [updateUcContact](#updateuccontact) - Update a contact
|
|
26
|
-
* [updateUcRecording](#updateucrecording) - Update a recording
|
|
27
|
-
|
|
28
|
-
## createUcComment
|
|
29
|
-
|
|
30
|
-
Create a comment
|
|
31
|
-
|
|
32
|
-
### Example Usage
|
|
33
|
-
|
|
34
|
-
<!-- UsageSnippet language="typescript" operationID="createUcComment" method="post" path="/uc/{connection_id}/comment" -->
|
|
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.uc.createUcComment({
|
|
46
|
-
ucComment: {
|
|
47
|
-
content: "<value>",
|
|
48
|
-
},
|
|
49
|
-
connectionId: "<id>",
|
|
50
|
-
});
|
|
51
|
-
|
|
52
|
-
console.log(result);
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
run();
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Standalone function
|
|
59
|
-
|
|
60
|
-
The standalone function version of this method:
|
|
61
|
-
|
|
62
|
-
```typescript
|
|
63
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
64
|
-
import { commentCreateUcComment } from "@unified-api/typescript-sdk/funcs/commentCreateUcComment.js";
|
|
65
|
-
|
|
66
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
67
|
-
// You can create one instance of it to use across an application.
|
|
68
|
-
const unifiedTo = new UnifiedToCore({
|
|
69
|
-
security: {
|
|
70
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
71
|
-
},
|
|
72
|
-
});
|
|
73
|
-
|
|
74
|
-
async function run() {
|
|
75
|
-
const res = await commentCreateUcComment(unifiedTo, {
|
|
76
|
-
ucComment: {
|
|
77
|
-
content: "<value>",
|
|
78
|
-
},
|
|
79
|
-
connectionId: "<id>",
|
|
80
|
-
});
|
|
81
|
-
if (res.ok) {
|
|
82
|
-
const { value: result } = res;
|
|
83
|
-
console.log(result);
|
|
84
|
-
} else {
|
|
85
|
-
console.log("commentCreateUcComment failed:", res.error);
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
run();
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Parameters
|
|
93
|
-
|
|
94
|
-
| Parameter | Type | Required | Description |
|
|
95
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
96
|
-
| `request` | [operations.CreateUcCommentRequest](../../sdk/models/operations/createuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
97
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
98
|
-
| `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. |
|
|
99
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
100
|
-
|
|
101
|
-
### Response
|
|
102
|
-
|
|
103
|
-
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
104
|
-
|
|
105
|
-
### Errors
|
|
106
|
-
|
|
107
|
-
| Error Type | Status Code | Content Type |
|
|
108
|
-
| --------------- | --------------- | --------------- |
|
|
109
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
110
|
-
|
|
111
|
-
## createUcContact
|
|
112
|
-
|
|
113
|
-
Create a contact
|
|
114
|
-
|
|
115
|
-
### Example Usage
|
|
116
|
-
|
|
117
|
-
<!-- UsageSnippet language="typescript" operationID="createUcContact" method="post" path="/uc/{connection_id}/contact" -->
|
|
118
|
-
```typescript
|
|
119
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
120
|
-
|
|
121
|
-
const unifiedTo = new UnifiedTo({
|
|
122
|
-
security: {
|
|
123
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
124
|
-
},
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
async function run() {
|
|
128
|
-
const result = await unifiedTo.uc.createUcContact({
|
|
129
|
-
ucContact: {},
|
|
130
|
-
connectionId: "<id>",
|
|
131
|
-
});
|
|
132
|
-
|
|
133
|
-
console.log(result);
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
run();
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### Standalone function
|
|
140
|
-
|
|
141
|
-
The standalone function version of this method:
|
|
142
|
-
|
|
143
|
-
```typescript
|
|
144
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
145
|
-
import { contactCreateUcContact } from "@unified-api/typescript-sdk/funcs/contactCreateUcContact.js";
|
|
146
|
-
|
|
147
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
148
|
-
// You can create one instance of it to use across an application.
|
|
149
|
-
const unifiedTo = new UnifiedToCore({
|
|
150
|
-
security: {
|
|
151
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
152
|
-
},
|
|
153
|
-
});
|
|
154
|
-
|
|
155
|
-
async function run() {
|
|
156
|
-
const res = await contactCreateUcContact(unifiedTo, {
|
|
157
|
-
ucContact: {},
|
|
158
|
-
connectionId: "<id>",
|
|
159
|
-
});
|
|
160
|
-
if (res.ok) {
|
|
161
|
-
const { value: result } = res;
|
|
162
|
-
console.log(result);
|
|
163
|
-
} else {
|
|
164
|
-
console.log("contactCreateUcContact failed:", res.error);
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
run();
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### Parameters
|
|
172
|
-
|
|
173
|
-
| Parameter | Type | Required | Description |
|
|
174
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
175
|
-
| `request` | [operations.CreateUcContactRequest](../../sdk/models/operations/createuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
176
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
177
|
-
| `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. |
|
|
178
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
179
|
-
|
|
180
|
-
### Response
|
|
181
|
-
|
|
182
|
-
**Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
|
|
183
|
-
|
|
184
|
-
### Errors
|
|
185
|
-
|
|
186
|
-
| Error Type | Status Code | Content Type |
|
|
187
|
-
| --------------- | --------------- | --------------- |
|
|
188
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
189
|
-
|
|
190
|
-
## createUcRecording
|
|
191
|
-
|
|
192
|
-
Create a recording
|
|
193
|
-
|
|
194
|
-
### Example Usage
|
|
195
|
-
|
|
196
|
-
<!-- UsageSnippet language="typescript" operationID="createUcRecording" method="post" path="/uc/{connection_id}/recording" -->
|
|
197
|
-
```typescript
|
|
198
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
199
|
-
|
|
200
|
-
const unifiedTo = new UnifiedTo({
|
|
201
|
-
security: {
|
|
202
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
203
|
-
},
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
async function run() {
|
|
207
|
-
const result = await unifiedTo.uc.createUcRecording({
|
|
208
|
-
ucRecording: {},
|
|
209
|
-
connectionId: "<id>",
|
|
210
|
-
});
|
|
211
|
-
|
|
212
|
-
console.log(result);
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
run();
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
### Standalone function
|
|
219
|
-
|
|
220
|
-
The standalone function version of this method:
|
|
221
|
-
|
|
222
|
-
```typescript
|
|
223
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
224
|
-
import { recordingCreateUcRecording } from "@unified-api/typescript-sdk/funcs/recordingCreateUcRecording.js";
|
|
225
|
-
|
|
226
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
227
|
-
// You can create one instance of it to use across an application.
|
|
228
|
-
const unifiedTo = new UnifiedToCore({
|
|
229
|
-
security: {
|
|
230
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
231
|
-
},
|
|
232
|
-
});
|
|
233
|
-
|
|
234
|
-
async function run() {
|
|
235
|
-
const res = await recordingCreateUcRecording(unifiedTo, {
|
|
236
|
-
ucRecording: {},
|
|
237
|
-
connectionId: "<id>",
|
|
238
|
-
});
|
|
239
|
-
if (res.ok) {
|
|
240
|
-
const { value: result } = res;
|
|
241
|
-
console.log(result);
|
|
242
|
-
} else {
|
|
243
|
-
console.log("recordingCreateUcRecording failed:", res.error);
|
|
244
|
-
}
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
run();
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
### Parameters
|
|
251
|
-
|
|
252
|
-
| Parameter | Type | Required | Description |
|
|
253
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
254
|
-
| `request` | [operations.CreateUcRecordingRequest](../../sdk/models/operations/createucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
255
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
256
|
-
| `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. |
|
|
257
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
258
|
-
|
|
259
|
-
### Response
|
|
260
|
-
|
|
261
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
262
|
-
|
|
263
|
-
### Errors
|
|
264
|
-
|
|
265
|
-
| Error Type | Status Code | Content Type |
|
|
266
|
-
| --------------- | --------------- | --------------- |
|
|
267
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
268
|
-
|
|
269
|
-
## getUcComment
|
|
270
|
-
|
|
271
|
-
Retrieve a comment
|
|
272
|
-
|
|
273
|
-
### Example Usage
|
|
274
|
-
|
|
275
|
-
<!-- UsageSnippet language="typescript" operationID="getUcComment" method="get" path="/uc/{connection_id}/comment/{id}" -->
|
|
276
|
-
```typescript
|
|
277
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
278
|
-
|
|
279
|
-
const unifiedTo = new UnifiedTo({
|
|
280
|
-
security: {
|
|
281
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
282
|
-
},
|
|
283
|
-
});
|
|
284
|
-
|
|
285
|
-
async function run() {
|
|
286
|
-
const result = await unifiedTo.uc.getUcComment({
|
|
287
|
-
connectionId: "<id>",
|
|
288
|
-
id: "<id>",
|
|
289
|
-
});
|
|
290
|
-
|
|
291
|
-
console.log(result);
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
run();
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
### Standalone function
|
|
298
|
-
|
|
299
|
-
The standalone function version of this method:
|
|
300
|
-
|
|
301
|
-
```typescript
|
|
302
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
303
|
-
import { commentGetUcComment } from "@unified-api/typescript-sdk/funcs/commentGetUcComment.js";
|
|
304
|
-
|
|
305
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
306
|
-
// You can create one instance of it to use across an application.
|
|
307
|
-
const unifiedTo = new UnifiedToCore({
|
|
308
|
-
security: {
|
|
309
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
310
|
-
},
|
|
311
|
-
});
|
|
312
|
-
|
|
313
|
-
async function run() {
|
|
314
|
-
const res = await commentGetUcComment(unifiedTo, {
|
|
315
|
-
connectionId: "<id>",
|
|
316
|
-
id: "<id>",
|
|
317
|
-
});
|
|
318
|
-
if (res.ok) {
|
|
319
|
-
const { value: result } = res;
|
|
320
|
-
console.log(result);
|
|
321
|
-
} else {
|
|
322
|
-
console.log("commentGetUcComment failed:", res.error);
|
|
323
|
-
}
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
run();
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
### Parameters
|
|
330
|
-
|
|
331
|
-
| Parameter | Type | Required | Description |
|
|
332
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
333
|
-
| `request` | [operations.GetUcCommentRequest](../../sdk/models/operations/getuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
334
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
335
|
-
| `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. |
|
|
336
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
337
|
-
|
|
338
|
-
### Response
|
|
339
|
-
|
|
340
|
-
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
341
|
-
|
|
342
|
-
### Errors
|
|
343
|
-
|
|
344
|
-
| Error Type | Status Code | Content Type |
|
|
345
|
-
| --------------- | --------------- | --------------- |
|
|
346
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
347
|
-
|
|
348
|
-
## getUcContact
|
|
349
|
-
|
|
350
|
-
Retrieve a contact
|
|
351
|
-
|
|
352
|
-
### Example Usage
|
|
353
|
-
|
|
354
|
-
<!-- UsageSnippet language="typescript" operationID="getUcContact" method="get" path="/uc/{connection_id}/contact/{id}" -->
|
|
355
|
-
```typescript
|
|
356
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
357
|
-
|
|
358
|
-
const unifiedTo = new UnifiedTo({
|
|
359
|
-
security: {
|
|
360
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
361
|
-
},
|
|
362
|
-
});
|
|
363
|
-
|
|
364
|
-
async function run() {
|
|
365
|
-
const result = await unifiedTo.uc.getUcContact({
|
|
366
|
-
connectionId: "<id>",
|
|
367
|
-
id: "<id>",
|
|
368
|
-
});
|
|
369
|
-
|
|
370
|
-
console.log(result);
|
|
371
|
-
}
|
|
372
|
-
|
|
373
|
-
run();
|
|
374
|
-
```
|
|
375
|
-
|
|
376
|
-
### Standalone function
|
|
377
|
-
|
|
378
|
-
The standalone function version of this method:
|
|
379
|
-
|
|
380
|
-
```typescript
|
|
381
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
382
|
-
import { contactGetUcContact } from "@unified-api/typescript-sdk/funcs/contactGetUcContact.js";
|
|
383
|
-
|
|
384
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
385
|
-
// You can create one instance of it to use across an application.
|
|
386
|
-
const unifiedTo = new UnifiedToCore({
|
|
387
|
-
security: {
|
|
388
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
389
|
-
},
|
|
390
|
-
});
|
|
391
|
-
|
|
392
|
-
async function run() {
|
|
393
|
-
const res = await contactGetUcContact(unifiedTo, {
|
|
394
|
-
connectionId: "<id>",
|
|
395
|
-
id: "<id>",
|
|
396
|
-
});
|
|
397
|
-
if (res.ok) {
|
|
398
|
-
const { value: result } = res;
|
|
399
|
-
console.log(result);
|
|
400
|
-
} else {
|
|
401
|
-
console.log("contactGetUcContact failed:", res.error);
|
|
402
|
-
}
|
|
403
|
-
}
|
|
404
|
-
|
|
405
|
-
run();
|
|
406
|
-
```
|
|
407
|
-
|
|
408
|
-
### Parameters
|
|
409
|
-
|
|
410
|
-
| Parameter | Type | Required | Description |
|
|
411
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
412
|
-
| `request` | [operations.GetUcContactRequest](../../sdk/models/operations/getuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
413
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
414
|
-
| `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. |
|
|
415
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
416
|
-
|
|
417
|
-
### Response
|
|
418
|
-
|
|
419
|
-
**Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
|
|
420
|
-
|
|
421
|
-
### Errors
|
|
422
|
-
|
|
423
|
-
| Error Type | Status Code | Content Type |
|
|
424
|
-
| --------------- | --------------- | --------------- |
|
|
425
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
426
|
-
|
|
427
|
-
## getUcRecording
|
|
428
|
-
|
|
429
|
-
Retrieve a recording
|
|
430
|
-
|
|
431
|
-
### Example Usage
|
|
432
|
-
|
|
433
|
-
<!-- UsageSnippet language="typescript" operationID="getUcRecording" method="get" path="/uc/{connection_id}/recording/{id}" -->
|
|
434
|
-
```typescript
|
|
435
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
436
|
-
|
|
437
|
-
const unifiedTo = new UnifiedTo({
|
|
438
|
-
security: {
|
|
439
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
440
|
-
},
|
|
441
|
-
});
|
|
442
|
-
|
|
443
|
-
async function run() {
|
|
444
|
-
const result = await unifiedTo.uc.getUcRecording({
|
|
445
|
-
connectionId: "<id>",
|
|
446
|
-
id: "<id>",
|
|
447
|
-
});
|
|
448
|
-
|
|
449
|
-
console.log(result);
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
run();
|
|
453
|
-
```
|
|
454
|
-
|
|
455
|
-
### Standalone function
|
|
456
|
-
|
|
457
|
-
The standalone function version of this method:
|
|
458
|
-
|
|
459
|
-
```typescript
|
|
460
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
461
|
-
import { recordingGetUcRecording } from "@unified-api/typescript-sdk/funcs/recordingGetUcRecording.js";
|
|
462
|
-
|
|
463
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
464
|
-
// You can create one instance of it to use across an application.
|
|
465
|
-
const unifiedTo = new UnifiedToCore({
|
|
466
|
-
security: {
|
|
467
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
468
|
-
},
|
|
469
|
-
});
|
|
470
|
-
|
|
471
|
-
async function run() {
|
|
472
|
-
const res = await recordingGetUcRecording(unifiedTo, {
|
|
473
|
-
connectionId: "<id>",
|
|
474
|
-
id: "<id>",
|
|
475
|
-
});
|
|
476
|
-
if (res.ok) {
|
|
477
|
-
const { value: result } = res;
|
|
478
|
-
console.log(result);
|
|
479
|
-
} else {
|
|
480
|
-
console.log("recordingGetUcRecording failed:", res.error);
|
|
481
|
-
}
|
|
482
|
-
}
|
|
483
|
-
|
|
484
|
-
run();
|
|
485
|
-
```
|
|
486
|
-
|
|
487
|
-
### Parameters
|
|
488
|
-
|
|
489
|
-
| Parameter | Type | Required | Description |
|
|
490
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
491
|
-
| `request` | [operations.GetUcRecordingRequest](../../sdk/models/operations/getucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
492
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
493
|
-
| `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. |
|
|
494
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
495
|
-
|
|
496
|
-
### Response
|
|
497
|
-
|
|
498
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
499
|
-
|
|
500
|
-
### Errors
|
|
501
|
-
|
|
502
|
-
| Error Type | Status Code | Content Type |
|
|
503
|
-
| --------------- | --------------- | --------------- |
|
|
504
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
505
|
-
|
|
506
|
-
## listUcCalls
|
|
507
|
-
|
|
508
|
-
List all calls
|
|
509
|
-
|
|
510
|
-
### Example Usage
|
|
511
|
-
|
|
512
|
-
<!-- UsageSnippet language="typescript" operationID="listUcCalls" method="get" path="/uc/{connection_id}/call" -->
|
|
513
|
-
```typescript
|
|
514
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
515
|
-
|
|
516
|
-
const unifiedTo = new UnifiedTo({
|
|
517
|
-
security: {
|
|
518
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
519
|
-
},
|
|
520
|
-
});
|
|
521
|
-
|
|
522
|
-
async function run() {
|
|
523
|
-
const result = await unifiedTo.uc.listUcCalls({
|
|
524
|
-
connectionId: "<id>",
|
|
525
|
-
});
|
|
526
|
-
|
|
527
|
-
console.log(result);
|
|
528
|
-
}
|
|
529
|
-
|
|
530
|
-
run();
|
|
531
|
-
```
|
|
532
|
-
|
|
533
|
-
### Standalone function
|
|
534
|
-
|
|
535
|
-
The standalone function version of this method:
|
|
536
|
-
|
|
537
|
-
```typescript
|
|
538
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
539
|
-
import { ucListUcCalls } from "@unified-api/typescript-sdk/funcs/ucListUcCalls.js";
|
|
540
|
-
|
|
541
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
542
|
-
// You can create one instance of it to use across an application.
|
|
543
|
-
const unifiedTo = new UnifiedToCore({
|
|
544
|
-
security: {
|
|
545
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
546
|
-
},
|
|
547
|
-
});
|
|
548
|
-
|
|
549
|
-
async function run() {
|
|
550
|
-
const res = await ucListUcCalls(unifiedTo, {
|
|
551
|
-
connectionId: "<id>",
|
|
552
|
-
});
|
|
553
|
-
if (res.ok) {
|
|
554
|
-
const { value: result } = res;
|
|
555
|
-
console.log(result);
|
|
556
|
-
} else {
|
|
557
|
-
console.log("ucListUcCalls failed:", res.error);
|
|
558
|
-
}
|
|
559
|
-
}
|
|
560
|
-
|
|
561
|
-
run();
|
|
562
|
-
```
|
|
563
|
-
|
|
564
|
-
### Parameters
|
|
565
|
-
|
|
566
|
-
| Parameter | Type | Required | Description |
|
|
567
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
568
|
-
| `request` | [operations.ListUcCallsRequest](../../sdk/models/operations/listuccallsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
569
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
570
|
-
| `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. |
|
|
571
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
572
|
-
|
|
573
|
-
### Response
|
|
574
|
-
|
|
575
|
-
**Promise\<[shared.UcCall[]](../../models/.md)\>**
|
|
576
|
-
|
|
577
|
-
### Errors
|
|
578
|
-
|
|
579
|
-
| Error Type | Status Code | Content Type |
|
|
580
|
-
| --------------- | --------------- | --------------- |
|
|
581
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
582
|
-
|
|
583
|
-
## listUcComments
|
|
584
|
-
|
|
585
|
-
List all comments
|
|
586
|
-
|
|
587
|
-
### Example Usage
|
|
588
|
-
|
|
589
|
-
<!-- UsageSnippet language="typescript" operationID="listUcComments" method="get" path="/uc/{connection_id}/comment" -->
|
|
590
|
-
```typescript
|
|
591
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
592
|
-
|
|
593
|
-
const unifiedTo = new UnifiedTo({
|
|
594
|
-
security: {
|
|
595
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
596
|
-
},
|
|
597
|
-
});
|
|
598
|
-
|
|
599
|
-
async function run() {
|
|
600
|
-
const result = await unifiedTo.uc.listUcComments({
|
|
601
|
-
connectionId: "<id>",
|
|
602
|
-
});
|
|
603
|
-
|
|
604
|
-
console.log(result);
|
|
605
|
-
}
|
|
606
|
-
|
|
607
|
-
run();
|
|
608
|
-
```
|
|
609
|
-
|
|
610
|
-
### Standalone function
|
|
611
|
-
|
|
612
|
-
The standalone function version of this method:
|
|
613
|
-
|
|
614
|
-
```typescript
|
|
615
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
616
|
-
import { commentListUcComments } from "@unified-api/typescript-sdk/funcs/commentListUcComments.js";
|
|
617
|
-
|
|
618
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
619
|
-
// You can create one instance of it to use across an application.
|
|
620
|
-
const unifiedTo = new UnifiedToCore({
|
|
621
|
-
security: {
|
|
622
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
623
|
-
},
|
|
624
|
-
});
|
|
625
|
-
|
|
626
|
-
async function run() {
|
|
627
|
-
const res = await commentListUcComments(unifiedTo, {
|
|
628
|
-
connectionId: "<id>",
|
|
629
|
-
});
|
|
630
|
-
if (res.ok) {
|
|
631
|
-
const { value: result } = res;
|
|
632
|
-
console.log(result);
|
|
633
|
-
} else {
|
|
634
|
-
console.log("commentListUcComments failed:", res.error);
|
|
635
|
-
}
|
|
636
|
-
}
|
|
637
|
-
|
|
638
|
-
run();
|
|
639
|
-
```
|
|
640
|
-
|
|
641
|
-
### Parameters
|
|
642
|
-
|
|
643
|
-
| Parameter | Type | Required | Description |
|
|
644
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
645
|
-
| `request` | [operations.ListUcCommentsRequest](../../sdk/models/operations/listuccommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
646
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
647
|
-
| `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. |
|
|
648
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
649
|
-
|
|
650
|
-
### Response
|
|
651
|
-
|
|
652
|
-
**Promise\<[shared.UcComment[]](../../models/.md)\>**
|
|
653
|
-
|
|
654
|
-
### Errors
|
|
655
|
-
|
|
656
|
-
| Error Type | Status Code | Content Type |
|
|
657
|
-
| --------------- | --------------- | --------------- |
|
|
658
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
659
|
-
|
|
660
|
-
## listUcContacts
|
|
661
|
-
|
|
662
|
-
List all contacts
|
|
663
|
-
|
|
664
|
-
### Example Usage
|
|
665
|
-
|
|
666
|
-
<!-- UsageSnippet language="typescript" operationID="listUcContacts" method="get" path="/uc/{connection_id}/contact" -->
|
|
667
|
-
```typescript
|
|
668
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
669
|
-
|
|
670
|
-
const unifiedTo = new UnifiedTo({
|
|
671
|
-
security: {
|
|
672
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
673
|
-
},
|
|
674
|
-
});
|
|
675
|
-
|
|
676
|
-
async function run() {
|
|
677
|
-
const result = await unifiedTo.uc.listUcContacts({
|
|
678
|
-
connectionId: "<id>",
|
|
679
|
-
});
|
|
680
|
-
|
|
681
|
-
console.log(result);
|
|
682
|
-
}
|
|
683
|
-
|
|
684
|
-
run();
|
|
685
|
-
```
|
|
686
|
-
|
|
687
|
-
### Standalone function
|
|
688
|
-
|
|
689
|
-
The standalone function version of this method:
|
|
690
|
-
|
|
691
|
-
```typescript
|
|
692
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
693
|
-
import { contactListUcContacts } from "@unified-api/typescript-sdk/funcs/contactListUcContacts.js";
|
|
694
|
-
|
|
695
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
696
|
-
// You can create one instance of it to use across an application.
|
|
697
|
-
const unifiedTo = new UnifiedToCore({
|
|
698
|
-
security: {
|
|
699
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
700
|
-
},
|
|
701
|
-
});
|
|
702
|
-
|
|
703
|
-
async function run() {
|
|
704
|
-
const res = await contactListUcContacts(unifiedTo, {
|
|
705
|
-
connectionId: "<id>",
|
|
706
|
-
});
|
|
707
|
-
if (res.ok) {
|
|
708
|
-
const { value: result } = res;
|
|
709
|
-
console.log(result);
|
|
710
|
-
} else {
|
|
711
|
-
console.log("contactListUcContacts failed:", res.error);
|
|
712
|
-
}
|
|
713
|
-
}
|
|
714
|
-
|
|
715
|
-
run();
|
|
716
|
-
```
|
|
717
|
-
|
|
718
|
-
### Parameters
|
|
719
|
-
|
|
720
|
-
| Parameter | Type | Required | Description |
|
|
721
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
722
|
-
| `request` | [operations.ListUcContactsRequest](../../sdk/models/operations/listuccontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
723
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
724
|
-
| `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. |
|
|
725
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
726
|
-
|
|
727
|
-
### Response
|
|
728
|
-
|
|
729
|
-
**Promise\<[shared.UcContact[]](../../models/.md)\>**
|
|
730
|
-
|
|
731
|
-
### Errors
|
|
732
|
-
|
|
733
|
-
| Error Type | Status Code | Content Type |
|
|
734
|
-
| --------------- | --------------- | --------------- |
|
|
735
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
736
|
-
|
|
737
|
-
## listUcRecordings
|
|
738
|
-
|
|
739
|
-
List all recordings
|
|
740
|
-
|
|
741
|
-
### Example Usage
|
|
742
|
-
|
|
743
|
-
<!-- UsageSnippet language="typescript" operationID="listUcRecordings" method="get" path="/uc/{connection_id}/recording" -->
|
|
744
|
-
```typescript
|
|
745
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
746
|
-
|
|
747
|
-
const unifiedTo = new UnifiedTo({
|
|
748
|
-
security: {
|
|
749
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
750
|
-
},
|
|
751
|
-
});
|
|
752
|
-
|
|
753
|
-
async function run() {
|
|
754
|
-
const result = await unifiedTo.uc.listUcRecordings({
|
|
755
|
-
connectionId: "<id>",
|
|
756
|
-
});
|
|
757
|
-
|
|
758
|
-
console.log(result);
|
|
759
|
-
}
|
|
760
|
-
|
|
761
|
-
run();
|
|
762
|
-
```
|
|
763
|
-
|
|
764
|
-
### Standalone function
|
|
765
|
-
|
|
766
|
-
The standalone function version of this method:
|
|
767
|
-
|
|
768
|
-
```typescript
|
|
769
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
770
|
-
import { recordingListUcRecordings } from "@unified-api/typescript-sdk/funcs/recordingListUcRecordings.js";
|
|
771
|
-
|
|
772
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
773
|
-
// You can create one instance of it to use across an application.
|
|
774
|
-
const unifiedTo = new UnifiedToCore({
|
|
775
|
-
security: {
|
|
776
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
777
|
-
},
|
|
778
|
-
});
|
|
779
|
-
|
|
780
|
-
async function run() {
|
|
781
|
-
const res = await recordingListUcRecordings(unifiedTo, {
|
|
782
|
-
connectionId: "<id>",
|
|
783
|
-
});
|
|
784
|
-
if (res.ok) {
|
|
785
|
-
const { value: result } = res;
|
|
786
|
-
console.log(result);
|
|
787
|
-
} else {
|
|
788
|
-
console.log("recordingListUcRecordings failed:", res.error);
|
|
789
|
-
}
|
|
790
|
-
}
|
|
791
|
-
|
|
792
|
-
run();
|
|
793
|
-
```
|
|
794
|
-
|
|
795
|
-
### Parameters
|
|
796
|
-
|
|
797
|
-
| Parameter | Type | Required | Description |
|
|
798
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
799
|
-
| `request` | [operations.ListUcRecordingsRequest](../../sdk/models/operations/listucrecordingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
800
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
801
|
-
| `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. |
|
|
802
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
803
|
-
|
|
804
|
-
### Response
|
|
805
|
-
|
|
806
|
-
**Promise\<[shared.UcRecording[]](../../models/.md)\>**
|
|
807
|
-
|
|
808
|
-
### Errors
|
|
809
|
-
|
|
810
|
-
| Error Type | Status Code | Content Type |
|
|
811
|
-
| --------------- | --------------- | --------------- |
|
|
812
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
813
|
-
|
|
814
|
-
## patchUcComment
|
|
815
|
-
|
|
816
|
-
Update a comment
|
|
817
|
-
|
|
818
|
-
### Example Usage
|
|
819
|
-
|
|
820
|
-
<!-- UsageSnippet language="typescript" operationID="patchUcComment" method="patch" path="/uc/{connection_id}/comment/{id}" -->
|
|
821
|
-
```typescript
|
|
822
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
823
|
-
|
|
824
|
-
const unifiedTo = new UnifiedTo({
|
|
825
|
-
security: {
|
|
826
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
827
|
-
},
|
|
828
|
-
});
|
|
829
|
-
|
|
830
|
-
async function run() {
|
|
831
|
-
const result = await unifiedTo.uc.patchUcComment({
|
|
832
|
-
ucComment: {
|
|
833
|
-
content: "<value>",
|
|
834
|
-
},
|
|
835
|
-
connectionId: "<id>",
|
|
836
|
-
id: "<id>",
|
|
837
|
-
});
|
|
838
|
-
|
|
839
|
-
console.log(result);
|
|
840
|
-
}
|
|
841
|
-
|
|
842
|
-
run();
|
|
843
|
-
```
|
|
844
|
-
|
|
845
|
-
### Standalone function
|
|
846
|
-
|
|
847
|
-
The standalone function version of this method:
|
|
848
|
-
|
|
849
|
-
```typescript
|
|
850
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
851
|
-
import { commentPatchUcComment } from "@unified-api/typescript-sdk/funcs/commentPatchUcComment.js";
|
|
852
|
-
|
|
853
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
854
|
-
// You can create one instance of it to use across an application.
|
|
855
|
-
const unifiedTo = new UnifiedToCore({
|
|
856
|
-
security: {
|
|
857
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
858
|
-
},
|
|
859
|
-
});
|
|
860
|
-
|
|
861
|
-
async function run() {
|
|
862
|
-
const res = await commentPatchUcComment(unifiedTo, {
|
|
863
|
-
ucComment: {
|
|
864
|
-
content: "<value>",
|
|
865
|
-
},
|
|
866
|
-
connectionId: "<id>",
|
|
867
|
-
id: "<id>",
|
|
868
|
-
});
|
|
869
|
-
if (res.ok) {
|
|
870
|
-
const { value: result } = res;
|
|
871
|
-
console.log(result);
|
|
872
|
-
} else {
|
|
873
|
-
console.log("commentPatchUcComment failed:", res.error);
|
|
874
|
-
}
|
|
875
|
-
}
|
|
876
|
-
|
|
877
|
-
run();
|
|
878
|
-
```
|
|
879
|
-
|
|
880
|
-
### Parameters
|
|
881
|
-
|
|
882
|
-
| Parameter | Type | Required | Description |
|
|
883
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
884
|
-
| `request` | [operations.PatchUcCommentRequest](../../sdk/models/operations/patchuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
885
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
886
|
-
| `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. |
|
|
887
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
888
|
-
|
|
889
|
-
### Response
|
|
890
|
-
|
|
891
|
-
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
892
|
-
|
|
893
|
-
### Errors
|
|
894
|
-
|
|
895
|
-
| Error Type | Status Code | Content Type |
|
|
896
|
-
| --------------- | --------------- | --------------- |
|
|
897
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
898
|
-
|
|
899
|
-
## patchUcContact
|
|
900
|
-
|
|
901
|
-
Update a contact
|
|
902
|
-
|
|
903
|
-
### Example Usage
|
|
904
|
-
|
|
905
|
-
<!-- UsageSnippet language="typescript" operationID="patchUcContact" method="patch" path="/uc/{connection_id}/contact/{id}" -->
|
|
906
|
-
```typescript
|
|
907
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
908
|
-
|
|
909
|
-
const unifiedTo = new UnifiedTo({
|
|
910
|
-
security: {
|
|
911
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
912
|
-
},
|
|
913
|
-
});
|
|
914
|
-
|
|
915
|
-
async function run() {
|
|
916
|
-
const result = await unifiedTo.uc.patchUcContact({
|
|
917
|
-
ucContact: {},
|
|
918
|
-
connectionId: "<id>",
|
|
919
|
-
id: "<id>",
|
|
920
|
-
});
|
|
921
|
-
|
|
922
|
-
console.log(result);
|
|
923
|
-
}
|
|
924
|
-
|
|
925
|
-
run();
|
|
926
|
-
```
|
|
927
|
-
|
|
928
|
-
### Standalone function
|
|
929
|
-
|
|
930
|
-
The standalone function version of this method:
|
|
931
|
-
|
|
932
|
-
```typescript
|
|
933
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
934
|
-
import { contactPatchUcContact } from "@unified-api/typescript-sdk/funcs/contactPatchUcContact.js";
|
|
935
|
-
|
|
936
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
937
|
-
// You can create one instance of it to use across an application.
|
|
938
|
-
const unifiedTo = new UnifiedToCore({
|
|
939
|
-
security: {
|
|
940
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
941
|
-
},
|
|
942
|
-
});
|
|
943
|
-
|
|
944
|
-
async function run() {
|
|
945
|
-
const res = await contactPatchUcContact(unifiedTo, {
|
|
946
|
-
ucContact: {},
|
|
947
|
-
connectionId: "<id>",
|
|
948
|
-
id: "<id>",
|
|
949
|
-
});
|
|
950
|
-
if (res.ok) {
|
|
951
|
-
const { value: result } = res;
|
|
952
|
-
console.log(result);
|
|
953
|
-
} else {
|
|
954
|
-
console.log("contactPatchUcContact failed:", res.error);
|
|
955
|
-
}
|
|
956
|
-
}
|
|
957
|
-
|
|
958
|
-
run();
|
|
959
|
-
```
|
|
960
|
-
|
|
961
|
-
### Parameters
|
|
962
|
-
|
|
963
|
-
| Parameter | Type | Required | Description |
|
|
964
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
965
|
-
| `request` | [operations.PatchUcContactRequest](../../sdk/models/operations/patchuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
966
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
967
|
-
| `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. |
|
|
968
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
969
|
-
|
|
970
|
-
### Response
|
|
971
|
-
|
|
972
|
-
**Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
|
|
973
|
-
|
|
974
|
-
### Errors
|
|
975
|
-
|
|
976
|
-
| Error Type | Status Code | Content Type |
|
|
977
|
-
| --------------- | --------------- | --------------- |
|
|
978
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
979
|
-
|
|
980
|
-
## patchUcRecording
|
|
981
|
-
|
|
982
|
-
Update a recording
|
|
983
|
-
|
|
984
|
-
### Example Usage
|
|
985
|
-
|
|
986
|
-
<!-- UsageSnippet language="typescript" operationID="patchUcRecording" method="patch" path="/uc/{connection_id}/recording/{id}" -->
|
|
987
|
-
```typescript
|
|
988
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
989
|
-
|
|
990
|
-
const unifiedTo = new UnifiedTo({
|
|
991
|
-
security: {
|
|
992
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
993
|
-
},
|
|
994
|
-
});
|
|
995
|
-
|
|
996
|
-
async function run() {
|
|
997
|
-
const result = await unifiedTo.uc.patchUcRecording({
|
|
998
|
-
ucRecording: {},
|
|
999
|
-
connectionId: "<id>",
|
|
1000
|
-
id: "<id>",
|
|
1001
|
-
});
|
|
1002
|
-
|
|
1003
|
-
console.log(result);
|
|
1004
|
-
}
|
|
1005
|
-
|
|
1006
|
-
run();
|
|
1007
|
-
```
|
|
1008
|
-
|
|
1009
|
-
### Standalone function
|
|
1010
|
-
|
|
1011
|
-
The standalone function version of this method:
|
|
1012
|
-
|
|
1013
|
-
```typescript
|
|
1014
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1015
|
-
import { recordingPatchUcRecording } from "@unified-api/typescript-sdk/funcs/recordingPatchUcRecording.js";
|
|
1016
|
-
|
|
1017
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1018
|
-
// You can create one instance of it to use across an application.
|
|
1019
|
-
const unifiedTo = new UnifiedToCore({
|
|
1020
|
-
security: {
|
|
1021
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1022
|
-
},
|
|
1023
|
-
});
|
|
1024
|
-
|
|
1025
|
-
async function run() {
|
|
1026
|
-
const res = await recordingPatchUcRecording(unifiedTo, {
|
|
1027
|
-
ucRecording: {},
|
|
1028
|
-
connectionId: "<id>",
|
|
1029
|
-
id: "<id>",
|
|
1030
|
-
});
|
|
1031
|
-
if (res.ok) {
|
|
1032
|
-
const { value: result } = res;
|
|
1033
|
-
console.log(result);
|
|
1034
|
-
} else {
|
|
1035
|
-
console.log("recordingPatchUcRecording failed:", res.error);
|
|
1036
|
-
}
|
|
1037
|
-
}
|
|
1038
|
-
|
|
1039
|
-
run();
|
|
1040
|
-
```
|
|
1041
|
-
|
|
1042
|
-
### Parameters
|
|
1043
|
-
|
|
1044
|
-
| Parameter | Type | Required | Description |
|
|
1045
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1046
|
-
| `request` | [operations.PatchUcRecordingRequest](../../sdk/models/operations/patchucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1047
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1048
|
-
| `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. |
|
|
1049
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1050
|
-
|
|
1051
|
-
### Response
|
|
1052
|
-
|
|
1053
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
1054
|
-
|
|
1055
|
-
### Errors
|
|
1056
|
-
|
|
1057
|
-
| Error Type | Status Code | Content Type |
|
|
1058
|
-
| --------------- | --------------- | --------------- |
|
|
1059
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1060
|
-
|
|
1061
|
-
## removeUcComment
|
|
1062
|
-
|
|
1063
|
-
Remove a comment
|
|
1064
|
-
|
|
1065
|
-
### Example Usage
|
|
1066
|
-
|
|
1067
|
-
<!-- UsageSnippet language="typescript" operationID="removeUcComment" method="delete" path="/uc/{connection_id}/comment/{id}" -->
|
|
1068
|
-
```typescript
|
|
1069
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1070
|
-
|
|
1071
|
-
const unifiedTo = new UnifiedTo({
|
|
1072
|
-
security: {
|
|
1073
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1074
|
-
},
|
|
1075
|
-
});
|
|
1076
|
-
|
|
1077
|
-
async function run() {
|
|
1078
|
-
const result = await unifiedTo.uc.removeUcComment({
|
|
1079
|
-
connectionId: "<id>",
|
|
1080
|
-
id: "<id>",
|
|
1081
|
-
});
|
|
1082
|
-
|
|
1083
|
-
console.log(result);
|
|
1084
|
-
}
|
|
1085
|
-
|
|
1086
|
-
run();
|
|
1087
|
-
```
|
|
1088
|
-
|
|
1089
|
-
### Standalone function
|
|
1090
|
-
|
|
1091
|
-
The standalone function version of this method:
|
|
1092
|
-
|
|
1093
|
-
```typescript
|
|
1094
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1095
|
-
import { commentRemoveUcComment } from "@unified-api/typescript-sdk/funcs/commentRemoveUcComment.js";
|
|
1096
|
-
|
|
1097
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1098
|
-
// You can create one instance of it to use across an application.
|
|
1099
|
-
const unifiedTo = new UnifiedToCore({
|
|
1100
|
-
security: {
|
|
1101
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1102
|
-
},
|
|
1103
|
-
});
|
|
1104
|
-
|
|
1105
|
-
async function run() {
|
|
1106
|
-
const res = await commentRemoveUcComment(unifiedTo, {
|
|
1107
|
-
connectionId: "<id>",
|
|
1108
|
-
id: "<id>",
|
|
1109
|
-
});
|
|
1110
|
-
if (res.ok) {
|
|
1111
|
-
const { value: result } = res;
|
|
1112
|
-
console.log(result);
|
|
1113
|
-
} else {
|
|
1114
|
-
console.log("commentRemoveUcComment failed:", res.error);
|
|
1115
|
-
}
|
|
1116
|
-
}
|
|
1117
|
-
|
|
1118
|
-
run();
|
|
1119
|
-
```
|
|
1120
|
-
|
|
1121
|
-
### Parameters
|
|
1122
|
-
|
|
1123
|
-
| Parameter | Type | Required | Description |
|
|
1124
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1125
|
-
| `request` | [operations.RemoveUcCommentRequest](../../sdk/models/operations/removeuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1126
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1127
|
-
| `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. |
|
|
1128
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1129
|
-
|
|
1130
|
-
### Response
|
|
1131
|
-
|
|
1132
|
-
**Promise\<[operations.RemoveUcCommentResponse](../../sdk/models/operations/removeuccommentresponse.md)\>**
|
|
1133
|
-
|
|
1134
|
-
### Errors
|
|
1135
|
-
|
|
1136
|
-
| Error Type | Status Code | Content Type |
|
|
1137
|
-
| --------------- | --------------- | --------------- |
|
|
1138
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1139
|
-
|
|
1140
|
-
## removeUcContact
|
|
1141
|
-
|
|
1142
|
-
Remove a contact
|
|
1143
|
-
|
|
1144
|
-
### Example Usage
|
|
1145
|
-
|
|
1146
|
-
<!-- UsageSnippet language="typescript" operationID="removeUcContact" method="delete" path="/uc/{connection_id}/contact/{id}" -->
|
|
1147
|
-
```typescript
|
|
1148
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1149
|
-
|
|
1150
|
-
const unifiedTo = new UnifiedTo({
|
|
1151
|
-
security: {
|
|
1152
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1153
|
-
},
|
|
1154
|
-
});
|
|
1155
|
-
|
|
1156
|
-
async function run() {
|
|
1157
|
-
const result = await unifiedTo.uc.removeUcContact({
|
|
1158
|
-
connectionId: "<id>",
|
|
1159
|
-
id: "<id>",
|
|
1160
|
-
});
|
|
1161
|
-
|
|
1162
|
-
console.log(result);
|
|
1163
|
-
}
|
|
1164
|
-
|
|
1165
|
-
run();
|
|
1166
|
-
```
|
|
1167
|
-
|
|
1168
|
-
### Standalone function
|
|
1169
|
-
|
|
1170
|
-
The standalone function version of this method:
|
|
1171
|
-
|
|
1172
|
-
```typescript
|
|
1173
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1174
|
-
import { contactRemoveUcContact } from "@unified-api/typescript-sdk/funcs/contactRemoveUcContact.js";
|
|
1175
|
-
|
|
1176
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1177
|
-
// You can create one instance of it to use across an application.
|
|
1178
|
-
const unifiedTo = new UnifiedToCore({
|
|
1179
|
-
security: {
|
|
1180
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1181
|
-
},
|
|
1182
|
-
});
|
|
1183
|
-
|
|
1184
|
-
async function run() {
|
|
1185
|
-
const res = await contactRemoveUcContact(unifiedTo, {
|
|
1186
|
-
connectionId: "<id>",
|
|
1187
|
-
id: "<id>",
|
|
1188
|
-
});
|
|
1189
|
-
if (res.ok) {
|
|
1190
|
-
const { value: result } = res;
|
|
1191
|
-
console.log(result);
|
|
1192
|
-
} else {
|
|
1193
|
-
console.log("contactRemoveUcContact failed:", res.error);
|
|
1194
|
-
}
|
|
1195
|
-
}
|
|
1196
|
-
|
|
1197
|
-
run();
|
|
1198
|
-
```
|
|
1199
|
-
|
|
1200
|
-
### Parameters
|
|
1201
|
-
|
|
1202
|
-
| Parameter | Type | Required | Description |
|
|
1203
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1204
|
-
| `request` | [operations.RemoveUcContactRequest](../../sdk/models/operations/removeuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1205
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1206
|
-
| `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. |
|
|
1207
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1208
|
-
|
|
1209
|
-
### Response
|
|
1210
|
-
|
|
1211
|
-
**Promise\<[operations.RemoveUcContactResponse](../../sdk/models/operations/removeuccontactresponse.md)\>**
|
|
1212
|
-
|
|
1213
|
-
### Errors
|
|
1214
|
-
|
|
1215
|
-
| Error Type | Status Code | Content Type |
|
|
1216
|
-
| --------------- | --------------- | --------------- |
|
|
1217
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1218
|
-
|
|
1219
|
-
## removeUcRecording
|
|
1220
|
-
|
|
1221
|
-
Remove a recording
|
|
1222
|
-
|
|
1223
|
-
### Example Usage
|
|
1224
|
-
|
|
1225
|
-
<!-- UsageSnippet language="typescript" operationID="removeUcRecording" method="delete" path="/uc/{connection_id}/recording/{id}" -->
|
|
1226
|
-
```typescript
|
|
1227
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1228
|
-
|
|
1229
|
-
const unifiedTo = new UnifiedTo({
|
|
1230
|
-
security: {
|
|
1231
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1232
|
-
},
|
|
1233
|
-
});
|
|
1234
|
-
|
|
1235
|
-
async function run() {
|
|
1236
|
-
const result = await unifiedTo.uc.removeUcRecording({
|
|
1237
|
-
connectionId: "<id>",
|
|
1238
|
-
id: "<id>",
|
|
1239
|
-
});
|
|
1240
|
-
|
|
1241
|
-
console.log(result);
|
|
1242
|
-
}
|
|
1243
|
-
|
|
1244
|
-
run();
|
|
1245
|
-
```
|
|
1246
|
-
|
|
1247
|
-
### Standalone function
|
|
1248
|
-
|
|
1249
|
-
The standalone function version of this method:
|
|
1250
|
-
|
|
1251
|
-
```typescript
|
|
1252
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1253
|
-
import { recordingRemoveUcRecording } from "@unified-api/typescript-sdk/funcs/recordingRemoveUcRecording.js";
|
|
1254
|
-
|
|
1255
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1256
|
-
// You can create one instance of it to use across an application.
|
|
1257
|
-
const unifiedTo = new UnifiedToCore({
|
|
1258
|
-
security: {
|
|
1259
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1260
|
-
},
|
|
1261
|
-
});
|
|
1262
|
-
|
|
1263
|
-
async function run() {
|
|
1264
|
-
const res = await recordingRemoveUcRecording(unifiedTo, {
|
|
1265
|
-
connectionId: "<id>",
|
|
1266
|
-
id: "<id>",
|
|
1267
|
-
});
|
|
1268
|
-
if (res.ok) {
|
|
1269
|
-
const { value: result } = res;
|
|
1270
|
-
console.log(result);
|
|
1271
|
-
} else {
|
|
1272
|
-
console.log("recordingRemoveUcRecording failed:", res.error);
|
|
1273
|
-
}
|
|
1274
|
-
}
|
|
1275
|
-
|
|
1276
|
-
run();
|
|
1277
|
-
```
|
|
1278
|
-
|
|
1279
|
-
### Parameters
|
|
1280
|
-
|
|
1281
|
-
| Parameter | Type | Required | Description |
|
|
1282
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1283
|
-
| `request` | [operations.RemoveUcRecordingRequest](../../sdk/models/operations/removeucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1284
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1285
|
-
| `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. |
|
|
1286
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1287
|
-
|
|
1288
|
-
### Response
|
|
1289
|
-
|
|
1290
|
-
**Promise\<[operations.RemoveUcRecordingResponse](../../sdk/models/operations/removeucrecordingresponse.md)\>**
|
|
1291
|
-
|
|
1292
|
-
### Errors
|
|
1293
|
-
|
|
1294
|
-
| Error Type | Status Code | Content Type |
|
|
1295
|
-
| --------------- | --------------- | --------------- |
|
|
1296
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1297
|
-
|
|
1298
|
-
## updateUcComment
|
|
1299
|
-
|
|
1300
|
-
Update a comment
|
|
1301
|
-
|
|
1302
|
-
### Example Usage
|
|
1303
|
-
|
|
1304
|
-
<!-- UsageSnippet language="typescript" operationID="updateUcComment" method="put" path="/uc/{connection_id}/comment/{id}" -->
|
|
1305
|
-
```typescript
|
|
1306
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1307
|
-
|
|
1308
|
-
const unifiedTo = new UnifiedTo({
|
|
1309
|
-
security: {
|
|
1310
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1311
|
-
},
|
|
1312
|
-
});
|
|
1313
|
-
|
|
1314
|
-
async function run() {
|
|
1315
|
-
const result = await unifiedTo.uc.updateUcComment({
|
|
1316
|
-
ucComment: {
|
|
1317
|
-
content: "<value>",
|
|
1318
|
-
},
|
|
1319
|
-
connectionId: "<id>",
|
|
1320
|
-
id: "<id>",
|
|
1321
|
-
});
|
|
1322
|
-
|
|
1323
|
-
console.log(result);
|
|
1324
|
-
}
|
|
1325
|
-
|
|
1326
|
-
run();
|
|
1327
|
-
```
|
|
1328
|
-
|
|
1329
|
-
### Standalone function
|
|
1330
|
-
|
|
1331
|
-
The standalone function version of this method:
|
|
1332
|
-
|
|
1333
|
-
```typescript
|
|
1334
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1335
|
-
import { commentUpdateUcComment } from "@unified-api/typescript-sdk/funcs/commentUpdateUcComment.js";
|
|
1336
|
-
|
|
1337
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1338
|
-
// You can create one instance of it to use across an application.
|
|
1339
|
-
const unifiedTo = new UnifiedToCore({
|
|
1340
|
-
security: {
|
|
1341
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1342
|
-
},
|
|
1343
|
-
});
|
|
1344
|
-
|
|
1345
|
-
async function run() {
|
|
1346
|
-
const res = await commentUpdateUcComment(unifiedTo, {
|
|
1347
|
-
ucComment: {
|
|
1348
|
-
content: "<value>",
|
|
1349
|
-
},
|
|
1350
|
-
connectionId: "<id>",
|
|
1351
|
-
id: "<id>",
|
|
1352
|
-
});
|
|
1353
|
-
if (res.ok) {
|
|
1354
|
-
const { value: result } = res;
|
|
1355
|
-
console.log(result);
|
|
1356
|
-
} else {
|
|
1357
|
-
console.log("commentUpdateUcComment failed:", res.error);
|
|
1358
|
-
}
|
|
1359
|
-
}
|
|
1360
|
-
|
|
1361
|
-
run();
|
|
1362
|
-
```
|
|
1363
|
-
|
|
1364
|
-
### Parameters
|
|
1365
|
-
|
|
1366
|
-
| Parameter | Type | Required | Description |
|
|
1367
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1368
|
-
| `request` | [operations.UpdateUcCommentRequest](../../sdk/models/operations/updateuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1369
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1370
|
-
| `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. |
|
|
1371
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1372
|
-
|
|
1373
|
-
### Response
|
|
1374
|
-
|
|
1375
|
-
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
1376
|
-
|
|
1377
|
-
### Errors
|
|
1378
|
-
|
|
1379
|
-
| Error Type | Status Code | Content Type |
|
|
1380
|
-
| --------------- | --------------- | --------------- |
|
|
1381
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1382
|
-
|
|
1383
|
-
## updateUcContact
|
|
1384
|
-
|
|
1385
|
-
Update a contact
|
|
1386
|
-
|
|
1387
|
-
### Example Usage
|
|
1388
|
-
|
|
1389
|
-
<!-- UsageSnippet language="typescript" operationID="updateUcContact" method="put" path="/uc/{connection_id}/contact/{id}" -->
|
|
1390
|
-
```typescript
|
|
1391
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1392
|
-
|
|
1393
|
-
const unifiedTo = new UnifiedTo({
|
|
1394
|
-
security: {
|
|
1395
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1396
|
-
},
|
|
1397
|
-
});
|
|
1398
|
-
|
|
1399
|
-
async function run() {
|
|
1400
|
-
const result = await unifiedTo.uc.updateUcContact({
|
|
1401
|
-
ucContact: {},
|
|
1402
|
-
connectionId: "<id>",
|
|
1403
|
-
id: "<id>",
|
|
1404
|
-
});
|
|
1405
|
-
|
|
1406
|
-
console.log(result);
|
|
1407
|
-
}
|
|
1408
|
-
|
|
1409
|
-
run();
|
|
1410
|
-
```
|
|
1411
|
-
|
|
1412
|
-
### Standalone function
|
|
1413
|
-
|
|
1414
|
-
The standalone function version of this method:
|
|
1415
|
-
|
|
1416
|
-
```typescript
|
|
1417
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1418
|
-
import { contactUpdateUcContact } from "@unified-api/typescript-sdk/funcs/contactUpdateUcContact.js";
|
|
1419
|
-
|
|
1420
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1421
|
-
// You can create one instance of it to use across an application.
|
|
1422
|
-
const unifiedTo = new UnifiedToCore({
|
|
1423
|
-
security: {
|
|
1424
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1425
|
-
},
|
|
1426
|
-
});
|
|
1427
|
-
|
|
1428
|
-
async function run() {
|
|
1429
|
-
const res = await contactUpdateUcContact(unifiedTo, {
|
|
1430
|
-
ucContact: {},
|
|
1431
|
-
connectionId: "<id>",
|
|
1432
|
-
id: "<id>",
|
|
1433
|
-
});
|
|
1434
|
-
if (res.ok) {
|
|
1435
|
-
const { value: result } = res;
|
|
1436
|
-
console.log(result);
|
|
1437
|
-
} else {
|
|
1438
|
-
console.log("contactUpdateUcContact failed:", res.error);
|
|
1439
|
-
}
|
|
1440
|
-
}
|
|
1441
|
-
|
|
1442
|
-
run();
|
|
1443
|
-
```
|
|
1444
|
-
|
|
1445
|
-
### Parameters
|
|
1446
|
-
|
|
1447
|
-
| Parameter | Type | Required | Description |
|
|
1448
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1449
|
-
| `request` | [operations.UpdateUcContactRequest](../../sdk/models/operations/updateuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1450
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1451
|
-
| `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. |
|
|
1452
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1453
|
-
|
|
1454
|
-
### Response
|
|
1455
|
-
|
|
1456
|
-
**Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
|
|
1457
|
-
|
|
1458
|
-
### Errors
|
|
1459
|
-
|
|
1460
|
-
| Error Type | Status Code | Content Type |
|
|
1461
|
-
| --------------- | --------------- | --------------- |
|
|
1462
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1463
|
-
|
|
1464
|
-
## updateUcRecording
|
|
1465
|
-
|
|
1466
|
-
Update a recording
|
|
1467
|
-
|
|
1468
|
-
### Example Usage
|
|
1469
|
-
|
|
1470
|
-
<!-- UsageSnippet language="typescript" operationID="updateUcRecording" method="put" path="/uc/{connection_id}/recording/{id}" -->
|
|
1471
|
-
```typescript
|
|
1472
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1473
|
-
|
|
1474
|
-
const unifiedTo = new UnifiedTo({
|
|
1475
|
-
security: {
|
|
1476
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1477
|
-
},
|
|
1478
|
-
});
|
|
1479
|
-
|
|
1480
|
-
async function run() {
|
|
1481
|
-
const result = await unifiedTo.uc.updateUcRecording({
|
|
1482
|
-
ucRecording: {},
|
|
1483
|
-
connectionId: "<id>",
|
|
1484
|
-
id: "<id>",
|
|
1485
|
-
});
|
|
1486
|
-
|
|
1487
|
-
console.log(result);
|
|
1488
|
-
}
|
|
1489
|
-
|
|
1490
|
-
run();
|
|
1491
|
-
```
|
|
1492
|
-
|
|
1493
|
-
### Standalone function
|
|
1494
|
-
|
|
1495
|
-
The standalone function version of this method:
|
|
1496
|
-
|
|
1497
|
-
```typescript
|
|
1498
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1499
|
-
import { recordingUpdateUcRecording } from "@unified-api/typescript-sdk/funcs/recordingUpdateUcRecording.js";
|
|
1500
|
-
|
|
1501
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1502
|
-
// You can create one instance of it to use across an application.
|
|
1503
|
-
const unifiedTo = new UnifiedToCore({
|
|
1504
|
-
security: {
|
|
1505
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1506
|
-
},
|
|
1507
|
-
});
|
|
1508
|
-
|
|
1509
|
-
async function run() {
|
|
1510
|
-
const res = await recordingUpdateUcRecording(unifiedTo, {
|
|
1511
|
-
ucRecording: {},
|
|
1512
|
-
connectionId: "<id>",
|
|
1513
|
-
id: "<id>",
|
|
1514
|
-
});
|
|
1515
|
-
if (res.ok) {
|
|
1516
|
-
const { value: result } = res;
|
|
1517
|
-
console.log(result);
|
|
1518
|
-
} else {
|
|
1519
|
-
console.log("recordingUpdateUcRecording failed:", res.error);
|
|
1520
|
-
}
|
|
1521
|
-
}
|
|
1522
|
-
|
|
1523
|
-
run();
|
|
1524
|
-
```
|
|
1525
|
-
|
|
1526
|
-
### Parameters
|
|
1527
|
-
|
|
1528
|
-
| Parameter | Type | Required | Description |
|
|
1529
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1530
|
-
| `request` | [operations.UpdateUcRecordingRequest](../../sdk/models/operations/updateucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1531
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1532
|
-
| `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. |
|
|
1533
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1534
|
-
|
|
1535
|
-
### Response
|
|
1536
|
-
|
|
1537
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
1538
|
-
|
|
1539
|
-
### Errors
|
|
1540
|
-
|
|
1541
|
-
| Error Type | Status Code | Content Type |
|
|
1542
|
-
| --------------- | --------------- | --------------- |
|
|
1543
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|