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/sessions/README.md DELETED
@@ -1,325 +0,0 @@
1
- # Sessions
2
- (*sessions*)
3
-
4
- ## Overview
5
-
6
- Operations related to sessions. A session is a building block of a conversation. For more information, see [Console docs](https://docs.syllable.ai/workspaces/Sessions).
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Sessions List
11
- * [getById](#getbyid) - Get A Single Session By Id
12
- * [generateSessionRecordingUrls](#generatesessionrecordingurls) - Generate Recording Urls
13
- * [sessionRecordingStream](#sessionrecordingstream) - Stream Recording
14
-
15
- ## list
16
-
17
- Sessions List
18
-
19
- ### Example Usage
20
-
21
- <!-- UsageSnippet language="typescript" operationID="sessions_list" method="get" path="/api/v1/sessions/" -->
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.sessions.list({
31
- page: 0,
32
- searchFields: [
33
- "conversation_id",
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 { sessionsList } from "syllable-sdk/funcs/sessionsList.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 sessionsList(syllableSDK, {
64
- page: 0,
65
- searchFields: [
66
- "conversation_id",
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("sessionsList failed:", res.error);
79
- }
80
- }
81
-
82
- run();
83
- ```
84
-
85
- ### Parameters
86
-
87
- | Parameter | Type | Required | Description |
88
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
89
- | `request` | [operations.SessionsListRequest](../../models/operations/sessionslistrequest.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.ListResponseSession](../../models/components/listresponsesession.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
- ## getById
106
-
107
- Get A Single Session By Id
108
-
109
- ### Example Usage
110
-
111
- <!-- UsageSnippet language="typescript" operationID="session_get_by_id" method="get" path="/api/v1/sessions/{session_id}" -->
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.sessions.getById({
121
- sessionId: "<id>",
122
- });
123
-
124
- console.log(result);
125
- }
126
-
127
- run();
128
- ```
129
-
130
- ### Standalone function
131
-
132
- The standalone function version of this method:
133
-
134
- ```typescript
135
- import { SyllableSDKCore } from "syllable-sdk/core.js";
136
- import { sessionsGetById } from "syllable-sdk/funcs/sessionsGetById.js";
137
-
138
- // Use `SyllableSDKCore` for best tree-shaking performance.
139
- // You can create one instance of it to use across an application.
140
- const syllableSDK = new SyllableSDKCore({
141
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
142
- });
143
-
144
- async function run() {
145
- const res = await sessionsGetById(syllableSDK, {
146
- sessionId: "<id>",
147
- });
148
- if (res.ok) {
149
- const { value: result } = res;
150
- console.log(result);
151
- } else {
152
- console.log("sessionsGetById failed:", res.error);
153
- }
154
- }
155
-
156
- run();
157
- ```
158
-
159
- ### Parameters
160
-
161
- | Parameter | Type | Required | Description |
162
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
163
- | `request` | [operations.SessionGetByIdRequest](../../models/operations/sessiongetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
164
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
165
- | `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. |
166
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
167
-
168
- ### Response
169
-
170
- **Promise\<[components.Session](../../models/components/session.md)\>**
171
-
172
- ### Errors
173
-
174
- | Error Type | Status Code | Content Type |
175
- | -------------------------- | -------------------------- | -------------------------- |
176
- | errors.HTTPValidationError | 422 | application/json |
177
- | errors.SDKError | 4XX, 5XX | \*/\* |
178
-
179
- ## generateSessionRecordingUrls
180
-
181
- Generate Recording Urls
182
-
183
- ### Example Usage
184
-
185
- <!-- UsageSnippet language="typescript" operationID="generate_session_recording_urls" method="post" path="/api/v1/sessions/recording/{session_id}" -->
186
- ```typescript
187
- import { SyllableSDK } from "syllable-sdk";
188
-
189
- const syllableSDK = new SyllableSDK({
190
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
191
- });
192
-
193
- async function run() {
194
- const result = await syllableSDK.sessions.generateSessionRecordingUrls({
195
- sessionId: "<id>",
196
- });
197
-
198
- console.log(result);
199
- }
200
-
201
- run();
202
- ```
203
-
204
- ### Standalone function
205
-
206
- The standalone function version of this method:
207
-
208
- ```typescript
209
- import { SyllableSDKCore } from "syllable-sdk/core.js";
210
- import { sessionsGenerateSessionRecordingUrls } from "syllable-sdk/funcs/sessionsGenerateSessionRecordingUrls.js";
211
-
212
- // Use `SyllableSDKCore` for best tree-shaking performance.
213
- // You can create one instance of it to use across an application.
214
- const syllableSDK = new SyllableSDKCore({
215
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
216
- });
217
-
218
- async function run() {
219
- const res = await sessionsGenerateSessionRecordingUrls(syllableSDK, {
220
- sessionId: "<id>",
221
- });
222
- if (res.ok) {
223
- const { value: result } = res;
224
- console.log(result);
225
- } else {
226
- console.log("sessionsGenerateSessionRecordingUrls failed:", res.error);
227
- }
228
- }
229
-
230
- run();
231
- ```
232
-
233
- ### Parameters
234
-
235
- | Parameter | Type | Required | Description |
236
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
237
- | `request` | [operations.GenerateSessionRecordingUrlsRequest](../../models/operations/generatesessionrecordingurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
238
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
239
- | `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. |
240
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
241
-
242
- ### Response
243
-
244
- **Promise\<[components.SessionRecordingResponse](../../models/components/sessionrecordingresponse.md)\>**
245
-
246
- ### Errors
247
-
248
- | Error Type | Status Code | Content Type |
249
- | -------------------------- | -------------------------- | -------------------------- |
250
- | errors.HTTPValidationError | 422 | application/json |
251
- | errors.SDKError | 4XX, 5XX | \*/\* |
252
-
253
- ## sessionRecordingStream
254
-
255
- Stream Recording
256
-
257
- ### Example Usage
258
-
259
- <!-- UsageSnippet language="typescript" operationID="session_recording_stream" method="get" path="/api/v1/sessions/recording/stream" -->
260
- ```typescript
261
- import { SyllableSDK } from "syllable-sdk";
262
-
263
- const syllableSDK = new SyllableSDK({
264
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
265
- });
266
-
267
- async function run() {
268
- const result = await syllableSDK.sessions.sessionRecordingStream({
269
- token: "<value>",
270
- });
271
-
272
- console.log(result);
273
- }
274
-
275
- run();
276
- ```
277
-
278
- ### Standalone function
279
-
280
- The standalone function version of this method:
281
-
282
- ```typescript
283
- import { SyllableSDKCore } from "syllable-sdk/core.js";
284
- import { sessionsSessionRecordingStream } from "syllable-sdk/funcs/sessionsSessionRecordingStream.js";
285
-
286
- // Use `SyllableSDKCore` for best tree-shaking performance.
287
- // You can create one instance of it to use across an application.
288
- const syllableSDK = new SyllableSDKCore({
289
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
290
- });
291
-
292
- async function run() {
293
- const res = await sessionsSessionRecordingStream(syllableSDK, {
294
- token: "<value>",
295
- });
296
- if (res.ok) {
297
- const { value: result } = res;
298
- console.log(result);
299
- } else {
300
- console.log("sessionsSessionRecordingStream failed:", res.error);
301
- }
302
- }
303
-
304
- run();
305
- ```
306
-
307
- ### Parameters
308
-
309
- | Parameter | Type | Required | Description |
310
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
311
- | `request` | [operations.SessionRecordingStreamRequest](../../models/operations/sessionrecordingstreamrequest.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\<[ReadableStream<Uint8Array>](../../models/.md)\>**
319
-
320
- ### Errors
321
-
322
- | Error Type | Status Code | Content Type |
323
- | -------------------------- | -------------------------- | -------------------------- |
324
- | errors.HTTPValidationError | 422 | application/json |
325
- | errors.SDKError | 4XX, 5XX | \*/\* |