@unified-api/typescript-sdk 2.79.0 → 2.80.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/package.json +1 -1
- package/sdk/models/shared/calendareventrecurrence.d.ts +2 -5
- package/sdk/models/shared/calendareventrecurrence.d.ts.map +1 -1
- package/sdk/models/shared/calendareventrecurrence.js +2 -2
- package/sdk/models/shared/calendareventrecurrence.js.map +1 -1
- package/sdk/models/shared/index.d.ts +5 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +5 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/integration.d.ts +3 -2
- package/sdk/models/shared/integration.d.ts.map +1 -1
- package/sdk/models/shared/integration.js +3 -2
- package/sdk/models/shared/integration.js.map +1 -1
- package/sdk/models/shared/integrationsupport.d.ts +2410 -0
- package/sdk/models/shared/integrationsupport.d.ts.map +1 -0
- package/sdk/models/shared/integrationsupport.js +3440 -0
- package/sdk/models/shared/integrationsupport.js.map +1 -0
- package/sdk/models/shared/kmspage.d.ts +2 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +4 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts +36 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.js +79 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookevents.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts +22 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts.map +1 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js +68 -0
- package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js.map +1 -0
- package/sdk/models/shared/webhook.d.ts +2 -2
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +2 -2
- package/sdk/models/shared/webhook.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/sdk/models/shared/calendareventrecurrence.ts +4 -7
- package/src/sdk/models/shared/index.ts +5 -0
- package/src/sdk/models/shared/integration.ts +10 -4
- package/src/sdk/models/shared/integrationsupport.ts +4969 -0
- package/src/sdk/models/shared/kmspage.ts +6 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookevents.ts +109 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.ts +54 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.ts +54 -0
- package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.ts +54 -0
- package/src/sdk/models/shared/webhook.ts +4 -4
- package/docs/sdks/account/README.md +0 -489
- package/docs/sdks/accounting/README.md +0 -7221
- package/docs/sdks/activity/README.md +0 -489
- package/docs/sdks/apicall/README.md +0 -159
- package/docs/sdks/application/README.md +0 -489
- package/docs/sdks/applicationstatus/README.md +0 -85
- package/docs/sdks/ats/README.md +0 -3953
- package/docs/sdks/auth/README.md +0 -167
- package/docs/sdks/balancesheet/README.md +0 -165
- package/docs/sdks/bill/README.md +0 -489
- package/docs/sdks/branch/README.md +0 -507
- package/docs/sdks/busy/README.md +0 -85
- package/docs/sdks/calendar/README.md +0 -1713
- package/docs/sdks/call/README.md +0 -85
- package/docs/sdks/candidate/README.md +0 -489
- package/docs/sdks/cashflow/README.md +0 -165
- package/docs/sdks/category/README.md +0 -971
- package/docs/sdks/change/README.md +0 -165
- package/docs/sdks/channel/README.md +0 -165
- package/docs/sdks/class/README.md +0 -507
- package/docs/sdks/collection/README.md +0 -501
- package/docs/sdks/comment/README.md +0 -1495
- package/docs/sdks/commerce/README.md +0 -2465
- package/docs/sdks/commit/README.md +0 -501
- package/docs/sdks/company/README.md +0 -1543
- package/docs/sdks/connection/README.md +0 -513
- package/docs/sdks/contact/README.md +0 -1453
- package/docs/sdks/course/README.md +0 -501
- package/docs/sdks/creditmemo/README.md +0 -489
- package/docs/sdks/crm/README.md +0 -2899
- package/docs/sdks/customer/README.md +0 -489
- package/docs/sdks/deal/README.md +0 -489
- package/docs/sdks/device/README.md +0 -501
- package/docs/sdks/document/README.md +0 -489
- package/docs/sdks/embedding/README.md +0 -87
- package/docs/sdks/employee/README.md +0 -489
- package/docs/sdks/enrich/README.md +0 -163
- package/docs/sdks/event/README.md +0 -971
- package/docs/sdks/expense/README.md +0 -489
- package/docs/sdks/file/README.md +0 -489
- package/docs/sdks/genai/README.md +0 -325
- package/docs/sdks/group/README.md +0 -983
- package/docs/sdks/hris/README.md +0 -3251
- package/docs/sdks/instructor/README.md +0 -489
- package/docs/sdks/integration/README.md +0 -239
- package/docs/sdks/interview/README.md +0 -489
- package/docs/sdks/inventory/README.md +0 -501
- package/docs/sdks/invoice/README.md +0 -489
- package/docs/sdks/issue/README.md +0 -159
- package/docs/sdks/item/README.md +0 -489
- package/docs/sdks/job/README.md +0 -489
- package/docs/sdks/journal/README.md +0 -489
- package/docs/sdks/kms/README.md +0 -1495
- package/docs/sdks/lead/README.md +0 -489
- package/docs/sdks/link/README.md +0 -983
- package/docs/sdks/list/README.md +0 -489
- package/docs/sdks/lms/README.md +0 -1965
- package/docs/sdks/location/README.md +0 -983
- package/docs/sdks/login/README.md +0 -87
- package/docs/sdks/martech/README.md +0 -971
- package/docs/sdks/member/README.md +0 -489
- package/docs/sdks/message/README.md +0 -489
- package/docs/sdks/messaging/README.md +0 -647
- package/docs/sdks/metadata/README.md +0 -507
- package/docs/sdks/model/README.md +0 -165
- package/docs/sdks/note/README.md +0 -489
- package/docs/sdks/order/README.md +0 -489
- package/docs/sdks/organization/README.md +0 -647
- package/docs/sdks/package/README.md +0 -165
- package/docs/sdks/page/README.md +0 -507
- package/docs/sdks/passthrough/README.md +0 -647
- package/docs/sdks/payment/README.md +0 -1769
- package/docs/sdks/payout/README.md +0 -165
- package/docs/sdks/payslip/README.md +0 -165
- package/docs/sdks/person/README.md +0 -85
- package/docs/sdks/pipeline/README.md +0 -489
- package/docs/sdks/profitloss/README.md +0 -165
- package/docs/sdks/project/README.md +0 -489
- package/docs/sdks/prompt/README.md +0 -87
- package/docs/sdks/pullrequest/README.md +0 -489
- package/docs/sdks/purchaseorder/README.md +0 -489
- package/docs/sdks/recording/README.md +0 -647
- package/docs/sdks/refund/README.md +0 -165
- package/docs/sdks/repo/README.md +0 -2459
- package/docs/sdks/report/README.md +0 -165
- package/docs/sdks/repository/README.md +0 -501
- package/docs/sdks/request/README.md +0 -489
- package/docs/sdks/review/README.md +0 -501
- package/docs/sdks/salesorder/README.md +0 -489
- package/docs/sdks/scim/README.md +0 -983
- package/docs/sdks/scorecard/README.md +0 -489
- package/docs/sdks/space/README.md +0 -501
- package/docs/sdks/storage/README.md +0 -489
- package/docs/sdks/student/README.md +0 -489
- package/docs/sdks/subscription/README.md +0 -489
- package/docs/sdks/task/README.md +0 -1629
- package/docs/sdks/taxrate/README.md +0 -489
- package/docs/sdks/ticket/README.md +0 -489
- package/docs/sdks/ticketing/README.md +0 -1935
- package/docs/sdks/timeoff/README.md +0 -165
- package/docs/sdks/timeshift/README.md +0 -513
- package/docs/sdks/transaction/README.md +0 -489
- package/docs/sdks/trialbalance/README.md +0 -165
- package/docs/sdks/uc/README.md +0 -1543
- package/docs/sdks/unified/README.md +0 -1697
- package/docs/sdks/user/README.md +0 -489
- package/docs/sdks/verification/README.md +0 -647
- package/docs/sdks/webhook/README.md +0 -655
- package/examples/README.md +0 -31
|
@@ -1,647 +0,0 @@
|
|
|
1
|
-
# Recording
|
|
2
|
-
(*recording*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [createUcRecording](#createucrecording) - Create a recording
|
|
9
|
-
* [getCalendarRecording](#getcalendarrecording) - Retrieve a recording
|
|
10
|
-
* [getUcRecording](#getucrecording) - Retrieve a recording
|
|
11
|
-
* [listCalendarRecordings](#listcalendarrecordings) - List all recordings
|
|
12
|
-
* [listUcRecordings](#listucrecordings) - List all recordings
|
|
13
|
-
* [patchUcRecording](#patchucrecording) - Update a recording
|
|
14
|
-
* [removeUcRecording](#removeucrecording) - Remove a recording
|
|
15
|
-
* [updateUcRecording](#updateucrecording) - Update a recording
|
|
16
|
-
|
|
17
|
-
## createUcRecording
|
|
18
|
-
|
|
19
|
-
Create a recording
|
|
20
|
-
|
|
21
|
-
### Example Usage
|
|
22
|
-
|
|
23
|
-
<!-- UsageSnippet language="typescript" operationID="createUcRecording" method="post" path="/uc/{connection_id}/recording" -->
|
|
24
|
-
```typescript
|
|
25
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
26
|
-
|
|
27
|
-
const unifiedTo = new UnifiedTo({
|
|
28
|
-
security: {
|
|
29
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
30
|
-
},
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
async function run() {
|
|
34
|
-
const result = await unifiedTo.recording.createUcRecording({
|
|
35
|
-
ucRecording: {},
|
|
36
|
-
connectionId: "<id>",
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
console.log(result);
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
run();
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
### Standalone function
|
|
46
|
-
|
|
47
|
-
The standalone function version of this method:
|
|
48
|
-
|
|
49
|
-
```typescript
|
|
50
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
51
|
-
import { recordingCreateUcRecording } from "@unified-api/typescript-sdk/funcs/recordingCreateUcRecording.js";
|
|
52
|
-
|
|
53
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
54
|
-
// You can create one instance of it to use across an application.
|
|
55
|
-
const unifiedTo = new UnifiedToCore({
|
|
56
|
-
security: {
|
|
57
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
58
|
-
},
|
|
59
|
-
});
|
|
60
|
-
|
|
61
|
-
async function run() {
|
|
62
|
-
const res = await recordingCreateUcRecording(unifiedTo, {
|
|
63
|
-
ucRecording: {},
|
|
64
|
-
connectionId: "<id>",
|
|
65
|
-
});
|
|
66
|
-
if (res.ok) {
|
|
67
|
-
const { value: result } = res;
|
|
68
|
-
console.log(result);
|
|
69
|
-
} else {
|
|
70
|
-
console.log("recordingCreateUcRecording failed:", res.error);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
run();
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Parameters
|
|
78
|
-
|
|
79
|
-
| Parameter | Type | Required | Description |
|
|
80
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `request` | [operations.CreateUcRecordingRequest](../../sdk/models/operations/createucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
82
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
83
|
-
| `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. |
|
|
84
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
85
|
-
|
|
86
|
-
### Response
|
|
87
|
-
|
|
88
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
89
|
-
|
|
90
|
-
### Errors
|
|
91
|
-
|
|
92
|
-
| Error Type | Status Code | Content Type |
|
|
93
|
-
| --------------- | --------------- | --------------- |
|
|
94
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
95
|
-
|
|
96
|
-
## getCalendarRecording
|
|
97
|
-
|
|
98
|
-
Retrieve a recording
|
|
99
|
-
|
|
100
|
-
### Example Usage
|
|
101
|
-
|
|
102
|
-
<!-- UsageSnippet language="typescript" operationID="getCalendarRecording" method="get" path="/calendar/{connection_id}/recording/{id}" -->
|
|
103
|
-
```typescript
|
|
104
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
105
|
-
|
|
106
|
-
const unifiedTo = new UnifiedTo({
|
|
107
|
-
security: {
|
|
108
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
109
|
-
},
|
|
110
|
-
});
|
|
111
|
-
|
|
112
|
-
async function run() {
|
|
113
|
-
const result = await unifiedTo.recording.getCalendarRecording({
|
|
114
|
-
connectionId: "<id>",
|
|
115
|
-
id: "<id>",
|
|
116
|
-
});
|
|
117
|
-
|
|
118
|
-
console.log(result);
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
run();
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Standalone function
|
|
125
|
-
|
|
126
|
-
The standalone function version of this method:
|
|
127
|
-
|
|
128
|
-
```typescript
|
|
129
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
130
|
-
import { calendarGetCalendarRecording } from "@unified-api/typescript-sdk/funcs/calendarGetCalendarRecording.js";
|
|
131
|
-
|
|
132
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
133
|
-
// You can create one instance of it to use across an application.
|
|
134
|
-
const unifiedTo = new UnifiedToCore({
|
|
135
|
-
security: {
|
|
136
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
137
|
-
},
|
|
138
|
-
});
|
|
139
|
-
|
|
140
|
-
async function run() {
|
|
141
|
-
const res = await calendarGetCalendarRecording(unifiedTo, {
|
|
142
|
-
connectionId: "<id>",
|
|
143
|
-
id: "<id>",
|
|
144
|
-
});
|
|
145
|
-
if (res.ok) {
|
|
146
|
-
const { value: result } = res;
|
|
147
|
-
console.log(result);
|
|
148
|
-
} else {
|
|
149
|
-
console.log("calendarGetCalendarRecording failed:", res.error);
|
|
150
|
-
}
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
run();
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
### Parameters
|
|
157
|
-
|
|
158
|
-
| Parameter | Type | Required | Description |
|
|
159
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
160
|
-
| `request` | [operations.GetCalendarRecordingRequest](../../sdk/models/operations/getcalendarrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
161
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
162
|
-
| `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. |
|
|
163
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
164
|
-
|
|
165
|
-
### Response
|
|
166
|
-
|
|
167
|
-
**Promise\<[shared.CalendarRecording](../../sdk/models/shared/calendarrecording.md)\>**
|
|
168
|
-
|
|
169
|
-
### Errors
|
|
170
|
-
|
|
171
|
-
| Error Type | Status Code | Content Type |
|
|
172
|
-
| --------------- | --------------- | --------------- |
|
|
173
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
174
|
-
|
|
175
|
-
## getUcRecording
|
|
176
|
-
|
|
177
|
-
Retrieve a recording
|
|
178
|
-
|
|
179
|
-
### Example Usage
|
|
180
|
-
|
|
181
|
-
<!-- UsageSnippet language="typescript" operationID="getUcRecording" method="get" path="/uc/{connection_id}/recording/{id}" -->
|
|
182
|
-
```typescript
|
|
183
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
184
|
-
|
|
185
|
-
const unifiedTo = new UnifiedTo({
|
|
186
|
-
security: {
|
|
187
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
188
|
-
},
|
|
189
|
-
});
|
|
190
|
-
|
|
191
|
-
async function run() {
|
|
192
|
-
const result = await unifiedTo.recording.getUcRecording({
|
|
193
|
-
connectionId: "<id>",
|
|
194
|
-
id: "<id>",
|
|
195
|
-
});
|
|
196
|
-
|
|
197
|
-
console.log(result);
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
run();
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### Standalone function
|
|
204
|
-
|
|
205
|
-
The standalone function version of this method:
|
|
206
|
-
|
|
207
|
-
```typescript
|
|
208
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
209
|
-
import { recordingGetUcRecording } from "@unified-api/typescript-sdk/funcs/recordingGetUcRecording.js";
|
|
210
|
-
|
|
211
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
212
|
-
// You can create one instance of it to use across an application.
|
|
213
|
-
const unifiedTo = new UnifiedToCore({
|
|
214
|
-
security: {
|
|
215
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
216
|
-
},
|
|
217
|
-
});
|
|
218
|
-
|
|
219
|
-
async function run() {
|
|
220
|
-
const res = await recordingGetUcRecording(unifiedTo, {
|
|
221
|
-
connectionId: "<id>",
|
|
222
|
-
id: "<id>",
|
|
223
|
-
});
|
|
224
|
-
if (res.ok) {
|
|
225
|
-
const { value: result } = res;
|
|
226
|
-
console.log(result);
|
|
227
|
-
} else {
|
|
228
|
-
console.log("recordingGetUcRecording failed:", res.error);
|
|
229
|
-
}
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
run();
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
### Parameters
|
|
236
|
-
|
|
237
|
-
| Parameter | Type | Required | Description |
|
|
238
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
239
|
-
| `request` | [operations.GetUcRecordingRequest](../../sdk/models/operations/getucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
240
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
241
|
-
| `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. |
|
|
242
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
243
|
-
|
|
244
|
-
### Response
|
|
245
|
-
|
|
246
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
247
|
-
|
|
248
|
-
### Errors
|
|
249
|
-
|
|
250
|
-
| Error Type | Status Code | Content Type |
|
|
251
|
-
| --------------- | --------------- | --------------- |
|
|
252
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
253
|
-
|
|
254
|
-
## listCalendarRecordings
|
|
255
|
-
|
|
256
|
-
List all recordings
|
|
257
|
-
|
|
258
|
-
### Example Usage
|
|
259
|
-
|
|
260
|
-
<!-- UsageSnippet language="typescript" operationID="listCalendarRecordings" method="get" path="/calendar/{connection_id}/recording" -->
|
|
261
|
-
```typescript
|
|
262
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
263
|
-
|
|
264
|
-
const unifiedTo = new UnifiedTo({
|
|
265
|
-
security: {
|
|
266
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
267
|
-
},
|
|
268
|
-
});
|
|
269
|
-
|
|
270
|
-
async function run() {
|
|
271
|
-
const result = await unifiedTo.recording.listCalendarRecordings({
|
|
272
|
-
connectionId: "<id>",
|
|
273
|
-
});
|
|
274
|
-
|
|
275
|
-
console.log(result);
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
run();
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
### Standalone function
|
|
282
|
-
|
|
283
|
-
The standalone function version of this method:
|
|
284
|
-
|
|
285
|
-
```typescript
|
|
286
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
287
|
-
import { calendarListCalendarRecordings } from "@unified-api/typescript-sdk/funcs/calendarListCalendarRecordings.js";
|
|
288
|
-
|
|
289
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
290
|
-
// You can create one instance of it to use across an application.
|
|
291
|
-
const unifiedTo = new UnifiedToCore({
|
|
292
|
-
security: {
|
|
293
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
294
|
-
},
|
|
295
|
-
});
|
|
296
|
-
|
|
297
|
-
async function run() {
|
|
298
|
-
const res = await calendarListCalendarRecordings(unifiedTo, {
|
|
299
|
-
connectionId: "<id>",
|
|
300
|
-
});
|
|
301
|
-
if (res.ok) {
|
|
302
|
-
const { value: result } = res;
|
|
303
|
-
console.log(result);
|
|
304
|
-
} else {
|
|
305
|
-
console.log("calendarListCalendarRecordings failed:", res.error);
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
run();
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
### Parameters
|
|
313
|
-
|
|
314
|
-
| Parameter | Type | Required | Description |
|
|
315
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
316
|
-
| `request` | [operations.ListCalendarRecordingsRequest](../../sdk/models/operations/listcalendarrecordingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
317
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
318
|
-
| `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. |
|
|
319
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
320
|
-
|
|
321
|
-
### Response
|
|
322
|
-
|
|
323
|
-
**Promise\<[shared.CalendarRecording[]](../../models/.md)\>**
|
|
324
|
-
|
|
325
|
-
### Errors
|
|
326
|
-
|
|
327
|
-
| Error Type | Status Code | Content Type |
|
|
328
|
-
| --------------- | --------------- | --------------- |
|
|
329
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
330
|
-
|
|
331
|
-
## listUcRecordings
|
|
332
|
-
|
|
333
|
-
List all recordings
|
|
334
|
-
|
|
335
|
-
### Example Usage
|
|
336
|
-
|
|
337
|
-
<!-- UsageSnippet language="typescript" operationID="listUcRecordings" method="get" path="/uc/{connection_id}/recording" -->
|
|
338
|
-
```typescript
|
|
339
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
340
|
-
|
|
341
|
-
const unifiedTo = new UnifiedTo({
|
|
342
|
-
security: {
|
|
343
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
344
|
-
},
|
|
345
|
-
});
|
|
346
|
-
|
|
347
|
-
async function run() {
|
|
348
|
-
const result = await unifiedTo.recording.listUcRecordings({
|
|
349
|
-
connectionId: "<id>",
|
|
350
|
-
});
|
|
351
|
-
|
|
352
|
-
console.log(result);
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
run();
|
|
356
|
-
```
|
|
357
|
-
|
|
358
|
-
### Standalone function
|
|
359
|
-
|
|
360
|
-
The standalone function version of this method:
|
|
361
|
-
|
|
362
|
-
```typescript
|
|
363
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
364
|
-
import { recordingListUcRecordings } from "@unified-api/typescript-sdk/funcs/recordingListUcRecordings.js";
|
|
365
|
-
|
|
366
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
367
|
-
// You can create one instance of it to use across an application.
|
|
368
|
-
const unifiedTo = new UnifiedToCore({
|
|
369
|
-
security: {
|
|
370
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
371
|
-
},
|
|
372
|
-
});
|
|
373
|
-
|
|
374
|
-
async function run() {
|
|
375
|
-
const res = await recordingListUcRecordings(unifiedTo, {
|
|
376
|
-
connectionId: "<id>",
|
|
377
|
-
});
|
|
378
|
-
if (res.ok) {
|
|
379
|
-
const { value: result } = res;
|
|
380
|
-
console.log(result);
|
|
381
|
-
} else {
|
|
382
|
-
console.log("recordingListUcRecordings failed:", res.error);
|
|
383
|
-
}
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
run();
|
|
387
|
-
```
|
|
388
|
-
|
|
389
|
-
### Parameters
|
|
390
|
-
|
|
391
|
-
| Parameter | Type | Required | Description |
|
|
392
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
393
|
-
| `request` | [operations.ListUcRecordingsRequest](../../sdk/models/operations/listucrecordingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
394
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
395
|
-
| `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. |
|
|
396
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
397
|
-
|
|
398
|
-
### Response
|
|
399
|
-
|
|
400
|
-
**Promise\<[shared.UcRecording[]](../../models/.md)\>**
|
|
401
|
-
|
|
402
|
-
### Errors
|
|
403
|
-
|
|
404
|
-
| Error Type | Status Code | Content Type |
|
|
405
|
-
| --------------- | --------------- | --------------- |
|
|
406
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
407
|
-
|
|
408
|
-
## patchUcRecording
|
|
409
|
-
|
|
410
|
-
Update a recording
|
|
411
|
-
|
|
412
|
-
### Example Usage
|
|
413
|
-
|
|
414
|
-
<!-- UsageSnippet language="typescript" operationID="patchUcRecording" method="patch" path="/uc/{connection_id}/recording/{id}" -->
|
|
415
|
-
```typescript
|
|
416
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
417
|
-
|
|
418
|
-
const unifiedTo = new UnifiedTo({
|
|
419
|
-
security: {
|
|
420
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
421
|
-
},
|
|
422
|
-
});
|
|
423
|
-
|
|
424
|
-
async function run() {
|
|
425
|
-
const result = await unifiedTo.recording.patchUcRecording({
|
|
426
|
-
ucRecording: {},
|
|
427
|
-
connectionId: "<id>",
|
|
428
|
-
id: "<id>",
|
|
429
|
-
});
|
|
430
|
-
|
|
431
|
-
console.log(result);
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
run();
|
|
435
|
-
```
|
|
436
|
-
|
|
437
|
-
### Standalone function
|
|
438
|
-
|
|
439
|
-
The standalone function version of this method:
|
|
440
|
-
|
|
441
|
-
```typescript
|
|
442
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
443
|
-
import { recordingPatchUcRecording } from "@unified-api/typescript-sdk/funcs/recordingPatchUcRecording.js";
|
|
444
|
-
|
|
445
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
446
|
-
// You can create one instance of it to use across an application.
|
|
447
|
-
const unifiedTo = new UnifiedToCore({
|
|
448
|
-
security: {
|
|
449
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
450
|
-
},
|
|
451
|
-
});
|
|
452
|
-
|
|
453
|
-
async function run() {
|
|
454
|
-
const res = await recordingPatchUcRecording(unifiedTo, {
|
|
455
|
-
ucRecording: {},
|
|
456
|
-
connectionId: "<id>",
|
|
457
|
-
id: "<id>",
|
|
458
|
-
});
|
|
459
|
-
if (res.ok) {
|
|
460
|
-
const { value: result } = res;
|
|
461
|
-
console.log(result);
|
|
462
|
-
} else {
|
|
463
|
-
console.log("recordingPatchUcRecording failed:", res.error);
|
|
464
|
-
}
|
|
465
|
-
}
|
|
466
|
-
|
|
467
|
-
run();
|
|
468
|
-
```
|
|
469
|
-
|
|
470
|
-
### Parameters
|
|
471
|
-
|
|
472
|
-
| Parameter | Type | Required | Description |
|
|
473
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
474
|
-
| `request` | [operations.PatchUcRecordingRequest](../../sdk/models/operations/patchucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
475
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
476
|
-
| `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. |
|
|
477
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
478
|
-
|
|
479
|
-
### Response
|
|
480
|
-
|
|
481
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
482
|
-
|
|
483
|
-
### Errors
|
|
484
|
-
|
|
485
|
-
| Error Type | Status Code | Content Type |
|
|
486
|
-
| --------------- | --------------- | --------------- |
|
|
487
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
488
|
-
|
|
489
|
-
## removeUcRecording
|
|
490
|
-
|
|
491
|
-
Remove a recording
|
|
492
|
-
|
|
493
|
-
### Example Usage
|
|
494
|
-
|
|
495
|
-
<!-- UsageSnippet language="typescript" operationID="removeUcRecording" method="delete" path="/uc/{connection_id}/recording/{id}" -->
|
|
496
|
-
```typescript
|
|
497
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
498
|
-
|
|
499
|
-
const unifiedTo = new UnifiedTo({
|
|
500
|
-
security: {
|
|
501
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
502
|
-
},
|
|
503
|
-
});
|
|
504
|
-
|
|
505
|
-
async function run() {
|
|
506
|
-
const result = await unifiedTo.recording.removeUcRecording({
|
|
507
|
-
connectionId: "<id>",
|
|
508
|
-
id: "<id>",
|
|
509
|
-
});
|
|
510
|
-
|
|
511
|
-
console.log(result);
|
|
512
|
-
}
|
|
513
|
-
|
|
514
|
-
run();
|
|
515
|
-
```
|
|
516
|
-
|
|
517
|
-
### Standalone function
|
|
518
|
-
|
|
519
|
-
The standalone function version of this method:
|
|
520
|
-
|
|
521
|
-
```typescript
|
|
522
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
523
|
-
import { recordingRemoveUcRecording } from "@unified-api/typescript-sdk/funcs/recordingRemoveUcRecording.js";
|
|
524
|
-
|
|
525
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
526
|
-
// You can create one instance of it to use across an application.
|
|
527
|
-
const unifiedTo = new UnifiedToCore({
|
|
528
|
-
security: {
|
|
529
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
530
|
-
},
|
|
531
|
-
});
|
|
532
|
-
|
|
533
|
-
async function run() {
|
|
534
|
-
const res = await recordingRemoveUcRecording(unifiedTo, {
|
|
535
|
-
connectionId: "<id>",
|
|
536
|
-
id: "<id>",
|
|
537
|
-
});
|
|
538
|
-
if (res.ok) {
|
|
539
|
-
const { value: result } = res;
|
|
540
|
-
console.log(result);
|
|
541
|
-
} else {
|
|
542
|
-
console.log("recordingRemoveUcRecording failed:", res.error);
|
|
543
|
-
}
|
|
544
|
-
}
|
|
545
|
-
|
|
546
|
-
run();
|
|
547
|
-
```
|
|
548
|
-
|
|
549
|
-
### Parameters
|
|
550
|
-
|
|
551
|
-
| Parameter | Type | Required | Description |
|
|
552
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
553
|
-
| `request` | [operations.RemoveUcRecordingRequest](../../sdk/models/operations/removeucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
554
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
555
|
-
| `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. |
|
|
556
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
557
|
-
|
|
558
|
-
### Response
|
|
559
|
-
|
|
560
|
-
**Promise\<[operations.RemoveUcRecordingResponse](../../sdk/models/operations/removeucrecordingresponse.md)\>**
|
|
561
|
-
|
|
562
|
-
### Errors
|
|
563
|
-
|
|
564
|
-
| Error Type | Status Code | Content Type |
|
|
565
|
-
| --------------- | --------------- | --------------- |
|
|
566
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
567
|
-
|
|
568
|
-
## updateUcRecording
|
|
569
|
-
|
|
570
|
-
Update a recording
|
|
571
|
-
|
|
572
|
-
### Example Usage
|
|
573
|
-
|
|
574
|
-
<!-- UsageSnippet language="typescript" operationID="updateUcRecording" method="put" path="/uc/{connection_id}/recording/{id}" -->
|
|
575
|
-
```typescript
|
|
576
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
577
|
-
|
|
578
|
-
const unifiedTo = new UnifiedTo({
|
|
579
|
-
security: {
|
|
580
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
581
|
-
},
|
|
582
|
-
});
|
|
583
|
-
|
|
584
|
-
async function run() {
|
|
585
|
-
const result = await unifiedTo.recording.updateUcRecording({
|
|
586
|
-
ucRecording: {},
|
|
587
|
-
connectionId: "<id>",
|
|
588
|
-
id: "<id>",
|
|
589
|
-
});
|
|
590
|
-
|
|
591
|
-
console.log(result);
|
|
592
|
-
}
|
|
593
|
-
|
|
594
|
-
run();
|
|
595
|
-
```
|
|
596
|
-
|
|
597
|
-
### Standalone function
|
|
598
|
-
|
|
599
|
-
The standalone function version of this method:
|
|
600
|
-
|
|
601
|
-
```typescript
|
|
602
|
-
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
603
|
-
import { recordingUpdateUcRecording } from "@unified-api/typescript-sdk/funcs/recordingUpdateUcRecording.js";
|
|
604
|
-
|
|
605
|
-
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
606
|
-
// You can create one instance of it to use across an application.
|
|
607
|
-
const unifiedTo = new UnifiedToCore({
|
|
608
|
-
security: {
|
|
609
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
610
|
-
},
|
|
611
|
-
});
|
|
612
|
-
|
|
613
|
-
async function run() {
|
|
614
|
-
const res = await recordingUpdateUcRecording(unifiedTo, {
|
|
615
|
-
ucRecording: {},
|
|
616
|
-
connectionId: "<id>",
|
|
617
|
-
id: "<id>",
|
|
618
|
-
});
|
|
619
|
-
if (res.ok) {
|
|
620
|
-
const { value: result } = res;
|
|
621
|
-
console.log(result);
|
|
622
|
-
} else {
|
|
623
|
-
console.log("recordingUpdateUcRecording failed:", res.error);
|
|
624
|
-
}
|
|
625
|
-
}
|
|
626
|
-
|
|
627
|
-
run();
|
|
628
|
-
```
|
|
629
|
-
|
|
630
|
-
### Parameters
|
|
631
|
-
|
|
632
|
-
| Parameter | Type | Required | Description |
|
|
633
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
634
|
-
| `request` | [operations.UpdateUcRecordingRequest](../../sdk/models/operations/updateucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
635
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
636
|
-
| `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. |
|
|
637
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
638
|
-
|
|
639
|
-
### Response
|
|
640
|
-
|
|
641
|
-
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
642
|
-
|
|
643
|
-
### Errors
|
|
644
|
-
|
|
645
|
-
| Error Type | Status Code | Content Type |
|
|
646
|
-
| --------------- | --------------- | --------------- |
|
|
647
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|