telnyx 6.65.0 → 6.66.0

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 (177) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/client.d.mts +11 -10
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +11 -10
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/ai/ai.d.mts +114 -116
  10. package/resources/ai/ai.d.mts.map +1 -1
  11. package/resources/ai/ai.d.ts +114 -116
  12. package/resources/ai/ai.d.ts.map +1 -1
  13. package/resources/ai/ai.js.map +1 -1
  14. package/resources/ai/ai.mjs.map +1 -1
  15. package/resources/ai/assistants/assistants.d.mts +139 -334
  16. package/resources/ai/assistants/assistants.d.mts.map +1 -1
  17. package/resources/ai/assistants/assistants.d.ts +139 -334
  18. package/resources/ai/assistants/assistants.d.ts.map +1 -1
  19. package/resources/ai/assistants/assistants.js.map +1 -1
  20. package/resources/ai/assistants/assistants.mjs.map +1 -1
  21. package/resources/ai/assistants/canary-deploys.d.mts +70 -241
  22. package/resources/ai/assistants/canary-deploys.d.mts.map +1 -1
  23. package/resources/ai/assistants/canary-deploys.d.ts +70 -241
  24. package/resources/ai/assistants/canary-deploys.d.ts.map +1 -1
  25. package/resources/ai/assistants/index.d.mts +2 -2
  26. package/resources/ai/assistants/index.d.mts.map +1 -1
  27. package/resources/ai/assistants/index.d.ts +2 -2
  28. package/resources/ai/assistants/index.d.ts.map +1 -1
  29. package/resources/ai/assistants/index.js.map +1 -1
  30. package/resources/ai/assistants/index.mjs.map +1 -1
  31. package/resources/ai/assistants/versions.d.mts +6 -220
  32. package/resources/ai/assistants/versions.d.mts.map +1 -1
  33. package/resources/ai/assistants/versions.d.ts +6 -220
  34. package/resources/ai/assistants/versions.d.ts.map +1 -1
  35. package/resources/ai/index.d.mts +2 -2
  36. package/resources/ai/index.d.mts.map +1 -1
  37. package/resources/ai/index.d.ts +2 -2
  38. package/resources/ai/index.d.ts.map +1 -1
  39. package/resources/ai/index.js.map +1 -1
  40. package/resources/ai/index.mjs.map +1 -1
  41. package/resources/ai/openai/openai.d.mts +2 -113
  42. package/resources/ai/openai/openai.d.mts.map +1 -1
  43. package/resources/ai/openai/openai.d.ts +2 -113
  44. package/resources/ai/openai/openai.d.ts.map +1 -1
  45. package/resources/ai/openai/openai.js.map +1 -1
  46. package/resources/ai/openai/openai.mjs.map +1 -1
  47. package/resources/calls/actions.d.mts +177 -120
  48. package/resources/calls/actions.d.mts.map +1 -1
  49. package/resources/calls/actions.d.ts +177 -120
  50. package/resources/calls/actions.d.ts.map +1 -1
  51. package/resources/calls/actions.js +3 -5
  52. package/resources/calls/actions.js.map +1 -1
  53. package/resources/calls/actions.mjs +3 -5
  54. package/resources/calls/actions.mjs.map +1 -1
  55. package/resources/calls/calls.d.mts +2 -2
  56. package/resources/calls/calls.d.mts.map +1 -1
  57. package/resources/calls/calls.d.ts +2 -2
  58. package/resources/calls/calls.d.ts.map +1 -1
  59. package/resources/calls/calls.js.map +1 -1
  60. package/resources/calls/calls.mjs.map +1 -1
  61. package/resources/calls/index.d.mts +1 -1
  62. package/resources/calls/index.d.mts.map +1 -1
  63. package/resources/calls/index.d.ts +1 -1
  64. package/resources/calls/index.d.ts.map +1 -1
  65. package/resources/calls/index.js.map +1 -1
  66. package/resources/calls/index.mjs.map +1 -1
  67. package/resources/conferences/actions.d.mts +1 -11
  68. package/resources/conferences/actions.d.mts.map +1 -1
  69. package/resources/conferences/actions.d.ts +1 -11
  70. package/resources/conferences/actions.d.ts.map +1 -1
  71. package/resources/faxes/faxes.d.mts +24 -8
  72. package/resources/faxes/faxes.d.mts.map +1 -1
  73. package/resources/faxes/faxes.d.ts +24 -8
  74. package/resources/faxes/faxes.d.ts.map +1 -1
  75. package/resources/faxes/faxes.js +12 -0
  76. package/resources/faxes/faxes.js.map +1 -1
  77. package/resources/faxes/faxes.mjs +12 -0
  78. package/resources/faxes/faxes.mjs.map +1 -1
  79. package/resources/index.d.mts +5 -5
  80. package/resources/index.d.mts.map +1 -1
  81. package/resources/index.d.ts +5 -5
  82. package/resources/index.d.ts.map +1 -1
  83. package/resources/index.js.map +1 -1
  84. package/resources/index.mjs.map +1 -1
  85. package/resources/networks/networks.d.mts +25 -2
  86. package/resources/networks/networks.d.mts.map +1 -1
  87. package/resources/networks/networks.d.ts +25 -2
  88. package/resources/networks/networks.d.ts.map +1 -1
  89. package/resources/networks/networks.js.map +1 -1
  90. package/resources/networks/networks.mjs.map +1 -1
  91. package/resources/public-internet-gateways.d.mts +40 -50
  92. package/resources/public-internet-gateways.d.mts.map +1 -1
  93. package/resources/public-internet-gateways.d.ts +40 -50
  94. package/resources/public-internet-gateways.d.ts.map +1 -1
  95. package/resources/public-internet-gateways.js +1 -1
  96. package/resources/public-internet-gateways.js.map +1 -1
  97. package/resources/public-internet-gateways.mjs +1 -1
  98. package/resources/public-internet-gateways.mjs.map +1 -1
  99. package/resources/shared.d.mts +10 -0
  100. package/resources/shared.d.mts.map +1 -1
  101. package/resources/shared.d.ts +10 -0
  102. package/resources/shared.d.ts.map +1 -1
  103. package/resources/texml/accounts/calls/calls.d.mts +27 -6
  104. package/resources/texml/accounts/calls/calls.d.mts.map +1 -1
  105. package/resources/texml/accounts/calls/calls.d.ts +27 -6
  106. package/resources/texml/accounts/calls/calls.d.ts.map +1 -1
  107. package/resources/texml/accounts/calls/calls.js.map +1 -1
  108. package/resources/texml/accounts/calls/calls.mjs.map +1 -1
  109. package/resources/texml/texml.d.mts +9 -2
  110. package/resources/texml/texml.d.mts.map +1 -1
  111. package/resources/texml/texml.d.ts +9 -2
  112. package/resources/texml/texml.d.ts.map +1 -1
  113. package/resources/texml/texml.js.map +1 -1
  114. package/resources/texml/texml.mjs.map +1 -1
  115. package/resources/uac-connections/index.d.mts +1 -1
  116. package/resources/uac-connections/index.d.mts.map +1 -1
  117. package/resources/uac-connections/index.d.ts +1 -1
  118. package/resources/uac-connections/index.d.ts.map +1 -1
  119. package/resources/uac-connections/index.js.map +1 -1
  120. package/resources/uac-connections/index.mjs.map +1 -1
  121. package/resources/uac-connections/uac-connections.d.mts +211 -1861
  122. package/resources/uac-connections/uac-connections.d.mts.map +1 -1
  123. package/resources/uac-connections/uac-connections.d.ts +211 -1861
  124. package/resources/uac-connections/uac-connections.d.ts.map +1 -1
  125. package/resources/uac-connections/uac-connections.js +1 -1
  126. package/resources/uac-connections/uac-connections.js.map +1 -1
  127. package/resources/uac-connections/uac-connections.mjs +1 -1
  128. package/resources/uac-connections/uac-connections.mjs.map +1 -1
  129. package/resources/virtual-cross-connects.d.mts +48 -504
  130. package/resources/virtual-cross-connects.d.mts.map +1 -1
  131. package/resources/virtual-cross-connects.d.ts +48 -504
  132. package/resources/virtual-cross-connects.d.ts.map +1 -1
  133. package/resources/virtual-cross-connects.js +1 -1
  134. package/resources/virtual-cross-connects.js.map +1 -1
  135. package/resources/virtual-cross-connects.mjs +1 -1
  136. package/resources/virtual-cross-connects.mjs.map +1 -1
  137. package/resources/webhooks.d.mts +20 -10
  138. package/resources/webhooks.d.mts.map +1 -1
  139. package/resources/webhooks.d.ts +20 -10
  140. package/resources/webhooks.d.ts.map +1 -1
  141. package/resources/wireguard-interfaces.d.mts +43 -127
  142. package/resources/wireguard-interfaces.d.mts.map +1 -1
  143. package/resources/wireguard-interfaces.d.ts +43 -127
  144. package/resources/wireguard-interfaces.d.ts.map +1 -1
  145. package/resources/wireguard-interfaces.js +5 -2
  146. package/resources/wireguard-interfaces.js.map +1 -1
  147. package/resources/wireguard-interfaces.mjs +5 -2
  148. package/resources/wireguard-interfaces.mjs.map +1 -1
  149. package/src/client.ts +27 -16
  150. package/src/resources/ai/ai.ts +139 -130
  151. package/src/resources/ai/assistants/assistants.ts +164 -363
  152. package/src/resources/ai/assistants/canary-deploys.ts +75 -266
  153. package/src/resources/ai/assistants/index.ts +10 -0
  154. package/src/resources/ai/assistants/versions.ts +6 -244
  155. package/src/resources/ai/index.ts +6 -0
  156. package/src/resources/ai/openai/openai.ts +2 -131
  157. package/src/resources/calls/actions.ts +284 -184
  158. package/src/resources/calls/calls.ts +4 -0
  159. package/src/resources/calls/index.ts +2 -0
  160. package/src/resources/conferences/actions.ts +1 -13
  161. package/src/resources/faxes/faxes.ts +24 -8
  162. package/src/resources/index.ts +13 -8
  163. package/src/resources/networks/networks.ts +31 -4
  164. package/src/resources/public-internet-gateways.ts +46 -55
  165. package/src/resources/shared.ts +12 -0
  166. package/src/resources/texml/accounts/calls/calls.ts +30 -6
  167. package/src/resources/texml/texml.ts +10 -2
  168. package/src/resources/uac-connections/index.ts +6 -2
  169. package/src/resources/uac-connections/uac-connections.ts +397 -2396
  170. package/src/resources/virtual-cross-connects.ts +54 -595
  171. package/src/resources/webhooks.ts +21 -10
  172. package/src/resources/wireguard-interfaces.ts +53 -158
  173. package/src/version.ts +1 -1
  174. package/version.d.mts +1 -1
  175. package/version.d.ts +1 -1
  176. package/version.js +1 -1
  177. package/version.mjs +1 -1
@@ -10,6 +10,11 @@ import {
10
10
  CanaryDeployResponse,
11
11
  CanaryDeployUpdateParams,
12
12
  CanaryDeploys,
13
+ Clause,
14
+ RolloutSlot,
15
+ RuleInput,
16
+ RuleOutput,
17
+ Serve,
13
18
  } from './canary-deploys';
14
19
  import * as ScheduledEventsAPI from './scheduled-events';
15
20
  import {
@@ -295,6 +300,47 @@ export interface Assistant {
295
300
  >;
296
301
  }
297
302
 
303
+ /**
304
+ * Reference to a connected integration attached to an assistant. Discover
305
+ * available integrations with `/ai/integrations` and connected integrations with
306
+ * `/ai/integrations/connections`.
307
+ */
308
+ export interface AssistantIntegration {
309
+ /**
310
+ * Catalog integration ID to attach. This is the `id` from the integrations catalog
311
+ * at `/ai/integrations` (the same value also appears as `integration_id` on
312
+ * entries returned by `/ai/integrations/connections`). It is **not** the
313
+ * connection-level `id` from `/ai/integrations/connections`.
314
+ */
315
+ integration_id: string;
316
+
317
+ /**
318
+ * Optional per-assistant allowlist of integration tool names. When omitted or
319
+ * empty, all tools allowed by the connected integration are available to the
320
+ * assistant.
321
+ */
322
+ allowed_list?: Array<string>;
323
+ }
324
+
325
+ /**
326
+ * Reference to an MCP server attached to an assistant. Create and manage MCP
327
+ * servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
328
+ * ID.
329
+ */
330
+ export interface AssistantMcpServer {
331
+ /**
332
+ * ID of the MCP server to attach. This must be the `id` of an MCP server returned
333
+ * by the `/ai/mcp_servers` endpoints.
334
+ */
335
+ id: string;
336
+
337
+ /**
338
+ * Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
339
+ * uses the MCP server's configured `allowed_tools`.
340
+ */
341
+ allowed_tools?: Array<string>;
342
+ }
343
+
298
344
  /**
299
345
  * The handoff tool allows the assistant to hand off control of the conversation to
300
346
  * another AI assistant. By default, this will happen transparently to the end
@@ -374,7 +420,7 @@ export namespace AssistantTool {
374
420
  * variable string like `{{ targets }}` where `targets` is returned by the dynamic
375
421
  * variables webhook and resolves to an array of target objects at runtime.
376
422
  */
377
- targets: Array<Transfer.UnionMember0> | string;
423
+ targets: Array<Transfer.TargetsList> | string;
378
424
 
379
425
  /**
380
426
  * Custom headers to be added to the SIP INVITE for the transfer command.
@@ -404,7 +450,7 @@ export namespace AssistantTool {
404
450
  }
405
451
 
406
452
  export namespace Transfer {
407
- export interface UnionMember0 {
453
+ export interface TargetsList {
408
454
  /**
409
455
  * The destination number or SIP URI of the call.
410
456
  */
@@ -581,7 +627,7 @@ export namespace AssistantTool {
581
627
  * omitted or null, the invite tool can still be configured and targets may be
582
628
  * supplied dynamically at runtime.
583
629
  */
584
- targets?: Array<Invite.UnionMember0> | string | null;
630
+ targets?: Array<Invite.TargetsList> | string | null;
585
631
 
586
632
  /**
587
633
  * Configuration for voicemail detection (AMD - Answering Machine Detection) on the
@@ -603,7 +649,7 @@ export namespace AssistantTool {
603
649
  value?: string;
604
650
  }
605
651
 
606
- export interface UnionMember0 {
652
+ export interface TargetsList {
607
653
  /**
608
654
  * The destination number or SIP URI of the call.
609
655
  */
@@ -1011,7 +1057,7 @@ export interface InferenceEmbedding {
1011
1057
  * `/ai/integrations/connections`. Each item references a catalog integration by
1012
1058
  * `integration_id`.
1013
1059
  */
1014
- integrations?: Array<InferenceEmbedding.Integration>;
1060
+ integrations?: Array<AssistantIntegration>;
1015
1061
 
1016
1062
  /**
1017
1063
  * Settings for interruptions and how the assistant decides the user has finished
@@ -1021,7 +1067,7 @@ export interface InferenceEmbedding {
1021
1067
  * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
1022
1068
  * `eager_eot_threshold`).
1023
1069
  */
1024
- interruption_settings?: InferenceEmbedding.InterruptionSettings;
1070
+ interruption_settings?: InferenceEmbeddingInterruptionSettings;
1025
1071
 
1026
1072
  /**
1027
1073
  * This is only needed when using third-party inference providers selected by
@@ -1037,7 +1083,7 @@ export interface InferenceEmbedding {
1037
1083
  * MCP servers attached to the assistant. Create MCP servers with
1038
1084
  * `/ai/mcp_servers`, then reference them by `id` here.
1039
1085
  */
1040
- mcp_servers?: Array<InferenceEmbedding.McpServer>;
1086
+ mcp_servers?: Array<AssistantMcpServer>;
1041
1087
 
1042
1088
  messaging_settings?: MessagingSettings;
1043
1089
 
@@ -1101,123 +1147,32 @@ export interface InferenceEmbedding {
1101
1147
  widget_settings?: WidgetSettings;
1102
1148
  }
1103
1149
 
1104
- export namespace InferenceEmbedding {
1150
+ /**
1151
+ * Settings for interruptions and how the assistant decides the user has finished
1152
+ * speaking. These timings are most relevant when using non turn-taking
1153
+ * transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
1154
+ * behavior is controlled by the transcription end-of-turn settings under
1155
+ * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
1156
+ * `eager_eot_threshold`).
1157
+ */
1158
+ export interface InferenceEmbeddingInterruptionSettings {
1105
1159
  /**
1106
- * Reference to a connected integration attached to an assistant. Discover
1107
- * available integrations with `/ai/integrations` and connected integrations with
1108
- * `/ai/integrations/connections`.
1160
+ * When true, disables user interruptions while the assistant greeting is playing.
1109
1161
  */
1110
- export interface Integration {
1111
- /**
1112
- * Catalog integration ID to attach. This is the `id` from the integrations catalog
1113
- * at `/ai/integrations` (the same value also appears as `integration_id` on
1114
- * entries returned by `/ai/integrations/connections`). It is **not** the
1115
- * connection-level `id` from `/ai/integrations/connections`.
1116
- */
1117
- integration_id: string;
1118
-
1119
- /**
1120
- * Optional per-assistant allowlist of integration tool names. When omitted or
1121
- * empty, all tools allowed by the connected integration are available to the
1122
- * assistant.
1123
- */
1124
- allowed_list?: Array<string>;
1125
- }
1162
+ disable_greeting_interruption?: boolean;
1126
1163
 
1127
1164
  /**
1128
- * Settings for interruptions and how the assistant decides the user has finished
1129
- * speaking. These timings are most relevant when using non turn-taking
1130
- * transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
1131
- * behavior is controlled by the transcription end-of-turn settings under
1132
- * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
1133
- * `eager_eot_threshold`).
1165
+ * Whether users can interrupt the assistant while it is speaking.
1134
1166
  */
1135
- export interface InterruptionSettings {
1136
- /**
1137
- * When true, disables user interruptions while the assistant greeting is playing.
1138
- */
1139
- disable_greeting_interruption?: boolean;
1140
-
1141
- /**
1142
- * Whether users can interrupt the assistant while it is speaking.
1143
- */
1144
- enable?: boolean;
1145
-
1146
- /**
1147
- * Controls when the assistant starts speaking after the user stops. These
1148
- * thresholds primarily apply to non turn-taking transcription models. For
1149
- * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
1150
- * transcription end-of-turn settings under `transcription.settings` instead.
1151
- */
1152
- start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
1153
- }
1154
-
1155
- export namespace InterruptionSettings {
1156
- /**
1157
- * Controls when the assistant starts speaking after the user stops. These
1158
- * thresholds primarily apply to non turn-taking transcription models. For
1159
- * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
1160
- * transcription end-of-turn settings under `transcription.settings` instead.
1161
- */
1162
- export interface StartSpeakingPlan {
1163
- /**
1164
- * Endpointing thresholds used to decide when the user has finished speaking.
1165
- * Applies to non turn-taking transcription models. For `deepgram/flux`, use
1166
- * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
1167
- * `eager_eot_threshold`.
1168
- */
1169
- transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
1170
-
1171
- /**
1172
- * Minimum seconds to wait before the assistant starts speaking.
1173
- */
1174
- wait_seconds?: number;
1175
- }
1176
-
1177
- export namespace StartSpeakingPlan {
1178
- /**
1179
- * Endpointing thresholds used to decide when the user has finished speaking.
1180
- * Applies to non turn-taking transcription models. For `deepgram/flux`, use
1181
- * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
1182
- * `eager_eot_threshold`.
1183
- */
1184
- export interface TranscriptionEndpointingPlan {
1185
- /**
1186
- * Seconds to wait after the transcript ends without punctuation.
1187
- */
1188
- on_no_punctuation_seconds?: number;
1189
-
1190
- /**
1191
- * Seconds to wait after the transcript ends with a number.
1192
- */
1193
- on_number_seconds?: number;
1194
-
1195
- /**
1196
- * Seconds to wait after the transcript ends with punctuation.
1197
- */
1198
- on_punctuation_seconds?: number;
1199
- }
1200
- }
1201
- }
1167
+ enable?: boolean;
1202
1168
 
1203
1169
  /**
1204
- * Reference to an MCP server attached to an assistant. Create and manage MCP
1205
- * servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
1206
- * ID.
1170
+ * Controls when the assistant starts speaking after the user stops. These
1171
+ * thresholds primarily apply to non turn-taking transcription models. For
1172
+ * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
1173
+ * transcription end-of-turn settings under `transcription.settings` instead.
1207
1174
  */
1208
- export interface McpServer {
1209
- /**
1210
- * ID of the MCP server to attach. This must be the `id` of an MCP server returned
1211
- * by the `/ai/mcp_servers` endpoints.
1212
- */
1213
- id: string;
1214
-
1215
- /**
1216
- * Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
1217
- * uses the MCP server's configured `allowed_tools`.
1218
- */
1219
- allowed_tools?: Array<string>;
1220
- }
1175
+ start_speaking_plan?: StartSpeakingPlan;
1221
1176
  }
1222
1177
 
1223
1178
  export interface InferenceEmbeddingWebhookToolParams {
@@ -1524,6 +1479,27 @@ export interface RetrievalTool {
1524
1479
  type: 'retrieval';
1525
1480
  }
1526
1481
 
1482
+ /**
1483
+ * Controls when the assistant starts speaking after the user stops. These
1484
+ * thresholds primarily apply to non turn-taking transcription models. For
1485
+ * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
1486
+ * transcription end-of-turn settings under `transcription.settings` instead.
1487
+ */
1488
+ export interface StartSpeakingPlan {
1489
+ /**
1490
+ * Endpointing thresholds used to decide when the user has finished speaking.
1491
+ * Applies to non turn-taking transcription models. For `deepgram/flux`, use
1492
+ * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
1493
+ * `eager_eot_threshold`.
1494
+ */
1495
+ transcription_endpointing_plan?: TranscriptionEndpointingPlan;
1496
+
1497
+ /**
1498
+ * Minimum seconds to wait before the assistant starts speaking.
1499
+ */
1500
+ wait_seconds?: number;
1501
+ }
1502
+
1527
1503
  export interface TelephonySettings {
1528
1504
  /**
1529
1505
  * Default Texml App used for voice calls with your assistant. This will be created
@@ -1687,6 +1663,29 @@ export namespace TelephonySettings {
1687
1663
  }
1688
1664
  }
1689
1665
 
1666
+ /**
1667
+ * Endpointing thresholds used to decide when the user has finished speaking.
1668
+ * Applies to non turn-taking transcription models. For `deepgram/flux`, use
1669
+ * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
1670
+ * `eager_eot_threshold`.
1671
+ */
1672
+ export interface TranscriptionEndpointingPlan {
1673
+ /**
1674
+ * Seconds to wait after the transcript ends without punctuation.
1675
+ */
1676
+ on_no_punctuation_seconds?: number;
1677
+
1678
+ /**
1679
+ * Seconds to wait after the transcript ends with a number.
1680
+ */
1681
+ on_number_seconds?: number;
1682
+
1683
+ /**
1684
+ * Seconds to wait after the transcript ends with punctuation.
1685
+ */
1686
+ on_punctuation_seconds?: number;
1687
+ }
1688
+
1690
1689
  export interface TranscriptionSettings {
1691
1690
  /**
1692
1691
  * Integration secret identifier for the transcription provider API key. Currently
@@ -1699,7 +1698,9 @@ export interface TranscriptionSettings {
1699
1698
  * supported models will automatically detect the language. For `deepgram/flux`,
1700
1699
  * supported values are: `auto` (Telnyx language detection controls the language
1701
1700
  * hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
1702
- * `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
1701
+ * `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
1702
+ * omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
1703
+ * `es`) bias detection toward that language.
1703
1704
  */
1704
1705
  language?: string;
1705
1706
 
@@ -1714,6 +1715,8 @@ export interface TranscriptionSettings {
1714
1715
  * - `assemblyai/universal-streaming` is a multilingual streaming model with
1715
1716
  * configurable turn detection.
1716
1717
  * - `xai/grok-stt` is a multilingual Grok STT model.
1718
+ * - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
1719
+ * detection and configurable endpointing.
1717
1720
  */
1718
1721
  model?:
1719
1722
  | 'deepgram/flux'
@@ -1722,6 +1725,7 @@ export interface TranscriptionSettings {
1722
1725
  | 'azure/fast'
1723
1726
  | 'assemblyai/universal-streaming'
1724
1727
  | 'xai/grok-stt'
1728
+ | 'soniox/stt-rt-v4'
1725
1729
  | 'distil-whisper/distil-large-v2'
1726
1730
  | 'openai/whisper-large-v3-turbo';
1727
1731
 
@@ -1742,6 +1746,12 @@ export interface TranscriptionSettingsConfig {
1742
1746
  */
1743
1747
  eager_eot_threshold?: number;
1744
1748
 
1749
+ /**
1750
+ * Available only for soniox/stt-rt-v4. When true, Soniox emits end-of-utterance
1751
+ * events at the cadence configured by `max_endpoint_delay_ms`.
1752
+ */
1753
+ enable_endpoint_detection?: boolean;
1754
+
1745
1755
  /**
1746
1756
  * Available only for assemblyai/universal-streaming. Confidence level required to
1747
1757
  * trigger an end of turn. Higher values require more certainty before ending a
@@ -1761,6 +1771,12 @@ export interface TranscriptionSettingsConfig {
1761
1771
  */
1762
1772
  eot_timeout_ms?: number;
1763
1773
 
1774
+ /**
1775
+ * Available only for soniox/stt-rt-v4. When true, Soniox streams interim
1776
+ * (non-final) results in addition to finalized transcripts.
1777
+ */
1778
+ interim_results?: boolean;
1779
+
1764
1780
  /**
1765
1781
  * Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
1766
1782
  * key terms to boost for recognition during transcription. Helps improve accuracy
@@ -1772,6 +1788,13 @@ export interface TranscriptionSettingsConfig {
1772
1788
  */
1773
1789
  keyterm?: string;
1774
1790
 
1791
+ /**
1792
+ * Available only for soniox/stt-rt-v4. Maximum silence (in milliseconds) before
1793
+ * Soniox emits an end-of-utterance event. Only honored when
1794
+ * `enable_endpoint_detection` is true.
1795
+ */
1796
+ max_endpoint_delay_ms?: number;
1797
+
1775
1798
  /**
1776
1799
  * Available only for assemblyai/universal-streaming. Maximum duration of silence
1777
1800
  * in milliseconds before forcing an end of turn.
@@ -1809,11 +1832,11 @@ export namespace TransferTool {
1809
1832
  * variable string like `{{ targets }}` where `targets` is returned by the dynamic
1810
1833
  * variables webhook and resolves to an array of target objects at runtime.
1811
1834
  */
1812
- targets: Array<Transfer.UnionMember0> | string;
1835
+ targets: Array<Transfer.TargetsList> | string;
1813
1836
  }
1814
1837
 
1815
1838
  export namespace Transfer {
1816
- export interface UnionMember0 {
1839
+ export interface TargetsList {
1817
1840
  /**
1818
1841
  * The destination number or SIP URI of the call.
1819
1842
  */
@@ -1965,6 +1988,12 @@ export namespace VoiceSettings {
1965
1988
  * The predefined media to use. `silence` disables background audio.
1966
1989
  */
1967
1990
  value: 'silence' | 'office';
1991
+
1992
+ /**
1993
+ * Volume level for the predefined background audio. Supports values from 0.1 to
1994
+ * 1.0 in 0.1 increments.
1995
+ */
1996
+ volume?: number;
1968
1997
  }
1969
1998
 
1970
1999
  export interface MediaURL {
@@ -2276,7 +2305,7 @@ export interface AssistantCreateParams {
2276
2305
  * `/ai/integrations/connections`. Each item references a catalog integration by
2277
2306
  * `integration_id`.
2278
2307
  */
2279
- integrations?: Array<AssistantCreateParams.Integration>;
2308
+ integrations?: Array<AssistantIntegration>;
2280
2309
 
2281
2310
  /**
2282
2311
  * Settings for interruptions and how the assistant decides the user has finished
@@ -2286,7 +2315,7 @@ export interface AssistantCreateParams {
2286
2315
  * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
2287
2316
  * `eager_eot_threshold`).
2288
2317
  */
2289
- interruption_settings?: AssistantCreateParams.InterruptionSettings;
2318
+ interruption_settings?: InferenceEmbeddingInterruptionSettings;
2290
2319
 
2291
2320
  /**
2292
2321
  * This is only needed when using third-party inference providers selected by
@@ -2302,7 +2331,7 @@ export interface AssistantCreateParams {
2302
2331
  * MCP servers attached to the assistant. Create MCP servers with
2303
2332
  * `/ai/mcp_servers`, then reference them by `id` here.
2304
2333
  */
2305
- mcp_servers?: Array<AssistantCreateParams.McpServer>;
2334
+ mcp_servers?: Array<AssistantMcpServer>;
2306
2335
 
2307
2336
  messaging_settings?: MessagingSettings;
2308
2337
 
@@ -2360,125 +2389,6 @@ export interface AssistantCreateParams {
2360
2389
  widget_settings?: WidgetSettings;
2361
2390
  }
2362
2391
 
2363
- export namespace AssistantCreateParams {
2364
- /**
2365
- * Reference to a connected integration attached to an assistant. Discover
2366
- * available integrations with `/ai/integrations` and connected integrations with
2367
- * `/ai/integrations/connections`.
2368
- */
2369
- export interface Integration {
2370
- /**
2371
- * Catalog integration ID to attach. This is the `id` from the integrations catalog
2372
- * at `/ai/integrations` (the same value also appears as `integration_id` on
2373
- * entries returned by `/ai/integrations/connections`). It is **not** the
2374
- * connection-level `id` from `/ai/integrations/connections`.
2375
- */
2376
- integration_id: string;
2377
-
2378
- /**
2379
- * Optional per-assistant allowlist of integration tool names. When omitted or
2380
- * empty, all tools allowed by the connected integration are available to the
2381
- * assistant.
2382
- */
2383
- allowed_list?: Array<string>;
2384
- }
2385
-
2386
- /**
2387
- * Settings for interruptions and how the assistant decides the user has finished
2388
- * speaking. These timings are most relevant when using non turn-taking
2389
- * transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
2390
- * behavior is controlled by the transcription end-of-turn settings under
2391
- * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
2392
- * `eager_eot_threshold`).
2393
- */
2394
- export interface InterruptionSettings {
2395
- /**
2396
- * When true, disables user interruptions while the assistant greeting is playing.
2397
- */
2398
- disable_greeting_interruption?: boolean;
2399
-
2400
- /**
2401
- * Whether users can interrupt the assistant while it is speaking.
2402
- */
2403
- enable?: boolean;
2404
-
2405
- /**
2406
- * Controls when the assistant starts speaking after the user stops. These
2407
- * thresholds primarily apply to non turn-taking transcription models. For
2408
- * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
2409
- * transcription end-of-turn settings under `transcription.settings` instead.
2410
- */
2411
- start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
2412
- }
2413
-
2414
- export namespace InterruptionSettings {
2415
- /**
2416
- * Controls when the assistant starts speaking after the user stops. These
2417
- * thresholds primarily apply to non turn-taking transcription models. For
2418
- * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
2419
- * transcription end-of-turn settings under `transcription.settings` instead.
2420
- */
2421
- export interface StartSpeakingPlan {
2422
- /**
2423
- * Endpointing thresholds used to decide when the user has finished speaking.
2424
- * Applies to non turn-taking transcription models. For `deepgram/flux`, use
2425
- * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
2426
- * `eager_eot_threshold`.
2427
- */
2428
- transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
2429
-
2430
- /**
2431
- * Minimum seconds to wait before the assistant starts speaking.
2432
- */
2433
- wait_seconds?: number;
2434
- }
2435
-
2436
- export namespace StartSpeakingPlan {
2437
- /**
2438
- * Endpointing thresholds used to decide when the user has finished speaking.
2439
- * Applies to non turn-taking transcription models. For `deepgram/flux`, use
2440
- * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
2441
- * `eager_eot_threshold`.
2442
- */
2443
- export interface TranscriptionEndpointingPlan {
2444
- /**
2445
- * Seconds to wait after the transcript ends without punctuation.
2446
- */
2447
- on_no_punctuation_seconds?: number;
2448
-
2449
- /**
2450
- * Seconds to wait after the transcript ends with a number.
2451
- */
2452
- on_number_seconds?: number;
2453
-
2454
- /**
2455
- * Seconds to wait after the transcript ends with punctuation.
2456
- */
2457
- on_punctuation_seconds?: number;
2458
- }
2459
- }
2460
- }
2461
-
2462
- /**
2463
- * Reference to an MCP server attached to an assistant. Create and manage MCP
2464
- * servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
2465
- * ID.
2466
- */
2467
- export interface McpServer {
2468
- /**
2469
- * ID of the MCP server to attach. This must be the `id` of an MCP server returned
2470
- * by the `/ai/mcp_servers` endpoints.
2471
- */
2472
- id: string;
2473
-
2474
- /**
2475
- * Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
2476
- * uses the MCP server's configured `allowed_tools`.
2477
- */
2478
- allowed_tools?: Array<string>;
2479
- }
2480
- }
2481
-
2482
2392
  export interface AssistantRetrieveParams {
2483
2393
  call_control_id?: string;
2484
2394
 
@@ -2547,7 +2457,7 @@ export interface AssistantUpdateParams {
2547
2457
  * `/ai/integrations/connections`. Each item references a catalog integration by
2548
2458
  * `integration_id`.
2549
2459
  */
2550
- integrations?: Array<AssistantUpdateParams.Integration>;
2460
+ integrations?: Array<AssistantIntegration>;
2551
2461
 
2552
2462
  /**
2553
2463
  * Settings for interruptions and how the assistant decides the user has finished
@@ -2557,7 +2467,7 @@ export interface AssistantUpdateParams {
2557
2467
  * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
2558
2468
  * `eager_eot_threshold`).
2559
2469
  */
2560
- interruption_settings?: AssistantUpdateParams.InterruptionSettings;
2470
+ interruption_settings?: InferenceEmbeddingInterruptionSettings;
2561
2471
 
2562
2472
  /**
2563
2473
  * This is only needed when using third-party inference providers selected by
@@ -2573,7 +2483,7 @@ export interface AssistantUpdateParams {
2573
2483
  * MCP servers attached to the assistant. Create MCP servers with
2574
2484
  * `/ai/mcp_servers`, then reference them by `id` here.
2575
2485
  */
2576
- mcp_servers?: Array<AssistantUpdateParams.McpServer>;
2486
+ mcp_servers?: Array<AssistantMcpServer>;
2577
2487
 
2578
2488
  messaging_settings?: MessagingSettings;
2579
2489
 
@@ -2644,125 +2554,6 @@ export interface AssistantUpdateParams {
2644
2554
  widget_settings?: WidgetSettings;
2645
2555
  }
2646
2556
 
2647
- export namespace AssistantUpdateParams {
2648
- /**
2649
- * Reference to a connected integration attached to an assistant. Discover
2650
- * available integrations with `/ai/integrations` and connected integrations with
2651
- * `/ai/integrations/connections`.
2652
- */
2653
- export interface Integration {
2654
- /**
2655
- * Catalog integration ID to attach. This is the `id` from the integrations catalog
2656
- * at `/ai/integrations` (the same value also appears as `integration_id` on
2657
- * entries returned by `/ai/integrations/connections`). It is **not** the
2658
- * connection-level `id` from `/ai/integrations/connections`.
2659
- */
2660
- integration_id: string;
2661
-
2662
- /**
2663
- * Optional per-assistant allowlist of integration tool names. When omitted or
2664
- * empty, all tools allowed by the connected integration are available to the
2665
- * assistant.
2666
- */
2667
- allowed_list?: Array<string>;
2668
- }
2669
-
2670
- /**
2671
- * Settings for interruptions and how the assistant decides the user has finished
2672
- * speaking. These timings are most relevant when using non turn-taking
2673
- * transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
2674
- * behavior is controlled by the transcription end-of-turn settings under
2675
- * `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
2676
- * `eager_eot_threshold`).
2677
- */
2678
- export interface InterruptionSettings {
2679
- /**
2680
- * When true, disables user interruptions while the assistant greeting is playing.
2681
- */
2682
- disable_greeting_interruption?: boolean;
2683
-
2684
- /**
2685
- * Whether users can interrupt the assistant while it is speaking.
2686
- */
2687
- enable?: boolean;
2688
-
2689
- /**
2690
- * Controls when the assistant starts speaking after the user stops. These
2691
- * thresholds primarily apply to non turn-taking transcription models. For
2692
- * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
2693
- * transcription end-of-turn settings under `transcription.settings` instead.
2694
- */
2695
- start_speaking_plan?: InterruptionSettings.StartSpeakingPlan;
2696
- }
2697
-
2698
- export namespace InterruptionSettings {
2699
- /**
2700
- * Controls when the assistant starts speaking after the user stops. These
2701
- * thresholds primarily apply to non turn-taking transcription models. For
2702
- * turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
2703
- * transcription end-of-turn settings under `transcription.settings` instead.
2704
- */
2705
- export interface StartSpeakingPlan {
2706
- /**
2707
- * Endpointing thresholds used to decide when the user has finished speaking.
2708
- * Applies to non turn-taking transcription models. For `deepgram/flux`, use
2709
- * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
2710
- * `eager_eot_threshold`.
2711
- */
2712
- transcription_endpointing_plan?: StartSpeakingPlan.TranscriptionEndpointingPlan;
2713
-
2714
- /**
2715
- * Minimum seconds to wait before the assistant starts speaking.
2716
- */
2717
- wait_seconds?: number;
2718
- }
2719
-
2720
- export namespace StartSpeakingPlan {
2721
- /**
2722
- * Endpointing thresholds used to decide when the user has finished speaking.
2723
- * Applies to non turn-taking transcription models. For `deepgram/flux`, use
2724
- * `transcription.settings.eot_threshold` / `eot_timeout_ms` /
2725
- * `eager_eot_threshold`.
2726
- */
2727
- export interface TranscriptionEndpointingPlan {
2728
- /**
2729
- * Seconds to wait after the transcript ends without punctuation.
2730
- */
2731
- on_no_punctuation_seconds?: number;
2732
-
2733
- /**
2734
- * Seconds to wait after the transcript ends with a number.
2735
- */
2736
- on_number_seconds?: number;
2737
-
2738
- /**
2739
- * Seconds to wait after the transcript ends with punctuation.
2740
- */
2741
- on_punctuation_seconds?: number;
2742
- }
2743
- }
2744
- }
2745
-
2746
- /**
2747
- * Reference to an MCP server attached to an assistant. Create and manage MCP
2748
- * servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
2749
- * ID.
2750
- */
2751
- export interface McpServer {
2752
- /**
2753
- * ID of the MCP server to attach. This must be the `id` of an MCP server returned
2754
- * by the `/ai/mcp_servers` endpoints.
2755
- */
2756
- id: string;
2757
-
2758
- /**
2759
- * Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
2760
- * uses the MCP server's configured `allowed_tools`.
2761
- */
2762
- allowed_tools?: Array<string>;
2763
- }
2764
- }
2765
-
2766
2557
  export interface AssistantChatParams {
2767
2558
  /**
2768
2559
  * The message content sent by the client to the assistant
@@ -2822,6 +2613,8 @@ Assistants.Tags = Tags;
2822
2613
  export declare namespace Assistants {
2823
2614
  export {
2824
2615
  type Assistant as Assistant,
2616
+ type AssistantIntegration as AssistantIntegration,
2617
+ type AssistantMcpServer as AssistantMcpServer,
2825
2618
  type AssistantTool as AssistantTool,
2826
2619
  type AssistantsList as AssistantsList,
2827
2620
  type AudioVisualizerConfig as AudioVisualizerConfig,
@@ -2834,6 +2627,7 @@ export declare namespace Assistants {
2834
2627
  type HangupToolParams as HangupToolParams,
2835
2628
  type ImportMetadata as ImportMetadata,
2836
2629
  type InferenceEmbedding as InferenceEmbedding,
2630
+ type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings,
2837
2631
  type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams,
2838
2632
  type InsightSettings as InsightSettings,
2839
2633
  type MessagingSettings as MessagingSettings,
@@ -2843,7 +2637,9 @@ export declare namespace Assistants {
2843
2637
  type PostConversationSettingsReq as PostConversationSettingsReq,
2844
2638
  type PrivacySettings as PrivacySettings,
2845
2639
  type RetrievalTool as RetrievalTool,
2640
+ type StartSpeakingPlan as StartSpeakingPlan,
2846
2641
  type TelephonySettings as TelephonySettings,
2642
+ type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan,
2847
2643
  type TranscriptionSettings as TranscriptionSettings,
2848
2644
  type TranscriptionSettingsConfig as TranscriptionSettingsConfig,
2849
2645
  type TransferTool as TransferTool,
@@ -2876,6 +2672,11 @@ export declare namespace Assistants {
2876
2672
  CanaryDeploys as CanaryDeploys,
2877
2673
  type CanaryDeploy as CanaryDeploy,
2878
2674
  type CanaryDeployResponse as CanaryDeployResponse,
2675
+ type Clause as Clause,
2676
+ type RolloutSlot as RolloutSlot,
2677
+ type RuleInput as RuleInput,
2678
+ type RuleOutput as RuleOutput,
2679
+ type Serve as Serve,
2879
2680
  type CanaryDeployCreateParams as CanaryDeployCreateParams,
2880
2681
  type CanaryDeployUpdateParams as CanaryDeployUpdateParams,
2881
2682
  };