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/channels/README.md DELETED
@@ -1,401 +0,0 @@
1
- # Channels
2
- (*channels*)
3
-
4
- ## Overview
5
-
6
- Operations related to channel configuration. A channel is an organization-level point of communication, like a phone number or a web chat. A channel can be associated with an agent by creating a channel target linking them.
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Get Channels
11
- * [create](#create) - Create Channel
12
- * [update](#update) - Update Channel
13
- * [delete](#delete) - Delete Channel Target
14
-
15
- ## list
16
-
17
- Get Channels
18
-
19
- ### Example Usage
20
-
21
- <!-- UsageSnippet language="typescript" operationID="channels_list" method="get" path="/api/v1/channels/" -->
22
- ```typescript
23
- import { SyllableSDK } from "syllable-sdk";
24
-
25
- const syllableSDK = new SyllableSDK({
26
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
27
- });
28
-
29
- async function run() {
30
- const result = await syllableSDK.channels.list({
31
- page: 0,
32
- searchFields: [
33
- "name",
34
- ],
35
- searchFieldValues: [
36
- "Some Object Name",
37
- ],
38
- startDatetime: "2023-01-01T00:00:00Z",
39
- endDatetime: "2024-01-01T00:00:00Z",
40
- });
41
-
42
- console.log(result);
43
- }
44
-
45
- run();
46
- ```
47
-
48
- ### Standalone function
49
-
50
- The standalone function version of this method:
51
-
52
- ```typescript
53
- import { SyllableSDKCore } from "syllable-sdk/core.js";
54
- import { channelsList } from "syllable-sdk/funcs/channelsList.js";
55
-
56
- // Use `SyllableSDKCore` for best tree-shaking performance.
57
- // You can create one instance of it to use across an application.
58
- const syllableSDK = new SyllableSDKCore({
59
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
60
- });
61
-
62
- async function run() {
63
- const res = await channelsList(syllableSDK, {
64
- page: 0,
65
- searchFields: [
66
- "name",
67
- ],
68
- searchFieldValues: [
69
- "Some Object Name",
70
- ],
71
- startDatetime: "2023-01-01T00:00:00Z",
72
- endDatetime: "2024-01-01T00:00:00Z",
73
- });
74
- if (res.ok) {
75
- const { value: result } = res;
76
- console.log(result);
77
- } else {
78
- console.log("channelsList failed:", res.error);
79
- }
80
- }
81
-
82
- run();
83
- ```
84
-
85
- ### Parameters
86
-
87
- | Parameter | Type | Required | Description |
88
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
89
- | `request` | [operations.ChannelsListRequest](../../models/operations/channelslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
90
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
91
- | `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. |
92
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
93
-
94
- ### Response
95
-
96
- **Promise\<[components.ListResponseChannel](../../models/components/listresponsechannel.md)\>**
97
-
98
- ### Errors
99
-
100
- | Error Type | Status Code | Content Type |
101
- | -------------------------- | -------------------------- | -------------------------- |
102
- | errors.HTTPValidationError | 422 | application/json |
103
- | errors.SDKError | 4XX, 5XX | \*/\* |
104
-
105
- ## create
106
-
107
- Create Channel
108
-
109
- ### Example Usage
110
-
111
- <!-- UsageSnippet language="typescript" operationID="channels_create" method="post" path="/api/v1/channels/" -->
112
- ```typescript
113
- import { SyllableSDK } from "syllable-sdk";
114
-
115
- const syllableSDK = new SyllableSDK({
116
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
117
- });
118
-
119
- async function run() {
120
- const result = await syllableSDK.channels.create({
121
- name: "twilio",
122
- channelService: "sip",
123
- supportedModes: "chat,voice",
124
- isSystemChannel: false,
125
- config: {
126
- accountSid: "AC123...",
127
- authToken: "sometoken",
128
- providerCredentials: {
129
- "api_key": "atk123",
130
- "username": "test_username",
131
- },
132
- telephony: {
133
- preInputTimeout: 1.2,
134
- overallInputTimeout: 20,
135
- interruptibility: "dtmf_only",
136
- passiveSpeechInputEnabled: true,
137
- passiveInputStart: 0.5,
138
- },
139
- },
140
- });
141
-
142
- console.log(result);
143
- }
144
-
145
- run();
146
- ```
147
-
148
- ### Standalone function
149
-
150
- The standalone function version of this method:
151
-
152
- ```typescript
153
- import { SyllableSDKCore } from "syllable-sdk/core.js";
154
- import { channelsCreate } from "syllable-sdk/funcs/channelsCreate.js";
155
-
156
- // Use `SyllableSDKCore` for best tree-shaking performance.
157
- // You can create one instance of it to use across an application.
158
- const syllableSDK = new SyllableSDKCore({
159
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
160
- });
161
-
162
- async function run() {
163
- const res = await channelsCreate(syllableSDK, {
164
- name: "twilio",
165
- channelService: "sip",
166
- supportedModes: "chat,voice",
167
- isSystemChannel: false,
168
- config: {
169
- accountSid: "AC123...",
170
- authToken: "sometoken",
171
- providerCredentials: {
172
- "api_key": "atk123",
173
- "username": "test_username",
174
- },
175
- telephony: {
176
- preInputTimeout: 1.2,
177
- overallInputTimeout: 20,
178
- interruptibility: "dtmf_only",
179
- passiveSpeechInputEnabled: true,
180
- passiveInputStart: 0.5,
181
- },
182
- },
183
- });
184
- if (res.ok) {
185
- const { value: result } = res;
186
- console.log(result);
187
- } else {
188
- console.log("channelsCreate failed:", res.error);
189
- }
190
- }
191
-
192
- run();
193
- ```
194
-
195
- ### Parameters
196
-
197
- | Parameter | Type | Required | Description |
198
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
199
- | `request` | [components.OrganizationChannelCreateRequest](../../models/components/organizationchannelcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
200
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
201
- | `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. |
202
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
203
-
204
- ### Response
205
-
206
- **Promise\<[components.Channel](../../models/components/channel.md)\>**
207
-
208
- ### Errors
209
-
210
- | Error Type | Status Code | Content Type |
211
- | -------------------------- | -------------------------- | -------------------------- |
212
- | errors.HTTPValidationError | 422 | application/json |
213
- | errors.SDKError | 4XX, 5XX | \*/\* |
214
-
215
- ## update
216
-
217
- Update Channel
218
-
219
- ### Example Usage
220
-
221
- <!-- UsageSnippet language="typescript" operationID="channels_update" method="put" path="/api/v1/channels/" -->
222
- ```typescript
223
- import { SyllableSDK } from "syllable-sdk";
224
-
225
- const syllableSDK = new SyllableSDK({
226
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
227
- });
228
-
229
- async function run() {
230
- const result = await syllableSDK.channels.update({
231
- name: "twilio",
232
- channelService: "sip",
233
- supportedModes: "chat,voice",
234
- isSystemChannel: false,
235
- config: {
236
- accountSid: "AC123...",
237
- authToken: "sometoken",
238
- providerCredentials: {
239
- "api_key": "atk123",
240
- "username": "test_username",
241
- },
242
- telephony: {
243
- preInputTimeout: 1.2,
244
- overallInputTimeout: 20,
245
- interruptibility: "dtmf_only",
246
- passiveSpeechInputEnabled: true,
247
- passiveInputStart: 0.5,
248
- },
249
- },
250
- id: 1,
251
- });
252
-
253
- console.log(result);
254
- }
255
-
256
- run();
257
- ```
258
-
259
- ### Standalone function
260
-
261
- The standalone function version of this method:
262
-
263
- ```typescript
264
- import { SyllableSDKCore } from "syllable-sdk/core.js";
265
- import { channelsUpdate } from "syllable-sdk/funcs/channelsUpdate.js";
266
-
267
- // Use `SyllableSDKCore` for best tree-shaking performance.
268
- // You can create one instance of it to use across an application.
269
- const syllableSDK = new SyllableSDKCore({
270
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
271
- });
272
-
273
- async function run() {
274
- const res = await channelsUpdate(syllableSDK, {
275
- name: "twilio",
276
- channelService: "sip",
277
- supportedModes: "chat,voice",
278
- isSystemChannel: false,
279
- config: {
280
- accountSid: "AC123...",
281
- authToken: "sometoken",
282
- providerCredentials: {
283
- "api_key": "atk123",
284
- "username": "test_username",
285
- },
286
- telephony: {
287
- preInputTimeout: 1.2,
288
- overallInputTimeout: 20,
289
- interruptibility: "dtmf_only",
290
- passiveSpeechInputEnabled: true,
291
- passiveInputStart: 0.5,
292
- },
293
- },
294
- id: 1,
295
- });
296
- if (res.ok) {
297
- const { value: result } = res;
298
- console.log(result);
299
- } else {
300
- console.log("channelsUpdate failed:", res.error);
301
- }
302
- }
303
-
304
- run();
305
- ```
306
-
307
- ### Parameters
308
-
309
- | Parameter | Type | Required | Description |
310
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
311
- | `request` | [components.OrganizationChannelUpdateRequest](../../models/components/organizationchannelupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
312
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
313
- | `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. |
314
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
315
-
316
- ### Response
317
-
318
- **Promise\<[components.Channel](../../models/components/channel.md)\>**
319
-
320
- ### Errors
321
-
322
- | Error Type | Status Code | Content Type |
323
- | -------------------------- | -------------------------- | -------------------------- |
324
- | errors.HTTPValidationError | 422 | application/json |
325
- | errors.SDKError | 4XX, 5XX | \*/\* |
326
-
327
- ## delete
328
-
329
- Hard-delete a channel target by ID
330
-
331
- ### Example Usage
332
-
333
- <!-- UsageSnippet language="typescript" operationID="channel_targets_delete" method="delete" path="/api/v1/channels/{channel_id}" -->
334
- ```typescript
335
- import { SyllableSDK } from "syllable-sdk";
336
-
337
- const syllableSDK = new SyllableSDK({
338
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
339
- });
340
-
341
- async function run() {
342
- const result = await syllableSDK.channels.delete({
343
- channelId: "<id>",
344
- targetId: "<id>",
345
- });
346
-
347
- console.log(result);
348
- }
349
-
350
- run();
351
- ```
352
-
353
- ### Standalone function
354
-
355
- The standalone function version of this method:
356
-
357
- ```typescript
358
- import { SyllableSDKCore } from "syllable-sdk/core.js";
359
- import { channelsDelete } from "syllable-sdk/funcs/channelsDelete.js";
360
-
361
- // Use `SyllableSDKCore` for best tree-shaking performance.
362
- // You can create one instance of it to use across an application.
363
- const syllableSDK = new SyllableSDKCore({
364
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
365
- });
366
-
367
- async function run() {
368
- const res = await channelsDelete(syllableSDK, {
369
- channelId: "<id>",
370
- targetId: "<id>",
371
- });
372
- if (res.ok) {
373
- const { value: result } = res;
374
- console.log(result);
375
- } else {
376
- console.log("channelsDelete failed:", res.error);
377
- }
378
- }
379
-
380
- run();
381
- ```
382
-
383
- ### Parameters
384
-
385
- | Parameter | Type | Required | Description |
386
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
387
- | `request` | [operations.ChannelTargetsDeleteRequest](../../models/operations/channeltargetsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
388
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
389
- | `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. |
390
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
391
-
392
- ### Response
393
-
394
- **Promise\<[any](../../models/.md)\>**
395
-
396
- ### Errors
397
-
398
- | Error Type | Status Code | Content Type |
399
- | -------------------------- | -------------------------- | -------------------------- |
400
- | errors.HTTPValidationError | 422 | application/json |
401
- | errors.SDKError | 4XX, 5XX | \*/\* |
package/docs/sdks/conversations/README.md DELETED
@@ -1,100 +0,0 @@
1
- # Conversations
2
- (*conversations*)
3
-
4
- ## Overview
5
-
6
- Operations related to conversations. A conversation is a record of messages between a user and an agent, and is composed of one or more sessions.
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Conversations List
11
-
12
- ## list
13
-
14
- Conversations List
15
-
16
- ### Example Usage
17
-
18
- <!-- UsageSnippet language="typescript" operationID="conversations_list" method="get" path="/api/v1/conversations/" -->
19
- ```typescript
20
- import { SyllableSDK } from "syllable-sdk";
21
-
22
- const syllableSDK = new SyllableSDK({
23
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
24
- });
25
-
26
- async function run() {
27
- const result = await syllableSDK.conversations.list({
28
- page: 0,
29
- searchFields: [
30
- "agent_name",
31
- ],
32
- searchFieldValues: [
33
- "Some Object Name",
34
- ],
35
- startDatetime: "2023-01-01T00:00:00Z",
36
- endDatetime: "2024-01-01T00:00:00Z",
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 { SyllableSDKCore } from "syllable-sdk/core.js";
51
- import { conversationsList } from "syllable-sdk/funcs/conversationsList.js";
52
-
53
- // Use `SyllableSDKCore` for best tree-shaking performance.
54
- // You can create one instance of it to use across an application.
55
- const syllableSDK = new SyllableSDKCore({
56
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
57
- });
58
-
59
- async function run() {
60
- const res = await conversationsList(syllableSDK, {
61
- page: 0,
62
- searchFields: [
63
- "agent_name",
64
- ],
65
- searchFieldValues: [
66
- "Some Object Name",
67
- ],
68
- startDatetime: "2023-01-01T00:00:00Z",
69
- endDatetime: "2024-01-01T00:00:00Z",
70
- });
71
- if (res.ok) {
72
- const { value: result } = res;
73
- console.log(result);
74
- } else {
75
- console.log("conversationsList failed:", res.error);
76
- }
77
- }
78
-
79
- run();
80
- ```
81
-
82
- ### Parameters
83
-
84
- | Parameter | Type | Required | Description |
85
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
86
- | `request` | [operations.ConversationsListRequest](../../models/operations/conversationslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
87
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
88
- | `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. |
89
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
90
-
91
- ### Response
92
-
93
- **Promise\<[components.ListResponseConversation](../../models/components/listresponseconversation.md)\>**
94
-
95
- ### Errors
96
-
97
- | Error Type | Status Code | Content Type |
98
- | -------------------------- | -------------------------- | -------------------------- |
99
- | errors.HTTPValidationError | 422 | application/json |
100
- | errors.SDKError | 4XX, 5XX | \*/\* |