syllable-sdk 1.0.3 → 1.0.4-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 (221) hide show
  1. package/README.md +28 -13
  2. package/bin/mcp-server.js +1027 -16
  3. package/bin/mcp-server.js.map +47 -26
  4. package/docs/sdks/batches/README.md +4 -4
  5. package/docs/sdks/channels/README.md +16 -0
  6. package/docs/sdks/languagegroups/README.md +31 -19
  7. package/docs/sdks/voicegroups/README.md +551 -0
  8. package/docs/sdks/workflows/README.md +8 -8
  9. package/examples/package-lock.json +1 -1
  10. package/funcs/languageGroupsCreate.d.ts +3 -1
  11. package/funcs/languageGroupsCreate.d.ts.map +1 -1
  12. package/funcs/languageGroupsCreate.js +3 -1
  13. package/funcs/languageGroupsCreate.js.map +1 -1
  14. package/funcs/languageGroupsDelete.d.ts +3 -1
  15. package/funcs/languageGroupsDelete.d.ts.map +1 -1
  16. package/funcs/languageGroupsDelete.js +3 -1
  17. package/funcs/languageGroupsDelete.js.map +1 -1
  18. package/funcs/languageGroupsGetById.d.ts +3 -1
  19. package/funcs/languageGroupsGetById.d.ts.map +1 -1
  20. package/funcs/languageGroupsGetById.js +3 -1
  21. package/funcs/languageGroupsGetById.js.map +1 -1
  22. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.d.ts +4 -2
  23. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.d.ts.map +1 -1
  24. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.js +4 -2
  25. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.js.map +1 -1
  26. package/funcs/languageGroupsList.d.ts +3 -1
  27. package/funcs/languageGroupsList.d.ts.map +1 -1
  28. package/funcs/languageGroupsList.js +3 -1
  29. package/funcs/languageGroupsList.js.map +1 -1
  30. package/funcs/languageGroupsUpdate.d.ts +3 -1
  31. package/funcs/languageGroupsUpdate.d.ts.map +1 -1
  32. package/funcs/languageGroupsUpdate.js +3 -1
  33. package/funcs/languageGroupsUpdate.js.map +1 -1
  34. package/funcs/voiceGroupsCreate.d.ts +18 -0
  35. package/funcs/voiceGroupsCreate.d.ts.map +1 -0
  36. package/funcs/voiceGroupsCreate.js +118 -0
  37. package/funcs/voiceGroupsCreate.js.map +1 -0
  38. package/funcs/voiceGroupsDelete.d.ts +18 -0
  39. package/funcs/voiceGroupsDelete.d.ts.map +1 -0
  40. package/funcs/voiceGroupsDelete.js +128 -0
  41. package/funcs/voiceGroupsDelete.js.map +1 -0
  42. package/funcs/voiceGroupsGetById.d.ts +19 -0
  43. package/funcs/voiceGroupsGetById.d.ts.map +1 -0
  44. package/funcs/voiceGroupsGetById.js +124 -0
  45. package/funcs/voiceGroupsGetById.js.map +1 -0
  46. package/funcs/voiceGroupsList.d.ts +19 -0
  47. package/funcs/voiceGroupsList.d.ts.map +1 -0
  48. package/funcs/voiceGroupsList.js +130 -0
  49. package/funcs/voiceGroupsList.js.map +1 -0
  50. package/funcs/voiceGroupsUpdate.d.ts +18 -0
  51. package/funcs/voiceGroupsUpdate.d.ts.map +1 -0
  52. package/funcs/voiceGroupsUpdate.js +118 -0
  53. package/funcs/voiceGroupsUpdate.js.map +1 -0
  54. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts +18 -0
  55. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts.map +1 -0
  56. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js +119 -0
  57. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js.map +1 -0
  58. package/jsr.json +1 -1
  59. package/lib/config.d.ts +2 -2
  60. package/lib/config.js +2 -2
  61. package/lib/config.js.map +1 -1
  62. package/mcp-server/mcp-server.js +1 -1
  63. package/mcp-server/mcp-server.js.map +1 -1
  64. package/mcp-server/server.d.ts.map +1 -1
  65. package/mcp-server/server.js +13 -1
  66. package/mcp-server/server.js.map +1 -1
  67. package/mcp-server/tools/languageGroupsCreate.js +1 -1
  68. package/mcp-server/tools/languageGroupsCreate.js.map +1 -1
  69. package/mcp-server/tools/languageGroupsDelete.js +1 -1
  70. package/mcp-server/tools/languageGroupsDelete.js.map +1 -1
  71. package/mcp-server/tools/languageGroupsGetById.js +1 -1
  72. package/mcp-server/tools/languageGroupsGetById.js.map +1 -1
  73. package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.d.ts +1 -1
  74. package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.js +2 -2
  75. package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.js.map +1 -1
  76. package/mcp-server/tools/languageGroupsList.js +1 -1
  77. package/mcp-server/tools/languageGroupsList.js.map +1 -1
  78. package/mcp-server/tools/languageGroupsUpdate.js +1 -1
  79. package/mcp-server/tools/languageGroupsUpdate.js.map +1 -1
  80. package/mcp-server/tools/voiceGroupsCreate.d.ts +8 -0
  81. package/mcp-server/tools/voiceGroupsCreate.d.ts.map +1 -0
  82. package/mcp-server/tools/voiceGroupsCreate.js +64 -0
  83. package/mcp-server/tools/voiceGroupsCreate.js.map +1 -0
  84. package/mcp-server/tools/voiceGroupsDelete.d.ts +8 -0
  85. package/mcp-server/tools/voiceGroupsDelete.d.ts.map +1 -0
  86. package/mcp-server/tools/voiceGroupsDelete.js +64 -0
  87. package/mcp-server/tools/voiceGroupsDelete.js.map +1 -0
  88. package/mcp-server/tools/voiceGroupsGetById.d.ts +8 -0
  89. package/mcp-server/tools/voiceGroupsGetById.d.ts.map +1 -0
  90. package/mcp-server/tools/voiceGroupsGetById.js +64 -0
  91. package/mcp-server/tools/voiceGroupsGetById.js.map +1 -0
  92. package/mcp-server/tools/voiceGroupsList.d.ts +8 -0
  93. package/mcp-server/tools/voiceGroupsList.d.ts.map +1 -0
  94. package/mcp-server/tools/voiceGroupsList.js +64 -0
  95. package/mcp-server/tools/voiceGroupsList.js.map +1 -0
  96. package/mcp-server/tools/voiceGroupsUpdate.d.ts +8 -0
  97. package/mcp-server/tools/voiceGroupsUpdate.d.ts.map +1 -0
  98. package/mcp-server/tools/voiceGroupsUpdate.js +64 -0
  99. package/mcp-server/tools/voiceGroupsUpdate.js.map +1 -0
  100. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts +8 -0
  101. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts.map +1 -0
  102. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.js +64 -0
  103. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.js.map +1 -0
  104. package/models/components/channelservices.d.ts +3 -0
  105. package/models/components/channelservices.d.ts.map +1 -1
  106. package/models/components/channelservices.js +1 -0
  107. package/models/components/channelservices.js.map +1 -1
  108. package/models/components/index.d.ts +6 -0
  109. package/models/components/index.d.ts.map +1 -1
  110. package/models/components/index.js +6 -0
  111. package/models/components/index.js.map +1 -1
  112. package/models/components/languagegroupcreaterequest.d.ts +1 -1
  113. package/models/components/languagegroupproperties.d.ts +2 -2
  114. package/models/components/languagegroupproperties.js +1 -1
  115. package/models/components/languagegroupresponse.d.ts +3 -3
  116. package/models/components/languagegroupupdaterequest.d.ts +1 -1
  117. package/models/components/languagesamplecreaterequest.d.ts +68 -0
  118. package/models/components/languagesamplecreaterequest.d.ts.map +1 -0
  119. package/models/components/languagesamplecreaterequest.js +103 -0
  120. package/models/components/languagesamplecreaterequest.js.map +1 -0
  121. package/models/components/listresponsevoicegroupresponse.d.ts +53 -0
  122. package/models/components/listresponsevoicegroupresponse.d.ts.map +1 -0
  123. package/models/components/listresponsevoicegroupresponse.js +91 -0
  124. package/models/components/listresponsevoicegroupresponse.js.map +1 -0
  125. package/models/components/organizationchannelconfig.d.ts +9 -0
  126. package/models/components/organizationchannelconfig.d.ts.map +1 -1
  127. package/models/components/organizationchannelconfig.js +4 -0
  128. package/models/components/organizationchannelconfig.js.map +1 -1
  129. package/models/components/voicegroupcreaterequest.d.ts +51 -0
  130. package/models/components/voicegroupcreaterequest.d.ts.map +1 -0
  131. package/models/components/voicegroupcreaterequest.js +87 -0
  132. package/models/components/voicegroupcreaterequest.js.map +1 -0
  133. package/models/components/voicegroupproperties.d.ts +43 -0
  134. package/models/components/voicegroupproperties.d.ts.map +1 -0
  135. package/models/components/voicegroupproperties.js +66 -0
  136. package/models/components/voicegroupproperties.js.map +1 -0
  137. package/models/components/voicegroupresponse.d.ts +82 -0
  138. package/models/components/voicegroupresponse.d.ts.map +1 -0
  139. package/models/components/voicegroupresponse.js +108 -0
  140. package/models/components/voicegroupresponse.js.map +1 -0
  141. package/models/components/voicegroupupdaterequest.d.ts +61 -0
  142. package/models/components/voicegroupupdaterequest.d.ts.map +1 -0
  143. package/models/components/voicegroupupdaterequest.js +93 -0
  144. package/models/components/voicegroupupdaterequest.js.map +1 -0
  145. package/models/operations/index.d.ts +3 -0
  146. package/models/operations/index.d.ts.map +1 -1
  147. package/models/operations/index.js +3 -0
  148. package/models/operations/index.js.map +1 -1
  149. package/models/operations/voicegroupsdelete.d.ts +31 -0
  150. package/models/operations/voicegroupsdelete.d.ts.map +1 -0
  151. package/models/operations/voicegroupsdelete.js +80 -0
  152. package/models/operations/voicegroupsdelete.js.map +1 -0
  153. package/models/operations/voicegroupsgetbyid.d.ts +29 -0
  154. package/models/operations/voicegroupsgetbyid.d.ts.map +1 -0
  155. package/models/operations/voicegroupsgetbyid.js +78 -0
  156. package/models/operations/voicegroupsgetbyid.js.map +1 -0
  157. package/models/operations/voicegroupslist.d.ts +73 -0
  158. package/models/operations/voicegroupslist.d.ts.map +1 -0
  159. package/models/operations/voicegroupslist.js +113 -0
  160. package/models/operations/voicegroupslist.js.map +1 -0
  161. package/openapi.json +1464 -511
  162. package/package.json +1 -1
  163. package/sdk/languagegroups.d.ts +19 -7
  164. package/sdk/languagegroups.d.ts.map +1 -1
  165. package/sdk/languagegroups.js +18 -6
  166. package/sdk/languagegroups.js.map +1 -1
  167. package/sdk/sdk.d.ts +3 -0
  168. package/sdk/sdk.d.ts.map +1 -1
  169. package/sdk/sdk.js +4 -0
  170. package/sdk/sdk.js.map +1 -1
  171. package/sdk/voicegroups.d.ts +48 -0
  172. package/sdk/voicegroups.d.ts.map +1 -0
  173. package/sdk/voicegroups.js +72 -0
  174. package/sdk/voicegroups.js.map +1 -0
  175. package/src/funcs/languageGroupsCreate.ts +3 -1
  176. package/src/funcs/languageGroupsDelete.ts +3 -1
  177. package/src/funcs/languageGroupsGetById.ts +3 -1
  178. package/src/funcs/languageGroupsLanguageGroupsCreateVoiceSample.ts +7 -4
  179. package/src/funcs/languageGroupsList.ts +3 -1
  180. package/src/funcs/languageGroupsUpdate.ts +3 -1
  181. package/src/funcs/voiceGroupsCreate.ts +169 -0
  182. package/src/funcs/voiceGroupsDelete.ts +181 -0
  183. package/src/funcs/voiceGroupsGetById.ts +176 -0
  184. package/src/funcs/voiceGroupsList.ts +182 -0
  185. package/src/funcs/voiceGroupsUpdate.ts +169 -0
  186. package/src/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.ts +170 -0
  187. package/src/lib/config.ts +2 -2
  188. package/src/mcp-server/mcp-server.ts +1 -1
  189. package/src/mcp-server/server.ts +13 -1
  190. package/src/mcp-server/tools/languageGroupsCreate.ts +1 -1
  191. package/src/mcp-server/tools/languageGroupsDelete.ts +1 -1
  192. package/src/mcp-server/tools/languageGroupsGetById.ts +1 -1
  193. package/src/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.ts +2 -2
  194. package/src/mcp-server/tools/languageGroupsList.ts +1 -1
  195. package/src/mcp-server/tools/languageGroupsUpdate.ts +1 -1
  196. package/src/mcp-server/tools/voiceGroupsCreate.ts +37 -0
  197. package/src/mcp-server/tools/voiceGroupsDelete.ts +37 -0
  198. package/src/mcp-server/tools/voiceGroupsGetById.ts +37 -0
  199. package/src/mcp-server/tools/voiceGroupsList.ts +37 -0
  200. package/src/mcp-server/tools/voiceGroupsUpdate.ts +37 -0
  201. package/src/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.ts +39 -0
  202. package/src/models/components/channelservices.ts +1 -0
  203. package/src/models/components/index.ts +6 -0
  204. package/src/models/components/languagegroupcreaterequest.ts +1 -1
  205. package/src/models/components/languagegroupproperties.ts +2 -2
  206. package/src/models/components/languagegroupresponse.ts +3 -3
  207. package/src/models/components/languagegroupupdaterequest.ts +1 -1
  208. package/src/models/components/languagesamplecreaterequest.ts +150 -0
  209. package/src/models/components/listresponsevoicegroupresponse.ts +118 -0
  210. package/src/models/components/organizationchannelconfig.ts +9 -0
  211. package/src/models/components/voicegroupcreaterequest.ts +110 -0
  212. package/src/models/components/voicegroupproperties.ts +42 -0
  213. package/src/models/components/voicegroupresponse.ts +166 -0
  214. package/src/models/components/voicegroupupdaterequest.ts +126 -0
  215. package/src/models/operations/index.ts +3 -0
  216. package/src/models/operations/voicegroupsdelete.ts +79 -0
  217. package/src/models/operations/voicegroupsgetbyid.ts +75 -0
  218. package/src/models/operations/voicegroupslist.ts +153 -0
  219. package/src/sdk/languagegroups.ts +19 -7
  220. package/src/sdk/sdk.ts +6 -0
  221. package/src/sdk/voicegroups.ts +118 -0
@@ -0,0 +1,551 @@
1
+ # VoiceGroups
2
+ (*voiceGroups*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [list](#list) - List Voice Groups
9
+ * [create](#create) - Create Voice Group
10
+ * [update](#update) - Update Voice Group
11
+ * [getById](#getbyid) - Get Voice Group
12
+ * [delete](#delete) - Delete Voice Group
13
+ * [voiceGroupsCreateVoiceSample](#voicegroupscreatevoicesample) - Create Voice Sample
14
+
15
+ ## list
16
+
17
+ Fetch voice groups.
18
+
19
+ ### Example Usage
20
+
21
+ <!-- UsageSnippet language="typescript" operationID="voice_groups_list" method="get" path="/api/v1/voice_groups/" -->
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.voiceGroups.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 { voiceGroupsList } from "syllable-sdk/funcs/voiceGroupsList.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 voiceGroupsList(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("voiceGroupsList failed:", res.error);
79
+ }
80
+ }
81
+
82
+ run();
83
+ ```
84
+
85
+ ### Parameters
86
+
87
+ | Parameter | Type | Required | Description |
88
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
89
+ | `request` | [operations.VoiceGroupsListRequest](../../models/operations/voicegroupslistrequest.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.ListResponseVoiceGroupResponse](../../models/components/listresponsevoicegroupresponse.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 a new voice group.
108
+
109
+ ### Example Usage
110
+
111
+ <!-- UsageSnippet language="typescript" operationID="voice_groups_create" method="post" path="/api/v1/voice_groups/" -->
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.voiceGroups.create({
121
+ name: "Call Center 1 Languages",
122
+ description: "Languages spoken by operators at Call Center 1",
123
+ languageConfigs: [
124
+ {
125
+ languageCode: "en-US",
126
+ voiceProvider: "OpenAI",
127
+ voiceDisplayName: "Alloy",
128
+ dtmfCode: 1,
129
+ },
130
+ {
131
+ languageCode: "es-US",
132
+ voiceProvider: "Google",
133
+ voiceDisplayName: "es-US-Neural2-B",
134
+ dtmfCode: 2,
135
+ },
136
+ ],
137
+ skipCurrentLanguageInMessage: true,
138
+ });
139
+
140
+ console.log(result);
141
+ }
142
+
143
+ run();
144
+ ```
145
+
146
+ ### Standalone function
147
+
148
+ The standalone function version of this method:
149
+
150
+ ```typescript
151
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
152
+ import { voiceGroupsCreate } from "syllable-sdk/funcs/voiceGroupsCreate.js";
153
+
154
+ // Use `SyllableSDKCore` for best tree-shaking performance.
155
+ // You can create one instance of it to use across an application.
156
+ const syllableSDK = new SyllableSDKCore({
157
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
158
+ });
159
+
160
+ async function run() {
161
+ const res = await voiceGroupsCreate(syllableSDK, {
162
+ name: "Call Center 1 Languages",
163
+ description: "Languages spoken by operators at Call Center 1",
164
+ languageConfigs: [
165
+ {
166
+ languageCode: "en-US",
167
+ voiceProvider: "OpenAI",
168
+ voiceDisplayName: "Alloy",
169
+ dtmfCode: 1,
170
+ },
171
+ {
172
+ languageCode: "es-US",
173
+ voiceProvider: "Google",
174
+ voiceDisplayName: "es-US-Neural2-B",
175
+ dtmfCode: 2,
176
+ },
177
+ ],
178
+ skipCurrentLanguageInMessage: true,
179
+ });
180
+ if (res.ok) {
181
+ const { value: result } = res;
182
+ console.log(result);
183
+ } else {
184
+ console.log("voiceGroupsCreate failed:", res.error);
185
+ }
186
+ }
187
+
188
+ run();
189
+ ```
190
+
191
+ ### Parameters
192
+
193
+ | Parameter | Type | Required | Description |
194
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
195
+ | `request` | [components.VoiceGroupCreateRequest](../../models/components/voicegroupcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
196
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
197
+ | `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. |
198
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
199
+
200
+ ### Response
201
+
202
+ **Promise\<[components.VoiceGroupResponse](../../models/components/voicegroupresponse.md)\>**
203
+
204
+ ### Errors
205
+
206
+ | Error Type | Status Code | Content Type |
207
+ | -------------------------- | -------------------------- | -------------------------- |
208
+ | errors.HTTPValidationError | 422 | application/json |
209
+ | errors.SDKError | 4XX, 5XX | \*/\* |
210
+
211
+ ## update
212
+
213
+ Update an existing voice group
214
+
215
+ ### Example Usage
216
+
217
+ <!-- UsageSnippet language="typescript" operationID="voice_groups_update" method="put" path="/api/v1/voice_groups/" -->
218
+ ```typescript
219
+ import { SyllableSDK } from "syllable-sdk";
220
+
221
+ const syllableSDK = new SyllableSDK({
222
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
223
+ });
224
+
225
+ async function run() {
226
+ const result = await syllableSDK.voiceGroups.update({
227
+ name: "Call Center 1 Languages",
228
+ description: "Languages spoken by operators at Call Center 1",
229
+ languageConfigs: [
230
+ {
231
+ languageCode: "en-US",
232
+ voiceProvider: "OpenAI",
233
+ voiceDisplayName: "Alloy",
234
+ dtmfCode: 1,
235
+ },
236
+ {
237
+ languageCode: "es-US",
238
+ voiceProvider: "Google",
239
+ voiceDisplayName: "es-US-Neural2-B",
240
+ dtmfCode: 2,
241
+ },
242
+ ],
243
+ skipCurrentLanguageInMessage: true,
244
+ id: 1,
245
+ editComments: "Added Spanish support.",
246
+ });
247
+
248
+ console.log(result);
249
+ }
250
+
251
+ run();
252
+ ```
253
+
254
+ ### Standalone function
255
+
256
+ The standalone function version of this method:
257
+
258
+ ```typescript
259
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
260
+ import { voiceGroupsUpdate } from "syllable-sdk/funcs/voiceGroupsUpdate.js";
261
+
262
+ // Use `SyllableSDKCore` for best tree-shaking performance.
263
+ // You can create one instance of it to use across an application.
264
+ const syllableSDK = new SyllableSDKCore({
265
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
266
+ });
267
+
268
+ async function run() {
269
+ const res = await voiceGroupsUpdate(syllableSDK, {
270
+ name: "Call Center 1 Languages",
271
+ description: "Languages spoken by operators at Call Center 1",
272
+ languageConfigs: [
273
+ {
274
+ languageCode: "en-US",
275
+ voiceProvider: "OpenAI",
276
+ voiceDisplayName: "Alloy",
277
+ dtmfCode: 1,
278
+ },
279
+ {
280
+ languageCode: "es-US",
281
+ voiceProvider: "Google",
282
+ voiceDisplayName: "es-US-Neural2-B",
283
+ dtmfCode: 2,
284
+ },
285
+ ],
286
+ skipCurrentLanguageInMessage: true,
287
+ id: 1,
288
+ editComments: "Added Spanish support.",
289
+ });
290
+ if (res.ok) {
291
+ const { value: result } = res;
292
+ console.log(result);
293
+ } else {
294
+ console.log("voiceGroupsUpdate failed:", res.error);
295
+ }
296
+ }
297
+
298
+ run();
299
+ ```
300
+
301
+ ### Parameters
302
+
303
+ | Parameter | Type | Required | Description |
304
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
305
+ | `request` | [components.VoiceGroupUpdateRequest](../../models/components/voicegroupupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
306
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
307
+ | `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. |
308
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
309
+
310
+ ### Response
311
+
312
+ **Promise\<[components.VoiceGroupResponse](../../models/components/voicegroupresponse.md)\>**
313
+
314
+ ### Errors
315
+
316
+ | Error Type | Status Code | Content Type |
317
+ | -------------------------- | -------------------------- | -------------------------- |
318
+ | errors.HTTPValidationError | 422 | application/json |
319
+ | errors.SDKError | 4XX, 5XX | \*/\* |
320
+
321
+ ## getById
322
+
323
+ Fetch a given voice group.
324
+
325
+ ### Example Usage
326
+
327
+ <!-- UsageSnippet language="typescript" operationID="voice_groups_get_by_id" method="get" path="/api/v1/voice_groups/{voice_group_id}" -->
328
+ ```typescript
329
+ import { SyllableSDK } from "syllable-sdk";
330
+
331
+ const syllableSDK = new SyllableSDK({
332
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
333
+ });
334
+
335
+ async function run() {
336
+ const result = await syllableSDK.voiceGroups.getById({
337
+ voiceGroupId: 431245,
338
+ });
339
+
340
+ console.log(result);
341
+ }
342
+
343
+ run();
344
+ ```
345
+
346
+ ### Standalone function
347
+
348
+ The standalone function version of this method:
349
+
350
+ ```typescript
351
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
352
+ import { voiceGroupsGetById } from "syllable-sdk/funcs/voiceGroupsGetById.js";
353
+
354
+ // Use `SyllableSDKCore` for best tree-shaking performance.
355
+ // You can create one instance of it to use across an application.
356
+ const syllableSDK = new SyllableSDKCore({
357
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
358
+ });
359
+
360
+ async function run() {
361
+ const res = await voiceGroupsGetById(syllableSDK, {
362
+ voiceGroupId: 431245,
363
+ });
364
+ if (res.ok) {
365
+ const { value: result } = res;
366
+ console.log(result);
367
+ } else {
368
+ console.log("voiceGroupsGetById failed:", res.error);
369
+ }
370
+ }
371
+
372
+ run();
373
+ ```
374
+
375
+ ### Parameters
376
+
377
+ | Parameter | Type | Required | Description |
378
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
379
+ | `request` | [operations.VoiceGroupsGetByIdRequest](../../models/operations/voicegroupsgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
380
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
381
+ | `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. |
382
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
383
+
384
+ ### Response
385
+
386
+ **Promise\<[components.VoiceGroupResponse](../../models/components/voicegroupresponse.md)\>**
387
+
388
+ ### Errors
389
+
390
+ | Error Type | Status Code | Content Type |
391
+ | -------------------------- | -------------------------- | -------------------------- |
392
+ | errors.HTTPValidationError | 422 | application/json |
393
+ | errors.SDKError | 4XX, 5XX | \*/\* |
394
+
395
+ ## delete
396
+
397
+ Delete a voice group.
398
+
399
+ ### Example Usage
400
+
401
+ <!-- UsageSnippet language="typescript" operationID="voice_groups_delete" method="delete" path="/api/v1/voice_groups/{voice_group_id}" -->
402
+ ```typescript
403
+ import { SyllableSDK } from "syllable-sdk";
404
+
405
+ const syllableSDK = new SyllableSDK({
406
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
407
+ });
408
+
409
+ async function run() {
410
+ const result = await syllableSDK.voiceGroups.delete({
411
+ voiceGroupId: 225046,
412
+ reason: "<value>",
413
+ });
414
+
415
+ console.log(result);
416
+ }
417
+
418
+ run();
419
+ ```
420
+
421
+ ### Standalone function
422
+
423
+ The standalone function version of this method:
424
+
425
+ ```typescript
426
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
427
+ import { voiceGroupsDelete } from "syllable-sdk/funcs/voiceGroupsDelete.js";
428
+
429
+ // Use `SyllableSDKCore` for best tree-shaking performance.
430
+ // You can create one instance of it to use across an application.
431
+ const syllableSDK = new SyllableSDKCore({
432
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
433
+ });
434
+
435
+ async function run() {
436
+ const res = await voiceGroupsDelete(syllableSDK, {
437
+ voiceGroupId: 225046,
438
+ reason: "<value>",
439
+ });
440
+ if (res.ok) {
441
+ const { value: result } = res;
442
+ console.log(result);
443
+ } else {
444
+ console.log("voiceGroupsDelete failed:", res.error);
445
+ }
446
+ }
447
+
448
+ run();
449
+ ```
450
+
451
+ ### Parameters
452
+
453
+ | Parameter | Type | Required | Description |
454
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
455
+ | `request` | [operations.VoiceGroupsDeleteRequest](../../models/operations/voicegroupsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
456
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
457
+ | `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. |
458
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
459
+
460
+ ### Response
461
+
462
+ **Promise\<[any](../../models/.md)\>**
463
+
464
+ ### Errors
465
+
466
+ | Error Type | Status Code | Content Type |
467
+ | -------------------------- | -------------------------- | -------------------------- |
468
+ | errors.HTTPValidationError | 422 | application/json |
469
+ | errors.SDKError | 4XX, 5XX | \*/\* |
470
+
471
+ ## voiceGroupsCreateVoiceSample
472
+
473
+ Generate voice sample.
474
+
475
+ ### Example Usage
476
+
477
+ <!-- UsageSnippet language="typescript" operationID="voice_groups_create_voice_sample" method="post" path="/api/v1/voice_groups/voices/sample" -->
478
+ ```typescript
479
+ import { SyllableSDK } from "syllable-sdk";
480
+
481
+ const syllableSDK = new SyllableSDK({
482
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
483
+ });
484
+
485
+ async function run() {
486
+ const result = await syllableSDK.voiceGroups.voiceGroupsCreateVoiceSample({
487
+ languageCode: "fa-IR",
488
+ voiceProvider: "Google",
489
+ voiceDisplayName: "Vindemiatrix (English)",
490
+ voiceSpeed: 1,
491
+ voicePitch: 0,
492
+ });
493
+
494
+ console.log(result);
495
+ }
496
+
497
+ run();
498
+ ```
499
+
500
+ ### Standalone function
501
+
502
+ The standalone function version of this method:
503
+
504
+ ```typescript
505
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
506
+ import { voiceGroupsVoiceGroupsCreateVoiceSample } from "syllable-sdk/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js";
507
+
508
+ // Use `SyllableSDKCore` for best tree-shaking performance.
509
+ // You can create one instance of it to use across an application.
510
+ const syllableSDK = new SyllableSDKCore({
511
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
512
+ });
513
+
514
+ async function run() {
515
+ const res = await voiceGroupsVoiceGroupsCreateVoiceSample(syllableSDK, {
516
+ languageCode: "fa-IR",
517
+ voiceProvider: "Google",
518
+ voiceDisplayName: "Vindemiatrix (English)",
519
+ voiceSpeed: 1,
520
+ voicePitch: 0,
521
+ });
522
+ if (res.ok) {
523
+ const { value: result } = res;
524
+ console.log(result);
525
+ } else {
526
+ console.log("voiceGroupsVoiceGroupsCreateVoiceSample failed:", res.error);
527
+ }
528
+ }
529
+
530
+ run();
531
+ ```
532
+
533
+ ### Parameters
534
+
535
+ | Parameter | Type | Required | Description |
536
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
537
+ | `request` | [components.VoiceSampleCreateRequest](../../models/components/voicesamplecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
538
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
539
+ | `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. |
540
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
541
+
542
+ ### Response
543
+
544
+ **Promise\<[ReadableStream<Uint8Array>](../../models/.md)\>**
545
+
546
+ ### Errors
547
+
548
+ | Error Type | Status Code | Content Type |
549
+ | -------------------------- | -------------------------- | -------------------------- |
550
+ | errors.HTTPValidationError | 422 | application/json |
551
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -148,8 +148,8 @@ async function run() {
148
148
  "sheet_name": "Q1 Sales Data",
149
149
  },
150
150
  },
151
- startDatetime: new Date("2025-10-14T00:00:00Z"),
152
- endDatetime: new Date("2025-10-15T00:00:00Z"),
151
+ startDatetime: new Date("2025-10-15T00:00:00Z"),
152
+ endDatetime: new Date("2025-10-16T00:00:00Z"),
153
153
  });
154
154
 
155
155
  console.log(result);
@@ -200,8 +200,8 @@ async function run() {
200
200
  "sheet_name": "Q1 Sales Data",
201
201
  },
202
202
  },
203
- startDatetime: new Date("2025-10-14T00:00:00Z"),
204
- endDatetime: new Date("2025-10-15T00:00:00Z"),
203
+ startDatetime: new Date("2025-10-15T00:00:00Z"),
204
+ endDatetime: new Date("2025-10-16T00:00:00Z"),
205
205
  });
206
206
  if (res.ok) {
207
207
  const { value: result } = res;
@@ -352,8 +352,8 @@ async function run() {
352
352
  "sheet_name": "Q1 Sales Data",
353
353
  },
354
354
  },
355
- startDatetime: new Date("2025-10-14T00:00:00Z"),
356
- endDatetime: new Date("2025-10-15T00:00:00Z"),
355
+ startDatetime: new Date("2025-10-15T00:00:00Z"),
356
+ endDatetime: new Date("2025-10-16T00:00:00Z"),
357
357
  },
358
358
  });
359
359
 
@@ -407,8 +407,8 @@ async function run() {
407
407
  "sheet_name": "Q1 Sales Data",
408
408
  },
409
409
  },
410
- startDatetime: new Date("2025-10-14T00:00:00Z"),
411
- endDatetime: new Date("2025-10-15T00:00:00Z"),
410
+ startDatetime: new Date("2025-10-15T00:00:00Z"),
411
+ endDatetime: new Date("2025-10-16T00:00:00Z"),
412
412
  },
413
413
  });
414
414
  if (res.ok) {
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "..": {
20
20
  "name": "syllable-sdk",
21
- "version": "1.0.3",
21
+ "version": "1.0.4-rc.2",
22
22
  "dependencies": {
23
23
  "zod": "^3.20.0"
24
24
  },
@@ -12,7 +12,9 @@ import { Result } from "../types/fp.js";
12
12
  * Create Language Group
13
13
  *
14
14
  * @remarks
15
- * Create a new language group.
15
+ * Deprecated alias for `POST /api/v1/voice_groups/`.
16
+ *
17
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
16
18
  */
17
19
  export declare function languageGroupsCreate(client: SyllableSDKCore, request: components.LanguageGroupCreateRequest, options?: RequestOptions): APIPromise<Result<components.LanguageGroupResponse, errors.HTTPValidationError | SyllableSDKError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
20
  //# sourceMappingURL=languageGroupsCreate.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"languageGroupsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/languageGroupsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAK7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,qBAAqB,EAC9B,MAAM,CAAC,mBAAmB,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
1
+ {"version":3,"file":"languageGroupsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/languageGroupsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAK7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,qBAAqB,EAC9B,MAAM,CAAC,mBAAmB,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
@@ -50,7 +50,9 @@ const async_js_1 = require("../types/async.js");
50
50
  * Create Language Group
51
51
  *
52
52
  * @remarks
53
- * Create a new language group.
53
+ * Deprecated alias for `POST /api/v1/voice_groups/`.
54
+ *
55
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
54
56
  */
55
57
  function languageGroupsCreate(client, request, options) {
56
58
  return new async_js_1.APIPromise($do(client, request, options));