syllable-sdk 1.0.8-rc.1 → 1.0.8-rc.2
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/bin/mcp-server.js +6 -6
- package/bin/mcp-server.js.map +4 -4
- 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/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/openapi.json +33 -33
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/.devcontainer/README.md +0 -35
- package/api-reference/sdks/agents/README.md +0 -224
- package/api-reference/sdks/availabletargets/README.md +0 -49
- package/api-reference/sdks/channels/README.md +0 -92
- package/api-reference/sdks/chats/README.md +0 -55
- package/api-reference/sdks/conversations/README.md +0 -91
- package/api-reference/sdks/dashboards/README.md +0 -321
- package/api-reference/sdks/events/README.md +0 -50
- package/api-reference/sdks/greetings/README.md +0 -223
- package/api-reference/sdks/organizations/README.md +0 -48
- package/api-reference/sdks/prompts/README.md +0 -225
- package/api-reference/sdks/sessions/README.md +0 -50
- package/api-reference/sdks/syllable/README.md +0 -22
- package/api-reference/sdks/targets/README.md +0 -194
- package/api-reference/sdks/tools/README.md +0 -92
- package/docs/sdks/agents/README.md +0 -589
- package/docs/sdks/batches/README.md +0 -742
- package/docs/sdks/campaigns/README.md +0 -526
- package/docs/sdks/channels/README.md +0 -401
- package/docs/sdks/conversations/README.md +0 -100
- package/docs/sdks/custommessages/README.md +0 -496
- package/docs/sdks/dashboards/README.md +0 -481
- package/docs/sdks/datasources/README.md +0 -458
- package/docs/sdks/directory/README.md +0 -727
- package/docs/sdks/events/README.md +0 -100
- package/docs/sdks/folders/README.md +0 -675
- package/docs/sdks/fullsummary/README.md +0 -82
- package/docs/sdks/incidents/README.md +0 -501
- package/docs/sdks/insights/README.md +0 -100
- package/docs/sdks/languagegroups/README.md +0 -565
- package/docs/sdks/latency/README.md +0 -82
- package/docs/sdks/numbers/README.md +0 -250
- package/docs/sdks/organizations/README.md +0 -317
- package/docs/sdks/permissions/README.md +0 -78
- package/docs/sdks/prompts/README.md +0 -592
- package/docs/sdks/pronunciations/README.md +0 -360
- package/docs/sdks/roles/README.md +0 -430
- package/docs/sdks/services/README.md +0 -430
- package/docs/sdks/sessiondebug/README.md +0 -236
- package/docs/sdks/sessionlabels/README.md +0 -262
- package/docs/sdks/sessions/README.md +0 -325
- package/docs/sdks/syllablesdktools/README.md +0 -578
- package/docs/sdks/takeouts/README.md +0 -228
- package/docs/sdks/targets/README.md +0 -454
- package/docs/sdks/test/README.md +0 -92
- package/docs/sdks/tools/README.md +0 -518
- package/docs/sdks/transcript/README.md +0 -82
- package/docs/sdks/twilio/README.md +0 -246
- package/docs/sdks/users/README.md +0 -561
- package/docs/sdks/v1/README.md +0 -561
- package/docs/sdks/voicegroups/README.md +0 -551
- package/docs/sdks/workflows/README.md +0 -781
- package/examples/README.md +0 -31
|
@@ -1,675 +0,0 @@
|
|
|
1
|
-
# Folders
|
|
2
|
-
(*insights.folders*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
Operations related to insights upload folders. An insight folder is used to upload call recordings for insight workflow analysis.
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [list](#list) - List Insights Upload Folders
|
|
11
|
-
* [create](#create) - Create Insights Upload Folder
|
|
12
|
-
* [getById](#getbyid) - Get Insights Folder Details
|
|
13
|
-
* [delete](#delete) - Delete Insights Folder
|
|
14
|
-
* [update](#update) - Update Insights Folder
|
|
15
|
-
* [uploadFile](#uploadfile) - Upload Insights Upload Folder
|
|
16
|
-
* [listFiles](#listfiles) - Fetch Insights Upload Files
|
|
17
|
-
* [moveFiles](#movefiles) - Move Insights Upload Files
|
|
18
|
-
|
|
19
|
-
## list
|
|
20
|
-
|
|
21
|
-
List Insights Upload Folders
|
|
22
|
-
|
|
23
|
-
### Example Usage
|
|
24
|
-
|
|
25
|
-
<!-- UsageSnippet language="typescript" operationID="insights_folder_list" method="get" path="/api/v1/insights/folders/" -->
|
|
26
|
-
```typescript
|
|
27
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
28
|
-
|
|
29
|
-
const syllableSDK = new SyllableSDK({
|
|
30
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
async function run() {
|
|
34
|
-
const result = await syllableSDK.insights.folders.list({
|
|
35
|
-
page: 0,
|
|
36
|
-
searchFields: [
|
|
37
|
-
"name",
|
|
38
|
-
],
|
|
39
|
-
searchFieldValues: [
|
|
40
|
-
"Some Object Name",
|
|
41
|
-
],
|
|
42
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
43
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
console.log(result);
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
run();
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Standalone function
|
|
53
|
-
|
|
54
|
-
The standalone function version of this method:
|
|
55
|
-
|
|
56
|
-
```typescript
|
|
57
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
58
|
-
import { insightsFoldersList } from "syllable-sdk/funcs/insightsFoldersList.js";
|
|
59
|
-
|
|
60
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
61
|
-
// You can create one instance of it to use across an application.
|
|
62
|
-
const syllableSDK = new SyllableSDKCore({
|
|
63
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
64
|
-
});
|
|
65
|
-
|
|
66
|
-
async function run() {
|
|
67
|
-
const res = await insightsFoldersList(syllableSDK, {
|
|
68
|
-
page: 0,
|
|
69
|
-
searchFields: [
|
|
70
|
-
"name",
|
|
71
|
-
],
|
|
72
|
-
searchFieldValues: [
|
|
73
|
-
"Some Object Name",
|
|
74
|
-
],
|
|
75
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
76
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
77
|
-
});
|
|
78
|
-
if (res.ok) {
|
|
79
|
-
const { value: result } = res;
|
|
80
|
-
console.log(result);
|
|
81
|
-
} else {
|
|
82
|
-
console.log("insightsFoldersList failed:", res.error);
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
run();
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### Parameters
|
|
90
|
-
|
|
91
|
-
| Parameter | Type | Required | Description |
|
|
92
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
93
|
-
| `request` | [operations.InsightsFolderListRequest](../../models/operations/insightsfolderlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
94
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
95
|
-
| `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. |
|
|
96
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
97
|
-
|
|
98
|
-
### Response
|
|
99
|
-
|
|
100
|
-
**Promise\<[components.ListResponseInsightsFolder](../../models/components/listresponseinsightsfolder.md)\>**
|
|
101
|
-
|
|
102
|
-
### Errors
|
|
103
|
-
|
|
104
|
-
| Error Type | Status Code | Content Type |
|
|
105
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
106
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
107
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
108
|
-
|
|
109
|
-
## create
|
|
110
|
-
|
|
111
|
-
Create Insights Upload Folder
|
|
112
|
-
|
|
113
|
-
### Example Usage
|
|
114
|
-
|
|
115
|
-
<!-- UsageSnippet language="typescript" operationID="insights_folder_create" method="post" path="/api/v1/insights/folders/" -->
|
|
116
|
-
```typescript
|
|
117
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
118
|
-
|
|
119
|
-
const syllableSDK = new SyllableSDK({
|
|
120
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
async function run() {
|
|
124
|
-
const result = await syllableSDK.insights.folders.create({
|
|
125
|
-
name: "customer-complaints",
|
|
126
|
-
label: "support",
|
|
127
|
-
description: "Call recordings related to customer complaints",
|
|
128
|
-
});
|
|
129
|
-
|
|
130
|
-
console.log(result);
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
run();
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Standalone function
|
|
137
|
-
|
|
138
|
-
The standalone function version of this method:
|
|
139
|
-
|
|
140
|
-
```typescript
|
|
141
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
142
|
-
import { insightsFoldersCreate } from "syllable-sdk/funcs/insightsFoldersCreate.js";
|
|
143
|
-
|
|
144
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
145
|
-
// You can create one instance of it to use across an application.
|
|
146
|
-
const syllableSDK = new SyllableSDKCore({
|
|
147
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
148
|
-
});
|
|
149
|
-
|
|
150
|
-
async function run() {
|
|
151
|
-
const res = await insightsFoldersCreate(syllableSDK, {
|
|
152
|
-
name: "customer-complaints",
|
|
153
|
-
label: "support",
|
|
154
|
-
description: "Call recordings related to customer complaints",
|
|
155
|
-
});
|
|
156
|
-
if (res.ok) {
|
|
157
|
-
const { value: result } = res;
|
|
158
|
-
console.log(result);
|
|
159
|
-
} else {
|
|
160
|
-
console.log("insightsFoldersCreate failed:", res.error);
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
run();
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### Parameters
|
|
168
|
-
|
|
169
|
-
| Parameter | Type | Required | Description |
|
|
170
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
171
|
-
| `request` | [components.InsightsFolderInput](../../models/components/insightsfolderinput.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
172
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
173
|
-
| `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. |
|
|
174
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
175
|
-
|
|
176
|
-
### Response
|
|
177
|
-
|
|
178
|
-
**Promise\<[components.InsightsFolder](../../models/components/insightsfolder.md)\>**
|
|
179
|
-
|
|
180
|
-
### Errors
|
|
181
|
-
|
|
182
|
-
| Error Type | Status Code | Content Type |
|
|
183
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
184
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
185
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
186
|
-
|
|
187
|
-
## getById
|
|
188
|
-
|
|
189
|
-
Get Insights Folder Details
|
|
190
|
-
|
|
191
|
-
### Example Usage
|
|
192
|
-
|
|
193
|
-
<!-- UsageSnippet language="typescript" operationID="insights_folder_get_by_id" method="get" path="/api/v1/insights/folders/{folder_id}" -->
|
|
194
|
-
```typescript
|
|
195
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
196
|
-
|
|
197
|
-
const syllableSDK = new SyllableSDK({
|
|
198
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
199
|
-
});
|
|
200
|
-
|
|
201
|
-
async function run() {
|
|
202
|
-
const result = await syllableSDK.insights.folders.getById({
|
|
203
|
-
folderId: 982079,
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
console.log(result);
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
run();
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
### Standalone function
|
|
213
|
-
|
|
214
|
-
The standalone function version of this method:
|
|
215
|
-
|
|
216
|
-
```typescript
|
|
217
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
218
|
-
import { insightsFoldersGetById } from "syllable-sdk/funcs/insightsFoldersGetById.js";
|
|
219
|
-
|
|
220
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
221
|
-
// You can create one instance of it to use across an application.
|
|
222
|
-
const syllableSDK = new SyllableSDKCore({
|
|
223
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
224
|
-
});
|
|
225
|
-
|
|
226
|
-
async function run() {
|
|
227
|
-
const res = await insightsFoldersGetById(syllableSDK, {
|
|
228
|
-
folderId: 982079,
|
|
229
|
-
});
|
|
230
|
-
if (res.ok) {
|
|
231
|
-
const { value: result } = res;
|
|
232
|
-
console.log(result);
|
|
233
|
-
} else {
|
|
234
|
-
console.log("insightsFoldersGetById failed:", res.error);
|
|
235
|
-
}
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
run();
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
### Parameters
|
|
242
|
-
|
|
243
|
-
| Parameter | Type | Required | Description |
|
|
244
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
245
|
-
| `request` | [operations.InsightsFolderGetByIdRequest](../../models/operations/insightsfoldergetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
246
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
247
|
-
| `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. |
|
|
248
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
249
|
-
|
|
250
|
-
### Response
|
|
251
|
-
|
|
252
|
-
**Promise\<[components.FolderDetails](../../models/components/folderdetails.md)\>**
|
|
253
|
-
|
|
254
|
-
### Errors
|
|
255
|
-
|
|
256
|
-
| Error Type | Status Code | Content Type |
|
|
257
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
258
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
259
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
260
|
-
|
|
261
|
-
## delete
|
|
262
|
-
|
|
263
|
-
Delete Insights Folder
|
|
264
|
-
|
|
265
|
-
### Example Usage
|
|
266
|
-
|
|
267
|
-
<!-- UsageSnippet language="typescript" operationID="insights_folder_delete" method="delete" path="/api/v1/insights/folders/{folder_id}" -->
|
|
268
|
-
```typescript
|
|
269
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
270
|
-
|
|
271
|
-
const syllableSDK = new SyllableSDK({
|
|
272
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
273
|
-
});
|
|
274
|
-
|
|
275
|
-
async function run() {
|
|
276
|
-
const result = await syllableSDK.insights.folders.delete({
|
|
277
|
-
folderId: 410792,
|
|
278
|
-
});
|
|
279
|
-
|
|
280
|
-
console.log(result);
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
run();
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
### Standalone function
|
|
287
|
-
|
|
288
|
-
The standalone function version of this method:
|
|
289
|
-
|
|
290
|
-
```typescript
|
|
291
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
292
|
-
import { insightsFoldersDelete } from "syllable-sdk/funcs/insightsFoldersDelete.js";
|
|
293
|
-
|
|
294
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
295
|
-
// You can create one instance of it to use across an application.
|
|
296
|
-
const syllableSDK = new SyllableSDKCore({
|
|
297
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
298
|
-
});
|
|
299
|
-
|
|
300
|
-
async function run() {
|
|
301
|
-
const res = await insightsFoldersDelete(syllableSDK, {
|
|
302
|
-
folderId: 410792,
|
|
303
|
-
});
|
|
304
|
-
if (res.ok) {
|
|
305
|
-
const { value: result } = res;
|
|
306
|
-
console.log(result);
|
|
307
|
-
} else {
|
|
308
|
-
console.log("insightsFoldersDelete failed:", res.error);
|
|
309
|
-
}
|
|
310
|
-
}
|
|
311
|
-
|
|
312
|
-
run();
|
|
313
|
-
```
|
|
314
|
-
|
|
315
|
-
### Parameters
|
|
316
|
-
|
|
317
|
-
| Parameter | Type | Required | Description |
|
|
318
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
319
|
-
| `request` | [operations.InsightsFolderDeleteRequest](../../models/operations/insightsfolderdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
320
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
321
|
-
| `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. |
|
|
322
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
323
|
-
|
|
324
|
-
### Response
|
|
325
|
-
|
|
326
|
-
**Promise\<[boolean](../../models/.md)\>**
|
|
327
|
-
|
|
328
|
-
### Errors
|
|
329
|
-
|
|
330
|
-
| Error Type | Status Code | Content Type |
|
|
331
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
332
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
333
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
334
|
-
|
|
335
|
-
## update
|
|
336
|
-
|
|
337
|
-
Update Insights Folder
|
|
338
|
-
|
|
339
|
-
### Example Usage
|
|
340
|
-
|
|
341
|
-
<!-- UsageSnippet language="typescript" operationID="insights_folder_update" method="put" path="/api/v1/insights/folders/{folder_id}" -->
|
|
342
|
-
```typescript
|
|
343
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
344
|
-
|
|
345
|
-
const syllableSDK = new SyllableSDK({
|
|
346
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
347
|
-
});
|
|
348
|
-
|
|
349
|
-
async function run() {
|
|
350
|
-
const result = await syllableSDK.insights.folders.update({
|
|
351
|
-
folderId: 567518,
|
|
352
|
-
insightsFolderInput: {
|
|
353
|
-
name: "customer-complaints",
|
|
354
|
-
label: "support",
|
|
355
|
-
description: "Call recordings related to customer complaints",
|
|
356
|
-
},
|
|
357
|
-
});
|
|
358
|
-
|
|
359
|
-
console.log(result);
|
|
360
|
-
}
|
|
361
|
-
|
|
362
|
-
run();
|
|
363
|
-
```
|
|
364
|
-
|
|
365
|
-
### Standalone function
|
|
366
|
-
|
|
367
|
-
The standalone function version of this method:
|
|
368
|
-
|
|
369
|
-
```typescript
|
|
370
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
371
|
-
import { insightsFoldersUpdate } from "syllable-sdk/funcs/insightsFoldersUpdate.js";
|
|
372
|
-
|
|
373
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
374
|
-
// You can create one instance of it to use across an application.
|
|
375
|
-
const syllableSDK = new SyllableSDKCore({
|
|
376
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
377
|
-
});
|
|
378
|
-
|
|
379
|
-
async function run() {
|
|
380
|
-
const res = await insightsFoldersUpdate(syllableSDK, {
|
|
381
|
-
folderId: 567518,
|
|
382
|
-
insightsFolderInput: {
|
|
383
|
-
name: "customer-complaints",
|
|
384
|
-
label: "support",
|
|
385
|
-
description: "Call recordings related to customer complaints",
|
|
386
|
-
},
|
|
387
|
-
});
|
|
388
|
-
if (res.ok) {
|
|
389
|
-
const { value: result } = res;
|
|
390
|
-
console.log(result);
|
|
391
|
-
} else {
|
|
392
|
-
console.log("insightsFoldersUpdate failed:", res.error);
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
run();
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
### Parameters
|
|
400
|
-
|
|
401
|
-
| Parameter | Type | Required | Description |
|
|
402
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
-
| `request` | [operations.InsightsFolderUpdateRequest](../../models/operations/insightsfolderupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
406
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
|
-
|
|
408
|
-
### Response
|
|
409
|
-
|
|
410
|
-
**Promise\<[components.InsightsFolder](../../models/components/insightsfolder.md)\>**
|
|
411
|
-
|
|
412
|
-
### Errors
|
|
413
|
-
|
|
414
|
-
| Error Type | Status Code | Content Type |
|
|
415
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
416
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
417
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
418
|
-
|
|
419
|
-
## uploadFile
|
|
420
|
-
|
|
421
|
-
Upload Insights Upload Folder
|
|
422
|
-
|
|
423
|
-
### Example Usage
|
|
424
|
-
|
|
425
|
-
<!-- UsageSnippet language="typescript" operationID="insights_folder_upload_file" method="post" path="/api/v1/insights/folders/{folder_id}/upload-file" -->
|
|
426
|
-
```typescript
|
|
427
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
428
|
-
|
|
429
|
-
const syllableSDK = new SyllableSDK({
|
|
430
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
431
|
-
});
|
|
432
|
-
|
|
433
|
-
async function run() {
|
|
434
|
-
const result = await syllableSDK.insights.folders.uploadFile({
|
|
435
|
-
folderId: 444923,
|
|
436
|
-
callId: "<id>",
|
|
437
|
-
});
|
|
438
|
-
|
|
439
|
-
console.log(result);
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
run();
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
### Standalone function
|
|
446
|
-
|
|
447
|
-
The standalone function version of this method:
|
|
448
|
-
|
|
449
|
-
```typescript
|
|
450
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
451
|
-
import { insightsFoldersUploadFile } from "syllable-sdk/funcs/insightsFoldersUploadFile.js";
|
|
452
|
-
|
|
453
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
454
|
-
// You can create one instance of it to use across an application.
|
|
455
|
-
const syllableSDK = new SyllableSDKCore({
|
|
456
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
457
|
-
});
|
|
458
|
-
|
|
459
|
-
async function run() {
|
|
460
|
-
const res = await insightsFoldersUploadFile(syllableSDK, {
|
|
461
|
-
folderId: 444923,
|
|
462
|
-
callId: "<id>",
|
|
463
|
-
});
|
|
464
|
-
if (res.ok) {
|
|
465
|
-
const { value: result } = res;
|
|
466
|
-
console.log(result);
|
|
467
|
-
} else {
|
|
468
|
-
console.log("insightsFoldersUploadFile failed:", res.error);
|
|
469
|
-
}
|
|
470
|
-
}
|
|
471
|
-
|
|
472
|
-
run();
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
### Parameters
|
|
476
|
-
|
|
477
|
-
| Parameter | Type | Required | Description |
|
|
478
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
479
|
-
| `request` | [operations.InsightsFolderUploadFileRequest](../../models/operations/insightsfolderuploadfilerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
480
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
481
|
-
| `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. |
|
|
482
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
483
|
-
|
|
484
|
-
### Response
|
|
485
|
-
|
|
486
|
-
**Promise\<[components.InsightsUploadFile](../../models/components/insightsuploadfile.md)\>**
|
|
487
|
-
|
|
488
|
-
### Errors
|
|
489
|
-
|
|
490
|
-
| Error Type | Status Code | Content Type |
|
|
491
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
492
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
493
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
494
|
-
|
|
495
|
-
## listFiles
|
|
496
|
-
|
|
497
|
-
Fetch Insights Upload Files
|
|
498
|
-
|
|
499
|
-
### Example Usage
|
|
500
|
-
|
|
501
|
-
<!-- UsageSnippet language="typescript" operationID="insights_upload_list_files" method="get" path="/api/v1/insights/folders/{folder_id}/files" -->
|
|
502
|
-
```typescript
|
|
503
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
504
|
-
|
|
505
|
-
const syllableSDK = new SyllableSDK({
|
|
506
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
507
|
-
});
|
|
508
|
-
|
|
509
|
-
async function run() {
|
|
510
|
-
const result = await syllableSDK.insights.folders.listFiles({
|
|
511
|
-
folderId: 55293,
|
|
512
|
-
page: 0,
|
|
513
|
-
searchFields: [
|
|
514
|
-
"customer_number",
|
|
515
|
-
],
|
|
516
|
-
searchFieldValues: [
|
|
517
|
-
"Some Object Name",
|
|
518
|
-
],
|
|
519
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
520
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
521
|
-
});
|
|
522
|
-
|
|
523
|
-
console.log(result);
|
|
524
|
-
}
|
|
525
|
-
|
|
526
|
-
run();
|
|
527
|
-
```
|
|
528
|
-
|
|
529
|
-
### Standalone function
|
|
530
|
-
|
|
531
|
-
The standalone function version of this method:
|
|
532
|
-
|
|
533
|
-
```typescript
|
|
534
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
535
|
-
import { insightsFoldersListFiles } from "syllable-sdk/funcs/insightsFoldersListFiles.js";
|
|
536
|
-
|
|
537
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
538
|
-
// You can create one instance of it to use across an application.
|
|
539
|
-
const syllableSDK = new SyllableSDKCore({
|
|
540
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
541
|
-
});
|
|
542
|
-
|
|
543
|
-
async function run() {
|
|
544
|
-
const res = await insightsFoldersListFiles(syllableSDK, {
|
|
545
|
-
folderId: 55293,
|
|
546
|
-
page: 0,
|
|
547
|
-
searchFields: [
|
|
548
|
-
"customer_number",
|
|
549
|
-
],
|
|
550
|
-
searchFieldValues: [
|
|
551
|
-
"Some Object Name",
|
|
552
|
-
],
|
|
553
|
-
startDatetime: "2023-01-01T00:00:00Z",
|
|
554
|
-
endDatetime: "2024-01-01T00:00:00Z",
|
|
555
|
-
});
|
|
556
|
-
if (res.ok) {
|
|
557
|
-
const { value: result } = res;
|
|
558
|
-
console.log(result);
|
|
559
|
-
} else {
|
|
560
|
-
console.log("insightsFoldersListFiles failed:", res.error);
|
|
561
|
-
}
|
|
562
|
-
}
|
|
563
|
-
|
|
564
|
-
run();
|
|
565
|
-
```
|
|
566
|
-
|
|
567
|
-
### Parameters
|
|
568
|
-
|
|
569
|
-
| Parameter | Type | Required | Description |
|
|
570
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
571
|
-
| `request` | [operations.InsightsUploadListFilesRequest](../../models/operations/insightsuploadlistfilesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
572
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
573
|
-
| `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. |
|
|
574
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
575
|
-
|
|
576
|
-
### Response
|
|
577
|
-
|
|
578
|
-
**Promise\<[components.ListResponseInsightsUploadFile](../../models/components/listresponseinsightsuploadfile.md)\>**
|
|
579
|
-
|
|
580
|
-
### Errors
|
|
581
|
-
|
|
582
|
-
| Error Type | Status Code | Content Type |
|
|
583
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
584
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
585
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
586
|
-
|
|
587
|
-
## moveFiles
|
|
588
|
-
|
|
589
|
-
Move Insights Upload Files
|
|
590
|
-
|
|
591
|
-
### Example Usage
|
|
592
|
-
|
|
593
|
-
<!-- UsageSnippet language="typescript" operationID="insights_upload_move_files" method="post" path="/api/v1/insights/folders/{folder_id}/move-files" -->
|
|
594
|
-
```typescript
|
|
595
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
596
|
-
|
|
597
|
-
const syllableSDK = new SyllableSDK({
|
|
598
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
599
|
-
});
|
|
600
|
-
|
|
601
|
-
async function run() {
|
|
602
|
-
const result = await syllableSDK.insights.folders.moveFiles({
|
|
603
|
-
folderId: 815114,
|
|
604
|
-
insightsFolderFileMove: {
|
|
605
|
-
destinationFolderId: 182764,
|
|
606
|
-
fileIdList: [
|
|
607
|
-
12334,
|
|
608
|
-
23445,
|
|
609
|
-
34556,
|
|
610
|
-
],
|
|
611
|
-
},
|
|
612
|
-
});
|
|
613
|
-
|
|
614
|
-
console.log(result);
|
|
615
|
-
}
|
|
616
|
-
|
|
617
|
-
run();
|
|
618
|
-
```
|
|
619
|
-
|
|
620
|
-
### Standalone function
|
|
621
|
-
|
|
622
|
-
The standalone function version of this method:
|
|
623
|
-
|
|
624
|
-
```typescript
|
|
625
|
-
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
626
|
-
import { insightsFoldersMoveFiles } from "syllable-sdk/funcs/insightsFoldersMoveFiles.js";
|
|
627
|
-
|
|
628
|
-
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
629
|
-
// You can create one instance of it to use across an application.
|
|
630
|
-
const syllableSDK = new SyllableSDKCore({
|
|
631
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
632
|
-
});
|
|
633
|
-
|
|
634
|
-
async function run() {
|
|
635
|
-
const res = await insightsFoldersMoveFiles(syllableSDK, {
|
|
636
|
-
folderId: 815114,
|
|
637
|
-
insightsFolderFileMove: {
|
|
638
|
-
destinationFolderId: 182764,
|
|
639
|
-
fileIdList: [
|
|
640
|
-
12334,
|
|
641
|
-
23445,
|
|
642
|
-
34556,
|
|
643
|
-
],
|
|
644
|
-
},
|
|
645
|
-
});
|
|
646
|
-
if (res.ok) {
|
|
647
|
-
const { value: result } = res;
|
|
648
|
-
console.log(result);
|
|
649
|
-
} else {
|
|
650
|
-
console.log("insightsFoldersMoveFiles failed:", res.error);
|
|
651
|
-
}
|
|
652
|
-
}
|
|
653
|
-
|
|
654
|
-
run();
|
|
655
|
-
```
|
|
656
|
-
|
|
657
|
-
### Parameters
|
|
658
|
-
|
|
659
|
-
| Parameter | Type | Required | Description |
|
|
660
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
661
|
-
| `request` | [operations.InsightsUploadMoveFilesRequest](../../models/operations/insightsuploadmovefilesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
662
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
663
|
-
| `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. |
|
|
664
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
665
|
-
|
|
666
|
-
### Response
|
|
667
|
-
|
|
668
|
-
**Promise\<[components.InsightsUploadFile[]](../../models/.md)\>**
|
|
669
|
-
|
|
670
|
-
### Errors
|
|
671
|
-
|
|
672
|
-
| Error Type | Status Code | Content Type |
|
|
673
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
674
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
675
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|