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.
Files changed (66) hide show
  1. package/bin/mcp-server.js +6 -6
  2. package/bin/mcp-server.js.map +4 -4
  3. package/examples/package-lock.json +1 -1
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +3 -3
  6. package/lib/config.js +3 -3
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/server.js +1 -1
  9. package/openapi.json +33 -33
  10. package/package.json +1 -1
  11. package/src/lib/config.ts +3 -3
  12. package/src/mcp-server/mcp-server.ts +1 -1
  13. package/src/mcp-server/server.ts +1 -1
  14. package/.devcontainer/README.md +0 -35
  15. package/api-reference/sdks/agents/README.md +0 -224
  16. package/api-reference/sdks/availabletargets/README.md +0 -49
  17. package/api-reference/sdks/channels/README.md +0 -92
  18. package/api-reference/sdks/chats/README.md +0 -55
  19. package/api-reference/sdks/conversations/README.md +0 -91
  20. package/api-reference/sdks/dashboards/README.md +0 -321
  21. package/api-reference/sdks/events/README.md +0 -50
  22. package/api-reference/sdks/greetings/README.md +0 -223
  23. package/api-reference/sdks/organizations/README.md +0 -48
  24. package/api-reference/sdks/prompts/README.md +0 -225
  25. package/api-reference/sdks/sessions/README.md +0 -50
  26. package/api-reference/sdks/syllable/README.md +0 -22
  27. package/api-reference/sdks/targets/README.md +0 -194
  28. package/api-reference/sdks/tools/README.md +0 -92
  29. package/docs/sdks/agents/README.md +0 -589
  30. package/docs/sdks/batches/README.md +0 -742
  31. package/docs/sdks/campaigns/README.md +0 -526
  32. package/docs/sdks/channels/README.md +0 -401
  33. package/docs/sdks/conversations/README.md +0 -100
  34. package/docs/sdks/custommessages/README.md +0 -496
  35. package/docs/sdks/dashboards/README.md +0 -481
  36. package/docs/sdks/datasources/README.md +0 -458
  37. package/docs/sdks/directory/README.md +0 -727
  38. package/docs/sdks/events/README.md +0 -100
  39. package/docs/sdks/folders/README.md +0 -675
  40. package/docs/sdks/fullsummary/README.md +0 -82
  41. package/docs/sdks/incidents/README.md +0 -501
  42. package/docs/sdks/insights/README.md +0 -100
  43. package/docs/sdks/languagegroups/README.md +0 -565
  44. package/docs/sdks/latency/README.md +0 -82
  45. package/docs/sdks/numbers/README.md +0 -250
  46. package/docs/sdks/organizations/README.md +0 -317
  47. package/docs/sdks/permissions/README.md +0 -78
  48. package/docs/sdks/prompts/README.md +0 -592
  49. package/docs/sdks/pronunciations/README.md +0 -360
  50. package/docs/sdks/roles/README.md +0 -430
  51. package/docs/sdks/services/README.md +0 -430
  52. package/docs/sdks/sessiondebug/README.md +0 -236
  53. package/docs/sdks/sessionlabels/README.md +0 -262
  54. package/docs/sdks/sessions/README.md +0 -325
  55. package/docs/sdks/syllablesdktools/README.md +0 -578
  56. package/docs/sdks/takeouts/README.md +0 -228
  57. package/docs/sdks/targets/README.md +0 -454
  58. package/docs/sdks/test/README.md +0 -92
  59. package/docs/sdks/tools/README.md +0 -518
  60. package/docs/sdks/transcript/README.md +0 -82
  61. package/docs/sdks/twilio/README.md +0 -246
  62. package/docs/sdks/users/README.md +0 -561
  63. package/docs/sdks/v1/README.md +0 -561
  64. package/docs/sdks/voicegroups/README.md +0 -551
  65. package/docs/sdks/workflows/README.md +0 -781
  66. package/examples/README.md +0 -31
package/docs/sdks/pronunciations/README.md DELETED
@@ -1,360 +0,0 @@
1
- # Pronunciations
2
- (*pronunciations*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [pronunciationsGet](#pronunciationsget) - Get Pronunciations Dictionary
9
- * [pronunciationsGetMetadata](#pronunciationsgetmetadata) - Get Pronunciations Metadata
10
- * [pronunciationsDownloadCsv](#pronunciationsdownloadcsv) - Download Pronunciations Csv
11
- * [pronunciationsUploadCsv](#pronunciationsuploadcsv) - Upload Pronunciations Csv
12
- * [pronunciationsDeleteCsv](#pronunciationsdeletecsv) - Delete Pronunciations Dictionary
13
-
14
- ## pronunciationsGet
15
-
16
- Get Pronunciations Dictionary
17
-
18
- ### Example Usage
19
-
20
- <!-- UsageSnippet language="typescript" operationID="pronunciations_get" method="get" path="/api/v1/pronunciations" -->
21
- ```typescript
22
- import { SyllableSDK } from "syllable-sdk";
23
-
24
- const syllableSDK = new SyllableSDK({
25
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
26
- });
27
-
28
- async function run() {
29
- const result = await syllableSDK.pronunciations.pronunciationsGet();
30
-
31
- console.log(result);
32
- }
33
-
34
- run();
35
- ```
36
-
37
- ### Standalone function
38
-
39
- The standalone function version of this method:
40
-
41
- ```typescript
42
- import { SyllableSDKCore } from "syllable-sdk/core.js";
43
- import { pronunciationsPronunciationsGet } from "syllable-sdk/funcs/pronunciationsPronunciationsGet.js";
44
-
45
- // Use `SyllableSDKCore` for best tree-shaking performance.
46
- // You can create one instance of it to use across an application.
47
- const syllableSDK = new SyllableSDKCore({
48
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
49
- });
50
-
51
- async function run() {
52
- const res = await pronunciationsPronunciationsGet(syllableSDK);
53
- if (res.ok) {
54
- const { value: result } = res;
55
- console.log(result);
56
- } else {
57
- console.log("pronunciationsPronunciationsGet failed:", res.error);
58
- }
59
- }
60
-
61
- run();
62
- ```
63
-
64
- ### Parameters
65
-
66
- | Parameter | Type | Required | Description |
67
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
68
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
69
- | `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. |
70
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
71
-
72
- ### Response
73
-
74
- **Promise\<[components.PronunciationOverridesDictionary](../../models/components/pronunciationoverridesdictionary.md)\>**
75
-
76
- ### Errors
77
-
78
- | Error Type | Status Code | Content Type |
79
- | --------------- | --------------- | --------------- |
80
- | errors.SDKError | 4XX, 5XX | \*/\* |
81
-
82
- ## pronunciationsGetMetadata
83
-
84
- Get Pronunciations Metadata
85
-
86
- ### Example Usage
87
-
88
- <!-- UsageSnippet language="typescript" operationID="pronunciations_get_metadata" method="get" path="/api/v1/pronunciations/metadata" -->
89
- ```typescript
90
- import { SyllableSDK } from "syllable-sdk";
91
-
92
- const syllableSDK = new SyllableSDK({
93
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
94
- });
95
-
96
- async function run() {
97
- const result = await syllableSDK.pronunciations.pronunciationsGetMetadata();
98
-
99
- console.log(result);
100
- }
101
-
102
- run();
103
- ```
104
-
105
- ### Standalone function
106
-
107
- The standalone function version of this method:
108
-
109
- ```typescript
110
- import { SyllableSDKCore } from "syllable-sdk/core.js";
111
- import { pronunciationsPronunciationsGetMetadata } from "syllable-sdk/funcs/pronunciationsPronunciationsGetMetadata.js";
112
-
113
- // Use `SyllableSDKCore` for best tree-shaking performance.
114
- // You can create one instance of it to use across an application.
115
- const syllableSDK = new SyllableSDKCore({
116
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
117
- });
118
-
119
- async function run() {
120
- const res = await pronunciationsPronunciationsGetMetadata(syllableSDK);
121
- if (res.ok) {
122
- const { value: result } = res;
123
- console.log(result);
124
- } else {
125
- console.log("pronunciationsPronunciationsGetMetadata failed:", res.error);
126
- }
127
- }
128
-
129
- run();
130
- ```
131
-
132
- ### Parameters
133
-
134
- | Parameter | Type | Required | Description |
135
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
136
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
137
- | `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. |
138
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
139
-
140
- ### Response
141
-
142
- **Promise\<[components.DictionaryMetadata](../../models/components/dictionarymetadata.md)\>**
143
-
144
- ### Errors
145
-
146
- | Error Type | Status Code | Content Type |
147
- | --------------- | --------------- | --------------- |
148
- | errors.SDKError | 4XX, 5XX | \*/\* |
149
-
150
- ## pronunciationsDownloadCsv
151
-
152
- Download Pronunciations Csv
153
-
154
- ### Example Usage
155
-
156
- <!-- UsageSnippet language="typescript" operationID="pronunciations_download_csv" method="get" path="/api/v1/pronunciations/csv" -->
157
- ```typescript
158
- import { SyllableSDK } from "syllable-sdk";
159
-
160
- const syllableSDK = new SyllableSDK({
161
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
162
- });
163
-
164
- async function run() {
165
- const result = await syllableSDK.pronunciations.pronunciationsDownloadCsv();
166
-
167
- console.log(result);
168
- }
169
-
170
- run();
171
- ```
172
-
173
- ### Standalone function
174
-
175
- The standalone function version of this method:
176
-
177
- ```typescript
178
- import { SyllableSDKCore } from "syllable-sdk/core.js";
179
- import { pronunciationsPronunciationsDownloadCsv } from "syllable-sdk/funcs/pronunciationsPronunciationsDownloadCsv.js";
180
-
181
- // Use `SyllableSDKCore` for best tree-shaking performance.
182
- // You can create one instance of it to use across an application.
183
- const syllableSDK = new SyllableSDKCore({
184
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
185
- });
186
-
187
- async function run() {
188
- const res = await pronunciationsPronunciationsDownloadCsv(syllableSDK);
189
- if (res.ok) {
190
- const { value: result } = res;
191
- console.log(result);
192
- } else {
193
- console.log("pronunciationsPronunciationsDownloadCsv failed:", res.error);
194
- }
195
- }
196
-
197
- run();
198
- ```
199
-
200
- ### Parameters
201
-
202
- | Parameter | Type | Required | Description |
203
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
204
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
205
- | `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. |
206
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
207
-
208
- ### Response
209
-
210
- **Promise\<[operations.PronunciationsDownloadCsvResponse](../../models/operations/pronunciationsdownloadcsvresponse.md)\>**
211
-
212
- ### Errors
213
-
214
- | Error Type | Status Code | Content Type |
215
- | --------------- | --------------- | --------------- |
216
- | errors.SDKError | 4XX, 5XX | \*/\* |
217
-
218
- ## pronunciationsUploadCsv
219
-
220
- Upload Pronunciations Csv
221
-
222
- ### Example Usage
223
-
224
- <!-- UsageSnippet language="typescript" operationID="pronunciations_upload_csv" method="post" path="/api/v1/pronunciations/csv" -->
225
- ```typescript
226
- import { openAsBlob } from "node:fs";
227
- import { SyllableSDK } from "syllable-sdk";
228
-
229
- const syllableSDK = new SyllableSDK({
230
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
231
- });
232
-
233
- async function run() {
234
- const result = await syllableSDK.pronunciations.pronunciationsUploadCsv({
235
- file: await openAsBlob("example.file"),
236
- });
237
-
238
- console.log(result);
239
- }
240
-
241
- run();
242
- ```
243
-
244
- ### Standalone function
245
-
246
- The standalone function version of this method:
247
-
248
- ```typescript
249
- import { openAsBlob } from "node:fs";
250
- import { SyllableSDKCore } from "syllable-sdk/core.js";
251
- import { pronunciationsPronunciationsUploadCsv } from "syllable-sdk/funcs/pronunciationsPronunciationsUploadCsv.js";
252
-
253
- // Use `SyllableSDKCore` for best tree-shaking performance.
254
- // You can create one instance of it to use across an application.
255
- const syllableSDK = new SyllableSDKCore({
256
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
257
- });
258
-
259
- async function run() {
260
- const res = await pronunciationsPronunciationsUploadCsv(syllableSDK, {
261
- file: await openAsBlob("example.file"),
262
- });
263
- if (res.ok) {
264
- const { value: result } = res;
265
- console.log(result);
266
- } else {
267
- console.log("pronunciationsPronunciationsUploadCsv failed:", res.error);
268
- }
269
- }
270
-
271
- run();
272
- ```
273
-
274
- ### Parameters
275
-
276
- | Parameter | Type | Required | Description |
277
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
278
- | `request` | [components.BodyPronunciationsUploadCsv](../../models/components/bodypronunciationsuploadcsv.md) | :heavy_check_mark: | The request object to use for the request. |
279
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
280
- | `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. |
281
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
282
-
283
- ### Response
284
-
285
- **Promise\<[components.PronunciationsCsvUploadResponse](../../models/components/pronunciationscsvuploadresponse.md)\>**
286
-
287
- ### Errors
288
-
289
- | Error Type | Status Code | Content Type |
290
- | -------------------------- | -------------------------- | -------------------------- |
291
- | errors.HTTPValidationError | 422 | application/json |
292
- | errors.SDKError | 4XX, 5XX | \*/\* |
293
-
294
- ## pronunciationsDeleteCsv
295
-
296
- Delete Pronunciations Dictionary
297
-
298
- ### Example Usage
299
-
300
- <!-- UsageSnippet language="typescript" operationID="pronunciations_delete_csv" method="delete" path="/api/v1/pronunciations/csv" -->
301
- ```typescript
302
- import { SyllableSDK } from "syllable-sdk";
303
-
304
- const syllableSDK = new SyllableSDK({
305
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
306
- });
307
-
308
- async function run() {
309
- await syllableSDK.pronunciations.pronunciationsDeleteCsv();
310
-
311
-
312
- }
313
-
314
- run();
315
- ```
316
-
317
- ### Standalone function
318
-
319
- The standalone function version of this method:
320
-
321
- ```typescript
322
- import { SyllableSDKCore } from "syllable-sdk/core.js";
323
- import { pronunciationsPronunciationsDeleteCsv } from "syllable-sdk/funcs/pronunciationsPronunciationsDeleteCsv.js";
324
-
325
- // Use `SyllableSDKCore` for best tree-shaking performance.
326
- // You can create one instance of it to use across an application.
327
- const syllableSDK = new SyllableSDKCore({
328
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
329
- });
330
-
331
- async function run() {
332
- const res = await pronunciationsPronunciationsDeleteCsv(syllableSDK);
333
- if (res.ok) {
334
- const { value: result } = res;
335
-
336
- } else {
337
- console.log("pronunciationsPronunciationsDeleteCsv failed:", res.error);
338
- }
339
- }
340
-
341
- run();
342
- ```
343
-
344
- ### Parameters
345
-
346
- | Parameter | Type | Required | Description |
347
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
348
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
349
- | `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. |
350
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
351
-
352
- ### Response
353
-
354
- **Promise\<void\>**
355
-
356
- ### Errors
357
-
358
- | Error Type | Status Code | Content Type |
359
- | --------------- | --------------- | --------------- |
360
- | errors.SDKError | 4XX, 5XX | \*/\* |