retell-sdk 5.7.0 → 5.9.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 (60) hide show
  1. package/CHANGELOG.md +441 -0
  2. package/README.md +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts.map +1 -1
  5. package/client.js +6 -5
  6. package/client.js.map +1 -1
  7. package/client.mjs +6 -5
  8. package/client.mjs.map +1 -1
  9. package/internal/uploads.js +12 -2
  10. package/internal/uploads.js.map +1 -1
  11. package/internal/uploads.mjs +12 -2
  12. package/internal/uploads.mjs.map +1 -1
  13. package/package.json +12 -1
  14. package/resources/agent.d.mts +72 -12
  15. package/resources/agent.d.mts.map +1 -1
  16. package/resources/agent.d.ts +72 -12
  17. package/resources/agent.d.ts.map +1 -1
  18. package/resources/batch-call.d.mts +26 -6
  19. package/resources/batch-call.d.mts.map +1 -1
  20. package/resources/batch-call.d.ts +26 -6
  21. package/resources/batch-call.d.ts.map +1 -1
  22. package/resources/call.d.mts +78 -18
  23. package/resources/call.d.mts.map +1 -1
  24. package/resources/call.d.ts +78 -18
  25. package/resources/call.d.ts.map +1 -1
  26. package/resources/chat-agent.d.mts +66 -6
  27. package/resources/chat-agent.d.mts.map +1 -1
  28. package/resources/chat-agent.d.ts +66 -6
  29. package/resources/chat-agent.d.ts.map +1 -1
  30. package/resources/conversation-flow-component.d.mts +225 -15
  31. package/resources/conversation-flow-component.d.mts.map +1 -1
  32. package/resources/conversation-flow-component.d.ts +225 -15
  33. package/resources/conversation-flow-component.d.ts.map +1 -1
  34. package/resources/conversation-flow.d.mts +453 -33
  35. package/resources/conversation-flow.d.mts.map +1 -1
  36. package/resources/conversation-flow.d.ts +453 -33
  37. package/resources/conversation-flow.d.ts.map +1 -1
  38. package/resources/llm.d.mts +213 -3
  39. package/resources/llm.d.mts.map +1 -1
  40. package/resources/llm.d.ts +213 -3
  41. package/resources/llm.d.ts.map +1 -1
  42. package/resources/tests.d.mts +3 -3
  43. package/resources/tests.d.mts.map +1 -1
  44. package/resources/tests.d.ts +3 -3
  45. package/resources/tests.d.ts.map +1 -1
  46. package/src/client.ts +6 -5
  47. package/src/internal/uploads.ts +12 -4
  48. package/src/resources/agent.ts +84 -6
  49. package/src/resources/batch-call.ts +30 -2
  50. package/src/resources/call.ts +90 -6
  51. package/src/resources/chat-agent.ts +78 -3
  52. package/src/resources/conversation-flow-component.ts +267 -0
  53. package/src/resources/conversation-flow.ts +537 -0
  54. package/src/resources/llm.ts +255 -0
  55. package/src/resources/tests.ts +3 -0
  56. package/src/version.ts +1 -1
  57. package/version.d.mts +1 -1
  58. package/version.d.ts +1 -1
  59. package/version.js +1 -1
  60. package/version.mjs +1 -1
@@ -443,7 +443,7 @@ export declare namespace ConversationFlowComponentResponse {
443
443
  /**
444
444
  * The LLM model to use
445
445
  */
446
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
446
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
447
447
  /**
448
448
  * Type of model choice
449
449
  */
@@ -627,6 +627,11 @@ export declare namespace ConversationFlowComponentResponse {
627
627
  * id when using `sip refer` cold transfer mode.
628
628
  */
629
629
  show_transferee_as_caller?: boolean;
630
+ /**
631
+ * Override the ring duration for this specific transfer, in milliseconds. If not
632
+ * set, falls back to the agent-level `ring_duration_ms`.
633
+ */
634
+ transfer_ring_duration_ms?: number;
630
635
  }
631
636
  interface TransferOptionWarmTransfer {
632
637
  /**
@@ -678,6 +683,11 @@ export declare namespace ConversationFlowComponentResponse {
678
683
  * Twilio numbers support this option.
679
684
  */
680
685
  show_transferee_as_caller?: boolean;
686
+ /**
687
+ * Override the ring duration for this specific transfer, in milliseconds. If not
688
+ * set, falls back to the agent-level `ring_duration_ms`.
689
+ */
690
+ transfer_ring_duration_ms?: number;
681
691
  }
682
692
  namespace TransferOptionWarmTransfer {
683
693
  /**
@@ -749,6 +759,11 @@ export declare namespace ConversationFlowComponentResponse {
749
759
  * Twilio numbers support this option.
750
760
  */
751
761
  show_transferee_as_caller?: boolean;
762
+ /**
763
+ * Override the ring duration for this specific transfer, in milliseconds. If not
764
+ * set, falls back to the agent-level `ring_duration_ms`.
765
+ */
766
+ transfer_ring_duration_ms?: number;
752
767
  }
753
768
  namespace TransferOptionAgenticWarmTransfer {
754
769
  /**
@@ -1123,6 +1138,11 @@ export declare namespace ConversationFlowComponentResponse {
1123
1138
  * Examples of the variable value to teach model the style and syntax.
1124
1139
  */
1125
1140
  examples?: Array<string>;
1141
+ /**
1142
+ * Whether this data is required. If true and the data is not extracted, the call
1143
+ * will be marked as unsuccessful.
1144
+ */
1145
+ required?: boolean;
1126
1146
  }
1127
1147
  interface EnumAnalysisData {
1128
1148
  /**
@@ -1141,6 +1161,11 @@ export declare namespace ConversationFlowComponentResponse {
1141
1161
  * Type of the variable to extract.
1142
1162
  */
1143
1163
  type: 'enum';
1164
+ /**
1165
+ * Whether this data is required. If true and the data is not extracted, the call
1166
+ * will be marked as unsuccessful.
1167
+ */
1168
+ required?: boolean;
1144
1169
  }
1145
1170
  interface BooleanAnalysisData {
1146
1171
  /**
@@ -1155,6 +1180,11 @@ export declare namespace ConversationFlowComponentResponse {
1155
1180
  * Type of the variable to extract.
1156
1181
  */
1157
1182
  type: 'boolean';
1183
+ /**
1184
+ * Whether this data is required. If true and the data is not extracted, the call
1185
+ * will be marked as unsuccessful.
1186
+ */
1187
+ required?: boolean;
1158
1188
  }
1159
1189
  interface NumberAnalysisData {
1160
1190
  /**
@@ -1169,6 +1199,11 @@ export declare namespace ConversationFlowComponentResponse {
1169
1199
  * Type of the variable to extract.
1170
1200
  */
1171
1201
  type: 'number';
1202
+ /**
1203
+ * Whether this data is required. If true and the data is not extracted, the call
1204
+ * will be marked as unsuccessful.
1205
+ */
1206
+ required?: boolean;
1172
1207
  }
1173
1208
  }
1174
1209
  interface BridgeTransferTool {
@@ -1734,7 +1769,7 @@ export declare namespace ConversationFlowComponentResponse {
1734
1769
  /**
1735
1770
  * The LLM model to use
1736
1771
  */
1737
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
1772
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
1738
1773
  /**
1739
1774
  * Type of model choice
1740
1775
  */
@@ -1888,6 +1923,11 @@ export declare namespace ConversationFlowComponentResponse {
1888
1923
  * id when using `sip refer` cold transfer mode.
1889
1924
  */
1890
1925
  show_transferee_as_caller?: boolean;
1926
+ /**
1927
+ * Override the ring duration for this specific transfer, in milliseconds. If not
1928
+ * set, falls back to the agent-level `ring_duration_ms`.
1929
+ */
1930
+ transfer_ring_duration_ms?: number;
1891
1931
  }
1892
1932
  interface TransferOptionWarmTransfer {
1893
1933
  /**
@@ -1939,6 +1979,11 @@ export declare namespace ConversationFlowComponentResponse {
1939
1979
  * Twilio numbers support this option.
1940
1980
  */
1941
1981
  show_transferee_as_caller?: boolean;
1982
+ /**
1983
+ * Override the ring duration for this specific transfer, in milliseconds. If not
1984
+ * set, falls back to the agent-level `ring_duration_ms`.
1985
+ */
1986
+ transfer_ring_duration_ms?: number;
1942
1987
  }
1943
1988
  namespace TransferOptionWarmTransfer {
1944
1989
  /**
@@ -2010,6 +2055,11 @@ export declare namespace ConversationFlowComponentResponse {
2010
2055
  * Twilio numbers support this option.
2011
2056
  */
2012
2057
  show_transferee_as_caller?: boolean;
2058
+ /**
2059
+ * Override the ring duration for this specific transfer, in milliseconds. If not
2060
+ * set, falls back to the agent-level `ring_duration_ms`.
2061
+ */
2062
+ transfer_ring_duration_ms?: number;
2013
2063
  }
2014
2064
  namespace TransferOptionAgenticWarmTransfer {
2015
2065
  /**
@@ -2205,7 +2255,7 @@ export declare namespace ConversationFlowComponentResponse {
2205
2255
  /**
2206
2256
  * The LLM model to use
2207
2257
  */
2208
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
2258
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
2209
2259
  /**
2210
2260
  * Type of model choice
2211
2261
  */
@@ -2446,7 +2496,7 @@ export declare namespace ConversationFlowComponentResponse {
2446
2496
  /**
2447
2497
  * The LLM model to use
2448
2498
  */
2449
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
2499
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
2450
2500
  /**
2451
2501
  * Type of model choice
2452
2502
  */
@@ -3023,6 +3073,11 @@ export declare namespace ConversationFlowComponentResponse {
3023
3073
  * Examples of the variable value to teach model the style and syntax.
3024
3074
  */
3025
3075
  examples?: Array<string>;
3076
+ /**
3077
+ * Whether this data is required. If true and the data is not extracted, the call
3078
+ * will be marked as unsuccessful.
3079
+ */
3080
+ required?: boolean;
3026
3081
  }
3027
3082
  interface EnumAnalysisData {
3028
3083
  /**
@@ -3041,6 +3096,11 @@ export declare namespace ConversationFlowComponentResponse {
3041
3096
  * Type of the variable to extract.
3042
3097
  */
3043
3098
  type: 'enum';
3099
+ /**
3100
+ * Whether this data is required. If true and the data is not extracted, the call
3101
+ * will be marked as unsuccessful.
3102
+ */
3103
+ required?: boolean;
3044
3104
  }
3045
3105
  interface BooleanAnalysisData {
3046
3106
  /**
@@ -3055,6 +3115,11 @@ export declare namespace ConversationFlowComponentResponse {
3055
3115
  * Type of the variable to extract.
3056
3116
  */
3057
3117
  type: 'boolean';
3118
+ /**
3119
+ * Whether this data is required. If true and the data is not extracted, the call
3120
+ * will be marked as unsuccessful.
3121
+ */
3122
+ required?: boolean;
3058
3123
  }
3059
3124
  interface NumberAnalysisData {
3060
3125
  /**
@@ -3069,6 +3134,11 @@ export declare namespace ConversationFlowComponentResponse {
3069
3134
  * Type of the variable to extract.
3070
3135
  */
3071
3136
  type: 'number';
3137
+ /**
3138
+ * Whether this data is required. If true and the data is not extracted, the call
3139
+ * will be marked as unsuccessful.
3140
+ */
3141
+ required?: boolean;
3072
3142
  }
3073
3143
  /**
3074
3144
  * Position for frontend display
@@ -3312,7 +3382,7 @@ export declare namespace ConversationFlowComponentResponse {
3312
3382
  /**
3313
3383
  * The LLM model to use
3314
3384
  */
3315
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
3385
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
3316
3386
  /**
3317
3387
  * Type of model choice
3318
3388
  */
@@ -4997,7 +5067,7 @@ export declare namespace ConversationFlowComponentCreateParams {
4997
5067
  /**
4998
5068
  * The LLM model to use
4999
5069
  */
5000
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
5070
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
5001
5071
  /**
5002
5072
  * Type of model choice
5003
5073
  */
@@ -5181,6 +5251,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5181
5251
  * id when using `sip refer` cold transfer mode.
5182
5252
  */
5183
5253
  show_transferee_as_caller?: boolean;
5254
+ /**
5255
+ * Override the ring duration for this specific transfer, in milliseconds. If not
5256
+ * set, falls back to the agent-level `ring_duration_ms`.
5257
+ */
5258
+ transfer_ring_duration_ms?: number;
5184
5259
  }
5185
5260
  interface TransferOptionWarmTransfer {
5186
5261
  /**
@@ -5232,6 +5307,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5232
5307
  * Twilio numbers support this option.
5233
5308
  */
5234
5309
  show_transferee_as_caller?: boolean;
5310
+ /**
5311
+ * Override the ring duration for this specific transfer, in milliseconds. If not
5312
+ * set, falls back to the agent-level `ring_duration_ms`.
5313
+ */
5314
+ transfer_ring_duration_ms?: number;
5235
5315
  }
5236
5316
  namespace TransferOptionWarmTransfer {
5237
5317
  /**
@@ -5303,6 +5383,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5303
5383
  * Twilio numbers support this option.
5304
5384
  */
5305
5385
  show_transferee_as_caller?: boolean;
5386
+ /**
5387
+ * Override the ring duration for this specific transfer, in milliseconds. If not
5388
+ * set, falls back to the agent-level `ring_duration_ms`.
5389
+ */
5390
+ transfer_ring_duration_ms?: number;
5306
5391
  }
5307
5392
  namespace TransferOptionAgenticWarmTransfer {
5308
5393
  /**
@@ -5677,6 +5762,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5677
5762
  * Examples of the variable value to teach model the style and syntax.
5678
5763
  */
5679
5764
  examples?: Array<string>;
5765
+ /**
5766
+ * Whether this data is required. If true and the data is not extracted, the call
5767
+ * will be marked as unsuccessful.
5768
+ */
5769
+ required?: boolean;
5680
5770
  }
5681
5771
  interface EnumAnalysisData {
5682
5772
  /**
@@ -5695,6 +5785,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5695
5785
  * Type of the variable to extract.
5696
5786
  */
5697
5787
  type: 'enum';
5788
+ /**
5789
+ * Whether this data is required. If true and the data is not extracted, the call
5790
+ * will be marked as unsuccessful.
5791
+ */
5792
+ required?: boolean;
5698
5793
  }
5699
5794
  interface BooleanAnalysisData {
5700
5795
  /**
@@ -5709,6 +5804,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5709
5804
  * Type of the variable to extract.
5710
5805
  */
5711
5806
  type: 'boolean';
5807
+ /**
5808
+ * Whether this data is required. If true and the data is not extracted, the call
5809
+ * will be marked as unsuccessful.
5810
+ */
5811
+ required?: boolean;
5712
5812
  }
5713
5813
  interface NumberAnalysisData {
5714
5814
  /**
@@ -5723,6 +5823,11 @@ export declare namespace ConversationFlowComponentCreateParams {
5723
5823
  * Type of the variable to extract.
5724
5824
  */
5725
5825
  type: 'number';
5826
+ /**
5827
+ * Whether this data is required. If true and the data is not extracted, the call
5828
+ * will be marked as unsuccessful.
5829
+ */
5830
+ required?: boolean;
5726
5831
  }
5727
5832
  }
5728
5833
  interface BridgeTransferTool {
@@ -6288,7 +6393,7 @@ export declare namespace ConversationFlowComponentCreateParams {
6288
6393
  /**
6289
6394
  * The LLM model to use
6290
6395
  */
6291
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
6396
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
6292
6397
  /**
6293
6398
  * Type of model choice
6294
6399
  */
@@ -6442,6 +6547,11 @@ export declare namespace ConversationFlowComponentCreateParams {
6442
6547
  * id when using `sip refer` cold transfer mode.
6443
6548
  */
6444
6549
  show_transferee_as_caller?: boolean;
6550
+ /**
6551
+ * Override the ring duration for this specific transfer, in milliseconds. If not
6552
+ * set, falls back to the agent-level `ring_duration_ms`.
6553
+ */
6554
+ transfer_ring_duration_ms?: number;
6445
6555
  }
6446
6556
  interface TransferOptionWarmTransfer {
6447
6557
  /**
@@ -6493,6 +6603,11 @@ export declare namespace ConversationFlowComponentCreateParams {
6493
6603
  * Twilio numbers support this option.
6494
6604
  */
6495
6605
  show_transferee_as_caller?: boolean;
6606
+ /**
6607
+ * Override the ring duration for this specific transfer, in milliseconds. If not
6608
+ * set, falls back to the agent-level `ring_duration_ms`.
6609
+ */
6610
+ transfer_ring_duration_ms?: number;
6496
6611
  }
6497
6612
  namespace TransferOptionWarmTransfer {
6498
6613
  /**
@@ -6564,6 +6679,11 @@ export declare namespace ConversationFlowComponentCreateParams {
6564
6679
  * Twilio numbers support this option.
6565
6680
  */
6566
6681
  show_transferee_as_caller?: boolean;
6682
+ /**
6683
+ * Override the ring duration for this specific transfer, in milliseconds. If not
6684
+ * set, falls back to the agent-level `ring_duration_ms`.
6685
+ */
6686
+ transfer_ring_duration_ms?: number;
6567
6687
  }
6568
6688
  namespace TransferOptionAgenticWarmTransfer {
6569
6689
  /**
@@ -6759,7 +6879,7 @@ export declare namespace ConversationFlowComponentCreateParams {
6759
6879
  /**
6760
6880
  * The LLM model to use
6761
6881
  */
6762
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
6882
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
6763
6883
  /**
6764
6884
  * Type of model choice
6765
6885
  */
@@ -7000,7 +7120,7 @@ export declare namespace ConversationFlowComponentCreateParams {
7000
7120
  /**
7001
7121
  * The LLM model to use
7002
7122
  */
7003
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
7123
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
7004
7124
  /**
7005
7125
  * Type of model choice
7006
7126
  */
@@ -7577,6 +7697,11 @@ export declare namespace ConversationFlowComponentCreateParams {
7577
7697
  * Examples of the variable value to teach model the style and syntax.
7578
7698
  */
7579
7699
  examples?: Array<string>;
7700
+ /**
7701
+ * Whether this data is required. If true and the data is not extracted, the call
7702
+ * will be marked as unsuccessful.
7703
+ */
7704
+ required?: boolean;
7580
7705
  }
7581
7706
  interface EnumAnalysisData {
7582
7707
  /**
@@ -7595,6 +7720,11 @@ export declare namespace ConversationFlowComponentCreateParams {
7595
7720
  * Type of the variable to extract.
7596
7721
  */
7597
7722
  type: 'enum';
7723
+ /**
7724
+ * Whether this data is required. If true and the data is not extracted, the call
7725
+ * will be marked as unsuccessful.
7726
+ */
7727
+ required?: boolean;
7598
7728
  }
7599
7729
  interface BooleanAnalysisData {
7600
7730
  /**
@@ -7609,6 +7739,11 @@ export declare namespace ConversationFlowComponentCreateParams {
7609
7739
  * Type of the variable to extract.
7610
7740
  */
7611
7741
  type: 'boolean';
7742
+ /**
7743
+ * Whether this data is required. If true and the data is not extracted, the call
7744
+ * will be marked as unsuccessful.
7745
+ */
7746
+ required?: boolean;
7612
7747
  }
7613
7748
  interface NumberAnalysisData {
7614
7749
  /**
@@ -7623,6 +7758,11 @@ export declare namespace ConversationFlowComponentCreateParams {
7623
7758
  * Type of the variable to extract.
7624
7759
  */
7625
7760
  type: 'number';
7761
+ /**
7762
+ * Whether this data is required. If true and the data is not extracted, the call
7763
+ * will be marked as unsuccessful.
7764
+ */
7765
+ required?: boolean;
7626
7766
  }
7627
7767
  /**
7628
7768
  * Position for frontend display
@@ -7866,7 +8006,7 @@ export declare namespace ConversationFlowComponentCreateParams {
7866
8006
  /**
7867
8007
  * The LLM model to use
7868
8008
  */
7869
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
8009
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
7870
8010
  /**
7871
8011
  * Type of model choice
7872
8012
  */
@@ -9581,7 +9721,7 @@ export declare namespace ConversationFlowComponentUpdateParams {
9581
9721
  /**
9582
9722
  * The LLM model to use
9583
9723
  */
9584
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
9724
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
9585
9725
  /**
9586
9726
  * Type of model choice
9587
9727
  */
@@ -9765,6 +9905,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
9765
9905
  * id when using `sip refer` cold transfer mode.
9766
9906
  */
9767
9907
  show_transferee_as_caller?: boolean;
9908
+ /**
9909
+ * Override the ring duration for this specific transfer, in milliseconds. If not
9910
+ * set, falls back to the agent-level `ring_duration_ms`.
9911
+ */
9912
+ transfer_ring_duration_ms?: number;
9768
9913
  }
9769
9914
  interface TransferOptionWarmTransfer {
9770
9915
  /**
@@ -9816,6 +9961,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
9816
9961
  * Twilio numbers support this option.
9817
9962
  */
9818
9963
  show_transferee_as_caller?: boolean;
9964
+ /**
9965
+ * Override the ring duration for this specific transfer, in milliseconds. If not
9966
+ * set, falls back to the agent-level `ring_duration_ms`.
9967
+ */
9968
+ transfer_ring_duration_ms?: number;
9819
9969
  }
9820
9970
  namespace TransferOptionWarmTransfer {
9821
9971
  /**
@@ -9887,6 +10037,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
9887
10037
  * Twilio numbers support this option.
9888
10038
  */
9889
10039
  show_transferee_as_caller?: boolean;
10040
+ /**
10041
+ * Override the ring duration for this specific transfer, in milliseconds. If not
10042
+ * set, falls back to the agent-level `ring_duration_ms`.
10043
+ */
10044
+ transfer_ring_duration_ms?: number;
9890
10045
  }
9891
10046
  namespace TransferOptionAgenticWarmTransfer {
9892
10047
  /**
@@ -10261,6 +10416,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
10261
10416
  * Examples of the variable value to teach model the style and syntax.
10262
10417
  */
10263
10418
  examples?: Array<string>;
10419
+ /**
10420
+ * Whether this data is required. If true and the data is not extracted, the call
10421
+ * will be marked as unsuccessful.
10422
+ */
10423
+ required?: boolean;
10264
10424
  }
10265
10425
  interface EnumAnalysisData {
10266
10426
  /**
@@ -10279,6 +10439,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
10279
10439
  * Type of the variable to extract.
10280
10440
  */
10281
10441
  type: 'enum';
10442
+ /**
10443
+ * Whether this data is required. If true and the data is not extracted, the call
10444
+ * will be marked as unsuccessful.
10445
+ */
10446
+ required?: boolean;
10282
10447
  }
10283
10448
  interface BooleanAnalysisData {
10284
10449
  /**
@@ -10293,6 +10458,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
10293
10458
  * Type of the variable to extract.
10294
10459
  */
10295
10460
  type: 'boolean';
10461
+ /**
10462
+ * Whether this data is required. If true and the data is not extracted, the call
10463
+ * will be marked as unsuccessful.
10464
+ */
10465
+ required?: boolean;
10296
10466
  }
10297
10467
  interface NumberAnalysisData {
10298
10468
  /**
@@ -10307,6 +10477,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
10307
10477
  * Type of the variable to extract.
10308
10478
  */
10309
10479
  type: 'number';
10480
+ /**
10481
+ * Whether this data is required. If true and the data is not extracted, the call
10482
+ * will be marked as unsuccessful.
10483
+ */
10484
+ required?: boolean;
10310
10485
  }
10311
10486
  }
10312
10487
  interface BridgeTransferTool {
@@ -10872,7 +11047,7 @@ export declare namespace ConversationFlowComponentUpdateParams {
10872
11047
  /**
10873
11048
  * The LLM model to use
10874
11049
  */
10875
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
11050
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
10876
11051
  /**
10877
11052
  * Type of model choice
10878
11053
  */
@@ -11026,6 +11201,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
11026
11201
  * id when using `sip refer` cold transfer mode.
11027
11202
  */
11028
11203
  show_transferee_as_caller?: boolean;
11204
+ /**
11205
+ * Override the ring duration for this specific transfer, in milliseconds. If not
11206
+ * set, falls back to the agent-level `ring_duration_ms`.
11207
+ */
11208
+ transfer_ring_duration_ms?: number;
11029
11209
  }
11030
11210
  interface TransferOptionWarmTransfer {
11031
11211
  /**
@@ -11077,6 +11257,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
11077
11257
  * Twilio numbers support this option.
11078
11258
  */
11079
11259
  show_transferee_as_caller?: boolean;
11260
+ /**
11261
+ * Override the ring duration for this specific transfer, in milliseconds. If not
11262
+ * set, falls back to the agent-level `ring_duration_ms`.
11263
+ */
11264
+ transfer_ring_duration_ms?: number;
11080
11265
  }
11081
11266
  namespace TransferOptionWarmTransfer {
11082
11267
  /**
@@ -11148,6 +11333,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
11148
11333
  * Twilio numbers support this option.
11149
11334
  */
11150
11335
  show_transferee_as_caller?: boolean;
11336
+ /**
11337
+ * Override the ring duration for this specific transfer, in milliseconds. If not
11338
+ * set, falls back to the agent-level `ring_duration_ms`.
11339
+ */
11340
+ transfer_ring_duration_ms?: number;
11151
11341
  }
11152
11342
  namespace TransferOptionAgenticWarmTransfer {
11153
11343
  /**
@@ -11343,7 +11533,7 @@ export declare namespace ConversationFlowComponentUpdateParams {
11343
11533
  /**
11344
11534
  * The LLM model to use
11345
11535
  */
11346
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
11536
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
11347
11537
  /**
11348
11538
  * Type of model choice
11349
11539
  */
@@ -11584,7 +11774,7 @@ export declare namespace ConversationFlowComponentUpdateParams {
11584
11774
  /**
11585
11775
  * The LLM model to use
11586
11776
  */
11587
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
11777
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
11588
11778
  /**
11589
11779
  * Type of model choice
11590
11780
  */
@@ -12161,6 +12351,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
12161
12351
  * Examples of the variable value to teach model the style and syntax.
12162
12352
  */
12163
12353
  examples?: Array<string>;
12354
+ /**
12355
+ * Whether this data is required. If true and the data is not extracted, the call
12356
+ * will be marked as unsuccessful.
12357
+ */
12358
+ required?: boolean;
12164
12359
  }
12165
12360
  interface EnumAnalysisData {
12166
12361
  /**
@@ -12179,6 +12374,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
12179
12374
  * Type of the variable to extract.
12180
12375
  */
12181
12376
  type: 'enum';
12377
+ /**
12378
+ * Whether this data is required. If true and the data is not extracted, the call
12379
+ * will be marked as unsuccessful.
12380
+ */
12381
+ required?: boolean;
12182
12382
  }
12183
12383
  interface BooleanAnalysisData {
12184
12384
  /**
@@ -12193,6 +12393,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
12193
12393
  * Type of the variable to extract.
12194
12394
  */
12195
12395
  type: 'boolean';
12396
+ /**
12397
+ * Whether this data is required. If true and the data is not extracted, the call
12398
+ * will be marked as unsuccessful.
12399
+ */
12400
+ required?: boolean;
12196
12401
  }
12197
12402
  interface NumberAnalysisData {
12198
12403
  /**
@@ -12207,6 +12412,11 @@ export declare namespace ConversationFlowComponentUpdateParams {
12207
12412
  * Type of the variable to extract.
12208
12413
  */
12209
12414
  type: 'number';
12415
+ /**
12416
+ * Whether this data is required. If true and the data is not extracted, the call
12417
+ * will be marked as unsuccessful.
12418
+ */
12419
+ required?: boolean;
12210
12420
  }
12211
12421
  /**
12212
12422
  * Position for frontend display
@@ -12450,7 +12660,7 @@ export declare namespace ConversationFlowComponentUpdateParams {
12450
12660
  /**
12451
12661
  * The LLM model to use
12452
12662
  */
12453
- model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
12663
+ model: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash';
12454
12664
  /**
12455
12665
  * Type of model choice
12456
12666
  */