telnyx 7.17.0 → 7.19.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 (260) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/client.d.mts +5 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +5 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -0
  9. package/client.mjs.map +1 -1
  10. package/lib/webhooks.d.mts +1 -1
  11. package/lib/webhooks.d.mts.map +1 -1
  12. package/lib/webhooks.d.ts +1 -1
  13. package/lib/webhooks.d.ts.map +1 -1
  14. package/lib/webhooks.js +74 -39
  15. package/lib/webhooks.js.map +1 -1
  16. package/lib/webhooks.mjs +52 -17
  17. package/lib/webhooks.mjs.map +1 -1
  18. package/package.json +1 -1
  19. package/resources/ai/ai.d.mts +6 -2
  20. package/resources/ai/ai.d.mts.map +1 -1
  21. package/resources/ai/ai.d.ts +6 -2
  22. package/resources/ai/ai.d.ts.map +1 -1
  23. package/resources/ai/ai.js +4 -0
  24. package/resources/ai/ai.js.map +1 -1
  25. package/resources/ai/ai.mjs +4 -0
  26. package/resources/ai/ai.mjs.map +1 -1
  27. package/resources/ai/anthropic/v1.d.mts +4 -3
  28. package/resources/ai/anthropic/v1.d.mts.map +1 -1
  29. package/resources/ai/anthropic/v1.d.ts +4 -3
  30. package/resources/ai/anthropic/v1.d.ts.map +1 -1
  31. package/resources/ai/anthropic/v1.js +1 -1
  32. package/resources/ai/anthropic/v1.mjs +1 -1
  33. package/resources/ai/assistants/assistants.d.mts +124 -18
  34. package/resources/ai/assistants/assistants.d.mts.map +1 -1
  35. package/resources/ai/assistants/assistants.d.ts +124 -18
  36. package/resources/ai/assistants/assistants.d.ts.map +1 -1
  37. package/resources/ai/assistants/assistants.js.map +1 -1
  38. package/resources/ai/assistants/assistants.mjs.map +1 -1
  39. package/resources/ai/chat.d.mts +8 -0
  40. package/resources/ai/chat.d.mts.map +1 -1
  41. package/resources/ai/chat.d.ts +8 -0
  42. package/resources/ai/chat.d.ts.map +1 -1
  43. package/resources/ai/collections/collections.d.mts +1 -102
  44. package/resources/ai/collections/collections.d.mts.map +1 -1
  45. package/resources/ai/collections/collections.d.ts +1 -102
  46. package/resources/ai/collections/collections.d.ts.map +1 -1
  47. package/resources/ai/collections/collections.js +0 -44
  48. package/resources/ai/collections/collections.js.map +1 -1
  49. package/resources/ai/collections/collections.mjs +0 -44
  50. package/resources/ai/collections/collections.mjs.map +1 -1
  51. package/resources/ai/collections/index.d.mts +1 -1
  52. package/resources/ai/collections/index.d.mts.map +1 -1
  53. package/resources/ai/collections/index.d.ts +1 -1
  54. package/resources/ai/collections/index.d.ts.map +1 -1
  55. package/resources/ai/collections/index.js.map +1 -1
  56. package/resources/ai/collections/index.mjs.map +1 -1
  57. package/resources/ai/collections/settings.d.mts +4 -1
  58. package/resources/ai/collections/settings.d.mts.map +1 -1
  59. package/resources/ai/collections/settings.d.ts +4 -1
  60. package/resources/ai/collections/settings.d.ts.map +1 -1
  61. package/resources/ai/index.d.mts +2 -1
  62. package/resources/ai/index.d.mts.map +1 -1
  63. package/resources/ai/index.d.ts +2 -1
  64. package/resources/ai/index.d.ts.map +1 -1
  65. package/resources/ai/index.js +7 -5
  66. package/resources/ai/index.js.map +1 -1
  67. package/resources/ai/index.mjs +1 -0
  68. package/resources/ai/index.mjs.map +1 -1
  69. package/resources/ai/knowledge/collections.d.mts +140 -0
  70. package/resources/ai/knowledge/collections.d.mts.map +1 -0
  71. package/resources/ai/knowledge/collections.d.ts +140 -0
  72. package/resources/ai/knowledge/collections.d.ts.map +1 -0
  73. package/resources/ai/knowledge/collections.js +58 -0
  74. package/resources/ai/knowledge/collections.js.map +1 -0
  75. package/resources/ai/knowledge/collections.mjs +54 -0
  76. package/resources/ai/knowledge/collections.mjs.map +1 -0
  77. package/resources/ai/knowledge/index.d.mts +3 -0
  78. package/resources/ai/knowledge/index.d.mts.map +1 -0
  79. package/resources/ai/knowledge/index.d.ts +3 -0
  80. package/resources/ai/knowledge/index.d.ts.map +1 -0
  81. package/resources/ai/knowledge/index.js +9 -0
  82. package/resources/ai/knowledge/index.js.map +1 -0
  83. package/resources/ai/knowledge/index.mjs +4 -0
  84. package/resources/ai/knowledge/index.mjs.map +1 -0
  85. package/resources/ai/knowledge/knowledge.d.mts +10 -0
  86. package/resources/ai/knowledge/knowledge.d.mts.map +1 -0
  87. package/resources/ai/knowledge/knowledge.d.ts +10 -0
  88. package/resources/ai/knowledge/knowledge.d.ts.map +1 -0
  89. package/resources/ai/knowledge/knowledge.js +17 -0
  90. package/resources/ai/knowledge/knowledge.js.map +1 -0
  91. package/resources/ai/knowledge/knowledge.mjs +12 -0
  92. package/resources/ai/knowledge/knowledge.mjs.map +1 -0
  93. package/resources/ai/knowledge.d.mts +2 -0
  94. package/resources/ai/knowledge.d.mts.map +1 -0
  95. package/resources/ai/knowledge.d.ts +2 -0
  96. package/resources/ai/knowledge.d.ts.map +1 -0
  97. package/resources/ai/knowledge.js +6 -0
  98. package/resources/ai/knowledge.js.map +1 -0
  99. package/resources/ai/knowledge.mjs +3 -0
  100. package/resources/ai/knowledge.mjs.map +1 -0
  101. package/resources/ai/openai/chat.d.mts +8 -0
  102. package/resources/ai/openai/chat.d.mts.map +1 -1
  103. package/resources/ai/openai/chat.d.ts +8 -0
  104. package/resources/ai/openai/chat.d.ts.map +1 -1
  105. package/resources/ai/openai/openai.d.mts +10 -0
  106. package/resources/ai/openai/openai.d.mts.map +1 -1
  107. package/resources/ai/openai/openai.d.ts +10 -0
  108. package/resources/ai/openai/openai.d.ts.map +1 -1
  109. package/resources/ai/openai/openai.js.map +1 -1
  110. package/resources/ai/openai/openai.mjs.map +1 -1
  111. package/resources/calls/actions.d.mts +35 -12
  112. package/resources/calls/actions.d.mts.map +1 -1
  113. package/resources/calls/actions.d.ts +35 -12
  114. package/resources/calls/actions.d.ts.map +1 -1
  115. package/resources/calls/calls.d.mts +2 -2
  116. package/resources/calls/calls.d.mts.map +1 -1
  117. package/resources/calls/calls.d.ts +2 -2
  118. package/resources/calls/calls.d.ts.map +1 -1
  119. package/resources/calls/calls.js.map +1 -1
  120. package/resources/calls/calls.mjs.map +1 -1
  121. package/resources/calls/index.d.mts +1 -1
  122. package/resources/calls/index.d.mts.map +1 -1
  123. package/resources/calls/index.d.ts +1 -1
  124. package/resources/calls/index.d.ts.map +1 -1
  125. package/resources/calls/index.js.map +1 -1
  126. package/resources/calls/index.mjs.map +1 -1
  127. package/resources/conferences/actions.d.mts +3 -1
  128. package/resources/conferences/actions.d.mts.map +1 -1
  129. package/resources/conferences/actions.d.ts +3 -1
  130. package/resources/conferences/actions.d.ts.map +1 -1
  131. package/resources/credential-connections/credential-connections.d.mts +2 -2
  132. package/resources/credential-connections/credential-connections.d.ts +2 -2
  133. package/resources/external-requirements/external-requirements.d.mts +10 -0
  134. package/resources/external-requirements/external-requirements.d.mts.map +1 -0
  135. package/resources/external-requirements/external-requirements.d.ts +10 -0
  136. package/resources/external-requirements/external-requirements.d.ts.map +1 -0
  137. package/resources/external-requirements/external-requirements.js +17 -0
  138. package/resources/external-requirements/external-requirements.js.map +1 -0
  139. package/resources/external-requirements/external-requirements.mjs +12 -0
  140. package/resources/external-requirements/external-requirements.mjs.map +1 -0
  141. package/resources/external-requirements/index.d.mts +3 -0
  142. package/resources/external-requirements/index.d.mts.map +1 -0
  143. package/resources/external-requirements/index.d.ts +3 -0
  144. package/resources/external-requirements/index.d.ts.map +1 -0
  145. package/resources/external-requirements/index.js +9 -0
  146. package/resources/external-requirements/index.js.map +1 -0
  147. package/resources/external-requirements/index.mjs +4 -0
  148. package/resources/external-requirements/index.mjs.map +1 -0
  149. package/resources/external-requirements/sub-number-orders.d.mts +151 -0
  150. package/resources/external-requirements/sub-number-orders.d.mts.map +1 -0
  151. package/resources/external-requirements/sub-number-orders.d.ts +151 -0
  152. package/resources/external-requirements/sub-number-orders.d.ts.map +1 -0
  153. package/resources/external-requirements/sub-number-orders.js +61 -0
  154. package/resources/external-requirements/sub-number-orders.js.map +1 -0
  155. package/resources/external-requirements/sub-number-orders.mjs +57 -0
  156. package/resources/external-requirements/sub-number-orders.mjs.map +1 -0
  157. package/resources/external-requirements.d.mts +2 -0
  158. package/resources/external-requirements.d.mts.map +1 -0
  159. package/resources/external-requirements.d.ts +2 -0
  160. package/resources/external-requirements.d.ts.map +1 -0
  161. package/resources/external-requirements.js +6 -0
  162. package/resources/external-requirements.js.map +1 -0
  163. package/resources/external-requirements.mjs +3 -0
  164. package/resources/external-requirements.mjs.map +1 -0
  165. package/resources/index.d.mts +2 -1
  166. package/resources/index.d.mts.map +1 -1
  167. package/resources/index.d.ts +2 -1
  168. package/resources/index.d.ts.map +1 -1
  169. package/resources/index.js +6 -4
  170. package/resources/index.js.map +1 -1
  171. package/resources/index.mjs +1 -0
  172. package/resources/index.mjs.map +1 -1
  173. package/resources/outbound-voice-profiles.d.mts +30 -30
  174. package/resources/outbound-voice-profiles.d.ts +30 -30
  175. package/resources/phone-numbers/jobs.d.mts +21 -4
  176. package/resources/phone-numbers/jobs.d.mts.map +1 -1
  177. package/resources/phone-numbers/jobs.d.ts +21 -4
  178. package/resources/phone-numbers/jobs.d.ts.map +1 -1
  179. package/resources/phone-numbers/jobs.js +4 -2
  180. package/resources/phone-numbers/jobs.js.map +1 -1
  181. package/resources/phone-numbers/jobs.mjs +4 -2
  182. package/resources/phone-numbers/jobs.mjs.map +1 -1
  183. package/resources/sim-card-groups/actions.d.mts +10 -4
  184. package/resources/sim-card-groups/actions.d.mts.map +1 -1
  185. package/resources/sim-card-groups/actions.d.ts +10 -4
  186. package/resources/sim-card-groups/actions.d.ts.map +1 -1
  187. package/resources/sim-card-groups/actions.js +6 -4
  188. package/resources/sim-card-groups/actions.js.map +1 -1
  189. package/resources/sim-card-groups/actions.mjs +6 -4
  190. package/resources/sim-card-groups/actions.mjs.map +1 -1
  191. package/resources/speech-to-text/speech-to-text.d.mts +20 -10
  192. package/resources/speech-to-text/speech-to-text.d.mts.map +1 -1
  193. package/resources/speech-to-text/speech-to-text.d.ts +20 -10
  194. package/resources/speech-to-text/speech-to-text.d.ts.map +1 -1
  195. package/resources/speech-to-text/speech-to-text.js +3 -2
  196. package/resources/speech-to-text/speech-to-text.js.map +1 -1
  197. package/resources/speech-to-text/speech-to-text.mjs +3 -2
  198. package/resources/speech-to-text/speech-to-text.mjs.map +1 -1
  199. package/resources/webhooks.d.mts +4 -3
  200. package/resources/webhooks.d.mts.map +1 -1
  201. package/resources/webhooks.d.ts +4 -3
  202. package/resources/webhooks.d.ts.map +1 -1
  203. package/resources/webhooks.js +4 -11
  204. package/resources/webhooks.js.map +1 -1
  205. package/resources/webhooks.mjs +4 -11
  206. package/resources/webhooks.mjs.map +1 -1
  207. package/resources/wireless-blocklist-values.d.mts +6 -19
  208. package/resources/wireless-blocklist-values.d.mts.map +1 -1
  209. package/resources/wireless-blocklist-values.d.ts +6 -19
  210. package/resources/wireless-blocklist-values.d.ts.map +1 -1
  211. package/resources/wireless-blocklist-values.js +2 -1
  212. package/resources/wireless-blocklist-values.js.map +1 -1
  213. package/resources/wireless-blocklist-values.mjs +2 -1
  214. package/resources/wireless-blocklist-values.mjs.map +1 -1
  215. package/resources/wireless-blocklists.d.mts +40 -20
  216. package/resources/wireless-blocklists.d.mts.map +1 -1
  217. package/resources/wireless-blocklists.d.ts +40 -20
  218. package/resources/wireless-blocklists.d.ts.map +1 -1
  219. package/resources/wireless-blocklists.js +12 -7
  220. package/resources/wireless-blocklists.js.map +1 -1
  221. package/resources/wireless-blocklists.mjs +12 -7
  222. package/resources/wireless-blocklists.mjs.map +1 -1
  223. package/src/client.ts +9 -4
  224. package/src/lib/webhooks.ts +59 -18
  225. package/src/resources/ai/ai.ts +6 -6
  226. package/src/resources/ai/anthropic/v1.ts +4 -3
  227. package/src/resources/ai/assistants/assistants.ts +130 -17
  228. package/src/resources/ai/chat.ts +9 -0
  229. package/src/resources/ai/collections/collections.ts +0 -134
  230. package/src/resources/ai/collections/index.ts +0 -3
  231. package/src/resources/ai/collections/settings.ts +4 -1
  232. package/src/resources/ai/index.ts +1 -3
  233. package/src/resources/ai/knowledge/collections.ts +179 -0
  234. package/src/resources/ai/knowledge/index.ts +8 -0
  235. package/src/resources/ai/knowledge/knowledge.ts +23 -0
  236. package/src/resources/ai/knowledge.ts +3 -0
  237. package/src/resources/ai/openai/chat.ts +9 -0
  238. package/src/resources/ai/openai/openai.ts +12 -0
  239. package/src/resources/calls/actions.ts +38 -6
  240. package/src/resources/calls/calls.ts +2 -0
  241. package/src/resources/calls/index.ts +1 -0
  242. package/src/resources/conferences/actions.ts +3 -1
  243. package/src/resources/credential-connections/credential-connections.ts +2 -2
  244. package/src/resources/external-requirements/external-requirements.ts +27 -0
  245. package/src/resources/external-requirements/index.ts +10 -0
  246. package/src/resources/external-requirements/sub-number-orders.ts +202 -0
  247. package/src/resources/external-requirements.ts +3 -0
  248. package/src/resources/index.ts +3 -2
  249. package/src/resources/outbound-voice-profiles.ts +30 -30
  250. package/src/resources/phone-numbers/jobs.ts +23 -4
  251. package/src/resources/sim-card-groups/actions.ts +11 -4
  252. package/src/resources/speech-to-text/speech-to-text.ts +23 -9
  253. package/src/resources/webhooks.ts +8 -13
  254. package/src/resources/wireless-blocklist-values.ts +6 -23
  255. package/src/resources/wireless-blocklists.ts +54 -25
  256. package/src/version.ts +1 -1
  257. package/version.d.mts +1 -1
  258. package/version.d.ts +1 -1
  259. package/version.js +1 -1
  260. package/version.mjs +1 -1
@@ -0,0 +1,23 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as CollectionsAPI from './collections';
5
+ import {
6
+ CollectionRetrieveDocumentsParams,
7
+ CollectionRetrieveDocumentsResponse,
8
+ Collections,
9
+ } from './collections';
10
+
11
+ export class Knowledge extends APIResource {
12
+ collections: CollectionsAPI.Collections = new CollectionsAPI.Collections(this._client);
13
+ }
14
+
15
+ Knowledge.Collections = Collections;
16
+
17
+ export declare namespace Knowledge {
18
+ export {
19
+ Collections as Collections,
20
+ type CollectionRetrieveDocumentsResponse as CollectionRetrieveDocumentsResponse,
21
+ type CollectionRetrieveDocumentsParams as CollectionRetrieveDocumentsParams,
22
+ };
23
+ }
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export * from './knowledge/index';
@@ -130,6 +130,15 @@ export interface ChatCreateCompletionParams {
130
130
  */
131
131
  presence_penalty?: number;
132
132
 
133
+ /**
134
+ * Controls the reasoning effort for models that support it. When set, the model
135
+ * spends more or less compute on internal reasoning before generating its
136
+ * response. Supported values: none, minimal, low, medium, high, xhigh, max. Not
137
+ * all models support all values; unsupported values are rejected with a 400 error.
138
+ * When omitted, reasoning models use their default effort level.
139
+ */
140
+ reasoning_effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max';
141
+
133
142
  /**
134
143
  * Use this is you want to guarantee a JSON output without defining a schema. For
135
144
  * control over the schema, use `guided_json`.
@@ -127,6 +127,8 @@ export interface OpenAICreateResponseParams {
127
127
  */
128
128
  model?: string;
129
129
 
130
+ reasoning?: OpenAICreateResponseParams.Reasoning;
131
+
130
132
  /**
131
133
  * The service tier to use for this request. Supported values vary by model; use
132
134
  * `GET /v2/ai/openai/models` and inspect the model's `service_tiers` field. If
@@ -143,6 +145,16 @@ export interface OpenAICreateResponseParams {
143
145
  [k: string]: unknown;
144
146
  }
145
147
 
148
+ export namespace OpenAICreateResponseParams {
149
+ export interface Reasoning {
150
+ /**
151
+ * Controls the reasoning effort for models that support it. Same values and
152
+ * semantics as reasoning_effort on Chat Completions.
153
+ */
154
+ effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max';
155
+ }
156
+ }
157
+
146
158
  OpenAI.Embeddings = Embeddings;
147
159
  OpenAI.Chat = Chat;
148
160
 
@@ -1689,7 +1689,9 @@ export interface TranscriptionConfig {
1689
1689
  * `auto` when `language` is omitted — omitting it applies `en` instead. For
1690
1690
  * `reson8/turns`, supported values are `auto` (or unset) for automatic language
1691
1691
  * detection, and the language codes `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`,
1692
- * `pt`, `es`, and `sv` to fix the transcription language.
1692
+ * `pt`, `es`, and `sv` to fix the transcription language. For `cohere/ar-stt`,
1693
+ * supported values are `ar` and `en`; unlike other models, this model does not
1694
+ * auto-detect and defaults to `ar` when `language` is omitted.
1693
1695
  */
1694
1696
  language?: string;
1695
1697
 
@@ -1711,6 +1713,7 @@ export interface TranscriptionConfig {
1711
1713
  * Arabic/English code-switching support.
1712
1714
  * - `reson8/turns` for live streaming turn-based transcription of 10 European
1713
1715
  * languages with automatic language detection.
1716
+ * - `cohere/ar-stt` for non-streaming Arabic and English transcription.
1714
1717
  * - `azure/fast` and `azure/realtime`; Azure models require `region`, and
1715
1718
  * unsupported regions require `api_key_ref`.
1716
1719
  * - `google/latest_long` for non-streaming multilingual transcription.
@@ -1732,6 +1735,7 @@ export interface TranscriptionConfig {
1732
1735
  | 'nvidia/parakeet-v3'
1733
1736
  | 'humain/realtime'
1734
1737
  | 'reson8/turns'
1738
+ | 'cohere/ar-stt'
1735
1739
  | 'azure/fast'
1736
1740
  | 'azure/realtime'
1737
1741
  | 'google/latest_long'
@@ -1951,6 +1955,24 @@ export interface TranscriptionEngineBConfig {
1951
1955
  transcription_model?: 'openai/whisper-tiny' | 'openai/whisper-large-v3-turbo';
1952
1956
  }
1953
1957
 
1958
+ export interface TranscriptionEngineCohereConfig {
1959
+ /**
1960
+ * The language of the audio to be transcribed. Unlike other self-hosted models,
1961
+ * Cohere does not auto-detect the language; `auto` is not supported.
1962
+ */
1963
+ language?: 'ar' | 'en';
1964
+
1965
+ /**
1966
+ * Engine identifier for Cohere transcription service
1967
+ */
1968
+ transcription_engine?: 'Cohere';
1969
+
1970
+ /**
1971
+ * The model to use for transcription.
1972
+ */
1973
+ transcription_model?: 'cohere/ar-stt';
1974
+ }
1975
+
1954
1976
  export type TranscriptionEngineDeepgramConfig = DeepgramNova2Config | DeepgramNova3Config;
1955
1977
 
1956
1978
  export interface TranscriptionEngineGoogleConfig {
@@ -2254,6 +2276,7 @@ export interface TranscriptionStartRequest {
2254
2276
  | 'Parakeet'
2255
2277
  | 'Humain'
2256
2278
  | 'Reson8'
2279
+ | 'Cohere'
2257
2280
  | 'A'
2258
2281
  | 'B';
2259
2282
 
@@ -2268,6 +2291,7 @@ export interface TranscriptionStartRequest {
2268
2291
  | TranscriptionEngineParakeetConfig
2269
2292
  | TranscriptionEngineHumainConfig
2270
2293
  | TranscriptionEngineReson8Config
2294
+ | TranscriptionEngineCohereConfig
2271
2295
  | TranscriptionEngineAConfig
2272
2296
  | TranscriptionEngineBConfig
2273
2297
  | DeepgramNova2Config
@@ -2532,8 +2556,10 @@ export interface ActionStartAIAssistantParams {
2532
2556
  participants?: Array<AIAssistantJoinParticipant>;
2533
2557
 
2534
2558
  /**
2535
- * When `true`, a webhook is sent each time the conversation message history is
2536
- * updated.
2559
+ * When `true`, a `call.ai_gather.message_history_updated` webhook carrying the
2560
+ * full message history is sent each time the conversation message history is
2561
+ * updated. The assistant's own `telephony_settings.send_message_history_updates`
2562
+ * overrides this value when it is set.
2537
2563
  */
2538
2564
  send_message_history_updates?: boolean;
2539
2565
 
@@ -3099,7 +3125,8 @@ export interface ActionGatherParams {
3099
3125
 
3100
3126
  /**
3101
3127
  * The digit used to terminate input if fewer than `maximum_digits` digits have
3102
- * been gathered.
3128
+ * been gathered. Set to an empty string to disable the terminating digit entirely,
3129
+ * so that a digit such as `#` can be collected as input per `valid_digits`.
3103
3130
  */
3104
3131
  terminating_digit?: string;
3105
3132
 
@@ -3344,7 +3371,8 @@ export interface ActionGatherUsingAudioParams {
3344
3371
 
3345
3372
  /**
3346
3373
  * The digit used to terminate input if fewer than `maximum_digits` digits have
3347
- * been gathered.
3374
+ * been gathered. Set to an empty string to disable the terminating digit entirely,
3375
+ * so that a digit such as `#` can be collected as input per `valid_digits`.
3348
3376
  */
3349
3377
  terminating_digit?: string;
3350
3378
 
@@ -3513,7 +3541,8 @@ export interface ActionGatherUsingSpeakParams {
3513
3541
 
3514
3542
  /**
3515
3543
  * The digit used to terminate input if fewer than `maximum_digits` digits have
3516
- * been gathered.
3544
+ * been gathered. Set to an empty string to disable the terminating digit entirely,
3545
+ * so that a digit such as `#` can be collected as input per `valid_digits`.
3517
3546
  */
3518
3547
  terminating_digit?: string;
3519
3548
 
@@ -4656,6 +4685,7 @@ export interface ActionStartTranscriptionParams {
4656
4685
  | 'Parakeet'
4657
4686
  | 'Humain'
4658
4687
  | 'Reson8'
4688
+ | 'Cohere'
4659
4689
  | 'A'
4660
4690
  | 'B';
4661
4691
 
@@ -4670,6 +4700,7 @@ export interface ActionStartTranscriptionParams {
4670
4700
  | TranscriptionEngineParakeetConfig
4671
4701
  | TranscriptionEngineHumainConfig
4672
4702
  | TranscriptionEngineReson8Config
4703
+ | TranscriptionEngineCohereConfig
4673
4704
  | TranscriptionEngineAConfig
4674
4705
  | TranscriptionEngineBConfig
4675
4706
  | DeepgramNova2Config
@@ -5539,6 +5570,7 @@ export declare namespace Actions {
5539
5570
  type TranscriptionEngineAssemblyaiConfig as TranscriptionEngineAssemblyaiConfig,
5540
5571
  type TranscriptionEngineAzureConfig as TranscriptionEngineAzureConfig,
5541
5572
  type TranscriptionEngineBConfig as TranscriptionEngineBConfig,
5573
+ type TranscriptionEngineCohereConfig as TranscriptionEngineCohereConfig,
5542
5574
  type TranscriptionEngineDeepgramConfig as TranscriptionEngineDeepgramConfig,
5543
5575
  type TranscriptionEngineGoogleConfig as TranscriptionEngineGoogleConfig,
5544
5576
  type TranscriptionEngineHumainConfig as TranscriptionEngineHumainConfig,
@@ -111,6 +111,7 @@ import {
111
111
  TranscriptionEngineAssemblyaiConfig,
112
112
  TranscriptionEngineAzureConfig,
113
113
  TranscriptionEngineBConfig,
114
+ TranscriptionEngineCohereConfig,
114
115
  TranscriptionEngineDeepgramConfig,
115
116
  TranscriptionEngineGoogleConfig,
116
117
  TranscriptionEngineHumainConfig,
@@ -1555,6 +1556,7 @@ export declare namespace Calls {
1555
1556
  type TranscriptionEngineAssemblyaiConfig as TranscriptionEngineAssemblyaiConfig,
1556
1557
  type TranscriptionEngineAzureConfig as TranscriptionEngineAzureConfig,
1557
1558
  type TranscriptionEngineBConfig as TranscriptionEngineBConfig,
1559
+ type TranscriptionEngineCohereConfig as TranscriptionEngineCohereConfig,
1558
1560
  type TranscriptionEngineDeepgramConfig as TranscriptionEngineDeepgramConfig,
1559
1561
  type TranscriptionEngineGoogleConfig as TranscriptionEngineGoogleConfig,
1560
1562
  type TranscriptionEngineHumainConfig as TranscriptionEngineHumainConfig,
@@ -26,6 +26,7 @@ export {
26
26
  type TranscriptionEngineAssemblyaiConfig,
27
27
  type TranscriptionEngineAzureConfig,
28
28
  type TranscriptionEngineBConfig,
29
+ type TranscriptionEngineCohereConfig,
29
30
  type TranscriptionEngineDeepgramConfig,
30
31
  type TranscriptionEngineGoogleConfig,
31
32
  type TranscriptionEngineHumainConfig,
@@ -1041,7 +1041,9 @@ export interface ActionGatherDtmfAudioParams {
1041
1041
  stop_playback_on_dtmf?: boolean;
1042
1042
 
1043
1043
  /**
1044
- * Digit that terminates gathering.
1044
+ * Digit that terminates gathering. Set to an empty string to disable the
1045
+ * terminating digit entirely, so that a digit such as `#` can be collected as
1046
+ * input per `valid_digits`.
1045
1047
  */
1046
1048
  terminating_digit?: string;
1047
1049
 
@@ -130,8 +130,8 @@ export type ConnectionNoiseSuppression = 'inbound' | 'outbound' | 'both' | 'disa
130
130
 
131
131
  export interface ConnectionRtcpSettings {
132
132
  /**
133
- * BETA - Enable the capture and storage of RTCP messages to create QoS reports on
134
- * the Telnyx Mission Control Portal.
133
+ * Enable the capture and storage of RTCP messages to create QoS reports on the
134
+ * Telnyx Mission Control Portal.
135
135
  */
136
136
  capture_enabled?: boolean;
137
137
 
@@ -0,0 +1,27 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as SubNumberOrdersAPI from './sub-number-orders';
5
+ import {
6
+ SubNumberOrderRetrieveParams,
7
+ SubNumberOrderRetrieveResponse,
8
+ SubNumberOrderUpdateParams,
9
+ SubNumberOrderUpdateResponse,
10
+ SubNumberOrders,
11
+ } from './sub-number-orders';
12
+
13
+ export class ExternalRequirements extends APIResource {
14
+ subNumberOrders: SubNumberOrdersAPI.SubNumberOrders = new SubNumberOrdersAPI.SubNumberOrders(this._client);
15
+ }
16
+
17
+ ExternalRequirements.SubNumberOrders = SubNumberOrders;
18
+
19
+ export declare namespace ExternalRequirements {
20
+ export {
21
+ SubNumberOrders as SubNumberOrders,
22
+ type SubNumberOrderRetrieveResponse as SubNumberOrderRetrieveResponse,
23
+ type SubNumberOrderUpdateResponse as SubNumberOrderUpdateResponse,
24
+ type SubNumberOrderRetrieveParams as SubNumberOrderRetrieveParams,
25
+ type SubNumberOrderUpdateParams as SubNumberOrderUpdateParams,
26
+ };
27
+ }
@@ -0,0 +1,10 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export { ExternalRequirements } from './external-requirements';
4
+ export {
5
+ SubNumberOrders,
6
+ type SubNumberOrderRetrieveResponse,
7
+ type SubNumberOrderUpdateResponse,
8
+ type SubNumberOrderRetrieveParams,
9
+ type SubNumberOrderUpdateParams,
10
+ } from './sub-number-orders';
@@ -0,0 +1,202 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import { APIPromise } from '../../core/api-promise';
5
+ import { RequestOptions } from '../../internal/request-options';
6
+ import { path } from '../../internal/utils/path';
7
+
8
+ /**
9
+ * Requirement Groups
10
+ */
11
+ export class SubNumberOrders extends APIResource {
12
+ /**
13
+ * Returns the input fields an action requirement needs and the current requirement
14
+ * action for a sub number order. Action requirements are fulfilled by an external
15
+ * step rather than by uploading documents. Australia mobile ID verification is
16
+ * currently the only action requirement. Once a verification link has been
17
+ * generated, it is returned in `requirement_action.value`.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const subNumberOrder =
22
+ * await client.externalRequirements.subNumberOrders.retrieve(
23
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
24
+ * {
25
+ * regulatory_requirement_id:
26
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
27
+ * },
28
+ * );
29
+ * ```
30
+ */
31
+ retrieve(
32
+ subNumberOrderID: string,
33
+ params: SubNumberOrderRetrieveParams,
34
+ options?: RequestOptions,
35
+ ): APIPromise<SubNumberOrderRetrieveResponse> {
36
+ const { regulatory_requirement_id } = params;
37
+ return this._client.get(
38
+ path`/external_requirements/${regulatory_requirement_id}/sub_number_orders/${subNumberOrderID}`,
39
+ options,
40
+ );
41
+ }
42
+
43
+ /**
44
+ * Submits the end user's details to the external verification provider and returns
45
+ * the requirement action. Australia mobile ID verification is currently the only
46
+ * action requirement. It generates a unique Onfido verification link, returned in
47
+ * `requirement_action.value`, which you share with the end user. The end user's
48
+ * `first_name` and `last_name` must be nested inside a `requirement` object;
49
+ * sending them at the top level is rejected.
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * const subNumberOrder =
54
+ * await client.externalRequirements.subNumberOrders.update(
55
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
56
+ * {
57
+ * regulatory_requirement_id:
58
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
59
+ * requirement: { first_name: 'Jane', last_name: 'Doe' },
60
+ * },
61
+ * );
62
+ * ```
63
+ */
64
+ update(
65
+ subNumberOrderID: string,
66
+ params: SubNumberOrderUpdateParams,
67
+ options?: RequestOptions,
68
+ ): APIPromise<SubNumberOrderUpdateResponse> {
69
+ const { regulatory_requirement_id, ...body } = params;
70
+ return this._client.post(
71
+ path`/external_requirements/${regulatory_requirement_id}/sub_number_orders/${subNumberOrderID}`,
72
+ { body, ...options },
73
+ );
74
+ }
75
+ }
76
+
77
+ export interface SubNumberOrderRetrieveResponse {
78
+ data?: SubNumberOrderRetrieveResponse.Data;
79
+ }
80
+
81
+ export namespace SubNumberOrderRetrieveResponse {
82
+ export interface Data {
83
+ /**
84
+ * The fields the end user must provide to fulfill this requirement.
85
+ */
86
+ fields_required?: Array<Data.FieldsRequired>;
87
+
88
+ regulatory_requirement_id?: string;
89
+
90
+ requirement_action?: Data.RequirementAction;
91
+ }
92
+
93
+ export namespace Data {
94
+ export interface FieldsRequired {
95
+ description?: string;
96
+
97
+ /**
98
+ * The field name to send inside the `requirement` object on the POST.
99
+ */
100
+ name?: string;
101
+
102
+ type?: string;
103
+
104
+ /**
105
+ * The value already stored for this field, or null if not yet provided.
106
+ */
107
+ value?: string | null;
108
+ }
109
+
110
+ export interface RequirementAction {
111
+ /**
112
+ * The type of action the end user must complete.
113
+ */
114
+ type?: string;
115
+
116
+ /**
117
+ * The action value. For ID verification this is the verification link URL, or null
118
+ * until it has been generated.
119
+ */
120
+ value?: string | null;
121
+ }
122
+ }
123
+ }
124
+
125
+ export interface SubNumberOrderUpdateResponse {
126
+ data?: SubNumberOrderUpdateResponse.Data;
127
+ }
128
+
129
+ export namespace SubNumberOrderUpdateResponse {
130
+ export interface Data {
131
+ regulatory_requirement_id?: string;
132
+
133
+ requirement_action?: Data.RequirementAction;
134
+
135
+ sub_order_id?: string;
136
+ }
137
+
138
+ export namespace Data {
139
+ export interface RequirementAction {
140
+ type?: string;
141
+
142
+ /**
143
+ * For Australia mobile ID verification, the unique Onfido verification link to
144
+ * share with the end user.
145
+ */
146
+ value?: string | null;
147
+ }
148
+ }
149
+ }
150
+
151
+ export interface SubNumberOrderRetrieveParams {
152
+ /**
153
+ * The ID of the regulatory (action) requirement. For Australia mobile ID
154
+ * verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
155
+ */
156
+ regulatory_requirement_id: string;
157
+ }
158
+
159
+ export interface SubNumberOrderUpdateParams {
160
+ /**
161
+ * Path param: The ID of the regulatory (action) requirement. For Australia mobile
162
+ * ID verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
163
+ */
164
+ regulatory_requirement_id: string;
165
+
166
+ /**
167
+ * Body param: The end user's identity details for the action requirement.
168
+ * Australia mobile ID verification is currently the only action requirement. It
169
+ * requires `first_name` and `last_name`, the same fields the corresponding GET
170
+ * lists in `fields_required`.
171
+ */
172
+ requirement: SubNumberOrderUpdateParams.Requirement;
173
+ }
174
+
175
+ export namespace SubNumberOrderUpdateParams {
176
+ /**
177
+ * The end user's identity details for the action requirement. Australia mobile ID
178
+ * verification is currently the only action requirement. It requires `first_name`
179
+ * and `last_name`, the same fields the corresponding GET lists in
180
+ * `fields_required`.
181
+ */
182
+ export interface Requirement {
183
+ /**
184
+ * The end user's first name.
185
+ */
186
+ first_name: string;
187
+
188
+ /**
189
+ * The end user's last name.
190
+ */
191
+ last_name: string;
192
+ }
193
+ }
194
+
195
+ export declare namespace SubNumberOrders {
196
+ export {
197
+ type SubNumberOrderRetrieveResponse as SubNumberOrderRetrieveResponse,
198
+ type SubNumberOrderUpdateResponse as SubNumberOrderUpdateResponse,
199
+ type SubNumberOrderRetrieveParams as SubNumberOrderRetrieveParams,
200
+ type SubNumberOrderUpdateParams as SubNumberOrderUpdateParams,
201
+ };
202
+ }
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export * from './external-requirements/index';
@@ -459,6 +459,7 @@ export {
459
459
  type ExternalConnectionUpdateLocationParams,
460
460
  type ExternalConnectionsDefaultFlatPagination,
461
461
  } from './external-connections/external-connections';
462
+ export { ExternalRequirements } from './external-requirements/external-requirements';
462
463
  export {
463
464
  FaxApplications,
464
465
  type FaxApplication,
@@ -1746,13 +1747,13 @@ export {
1746
1747
  export {
1747
1748
  WirelessBlocklists,
1748
1749
  type WirelessBlocklist,
1750
+ type WirelessWirelessBlocklist,
1749
1751
  type WirelessBlocklistCreateResponse,
1750
1752
  type WirelessBlocklistRetrieveResponse,
1751
1753
  type WirelessBlocklistUpdateResponse,
1752
- type WirelessBlocklistDeleteResponse,
1753
1754
  type WirelessBlocklistListParams,
1754
1755
  type WirelessBlocklistUpdateParams,
1755
1756
  type WirelessBlocklistCreateParams,
1756
- type WirelessBlocklistsDefaultFlatPagination,
1757
+ type WirelessWirelessBlocklistsDefaultFlatPagination,
1757
1758
  } from './wireless-blocklists';
1758
1759
  export { X402 } from './x402/x402';
@@ -148,8 +148,8 @@ export interface OutboundVoiceProfile {
148
148
  call_recording?: OutboundCallRecording;
149
149
 
150
150
  /**
151
- * (BETA) Specifies the time window and call limits for calls made using this
152
- * outbound voice profile. Note that all times are UTC in 24-hour clock time.
151
+ * Specifies the time window and call limits for calls made using this outbound
152
+ * voice profile. Note that all times are UTC in 24-hour clock time.
153
153
  */
154
154
  calling_window?: OutboundVoiceProfile.CallingWindow;
155
155
 
@@ -228,25 +228,25 @@ export interface OutboundVoiceProfile {
228
228
 
229
229
  export namespace OutboundVoiceProfile {
230
230
  /**
231
- * (BETA) Specifies the time window and call limits for calls made using this
232
- * outbound voice profile. Note that all times are UTC in 24-hour clock time.
231
+ * Specifies the time window and call limits for calls made using this outbound
232
+ * voice profile. Note that all times are UTC in 24-hour clock time.
233
233
  */
234
234
  export interface CallingWindow {
235
235
  /**
236
- * (BETA) The maximum number of calls that can be initiated to a single called
237
- * party (CLD) within the calling window. A null value means no limit.
236
+ * The maximum number of calls that can be initiated to a single called party (CLD)
237
+ * within the calling window. A null value means no limit.
238
238
  */
239
239
  calls_per_cld?: number;
240
240
 
241
241
  /**
242
- * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
243
- * longer allowed to start.
242
+ * The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
243
+ * allowed to start.
244
244
  */
245
245
  end_time?: string;
246
246
 
247
247
  /**
248
- * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
249
- * allowed to start.
248
+ * The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
249
+ * start.
250
250
  */
251
251
  start_time?: string;
252
252
  }
@@ -361,8 +361,8 @@ export interface OutboundVoiceProfileCreateParams {
361
361
  call_recording?: OutboundCallRecording;
362
362
 
363
363
  /**
364
- * (BETA) Specifies the time window and call limits for calls made using this
365
- * outbound voice profile. Note that all times are UTC in 24-hour clock time.
364
+ * Specifies the time window and call limits for calls made using this outbound
365
+ * voice profile. Note that all times are UTC in 24-hour clock time.
366
366
  */
367
367
  calling_window?: OutboundVoiceProfileCreateParams.CallingWindow;
368
368
 
@@ -421,25 +421,25 @@ export interface OutboundVoiceProfileCreateParams {
421
421
 
422
422
  export namespace OutboundVoiceProfileCreateParams {
423
423
  /**
424
- * (BETA) Specifies the time window and call limits for calls made using this
425
- * outbound voice profile. Note that all times are UTC in 24-hour clock time.
424
+ * Specifies the time window and call limits for calls made using this outbound
425
+ * voice profile. Note that all times are UTC in 24-hour clock time.
426
426
  */
427
427
  export interface CallingWindow {
428
428
  /**
429
- * (BETA) The maximum number of calls that can be initiated to a single called
430
- * party (CLD) within the calling window. A null value means no limit.
429
+ * The maximum number of calls that can be initiated to a single called party (CLD)
430
+ * within the calling window. A null value means no limit.
431
431
  */
432
432
  calls_per_cld?: number;
433
433
 
434
434
  /**
435
- * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
436
- * longer allowed to start.
435
+ * The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
436
+ * allowed to start.
437
437
  */
438
438
  end_time?: string;
439
439
 
440
440
  /**
441
- * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
442
- * allowed to start.
441
+ * The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
442
+ * start.
443
443
  */
444
444
  start_time?: string;
445
445
  }
@@ -460,8 +460,8 @@ export interface OutboundVoiceProfileUpdateParams {
460
460
  call_recording?: OutboundCallRecording;
461
461
 
462
462
  /**
463
- * (BETA) Specifies the time window and call limits for calls made using this
464
- * outbound voice profile.
463
+ * Specifies the time window and call limits for calls made using this outbound
464
+ * voice profile.
465
465
  */
466
466
  calling_window?: OutboundVoiceProfileUpdateParams.CallingWindow;
467
467
 
@@ -520,25 +520,25 @@ export interface OutboundVoiceProfileUpdateParams {
520
520
 
521
521
  export namespace OutboundVoiceProfileUpdateParams {
522
522
  /**
523
- * (BETA) Specifies the time window and call limits for calls made using this
524
- * outbound voice profile.
523
+ * Specifies the time window and call limits for calls made using this outbound
524
+ * voice profile.
525
525
  */
526
526
  export interface CallingWindow {
527
527
  /**
528
- * (BETA) The maximum number of calls that can be initiated to a single called
529
- * party (CLD) within the calling window. A null value means no limit.
528
+ * The maximum number of calls that can be initiated to a single called party (CLD)
529
+ * within the calling window. A null value means no limit.
530
530
  */
531
531
  calls_per_cld?: number;
532
532
 
533
533
  /**
534
- * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
535
- * longer allowed to start.
534
+ * The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
535
+ * allowed to start.
536
536
  */
537
537
  end_time?: string;
538
538
 
539
539
  /**
540
- * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
541
- * allowed to start.
540
+ * The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
541
+ * start.
542
542
  */
543
543
  start_time?: string;
544
544
  }