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