syllable-sdk 1.0.8-rc.1 → 1.0.8-rc.3

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 (91) hide show
  1. package/bin/mcp-server.js +135 -59
  2. package/bin/mcp-server.js.map +13 -12
  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/models/components/daotoolresponse.d.ts +80 -0
  10. package/models/components/daotoolresponse.d.ts.map +1 -0
  11. package/models/components/daotoolresponse.js +111 -0
  12. package/models/components/daotoolresponse.js.map +1 -0
  13. package/models/components/index.d.ts +1 -0
  14. package/models/components/index.d.ts.map +1 -1
  15. package/models/components/index.js +1 -0
  16. package/models/components/index.js.map +1 -1
  17. package/models/components/promptcreaterequest.d.ts +5 -0
  18. package/models/components/promptcreaterequest.d.ts.map +1 -1
  19. package/models/components/promptcreaterequest.js +4 -0
  20. package/models/components/promptcreaterequest.js.map +1 -1
  21. package/models/components/promptresponse.d.ts +11 -0
  22. package/models/components/promptresponse.d.ts.map +1 -1
  23. package/models/components/promptresponse.js +9 -0
  24. package/models/components/promptresponse.js.map +1 -1
  25. package/models/components/promptupdaterequest.d.ts +5 -0
  26. package/models/components/promptupdaterequest.d.ts.map +1 -1
  27. package/models/components/promptupdaterequest.js +4 -0
  28. package/models/components/promptupdaterequest.js.map +1 -1
  29. package/openapi.json +243 -33
  30. package/package.json +1 -1
  31. package/src/lib/config.ts +3 -3
  32. package/src/mcp-server/mcp-server.ts +1 -1
  33. package/src/mcp-server/server.ts +1 -1
  34. package/src/models/components/daotoolresponse.ts +171 -0
  35. package/src/models/components/index.ts +1 -0
  36. package/src/models/components/promptcreaterequest.ts +9 -0
  37. package/src/models/components/promptresponse.ts +24 -0
  38. package/src/models/components/promptupdaterequest.ts +9 -0
  39. package/.devcontainer/README.md +0 -35
  40. package/api-reference/sdks/agents/README.md +0 -224
  41. package/api-reference/sdks/availabletargets/README.md +0 -49
  42. package/api-reference/sdks/channels/README.md +0 -92
  43. package/api-reference/sdks/chats/README.md +0 -55
  44. package/api-reference/sdks/conversations/README.md +0 -91
  45. package/api-reference/sdks/dashboards/README.md +0 -321
  46. package/api-reference/sdks/events/README.md +0 -50
  47. package/api-reference/sdks/greetings/README.md +0 -223
  48. package/api-reference/sdks/organizations/README.md +0 -48
  49. package/api-reference/sdks/prompts/README.md +0 -225
  50. package/api-reference/sdks/sessions/README.md +0 -50
  51. package/api-reference/sdks/syllable/README.md +0 -22
  52. package/api-reference/sdks/targets/README.md +0 -194
  53. package/api-reference/sdks/tools/README.md +0 -92
  54. package/docs/sdks/agents/README.md +0 -589
  55. package/docs/sdks/batches/README.md +0 -742
  56. package/docs/sdks/campaigns/README.md +0 -526
  57. package/docs/sdks/channels/README.md +0 -401
  58. package/docs/sdks/conversations/README.md +0 -100
  59. package/docs/sdks/custommessages/README.md +0 -496
  60. package/docs/sdks/dashboards/README.md +0 -481
  61. package/docs/sdks/datasources/README.md +0 -458
  62. package/docs/sdks/directory/README.md +0 -727
  63. package/docs/sdks/events/README.md +0 -100
  64. package/docs/sdks/folders/README.md +0 -675
  65. package/docs/sdks/fullsummary/README.md +0 -82
  66. package/docs/sdks/incidents/README.md +0 -501
  67. package/docs/sdks/insights/README.md +0 -100
  68. package/docs/sdks/languagegroups/README.md +0 -565
  69. package/docs/sdks/latency/README.md +0 -82
  70. package/docs/sdks/numbers/README.md +0 -250
  71. package/docs/sdks/organizations/README.md +0 -317
  72. package/docs/sdks/permissions/README.md +0 -78
  73. package/docs/sdks/prompts/README.md +0 -592
  74. package/docs/sdks/pronunciations/README.md +0 -360
  75. package/docs/sdks/roles/README.md +0 -430
  76. package/docs/sdks/services/README.md +0 -430
  77. package/docs/sdks/sessiondebug/README.md +0 -236
  78. package/docs/sdks/sessionlabels/README.md +0 -262
  79. package/docs/sdks/sessions/README.md +0 -325
  80. package/docs/sdks/syllablesdktools/README.md +0 -578
  81. package/docs/sdks/takeouts/README.md +0 -228
  82. package/docs/sdks/targets/README.md +0 -454
  83. package/docs/sdks/test/README.md +0 -92
  84. package/docs/sdks/tools/README.md +0 -518
  85. package/docs/sdks/transcript/README.md +0 -82
  86. package/docs/sdks/twilio/README.md +0 -246
  87. package/docs/sdks/users/README.md +0 -561
  88. package/docs/sdks/v1/README.md +0 -561
  89. package/docs/sdks/voicegroups/README.md +0 -551
  90. package/docs/sdks/workflows/README.md +0 -781
  91. package/examples/README.md +0 -31
package/docs/sdks/latency/README.md DELETED
@@ -1,82 +0,0 @@
1
- # Latency
2
- (*sessions.latency*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [getById](#getbyid) - Inspect Latency For Session
9
-
10
- ## getById
11
-
12
- Inspect Latency For Session
13
-
14
- ### Example Usage
15
-
16
- <!-- UsageSnippet language="typescript" operationID="session_latency_get_by_id" method="get" path="/api/v1/sessions/latency/{session_id}" -->
17
- ```typescript
18
- import { SyllableSDK } from "syllable-sdk";
19
-
20
- const syllableSDK = new SyllableSDK({
21
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
22
- });
23
-
24
- async function run() {
25
- const result = await syllableSDK.sessions.latency.getById({
26
- sessionId: "<id>",
27
- });
28
-
29
- console.log(result);
30
- }
31
-
32
- run();
33
- ```
34
-
35
- ### Standalone function
36
-
37
- The standalone function version of this method:
38
-
39
- ```typescript
40
- import { SyllableSDKCore } from "syllable-sdk/core.js";
41
- import { sessionsLatencyGetById } from "syllable-sdk/funcs/sessionsLatencyGetById.js";
42
-
43
- // Use `SyllableSDKCore` for best tree-shaking performance.
44
- // You can create one instance of it to use across an application.
45
- const syllableSDK = new SyllableSDKCore({
46
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
47
- });
48
-
49
- async function run() {
50
- const res = await sessionsLatencyGetById(syllableSDK, {
51
- sessionId: "<id>",
52
- });
53
- if (res.ok) {
54
- const { value: result } = res;
55
- console.log(result);
56
- } else {
57
- console.log("sessionsLatencyGetById failed:", res.error);
58
- }
59
- }
60
-
61
- run();
62
- ```
63
-
64
- ### Parameters
65
-
66
- | Parameter | Type | Required | Description |
67
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
68
- | `request` | [operations.SessionLatencyGetByIdRequest](../../models/operations/sessionlatencygetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
69
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
70
- | `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. |
71
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
72
-
73
- ### Response
74
-
75
- **Promise\<[components.InspectLatencyResponse](../../models/components/inspectlatencyresponse.md)\>**
76
-
77
- ### Errors
78
-
79
- | Error Type | Status Code | Content Type |
80
- | -------------------------- | -------------------------- | -------------------------- |
81
- | errors.HTTPValidationError | 422 | application/json |
82
- | errors.SDKError | 4XX, 5XX | \*/\* |
package/docs/sdks/numbers/README.md DELETED
@@ -1,250 +0,0 @@
1
- # Numbers
2
- (*channels.twilio.numbers*)
3
-
4
- ## Overview
5
-
6
- Operations related to setting up phone numbers in Twilio for use in channels.
7
-
8
- ### Available Operations
9
-
10
- * [add](#add) - Add Twilio Number
11
- * [update](#update) - Update Twilio Number
12
- * [list](#list) - List Twilio Phone Numbers
13
-
14
- ## add
15
-
16
- Purchase a Twilio number and associate it with a channel.
17
-
18
- ### Example Usage
19
-
20
- <!-- UsageSnippet language="typescript" operationID="channels_twilio_numbers_add" method="post" path="/api/v1/channels/twilio/{channel_id}/numbers" -->
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.channels.twilio.numbers.add({
30
- channelId: 314558,
31
- twilioNumberAddRequest: {
32
- friendlyName: "Support Line",
33
- areaCode: "804",
34
- },
35
- });
36
-
37
- console.log(result);
38
- }
39
-
40
- run();
41
- ```
42
-
43
- ### Standalone function
44
-
45
- The standalone function version of this method:
46
-
47
- ```typescript
48
- import { SyllableSDKCore } from "syllable-sdk/core.js";
49
- import { channelsTwilioNumbersAdd } from "syllable-sdk/funcs/channelsTwilioNumbersAdd.js";
50
-
51
- // Use `SyllableSDKCore` for best tree-shaking performance.
52
- // You can create one instance of it to use across an application.
53
- const syllableSDK = new SyllableSDKCore({
54
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
55
- });
56
-
57
- async function run() {
58
- const res = await channelsTwilioNumbersAdd(syllableSDK, {
59
- channelId: 314558,
60
- twilioNumberAddRequest: {
61
- friendlyName: "Support Line",
62
- areaCode: "804",
63
- },
64
- });
65
- if (res.ok) {
66
- const { value: result } = res;
67
- console.log(result);
68
- } else {
69
- console.log("channelsTwilioNumbersAdd failed:", res.error);
70
- }
71
- }
72
-
73
- run();
74
- ```
75
-
76
- ### Parameters
77
-
78
- | Parameter | Type | Required | Description |
79
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
80
- | `request` | [operations.ChannelsTwilioNumbersAddRequest](../../models/operations/channelstwilionumbersaddrequest.md) | :heavy_check_mark: | The request object to use for the request. |
81
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
82
- | `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. |
83
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
84
-
85
- ### Response
86
-
87
- **Promise\<[components.TwilioNumberAddResponse](../../models/components/twilionumberaddresponse.md)\>**
88
-
89
- ### Errors
90
-
91
- | Error Type | Status Code | Content Type |
92
- | -------------------------- | -------------------------- | -------------------------- |
93
- | errors.HTTPValidationError | 422 | application/json |
94
- | errors.SDKError | 4XX, 5XX | \*/\* |
95
-
96
- ## update
97
-
98
- Update a Twilio number and associate it with a channel.
99
-
100
- ### Example Usage
101
-
102
- <!-- UsageSnippet language="typescript" operationID="channels_twilio_numbers_update" method="put" path="/api/v1/channels/twilio/{channel_id}/numbers" -->
103
- ```typescript
104
- import { SyllableSDK } from "syllable-sdk";
105
-
106
- const syllableSDK = new SyllableSDK({
107
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
108
- });
109
-
110
- async function run() {
111
- const result = await syllableSDK.channels.twilio.numbers.update({
112
- channelId: 815949,
113
- twilioNumberUpdateRequest: {
114
- friendlyName: "Support Line",
115
- phoneSid: "PN123",
116
- },
117
- });
118
-
119
- console.log(result);
120
- }
121
-
122
- run();
123
- ```
124
-
125
- ### Standalone function
126
-
127
- The standalone function version of this method:
128
-
129
- ```typescript
130
- import { SyllableSDKCore } from "syllable-sdk/core.js";
131
- import { channelsTwilioNumbersUpdate } from "syllable-sdk/funcs/channelsTwilioNumbersUpdate.js";
132
-
133
- // Use `SyllableSDKCore` for best tree-shaking performance.
134
- // You can create one instance of it to use across an application.
135
- const syllableSDK = new SyllableSDKCore({
136
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
137
- });
138
-
139
- async function run() {
140
- const res = await channelsTwilioNumbersUpdate(syllableSDK, {
141
- channelId: 815949,
142
- twilioNumberUpdateRequest: {
143
- friendlyName: "Support Line",
144
- phoneSid: "PN123",
145
- },
146
- });
147
- if (res.ok) {
148
- const { value: result } = res;
149
- console.log(result);
150
- } else {
151
- console.log("channelsTwilioNumbersUpdate failed:", res.error);
152
- }
153
- }
154
-
155
- run();
156
- ```
157
-
158
- ### Parameters
159
-
160
- | Parameter | Type | Required | Description |
161
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
162
- | `request` | [operations.ChannelsTwilioNumbersUpdateRequest](../../models/operations/channelstwilionumbersupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
163
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
164
- | `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. |
165
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
166
-
167
- ### Response
168
-
169
- **Promise\<[components.TwilioNumberUpdateResponse](../../models/components/twilionumberupdateresponse.md)\>**
170
-
171
- ### Errors
172
-
173
- | Error Type | Status Code | Content Type |
174
- | -------------------------- | -------------------------- | -------------------------- |
175
- | errors.HTTPValidationError | 422 | application/json |
176
- | errors.SDKError | 4XX, 5XX | \*/\* |
177
-
178
- ## list
179
-
180
- List Twilio phone numbers.
181
-
182
- ### Example Usage
183
-
184
- <!-- UsageSnippet language="typescript" operationID="channels_twilio_numbers_list" method="get" path="/api/v1/channels/twilio/{channel_id}/numbers" -->
185
- ```typescript
186
- import { SyllableSDK } from "syllable-sdk";
187
-
188
- const syllableSDK = new SyllableSDK({
189
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
190
- });
191
-
192
- async function run() {
193
- const result = await syllableSDK.channels.twilio.numbers.list({
194
- channelId: 739627,
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 { SyllableSDKCore } from "syllable-sdk/core.js";
209
- import { channelsTwilioNumbersList } from "syllable-sdk/funcs/channelsTwilioNumbersList.js";
210
-
211
- // Use `SyllableSDKCore` for best tree-shaking performance.
212
- // You can create one instance of it to use across an application.
213
- const syllableSDK = new SyllableSDKCore({
214
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
215
- });
216
-
217
- async function run() {
218
- const res = await channelsTwilioNumbersList(syllableSDK, {
219
- channelId: 739627,
220
- });
221
- if (res.ok) {
222
- const { value: result } = res;
223
- console.log(result);
224
- } else {
225
- console.log("channelsTwilioNumbersList failed:", res.error);
226
- }
227
- }
228
-
229
- run();
230
- ```
231
-
232
- ### Parameters
233
-
234
- | Parameter | Type | Required | Description |
235
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
236
- | `request` | [operations.ChannelsTwilioNumbersListRequest](../../models/operations/channelstwilionumberslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
237
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
238
- | `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. |
239
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
240
-
241
- ### Response
242
-
243
- **Promise\<[components.TwilioListNumbersResponse](../../models/components/twiliolistnumbersresponse.md)\>**
244
-
245
- ### Errors
246
-
247
- | Error Type | Status Code | Content Type |
248
- | -------------------------- | -------------------------- | -------------------------- |
249
- | errors.HTTPValidationError | 422 | application/json |
250
- | errors.SDKError | 4XX, 5XX | \*/\* |