syllable-sdk 1.0.4-rc.1 → 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 (206) hide show
  1. package/README.md +28 -13
  2. package/bin/mcp-server.js +1019 -13
  3. package/bin/mcp-server.js.map +45 -24
  4. package/docs/sdks/languagegroups/README.md +31 -19
  5. package/docs/sdks/voicegroups/README.md +551 -0
  6. package/examples/package-lock.json +1 -1
  7. package/funcs/languageGroupsCreate.d.ts +3 -1
  8. package/funcs/languageGroupsCreate.d.ts.map +1 -1
  9. package/funcs/languageGroupsCreate.js +3 -1
  10. package/funcs/languageGroupsCreate.js.map +1 -1
  11. package/funcs/languageGroupsDelete.d.ts +3 -1
  12. package/funcs/languageGroupsDelete.d.ts.map +1 -1
  13. package/funcs/languageGroupsDelete.js +3 -1
  14. package/funcs/languageGroupsDelete.js.map +1 -1
  15. package/funcs/languageGroupsGetById.d.ts +3 -1
  16. package/funcs/languageGroupsGetById.d.ts.map +1 -1
  17. package/funcs/languageGroupsGetById.js +3 -1
  18. package/funcs/languageGroupsGetById.js.map +1 -1
  19. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.d.ts +4 -2
  20. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.d.ts.map +1 -1
  21. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.js +4 -2
  22. package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.js.map +1 -1
  23. package/funcs/languageGroupsList.d.ts +3 -1
  24. package/funcs/languageGroupsList.d.ts.map +1 -1
  25. package/funcs/languageGroupsList.js +3 -1
  26. package/funcs/languageGroupsList.js.map +1 -1
  27. package/funcs/languageGroupsUpdate.d.ts +3 -1
  28. package/funcs/languageGroupsUpdate.d.ts.map +1 -1
  29. package/funcs/languageGroupsUpdate.js +3 -1
  30. package/funcs/languageGroupsUpdate.js.map +1 -1
  31. package/funcs/voiceGroupsCreate.d.ts +18 -0
  32. package/funcs/voiceGroupsCreate.d.ts.map +1 -0
  33. package/funcs/voiceGroupsCreate.js +118 -0
  34. package/funcs/voiceGroupsCreate.js.map +1 -0
  35. package/funcs/voiceGroupsDelete.d.ts +18 -0
  36. package/funcs/voiceGroupsDelete.d.ts.map +1 -0
  37. package/funcs/voiceGroupsDelete.js +128 -0
  38. package/funcs/voiceGroupsDelete.js.map +1 -0
  39. package/funcs/voiceGroupsGetById.d.ts +19 -0
  40. package/funcs/voiceGroupsGetById.d.ts.map +1 -0
  41. package/funcs/voiceGroupsGetById.js +124 -0
  42. package/funcs/voiceGroupsGetById.js.map +1 -0
  43. package/funcs/voiceGroupsList.d.ts +19 -0
  44. package/funcs/voiceGroupsList.d.ts.map +1 -0
  45. package/funcs/voiceGroupsList.js +130 -0
  46. package/funcs/voiceGroupsList.js.map +1 -0
  47. package/funcs/voiceGroupsUpdate.d.ts +18 -0
  48. package/funcs/voiceGroupsUpdate.d.ts.map +1 -0
  49. package/funcs/voiceGroupsUpdate.js +118 -0
  50. package/funcs/voiceGroupsUpdate.js.map +1 -0
  51. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts +18 -0
  52. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts.map +1 -0
  53. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js +119 -0
  54. package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js.map +1 -0
  55. package/jsr.json +1 -1
  56. package/lib/config.d.ts +2 -2
  57. package/lib/config.js +2 -2
  58. package/mcp-server/mcp-server.js +1 -1
  59. package/mcp-server/server.d.ts.map +1 -1
  60. package/mcp-server/server.js +13 -1
  61. package/mcp-server/server.js.map +1 -1
  62. package/mcp-server/tools/languageGroupsCreate.js +1 -1
  63. package/mcp-server/tools/languageGroupsCreate.js.map +1 -1
  64. package/mcp-server/tools/languageGroupsDelete.js +1 -1
  65. package/mcp-server/tools/languageGroupsDelete.js.map +1 -1
  66. package/mcp-server/tools/languageGroupsGetById.js +1 -1
  67. package/mcp-server/tools/languageGroupsGetById.js.map +1 -1
  68. package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.d.ts +1 -1
  69. package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.js +2 -2
  70. package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.js.map +1 -1
  71. package/mcp-server/tools/languageGroupsList.js +1 -1
  72. package/mcp-server/tools/languageGroupsList.js.map +1 -1
  73. package/mcp-server/tools/languageGroupsUpdate.js +1 -1
  74. package/mcp-server/tools/languageGroupsUpdate.js.map +1 -1
  75. package/mcp-server/tools/voiceGroupsCreate.d.ts +8 -0
  76. package/mcp-server/tools/voiceGroupsCreate.d.ts.map +1 -0
  77. package/mcp-server/tools/voiceGroupsCreate.js +64 -0
  78. package/mcp-server/tools/voiceGroupsCreate.js.map +1 -0
  79. package/mcp-server/tools/voiceGroupsDelete.d.ts +8 -0
  80. package/mcp-server/tools/voiceGroupsDelete.d.ts.map +1 -0
  81. package/mcp-server/tools/voiceGroupsDelete.js +64 -0
  82. package/mcp-server/tools/voiceGroupsDelete.js.map +1 -0
  83. package/mcp-server/tools/voiceGroupsGetById.d.ts +8 -0
  84. package/mcp-server/tools/voiceGroupsGetById.d.ts.map +1 -0
  85. package/mcp-server/tools/voiceGroupsGetById.js +64 -0
  86. package/mcp-server/tools/voiceGroupsGetById.js.map +1 -0
  87. package/mcp-server/tools/voiceGroupsList.d.ts +8 -0
  88. package/mcp-server/tools/voiceGroupsList.d.ts.map +1 -0
  89. package/mcp-server/tools/voiceGroupsList.js +64 -0
  90. package/mcp-server/tools/voiceGroupsList.js.map +1 -0
  91. package/mcp-server/tools/voiceGroupsUpdate.d.ts +8 -0
  92. package/mcp-server/tools/voiceGroupsUpdate.d.ts.map +1 -0
  93. package/mcp-server/tools/voiceGroupsUpdate.js +64 -0
  94. package/mcp-server/tools/voiceGroupsUpdate.js.map +1 -0
  95. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts +8 -0
  96. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts.map +1 -0
  97. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.js +64 -0
  98. package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.js.map +1 -0
  99. package/models/components/index.d.ts +6 -0
  100. package/models/components/index.d.ts.map +1 -1
  101. package/models/components/index.js +6 -0
  102. package/models/components/index.js.map +1 -1
  103. package/models/components/languagegroupcreaterequest.d.ts +1 -1
  104. package/models/components/languagegroupproperties.d.ts +2 -2
  105. package/models/components/languagegroupproperties.js +1 -1
  106. package/models/components/languagegroupresponse.d.ts +3 -3
  107. package/models/components/languagegroupupdaterequest.d.ts +1 -1
  108. package/models/components/languagesamplecreaterequest.d.ts +68 -0
  109. package/models/components/languagesamplecreaterequest.d.ts.map +1 -0
  110. package/models/components/languagesamplecreaterequest.js +103 -0
  111. package/models/components/languagesamplecreaterequest.js.map +1 -0
  112. package/models/components/listresponsevoicegroupresponse.d.ts +53 -0
  113. package/models/components/listresponsevoicegroupresponse.d.ts.map +1 -0
  114. package/models/components/listresponsevoicegroupresponse.js +91 -0
  115. package/models/components/listresponsevoicegroupresponse.js.map +1 -0
  116. package/models/components/voicegroupcreaterequest.d.ts +51 -0
  117. package/models/components/voicegroupcreaterequest.d.ts.map +1 -0
  118. package/models/components/voicegroupcreaterequest.js +87 -0
  119. package/models/components/voicegroupcreaterequest.js.map +1 -0
  120. package/models/components/voicegroupproperties.d.ts +43 -0
  121. package/models/components/voicegroupproperties.d.ts.map +1 -0
  122. package/models/components/voicegroupproperties.js +66 -0
  123. package/models/components/voicegroupproperties.js.map +1 -0
  124. package/models/components/voicegroupresponse.d.ts +82 -0
  125. package/models/components/voicegroupresponse.d.ts.map +1 -0
  126. package/models/components/voicegroupresponse.js +108 -0
  127. package/models/components/voicegroupresponse.js.map +1 -0
  128. package/models/components/voicegroupupdaterequest.d.ts +61 -0
  129. package/models/components/voicegroupupdaterequest.d.ts.map +1 -0
  130. package/models/components/voicegroupupdaterequest.js +93 -0
  131. package/models/components/voicegroupupdaterequest.js.map +1 -0
  132. package/models/operations/index.d.ts +3 -0
  133. package/models/operations/index.d.ts.map +1 -1
  134. package/models/operations/index.js +3 -0
  135. package/models/operations/index.js.map +1 -1
  136. package/models/operations/voicegroupsdelete.d.ts +31 -0
  137. package/models/operations/voicegroupsdelete.d.ts.map +1 -0
  138. package/models/operations/voicegroupsdelete.js +80 -0
  139. package/models/operations/voicegroupsdelete.js.map +1 -0
  140. package/models/operations/voicegroupsgetbyid.d.ts +29 -0
  141. package/models/operations/voicegroupsgetbyid.d.ts.map +1 -0
  142. package/models/operations/voicegroupsgetbyid.js +78 -0
  143. package/models/operations/voicegroupsgetbyid.js.map +1 -0
  144. package/models/operations/voicegroupslist.d.ts +73 -0
  145. package/models/operations/voicegroupslist.d.ts.map +1 -0
  146. package/models/operations/voicegroupslist.js +113 -0
  147. package/models/operations/voicegroupslist.js.map +1 -0
  148. package/openapi.json +1397 -490
  149. package/package.json +1 -1
  150. package/sdk/languagegroups.d.ts +19 -7
  151. package/sdk/languagegroups.d.ts.map +1 -1
  152. package/sdk/languagegroups.js +18 -6
  153. package/sdk/languagegroups.js.map +1 -1
  154. package/sdk/sdk.d.ts +3 -0
  155. package/sdk/sdk.d.ts.map +1 -1
  156. package/sdk/sdk.js +4 -0
  157. package/sdk/sdk.js.map +1 -1
  158. package/sdk/voicegroups.d.ts +48 -0
  159. package/sdk/voicegroups.d.ts.map +1 -0
  160. package/sdk/voicegroups.js +72 -0
  161. package/sdk/voicegroups.js.map +1 -0
  162. package/src/funcs/languageGroupsCreate.ts +3 -1
  163. package/src/funcs/languageGroupsDelete.ts +3 -1
  164. package/src/funcs/languageGroupsGetById.ts +3 -1
  165. package/src/funcs/languageGroupsLanguageGroupsCreateVoiceSample.ts +7 -4
  166. package/src/funcs/languageGroupsList.ts +3 -1
  167. package/src/funcs/languageGroupsUpdate.ts +3 -1
  168. package/src/funcs/voiceGroupsCreate.ts +169 -0
  169. package/src/funcs/voiceGroupsDelete.ts +181 -0
  170. package/src/funcs/voiceGroupsGetById.ts +176 -0
  171. package/src/funcs/voiceGroupsList.ts +182 -0
  172. package/src/funcs/voiceGroupsUpdate.ts +169 -0
  173. package/src/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.ts +170 -0
  174. package/src/lib/config.ts +2 -2
  175. package/src/mcp-server/mcp-server.ts +1 -1
  176. package/src/mcp-server/server.ts +13 -1
  177. package/src/mcp-server/tools/languageGroupsCreate.ts +1 -1
  178. package/src/mcp-server/tools/languageGroupsDelete.ts +1 -1
  179. package/src/mcp-server/tools/languageGroupsGetById.ts +1 -1
  180. package/src/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.ts +2 -2
  181. package/src/mcp-server/tools/languageGroupsList.ts +1 -1
  182. package/src/mcp-server/tools/languageGroupsUpdate.ts +1 -1
  183. package/src/mcp-server/tools/voiceGroupsCreate.ts +37 -0
  184. package/src/mcp-server/tools/voiceGroupsDelete.ts +37 -0
  185. package/src/mcp-server/tools/voiceGroupsGetById.ts +37 -0
  186. package/src/mcp-server/tools/voiceGroupsList.ts +37 -0
  187. package/src/mcp-server/tools/voiceGroupsUpdate.ts +37 -0
  188. package/src/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.ts +39 -0
  189. package/src/models/components/index.ts +6 -0
  190. package/src/models/components/languagegroupcreaterequest.ts +1 -1
  191. package/src/models/components/languagegroupproperties.ts +2 -2
  192. package/src/models/components/languagegroupresponse.ts +3 -3
  193. package/src/models/components/languagegroupupdaterequest.ts +1 -1
  194. package/src/models/components/languagesamplecreaterequest.ts +150 -0
  195. package/src/models/components/listresponsevoicegroupresponse.ts +118 -0
  196. package/src/models/components/voicegroupcreaterequest.ts +110 -0
  197. package/src/models/components/voicegroupproperties.ts +42 -0
  198. package/src/models/components/voicegroupresponse.ts +166 -0
  199. package/src/models/components/voicegroupupdaterequest.ts +126 -0
  200. package/src/models/operations/index.ts +3 -0
  201. package/src/models/operations/voicegroupsdelete.ts +79 -0
  202. package/src/models/operations/voicegroupsgetbyid.ts +75 -0
  203. package/src/models/operations/voicegroupslist.ts +153 -0
  204. package/src/sdk/languagegroups.ts +19 -7
  205. package/src/sdk/sdk.ts +6 -0
  206. package/src/sdk/voicegroups.ts +118 -0
package/openapi.json CHANGED
@@ -10755,8 +10755,9 @@
10755
10755
  "language_groups"
10756
10756
  ],
10757
10757
  "summary": "List Language Groups",
10758
- "description": "Fetch language groups.",
10758
+ "description": "Deprecated alias for `GET /api/v1/voice_groups/`.",
10759
10759
  "operationId": "language_groups_list",
10760
+ "deprecated": true,
10760
10761
  "security": [
10761
10762
  {
10762
10763
  "APIKeyHeader": []
@@ -10970,8 +10971,9 @@
10970
10971
  "language_groups"
10971
10972
  ],
10972
10973
  "summary": "Create Language Group",
10973
- "description": "Create a new language group.",
10974
+ "description": "Deprecated alias for `POST /api/v1/voice_groups/`.",
10974
10975
  "operationId": "language_groups_create",
10976
+ "deprecated": true,
10975
10977
  "security": [
10976
10978
  {
10977
10979
  "APIKeyHeader": []
@@ -11015,8 +11017,9 @@
11015
11017
  "language_groups"
11016
11018
  ],
11017
11019
  "summary": "Update Language Group",
11018
- "description": "Update an existing language group",
11020
+ "description": "Deprecated alias for `PUT /api/v1/voice_groups/`.",
11019
11021
  "operationId": "language_groups_update",
11022
+ "deprecated": true,
11020
11023
  "security": [
11021
11024
  {
11022
11025
  "APIKeyHeader": []
@@ -11062,8 +11065,9 @@
11062
11065
  "language_groups"
11063
11066
  ],
11064
11067
  "summary": "Get Language Group",
11065
- "description": "Fetch a given language group.",
11068
+ "description": "Deprecated alias for `GET /api/v1/voice_groups/{voice_group_id}`.",
11066
11069
  "operationId": "language_groups_get_by_id",
11070
+ "deprecated": true,
11067
11071
  "security": [
11068
11072
  {
11069
11073
  "APIKeyHeader": []
@@ -11108,8 +11112,9 @@
11108
11112
  "language_groups"
11109
11113
  ],
11110
11114
  "summary": "Delete Language Group",
11111
- "description": "Delete a language group.",
11115
+ "description": "Deprecated alias for `DELETE /api/v1/voice_groups/{voice_group_id}`.",
11112
11116
  "operationId": "language_groups_delete",
11117
+ "deprecated": true,
11113
11118
  "security": [
11114
11119
  {
11115
11120
  "APIKeyHeader": []
@@ -11163,13 +11168,13 @@
11163
11168
  "language_groups"
11164
11169
  ],
11165
11170
  "summary": "Create Voice Sample",
11166
- "description": "Generate voice sample.",
11171
+ "description": "Deprecated alias for `POST /api/v1/voice_groups/voices/sample`.",
11167
11172
  "operationId": "language_groups_create_voice_sample",
11168
11173
  "requestBody": {
11169
11174
  "content": {
11170
11175
  "application/json": {
11171
11176
  "schema": {
11172
- "$ref": "#/components/schemas/VoiceSampleCreateRequest"
11177
+ "$ref": "#/components/schemas/LanguageSampleCreateRequest"
11173
11178
  }
11174
11179
  }
11175
11180
  },
@@ -11199,6 +11204,7 @@
11199
11204
  }
11200
11205
  }
11201
11206
  },
11207
+ "deprecated": true,
11202
11208
  "security": [
11203
11209
  {
11204
11210
  "APIKeyHeader": []
@@ -11206,146 +11212,14 @@
11206
11212
  ]
11207
11213
  }
11208
11214
  },
11209
- "/api/v1/takeouts/create": {
11210
- "post": {
11211
- "tags": [
11212
- "takeouts"
11213
- ],
11214
- "summary": "Create Takeout",
11215
- "operationId": "takeouts_create",
11216
- "responses": {
11217
- "200": {
11218
- "description": "Successful Response",
11219
- "content": {
11220
- "application/json": {
11221
- "schema": {
11222
- "$ref": "#/components/schemas/CreateTakeoutResponse"
11223
- }
11224
- }
11225
- }
11226
- }
11227
- },
11228
- "security": [
11229
- {
11230
- "APIKeyHeader": []
11231
- }
11232
- ]
11233
- }
11234
- },
11235
- "/api/v1/takeouts/get/{job_id}": {
11236
- "get": {
11237
- "tags": [
11238
- "takeouts"
11239
- ],
11240
- "summary": "Get Takeout",
11241
- "operationId": "takeouts_get_by_job_id",
11242
- "security": [
11243
- {
11244
- "APIKeyHeader": []
11245
- }
11246
- ],
11247
- "parameters": [
11248
- {
11249
- "name": "job_id",
11250
- "in": "path",
11251
- "required": true,
11252
- "schema": {
11253
- "type": "string",
11254
- "title": "Job Id"
11255
- }
11256
- }
11257
- ],
11258
- "responses": {
11259
- "200": {
11260
- "description": "Successful Response",
11261
- "content": {
11262
- "application/json": {
11263
- "schema": {
11264
- "$ref": "#/components/schemas/TakeoutStatusResponse"
11265
- }
11266
- }
11267
- }
11268
- },
11269
- "422": {
11270
- "description": "Validation Error",
11271
- "content": {
11272
- "application/json": {
11273
- "schema": {
11274
- "$ref": "#/components/schemas/HTTPValidationError"
11275
- }
11276
- }
11277
- }
11278
- }
11279
- }
11280
- }
11281
- },
11282
- "/api/v1/takeouts/get/{job_id}/file/{file_name}": {
11283
- "get": {
11284
- "tags": [
11285
- "takeouts"
11286
- ],
11287
- "summary": "Get File",
11288
- "operationId": "takeouts_get_file",
11289
- "security": [
11290
- {
11291
- "APIKeyHeader": []
11292
- }
11293
- ],
11294
- "parameters": [
11295
- {
11296
- "name": "job_id",
11297
- "in": "path",
11298
- "required": true,
11299
- "schema": {
11300
- "type": "string",
11301
- "title": "Job Id"
11302
- }
11303
- },
11304
- {
11305
- "name": "file_name",
11306
- "in": "path",
11307
- "required": true,
11308
- "schema": {
11309
- "type": "string",
11310
- "title": "File Name"
11311
- }
11312
- }
11313
- ],
11314
- "responses": {
11315
- "200": {
11316
- "description": "File content",
11317
- "content": {
11318
- "application/zip": {
11319
- "schema": {
11320
- "type": "string",
11321
- "title": "bytes",
11322
- "format": "binary"
11323
- }
11324
- }
11325
- }
11326
- },
11327
- "422": {
11328
- "description": "Validation Error",
11329
- "content": {
11330
- "application/json": {
11331
- "schema": {
11332
- "$ref": "#/components/schemas/HTTPValidationError"
11333
- }
11334
- }
11335
- }
11336
- }
11337
- }
11338
- }
11339
- },
11340
- "/api/v1/users/": {
11215
+ "/api/v1/voice_groups/": {
11341
11216
  "get": {
11342
11217
  "tags": [
11343
- "users",
11344
- "V1"
11218
+ "voice_groups"
11345
11219
  ],
11346
- "summary": "List Users",
11347
- "description": "List the existing users.",
11348
- "operationId": "users_list",
11220
+ "summary": "List Voice Groups",
11221
+ "description": "Fetch voice groups.",
11222
+ "operationId": "voice_groups_list",
11349
11223
  "security": [
11350
11224
  {
11351
11225
  "APIKeyHeader": []
@@ -11398,7 +11272,7 @@
11398
11272
  "schema": {
11399
11273
  "type": "array",
11400
11274
  "items": {
11401
- "$ref": "#/components/schemas/UserProperties"
11275
+ "$ref": "#/components/schemas/VoiceGroupProperties"
11402
11276
  },
11403
11277
  "description": "String names of fields to search. Correspond by index to search field values",
11404
11278
  "examples": [
@@ -11434,7 +11308,7 @@
11434
11308
  "schema": {
11435
11309
  "anyOf": [
11436
11310
  {
11437
- "$ref": "#/components/schemas/UserProperties"
11311
+ "$ref": "#/components/schemas/VoiceGroupProperties"
11438
11312
  },
11439
11313
  {
11440
11314
  "type": "null"
@@ -11475,7 +11349,7 @@
11475
11349
  {
11476
11350
  "type": "array",
11477
11351
  "items": {
11478
- "$ref": "#/components/schemas/UserProperties"
11352
+ "$ref": "#/components/schemas/VoiceGroupProperties"
11479
11353
  }
11480
11354
  },
11481
11355
  {
@@ -11537,7 +11411,7 @@
11537
11411
  "content": {
11538
11412
  "application/json": {
11539
11413
  "schema": {
11540
- "$ref": "#/components/schemas/ListResponse_UserResponse_"
11414
+ "$ref": "#/components/schemas/ListResponse_VoiceGroupResponse_"
11541
11415
  }
11542
11416
  }
11543
11417
  }
@@ -11556,12 +11430,11 @@
11556
11430
  },
11557
11431
  "post": {
11558
11432
  "tags": [
11559
- "users",
11560
- "V1"
11433
+ "voice_groups"
11561
11434
  ],
11562
- "summary": "Create User",
11563
- "description": "Create a new user.",
11564
- "operationId": "users_create",
11435
+ "summary": "Create Voice Group",
11436
+ "description": "Create a new voice group.",
11437
+ "operationId": "voice_groups_create",
11565
11438
  "security": [
11566
11439
  {
11567
11440
  "APIKeyHeader": []
@@ -11572,7 +11445,7 @@
11572
11445
  "content": {
11573
11446
  "application/json": {
11574
11447
  "schema": {
11575
- "$ref": "#/components/schemas/UserCreateRequest"
11448
+ "$ref": "#/components/schemas/VoiceGroupCreateRequest"
11576
11449
  }
11577
11450
  }
11578
11451
  }
@@ -11583,7 +11456,7 @@
11583
11456
  "content": {
11584
11457
  "application/json": {
11585
11458
  "schema": {
11586
- "$ref": "#/components/schemas/UserResponse"
11459
+ "$ref": "#/components/schemas/VoiceGroupResponse"
11587
11460
  }
11588
11461
  }
11589
11462
  }
@@ -11602,12 +11475,11 @@
11602
11475
  },
11603
11476
  "put": {
11604
11477
  "tags": [
11605
- "users",
11606
- "V1"
11478
+ "voice_groups"
11607
11479
  ],
11608
- "summary": "Update User",
11609
- "description": "Update an existing user.",
11610
- "operationId": "users_update",
11480
+ "summary": "Update Voice Group",
11481
+ "description": "Update an existing voice group",
11482
+ "operationId": "voice_groups_update",
11611
11483
  "security": [
11612
11484
  {
11613
11485
  "APIKeyHeader": []
@@ -11618,7 +11490,7 @@
11618
11490
  "content": {
11619
11491
  "application/json": {
11620
11492
  "schema": {
11621
- "$ref": "#/components/schemas/UserUpdateRequest"
11493
+ "$ref": "#/components/schemas/VoiceGroupUpdateRequest"
11622
11494
  }
11623
11495
  }
11624
11496
  }
@@ -11629,54 +11501,10 @@
11629
11501
  "content": {
11630
11502
  "application/json": {
11631
11503
  "schema": {
11632
- "$ref": "#/components/schemas/UserResponse"
11633
- }
11634
- }
11635
- }
11636
- },
11637
- "422": {
11638
- "description": "Validation Error",
11639
- "content": {
11640
- "application/json": {
11641
- "schema": {
11642
- "$ref": "#/components/schemas/HTTPValidationError"
11504
+ "$ref": "#/components/schemas/VoiceGroupResponse"
11643
11505
  }
11644
11506
  }
11645
11507
  }
11646
- }
11647
- }
11648
- },
11649
- "delete": {
11650
- "tags": [
11651
- "users",
11652
- "V1"
11653
- ],
11654
- "summary": "Delete User",
11655
- "description": "Delete a user.",
11656
- "operationId": "users_delete",
11657
- "security": [
11658
- {
11659
- "APIKeyHeader": []
11660
- }
11661
- ],
11662
- "requestBody": {
11663
- "required": true,
11664
- "content": {
11665
- "application/json": {
11666
- "schema": {
11667
- "$ref": "#/components/schemas/UserDeleteRequest"
11668
- }
11669
- }
11670
- }
11671
- },
11672
- "responses": {
11673
- "200": {
11674
- "description": "Successful Response",
11675
- "content": {
11676
- "application/json": {
11677
- "schema": {}
11678
- }
11679
- }
11680
11508
  },
11681
11509
  "422": {
11682
11510
  "description": "Validation Error",
@@ -11691,15 +11519,14 @@
11691
11519
  }
11692
11520
  }
11693
11521
  },
11694
- "/api/v1/users/{user_email}": {
11522
+ "/api/v1/voice_groups/{voice_group_id}": {
11695
11523
  "get": {
11696
11524
  "tags": [
11697
- "users",
11698
- "V1"
11525
+ "voice_groups"
11699
11526
  ],
11700
- "summary": "Get User",
11701
- "description": "Fetch a given user.",
11702
- "operationId": "users_get_by_email",
11527
+ "summary": "Get Voice Group",
11528
+ "description": "Fetch a given voice group.",
11529
+ "operationId": "voice_groups_get_by_id",
11703
11530
  "security": [
11704
11531
  {
11705
11532
  "APIKeyHeader": []
@@ -11707,12 +11534,12 @@
11707
11534
  ],
11708
11535
  "parameters": [
11709
11536
  {
11710
- "name": "user_email",
11537
+ "name": "voice_group_id",
11711
11538
  "in": "path",
11712
11539
  "required": true,
11713
11540
  "schema": {
11714
- "type": "string",
11715
- "title": "User Email"
11541
+ "type": "integer",
11542
+ "title": "Voice Group Id"
11716
11543
  }
11717
11544
  }
11718
11545
  ],
@@ -11722,7 +11549,7 @@
11722
11549
  "content": {
11723
11550
  "application/json": {
11724
11551
  "schema": {
11725
- "$ref": "#/components/schemas/UserResponse"
11552
+ "$ref": "#/components/schemas/VoiceGroupResponse"
11726
11553
  }
11727
11554
  }
11728
11555
  }
@@ -11738,17 +11565,14 @@
11738
11565
  }
11739
11566
  }
11740
11567
  }
11741
- }
11742
- },
11743
- "/api/v1/users/{user_email}/send_email": {
11744
- "post": {
11568
+ },
11569
+ "delete": {
11745
11570
  "tags": [
11746
- "users",
11747
- "V1"
11571
+ "voice_groups"
11748
11572
  ],
11749
- "summary": "Send User Email",
11750
- "description": "Send a welcome email to a user.",
11751
- "operationId": "users_send_email",
11573
+ "summary": "Delete Voice Group",
11574
+ "description": "Delete a voice group.",
11575
+ "operationId": "voice_groups_delete",
11752
11576
  "security": [
11753
11577
  {
11754
11578
  "APIKeyHeader": []
@@ -11756,22 +11580,21 @@
11756
11580
  ],
11757
11581
  "parameters": [
11758
11582
  {
11759
- "name": "user_email",
11583
+ "name": "voice_group_id",
11760
11584
  "in": "path",
11761
11585
  "required": true,
11762
11586
  "schema": {
11763
- "type": "string",
11764
- "title": "User Email"
11587
+ "type": "integer",
11588
+ "title": "Voice Group Id"
11765
11589
  }
11766
11590
  },
11767
11591
  {
11768
- "name": "skip_auth",
11592
+ "name": "reason",
11769
11593
  "in": "query",
11770
- "required": false,
11594
+ "required": true,
11771
11595
  "schema": {
11772
- "type": "boolean",
11773
- "default": false,
11774
- "title": "Skip Auth"
11596
+ "type": "string",
11597
+ "title": "Reason"
11775
11598
  }
11776
11599
  }
11777
11600
  ],
@@ -11797,21 +11620,661 @@
11797
11620
  }
11798
11621
  }
11799
11622
  },
11800
- "/api/v1/users/delete_account": {
11801
- "delete": {
11623
+ "/api/v1/voice_groups/voices/sample": {
11624
+ "post": {
11802
11625
  "tags": [
11803
- "users",
11804
- "V1"
11626
+ "voice_groups"
11805
11627
  ],
11806
- "summary": "Request Removal Of This Account",
11807
- "description": "Request removal of the account of the user calling this endpoint. Intended for removing trial\naccounts.",
11808
- "operationId": "users_delete_account",
11809
- "responses": {
11810
- "200": {
11811
- "description": "Successful Response",
11812
- "content": {
11813
- "application/json": {
11814
- "schema": {}
11628
+ "summary": "Create Voice Sample",
11629
+ "description": "Generate voice sample.",
11630
+ "operationId": "voice_groups_create_voice_sample",
11631
+ "requestBody": {
11632
+ "content": {
11633
+ "application/json": {
11634
+ "schema": {
11635
+ "$ref": "#/components/schemas/VoiceSampleCreateRequest"
11636
+ }
11637
+ }
11638
+ },
11639
+ "required": true
11640
+ },
11641
+ "responses": {
11642
+ "200": {
11643
+ "description": "Successful Response",
11644
+ "content": {
11645
+ "application/octet-stream": {
11646
+ "schema": {
11647
+ "type": "string",
11648
+ "format": "binary",
11649
+ "title": "bytes"
11650
+ }
11651
+ }
11652
+ }
11653
+ },
11654
+ "422": {
11655
+ "description": "Validation Error",
11656
+ "content": {
11657
+ "application/json": {
11658
+ "schema": {
11659
+ "$ref": "#/components/schemas/HTTPValidationError"
11660
+ }
11661
+ }
11662
+ }
11663
+ }
11664
+ },
11665
+ "security": [
11666
+ {
11667
+ "APIKeyHeader": []
11668
+ }
11669
+ ]
11670
+ }
11671
+ },
11672
+ "/api/v1/takeouts/create": {
11673
+ "post": {
11674
+ "tags": [
11675
+ "takeouts"
11676
+ ],
11677
+ "summary": "Create Takeout",
11678
+ "operationId": "takeouts_create",
11679
+ "responses": {
11680
+ "200": {
11681
+ "description": "Successful Response",
11682
+ "content": {
11683
+ "application/json": {
11684
+ "schema": {
11685
+ "$ref": "#/components/schemas/CreateTakeoutResponse"
11686
+ }
11687
+ }
11688
+ }
11689
+ }
11690
+ },
11691
+ "security": [
11692
+ {
11693
+ "APIKeyHeader": []
11694
+ }
11695
+ ]
11696
+ }
11697
+ },
11698
+ "/api/v1/takeouts/get/{job_id}": {
11699
+ "get": {
11700
+ "tags": [
11701
+ "takeouts"
11702
+ ],
11703
+ "summary": "Get Takeout",
11704
+ "operationId": "takeouts_get_by_job_id",
11705
+ "security": [
11706
+ {
11707
+ "APIKeyHeader": []
11708
+ }
11709
+ ],
11710
+ "parameters": [
11711
+ {
11712
+ "name": "job_id",
11713
+ "in": "path",
11714
+ "required": true,
11715
+ "schema": {
11716
+ "type": "string",
11717
+ "title": "Job Id"
11718
+ }
11719
+ }
11720
+ ],
11721
+ "responses": {
11722
+ "200": {
11723
+ "description": "Successful Response",
11724
+ "content": {
11725
+ "application/json": {
11726
+ "schema": {
11727
+ "$ref": "#/components/schemas/TakeoutStatusResponse"
11728
+ }
11729
+ }
11730
+ }
11731
+ },
11732
+ "422": {
11733
+ "description": "Validation Error",
11734
+ "content": {
11735
+ "application/json": {
11736
+ "schema": {
11737
+ "$ref": "#/components/schemas/HTTPValidationError"
11738
+ }
11739
+ }
11740
+ }
11741
+ }
11742
+ }
11743
+ }
11744
+ },
11745
+ "/api/v1/takeouts/get/{job_id}/file/{file_name}": {
11746
+ "get": {
11747
+ "tags": [
11748
+ "takeouts"
11749
+ ],
11750
+ "summary": "Get File",
11751
+ "operationId": "takeouts_get_file",
11752
+ "security": [
11753
+ {
11754
+ "APIKeyHeader": []
11755
+ }
11756
+ ],
11757
+ "parameters": [
11758
+ {
11759
+ "name": "job_id",
11760
+ "in": "path",
11761
+ "required": true,
11762
+ "schema": {
11763
+ "type": "string",
11764
+ "title": "Job Id"
11765
+ }
11766
+ },
11767
+ {
11768
+ "name": "file_name",
11769
+ "in": "path",
11770
+ "required": true,
11771
+ "schema": {
11772
+ "type": "string",
11773
+ "title": "File Name"
11774
+ }
11775
+ }
11776
+ ],
11777
+ "responses": {
11778
+ "200": {
11779
+ "description": "File content",
11780
+ "content": {
11781
+ "application/zip": {
11782
+ "schema": {
11783
+ "type": "string",
11784
+ "title": "bytes",
11785
+ "format": "binary"
11786
+ }
11787
+ }
11788
+ }
11789
+ },
11790
+ "422": {
11791
+ "description": "Validation Error",
11792
+ "content": {
11793
+ "application/json": {
11794
+ "schema": {
11795
+ "$ref": "#/components/schemas/HTTPValidationError"
11796
+ }
11797
+ }
11798
+ }
11799
+ }
11800
+ }
11801
+ }
11802
+ },
11803
+ "/api/v1/users/": {
11804
+ "get": {
11805
+ "tags": [
11806
+ "users",
11807
+ "V1"
11808
+ ],
11809
+ "summary": "List Users",
11810
+ "description": "List the existing users.",
11811
+ "operationId": "users_list",
11812
+ "security": [
11813
+ {
11814
+ "APIKeyHeader": []
11815
+ }
11816
+ ],
11817
+ "parameters": [
11818
+ {
11819
+ "name": "page",
11820
+ "in": "query",
11821
+ "required": false,
11822
+ "schema": {
11823
+ "anyOf": [
11824
+ {
11825
+ "type": "integer",
11826
+ "minimum": 0
11827
+ },
11828
+ {
11829
+ "type": "null"
11830
+ }
11831
+ ],
11832
+ "description": "The page number from which to start (0-based)",
11833
+ "examples": [
11834
+ 0
11835
+ ],
11836
+ "default": 0,
11837
+ "title": "Page"
11838
+ },
11839
+ "description": "The page number from which to start (0-based)"
11840
+ },
11841
+ {
11842
+ "name": "limit",
11843
+ "in": "query",
11844
+ "required": false,
11845
+ "schema": {
11846
+ "type": "integer",
11847
+ "minimum": 0,
11848
+ "description": "The maximum number of items to return",
11849
+ "examples": [
11850
+ 25
11851
+ ],
11852
+ "default": 25,
11853
+ "title": "Limit"
11854
+ },
11855
+ "description": "The maximum number of items to return"
11856
+ },
11857
+ {
11858
+ "name": "search_fields",
11859
+ "in": "query",
11860
+ "required": false,
11861
+ "schema": {
11862
+ "type": "array",
11863
+ "items": {
11864
+ "$ref": "#/components/schemas/UserProperties"
11865
+ },
11866
+ "description": "String names of fields to search. Correspond by index to search field values",
11867
+ "examples": [
11868
+ "name"
11869
+ ],
11870
+ "default": [],
11871
+ "title": "Search Fields"
11872
+ },
11873
+ "description": "String names of fields to search. Correspond by index to search field values"
11874
+ },
11875
+ {
11876
+ "name": "search_field_values",
11877
+ "in": "query",
11878
+ "required": false,
11879
+ "schema": {
11880
+ "type": "array",
11881
+ "items": {
11882
+ "type": "string"
11883
+ },
11884
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
11885
+ "examples": [
11886
+ "Some Object Name"
11887
+ ],
11888
+ "default": [],
11889
+ "title": "Search Field Values"
11890
+ },
11891
+ "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
11892
+ },
11893
+ {
11894
+ "name": "order_by",
11895
+ "in": "query",
11896
+ "required": false,
11897
+ "schema": {
11898
+ "anyOf": [
11899
+ {
11900
+ "$ref": "#/components/schemas/UserProperties"
11901
+ },
11902
+ {
11903
+ "type": "null"
11904
+ }
11905
+ ],
11906
+ "description": "The field whose value should be used to order the results",
11907
+ "examples": [
11908
+ "name"
11909
+ ],
11910
+ "title": "Order By"
11911
+ },
11912
+ "description": "The field whose value should be used to order the results"
11913
+ },
11914
+ {
11915
+ "name": "order_by_direction",
11916
+ "in": "query",
11917
+ "required": false,
11918
+ "schema": {
11919
+ "anyOf": [
11920
+ {
11921
+ "$ref": "#/components/schemas/OrderByDirection"
11922
+ },
11923
+ {
11924
+ "type": "null"
11925
+ }
11926
+ ],
11927
+ "description": "The direction in which to order the results",
11928
+ "title": "Order By Direction"
11929
+ },
11930
+ "description": "The direction in which to order the results"
11931
+ },
11932
+ {
11933
+ "name": "fields",
11934
+ "in": "query",
11935
+ "required": false,
11936
+ "schema": {
11937
+ "anyOf": [
11938
+ {
11939
+ "type": "array",
11940
+ "items": {
11941
+ "$ref": "#/components/schemas/UserProperties"
11942
+ }
11943
+ },
11944
+ {
11945
+ "type": "null"
11946
+ }
11947
+ ],
11948
+ "description": "The fields to include in the response",
11949
+ "default": [],
11950
+ "title": "Fields"
11951
+ },
11952
+ "description": "The fields to include in the response"
11953
+ },
11954
+ {
11955
+ "name": "start_datetime",
11956
+ "in": "query",
11957
+ "required": false,
11958
+ "schema": {
11959
+ "anyOf": [
11960
+ {
11961
+ "type": "string"
11962
+ },
11963
+ {
11964
+ "type": "null"
11965
+ }
11966
+ ],
11967
+ "description": "The start datetime for filtering results",
11968
+ "examples": [
11969
+ "2023-01-01T00:00:00Z"
11970
+ ],
11971
+ "title": "Start Datetime"
11972
+ },
11973
+ "description": "The start datetime for filtering results"
11974
+ },
11975
+ {
11976
+ "name": "end_datetime",
11977
+ "in": "query",
11978
+ "required": false,
11979
+ "schema": {
11980
+ "anyOf": [
11981
+ {
11982
+ "type": "string"
11983
+ },
11984
+ {
11985
+ "type": "null"
11986
+ }
11987
+ ],
11988
+ "description": "The end datetime for filtering results",
11989
+ "examples": [
11990
+ "2024-01-01T00:00:00Z"
11991
+ ],
11992
+ "title": "End Datetime"
11993
+ },
11994
+ "description": "The end datetime for filtering results"
11995
+ }
11996
+ ],
11997
+ "responses": {
11998
+ "200": {
11999
+ "description": "Successful Response",
12000
+ "content": {
12001
+ "application/json": {
12002
+ "schema": {
12003
+ "$ref": "#/components/schemas/ListResponse_UserResponse_"
12004
+ }
12005
+ }
12006
+ }
12007
+ },
12008
+ "422": {
12009
+ "description": "Validation Error",
12010
+ "content": {
12011
+ "application/json": {
12012
+ "schema": {
12013
+ "$ref": "#/components/schemas/HTTPValidationError"
12014
+ }
12015
+ }
12016
+ }
12017
+ }
12018
+ }
12019
+ },
12020
+ "post": {
12021
+ "tags": [
12022
+ "users",
12023
+ "V1"
12024
+ ],
12025
+ "summary": "Create User",
12026
+ "description": "Create a new user.",
12027
+ "operationId": "users_create",
12028
+ "security": [
12029
+ {
12030
+ "APIKeyHeader": []
12031
+ }
12032
+ ],
12033
+ "requestBody": {
12034
+ "required": true,
12035
+ "content": {
12036
+ "application/json": {
12037
+ "schema": {
12038
+ "$ref": "#/components/schemas/UserCreateRequest"
12039
+ }
12040
+ }
12041
+ }
12042
+ },
12043
+ "responses": {
12044
+ "200": {
12045
+ "description": "Successful Response",
12046
+ "content": {
12047
+ "application/json": {
12048
+ "schema": {
12049
+ "$ref": "#/components/schemas/UserResponse"
12050
+ }
12051
+ }
12052
+ }
12053
+ },
12054
+ "422": {
12055
+ "description": "Validation Error",
12056
+ "content": {
12057
+ "application/json": {
12058
+ "schema": {
12059
+ "$ref": "#/components/schemas/HTTPValidationError"
12060
+ }
12061
+ }
12062
+ }
12063
+ }
12064
+ }
12065
+ },
12066
+ "put": {
12067
+ "tags": [
12068
+ "users",
12069
+ "V1"
12070
+ ],
12071
+ "summary": "Update User",
12072
+ "description": "Update an existing user.",
12073
+ "operationId": "users_update",
12074
+ "security": [
12075
+ {
12076
+ "APIKeyHeader": []
12077
+ }
12078
+ ],
12079
+ "requestBody": {
12080
+ "required": true,
12081
+ "content": {
12082
+ "application/json": {
12083
+ "schema": {
12084
+ "$ref": "#/components/schemas/UserUpdateRequest"
12085
+ }
12086
+ }
12087
+ }
12088
+ },
12089
+ "responses": {
12090
+ "200": {
12091
+ "description": "Successful Response",
12092
+ "content": {
12093
+ "application/json": {
12094
+ "schema": {
12095
+ "$ref": "#/components/schemas/UserResponse"
12096
+ }
12097
+ }
12098
+ }
12099
+ },
12100
+ "422": {
12101
+ "description": "Validation Error",
12102
+ "content": {
12103
+ "application/json": {
12104
+ "schema": {
12105
+ "$ref": "#/components/schemas/HTTPValidationError"
12106
+ }
12107
+ }
12108
+ }
12109
+ }
12110
+ }
12111
+ },
12112
+ "delete": {
12113
+ "tags": [
12114
+ "users",
12115
+ "V1"
12116
+ ],
12117
+ "summary": "Delete User",
12118
+ "description": "Delete a user.",
12119
+ "operationId": "users_delete",
12120
+ "security": [
12121
+ {
12122
+ "APIKeyHeader": []
12123
+ }
12124
+ ],
12125
+ "requestBody": {
12126
+ "required": true,
12127
+ "content": {
12128
+ "application/json": {
12129
+ "schema": {
12130
+ "$ref": "#/components/schemas/UserDeleteRequest"
12131
+ }
12132
+ }
12133
+ }
12134
+ },
12135
+ "responses": {
12136
+ "200": {
12137
+ "description": "Successful Response",
12138
+ "content": {
12139
+ "application/json": {
12140
+ "schema": {}
12141
+ }
12142
+ }
12143
+ },
12144
+ "422": {
12145
+ "description": "Validation Error",
12146
+ "content": {
12147
+ "application/json": {
12148
+ "schema": {
12149
+ "$ref": "#/components/schemas/HTTPValidationError"
12150
+ }
12151
+ }
12152
+ }
12153
+ }
12154
+ }
12155
+ }
12156
+ },
12157
+ "/api/v1/users/{user_email}": {
12158
+ "get": {
12159
+ "tags": [
12160
+ "users",
12161
+ "V1"
12162
+ ],
12163
+ "summary": "Get User",
12164
+ "description": "Fetch a given user.",
12165
+ "operationId": "users_get_by_email",
12166
+ "security": [
12167
+ {
12168
+ "APIKeyHeader": []
12169
+ }
12170
+ ],
12171
+ "parameters": [
12172
+ {
12173
+ "name": "user_email",
12174
+ "in": "path",
12175
+ "required": true,
12176
+ "schema": {
12177
+ "type": "string",
12178
+ "title": "User Email"
12179
+ }
12180
+ }
12181
+ ],
12182
+ "responses": {
12183
+ "200": {
12184
+ "description": "Successful Response",
12185
+ "content": {
12186
+ "application/json": {
12187
+ "schema": {
12188
+ "$ref": "#/components/schemas/UserResponse"
12189
+ }
12190
+ }
12191
+ }
12192
+ },
12193
+ "422": {
12194
+ "description": "Validation Error",
12195
+ "content": {
12196
+ "application/json": {
12197
+ "schema": {
12198
+ "$ref": "#/components/schemas/HTTPValidationError"
12199
+ }
12200
+ }
12201
+ }
12202
+ }
12203
+ }
12204
+ }
12205
+ },
12206
+ "/api/v1/users/{user_email}/send_email": {
12207
+ "post": {
12208
+ "tags": [
12209
+ "users",
12210
+ "V1"
12211
+ ],
12212
+ "summary": "Send User Email",
12213
+ "description": "Send a welcome email to a user.",
12214
+ "operationId": "users_send_email",
12215
+ "security": [
12216
+ {
12217
+ "APIKeyHeader": []
12218
+ }
12219
+ ],
12220
+ "parameters": [
12221
+ {
12222
+ "name": "user_email",
12223
+ "in": "path",
12224
+ "required": true,
12225
+ "schema": {
12226
+ "type": "string",
12227
+ "title": "User Email"
12228
+ }
12229
+ },
12230
+ {
12231
+ "name": "skip_auth",
12232
+ "in": "query",
12233
+ "required": false,
12234
+ "schema": {
12235
+ "type": "boolean",
12236
+ "default": false,
12237
+ "title": "Skip Auth"
12238
+ }
12239
+ }
12240
+ ],
12241
+ "responses": {
12242
+ "200": {
12243
+ "description": "Successful Response",
12244
+ "content": {
12245
+ "application/json": {
12246
+ "schema": {}
12247
+ }
12248
+ }
12249
+ },
12250
+ "422": {
12251
+ "description": "Validation Error",
12252
+ "content": {
12253
+ "application/json": {
12254
+ "schema": {
12255
+ "$ref": "#/components/schemas/HTTPValidationError"
12256
+ }
12257
+ }
12258
+ }
12259
+ }
12260
+ }
12261
+ }
12262
+ },
12263
+ "/api/v1/users/delete_account": {
12264
+ "delete": {
12265
+ "tags": [
12266
+ "users",
12267
+ "V1"
12268
+ ],
12269
+ "summary": "Request Removal Of This Account",
12270
+ "description": "Request removal of the account of the user calling this endpoint. Intended for removing trial\naccounts.",
12271
+ "operationId": "users_delete_account",
12272
+ "responses": {
12273
+ "200": {
12274
+ "description": "Successful Response",
12275
+ "content": {
12276
+ "application/json": {
12277
+ "schema": {}
11815
12278
  }
11816
12279
  }
11817
12280
  }
@@ -18501,7 +18964,7 @@
18501
18964
  "skip_current_language_in_message"
18502
18965
  ],
18503
18966
  "title": "LanguageGroupCreateRequest",
18504
- "description": "Request model to create a language group."
18967
+ "description": "Request model to create a voice group."
18505
18968
  },
18506
18969
  "LanguageGroupProperties": {
18507
18970
  "type": "string",
@@ -18513,7 +18976,7 @@
18513
18976
  "last_updated_by"
18514
18977
  ],
18515
18978
  "title": "LanguageGroupProperties",
18516
- "description": "Names of language group fields supported for filtering/sorting on list endpoint."
18979
+ "description": "Deprecated enum mirroring `VoiceGroupProperties` values."
18517
18980
  },
18518
18981
  "LanguageGroupResponse": {
18519
18982
  "properties": {
@@ -18646,7 +19109,7 @@
18646
19109
  "last_updated_by"
18647
19110
  ],
18648
19111
  "title": "LanguageGroupResponse",
18649
- "description": "Response model for language group operations.\nA language group is a collection of language, voice, and DTMF configuration that can be\nlinked to an agent to define the languages and voices it supports. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/LanguageGroups)."
19112
+ "description": "Response model for voice group operations.\nA voice group is a collection of language, voice, and DTMF configuration that can be\nlinked to an agent to define the languages and voices it supports. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/VoiceGroups)."
18650
19113
  },
18651
19114
  "LanguageGroupUpdateRequest": {
18652
19115
  "properties": {
@@ -18737,7 +19200,82 @@
18737
19200
  "id"
18738
19201
  ],
18739
19202
  "title": "LanguageGroupUpdateRequest",
18740
- "description": "Request model to update an existing language group."
19203
+ "description": "Request model to update an existing voice group."
19204
+ },
19205
+ "LanguageSampleCreateRequest": {
19206
+ "properties": {
19207
+ "language_code": {
19208
+ "$ref": "#/components/schemas/LanguageCode",
19209
+ "description": "BCP 47 code of the language",
19210
+ "examples": [
19211
+ "en-US"
19212
+ ]
19213
+ },
19214
+ "voice_provider": {
19215
+ "$ref": "#/components/schemas/TtsProvider",
19216
+ "description": "TTS provider of the voice to use for the language",
19217
+ "examples": [
19218
+ "OpenAI"
19219
+ ]
19220
+ },
19221
+ "voice_display_name": {
19222
+ "$ref": "#/components/schemas/AgentVoiceDisplayName",
19223
+ "description": "Display name of the voice to use for the language",
19224
+ "examples": [
19225
+ "Alloy"
19226
+ ]
19227
+ },
19228
+ "voice_speed": {
19229
+ "anyOf": [
19230
+ {
19231
+ "type": "number"
19232
+ },
19233
+ {
19234
+ "type": "null"
19235
+ }
19236
+ ],
19237
+ "title": "Voice Speed",
19238
+ "description": "Speed of the voice in the range of 0.25 to 4.0 (OpenAI and Google) or 0.7 to 1.2 (ElevenLabs). Standard speed is 1.0.",
19239
+ "examples": [
19240
+ 1.0
19241
+ ]
19242
+ },
19243
+ "voice_pitch": {
19244
+ "anyOf": [
19245
+ {
19246
+ "type": "number"
19247
+ },
19248
+ {
19249
+ "type": "null"
19250
+ }
19251
+ ],
19252
+ "title": "Voice Pitch",
19253
+ "description": "Pitch of the voice in the range of -20.0 to 20.0. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. 0 means use the original pitch. Only supported for Google configs.",
19254
+ "examples": [
19255
+ 0.0
19256
+ ]
19257
+ },
19258
+ "text": {
19259
+ "type": "string",
19260
+ "title": "Text",
19261
+ "description": "Text to generate for this voice.",
19262
+ "default": ""
19263
+ },
19264
+ "apply_pronunciation_overrides": {
19265
+ "type": "boolean",
19266
+ "title": "Apply Pronunciation Overrides",
19267
+ "description": "Apply TTS pronunciation fixes.",
19268
+ "default": false
19269
+ }
19270
+ },
19271
+ "type": "object",
19272
+ "required": [
19273
+ "language_code",
19274
+ "voice_provider",
19275
+ "voice_display_name"
19276
+ ],
19277
+ "title": "LanguageSampleCreateRequest",
19278
+ "description": "Request model to generate a sample audio file for a given voice and language."
18741
19279
  },
18742
19280
  "LatencyCategory": {
18743
19281
  "type": "string",
@@ -20274,13 +20812,79 @@
20274
20812
  "page",
20275
20813
  "page_size"
20276
20814
  ],
20277
- "title": "ListResponse[ServiceResponse]"
20815
+ "title": "ListResponse[ServiceResponse]"
20816
+ },
20817
+ "ListResponse_SessionLabel_": {
20818
+ "properties": {
20819
+ "items": {
20820
+ "items": {
20821
+ "$ref": "#/components/schemas/SessionLabel"
20822
+ },
20823
+ "type": "array",
20824
+ "title": "Items",
20825
+ "description": "List of items returned from the query",
20826
+ "examples": []
20827
+ },
20828
+ "page": {
20829
+ "type": "integer",
20830
+ "title": "Page",
20831
+ "description": "The page number of the results (0-based)",
20832
+ "examples": [
20833
+ 0
20834
+ ]
20835
+ },
20836
+ "page_size": {
20837
+ "type": "integer",
20838
+ "title": "Page Size",
20839
+ "description": "The number of items returned per page",
20840
+ "examples": [
20841
+ 25
20842
+ ]
20843
+ },
20844
+ "total_pages": {
20845
+ "anyOf": [
20846
+ {
20847
+ "type": "integer"
20848
+ },
20849
+ {
20850
+ "type": "null"
20851
+ }
20852
+ ],
20853
+ "title": "Total Pages",
20854
+ "description": "The total number of pages of results given the indicated page size",
20855
+ "examples": [
20856
+ 4
20857
+ ]
20858
+ },
20859
+ "total_count": {
20860
+ "anyOf": [
20861
+ {
20862
+ "type": "integer"
20863
+ },
20864
+ {
20865
+ "type": "null"
20866
+ }
20867
+ ],
20868
+ "title": "Total Count",
20869
+ "description": "The total number of items returned from the query",
20870
+ "examples": [
20871
+ 100
20872
+ ]
20873
+ }
20874
+ },
20875
+ "type": "object",
20876
+ "required": [
20877
+ "items",
20878
+ "page",
20879
+ "page_size"
20880
+ ],
20881
+ "title": "ListResponse[SessionLabel]"
20278
20882
  },
20279
- "ListResponse_SessionLabel_": {
20883
+ "ListResponse_Session_": {
20280
20884
  "properties": {
20281
20885
  "items": {
20282
20886
  "items": {
20283
- "$ref": "#/components/schemas/SessionLabel"
20887
+ "$ref": "#/components/schemas/Session"
20284
20888
  },
20285
20889
  "type": "array",
20286
20890
  "title": "Items",
@@ -20340,13 +20944,13 @@
20340
20944
  "page",
20341
20945
  "page_size"
20342
20946
  ],
20343
- "title": "ListResponse[SessionLabel]"
20947
+ "title": "ListResponse[Session]"
20344
20948
  },
20345
- "ListResponse_Session_": {
20949
+ "ListResponse_ToolResponse_": {
20346
20950
  "properties": {
20347
20951
  "items": {
20348
20952
  "items": {
20349
- "$ref": "#/components/schemas/Session"
20953
+ "$ref": "#/components/schemas/ToolResponse"
20350
20954
  },
20351
20955
  "type": "array",
20352
20956
  "title": "Items",
@@ -20406,13 +21010,13 @@
20406
21010
  "page",
20407
21011
  "page_size"
20408
21012
  ],
20409
- "title": "ListResponse[Session]"
21013
+ "title": "ListResponse[ToolResponse]"
20410
21014
  },
20411
- "ListResponse_ToolResponse_": {
21015
+ "ListResponse_UserResponse_": {
20412
21016
  "properties": {
20413
21017
  "items": {
20414
21018
  "items": {
20415
- "$ref": "#/components/schemas/ToolResponse"
21019
+ "$ref": "#/components/schemas/UserResponse"
20416
21020
  },
20417
21021
  "type": "array",
20418
21022
  "title": "Items",
@@ -20472,13 +21076,13 @@
20472
21076
  "page",
20473
21077
  "page_size"
20474
21078
  ],
20475
- "title": "ListResponse[ToolResponse]"
21079
+ "title": "ListResponse[UserResponse]"
20476
21080
  },
20477
- "ListResponse_UserResponse_": {
21081
+ "ListResponse_VoiceGroupResponse_": {
20478
21082
  "properties": {
20479
21083
  "items": {
20480
21084
  "items": {
20481
- "$ref": "#/components/schemas/UserResponse"
21085
+ "$ref": "#/components/schemas/VoiceGroupResponse"
20482
21086
  },
20483
21087
  "type": "array",
20484
21088
  "title": "Items",
@@ -20538,7 +21142,7 @@
20538
21142
  "page",
20539
21143
  "page_size"
20540
21144
  ],
20541
- "title": "ListResponse[UserResponse]"
21145
+ "title": "ListResponse[VoiceGroupResponse]"
20542
21146
  },
20543
21147
  "LoginType": {
20544
21148
  "type": "string",
@@ -25424,41 +26028,305 @@
25424
26028
  "title": "Sid",
25425
26029
  "description": "The unique identifier for the phone number."
25426
26030
  },
25427
- "phone_number": {
25428
- "type": "string",
25429
- "title": "Phone Number",
25430
- "description": "The phone number."
26031
+ "phone_number": {
26032
+ "type": "string",
26033
+ "title": "Phone Number",
26034
+ "description": "The phone number."
26035
+ },
26036
+ "friendly_name": {
26037
+ "type": "string",
26038
+ "title": "Friendly Name",
26039
+ "description": "A user-friendly name for the number."
26040
+ },
26041
+ "trunk_sid": {
26042
+ "type": "string",
26043
+ "title": "Trunk Sid",
26044
+ "description": "Associated trunk SID, if any."
26045
+ }
26046
+ },
26047
+ "type": "object",
26048
+ "required": [
26049
+ "sid",
26050
+ "phone_number",
26051
+ "friendly_name",
26052
+ "trunk_sid"
26053
+ ],
26054
+ "title": "TwilioPhoneNumber"
26055
+ },
26056
+ "UserActivityStatus": {
26057
+ "type": "string",
26058
+ "enum": [
26059
+ "not_invited",
26060
+ "invited",
26061
+ "active"
26062
+ ],
26063
+ "title": "UserActivityStatus"
26064
+ },
26065
+ "UserCreateRequest": {
26066
+ "properties": {
26067
+ "email": {
26068
+ "type": "string",
26069
+ "title": "Email",
26070
+ "description": "Email address of the user",
26071
+ "examples": [
26072
+ "user@syllable.ai"
26073
+ ]
26074
+ },
26075
+ "first_name": {
26076
+ "anyOf": [
26077
+ {
26078
+ "type": "string"
26079
+ },
26080
+ {
26081
+ "type": "null"
26082
+ }
26083
+ ],
26084
+ "title": "First Name",
26085
+ "description": "First name of the user",
26086
+ "examples": [
26087
+ "Jane"
26088
+ ]
26089
+ },
26090
+ "last_name": {
26091
+ "anyOf": [
26092
+ {
26093
+ "type": "string"
26094
+ },
26095
+ {
26096
+ "type": "null"
26097
+ }
26098
+ ],
26099
+ "title": "Last Name",
26100
+ "description": "Last name of the user",
26101
+ "examples": [
26102
+ "Smith"
26103
+ ]
26104
+ },
26105
+ "role_id": {
26106
+ "type": "integer",
26107
+ "title": "Role Id",
26108
+ "description": "ID of the role assigned to the user",
26109
+ "examples": [
26110
+ 1
26111
+ ]
26112
+ },
26113
+ "login_type": {
26114
+ "anyOf": [
26115
+ {
26116
+ "$ref": "#/components/schemas/LoginType"
26117
+ },
26118
+ {
26119
+ "type": "null"
26120
+ }
26121
+ ],
26122
+ "description": "The type of login to use for the user. If not provided, defaults to google for @gmail.com email addresses, and username and password otherwise.",
26123
+ "examples": [
26124
+ "username_and_password"
26125
+ ]
26126
+ },
26127
+ "skip_auth": {
26128
+ "type": "boolean",
26129
+ "title": "Skip Auth",
26130
+ "description": "Whether to skip authentication for the user.",
26131
+ "default": false
26132
+ }
26133
+ },
26134
+ "type": "object",
26135
+ "required": [
26136
+ "email",
26137
+ "role_id"
26138
+ ],
26139
+ "title": "UserCreateRequest",
26140
+ "description": "Request model to create a user."
26141
+ },
26142
+ "UserDeleteRequest": {
26143
+ "properties": {
26144
+ "email": {
26145
+ "type": "string",
26146
+ "title": "Email",
26147
+ "description": "The email address of the user to delete",
26148
+ "examples": [
26149
+ "user@syllable.ai"
26150
+ ]
26151
+ },
26152
+ "reason": {
26153
+ "type": "string",
26154
+ "title": "Reason",
26155
+ "description": "The reason for deleting the user",
26156
+ "examples": [
26157
+ "User left the organization"
26158
+ ]
26159
+ }
26160
+ },
26161
+ "type": "object",
26162
+ "required": [
26163
+ "email",
26164
+ "reason"
26165
+ ],
26166
+ "title": "UserDeleteRequest",
26167
+ "description": "Request model to delete a user."
26168
+ },
26169
+ "UserProperties": {
26170
+ "type": "string",
26171
+ "enum": [
26172
+ "email",
26173
+ "first_name",
26174
+ "last_name",
26175
+ "role_id",
26176
+ "role_name",
26177
+ "email_first_name_last_name",
26178
+ "activity_status",
26179
+ "last_updated"
26180
+ ],
26181
+ "title": "UserProperties",
26182
+ "description": "Names of user fields supported for filtering/sorting on list endpoint."
26183
+ },
26184
+ "UserResponse": {
26185
+ "properties": {
26186
+ "email": {
26187
+ "type": "string",
26188
+ "title": "Email",
26189
+ "description": "Email address of the user",
26190
+ "examples": [
26191
+ "user@syllable.ai"
26192
+ ]
26193
+ },
26194
+ "first_name": {
26195
+ "anyOf": [
26196
+ {
26197
+ "type": "string"
26198
+ },
26199
+ {
26200
+ "type": "null"
26201
+ }
26202
+ ],
26203
+ "title": "First Name",
26204
+ "description": "First name of the user",
26205
+ "examples": [
26206
+ "Jane"
26207
+ ]
26208
+ },
26209
+ "last_name": {
26210
+ "anyOf": [
26211
+ {
26212
+ "type": "string"
26213
+ },
26214
+ {
26215
+ "type": "null"
26216
+ }
26217
+ ],
26218
+ "title": "Last Name",
26219
+ "description": "Last name of the user",
26220
+ "examples": [
26221
+ "Smith"
26222
+ ]
26223
+ },
26224
+ "role_id": {
26225
+ "type": "integer",
26226
+ "title": "Role Id",
26227
+ "description": "ID of the role assigned to the user",
26228
+ "examples": [
26229
+ 1
26230
+ ]
26231
+ },
26232
+ "last_updated_comments": {
26233
+ "anyOf": [
26234
+ {
26235
+ "type": "string"
26236
+ },
26237
+ {
26238
+ "type": "null"
26239
+ }
26240
+ ],
26241
+ "title": "Last Updated Comments",
26242
+ "description": "Comments for the most recent edit to the user.",
26243
+ "examples": [
26244
+ "Updated to change which role was assigned"
26245
+ ]
26246
+ },
26247
+ "id": {
26248
+ "type": "integer",
26249
+ "title": "Id",
26250
+ "description": "Internal ID of the user",
26251
+ "examples": [
26252
+ 1
26253
+ ]
26254
+ },
26255
+ "role_name": {
26256
+ "type": "string",
26257
+ "title": "Role Name",
26258
+ "description": "Name of the role assigned to the user",
26259
+ "examples": [
26260
+ "Admin"
26261
+ ]
26262
+ },
26263
+ "email_sent": {
26264
+ "type": "boolean",
26265
+ "title": "Email Sent",
26266
+ "description": "Whether the welcome email has been sent to the user",
26267
+ "examples": [
26268
+ true
26269
+ ]
26270
+ },
26271
+ "activity_status": {
26272
+ "$ref": "#/components/schemas/UserActivityStatus",
26273
+ "description": "The activity status of the user",
26274
+ "examples": [
26275
+ "invited"
26276
+ ]
25431
26277
  },
25432
- "friendly_name": {
26278
+ "last_updated": {
25433
26279
  "type": "string",
25434
- "title": "Friendly Name",
25435
- "description": "A user-friendly name for the number."
26280
+ "format": "date-time",
26281
+ "title": "Last Updated",
26282
+ "description": "The timestamp of the most recent update to the user"
25436
26283
  },
25437
- "trunk_sid": {
25438
- "type": "string",
25439
- "title": "Trunk Sid",
25440
- "description": "Associated trunk SID, if any."
26284
+ "last_updated_by": {
26285
+ "anyOf": [
26286
+ {
26287
+ "type": "string"
26288
+ },
26289
+ {
26290
+ "type": "null"
26291
+ }
26292
+ ],
26293
+ "title": "Last Updated By",
26294
+ "description": "The email address of the user who last updated the user",
26295
+ "examples": [
26296
+ "admin@email.com"
26297
+ ]
26298
+ },
26299
+ "last_session_at": {
26300
+ "anyOf": [
26301
+ {
26302
+ "type": "string",
26303
+ "format": "date-time"
26304
+ },
26305
+ {
26306
+ "type": "null"
26307
+ }
26308
+ ],
26309
+ "title": "Last Session At",
26310
+ "description": "The timestamp of the user's last session",
26311
+ "examples": [
26312
+ "2025-01-01T12:00:00Z"
26313
+ ]
25441
26314
  }
25442
26315
  },
25443
26316
  "type": "object",
25444
26317
  "required": [
25445
- "sid",
25446
- "phone_number",
25447
- "friendly_name",
25448
- "trunk_sid"
25449
- ],
25450
- "title": "TwilioPhoneNumber"
25451
- },
25452
- "UserActivityStatus": {
25453
- "type": "string",
25454
- "enum": [
25455
- "not_invited",
25456
- "invited",
25457
- "active"
26318
+ "email",
26319
+ "role_id",
26320
+ "id",
26321
+ "role_name",
26322
+ "email_sent",
26323
+ "activity_status",
26324
+ "last_updated"
25458
26325
  ],
25459
- "title": "UserActivityStatus"
26326
+ "title": "UserResponse",
26327
+ "description": "Information about a user."
25460
26328
  },
25461
- "UserCreateRequest": {
26329
+ "UserUpdateRequest": {
25462
26330
  "properties": {
25463
26331
  "email": {
25464
26332
  "type": "string",
@@ -25506,25 +26374,20 @@
25506
26374
  1
25507
26375
  ]
25508
26376
  },
25509
- "login_type": {
26377
+ "last_updated_comments": {
25510
26378
  "anyOf": [
25511
26379
  {
25512
- "$ref": "#/components/schemas/LoginType"
26380
+ "type": "string"
25513
26381
  },
25514
26382
  {
25515
26383
  "type": "null"
25516
26384
  }
25517
26385
  ],
25518
- "description": "The type of login to use for the user. If not provided, defaults to google for @gmail.com email addresses, and username and password otherwise.",
26386
+ "title": "Last Updated Comments",
26387
+ "description": "Comments for the most recent edit to the user.",
25519
26388
  "examples": [
25520
- "username_and_password"
26389
+ "Updated to change which role was assigned"
25521
26390
  ]
25522
- },
25523
- "skip_auth": {
25524
- "type": "boolean",
25525
- "title": "Skip Auth",
25526
- "description": "Whether to skip authentication for the user.",
25527
- "default": false
25528
26391
  }
25529
26392
  },
25530
26393
  "type": "object",
@@ -25532,62 +26395,73 @@
25532
26395
  "email",
25533
26396
  "role_id"
25534
26397
  ],
25535
- "title": "UserCreateRequest",
25536
- "description": "Request model to create a user."
26398
+ "title": "UserUpdateRequest",
26399
+ "description": "Request model to update an existing user."
25537
26400
  },
25538
- "UserDeleteRequest": {
26401
+ "ValidationError": {
25539
26402
  "properties": {
25540
- "email": {
26403
+ "loc": {
26404
+ "items": {
26405
+ "anyOf": [
26406
+ {
26407
+ "type": "string"
26408
+ },
26409
+ {
26410
+ "type": "integer"
26411
+ }
26412
+ ]
26413
+ },
26414
+ "type": "array",
26415
+ "title": "Location"
26416
+ },
26417
+ "msg": {
25541
26418
  "type": "string",
25542
- "title": "Email",
25543
- "description": "The email address of the user to delete",
25544
- "examples": [
25545
- "user@syllable.ai"
25546
- ]
26419
+ "title": "Message"
25547
26420
  },
25548
- "reason": {
26421
+ "type": {
25549
26422
  "type": "string",
25550
- "title": "Reason",
25551
- "description": "The reason for deleting the user",
25552
- "examples": [
25553
- "User left the organization"
25554
- ]
26423
+ "title": "Error Type"
25555
26424
  }
25556
26425
  },
25557
26426
  "type": "object",
25558
26427
  "required": [
25559
- "email",
25560
- "reason"
26428
+ "loc",
26429
+ "msg",
26430
+ "type"
25561
26431
  ],
25562
- "title": "UserDeleteRequest",
25563
- "description": "Request model to delete a user."
26432
+ "title": "ValidationError"
25564
26433
  },
25565
- "UserProperties": {
25566
- "type": "string",
25567
- "enum": [
25568
- "email",
25569
- "first_name",
25570
- "last_name",
25571
- "role_id",
25572
- "role_name",
25573
- "email_first_name_last_name",
25574
- "activity_status",
25575
- "last_updated"
26434
+ "VoiceDisplayInfo": {
26435
+ "properties": {
26436
+ "display_name": {
26437
+ "type": "string",
26438
+ "title": "Display Name"
26439
+ },
26440
+ "provider": {
26441
+ "type": "string",
26442
+ "title": "Provider"
26443
+ }
26444
+ },
26445
+ "additionalProperties": false,
26446
+ "type": "object",
26447
+ "required": [
26448
+ "display_name",
26449
+ "provider"
25576
26450
  ],
25577
- "title": "UserProperties",
25578
- "description": "Names of user fields supported for filtering/sorting on list endpoint."
26451
+ "title": "VoiceDisplayInfo",
26452
+ "description": "Display metadata for a canonical voice identifier."
25579
26453
  },
25580
- "UserResponse": {
26454
+ "VoiceGroupCreateRequest": {
25581
26455
  "properties": {
25582
- "email": {
26456
+ "name": {
25583
26457
  "type": "string",
25584
- "title": "Email",
25585
- "description": "Email address of the user",
26458
+ "title": "Name",
26459
+ "description": "The name of the language group.",
25586
26460
  "examples": [
25587
- "user@syllable.ai"
26461
+ "Call Center 1 Languages"
25588
26462
  ]
25589
26463
  },
25590
- "first_name": {
26464
+ "description": {
25591
26465
  "anyOf": [
25592
26466
  {
25593
26467
  "type": "string"
@@ -25596,36 +26470,77 @@
25596
26470
  "type": "null"
25597
26471
  }
25598
26472
  ],
25599
- "title": "First Name",
25600
- "description": "First name of the user",
26473
+ "title": "Description",
26474
+ "description": "Description of the language group.",
25601
26475
  "examples": [
25602
- "Jane"
26476
+ "Languages spoken by operators at Call Center 1"
25603
26477
  ]
25604
26478
  },
25605
- "last_name": {
25606
- "anyOf": [
25607
- {
25608
- "type": "string"
25609
- },
25610
- {
25611
- "type": "null"
25612
- }
25613
- ],
25614
- "title": "Last Name",
25615
- "description": "Last name of the user",
26479
+ "language_configs": {
26480
+ "items": {
26481
+ "$ref": "#/components/schemas/LanguageConfig"
26482
+ },
26483
+ "type": "array",
26484
+ "title": "Language Configs",
26485
+ "description": "Voice and DTMF configurations for each language in the group.",
25616
26486
  "examples": [
25617
- "Smith"
26487
+ [
26488
+ {
26489
+ "dtmf_code": 1,
26490
+ "language_code": "en-US",
26491
+ "voice_display_name": "Alloy",
26492
+ "voice_provider": "OpenAI"
26493
+ },
26494
+ {
26495
+ "dtmf_code": 2,
26496
+ "language_code": "es-US",
26497
+ "voice_display_name": "es-US-Neural2-B",
26498
+ "voice_provider": "Google"
26499
+ }
26500
+ ]
25618
26501
  ]
25619
26502
  },
25620
- "role_id": {
25621
- "type": "integer",
25622
- "title": "Role Id",
25623
- "description": "ID of the role assigned to the user",
26503
+ "skip_current_language_in_message": {
26504
+ "type": "boolean",
26505
+ "title": "Skip Current Language In Message",
26506
+ "description": "Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.",
26507
+ "examples": [
26508
+ true
26509
+ ]
26510
+ }
26511
+ },
26512
+ "type": "object",
26513
+ "required": [
26514
+ "name",
26515
+ "language_configs",
26516
+ "skip_current_language_in_message"
26517
+ ],
26518
+ "title": "VoiceGroupCreateRequest",
26519
+ "description": "Request model to create a voice group."
26520
+ },
26521
+ "VoiceGroupProperties": {
26522
+ "type": "string",
26523
+ "enum": [
26524
+ "name",
26525
+ "description",
26526
+ "skip_current_language_in_message",
26527
+ "updated_at",
26528
+ "last_updated_by"
26529
+ ],
26530
+ "title": "VoiceGroupProperties",
26531
+ "description": "Names of voice group fields supported for filtering/sorting on list endpoint."
26532
+ },
26533
+ "VoiceGroupResponse": {
26534
+ "properties": {
26535
+ "name": {
26536
+ "type": "string",
26537
+ "title": "Name",
26538
+ "description": "The name of the language group.",
25624
26539
  "examples": [
25625
- 1
26540
+ "Call Center 1 Languages"
25626
26541
  ]
25627
26542
  },
25628
- "last_updated_comments": {
26543
+ "description": {
25629
26544
  "anyOf": [
25630
26545
  {
25631
26546
  "type": "string"
@@ -25634,50 +26549,53 @@
25634
26549
  "type": "null"
25635
26550
  }
25636
26551
  ],
25637
- "title": "Last Updated Comments",
25638
- "description": "Comments for the most recent edit to the user.",
25639
- "examples": [
25640
- "Updated to change which role was assigned"
25641
- ]
25642
- },
25643
- "id": {
25644
- "type": "integer",
25645
- "title": "Id",
25646
- "description": "Internal ID of the user",
26552
+ "title": "Description",
26553
+ "description": "Description of the language group.",
25647
26554
  "examples": [
25648
- 1
26555
+ "Languages spoken by operators at Call Center 1"
25649
26556
  ]
25650
26557
  },
25651
- "role_name": {
25652
- "type": "string",
25653
- "title": "Role Name",
25654
- "description": "Name of the role assigned to the user",
26558
+ "language_configs": {
26559
+ "items": {
26560
+ "$ref": "#/components/schemas/LanguageConfig"
26561
+ },
26562
+ "type": "array",
26563
+ "title": "Language Configs",
26564
+ "description": "Voice and DTMF configurations for each language in the group.",
25655
26565
  "examples": [
25656
- "Admin"
26566
+ [
26567
+ {
26568
+ "dtmf_code": 1,
26569
+ "language_code": "en-US",
26570
+ "voice_display_name": "Alloy",
26571
+ "voice_provider": "OpenAI"
26572
+ },
26573
+ {
26574
+ "dtmf_code": 2,
26575
+ "language_code": "es-US",
26576
+ "voice_display_name": "es-US-Neural2-B",
26577
+ "voice_provider": "Google"
26578
+ }
26579
+ ]
25657
26580
  ]
25658
26581
  },
25659
- "email_sent": {
26582
+ "skip_current_language_in_message": {
25660
26583
  "type": "boolean",
25661
- "title": "Email Sent",
25662
- "description": "Whether the welcome email has been sent to the user",
26584
+ "title": "Skip Current Language In Message",
26585
+ "description": "Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.",
25663
26586
  "examples": [
25664
26587
  true
25665
26588
  ]
25666
26589
  },
25667
- "activity_status": {
25668
- "$ref": "#/components/schemas/UserActivityStatus",
25669
- "description": "The activity status of the user",
26590
+ "id": {
26591
+ "type": "integer",
26592
+ "title": "Id",
26593
+ "description": "The ID of the language group to update.",
25670
26594
  "examples": [
25671
- "invited"
26595
+ 1
25672
26596
  ]
25673
26597
  },
25674
- "last_updated": {
25675
- "type": "string",
25676
- "format": "date-time",
25677
- "title": "Last Updated",
25678
- "description": "The timestamp of the most recent update to the user"
25679
- },
25680
- "last_updated_by": {
26598
+ "edit_comments": {
25681
26599
  "anyOf": [
25682
26600
  {
25683
26601
  "type": "string"
@@ -25686,53 +26604,76 @@
25686
26604
  "type": "null"
25687
26605
  }
25688
26606
  ],
25689
- "title": "Last Updated By",
25690
- "description": "The email address of the user who last updated the user",
26607
+ "title": "Edit Comments",
26608
+ "description": "Comments for the most recent edit to the language group.",
25691
26609
  "examples": [
25692
- "admin@email.com"
26610
+ "Added Spanish support."
25693
26611
  ]
25694
26612
  },
25695
- "last_session_at": {
26613
+ "agents_info": {
25696
26614
  "anyOf": [
25697
26615
  {
25698
- "type": "string",
25699
- "format": "date-time"
26616
+ "items": {
26617
+ "$ref": "#/components/schemas/LanguageGroupAgentInfo"
26618
+ },
26619
+ "type": "array"
25700
26620
  },
25701
26621
  {
25702
26622
  "type": "null"
25703
26623
  }
25704
26624
  ],
25705
- "title": "Last Session At",
25706
- "description": "The timestamp of the user's last session",
26625
+ "title": "Agents Info",
26626
+ "description": "IDs and names of the agents linked to the language group",
25707
26627
  "examples": [
25708
- "2025-01-01T12:00:00Z"
26628
+ [
26629
+ {
26630
+ "id": 1,
26631
+ "name": "Test Agent"
26632
+ }
26633
+ ]
26634
+ ]
26635
+ },
26636
+ "updated_at": {
26637
+ "type": "string",
26638
+ "format": "date-time",
26639
+ "title": "Updated At",
26640
+ "description": "Timestamp of the last update to the language group.",
26641
+ "examples": [
26642
+ "2024-01-01T00:00:00Z"
26643
+ ]
26644
+ },
26645
+ "last_updated_by": {
26646
+ "type": "string",
26647
+ "title": "Last Updated By",
26648
+ "description": "Email of the user who last updated the language group.",
26649
+ "examples": [
26650
+ "user@mail.com"
25709
26651
  ]
25710
26652
  }
25711
26653
  },
25712
26654
  "type": "object",
25713
26655
  "required": [
25714
- "email",
25715
- "role_id",
26656
+ "name",
26657
+ "language_configs",
26658
+ "skip_current_language_in_message",
25716
26659
  "id",
25717
- "role_name",
25718
- "email_sent",
25719
- "activity_status",
25720
- "last_updated"
26660
+ "updated_at",
26661
+ "last_updated_by"
25721
26662
  ],
25722
- "title": "UserResponse",
25723
- "description": "Information about a user."
26663
+ "title": "VoiceGroupResponse",
26664
+ "description": "Response model for voice group operations.\nA voice group is a collection of language, voice, and DTMF configuration that can be\nlinked to an agent to define the languages and voices it supports. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/VoiceGroups)."
25724
26665
  },
25725
- "UserUpdateRequest": {
26666
+ "VoiceGroupUpdateRequest": {
25726
26667
  "properties": {
25727
- "email": {
26668
+ "name": {
25728
26669
  "type": "string",
25729
- "title": "Email",
25730
- "description": "Email address of the user",
26670
+ "title": "Name",
26671
+ "description": "The name of the language group.",
25731
26672
  "examples": [
25732
- "user@syllable.ai"
26673
+ "Call Center 1 Languages"
25733
26674
  ]
25734
26675
  },
25735
- "first_name": {
26676
+ "description": {
25736
26677
  "anyOf": [
25737
26678
  {
25738
26679
  "type": "string"
@@ -25741,36 +26682,53 @@
25741
26682
  "type": "null"
25742
26683
  }
25743
26684
  ],
25744
- "title": "First Name",
25745
- "description": "First name of the user",
26685
+ "title": "Description",
26686
+ "description": "Description of the language group.",
25746
26687
  "examples": [
25747
- "Jane"
26688
+ "Languages spoken by operators at Call Center 1"
25748
26689
  ]
25749
26690
  },
25750
- "last_name": {
25751
- "anyOf": [
25752
- {
25753
- "type": "string"
25754
- },
25755
- {
25756
- "type": "null"
25757
- }
25758
- ],
25759
- "title": "Last Name",
25760
- "description": "Last name of the user",
26691
+ "language_configs": {
26692
+ "items": {
26693
+ "$ref": "#/components/schemas/LanguageConfig"
26694
+ },
26695
+ "type": "array",
26696
+ "title": "Language Configs",
26697
+ "description": "Voice and DTMF configurations for each language in the group.",
25761
26698
  "examples": [
25762
- "Smith"
26699
+ [
26700
+ {
26701
+ "dtmf_code": 1,
26702
+ "language_code": "en-US",
26703
+ "voice_display_name": "Alloy",
26704
+ "voice_provider": "OpenAI"
26705
+ },
26706
+ {
26707
+ "dtmf_code": 2,
26708
+ "language_code": "es-US",
26709
+ "voice_display_name": "es-US-Neural2-B",
26710
+ "voice_provider": "Google"
26711
+ }
26712
+ ]
25763
26713
  ]
25764
26714
  },
25765
- "role_id": {
26715
+ "skip_current_language_in_message": {
26716
+ "type": "boolean",
26717
+ "title": "Skip Current Language In Message",
26718
+ "description": "Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.",
26719
+ "examples": [
26720
+ true
26721
+ ]
26722
+ },
26723
+ "id": {
25766
26724
  "type": "integer",
25767
- "title": "Role Id",
25768
- "description": "ID of the role assigned to the user",
26725
+ "title": "Id",
26726
+ "description": "The ID of the language group to update.",
25769
26727
  "examples": [
25770
26728
  1
25771
26729
  ]
25772
26730
  },
25773
- "last_updated_comments": {
26731
+ "edit_comments": {
25774
26732
  "anyOf": [
25775
26733
  {
25776
26734
  "type": "string"
@@ -25779,73 +26737,22 @@
25779
26737
  "type": "null"
25780
26738
  }
25781
26739
  ],
25782
- "title": "Last Updated Comments",
25783
- "description": "Comments for the most recent edit to the user.",
26740
+ "title": "Edit Comments",
26741
+ "description": "Comments for the most recent edit to the language group.",
25784
26742
  "examples": [
25785
- "Updated to change which role was assigned"
26743
+ "Added Spanish support."
25786
26744
  ]
25787
26745
  }
25788
26746
  },
25789
26747
  "type": "object",
25790
26748
  "required": [
25791
- "email",
25792
- "role_id"
25793
- ],
25794
- "title": "UserUpdateRequest",
25795
- "description": "Request model to update an existing user."
25796
- },
25797
- "ValidationError": {
25798
- "properties": {
25799
- "loc": {
25800
- "items": {
25801
- "anyOf": [
25802
- {
25803
- "type": "string"
25804
- },
25805
- {
25806
- "type": "integer"
25807
- }
25808
- ]
25809
- },
25810
- "type": "array",
25811
- "title": "Location"
25812
- },
25813
- "msg": {
25814
- "type": "string",
25815
- "title": "Message"
25816
- },
25817
- "type": {
25818
- "type": "string",
25819
- "title": "Error Type"
25820
- }
25821
- },
25822
- "type": "object",
25823
- "required": [
25824
- "loc",
25825
- "msg",
25826
- "type"
25827
- ],
25828
- "title": "ValidationError"
25829
- },
25830
- "VoiceDisplayInfo": {
25831
- "properties": {
25832
- "display_name": {
25833
- "type": "string",
25834
- "title": "Display Name"
25835
- },
25836
- "provider": {
25837
- "type": "string",
25838
- "title": "Provider"
25839
- }
25840
- },
25841
- "additionalProperties": false,
25842
- "type": "object",
25843
- "required": [
25844
- "display_name",
25845
- "provider"
26749
+ "name",
26750
+ "language_configs",
26751
+ "skip_current_language_in_message",
26752
+ "id"
25846
26753
  ],
25847
- "title": "VoiceDisplayInfo",
25848
- "description": "Display metadata for a canonical voice identifier."
26754
+ "title": "VoiceGroupUpdateRequest",
26755
+ "description": "Request model to update an existing voice group."
25849
26756
  },
25850
26757
  "VoiceSampleCreateRequest": {
25851
26758
  "properties": {