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/takeouts/README.md DELETED
@@ -1,228 +0,0 @@
1
- # Takeouts
2
- (*takeouts*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Create Takeout
9
- * [takeoutsGetByJobId](#takeoutsgetbyjobid) - Get Takeout
10
- * [takeoutsGetFile](#takeoutsgetfile) - Get File
11
-
12
- ## create
13
-
14
- Create Takeout
15
-
16
- ### Example Usage
17
-
18
- <!-- UsageSnippet language="typescript" operationID="takeouts_create" method="post" path="/api/v1/takeouts/create" -->
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.takeouts.create();
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 { takeoutsCreate } from "syllable-sdk/funcs/takeoutsCreate.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 takeoutsCreate(syllableSDK);
51
- if (res.ok) {
52
- const { value: result } = res;
53
- console.log(result);
54
- } else {
55
- console.log("takeoutsCreate failed:", res.error);
56
- }
57
- }
58
-
59
- run();
60
- ```
61
-
62
- ### Parameters
63
-
64
- | Parameter | Type | Required | Description |
65
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
66
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
67
- | `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. |
68
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
69
-
70
- ### Response
71
-
72
- **Promise\<[components.CreateTakeoutResponse](../../models/components/createtakeoutresponse.md)\>**
73
-
74
- ### Errors
75
-
76
- | Error Type | Status Code | Content Type |
77
- | --------------- | --------------- | --------------- |
78
- | errors.SDKError | 4XX, 5XX | \*/\* |
79
-
80
- ## takeoutsGetByJobId
81
-
82
- Get Takeout
83
-
84
- ### Example Usage
85
-
86
- <!-- UsageSnippet language="typescript" operationID="takeouts_get_by_job_id" method="get" path="/api/v1/takeouts/get/{job_id}" -->
87
- ```typescript
88
- import { SyllableSDK } from "syllable-sdk";
89
-
90
- const syllableSDK = new SyllableSDK({
91
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
92
- });
93
-
94
- async function run() {
95
- const result = await syllableSDK.takeouts.takeoutsGetByJobId({
96
- jobId: "<id>",
97
- });
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 { takeoutsTakeoutsGetByJobId } from "syllable-sdk/funcs/takeoutsTakeoutsGetByJobId.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 takeoutsTakeoutsGetByJobId(syllableSDK, {
121
- jobId: "<id>",
122
- });
123
- if (res.ok) {
124
- const { value: result } = res;
125
- console.log(result);
126
- } else {
127
- console.log("takeoutsTakeoutsGetByJobId failed:", res.error);
128
- }
129
- }
130
-
131
- run();
132
- ```
133
-
134
- ### Parameters
135
-
136
- | Parameter | Type | Required | Description |
137
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
138
- | `request` | [operations.TakeoutsGetByJobIdRequest](../../models/operations/takeoutsgetbyjobidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
139
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
140
- | `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. |
141
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
142
-
143
- ### Response
144
-
145
- **Promise\<[components.TakeoutStatusResponse](../../models/components/takeoutstatusresponse.md)\>**
146
-
147
- ### Errors
148
-
149
- | Error Type | Status Code | Content Type |
150
- | -------------------------- | -------------------------- | -------------------------- |
151
- | errors.HTTPValidationError | 422 | application/json |
152
- | errors.SDKError | 4XX, 5XX | \*/\* |
153
-
154
- ## takeoutsGetFile
155
-
156
- Get File
157
-
158
- ### Example Usage
159
-
160
- <!-- UsageSnippet language="typescript" operationID="takeouts_get_file" method="get" path="/api/v1/takeouts/get/{job_id}/file/{file_name}" -->
161
- ```typescript
162
- import { SyllableSDK } from "syllable-sdk";
163
-
164
- const syllableSDK = new SyllableSDK({
165
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
166
- });
167
-
168
- async function run() {
169
- const result = await syllableSDK.takeouts.takeoutsGetFile({
170
- jobId: "<id>",
171
- fileName: "example.file",
172
- });
173
-
174
- console.log(result);
175
- }
176
-
177
- run();
178
- ```
179
-
180
- ### Standalone function
181
-
182
- The standalone function version of this method:
183
-
184
- ```typescript
185
- import { SyllableSDKCore } from "syllable-sdk/core.js";
186
- import { takeoutsTakeoutsGetFile } from "syllable-sdk/funcs/takeoutsTakeoutsGetFile.js";
187
-
188
- // Use `SyllableSDKCore` for best tree-shaking performance.
189
- // You can create one instance of it to use across an application.
190
- const syllableSDK = new SyllableSDKCore({
191
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
192
- });
193
-
194
- async function run() {
195
- const res = await takeoutsTakeoutsGetFile(syllableSDK, {
196
- jobId: "<id>",
197
- fileName: "example.file",
198
- });
199
- if (res.ok) {
200
- const { value: result } = res;
201
- console.log(result);
202
- } else {
203
- console.log("takeoutsTakeoutsGetFile failed:", res.error);
204
- }
205
- }
206
-
207
- run();
208
- ```
209
-
210
- ### Parameters
211
-
212
- | Parameter | Type | Required | Description |
213
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
214
- | `request` | [operations.TakeoutsGetFileRequest](../../models/operations/takeoutsgetfilerequest.md) | :heavy_check_mark: | The request object to use for the request. |
215
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
216
- | `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. |
217
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
218
-
219
- ### Response
220
-
221
- **Promise\<[ReadableStream<Uint8Array>](../../models/.md)\>**
222
-
223
- ### Errors
224
-
225
- | Error Type | Status Code | Content Type |
226
- | -------------------------- | -------------------------- | -------------------------- |
227
- | errors.HTTPValidationError | 422 | application/json |
228
- | errors.SDKError | 4XX, 5XX | \*/\* |