syllable-sdk 0.1.0-alpha.48 → 0.1.0-alpha.49

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 (199) hide show
  1. package/README.md +18 -4
  2. package/docs/sdks/fullsummary/README.md +85 -0
  3. package/docs/sdks/languagegroups/README.md +465 -0
  4. package/docs/sdks/v1/README.md +0 -158
  5. package/funcs/languageGroupsCreate.d.ts +16 -0
  6. package/funcs/languageGroupsCreate.d.ts.map +1 -0
  7. package/funcs/languageGroupsCreate.js +102 -0
  8. package/funcs/languageGroupsCreate.js.map +1 -0
  9. package/funcs/{v1Delete.d.ts → languageGroupsDelete.d.ts} +4 -4
  10. package/funcs/languageGroupsDelete.d.ts.map +1 -0
  11. package/funcs/{v1Delete.js → languageGroupsDelete.js} +9 -12
  12. package/funcs/languageGroupsDelete.js.map +1 -0
  13. package/funcs/languageGroupsGetById.d.ts +17 -0
  14. package/funcs/languageGroupsGetById.d.ts.map +1 -0
  15. package/funcs/languageGroupsGetById.js +105 -0
  16. package/funcs/languageGroupsGetById.js.map +1 -0
  17. package/funcs/{v1GetById.d.ts → languageGroupsList.d.ts} +4 -4
  18. package/funcs/languageGroupsList.d.ts.map +1 -0
  19. package/funcs/languageGroupsList.js +114 -0
  20. package/funcs/languageGroupsList.js.map +1 -0
  21. package/funcs/languageGroupsUpdate.d.ts +16 -0
  22. package/funcs/languageGroupsUpdate.d.ts.map +1 -0
  23. package/funcs/languageGroupsUpdate.js +102 -0
  24. package/funcs/languageGroupsUpdate.js.map +1 -0
  25. package/funcs/sessionsFullSummaryGetById.d.ts +14 -0
  26. package/funcs/sessionsFullSummaryGetById.d.ts.map +1 -0
  27. package/funcs/{v1GetById.js → sessionsFullSummaryGetById.js} +9 -12
  28. package/funcs/sessionsFullSummaryGetById.js.map +1 -0
  29. package/jsr.json +1 -1
  30. package/lib/config.d.ts +2 -2
  31. package/lib/config.js +2 -2
  32. package/models/components/agentcreate.d.ts +7 -0
  33. package/models/components/agentcreate.d.ts.map +1 -1
  34. package/models/components/agentcreate.js +4 -0
  35. package/models/components/agentcreate.js.map +1 -1
  36. package/models/components/agentlanguage.d.ts +41 -0
  37. package/models/components/agentlanguage.d.ts.map +1 -0
  38. package/models/components/agentlanguage.js +62 -0
  39. package/models/components/agentlanguage.js.map +1 -0
  40. package/models/components/agentresponse.d.ts +13 -0
  41. package/models/components/agentresponse.d.ts.map +1 -1
  42. package/models/components/agentresponse.js +9 -0
  43. package/models/components/agentresponse.js.map +1 -1
  44. package/models/components/agentupdate.d.ts +7 -0
  45. package/models/components/agentupdate.d.ts.map +1 -1
  46. package/models/components/agentupdate.js +4 -0
  47. package/models/components/agentupdate.js.map +1 -1
  48. package/models/components/agentvoice.d.ts +29 -5
  49. package/models/components/agentvoice.d.ts.map +1 -1
  50. package/models/components/agentvoice.js +19 -5
  51. package/models/components/agentvoice.js.map +1 -1
  52. package/models/components/agentvoicedisplayname.d.ts +142 -0
  53. package/models/components/agentvoicedisplayname.d.ts.map +1 -0
  54. package/models/components/agentvoicedisplayname.js +89 -0
  55. package/models/components/agentvoicedisplayname.js.map +1 -0
  56. package/models/components/agentvoicegender.d.ts +34 -0
  57. package/models/components/agentvoicegender.d.ts.map +1 -0
  58. package/models/components/agentvoicegender.js +53 -0
  59. package/models/components/agentvoicegender.js.map +1 -0
  60. package/models/components/agentvoicemodel.d.ts +46 -0
  61. package/models/components/agentvoicemodel.d.ts.map +1 -0
  62. package/models/components/agentvoicemodel.js +57 -0
  63. package/models/components/agentvoicemodel.js.map +1 -0
  64. package/models/components/agentvoicevarname.d.ts +30 -0
  65. package/models/components/agentvoicevarname.d.ts.map +1 -1
  66. package/models/components/agentvoicevarname.js +10 -0
  67. package/models/components/agentvoicevarname.js.map +1 -1
  68. package/models/components/index.d.ts +13 -1
  69. package/models/components/index.d.ts.map +1 -1
  70. package/models/components/index.js +13 -1
  71. package/models/components/index.js.map +1 -1
  72. package/models/components/languagecode.d.ts +49 -0
  73. package/models/components/languagecode.d.ts.map +1 -0
  74. package/models/components/languagecode.js +58 -0
  75. package/models/components/languagecode.js.map +1 -0
  76. package/models/components/languageconfig.d.ts +56 -0
  77. package/models/components/languageconfig.d.ts.map +1 -0
  78. package/models/components/languageconfig.js +83 -0
  79. package/models/components/languageconfig.js.map +1 -0
  80. package/models/components/languagegroupcreaterequest.d.ts +48 -0
  81. package/models/components/languagegroupcreaterequest.d.ts.map +1 -0
  82. package/models/components/languagegroupcreaterequest.js +77 -0
  83. package/models/components/languagegroupcreaterequest.js.map +1 -0
  84. package/models/components/languagegroupproperties.d.ts +37 -0
  85. package/models/components/languagegroupproperties.d.ts.map +1 -0
  86. package/models/components/languagegroupproperties.js +53 -0
  87. package/models/components/languagegroupproperties.js.map +1 -0
  88. package/models/components/languagegroupresponse.d.ts +68 -0
  89. package/models/components/languagegroupresponse.d.ts.map +1 -0
  90. package/models/components/languagegroupresponse.js +91 -0
  91. package/models/components/languagegroupresponse.js.map +1 -0
  92. package/models/components/languagegroupupdaterequest.d.ts +58 -0
  93. package/models/components/languagegroupupdaterequest.d.ts.map +1 -0
  94. package/models/components/languagegroupupdaterequest.js +83 -0
  95. package/models/components/languagegroupupdaterequest.js.map +1 -0
  96. package/models/components/listresponselanguagegroupresponse.d.ts +38 -0
  97. package/models/components/listresponselanguagegroupresponse.d.ts.map +1 -0
  98. package/models/components/listresponselanguagegroupresponse.js +81 -0
  99. package/models/components/listresponselanguagegroupresponse.js.map +1 -0
  100. package/models/components/promptcreaterequest.d.ts +1 -1
  101. package/models/components/promptupdaterequest.d.ts +1 -1
  102. package/models/components/sessionrecordingresponse.d.ts +0 -5
  103. package/models/components/sessionrecordingresponse.d.ts.map +1 -1
  104. package/models/components/sessionrecordingresponse.js +0 -2
  105. package/models/components/sessionrecordingresponse.js.map +1 -1
  106. package/models/components/sessionsummaryresponse.d.ts +40 -0
  107. package/models/components/sessionsummaryresponse.d.ts.map +1 -0
  108. package/models/components/sessionsummaryresponse.js +61 -0
  109. package/models/components/sessionsummaryresponse.js.map +1 -0
  110. package/models/components/{sttprovider.d.ts → ttsprovider.d.ts} +10 -10
  111. package/models/components/{sttprovider.d.ts.map → ttsprovider.d.ts.map} +1 -1
  112. package/models/components/{sttprovider.js → ttsprovider.js} +14 -14
  113. package/models/components/{sttprovider.js.map → ttsprovider.js.map} +1 -1
  114. package/models/operations/index.d.ts +4 -0
  115. package/models/operations/index.d.ts.map +1 -1
  116. package/models/operations/index.js +4 -0
  117. package/models/operations/index.js.map +1 -1
  118. package/models/operations/languagegroupsdelete.d.ts +31 -0
  119. package/models/operations/languagegroupsdelete.d.ts.map +1 -0
  120. package/models/operations/languagegroupsdelete.js +70 -0
  121. package/models/operations/languagegroupsdelete.js.map +1 -0
  122. package/models/operations/languagegroupsgetbyid.d.ts +29 -0
  123. package/models/operations/languagegroupsgetbyid.d.ts.map +1 -0
  124. package/models/operations/languagegroupsgetbyid.js +68 -0
  125. package/models/operations/languagegroupsgetbyid.js.map +1 -0
  126. package/models/operations/languagegroupslist.d.ts +46 -0
  127. package/models/operations/languagegroupslist.d.ts.map +1 -0
  128. package/models/operations/languagegroupslist.js +103 -0
  129. package/models/operations/languagegroupslist.js.map +1 -0
  130. package/models/operations/sessionfullsummarygetbyid.d.ts +29 -0
  131. package/models/operations/sessionfullsummarygetbyid.d.ts.map +1 -0
  132. package/models/operations/sessionfullsummarygetbyid.js +68 -0
  133. package/models/operations/sessionfullsummarygetbyid.js.map +1 -0
  134. package/openapi.json +1160 -207
  135. package/package.json +1 -1
  136. package/sdk/fullsummary.d.ts +10 -0
  137. package/sdk/fullsummary.d.ts.map +1 -0
  138. package/sdk/fullsummary.js +19 -0
  139. package/sdk/fullsummary.js.map +1 -0
  140. package/sdk/languagegroups.d.ts +41 -0
  141. package/sdk/languagegroups.d.ts.map +1 -0
  142. package/sdk/languagegroups.js +62 -0
  143. package/sdk/languagegroups.js.map +1 -0
  144. package/sdk/sdk.d.ts +5 -2
  145. package/sdk/sdk.d.ts.map +1 -1
  146. package/sdk/sdk.js +7 -3
  147. package/sdk/sdk.js.map +1 -1
  148. package/sdk/sessions.d.ts +3 -0
  149. package/sdk/sessions.d.ts.map +1 -1
  150. package/sdk/sessions.js +4 -0
  151. package/sdk/sessions.js.map +1 -1
  152. package/sdk/v1.d.ts +0 -14
  153. package/sdk/v1.d.ts.map +1 -1
  154. package/sdk/v1.js +0 -20
  155. package/sdk/v1.js.map +1 -1
  156. package/src/funcs/languageGroupsCreate.ts +136 -0
  157. package/src/funcs/{v1Delete.ts → languageGroupsDelete.ts} +15 -11
  158. package/src/funcs/languageGroupsGetById.ts +146 -0
  159. package/src/funcs/languageGroupsList.ts +148 -0
  160. package/src/funcs/languageGroupsUpdate.ts +136 -0
  161. package/src/funcs/{v1GetById.ts → sessionsFullSummaryGetById.ts} +13 -13
  162. package/src/lib/config.ts +2 -2
  163. package/src/models/components/agentcreate.ts +11 -0
  164. package/src/models/components/agentlanguage.ts +80 -0
  165. package/src/models/components/agentresponse.ts +26 -0
  166. package/src/models/components/agentupdate.ts +11 -0
  167. package/src/models/components/agentvoice.ts +63 -12
  168. package/src/models/components/agentvoicedisplayname.ts +75 -0
  169. package/src/models/components/agentvoicegender.ts +39 -0
  170. package/src/models/components/agentvoicemodel.ts +43 -0
  171. package/src/models/components/agentvoicevarname.ts +10 -0
  172. package/src/models/components/index.ts +13 -1
  173. package/src/models/components/languagecode.ts +42 -0
  174. package/src/models/components/languageconfig.ts +122 -0
  175. package/src/models/components/languagegroupcreaterequest.ts +107 -0
  176. package/src/models/components/languagegroupproperties.ts +38 -0
  177. package/src/models/components/languagegroupresponse.ts +141 -0
  178. package/src/models/components/languagegroupupdaterequest.ts +123 -0
  179. package/src/models/components/listresponselanguagegroupresponse.ts +104 -0
  180. package/src/models/components/promptcreaterequest.ts +1 -1
  181. package/src/models/components/promptupdaterequest.ts +1 -1
  182. package/src/models/components/sessionrecordingresponse.ts +0 -7
  183. package/src/models/components/sessionsummaryresponse.ts +79 -0
  184. package/src/models/components/ttsprovider.ts +38 -0
  185. package/src/models/operations/index.ts +4 -0
  186. package/src/models/operations/languagegroupsdelete.ts +81 -0
  187. package/src/models/operations/languagegroupsgetbyid.ts +77 -0
  188. package/src/models/operations/languagegroupslist.ts +126 -0
  189. package/src/models/operations/sessionfullsummarygetbyid.ts +77 -0
  190. package/src/sdk/fullsummary.ts +25 -0
  191. package/src/sdk/languagegroups.ts +100 -0
  192. package/src/sdk/sdk.ts +11 -5
  193. package/src/sdk/sessions.ts +6 -0
  194. package/src/sdk/v1.ts +0 -36
  195. package/funcs/v1Delete.d.ts.map +0 -1
  196. package/funcs/v1Delete.js.map +0 -1
  197. package/funcs/v1GetById.d.ts.map +0 -1
  198. package/funcs/v1GetById.js.map +0 -1
  199. package/src/models/components/sttprovider.ts +0 -38
package/README.md CHANGED
@@ -203,6 +203,14 @@ run();
203
203
  * [update](docs/sdks/workflows/README.md#update) - Update Insights Workflow
204
204
  * [delete](docs/sdks/workflows/README.md#delete) - Delete Insights Workflow
205
205
 
206
+ ### [languageGroups](docs/sdks/languagegroups/README.md)
207
+
208
+ * [list](docs/sdks/languagegroups/README.md#list) - List Language Groups
209
+ * [create](docs/sdks/languagegroups/README.md#create) - Create Language Group
210
+ * [update](docs/sdks/languagegroups/README.md#update) - Update Language Group
211
+ * [getById](docs/sdks/languagegroups/README.md#getbyid) - Get Language Group
212
+ * [delete](docs/sdks/languagegroups/README.md#delete) - Delete Language Group
213
+
206
214
  ### [prompts](docs/sdks/prompts/README.md)
207
215
 
208
216
  * [list](docs/sdks/prompts/README.md#list) - Prompt List
@@ -233,6 +241,10 @@ run();
233
241
  * [generateSessionRecordingUrls](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
234
242
  * [sessionRecordingStream](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
235
243
 
244
+ #### [sessions.fullSummary](docs/sdks/fullsummary/README.md)
245
+
246
+ * [getById](docs/sdks/fullsummary/README.md#getbyid) - Get Full Session Summary By Id
247
+
236
248
  #### [sessions.summary](docs/sdks/summary/README.md)
237
249
 
238
250
  * [getById](docs/sdks/summary/README.md#getbyid) - Get Session Summary By Id
@@ -252,8 +264,6 @@ run();
252
264
 
253
265
  ### [v1](docs/sdks/v1/README.md)
254
266
 
255
- * [getById](docs/sdks/v1/README.md#getbyid) - Get Data Source
256
- * [delete](docs/sdks/v1/README.md#delete) - Delete Data Source
257
267
  * [postListDashboard](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
258
268
  * [postGetDashboard](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
259
269
  * [~~postSessionEventsDashboard~~](docs/sdks/v1/README.md#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
@@ -317,6 +327,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
317
327
  - [`insightsWorkflowsGetById`](docs/sdks/workflows/README.md#getbyid) - Get Insight Workflow By Id
318
328
  - [`insightsWorkflowsList`](docs/sdks/workflows/README.md#list) - Insight Workflow List
319
329
  - [`insightsWorkflowsUpdate`](docs/sdks/workflows/README.md#update) - Update Insights Workflow
330
+ - [`languageGroupsCreate`](docs/sdks/languagegroups/README.md#create) - Create Language Group
331
+ - [`languageGroupsDelete`](docs/sdks/languagegroups/README.md#delete) - Delete Language Group
332
+ - [`languageGroupsGetById`](docs/sdks/languagegroups/README.md#getbyid) - Get Language Group
333
+ - [`languageGroupsList`](docs/sdks/languagegroups/README.md#list) - List Language Groups
334
+ - [`languageGroupsUpdate`](docs/sdks/languagegroups/README.md#update) - Update Language Group
320
335
  - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create Prompt
321
336
  - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
322
337
  - [`promptsGetById`](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
@@ -331,6 +346,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
331
346
  - [`sessionLabelsCreate`](docs/sdks/sessionlabels/README.md#create) - Create Label
332
347
  - [`sessionLabelsGetById`](docs/sdks/sessionlabels/README.md#getbyid) - Get Label By Id
333
348
  - [`sessionLabelsList`](docs/sdks/sessionlabels/README.md#list) - Session Labels List
349
+ - [`sessionsFullSummaryGetById`](docs/sdks/fullsummary/README.md#getbyid) - Get Full Session Summary By Id
334
350
  - [`sessionsGenerateSessionRecordingUrls`](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
335
351
  - [`sessionsGetById`](docs/sdks/sessions/README.md#getbyid) - Get A Single Session By Id
336
352
  - [`sessionsList`](docs/sdks/sessions/README.md#list) - Sessions List
@@ -342,8 +358,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
342
358
  - [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
343
359
  - [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
344
360
  - [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
345
- - [`v1Delete`](docs/sdks/v1/README.md#delete) - Delete Data Source
346
- - [`v1GetById`](docs/sdks/v1/README.md#getbyid) - Get Data Source
347
361
  - [`v1PostGetDashboard`](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
348
362
  - [`v1PostListDashboard`](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
349
363
  - ~~[`dashboardsPostSessionEventsDashboard`](docs/sdks/dashboards/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
@@ -0,0 +1,85 @@
1
+ # FullSummary
2
+ (*sessions.fullSummary*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [getById](#getbyid) - Get Full Session Summary By Id
9
+
10
+ ## getById
11
+
12
+ Get Full Session Summary By Id
13
+
14
+ ### Example Usage
15
+
16
+ ```typescript
17
+ import { SyllableSDK } from "syllable-sdk";
18
+
19
+ const syllableSDK = new SyllableSDK({
20
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
21
+ });
22
+
23
+ async function run() {
24
+ const result = await syllableSDK.sessions.fullSummary.getById({
25
+ sessionId: "<id>",
26
+ });
27
+
28
+ // Handle the result
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 { sessionsFullSummaryGetById } from "syllable-sdk/funcs/sessionsFullSummaryGetById.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 sessionsFullSummaryGetById(syllableSDK, {
51
+ sessionId: "<id>",
52
+ });
53
+
54
+ if (!res.ok) {
55
+ throw res.error;
56
+ }
57
+
58
+ const { value: result } = res;
59
+
60
+ // Handle the result
61
+ console.log(result);
62
+ }
63
+
64
+ run();
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ | Parameter | Type | Required | Description |
70
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
71
+ | `request` | [operations.SessionFullSummaryGetByIdRequest](../../models/operations/sessionfullsummarygetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
72
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
73
+ | `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. |
74
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
75
+
76
+ ### Response
77
+
78
+ **Promise\<[components.SessionSummaryResponse](../../models/components/sessionsummaryresponse.md)\>**
79
+
80
+ ### Errors
81
+
82
+ | Error Type | Status Code | Content Type |
83
+ | -------------------------- | -------------------------- | -------------------------- |
84
+ | errors.HTTPValidationError | 422 | application/json |
85
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,465 @@
1
+ # LanguageGroups
2
+ (*languageGroups*)
3
+
4
+ ## Overview
5
+
6
+ Operations related to language groups. A language group is a collection of language, voice, and DTMF configuration that can be linked to an agent to define the languages and voices it supports.
7
+
8
+ ### Available Operations
9
+
10
+ * [list](#list) - List Language Groups
11
+ * [create](#create) - Create Language Group
12
+ * [update](#update) - Update Language Group
13
+ * [getById](#getbyid) - Get Language Group
14
+ * [delete](#delete) - Delete Language Group
15
+
16
+ ## list
17
+
18
+ Fetch language groups.
19
+
20
+ ### Example Usage
21
+
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.languageGroups.list({});
31
+
32
+ // Handle the result
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 { languageGroupsList } from "syllable-sdk/funcs/languageGroupsList.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 languageGroupsList(syllableSDK, {});
55
+
56
+ if (!res.ok) {
57
+ throw res.error;
58
+ }
59
+
60
+ const { value: result } = res;
61
+
62
+ // Handle the result
63
+ console.log(result);
64
+ }
65
+
66
+ run();
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Parameter | Type | Required | Description |
72
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
+ | `request` | [operations.LanguageGroupsListRequest](../../models/operations/languagegroupslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
74
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
75
+ | `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. |
76
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
77
+
78
+ ### Response
79
+
80
+ **Promise\<[components.ListResponseLanguageGroupResponse](../../models/components/listresponselanguagegroupresponse.md)\>**
81
+
82
+ ### Errors
83
+
84
+ | Error Type | Status Code | Content Type |
85
+ | -------------------------- | -------------------------- | -------------------------- |
86
+ | errors.HTTPValidationError | 422 | application/json |
87
+ | errors.SDKError | 4XX, 5XX | \*/\* |
88
+
89
+ ## create
90
+
91
+ Create a new language group.
92
+
93
+ ### Example Usage
94
+
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.languageGroups.create({
104
+ name: "Call Center 1 Languages",
105
+ description: "Languages spoken by operators at Call Center 1",
106
+ languageConfigs: [
107
+ {
108
+ languageCode: "es-US",
109
+ voiceProvider: "ElevenLabs",
110
+ voiceDisplayName: "Brian",
111
+ dtmfCode: 1,
112
+ },
113
+ ],
114
+ skipCurrentLanguageInMessage: true,
115
+ });
116
+
117
+ // Handle the result
118
+ console.log(result);
119
+ }
120
+
121
+ run();
122
+ ```
123
+
124
+ ### Standalone function
125
+
126
+ The standalone function version of this method:
127
+
128
+ ```typescript
129
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
130
+ import { languageGroupsCreate } from "syllable-sdk/funcs/languageGroupsCreate.js";
131
+
132
+ // Use `SyllableSDKCore` for best tree-shaking performance.
133
+ // You can create one instance of it to use across an application.
134
+ const syllableSDK = new SyllableSDKCore({
135
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
136
+ });
137
+
138
+ async function run() {
139
+ const res = await languageGroupsCreate(syllableSDK, {
140
+ name: "Call Center 1 Languages",
141
+ description: "Languages spoken by operators at Call Center 1",
142
+ languageConfigs: [
143
+ {
144
+ languageCode: "es-US",
145
+ voiceProvider: "ElevenLabs",
146
+ voiceDisplayName: "Brian",
147
+ dtmfCode: 1,
148
+ },
149
+ ],
150
+ skipCurrentLanguageInMessage: true,
151
+ });
152
+
153
+ if (!res.ok) {
154
+ throw res.error;
155
+ }
156
+
157
+ const { value: result } = res;
158
+
159
+ // Handle the result
160
+ console.log(result);
161
+ }
162
+
163
+ run();
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ | Parameter | Type | Required | Description |
169
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
170
+ | `request` | [components.LanguageGroupCreateRequest](../../models/components/languagegroupcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
171
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
172
+ | `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. |
173
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
174
+
175
+ ### Response
176
+
177
+ **Promise\<[components.LanguageGroupResponse](../../models/components/languagegroupresponse.md)\>**
178
+
179
+ ### Errors
180
+
181
+ | Error Type | Status Code | Content Type |
182
+ | -------------------------- | -------------------------- | -------------------------- |
183
+ | errors.HTTPValidationError | 422 | application/json |
184
+ | errors.SDKError | 4XX, 5XX | \*/\* |
185
+
186
+ ## update
187
+
188
+ Update an existing language group
189
+
190
+ ### Example Usage
191
+
192
+ ```typescript
193
+ import { SyllableSDK } from "syllable-sdk";
194
+
195
+ const syllableSDK = new SyllableSDK({
196
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
197
+ });
198
+
199
+ async function run() {
200
+ const result = await syllableSDK.languageGroups.update({
201
+ name: "Call Center 1 Languages",
202
+ description: "Languages spoken by operators at Call Center 1",
203
+ languageConfigs: [
204
+ {
205
+ languageCode: "es-US",
206
+ voiceProvider: "ElevenLabs",
207
+ voiceDisplayName: "Will",
208
+ dtmfCode: 1,
209
+ },
210
+ {
211
+ languageCode: "es-US",
212
+ voiceProvider: "ElevenLabs",
213
+ voiceDisplayName: "Will",
214
+ dtmfCode: 1,
215
+ },
216
+ {
217
+ languageCode: "yue-HK",
218
+ voiceProvider: "Google",
219
+ voiceDisplayName: "George",
220
+ dtmfCode: 1,
221
+ },
222
+ ],
223
+ skipCurrentLanguageInMessage: true,
224
+ id: 1,
225
+ editComments: "Added Spanish support.",
226
+ });
227
+
228
+ // Handle the result
229
+ console.log(result);
230
+ }
231
+
232
+ run();
233
+ ```
234
+
235
+ ### Standalone function
236
+
237
+ The standalone function version of this method:
238
+
239
+ ```typescript
240
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
241
+ import { languageGroupsUpdate } from "syllable-sdk/funcs/languageGroupsUpdate.js";
242
+
243
+ // Use `SyllableSDKCore` for best tree-shaking performance.
244
+ // You can create one instance of it to use across an application.
245
+ const syllableSDK = new SyllableSDKCore({
246
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
247
+ });
248
+
249
+ async function run() {
250
+ const res = await languageGroupsUpdate(syllableSDK, {
251
+ name: "Call Center 1 Languages",
252
+ description: "Languages spoken by operators at Call Center 1",
253
+ languageConfigs: [
254
+ {
255
+ languageCode: "es-US",
256
+ voiceProvider: "ElevenLabs",
257
+ voiceDisplayName: "Will",
258
+ dtmfCode: 1,
259
+ },
260
+ {
261
+ languageCode: "es-US",
262
+ voiceProvider: "ElevenLabs",
263
+ voiceDisplayName: "Will",
264
+ dtmfCode: 1,
265
+ },
266
+ {
267
+ languageCode: "yue-HK",
268
+ voiceProvider: "Google",
269
+ voiceDisplayName: "George",
270
+ dtmfCode: 1,
271
+ },
272
+ ],
273
+ skipCurrentLanguageInMessage: true,
274
+ id: 1,
275
+ editComments: "Added Spanish support.",
276
+ });
277
+
278
+ if (!res.ok) {
279
+ throw res.error;
280
+ }
281
+
282
+ const { value: result } = res;
283
+
284
+ // Handle the result
285
+ console.log(result);
286
+ }
287
+
288
+ run();
289
+ ```
290
+
291
+ ### Parameters
292
+
293
+ | Parameter | Type | Required | Description |
294
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
295
+ | `request` | [components.LanguageGroupUpdateRequest](../../models/components/languagegroupupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
296
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
297
+ | `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. |
298
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
299
+
300
+ ### Response
301
+
302
+ **Promise\<[components.LanguageGroupResponse](../../models/components/languagegroupresponse.md)\>**
303
+
304
+ ### Errors
305
+
306
+ | Error Type | Status Code | Content Type |
307
+ | -------------------------- | -------------------------- | -------------------------- |
308
+ | errors.HTTPValidationError | 422 | application/json |
309
+ | errors.SDKError | 4XX, 5XX | \*/\* |
310
+
311
+ ## getById
312
+
313
+ Fetch a given language group.
314
+
315
+ ### Example Usage
316
+
317
+ ```typescript
318
+ import { SyllableSDK } from "syllable-sdk";
319
+
320
+ const syllableSDK = new SyllableSDK({
321
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
322
+ });
323
+
324
+ async function run() {
325
+ const result = await syllableSDK.languageGroups.getById({
326
+ languageGroupId: 931598,
327
+ });
328
+
329
+ // Handle the result
330
+ console.log(result);
331
+ }
332
+
333
+ run();
334
+ ```
335
+
336
+ ### Standalone function
337
+
338
+ The standalone function version of this method:
339
+
340
+ ```typescript
341
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
342
+ import { languageGroupsGetById } from "syllable-sdk/funcs/languageGroupsGetById.js";
343
+
344
+ // Use `SyllableSDKCore` for best tree-shaking performance.
345
+ // You can create one instance of it to use across an application.
346
+ const syllableSDK = new SyllableSDKCore({
347
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
348
+ });
349
+
350
+ async function run() {
351
+ const res = await languageGroupsGetById(syllableSDK, {
352
+ languageGroupId: 931598,
353
+ });
354
+
355
+ if (!res.ok) {
356
+ throw res.error;
357
+ }
358
+
359
+ const { value: result } = res;
360
+
361
+ // Handle the result
362
+ console.log(result);
363
+ }
364
+
365
+ run();
366
+ ```
367
+
368
+ ### Parameters
369
+
370
+ | Parameter | Type | Required | Description |
371
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
372
+ | `request` | [operations.LanguageGroupsGetByIdRequest](../../models/operations/languagegroupsgetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
373
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
374
+ | `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. |
375
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
376
+
377
+ ### Response
378
+
379
+ **Promise\<[components.LanguageGroupResponse](../../models/components/languagegroupresponse.md)\>**
380
+
381
+ ### Errors
382
+
383
+ | Error Type | Status Code | Content Type |
384
+ | -------------------------- | -------------------------- | -------------------------- |
385
+ | errors.HTTPValidationError | 422 | application/json |
386
+ | errors.SDKError | 4XX, 5XX | \*/\* |
387
+
388
+ ## delete
389
+
390
+ Delete a language group.
391
+
392
+ ### Example Usage
393
+
394
+ ```typescript
395
+ import { SyllableSDK } from "syllable-sdk";
396
+
397
+ const syllableSDK = new SyllableSDK({
398
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
399
+ });
400
+
401
+ async function run() {
402
+ const result = await syllableSDK.languageGroups.delete({
403
+ languageGroupId: 545907,
404
+ reason: "<value>",
405
+ });
406
+
407
+ // Handle the result
408
+ console.log(result);
409
+ }
410
+
411
+ run();
412
+ ```
413
+
414
+ ### Standalone function
415
+
416
+ The standalone function version of this method:
417
+
418
+ ```typescript
419
+ import { SyllableSDKCore } from "syllable-sdk/core.js";
420
+ import { languageGroupsDelete } from "syllable-sdk/funcs/languageGroupsDelete.js";
421
+
422
+ // Use `SyllableSDKCore` for best tree-shaking performance.
423
+ // You can create one instance of it to use across an application.
424
+ const syllableSDK = new SyllableSDKCore({
425
+ apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
426
+ });
427
+
428
+ async function run() {
429
+ const res = await languageGroupsDelete(syllableSDK, {
430
+ languageGroupId: 545907,
431
+ reason: "<value>",
432
+ });
433
+
434
+ if (!res.ok) {
435
+ throw res.error;
436
+ }
437
+
438
+ const { value: result } = res;
439
+
440
+ // Handle the result
441
+ console.log(result);
442
+ }
443
+
444
+ run();
445
+ ```
446
+
447
+ ### Parameters
448
+
449
+ | Parameter | Type | Required | Description |
450
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
451
+ | `request` | [operations.LanguageGroupsDeleteRequest](../../models/operations/languagegroupsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
452
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
453
+ | `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. |
454
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
455
+
456
+ ### Response
457
+
458
+ **Promise\<[any](../../models/.md)\>**
459
+
460
+ ### Errors
461
+
462
+ | Error Type | Status Code | Content Type |
463
+ | -------------------------- | -------------------------- | -------------------------- |
464
+ | errors.HTTPValidationError | 422 | application/json |
465
+ | errors.SDKError | 4XX, 5XX | \*/\* |