telnyx 5.7.0 → 5.7.1

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 (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/audio_transcribe_params.rb +32 -5
  5. data/lib/telnyx/models/calls/action_start_recording_params.rb +122 -7
  6. data/lib/telnyx/models/private_wireless_gateway_status.rb +3 -2
  7. data/lib/telnyx/models/sim_card_list_params.rb +11 -3
  8. data/lib/telnyx/models/texml/accounts/conference_retrieve_recordings_response.rb +9 -1
  9. data/lib/telnyx/models/texml/accounts/conferences/participant_participants_response.rb +9 -1
  10. data/lib/telnyx/models/texml/accounts/conferences/participant_retrieve_participants_response.rb +9 -1
  11. data/lib/telnyx/models/texml/accounts/conferences/participant_retrieve_response.rb +9 -1
  12. data/lib/telnyx/models/texml/accounts/conferences/participant_update_response.rb +9 -1
  13. data/lib/telnyx/resources/ai/audio.rb +5 -1
  14. data/lib/telnyx/resources/calls/actions.rb +2 -2
  15. data/lib/telnyx/resources/texml/calls.rb +0 -130
  16. data/lib/telnyx/version.rb +1 -1
  17. data/lib/telnyx.rb +0 -4
  18. data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +53 -7
  19. data/rbi/telnyx/models/calls/action_start_recording_params.rbi +565 -9
  20. data/rbi/telnyx/models/private_wireless_gateway_status.rbi +4 -2
  21. data/rbi/telnyx/models/sim_card_list_params.rbi +14 -3
  22. data/rbi/telnyx/models/texml/accounts/conference_retrieve_recordings_response.rbi +11 -0
  23. data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_response.rbi +11 -0
  24. data/rbi/telnyx/models/texml/accounts/conferences/participant_retrieve_participants_response.rbi +11 -0
  25. data/rbi/telnyx/models/texml/accounts/conferences/participant_retrieve_response.rbi +11 -0
  26. data/rbi/telnyx/models/texml/accounts/conferences/participant_update_response.rbi +11 -0
  27. data/rbi/telnyx/resources/ai/audio.rbi +18 -3
  28. data/rbi/telnyx/resources/calls/actions.rbi +5 -3
  29. data/rbi/telnyx/resources/sim_cards.rbi +1 -1
  30. data/rbi/telnyx/resources/texml/calls.rbi +0 -180
  31. data/sig/telnyx/models/ai/audio_transcribe_params.rbs +18 -1
  32. data/sig/telnyx/models/calls/action_start_recording_params.rbs +219 -5
  33. data/sig/telnyx/models/sim_card_list_params.rbs +7 -0
  34. data/sig/telnyx/models/texml/accounts/conference_retrieve_recordings_response.rbs +7 -0
  35. data/sig/telnyx/models/texml/accounts/conferences/participant_participants_response.rbs +7 -0
  36. data/sig/telnyx/models/texml/accounts/conferences/participant_retrieve_participants_response.rbs +7 -0
  37. data/sig/telnyx/models/texml/accounts/conferences/participant_retrieve_response.rbs +7 -0
  38. data/sig/telnyx/models/texml/accounts/conferences/participant_update_response.rbs +7 -0
  39. data/sig/telnyx/resources/ai/audio.rbs +2 -0
  40. data/sig/telnyx/resources/calls/actions.rbs +1 -1
  41. data/sig/telnyx/resources/texml/calls.rbs +0 -49
  42. metadata +2 -14
  43. data/lib/telnyx/models/texml/call_initiate_params.rb +0 -427
  44. data/lib/telnyx/models/texml/call_initiate_response.rb +0 -41
  45. data/lib/telnyx/models/texml/call_update_params.rb +0 -16
  46. data/lib/telnyx/models/texml/call_update_response.rb +0 -35
  47. data/rbi/telnyx/models/texml/call_initiate_params.rbi +0 -886
  48. data/rbi/telnyx/models/texml/call_initiate_response.rbi +0 -85
  49. data/rbi/telnyx/models/texml/call_update_params.rbi +0 -29
  50. data/rbi/telnyx/models/texml/call_update_response.rbi +0 -75
  51. data/sig/telnyx/models/texml/call_initiate_params.rbs +0 -371
  52. data/sig/telnyx/models/texml/call_initiate_response.rbs +0 -44
  53. data/sig/telnyx/models/texml/call_update_params.rbs +0 -17
  54. data/sig/telnyx/models/texml/call_update_response.rbs +0 -40
@@ -1,886 +0,0 @@
1
- # typed: strong
2
-
3
- module Telnyx
4
- module Models
5
- module Texml
6
- class CallInitiateParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- OrHash =
11
- T.type_alias do
12
- T.any(Telnyx::Texml::CallInitiateParams, Telnyx::Internal::AnyHash)
13
- end
14
-
15
- # The phone number of the party that initiated the call. Phone numbers are
16
- # formatted with a `+` and country code.
17
- sig { returns(String) }
18
- attr_accessor :from
19
-
20
- # The phone number of the called party. Phone numbers are formatted with a `+` and
21
- # country code.
22
- sig { returns(String) }
23
- attr_accessor :to
24
-
25
- # Select whether to perform answering machine detection in the background. By
26
- # default execution is blocked until Answering Machine Detection is completed.
27
- sig { returns(T.nilable(T::Boolean)) }
28
- attr_reader :async_amd
29
-
30
- sig { params(async_amd: T::Boolean).void }
31
- attr_writer :async_amd
32
-
33
- # URL destination for Telnyx to send AMD callback events to for the call.
34
- sig { returns(T.nilable(String)) }
35
- attr_reader :async_amd_status_callback
36
-
37
- sig { params(async_amd_status_callback: String).void }
38
- attr_writer :async_amd_status_callback
39
-
40
- # HTTP request type used for `AsyncAmdStatusCallback`. The default value is
41
- # inherited from TeXML Application setting.
42
- sig do
43
- returns(
44
- T.nilable(
45
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::OrSymbol
46
- )
47
- )
48
- end
49
- attr_reader :async_amd_status_callback_method
50
-
51
- sig do
52
- params(
53
- async_amd_status_callback_method:
54
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::OrSymbol
55
- ).void
56
- end
57
- attr_writer :async_amd_status_callback_method
58
-
59
- # To be used as the caller id name (SIP From Display Name) presented to the
60
- # destination (`To` number). The string should have a maximum of 128 characters,
61
- # containing only letters, numbers, spaces, and `-_~!.+` special characters. If
62
- # ommited, the display name will be the same as the number in the `From` field.
63
- sig { returns(T.nilable(String)) }
64
- attr_reader :caller_id
65
-
66
- sig { params(caller_id: String).void }
67
- attr_writer :caller_id
68
-
69
- # Whether to cancel ongoing playback on `greeting ended` detection. Defaults to
70
- # `true`.
71
- sig { returns(T.nilable(T::Boolean)) }
72
- attr_reader :cancel_playback_on_detect_message_end
73
-
74
- sig { params(cancel_playback_on_detect_message_end: T::Boolean).void }
75
- attr_writer :cancel_playback_on_detect_message_end
76
-
77
- # Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
78
- sig { returns(T.nilable(T::Boolean)) }
79
- attr_reader :cancel_playback_on_machine_detection
80
-
81
- sig { params(cancel_playback_on_machine_detection: T::Boolean).void }
82
- attr_writer :cancel_playback_on_machine_detection
83
-
84
- # Allows you to chose between Premium and Standard detections.
85
- sig do
86
- returns(
87
- T.nilable(
88
- Telnyx::Texml::CallInitiateParams::DetectionMode::OrSymbol
89
- )
90
- )
91
- end
92
- attr_reader :detection_mode
93
-
94
- sig do
95
- params(
96
- detection_mode:
97
- Telnyx::Texml::CallInitiateParams::DetectionMode::OrSymbol
98
- ).void
99
- end
100
- attr_writer :detection_mode
101
-
102
- # A failover URL for which Telnyx will retrieve the TeXML call instructions if the
103
- # `Url` is not responding.
104
- sig { returns(T.nilable(String)) }
105
- attr_reader :fallback_url
106
-
107
- sig { params(fallback_url: String).void }
108
- attr_writer :fallback_url
109
-
110
- # Enables Answering Machine Detection.
111
- sig do
112
- returns(
113
- T.nilable(
114
- Telnyx::Texml::CallInitiateParams::MachineDetection::OrSymbol
115
- )
116
- )
117
- end
118
- attr_reader :machine_detection
119
-
120
- sig do
121
- params(
122
- machine_detection:
123
- Telnyx::Texml::CallInitiateParams::MachineDetection::OrSymbol
124
- ).void
125
- end
126
- attr_writer :machine_detection
127
-
128
- # If initial silence duration is greater than this value, consider it a machine.
129
- # Ignored when `premium` detection is used.
130
- sig { returns(T.nilable(Integer)) }
131
- attr_reader :machine_detection_silence_timeout
132
-
133
- sig { params(machine_detection_silence_timeout: Integer).void }
134
- attr_writer :machine_detection_silence_timeout
135
-
136
- # Silence duration threshold after a greeting message or voice for it be
137
- # considered human. Ignored when `premium` detection is used.
138
- sig { returns(T.nilable(Integer)) }
139
- attr_reader :machine_detection_speech_end_threshold
140
-
141
- sig { params(machine_detection_speech_end_threshold: Integer).void }
142
- attr_writer :machine_detection_speech_end_threshold
143
-
144
- # Maximum threshold of a human greeting. If greeting longer than this value,
145
- # considered machine. Ignored when `premium` detection is used.
146
- sig { returns(T.nilable(Integer)) }
147
- attr_reader :machine_detection_speech_threshold
148
-
149
- sig { params(machine_detection_speech_threshold: Integer).void }
150
- attr_writer :machine_detection_speech_threshold
151
-
152
- # Maximum timeout threshold in milliseconds for overall detection.
153
- sig { returns(T.nilable(Integer)) }
154
- attr_reader :machine_detection_timeout
155
-
156
- sig { params(machine_detection_timeout: Integer).void }
157
- attr_writer :machine_detection_timeout
158
-
159
- # The list of comma-separated codecs to be offered on a call.
160
- sig { returns(T.nilable(String)) }
161
- attr_reader :preferred_codecs
162
-
163
- sig { params(preferred_codecs: String).void }
164
- attr_writer :preferred_codecs
165
-
166
- # Whether to record the entire participant's call leg. Defaults to `false`.
167
- sig { returns(T.nilable(T::Boolean)) }
168
- attr_reader :record
169
-
170
- sig { params(record: T::Boolean).void }
171
- attr_writer :record
172
-
173
- # The number of channels in the final recording. Defaults to `mono`.
174
- sig do
175
- returns(
176
- T.nilable(
177
- Telnyx::Texml::CallInitiateParams::RecordingChannels::OrSymbol
178
- )
179
- )
180
- end
181
- attr_reader :recording_channels
182
-
183
- sig do
184
- params(
185
- recording_channels:
186
- Telnyx::Texml::CallInitiateParams::RecordingChannels::OrSymbol
187
- ).void
188
- end
189
- attr_writer :recording_channels
190
-
191
- # The URL the recording callbacks will be sent to.
192
- sig { returns(T.nilable(String)) }
193
- attr_reader :recording_status_callback
194
-
195
- sig { params(recording_status_callback: String).void }
196
- attr_writer :recording_status_callback
197
-
198
- # The changes to the recording's state that should generate a call to
199
- # `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
200
- # Separate multiple values with a space. Defaults to `completed`.
201
- sig { returns(T.nilable(String)) }
202
- attr_reader :recording_status_callback_event
203
-
204
- sig { params(recording_status_callback_event: String).void }
205
- attr_writer :recording_status_callback_event
206
-
207
- # HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
208
- sig do
209
- returns(
210
- T.nilable(
211
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::OrSymbol
212
- )
213
- )
214
- end
215
- attr_reader :recording_status_callback_method
216
-
217
- sig do
218
- params(
219
- recording_status_callback_method:
220
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::OrSymbol
221
- ).void
222
- end
223
- attr_writer :recording_status_callback_method
224
-
225
- # The number of seconds that Telnyx will wait for the recording to be stopped if
226
- # silence is detected. The timer only starts when the speech is detected. Please
227
- # note that the transcription is used to detect silence and the related charge
228
- # will be applied. The minimum value is 0. The default value is 0 (infinite)
229
- sig { returns(T.nilable(Integer)) }
230
- attr_reader :recording_timeout
231
-
232
- sig { params(recording_timeout: Integer).void }
233
- attr_writer :recording_timeout
234
-
235
- # The audio track to record for the call. The default is `both`.
236
- sig do
237
- returns(
238
- T.nilable(
239
- Telnyx::Texml::CallInitiateParams::RecordingTrack::OrSymbol
240
- )
241
- )
242
- end
243
- attr_reader :recording_track
244
-
245
- sig do
246
- params(
247
- recording_track:
248
- Telnyx::Texml::CallInitiateParams::RecordingTrack::OrSymbol
249
- ).void
250
- end
251
- attr_writer :recording_track
252
-
253
- # The password to use for SIP authentication.
254
- sig { returns(T.nilable(String)) }
255
- attr_reader :sip_auth_password
256
-
257
- sig { params(sip_auth_password: String).void }
258
- attr_writer :sip_auth_password
259
-
260
- # The username to use for SIP authentication.
261
- sig { returns(T.nilable(String)) }
262
- attr_reader :sip_auth_username
263
-
264
- sig { params(sip_auth_username: String).void }
265
- attr_writer :sip_auth_username
266
-
267
- # URL destination for Telnyx to send status callback events to for the call.
268
- sig { returns(T.nilable(String)) }
269
- attr_reader :status_callback
270
-
271
- sig { params(status_callback: String).void }
272
- attr_writer :status_callback
273
-
274
- # The call events for which Telnyx should send a webhook. Multiple events can be
275
- # defined when separated by a space.
276
- sig do
277
- returns(
278
- T.nilable(
279
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::OrSymbol
280
- )
281
- )
282
- end
283
- attr_reader :status_callback_event
284
-
285
- sig do
286
- params(
287
- status_callback_event:
288
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::OrSymbol
289
- ).void
290
- end
291
- attr_writer :status_callback_event
292
-
293
- # HTTP request type used for `StatusCallback`.
294
- sig do
295
- returns(
296
- T.nilable(
297
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::OrSymbol
298
- )
299
- )
300
- end
301
- attr_reader :status_callback_method
302
-
303
- sig do
304
- params(
305
- status_callback_method:
306
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::OrSymbol
307
- ).void
308
- end
309
- attr_writer :status_callback_method
310
-
311
- # Whether to trim any leading and trailing silence from the recording. Defaults to
312
- # `trim-silence`.
313
- sig do
314
- returns(T.nilable(Telnyx::Texml::CallInitiateParams::Trim::OrSymbol))
315
- end
316
- attr_reader :trim
317
-
318
- sig do
319
- params(trim: Telnyx::Texml::CallInitiateParams::Trim::OrSymbol).void
320
- end
321
- attr_writer :trim
322
-
323
- # The URL from which Telnyx will retrieve the TeXML call instructions.
324
- sig { returns(T.nilable(String)) }
325
- attr_reader :url
326
-
327
- sig { params(url: String).void }
328
- attr_writer :url
329
-
330
- # HTTP request type used for `Url`. The default value is inherited from TeXML
331
- # Application setting.
332
- sig do
333
- returns(
334
- T.nilable(Telnyx::Texml::CallInitiateParams::URLMethod::OrSymbol)
335
- )
336
- end
337
- attr_reader :url_method
338
-
339
- sig do
340
- params(
341
- url_method: Telnyx::Texml::CallInitiateParams::URLMethod::OrSymbol
342
- ).void
343
- end
344
- attr_writer :url_method
345
-
346
- sig do
347
- params(
348
- from: String,
349
- to: String,
350
- async_amd: T::Boolean,
351
- async_amd_status_callback: String,
352
- async_amd_status_callback_method:
353
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::OrSymbol,
354
- caller_id: String,
355
- cancel_playback_on_detect_message_end: T::Boolean,
356
- cancel_playback_on_machine_detection: T::Boolean,
357
- detection_mode:
358
- Telnyx::Texml::CallInitiateParams::DetectionMode::OrSymbol,
359
- fallback_url: String,
360
- machine_detection:
361
- Telnyx::Texml::CallInitiateParams::MachineDetection::OrSymbol,
362
- machine_detection_silence_timeout: Integer,
363
- machine_detection_speech_end_threshold: Integer,
364
- machine_detection_speech_threshold: Integer,
365
- machine_detection_timeout: Integer,
366
- preferred_codecs: String,
367
- record: T::Boolean,
368
- recording_channels:
369
- Telnyx::Texml::CallInitiateParams::RecordingChannels::OrSymbol,
370
- recording_status_callback: String,
371
- recording_status_callback_event: String,
372
- recording_status_callback_method:
373
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::OrSymbol,
374
- recording_timeout: Integer,
375
- recording_track:
376
- Telnyx::Texml::CallInitiateParams::RecordingTrack::OrSymbol,
377
- sip_auth_password: String,
378
- sip_auth_username: String,
379
- status_callback: String,
380
- status_callback_event:
381
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::OrSymbol,
382
- status_callback_method:
383
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::OrSymbol,
384
- trim: Telnyx::Texml::CallInitiateParams::Trim::OrSymbol,
385
- url: String,
386
- url_method: Telnyx::Texml::CallInitiateParams::URLMethod::OrSymbol,
387
- request_options: Telnyx::RequestOptions::OrHash
388
- ).returns(T.attached_class)
389
- end
390
- def self.new(
391
- # The phone number of the party that initiated the call. Phone numbers are
392
- # formatted with a `+` and country code.
393
- from:,
394
- # The phone number of the called party. Phone numbers are formatted with a `+` and
395
- # country code.
396
- to:,
397
- # Select whether to perform answering machine detection in the background. By
398
- # default execution is blocked until Answering Machine Detection is completed.
399
- async_amd: nil,
400
- # URL destination for Telnyx to send AMD callback events to for the call.
401
- async_amd_status_callback: nil,
402
- # HTTP request type used for `AsyncAmdStatusCallback`. The default value is
403
- # inherited from TeXML Application setting.
404
- async_amd_status_callback_method: nil,
405
- # To be used as the caller id name (SIP From Display Name) presented to the
406
- # destination (`To` number). The string should have a maximum of 128 characters,
407
- # containing only letters, numbers, spaces, and `-_~!.+` special characters. If
408
- # ommited, the display name will be the same as the number in the `From` field.
409
- caller_id: nil,
410
- # Whether to cancel ongoing playback on `greeting ended` detection. Defaults to
411
- # `true`.
412
- cancel_playback_on_detect_message_end: nil,
413
- # Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
414
- cancel_playback_on_machine_detection: nil,
415
- # Allows you to chose between Premium and Standard detections.
416
- detection_mode: nil,
417
- # A failover URL for which Telnyx will retrieve the TeXML call instructions if the
418
- # `Url` is not responding.
419
- fallback_url: nil,
420
- # Enables Answering Machine Detection.
421
- machine_detection: nil,
422
- # If initial silence duration is greater than this value, consider it a machine.
423
- # Ignored when `premium` detection is used.
424
- machine_detection_silence_timeout: nil,
425
- # Silence duration threshold after a greeting message or voice for it be
426
- # considered human. Ignored when `premium` detection is used.
427
- machine_detection_speech_end_threshold: nil,
428
- # Maximum threshold of a human greeting. If greeting longer than this value,
429
- # considered machine. Ignored when `premium` detection is used.
430
- machine_detection_speech_threshold: nil,
431
- # Maximum timeout threshold in milliseconds for overall detection.
432
- machine_detection_timeout: nil,
433
- # The list of comma-separated codecs to be offered on a call.
434
- preferred_codecs: nil,
435
- # Whether to record the entire participant's call leg. Defaults to `false`.
436
- record: nil,
437
- # The number of channels in the final recording. Defaults to `mono`.
438
- recording_channels: nil,
439
- # The URL the recording callbacks will be sent to.
440
- recording_status_callback: nil,
441
- # The changes to the recording's state that should generate a call to
442
- # `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
443
- # Separate multiple values with a space. Defaults to `completed`.
444
- recording_status_callback_event: nil,
445
- # HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
446
- recording_status_callback_method: nil,
447
- # The number of seconds that Telnyx will wait for the recording to be stopped if
448
- # silence is detected. The timer only starts when the speech is detected. Please
449
- # note that the transcription is used to detect silence and the related charge
450
- # will be applied. The minimum value is 0. The default value is 0 (infinite)
451
- recording_timeout: nil,
452
- # The audio track to record for the call. The default is `both`.
453
- recording_track: nil,
454
- # The password to use for SIP authentication.
455
- sip_auth_password: nil,
456
- # The username to use for SIP authentication.
457
- sip_auth_username: nil,
458
- # URL destination for Telnyx to send status callback events to for the call.
459
- status_callback: nil,
460
- # The call events for which Telnyx should send a webhook. Multiple events can be
461
- # defined when separated by a space.
462
- status_callback_event: nil,
463
- # HTTP request type used for `StatusCallback`.
464
- status_callback_method: nil,
465
- # Whether to trim any leading and trailing silence from the recording. Defaults to
466
- # `trim-silence`.
467
- trim: nil,
468
- # The URL from which Telnyx will retrieve the TeXML call instructions.
469
- url: nil,
470
- # HTTP request type used for `Url`. The default value is inherited from TeXML
471
- # Application setting.
472
- url_method: nil,
473
- request_options: {}
474
- )
475
- end
476
-
477
- sig do
478
- override.returns(
479
- {
480
- from: String,
481
- to: String,
482
- async_amd: T::Boolean,
483
- async_amd_status_callback: String,
484
- async_amd_status_callback_method:
485
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::OrSymbol,
486
- caller_id: String,
487
- cancel_playback_on_detect_message_end: T::Boolean,
488
- cancel_playback_on_machine_detection: T::Boolean,
489
- detection_mode:
490
- Telnyx::Texml::CallInitiateParams::DetectionMode::OrSymbol,
491
- fallback_url: String,
492
- machine_detection:
493
- Telnyx::Texml::CallInitiateParams::MachineDetection::OrSymbol,
494
- machine_detection_silence_timeout: Integer,
495
- machine_detection_speech_end_threshold: Integer,
496
- machine_detection_speech_threshold: Integer,
497
- machine_detection_timeout: Integer,
498
- preferred_codecs: String,
499
- record: T::Boolean,
500
- recording_channels:
501
- Telnyx::Texml::CallInitiateParams::RecordingChannels::OrSymbol,
502
- recording_status_callback: String,
503
- recording_status_callback_event: String,
504
- recording_status_callback_method:
505
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::OrSymbol,
506
- recording_timeout: Integer,
507
- recording_track:
508
- Telnyx::Texml::CallInitiateParams::RecordingTrack::OrSymbol,
509
- sip_auth_password: String,
510
- sip_auth_username: String,
511
- status_callback: String,
512
- status_callback_event:
513
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::OrSymbol,
514
- status_callback_method:
515
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::OrSymbol,
516
- trim: Telnyx::Texml::CallInitiateParams::Trim::OrSymbol,
517
- url: String,
518
- url_method:
519
- Telnyx::Texml::CallInitiateParams::URLMethod::OrSymbol,
520
- request_options: Telnyx::RequestOptions
521
- }
522
- )
523
- end
524
- def to_hash
525
- end
526
-
527
- # HTTP request type used for `AsyncAmdStatusCallback`. The default value is
528
- # inherited from TeXML Application setting.
529
- module AsyncAmdStatusCallbackMethod
530
- extend Telnyx::Internal::Type::Enum
531
-
532
- TaggedSymbol =
533
- T.type_alias do
534
- T.all(
535
- Symbol,
536
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod
537
- )
538
- end
539
- OrSymbol = T.type_alias { T.any(Symbol, String) }
540
-
541
- GET =
542
- T.let(
543
- :GET,
544
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::TaggedSymbol
545
- )
546
- POST =
547
- T.let(
548
- :POST,
549
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::TaggedSymbol
550
- )
551
-
552
- sig do
553
- override.returns(
554
- T::Array[
555
- Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::TaggedSymbol
556
- ]
557
- )
558
- end
559
- def self.values
560
- end
561
- end
562
-
563
- # Allows you to chose between Premium and Standard detections.
564
- module DetectionMode
565
- extend Telnyx::Internal::Type::Enum
566
-
567
- TaggedSymbol =
568
- T.type_alias do
569
- T.all(Symbol, Telnyx::Texml::CallInitiateParams::DetectionMode)
570
- end
571
- OrSymbol = T.type_alias { T.any(Symbol, String) }
572
-
573
- PREMIUM =
574
- T.let(
575
- :Premium,
576
- Telnyx::Texml::CallInitiateParams::DetectionMode::TaggedSymbol
577
- )
578
- REGULAR =
579
- T.let(
580
- :Regular,
581
- Telnyx::Texml::CallInitiateParams::DetectionMode::TaggedSymbol
582
- )
583
-
584
- sig do
585
- override.returns(
586
- T::Array[
587
- Telnyx::Texml::CallInitiateParams::DetectionMode::TaggedSymbol
588
- ]
589
- )
590
- end
591
- def self.values
592
- end
593
- end
594
-
595
- # Enables Answering Machine Detection.
596
- module MachineDetection
597
- extend Telnyx::Internal::Type::Enum
598
-
599
- TaggedSymbol =
600
- T.type_alias do
601
- T.all(Symbol, Telnyx::Texml::CallInitiateParams::MachineDetection)
602
- end
603
- OrSymbol = T.type_alias { T.any(Symbol, String) }
604
-
605
- ENABLE =
606
- T.let(
607
- :Enable,
608
- Telnyx::Texml::CallInitiateParams::MachineDetection::TaggedSymbol
609
- )
610
- DISABLE =
611
- T.let(
612
- :Disable,
613
- Telnyx::Texml::CallInitiateParams::MachineDetection::TaggedSymbol
614
- )
615
- DETECT_MESSAGE_END =
616
- T.let(
617
- :DetectMessageEnd,
618
- Telnyx::Texml::CallInitiateParams::MachineDetection::TaggedSymbol
619
- )
620
-
621
- sig do
622
- override.returns(
623
- T::Array[
624
- Telnyx::Texml::CallInitiateParams::MachineDetection::TaggedSymbol
625
- ]
626
- )
627
- end
628
- def self.values
629
- end
630
- end
631
-
632
- # The number of channels in the final recording. Defaults to `mono`.
633
- module RecordingChannels
634
- extend Telnyx::Internal::Type::Enum
635
-
636
- TaggedSymbol =
637
- T.type_alias do
638
- T.all(
639
- Symbol,
640
- Telnyx::Texml::CallInitiateParams::RecordingChannels
641
- )
642
- end
643
- OrSymbol = T.type_alias { T.any(Symbol, String) }
644
-
645
- MONO =
646
- T.let(
647
- :mono,
648
- Telnyx::Texml::CallInitiateParams::RecordingChannels::TaggedSymbol
649
- )
650
- DUAL =
651
- T.let(
652
- :dual,
653
- Telnyx::Texml::CallInitiateParams::RecordingChannels::TaggedSymbol
654
- )
655
-
656
- sig do
657
- override.returns(
658
- T::Array[
659
- Telnyx::Texml::CallInitiateParams::RecordingChannels::TaggedSymbol
660
- ]
661
- )
662
- end
663
- def self.values
664
- end
665
- end
666
-
667
- # HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
668
- module RecordingStatusCallbackMethod
669
- extend Telnyx::Internal::Type::Enum
670
-
671
- TaggedSymbol =
672
- T.type_alias do
673
- T.all(
674
- Symbol,
675
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod
676
- )
677
- end
678
- OrSymbol = T.type_alias { T.any(Symbol, String) }
679
-
680
- GET =
681
- T.let(
682
- :GET,
683
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::TaggedSymbol
684
- )
685
- POST =
686
- T.let(
687
- :POST,
688
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::TaggedSymbol
689
- )
690
-
691
- sig do
692
- override.returns(
693
- T::Array[
694
- Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::TaggedSymbol
695
- ]
696
- )
697
- end
698
- def self.values
699
- end
700
- end
701
-
702
- # The audio track to record for the call. The default is `both`.
703
- module RecordingTrack
704
- extend Telnyx::Internal::Type::Enum
705
-
706
- TaggedSymbol =
707
- T.type_alias do
708
- T.all(Symbol, Telnyx::Texml::CallInitiateParams::RecordingTrack)
709
- end
710
- OrSymbol = T.type_alias { T.any(Symbol, String) }
711
-
712
- INBOUND =
713
- T.let(
714
- :inbound,
715
- Telnyx::Texml::CallInitiateParams::RecordingTrack::TaggedSymbol
716
- )
717
- OUTBOUND =
718
- T.let(
719
- :outbound,
720
- Telnyx::Texml::CallInitiateParams::RecordingTrack::TaggedSymbol
721
- )
722
- BOTH =
723
- T.let(
724
- :both,
725
- Telnyx::Texml::CallInitiateParams::RecordingTrack::TaggedSymbol
726
- )
727
-
728
- sig do
729
- override.returns(
730
- T::Array[
731
- Telnyx::Texml::CallInitiateParams::RecordingTrack::TaggedSymbol
732
- ]
733
- )
734
- end
735
- def self.values
736
- end
737
- end
738
-
739
- # The call events for which Telnyx should send a webhook. Multiple events can be
740
- # defined when separated by a space.
741
- module StatusCallbackEvent
742
- extend Telnyx::Internal::Type::Enum
743
-
744
- TaggedSymbol =
745
- T.type_alias do
746
- T.all(
747
- Symbol,
748
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent
749
- )
750
- end
751
- OrSymbol = T.type_alias { T.any(Symbol, String) }
752
-
753
- INITIATED =
754
- T.let(
755
- :initiated,
756
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::TaggedSymbol
757
- )
758
- RINGING =
759
- T.let(
760
- :ringing,
761
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::TaggedSymbol
762
- )
763
- ANSWERED =
764
- T.let(
765
- :answered,
766
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::TaggedSymbol
767
- )
768
- COMPLETED =
769
- T.let(
770
- :completed,
771
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::TaggedSymbol
772
- )
773
-
774
- sig do
775
- override.returns(
776
- T::Array[
777
- Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::TaggedSymbol
778
- ]
779
- )
780
- end
781
- def self.values
782
- end
783
- end
784
-
785
- # HTTP request type used for `StatusCallback`.
786
- module StatusCallbackMethod
787
- extend Telnyx::Internal::Type::Enum
788
-
789
- TaggedSymbol =
790
- T.type_alias do
791
- T.all(
792
- Symbol,
793
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod
794
- )
795
- end
796
- OrSymbol = T.type_alias { T.any(Symbol, String) }
797
-
798
- GET =
799
- T.let(
800
- :GET,
801
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::TaggedSymbol
802
- )
803
- POST =
804
- T.let(
805
- :POST,
806
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::TaggedSymbol
807
- )
808
-
809
- sig do
810
- override.returns(
811
- T::Array[
812
- Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::TaggedSymbol
813
- ]
814
- )
815
- end
816
- def self.values
817
- end
818
- end
819
-
820
- # Whether to trim any leading and trailing silence from the recording. Defaults to
821
- # `trim-silence`.
822
- module Trim
823
- extend Telnyx::Internal::Type::Enum
824
-
825
- TaggedSymbol =
826
- T.type_alias do
827
- T.all(Symbol, Telnyx::Texml::CallInitiateParams::Trim)
828
- end
829
- OrSymbol = T.type_alias { T.any(Symbol, String) }
830
-
831
- TRIM_SILENCE =
832
- T.let(
833
- :"trim-silence",
834
- Telnyx::Texml::CallInitiateParams::Trim::TaggedSymbol
835
- )
836
- DO_NOT_TRIM =
837
- T.let(
838
- :"do-not-trim",
839
- Telnyx::Texml::CallInitiateParams::Trim::TaggedSymbol
840
- )
841
-
842
- sig do
843
- override.returns(
844
- T::Array[Telnyx::Texml::CallInitiateParams::Trim::TaggedSymbol]
845
- )
846
- end
847
- def self.values
848
- end
849
- end
850
-
851
- # HTTP request type used for `Url`. The default value is inherited from TeXML
852
- # Application setting.
853
- module URLMethod
854
- extend Telnyx::Internal::Type::Enum
855
-
856
- TaggedSymbol =
857
- T.type_alias do
858
- T.all(Symbol, Telnyx::Texml::CallInitiateParams::URLMethod)
859
- end
860
- OrSymbol = T.type_alias { T.any(Symbol, String) }
861
-
862
- GET =
863
- T.let(
864
- :GET,
865
- Telnyx::Texml::CallInitiateParams::URLMethod::TaggedSymbol
866
- )
867
- POST =
868
- T.let(
869
- :POST,
870
- Telnyx::Texml::CallInitiateParams::URLMethod::TaggedSymbol
871
- )
872
-
873
- sig do
874
- override.returns(
875
- T::Array[
876
- Telnyx::Texml::CallInitiateParams::URLMethod::TaggedSymbol
877
- ]
878
- )
879
- end
880
- def self.values
881
- end
882
- end
883
- end
884
- end
885
- end
886
- end