telnyx 5.68.2 → 5.70.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +59 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +7 -0
- data/lib/telnyx/internal/util.rb +21 -5
- data/lib/telnyx/models/ai/assistant_create_params.rb +8 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +25 -5
- data/lib/telnyx/models/ai/assistant_update_params.rb +8 -1
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +8 -1
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +70 -7
- data/lib/telnyx/models/ai/conversation_add_message_params.rb +4 -4
- data/lib/telnyx/models/ai/inference_embedding.rb +8 -1
- data/lib/telnyx/models/ai/observability.rb +46 -0
- data/lib/telnyx/models/ai/observability_req.rb +46 -0
- data/lib/telnyx/models/ai/telephony_settings.rb +13 -1
- data/lib/telnyx/models/call_dial_params.rb +24 -1
- data/lib/telnyx/models/calls/action_transfer_params.rb +24 -1
- data/lib/telnyx/models/enterprise_create_params.rb +1 -1
- data/lib/telnyx/models/enterprise_public.rb +1 -1
- data/lib/telnyx/models/enterprise_update_params.rb +1 -1
- data/lib/telnyx/models/enterprises/reputation/{number_create_params.rb → number_associate_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/reputation/{number_create_response.rb → number_associate_response.rb} +5 -5
- data/lib/telnyx/models/enterprises/reputation/{number_delete_params.rb → number_disassociate_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_list_params.rb → reputation_disable_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_create_params.rb → reputation_enable_params.rb} +6 -6
- data/lib/telnyx/models/enterprises/{reputation_create_response.rb → reputation_enable_response.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_delete_all_params.rb → reputation_retrieve_params.rb} +2 -2
- data/lib/telnyx/models/enterprises/{reputation_list_response.rb → reputation_retrieve_response.rb} +2 -2
- data/lib/telnyx/models/porting_orders/phone_number_block_list_params.rb +9 -9
- data/lib/telnyx/models/pronunciation_dict_create_params.rb +141 -0
- data/lib/telnyx/models/pronunciation_dict_create_response.rb +207 -0
- data/lib/telnyx/models/pronunciation_dict_delete_params.rb +20 -0
- data/lib/telnyx/models/pronunciation_dict_list_params.rb +30 -0
- data/lib/telnyx/models/pronunciation_dict_list_response.rb +190 -0
- data/lib/telnyx/models/pronunciation_dict_retrieve_params.rb +20 -0
- data/lib/telnyx/models/pronunciation_dict_retrieve_response.rb +207 -0
- data/lib/telnyx/models/pronunciation_dict_update_params.rb +144 -0
- data/lib/telnyx/models/pronunciation_dict_update_response.rb +207 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +1893 -547
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +514 -0
- data/lib/telnyx/models/texml_initiate_ai_call_response.rb +34 -0
- data/lib/telnyx/models/verification.rb +1 -0
- data/lib/telnyx/models/verification_trigger_whatsapp_verification_params.rb +46 -0
- data/lib/telnyx/models/verify_profile_create_params.rb +43 -1
- data/lib/telnyx/models/verify_profile_update_params.rb +43 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +364 -71
- data/lib/telnyx/models/voice_clone_create_params.rb +161 -51
- data/lib/telnyx/models/voice_clone_data.rb +51 -4
- data/lib/telnyx/models/whatsapp_message_content.rb +196 -1
- data/lib/telnyx/models/wireless_blocklist_update_params.rb +8 -21
- data/lib/telnyx/models.rb +15 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
- data/lib/telnyx/resources/ai/assistants.rb +6 -2
- data/lib/telnyx/resources/calls/actions.rb +3 -1
- data/lib/telnyx/resources/calls.rb +3 -1
- data/lib/telnyx/resources/enterprises/reputation/numbers.rb +42 -42
- data/lib/telnyx/resources/enterprises/reputation.rb +61 -61
- data/lib/telnyx/resources/pronunciation_dicts.rb +156 -0
- data/lib/telnyx/resources/texml/accounts/calls.rb +3 -84
- data/lib/telnyx/resources/texml.rb +106 -0
- data/lib/telnyx/resources/verifications.rb +28 -0
- data/lib/telnyx/resources/verify_profiles.rb +5 -2
- data/lib/telnyx/resources/voice_clones.rb +7 -27
- data/lib/telnyx/resources/wireless_blocklists.rb +5 -5
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +23 -8
- data/rbi/telnyx/client.rbi +6 -0
- data/rbi/telnyx/internal/util.rbi +8 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +13 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +56 -5
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +13 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +13 -0
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +123 -10
- data/rbi/telnyx/models/ai/conversation_add_message_params.rbi +5 -5
- data/rbi/telnyx/models/ai/inference_embedding.rbi +11 -0
- data/rbi/telnyx/models/ai/observability.rbi +90 -0
- data/rbi/telnyx/models/ai/observability_req.rbi +92 -0
- data/rbi/telnyx/models/ai/telephony_settings.rbi +13 -0
- data/rbi/telnyx/models/call_dial_params.rbi +37 -0
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +57 -0
- data/rbi/telnyx/models/enterprise_create_params.rbi +1 -1
- data/rbi/telnyx/models/enterprise_public.rbi +1 -1
- data/rbi/telnyx/models/enterprise_update_params.rbi +1 -1
- data/rbi/telnyx/models/enterprises/reputation/{number_create_params.rbi → number_associate_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/reputation/{number_create_response.rbi → number_associate_response.rbi} +7 -7
- data/rbi/telnyx/models/enterprises/reputation/{number_delete_params.rbi → number_disassociate_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_list_params.rbi → reputation_disable_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_create_params.rbi → reputation_enable_params.rbi} +14 -14
- data/rbi/telnyx/models/enterprises/{reputation_create_response.rbi → reputation_enable_response.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_delete_all_params.rbi → reputation_retrieve_params.rbi} +2 -2
- data/rbi/telnyx/models/enterprises/{reputation_list_response.rbi → reputation_retrieve_response.rbi} +2 -2
- data/rbi/telnyx/models/porting_orders/phone_number_block_list_params.rbi +34 -34
- data/rbi/telnyx/models/pronunciation_dict_create_params.rbi +246 -0
- data/rbi/telnyx/models/pronunciation_dict_create_response.rbi +398 -0
- data/rbi/telnyx/models/pronunciation_dict_delete_params.rbi +38 -0
- data/rbi/telnyx/models/pronunciation_dict_list_params.rbi +57 -0
- data/rbi/telnyx/models/pronunciation_dict_list_response.rbi +353 -0
- data/rbi/telnyx/models/pronunciation_dict_retrieve_params.rbi +38 -0
- data/rbi/telnyx/models/pronunciation_dict_retrieve_response.rbi +398 -0
- data/rbi/telnyx/models/pronunciation_dict_update_params.rbi +268 -0
- data/rbi/telnyx/models/pronunciation_dict_update_response.rbi +398 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +3719 -1011
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +1010 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_response.rbi +58 -0
- data/rbi/telnyx/models/verification.rbi +1 -0
- data/rbi/telnyx/models/verification_trigger_whatsapp_verification_params.rbi +73 -0
- data/rbi/telnyx/models/verify_profile_create_params.rbi +85 -0
- data/rbi/telnyx/models/verify_profile_update_params.rbi +85 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +711 -136
- data/rbi/telnyx/models/voice_clone_create_params.rbi +345 -79
- data/rbi/telnyx/models/voice_clone_data.rbi +77 -4
- data/rbi/telnyx/models/whatsapp_message_content.rbi +492 -0
- data/rbi/telnyx/models/wireless_blocklist_update_params.rbi +6 -49
- data/rbi/telnyx/models.rbi +19 -10
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -0
- data/rbi/telnyx/resources/ai/assistants.rbi +4 -0
- data/rbi/telnyx/resources/calls/actions.rbi +5 -0
- data/rbi/telnyx/resources/calls.rbi +5 -0
- data/rbi/telnyx/resources/enterprises/reputation/numbers.rbi +34 -34
- data/rbi/telnyx/resources/enterprises/reputation.rbi +44 -44
- data/rbi/telnyx/resources/pronunciation_dicts.rbi +131 -0
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +7 -163
- data/rbi/telnyx/resources/texml.rbi +164 -0
- data/rbi/telnyx/resources/verifications.rbi +23 -0
- data/rbi/telnyx/resources/verify_profiles.rbi +4 -0
- data/rbi/telnyx/resources/voice_clones.rbi +17 -41
- data/rbi/telnyx/resources/wireless_blocklists.rbi +3 -3
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/internal/util.rbs +4 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +9 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +17 -4
- data/sig/telnyx/models/ai/assistant_update_params.rbs +9 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +9 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +53 -3
- data/sig/telnyx/models/ai/conversation_add_message_params.rbs +5 -5
- data/sig/telnyx/models/ai/inference_embedding.rbs +9 -0
- data/sig/telnyx/models/ai/observability.rbs +58 -0
- data/sig/telnyx/models/ai/observability_req.rbs +58 -0
- data/sig/telnyx/models/ai/telephony_settings.rbs +7 -0
- data/sig/telnyx/models/call_dial_params.rbs +20 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +20 -0
- data/sig/telnyx/models/enterprise_create_params.rbs +1 -1
- data/sig/telnyx/models/enterprise_public.rbs +1 -1
- data/sig/telnyx/models/enterprise_update_params.rbs +1 -1
- data/sig/telnyx/models/enterprises/reputation/{number_create_params.rbs → number_associate_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/reputation/{number_create_response.rbs → number_associate_response.rbs} +8 -8
- data/sig/telnyx/models/enterprises/reputation/{number_delete_params.rbs → number_disassociate_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_list_params.rbs → reputation_disable_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_create_params.rbs → reputation_enable_params.rbs} +9 -9
- data/sig/telnyx/models/enterprises/{reputation_create_response.rbs → reputation_enable_response.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_delete_all_params.rbs → reputation_retrieve_params.rbs} +2 -2
- data/sig/telnyx/models/enterprises/{reputation_list_response.rbs → reputation_retrieve_response.rbs} +2 -2
- data/sig/telnyx/models/porting_orders/phone_number_block_list_params.rbs +9 -9
- data/sig/telnyx/models/pronunciation_dict_create_params.rbs +97 -0
- data/sig/telnyx/models/pronunciation_dict_create_response.rbs +167 -0
- data/sig/telnyx/models/pronunciation_dict_delete_params.rbs +20 -0
- data/sig/telnyx/models/pronunciation_dict_list_params.rbs +32 -0
- data/sig/telnyx/models/pronunciation_dict_list_response.rbs +144 -0
- data/sig/telnyx/models/pronunciation_dict_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/pronunciation_dict_retrieve_response.rbs +167 -0
- data/sig/telnyx/models/pronunciation_dict_update_params.rbs +108 -0
- data/sig/telnyx/models/pronunciation_dict_update_response.rbs +167 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +1368 -331
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +444 -0
- data/sig/telnyx/models/texml_initiate_ai_call_response.rbs +38 -0
- data/sig/telnyx/models/verification.rbs +2 -1
- data/sig/telnyx/models/verification_trigger_whatsapp_verification_params.rbs +43 -0
- data/sig/telnyx/models/verify_profile_create_params.rbs +43 -1
- data/sig/telnyx/models/verify_profile_update_params.rbs +43 -1
- data/sig/telnyx/models/voice_clone_create_from_upload_params.rbs +269 -58
- data/sig/telnyx/models/voice_clone_create_params.rbs +129 -44
- data/sig/telnyx/models/voice_clone_data.rbs +43 -0
- data/sig/telnyx/models/whatsapp_message_content.rbs +205 -0
- data/sig/telnyx/models/wireless_blocklist_update_params.rbs +5 -25
- data/sig/telnyx/models.rbs +14 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +2 -0
- data/sig/telnyx/resources/calls/actions.rbs +1 -0
- data/sig/telnyx/resources/calls.rbs +1 -0
- data/sig/telnyx/resources/enterprises/reputation/numbers.rbs +7 -7
- data/sig/telnyx/resources/enterprises/reputation.rbs +8 -8
- data/sig/telnyx/resources/pronunciation_dicts.rbs +33 -0
- data/sig/telnyx/resources/texml/accounts/calls.rbs +1 -40
- data/sig/telnyx/resources/texml.rbs +44 -0
- data/sig/telnyx/resources/verifications.rbs +8 -0
- data/sig/telnyx/resources/verify_profiles.rbs +2 -0
- data/sig/telnyx/resources/voice_clones.rbs +2 -12
- data/sig/telnyx/resources/wireless_blocklists.rbs +1 -1
- metadata +71 -26
|
@@ -34,7 +34,7 @@ module Telnyx
|
|
|
34
34
|
#
|
|
35
35
|
# Create a new AI Assistant.
|
|
36
36
|
#
|
|
37
|
-
# @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
37
|
+
# @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
38
38
|
#
|
|
39
39
|
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
40
40
|
#
|
|
@@ -58,6 +58,8 @@ module Telnyx
|
|
|
58
58
|
#
|
|
59
59
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
60
60
|
#
|
|
61
|
+
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
62
|
+
#
|
|
61
63
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
62
64
|
#
|
|
63
65
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
@@ -119,7 +121,7 @@ module Telnyx
|
|
|
119
121
|
#
|
|
120
122
|
# Update an AI Assistant's attributes.
|
|
121
123
|
#
|
|
122
|
-
# @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
124
|
+
# @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
123
125
|
#
|
|
124
126
|
# @param assistant_id [String]
|
|
125
127
|
#
|
|
@@ -145,6 +147,8 @@ module Telnyx
|
|
|
145
147
|
#
|
|
146
148
|
# @param name [String]
|
|
147
149
|
#
|
|
150
|
+
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
151
|
+
#
|
|
148
152
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
149
153
|
#
|
|
150
154
|
# @param promote_to_main [Boolean] Indicates whether the assistant should be promoted to the main version. Defaults
|
|
@@ -1613,7 +1613,7 @@ module Telnyx
|
|
|
1613
1613
|
# - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
|
|
1614
1614
|
# was requested and a beep was detected
|
|
1615
1615
|
#
|
|
1616
|
-
# @overload transfer(call_control_id, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
1616
|
+
# @overload transfer(call_control_id, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
1617
1617
|
#
|
|
1618
1618
|
# @param call_control_id [String] Unique identifier and token for controlling the call
|
|
1619
1619
|
#
|
|
@@ -1647,6 +1647,8 @@ module Telnyx
|
|
|
1647
1647
|
#
|
|
1648
1648
|
# @param preferred_codecs [String] The list of comma-separated codecs in order of preference to be used during the
|
|
1649
1649
|
#
|
|
1650
|
+
# @param privacy [Symbol, Telnyx::Models::Calls::ActionTransferParams::Privacy] Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
1651
|
+
#
|
|
1650
1652
|
# @param record [Symbol, Telnyx::Models::Calls::ActionTransferParams::Record] Start recording automatically after an event. Disabled by default.
|
|
1651
1653
|
#
|
|
1652
1654
|
# @param record_channels [Symbol, Telnyx::Models::Calls::ActionTransferParams::RecordChannels] Defines which channel should be recorded ('single' or 'dual') when `record` is s
|
|
@@ -31,7 +31,7 @@ module Telnyx
|
|
|
31
31
|
# When the `record` parameter is set to `record-from-answer`, the response will
|
|
32
32
|
# include a `recording_id` field.
|
|
33
33
|
#
|
|
34
|
-
# @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
|
|
34
|
+
# @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
|
|
35
35
|
#
|
|
36
36
|
# @param connection_id [String] The ID of the Call Control App (formerly ID of the connection) to be used when d
|
|
37
37
|
#
|
|
@@ -77,6 +77,8 @@ module Telnyx
|
|
|
77
77
|
#
|
|
78
78
|
# @param prevent_double_bridge [Boolean] Prevents bridging and hangs up the call if the target is already bridged. Disabl
|
|
79
79
|
#
|
|
80
|
+
# @param privacy [Symbol, Telnyx::Models::CallDialParams::Privacy] Indicates the privacy level to be used for the call. When set to `id`, caller ID
|
|
81
|
+
#
|
|
80
82
|
# @param record [Symbol, Telnyx::Models::CallDialParams::Record] Start recording automatically after an event. Disabled by default.
|
|
81
83
|
#
|
|
82
84
|
# @param record_channels [Symbol, Telnyx::Models::CallDialParams::RecordChannels] Defines which channel should be recorded ('single' or 'dual') when `record` is s
|
|
@@ -7,44 +7,6 @@ module Telnyx
|
|
|
7
7
|
# Associate phone numbers with an enterprise for reputation monitoring and
|
|
8
8
|
# retrieve reputation scores
|
|
9
9
|
class Numbers
|
|
10
|
-
# Associate one or more phone numbers with an enterprise for Number Reputation
|
|
11
|
-
# monitoring.
|
|
12
|
-
#
|
|
13
|
-
# **Validations:**
|
|
14
|
-
#
|
|
15
|
-
# - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
16
|
-
# - Phone numbers must be in-service and belong to your account (verified via
|
|
17
|
-
# Warehouse)
|
|
18
|
-
# - Phone numbers must be US local numbers
|
|
19
|
-
# - Phone numbers cannot already be associated with any enterprise
|
|
20
|
-
#
|
|
21
|
-
# **Note:** This operation is atomic — if any number fails validation, the entire
|
|
22
|
-
# request fails.
|
|
23
|
-
#
|
|
24
|
-
# **Maximum:** 100 phone numbers per request.
|
|
25
|
-
#
|
|
26
|
-
# @overload create(enterprise_id, phone_numbers:, request_options: {})
|
|
27
|
-
#
|
|
28
|
-
# @param enterprise_id [String] Unique identifier of the enterprise (UUID)
|
|
29
|
-
#
|
|
30
|
-
# @param phone_numbers [Array<String>] List of phone numbers to associate for reputation monitoring (max 100)
|
|
31
|
-
#
|
|
32
|
-
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
33
|
-
#
|
|
34
|
-
# @return [Telnyx::Models::Enterprises::Reputation::NumberCreateResponse]
|
|
35
|
-
#
|
|
36
|
-
# @see Telnyx::Models::Enterprises::Reputation::NumberCreateParams
|
|
37
|
-
def create(enterprise_id, params)
|
|
38
|
-
parsed, options = Telnyx::Enterprises::Reputation::NumberCreateParams.dump_request(params)
|
|
39
|
-
@client.request(
|
|
40
|
-
method: :post,
|
|
41
|
-
path: ["enterprises/%1$s/reputation/numbers", enterprise_id],
|
|
42
|
-
body: parsed,
|
|
43
|
-
model: Telnyx::Models::Enterprises::Reputation::NumberCreateResponse,
|
|
44
|
-
options: options
|
|
45
|
-
)
|
|
46
|
-
end
|
|
47
|
-
|
|
48
10
|
# Some parameter documentations has been truncated, see
|
|
49
11
|
# {Telnyx::Models::Enterprises::Reputation::NumberRetrieveParams} for more
|
|
50
12
|
# details.
|
|
@@ -131,12 +93,50 @@ module Telnyx
|
|
|
131
93
|
)
|
|
132
94
|
end
|
|
133
95
|
|
|
96
|
+
# Associate one or more phone numbers with an enterprise for Number Reputation
|
|
97
|
+
# monitoring.
|
|
98
|
+
#
|
|
99
|
+
# **Validations:**
|
|
100
|
+
#
|
|
101
|
+
# - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
102
|
+
# - Phone numbers must be in-service and belong to your account (verified via
|
|
103
|
+
# Warehouse)
|
|
104
|
+
# - Phone numbers must be US local numbers
|
|
105
|
+
# - Phone numbers cannot already be associated with any enterprise
|
|
106
|
+
#
|
|
107
|
+
# **Note:** This operation is atomic — if any number fails validation, the entire
|
|
108
|
+
# request fails.
|
|
109
|
+
#
|
|
110
|
+
# **Maximum:** 100 phone numbers per request.
|
|
111
|
+
#
|
|
112
|
+
# @overload associate(enterprise_id, phone_numbers:, request_options: {})
|
|
113
|
+
#
|
|
114
|
+
# @param enterprise_id [String] Unique identifier of the enterprise (UUID)
|
|
115
|
+
#
|
|
116
|
+
# @param phone_numbers [Array<String>] List of phone numbers to associate for reputation monitoring (max 100)
|
|
117
|
+
#
|
|
118
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
119
|
+
#
|
|
120
|
+
# @return [Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse]
|
|
121
|
+
#
|
|
122
|
+
# @see Telnyx::Models::Enterprises::Reputation::NumberAssociateParams
|
|
123
|
+
def associate(enterprise_id, params)
|
|
124
|
+
parsed, options = Telnyx::Enterprises::Reputation::NumberAssociateParams.dump_request(params)
|
|
125
|
+
@client.request(
|
|
126
|
+
method: :post,
|
|
127
|
+
path: ["enterprises/%1$s/reputation/numbers", enterprise_id],
|
|
128
|
+
body: parsed,
|
|
129
|
+
model: Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse,
|
|
130
|
+
options: options
|
|
131
|
+
)
|
|
132
|
+
end
|
|
133
|
+
|
|
134
134
|
# Remove a phone number from Number Reputation monitoring for an enterprise.
|
|
135
135
|
#
|
|
136
136
|
# The number will no longer be tracked and reputation data will no longer be
|
|
137
137
|
# refreshed.
|
|
138
138
|
#
|
|
139
|
-
# @overload
|
|
139
|
+
# @overload disassociate(phone_number, enterprise_id:, request_options: {})
|
|
140
140
|
#
|
|
141
141
|
# @param phone_number [String] Phone number in E.164 format
|
|
142
142
|
#
|
|
@@ -146,9 +146,9 @@ module Telnyx
|
|
|
146
146
|
#
|
|
147
147
|
# @return [nil]
|
|
148
148
|
#
|
|
149
|
-
# @see Telnyx::Models::Enterprises::Reputation::
|
|
150
|
-
def
|
|
151
|
-
parsed, options = Telnyx::Enterprises::Reputation::
|
|
149
|
+
# @see Telnyx::Models::Enterprises::Reputation::NumberDisassociateParams
|
|
150
|
+
def disassociate(phone_number, params)
|
|
151
|
+
parsed, options = Telnyx::Enterprises::Reputation::NumberDisassociateParams.dump_request(params)
|
|
152
152
|
enterprise_id =
|
|
153
153
|
parsed.delete(:enterprise_id) do
|
|
154
154
|
raise ArgumentError.new("missing required path argument #{_1}")
|
|
@@ -11,59 +11,6 @@ module Telnyx
|
|
|
11
11
|
# @return [Telnyx::Resources::Enterprises::Reputation::Numbers]
|
|
12
12
|
attr_reader :numbers
|
|
13
13
|
|
|
14
|
-
# Some parameter documentations has been truncated, see
|
|
15
|
-
# {Telnyx::Models::Enterprises::ReputationCreateParams} for more details.
|
|
16
|
-
#
|
|
17
|
-
# Enable Number Reputation service for an enterprise.
|
|
18
|
-
#
|
|
19
|
-
# **Requirements:**
|
|
20
|
-
#
|
|
21
|
-
# - Signed LOA (Letter of Authorization) document ID
|
|
22
|
-
# - Reputation check frequency (defaults to `business_daily`)
|
|
23
|
-
# - Number Reputation Terms of Service must be accepted
|
|
24
|
-
#
|
|
25
|
-
# **Flow:**
|
|
26
|
-
#
|
|
27
|
-
# 1. Registers the enterprise for reputation monitoring
|
|
28
|
-
# 2. Creates reputation settings with `pending` status
|
|
29
|
-
# 3. Awaits admin approval before monitoring begins
|
|
30
|
-
#
|
|
31
|
-
# **Resubmission After Rejection:** If a previously rejected record exists, this
|
|
32
|
-
# endpoint will delete it and create a new `pending` record.
|
|
33
|
-
#
|
|
34
|
-
# **Available Frequencies:**
|
|
35
|
-
#
|
|
36
|
-
# - `business_daily` — Monday–Friday
|
|
37
|
-
# - `daily` — Every day
|
|
38
|
-
# - `weekly` — Once per week
|
|
39
|
-
# - `biweekly` — Once every two weeks
|
|
40
|
-
# - `monthly` — Once per month
|
|
41
|
-
# - `never` — Manual refresh only
|
|
42
|
-
#
|
|
43
|
-
# @overload create(enterprise_id, loa_document_id:, check_frequency: nil, request_options: {})
|
|
44
|
-
#
|
|
45
|
-
# @param enterprise_id [String] Unique identifier of the enterprise (UUID)
|
|
46
|
-
#
|
|
47
|
-
# @param loa_document_id [String] ID of the signed Letter of Authorization (LOA) document uploaded to the document
|
|
48
|
-
#
|
|
49
|
-
# @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationCreateParams::CheckFrequency] Frequency for automatically refreshing reputation data
|
|
50
|
-
#
|
|
51
|
-
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
52
|
-
#
|
|
53
|
-
# @return [Telnyx::Models::Enterprises::ReputationCreateResponse]
|
|
54
|
-
#
|
|
55
|
-
# @see Telnyx::Models::Enterprises::ReputationCreateParams
|
|
56
|
-
def create(enterprise_id, params)
|
|
57
|
-
parsed, options = Telnyx::Enterprises::ReputationCreateParams.dump_request(params)
|
|
58
|
-
@client.request(
|
|
59
|
-
method: :post,
|
|
60
|
-
path: ["enterprises/%1$s/reputation", enterprise_id],
|
|
61
|
-
body: parsed,
|
|
62
|
-
model: Telnyx::Models::Enterprises::ReputationCreateResponse,
|
|
63
|
-
options: options
|
|
64
|
-
)
|
|
65
|
-
end
|
|
66
|
-
|
|
67
14
|
# Retrieve the current Number Reputation settings for an enterprise.
|
|
68
15
|
#
|
|
69
16
|
# Returns the enrollment status (`pending`, `approved`, `rejected`, `deleted`),
|
|
@@ -71,20 +18,20 @@ module Telnyx
|
|
|
71
18
|
#
|
|
72
19
|
# Returns `404` if reputation has not been enabled for this enterprise.
|
|
73
20
|
#
|
|
74
|
-
# @overload
|
|
21
|
+
# @overload retrieve(enterprise_id, request_options: {})
|
|
75
22
|
#
|
|
76
23
|
# @param enterprise_id [String] Unique identifier of the enterprise (UUID)
|
|
77
24
|
#
|
|
78
25
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
79
26
|
#
|
|
80
|
-
# @return [Telnyx::Models::Enterprises::
|
|
27
|
+
# @return [Telnyx::Models::Enterprises::ReputationRetrieveResponse]
|
|
81
28
|
#
|
|
82
|
-
# @see Telnyx::Models::Enterprises::
|
|
83
|
-
def
|
|
29
|
+
# @see Telnyx::Models::Enterprises::ReputationRetrieveParams
|
|
30
|
+
def retrieve(enterprise_id, params = {})
|
|
84
31
|
@client.request(
|
|
85
32
|
method: :get,
|
|
86
33
|
path: ["enterprises/%1$s/reputation", enterprise_id],
|
|
87
|
-
model: Telnyx::Models::Enterprises::
|
|
34
|
+
model: Telnyx::Models::Enterprises::ReputationRetrieveResponse,
|
|
88
35
|
options: params[:request_options]
|
|
89
36
|
)
|
|
90
37
|
end
|
|
@@ -99,7 +46,7 @@ module Telnyx
|
|
|
99
46
|
#
|
|
100
47
|
# **Note:** Can only be performed on `approved` reputation settings.
|
|
101
48
|
#
|
|
102
|
-
# @overload
|
|
49
|
+
# @overload disable(enterprise_id, request_options: {})
|
|
103
50
|
#
|
|
104
51
|
# @param enterprise_id [String] Unique identifier of the enterprise (UUID)
|
|
105
52
|
#
|
|
@@ -107,8 +54,8 @@ module Telnyx
|
|
|
107
54
|
#
|
|
108
55
|
# @return [nil]
|
|
109
56
|
#
|
|
110
|
-
# @see Telnyx::Models::Enterprises::
|
|
111
|
-
def
|
|
57
|
+
# @see Telnyx::Models::Enterprises::ReputationDisableParams
|
|
58
|
+
def disable(enterprise_id, params = {})
|
|
112
59
|
@client.request(
|
|
113
60
|
method: :delete,
|
|
114
61
|
path: ["enterprises/%1$s/reputation", enterprise_id],
|
|
@@ -117,6 +64,59 @@ module Telnyx
|
|
|
117
64
|
)
|
|
118
65
|
end
|
|
119
66
|
|
|
67
|
+
# Some parameter documentations has been truncated, see
|
|
68
|
+
# {Telnyx::Models::Enterprises::ReputationEnableParams} for more details.
|
|
69
|
+
#
|
|
70
|
+
# Enable Number Reputation service for an enterprise.
|
|
71
|
+
#
|
|
72
|
+
# **Requirements:**
|
|
73
|
+
#
|
|
74
|
+
# - Signed LOA (Letter of Authorization) document ID
|
|
75
|
+
# - Reputation check frequency (defaults to `business_daily`)
|
|
76
|
+
# - Number Reputation Terms of Service must be accepted
|
|
77
|
+
#
|
|
78
|
+
# **Flow:**
|
|
79
|
+
#
|
|
80
|
+
# 1. Registers the enterprise for reputation monitoring
|
|
81
|
+
# 2. Creates reputation settings with `pending` status
|
|
82
|
+
# 3. Awaits admin approval before monitoring begins
|
|
83
|
+
#
|
|
84
|
+
# **Resubmission After Rejection:** If a previously rejected record exists, this
|
|
85
|
+
# endpoint will delete it and create a new `pending` record.
|
|
86
|
+
#
|
|
87
|
+
# **Available Frequencies:**
|
|
88
|
+
#
|
|
89
|
+
# - `business_daily` — Monday–Friday
|
|
90
|
+
# - `daily` — Every day
|
|
91
|
+
# - `weekly` — Once per week
|
|
92
|
+
# - `biweekly` — Once every two weeks
|
|
93
|
+
# - `monthly` — Once per month
|
|
94
|
+
# - `never` — Manual refresh only
|
|
95
|
+
#
|
|
96
|
+
# @overload enable(enterprise_id, loa_document_id:, check_frequency: nil, request_options: {})
|
|
97
|
+
#
|
|
98
|
+
# @param enterprise_id [String] Unique identifier of the enterprise (UUID)
|
|
99
|
+
#
|
|
100
|
+
# @param loa_document_id [String] ID of the signed Letter of Authorization (LOA) document uploaded to the document
|
|
101
|
+
#
|
|
102
|
+
# @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationEnableParams::CheckFrequency] Frequency for automatically refreshing reputation data
|
|
103
|
+
#
|
|
104
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
105
|
+
#
|
|
106
|
+
# @return [Telnyx::Models::Enterprises::ReputationEnableResponse]
|
|
107
|
+
#
|
|
108
|
+
# @see Telnyx::Models::Enterprises::ReputationEnableParams
|
|
109
|
+
def enable(enterprise_id, params)
|
|
110
|
+
parsed, options = Telnyx::Enterprises::ReputationEnableParams.dump_request(params)
|
|
111
|
+
@client.request(
|
|
112
|
+
method: :post,
|
|
113
|
+
path: ["enterprises/%1$s/reputation", enterprise_id],
|
|
114
|
+
body: parsed,
|
|
115
|
+
model: Telnyx::Models::Enterprises::ReputationEnableResponse,
|
|
116
|
+
options: options
|
|
117
|
+
)
|
|
118
|
+
end
|
|
119
|
+
|
|
120
120
|
# Update how often reputation data is automatically refreshed.
|
|
121
121
|
#
|
|
122
122
|
# **Note:** The enterprise must have `approved` reputation settings. Updating
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
# Manage pronunciation dictionaries for text-to-speech synthesis. Dictionaries
|
|
6
|
+
# contain alias items (text replacement) and phoneme items (IPA pronunciation
|
|
7
|
+
# notation) that control how specific words are spoken.
|
|
8
|
+
class PronunciationDicts
|
|
9
|
+
# Some parameter documentations has been truncated, see
|
|
10
|
+
# {Telnyx::Models::PronunciationDictCreateParams} for more details.
|
|
11
|
+
#
|
|
12
|
+
# Create a new pronunciation dictionary for the authenticated organization. Each
|
|
13
|
+
# dictionary contains a list of items that control how specific words are spoken.
|
|
14
|
+
# Items can be alias type (text replacement) or phoneme type (IPA pronunciation
|
|
15
|
+
# notation).
|
|
16
|
+
#
|
|
17
|
+
# As an alternative to providing items directly as JSON, you can upload a
|
|
18
|
+
# dictionary file (PLS/XML or plain text format, max 1MB) using
|
|
19
|
+
# multipart/form-data. PLS files use the standard W3C Pronunciation Lexicon
|
|
20
|
+
# Specification XML format. Text files use a line-based format: `word=alias` for
|
|
21
|
+
# aliases, `word:/phoneme/` for IPA phonemes.
|
|
22
|
+
#
|
|
23
|
+
# Limits:
|
|
24
|
+
#
|
|
25
|
+
# - Maximum 50 dictionaries per organization
|
|
26
|
+
# - Maximum 100 items per dictionary
|
|
27
|
+
# - Text: max 200 characters
|
|
28
|
+
# - Alias/phoneme value: max 500 characters
|
|
29
|
+
# - File upload: max 1MB (1,048,576 bytes)
|
|
30
|
+
#
|
|
31
|
+
# @overload create(items:, name:, request_options: {})
|
|
32
|
+
#
|
|
33
|
+
# @param items [Array<Telnyx::Models::PronunciationDictCreateParams::Item::Alias, Telnyx::Models::PronunciationDictCreateParams::Item::Phoneme>] List of pronunciation items (alias or phoneme type). At least one item is requir
|
|
34
|
+
#
|
|
35
|
+
# @param name [String] Human-readable name. Must be unique within the organization.
|
|
36
|
+
#
|
|
37
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
38
|
+
#
|
|
39
|
+
# @return [Telnyx::Models::PronunciationDictCreateResponse]
|
|
40
|
+
#
|
|
41
|
+
# @see Telnyx::Models::PronunciationDictCreateParams
|
|
42
|
+
def create(params)
|
|
43
|
+
parsed, options = Telnyx::PronunciationDictCreateParams.dump_request(params)
|
|
44
|
+
@client.request(
|
|
45
|
+
method: :post,
|
|
46
|
+
path: "pronunciation_dicts",
|
|
47
|
+
body: parsed,
|
|
48
|
+
model: Telnyx::Models::PronunciationDictCreateResponse,
|
|
49
|
+
options: options
|
|
50
|
+
)
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# Retrieve a single pronunciation dictionary by ID.
|
|
54
|
+
#
|
|
55
|
+
# @overload retrieve(id, request_options: {})
|
|
56
|
+
#
|
|
57
|
+
# @param id [String] The UUID of the pronunciation dictionary.
|
|
58
|
+
#
|
|
59
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
60
|
+
#
|
|
61
|
+
# @return [Telnyx::Models::PronunciationDictRetrieveResponse]
|
|
62
|
+
#
|
|
63
|
+
# @see Telnyx::Models::PronunciationDictRetrieveParams
|
|
64
|
+
def retrieve(id, params = {})
|
|
65
|
+
@client.request(
|
|
66
|
+
method: :get,
|
|
67
|
+
path: ["pronunciation_dicts/%1$s", id],
|
|
68
|
+
model: Telnyx::Models::PronunciationDictRetrieveResponse,
|
|
69
|
+
options: params[:request_options]
|
|
70
|
+
)
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# Update the name and/or items of an existing pronunciation dictionary. Uses
|
|
74
|
+
# optimistic locking — if the dictionary was modified concurrently, the request
|
|
75
|
+
# returns 409 Conflict.
|
|
76
|
+
#
|
|
77
|
+
# @overload update(id, items: nil, name: nil, request_options: {})
|
|
78
|
+
#
|
|
79
|
+
# @param id [String] The UUID of the pronunciation dictionary.
|
|
80
|
+
#
|
|
81
|
+
# @param items [Array<Telnyx::Models::PronunciationDictUpdateParams::Item::Alias, Telnyx::Models::PronunciationDictUpdateParams::Item::Phoneme>] Updated list of pronunciation items (alias or phoneme type).
|
|
82
|
+
#
|
|
83
|
+
# @param name [String] Updated dictionary name.
|
|
84
|
+
#
|
|
85
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
86
|
+
#
|
|
87
|
+
# @return [Telnyx::Models::PronunciationDictUpdateResponse]
|
|
88
|
+
#
|
|
89
|
+
# @see Telnyx::Models::PronunciationDictUpdateParams
|
|
90
|
+
def update(id, params = {})
|
|
91
|
+
parsed, options = Telnyx::PronunciationDictUpdateParams.dump_request(params)
|
|
92
|
+
@client.request(
|
|
93
|
+
method: :patch,
|
|
94
|
+
path: ["pronunciation_dicts/%1$s", id],
|
|
95
|
+
body: parsed,
|
|
96
|
+
model: Telnyx::Models::PronunciationDictUpdateResponse,
|
|
97
|
+
options: options
|
|
98
|
+
)
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# List all pronunciation dictionaries for the authenticated organization. Results
|
|
102
|
+
# are paginated using offset-based pagination.
|
|
103
|
+
#
|
|
104
|
+
# @overload list(page_number: nil, page_size: nil, request_options: {})
|
|
105
|
+
#
|
|
106
|
+
# @param page_number [Integer] Page number (1-based). Defaults to 1.
|
|
107
|
+
#
|
|
108
|
+
# @param page_size [Integer] Number of results per page. Defaults to 20, maximum 250.
|
|
109
|
+
#
|
|
110
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
111
|
+
#
|
|
112
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PronunciationDictListResponse>]
|
|
113
|
+
#
|
|
114
|
+
# @see Telnyx::Models::PronunciationDictListParams
|
|
115
|
+
def list(params = {})
|
|
116
|
+
parsed, options = Telnyx::PronunciationDictListParams.dump_request(params)
|
|
117
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
118
|
+
@client.request(
|
|
119
|
+
method: :get,
|
|
120
|
+
path: "pronunciation_dicts",
|
|
121
|
+
query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
122
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
123
|
+
model: Telnyx::Models::PronunciationDictListResponse,
|
|
124
|
+
options: options
|
|
125
|
+
)
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Permanently delete a pronunciation dictionary.
|
|
129
|
+
#
|
|
130
|
+
# @overload delete(id, request_options: {})
|
|
131
|
+
#
|
|
132
|
+
# @param id [String] The UUID of the pronunciation dictionary.
|
|
133
|
+
#
|
|
134
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
135
|
+
#
|
|
136
|
+
# @return [nil]
|
|
137
|
+
#
|
|
138
|
+
# @see Telnyx::Models::PronunciationDictDeleteParams
|
|
139
|
+
def delete(id, params = {})
|
|
140
|
+
@client.request(
|
|
141
|
+
method: :delete,
|
|
142
|
+
path: ["pronunciation_dicts/%1$s", id],
|
|
143
|
+
model: NilClass,
|
|
144
|
+
options: params[:request_options]
|
|
145
|
+
)
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# @api private
|
|
149
|
+
#
|
|
150
|
+
# @param client [Telnyx::Client]
|
|
151
|
+
def initialize(client:)
|
|
152
|
+
@client = client
|
|
153
|
+
end
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
end
|
|
@@ -99,95 +99,14 @@ module Telnyx
|
|
|
99
99
|
)
|
|
100
100
|
end
|
|
101
101
|
|
|
102
|
-
# Some parameter documentations has been truncated, see
|
|
103
|
-
# {Telnyx::Models::Texml::Accounts::CallCallsParams} for more details.
|
|
104
|
-
#
|
|
105
102
|
# Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request
|
|
106
103
|
# URL configured for the connection in the Mission Control Portal.
|
|
107
104
|
#
|
|
108
|
-
# @overload calls(account_sid,
|
|
105
|
+
# @overload calls(account_sid, body:, request_options: {})
|
|
109
106
|
#
|
|
110
107
|
# @param account_sid [String] The id of the account the resource belongs to.
|
|
111
108
|
#
|
|
112
|
-
# @param
|
|
113
|
-
#
|
|
114
|
-
# @param from [String] The phone number of the party that initiated the call. Phone numbers are formatt
|
|
115
|
-
#
|
|
116
|
-
# @param to [String] The phone number of the called party. Phone numbers are formatted with a `+` and
|
|
117
|
-
#
|
|
118
|
-
# @param async_amd [Boolean] Select whether to perform answering machine detection in the background. By defa
|
|
119
|
-
#
|
|
120
|
-
# @param async_amd_status_callback [String] URL destination for Telnyx to send AMD callback events to for the call.
|
|
121
|
-
#
|
|
122
|
-
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::AsyncAmdStatusCallbackMethod] HTTP request type used for `AsyncAmdStatusCallback`. The default value is inheri
|
|
123
|
-
#
|
|
124
|
-
# @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
|
|
125
|
-
#
|
|
126
|
-
# @param cancel_playback_on_detect_message_end [Boolean] Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `t
|
|
127
|
-
#
|
|
128
|
-
# @param cancel_playback_on_machine_detection [Boolean] Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
|
|
129
|
-
#
|
|
130
|
-
# @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
|
|
131
|
-
#
|
|
132
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
133
|
-
#
|
|
134
|
-
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
135
|
-
#
|
|
136
|
-
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::MachineDetection] Enables Answering Machine Detection.
|
|
137
|
-
#
|
|
138
|
-
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
139
|
-
#
|
|
140
|
-
# @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
141
|
-
#
|
|
142
|
-
# @param machine_detection_speech_threshold [Integer] Maximum threshold of a human greeting. If greeting longer than this value, consi
|
|
143
|
-
#
|
|
144
|
-
# @param machine_detection_timeout [Integer] Maximum timeout threshold in milliseconds for overall detection.
|
|
145
|
-
#
|
|
146
|
-
# @param preferred_codecs [String] The list of comma-separated codecs to be offered on a call.
|
|
147
|
-
#
|
|
148
|
-
# @param record [Boolean] Whether to record the entire participant's call leg. Defaults to `false`.
|
|
149
|
-
#
|
|
150
|
-
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::RecordingChannels] The number of channels in the final recording. Defaults to `mono`.
|
|
151
|
-
#
|
|
152
|
-
# @param recording_status_callback [String] The URL the recording callbacks will be sent to.
|
|
153
|
-
#
|
|
154
|
-
# @param recording_status_callback_event [String] The changes to the recording's state that should generate a call to `RecoridngSt
|
|
155
|
-
#
|
|
156
|
-
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::RecordingStatusCallbackMethod] HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
157
|
-
#
|
|
158
|
-
# @param recording_timeout [Integer] The number of seconds that Telnyx will wait for the recording to be stopped if s
|
|
159
|
-
#
|
|
160
|
-
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::RecordingTrack] The audio track to record for the call. The default is `both`.
|
|
161
|
-
#
|
|
162
|
-
# @param send_recording_url [Boolean] Whether to send RecordingUrl in webhooks.
|
|
163
|
-
#
|
|
164
|
-
# @param sip_auth_password [String] The password to use for SIP authentication.
|
|
165
|
-
#
|
|
166
|
-
# @param sip_auth_username [String] The username to use for SIP authentication.
|
|
167
|
-
#
|
|
168
|
-
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::SipRegion] Defines the SIP region to be used for the call.
|
|
169
|
-
#
|
|
170
|
-
# @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
|
|
171
|
-
#
|
|
172
|
-
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::StatusCallbackEvent] The call events for which Telnyx should send a webhook. Multiple events can be d
|
|
173
|
-
#
|
|
174
|
-
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
|
|
175
|
-
#
|
|
176
|
-
# @param supervise_call_sid [String] The call control ID of the existing call to supervise. When provided, the create
|
|
177
|
-
#
|
|
178
|
-
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::SupervisingRole] The supervising role for the new leg. Determines the audio behavior: barge (hear
|
|
179
|
-
#
|
|
180
|
-
# @param texml [String] TeXML to be used as instructions for the call. If provided, the call will execut
|
|
181
|
-
#
|
|
182
|
-
# @param time_limit [Integer] The maximum duration of the call in seconds. The minimum value is 30 and the max
|
|
183
|
-
#
|
|
184
|
-
# @param timeout_seconds [Integer] The number of seconds to wait for the called party to answer the call before the
|
|
185
|
-
#
|
|
186
|
-
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Trim] Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
187
|
-
#
|
|
188
|
-
# @param url [String] The URL from which Telnyx will retrieve the TeXML call instructions.
|
|
189
|
-
#
|
|
190
|
-
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::URLMethod] HTTP request type used for `Url`. The default value is inherited from TeXML Appl
|
|
109
|
+
# @param body [Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault]
|
|
191
110
|
#
|
|
192
111
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
193
112
|
#
|
|
@@ -199,7 +118,7 @@ module Telnyx
|
|
|
199
118
|
@client.request(
|
|
200
119
|
method: :post,
|
|
201
120
|
path: ["texml/Accounts/%1$s/Calls", account_sid],
|
|
202
|
-
body: parsed,
|
|
121
|
+
body: parsed[:body],
|
|
203
122
|
model: Telnyx::Models::Texml::Accounts::CallCallsResponse,
|
|
204
123
|
options: options
|
|
205
124
|
)
|