telnyx 5.0.0 → 5.2.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 +46 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +4 -0
- data/lib/telnyx/internal/type/union.rb +1 -1
- data/lib/telnyx/models/ai/assistant.rb +39 -4
- data/lib/telnyx/models/ai/assistant_create_params.rb +17 -6
- data/lib/telnyx/models/ai/assistant_imports_params.rb +10 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +400 -3
- data/lib/telnyx/models/ai/assistant_update_params.rb +17 -6
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +17 -6
- data/lib/telnyx/models/ai/audio_visualizer_config.rb +43 -0
- data/lib/telnyx/models/ai/bucket_ids.rb +7 -1
- data/lib/telnyx/models/ai/chat_create_completion_params.rb +4 -4
- data/lib/telnyx/models/ai/inference_embedding.rb +17 -6
- data/lib/telnyx/models/ai/messaging_settings.rb +10 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +3 -3
- data/lib/telnyx/models/ai/telephony_settings.rb +142 -1
- data/lib/telnyx/models/ai/transfer_tool.rb +46 -3
- data/lib/telnyx/models/ai/voice_settings.rb +1 -1
- data/lib/telnyx/models/ai/webhook_tool.rb +256 -3
- data/lib/telnyx/models/ai/widget_settings.rb +138 -0
- data/lib/telnyx/models/call_control_application_list_params.rb +16 -18
- data/lib/telnyx/models/call_event_list_params.rb +16 -18
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +289 -0
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_response.rb +18 -0
- data/lib/telnyx/models/calls/action_start_noise_suppression_params.rb +7 -4
- data/lib/telnyx/models/conference_list_params.rb +16 -18
- data/lib/telnyx/models/conference_list_participants_params.rb +16 -18
- data/lib/telnyx/models/connection_list_active_calls_params.rb +16 -18
- data/lib/telnyx/models/connection_noise_suppression_details.rb +61 -0
- data/lib/telnyx/models/credential_connection.rb +3 -61
- data/lib/telnyx/models/credential_connection_create_params.rb +3 -61
- data/lib/telnyx/models/credential_connection_update_params.rb +3 -61
- data/lib/telnyx/models/fax_create_params.rb +10 -1
- data/lib/telnyx/models/fqdn_connection.rb +3 -60
- data/lib/telnyx/models/fqdn_connection_create_params.rb +3 -60
- data/lib/telnyx/models/fqdn_connection_update_params.rb +3 -60
- data/lib/telnyx/models/ip_connection.rb +3 -60
- data/lib/telnyx/models/ip_connection_create_params.rb +3 -60
- data/lib/telnyx/models/ip_connection_update_params.rb +3 -60
- data/lib/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rb +1 -9
- data/lib/telnyx/models/messaging_profile.rb +11 -1
- data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
- data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +14 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +17 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +17 -1
- data/lib/telnyx/models/organizations/user_get_groups_report_params.rb +32 -0
- data/lib/telnyx/models/organizations/user_get_groups_report_response.rb +110 -0
- data/lib/telnyx/models/organizations/user_group_reference.rb +28 -0
- data/lib/telnyx/models/organizations/user_list_params.rb +73 -0
- data/lib/telnyx/models/organizations/user_list_response.rb +96 -0
- data/lib/telnyx/models/organizations/user_retrieve_params.rb +29 -0
- data/lib/telnyx/models/organizations/user_retrieve_response.rb +107 -0
- data/lib/telnyx/models/organizations/users/action_remove_params.rb +18 -0
- data/lib/telnyx/models/organizations/users/action_remove_response.rb +111 -0
- data/lib/telnyx/models/private_wireless_gateway_status.rb +3 -2
- data/lib/telnyx/models/queues/call_list_params.rb +16 -18
- data/lib/telnyx/models/sim_card_list_params.rb +11 -3
- data/lib/telnyx/models/texml/accounts/queue_list_params.rb +64 -0
- data/lib/telnyx/models/texml/accounts/queue_list_response.rb +155 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models/unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models.rb +4 -6
- data/lib/telnyx/resources/ai/assistants/tools.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +18 -16
- data/lib/telnyx/resources/ai/assistants.rb +15 -9
- data/lib/telnyx/resources/ai/clusters.rb +1 -1
- data/lib/telnyx/resources/ai/embeddings.rb +1 -1
- data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +1 -1
- data/lib/telnyx/resources/call_control_applications.rb +8 -4
- data/lib/telnyx/resources/call_events.rb +8 -4
- data/lib/telnyx/resources/calls/actions.rb +31 -0
- data/lib/telnyx/resources/conferences.rb +16 -8
- data/lib/telnyx/resources/connections.rb +8 -4
- data/lib/telnyx/resources/credential_connections.rb +2 -2
- data/lib/telnyx/resources/faxes.rb +3 -1
- data/lib/telnyx/resources/fqdn_connections.rb +2 -2
- data/lib/telnyx/resources/ip_connections.rb +2 -2
- data/lib/telnyx/resources/messages.rb +1 -1
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +10 -14
- data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +6 -6
- data/lib/telnyx/resources/messaging_profiles.rb +6 -2
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +6 -2
- data/lib/telnyx/resources/operator_connect/actions.rb +1 -1
- data/lib/telnyx/resources/organizations/users/actions.rb +38 -0
- data/lib/telnyx/resources/organizations/users.rb +114 -0
- data/lib/telnyx/resources/organizations.rb +18 -0
- data/lib/telnyx/resources/phone_numbers/jobs.rb +1 -1
- data/lib/telnyx/resources/queues/calls.rb +8 -4
- data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
- data/lib/telnyx/resources/texml/accounts/calls/recordings.rb +1 -1
- data/lib/telnyx/resources/texml/accounts/queues.rb +41 -0
- data/lib/telnyx/resources/usage_reports.rb +2 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +19 -69
- data/rbi/telnyx/client.rbi +3 -0
- data/rbi/telnyx/models/ai/assistant.rbi +91 -5
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +31 -14
- data/rbi/telnyx/models/ai/assistant_imports_params.rbi +13 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +910 -2
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +31 -14
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +36 -17
- data/rbi/telnyx/models/ai/audio_visualizer_config.rbi +107 -0
- data/rbi/telnyx/models/ai/bucket_ids.rbi +6 -0
- data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +6 -13
- data/rbi/telnyx/models/ai/inference_embedding.rbi +30 -13
- data/rbi/telnyx/models/ai/messaging_settings.rbi +13 -0
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +4 -8
- data/rbi/telnyx/models/ai/telephony_settings.rbi +347 -3
- data/rbi/telnyx/models/ai/transfer_tool.rbi +87 -6
- data/rbi/telnyx/models/ai/voice_settings.rbi +2 -2
- data/rbi/telnyx/models/ai/webhook_tool.rbi +584 -8
- data/rbi/telnyx/models/ai/widget_settings.rbi +225 -0
- data/rbi/telnyx/models/call_control_application_list_params.rbi +23 -35
- data/rbi/telnyx/models/call_event_list_params.rbi +23 -35
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +583 -0
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_response.rbi +39 -0
- data/rbi/telnyx/models/calls/action_start_noise_suppression_params.rbi +14 -6
- data/rbi/telnyx/models/conference_list_params.rbi +23 -35
- data/rbi/telnyx/models/conference_list_participants_params.rbi +23 -35
- data/rbi/telnyx/models/connection_list_active_calls_params.rbi +23 -35
- data/rbi/telnyx/models/connection_noise_suppression_details.rbi +141 -0
- data/rbi/telnyx/models/credential_connection.rbi +4 -152
- data/rbi/telnyx/models/credential_connection_create_params.rbi +4 -154
- data/rbi/telnyx/models/credential_connection_update_params.rbi +4 -154
- data/rbi/telnyx/models/fax_create_params.rbi +13 -0
- data/rbi/telnyx/models/fqdn_connection.rbi +4 -150
- data/rbi/telnyx/models/fqdn_connection_create_params.rbi +4 -152
- data/rbi/telnyx/models/fqdn_connection_update_params.rbi +4 -152
- data/rbi/telnyx/models/ip_connection.rbi +4 -148
- data/rbi/telnyx/models/ip_connection_create_params.rbi +4 -152
- data/rbi/telnyx/models/ip_connection_update_params.rbi +4 -152
- data/rbi/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbi +5 -21
- data/rbi/telnyx/models/messaging_profile.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +12 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +10 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +10 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_params.rbi +93 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi +210 -0
- data/rbi/telnyx/models/organizations/user_group_reference.rbi +39 -0
- data/rbi/telnyx/models/organizations/user_list_params.rbi +152 -0
- data/rbi/telnyx/models/organizations/user_list_response.rbi +188 -0
- data/rbi/telnyx/models/organizations/user_retrieve_params.rbi +55 -0
- data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +232 -0
- data/rbi/telnyx/models/organizations/users/action_remove_params.rbi +34 -0
- data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +239 -0
- data/rbi/telnyx/models/private_wireless_gateway_status.rbi +4 -2
- data/rbi/telnyx/models/queues/call_list_params.rbi +23 -35
- data/rbi/telnyx/models/sim_card_list_params.rbi +14 -3
- data/rbi/telnyx/models/texml/accounts/queue_list_params.rbi +103 -0
- data/rbi/telnyx/models/texml/accounts/queue_list_response.rbi +269 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models.rbi +5 -6
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +25 -19
- data/rbi/telnyx/resources/ai/assistants.rbi +30 -14
- data/rbi/telnyx/resources/ai/chat.rbi +1 -1
- data/rbi/telnyx/resources/ai/clusters.rbi +1 -1
- data/rbi/telnyx/resources/ai/embeddings.rbi +1 -1
- data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +1 -1
- data/rbi/telnyx/resources/call_control_applications.rbi +7 -1
- data/rbi/telnyx/resources/call_events.rbi +5 -1
- data/rbi/telnyx/resources/calls/actions.rbi +37 -2
- data/rbi/telnyx/resources/conferences.rbi +10 -2
- data/rbi/telnyx/resources/connections.rbi +5 -1
- data/rbi/telnyx/resources/credential_connections.rbi +2 -2
- data/rbi/telnyx/resources/faxes.rbi +4 -0
- data/rbi/telnyx/resources/fqdn_connections.rbi +2 -2
- data/rbi/telnyx/resources/ip_connections.rbi +2 -2
- data/rbi/telnyx/resources/messages.rbi +1 -1
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +8 -11
- data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +6 -6
- data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +10 -0
- data/rbi/telnyx/resources/operator_connect/actions.rbi +1 -1
- data/rbi/telnyx/resources/organizations/users/actions.rbi +32 -0
- data/rbi/telnyx/resources/organizations/users.rbi +88 -0
- data/rbi/telnyx/resources/organizations.rbi +15 -0
- data/rbi/telnyx/resources/phone_numbers/jobs.rbi +1 -1
- data/rbi/telnyx/resources/queues/calls.rbi +5 -1
- data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
- data/rbi/telnyx/resources/sim_cards.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/calls/recordings.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/queues.rbi +32 -0
- data/rbi/telnyx/resources/usage_reports.rbi +2 -2
- data/rbi/telnyx/resources/webhooks.rbi +0 -6
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistant.rbs +44 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +10 -1
- data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_tool.rbs +367 -2
- data/sig/telnyx/models/ai/assistant_update_params.rbs +10 -1
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +12 -3
- data/sig/telnyx/models/ai/audio_visualizer_config.rbs +48 -0
- data/sig/telnyx/models/ai/chat_create_completion_params.rbs +4 -7
- data/sig/telnyx/models/ai/inference_embedding.rbs +12 -3
- data/sig/telnyx/models/ai/messaging_settings.rbs +7 -0
- data/sig/telnyx/models/ai/retrieval_tool.rbs +4 -4
- data/sig/telnyx/models/ai/telephony_settings.rbs +133 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +42 -4
- data/sig/telnyx/models/ai/webhook_tool.rbs +241 -4
- data/sig/telnyx/models/ai/widget_settings.rbs +127 -0
- data/sig/telnyx/models/call_control_application_list_params.rbs +17 -26
- data/sig/telnyx/models/call_event_list_params.rbs +18 -27
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +240 -0
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_response.rbs +20 -0
- data/sig/telnyx/models/calls/action_start_noise_suppression_params.rbs +2 -1
- data/sig/telnyx/models/conference_list_params.rbs +17 -26
- data/sig/telnyx/models/conference_list_participants_params.rbs +17 -26
- data/sig/telnyx/models/connection_list_active_calls_params.rbs +20 -27
- data/sig/telnyx/models/connection_noise_suppression_details.rbs +54 -0
- data/sig/telnyx/models/credential_connection.rbs +6 -57
- data/sig/telnyx/models/credential_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/credential_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/fax_create_params.rbs +7 -0
- data/sig/telnyx/models/fqdn_connection.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/ip_connection.rbs +6 -57
- data/sig/telnyx/models/ip_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/ip_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbs +3 -13
- data/sig/telnyx/models/messaging_profile.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_create_params.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_update_params.rbs +7 -0
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +5 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_params.rbs +43 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_response.rbs +92 -0
- data/sig/telnyx/models/organizations/user_group_reference.rbs +17 -0
- data/sig/telnyx/models/organizations/user_list_params.rbs +72 -0
- data/sig/telnyx/models/organizations/user_list_response.rbs +87 -0
- data/sig/telnyx/models/organizations/user_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/organizations/user_retrieve_response.rbs +106 -0
- data/sig/telnyx/models/organizations/users/action_remove_params.rbs +19 -0
- data/sig/telnyx/models/organizations/users/action_remove_response.rbs +110 -0
- data/sig/telnyx/models/queues/call_list_params.rbs +20 -27
- data/sig/telnyx/models/sim_card_list_params.rbs +7 -0
- data/sig/telnyx/models/texml/accounts/queue_list_params.rbs +60 -0
- data/sig/telnyx/models/texml/accounts/queue_list_response.rbs +152 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models/unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models.rbs +4 -6
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +3 -0
- data/sig/telnyx/resources/call_control_applications.rbs +3 -1
- data/sig/telnyx/resources/call_events.rbs +3 -1
- data/sig/telnyx/resources/calls/actions.rbs +8 -0
- data/sig/telnyx/resources/conferences.rbs +6 -2
- data/sig/telnyx/resources/connections.rbs +3 -1
- data/sig/telnyx/resources/credential_connections.rbs +2 -2
- data/sig/telnyx/resources/faxes.rbs +1 -0
- data/sig/telnyx/resources/fqdn_connections.rbs +2 -2
- data/sig/telnyx/resources/ip_connections.rbs +2 -2
- data/sig/telnyx/resources/messaging_10dlc/brand.rbs +1 -2
- data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -0
- data/sig/telnyx/resources/organizations/users/actions.rbs +16 -0
- data/sig/telnyx/resources/organizations/users.rbs +31 -0
- data/sig/telnyx/resources/organizations.rbs +9 -0
- data/sig/telnyx/resources/queues/calls.rbs +3 -1
- data/sig/telnyx/resources/texml/accounts/queues.rbs +10 -0
- data/sig/telnyx/resources/webhooks.rbs +0 -6
- metadata +59 -20
- data/lib/telnyx/models/ai/inference_embedding_bucket_ids.rb +0 -31
- data/lib/telnyx/models/ai/inference_embedding_transfer_tool_params.rb +0 -93
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +0 -265
- data/lib/telnyx/models/streaming_failed_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_started_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_stopped_webhook_event.rb +0 -15
- data/rbi/telnyx/models/ai/inference_embedding_bucket_ids.rbi +0 -54
- data/rbi/telnyx/models/ai/inference_embedding_transfer_tool_params.rbi +0 -185
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +0 -621
- data/rbi/telnyx/models/streaming_failed_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_started_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_stopped_webhook_event.rbi +0 -30
- data/sig/telnyx/models/ai/inference_embedding_bucket_ids.rbs +0 -26
- data/sig/telnyx/models/ai/inference_embedding_transfer_tool_params.rbs +0 -75
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +0 -242
- data/sig/telnyx/models/streaming_failed_webhook_event.rbs +0 -15
- data/sig/telnyx/models/streaming_started_webhook_event.rbs +0 -16
- data/sig/telnyx/models/streaming_stopped_webhook_event.rbs +0 -16
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class WidgetSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute agent_thinking_text
|
|
8
|
+
# Text displayed while the agent is processing.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :agent_thinking_text, String
|
|
12
|
+
|
|
13
|
+
# @!attribute audio_visualizer_config
|
|
14
|
+
#
|
|
15
|
+
# @return [Telnyx::Models::AI::AudioVisualizerConfig, nil]
|
|
16
|
+
optional :audio_visualizer_config, -> { Telnyx::AI::AudioVisualizerConfig }
|
|
17
|
+
|
|
18
|
+
# @!attribute default_state
|
|
19
|
+
# The default state of the widget.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, Telnyx::Models::AI::WidgetSettings::DefaultState, nil]
|
|
22
|
+
optional :default_state, enum: -> { Telnyx::AI::WidgetSettings::DefaultState }
|
|
23
|
+
|
|
24
|
+
# @!attribute give_feedback_url
|
|
25
|
+
# URL for users to give feedback.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :give_feedback_url, String, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute logo_icon_url
|
|
31
|
+
# URL to a custom logo icon for the widget.
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :logo_icon_url, String, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute position
|
|
37
|
+
# The positioning style for the widget.
|
|
38
|
+
#
|
|
39
|
+
# @return [Symbol, Telnyx::Models::AI::WidgetSettings::Position, nil]
|
|
40
|
+
optional :position, enum: -> { Telnyx::AI::WidgetSettings::Position }
|
|
41
|
+
|
|
42
|
+
# @!attribute report_issue_url
|
|
43
|
+
# URL for users to report issues.
|
|
44
|
+
#
|
|
45
|
+
# @return [String, nil]
|
|
46
|
+
optional :report_issue_url, String, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute speak_to_interrupt_text
|
|
49
|
+
# Text prompting users to speak to interrupt.
|
|
50
|
+
#
|
|
51
|
+
# @return [String, nil]
|
|
52
|
+
optional :speak_to_interrupt_text, String
|
|
53
|
+
|
|
54
|
+
# @!attribute start_call_text
|
|
55
|
+
# Custom text displayed on the start call button.
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :start_call_text, String
|
|
59
|
+
|
|
60
|
+
# @!attribute theme
|
|
61
|
+
# The visual theme for the widget.
|
|
62
|
+
#
|
|
63
|
+
# @return [Symbol, Telnyx::Models::AI::WidgetSettings::Theme, nil]
|
|
64
|
+
optional :theme, enum: -> { Telnyx::AI::WidgetSettings::Theme }
|
|
65
|
+
|
|
66
|
+
# @!attribute view_history_url
|
|
67
|
+
# URL to view conversation history.
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :view_history_url, String, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
|
|
73
|
+
# Configuration settings for the assistant's web widget.
|
|
74
|
+
#
|
|
75
|
+
# @param agent_thinking_text [String] Text displayed while the agent is processing.
|
|
76
|
+
#
|
|
77
|
+
# @param audio_visualizer_config [Telnyx::Models::AI::AudioVisualizerConfig]
|
|
78
|
+
#
|
|
79
|
+
# @param default_state [Symbol, Telnyx::Models::AI::WidgetSettings::DefaultState] The default state of the widget.
|
|
80
|
+
#
|
|
81
|
+
# @param give_feedback_url [String, nil] URL for users to give feedback.
|
|
82
|
+
#
|
|
83
|
+
# @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
|
|
84
|
+
#
|
|
85
|
+
# @param position [Symbol, Telnyx::Models::AI::WidgetSettings::Position] The positioning style for the widget.
|
|
86
|
+
#
|
|
87
|
+
# @param report_issue_url [String, nil] URL for users to report issues.
|
|
88
|
+
#
|
|
89
|
+
# @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
|
|
90
|
+
#
|
|
91
|
+
# @param start_call_text [String] Custom text displayed on the start call button.
|
|
92
|
+
#
|
|
93
|
+
# @param theme [Symbol, Telnyx::Models::AI::WidgetSettings::Theme] The visual theme for the widget.
|
|
94
|
+
#
|
|
95
|
+
# @param view_history_url [String, nil] URL to view conversation history.
|
|
96
|
+
|
|
97
|
+
# The default state of the widget.
|
|
98
|
+
#
|
|
99
|
+
# @see Telnyx::Models::AI::WidgetSettings#default_state
|
|
100
|
+
module DefaultState
|
|
101
|
+
extend Telnyx::Internal::Type::Enum
|
|
102
|
+
|
|
103
|
+
EXPANDED = :expanded
|
|
104
|
+
COLLAPSED = :collapsed
|
|
105
|
+
|
|
106
|
+
# @!method self.values
|
|
107
|
+
# @return [Array<Symbol>]
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# The positioning style for the widget.
|
|
111
|
+
#
|
|
112
|
+
# @see Telnyx::Models::AI::WidgetSettings#position
|
|
113
|
+
module Position
|
|
114
|
+
extend Telnyx::Internal::Type::Enum
|
|
115
|
+
|
|
116
|
+
FIXED = :fixed
|
|
117
|
+
STATIC = :static
|
|
118
|
+
|
|
119
|
+
# @!method self.values
|
|
120
|
+
# @return [Array<Symbol>]
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# The visual theme for the widget.
|
|
124
|
+
#
|
|
125
|
+
# @see Telnyx::Models::AI::WidgetSettings#theme
|
|
126
|
+
module Theme
|
|
127
|
+
extend Telnyx::Internal::Type::Enum
|
|
128
|
+
|
|
129
|
+
LIGHT = :light
|
|
130
|
+
DARK = :dark
|
|
131
|
+
|
|
132
|
+
# @!method self.values
|
|
133
|
+
# @return [Array<Symbol>]
|
|
134
|
+
end
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
end
|
|
138
|
+
end
|
|
@@ -24,6 +24,16 @@ module Telnyx
|
|
|
24
24
|
# @return [Telnyx::Models::CallControlApplicationListParams::Page, nil]
|
|
25
25
|
optional :page, -> { Telnyx::CallControlApplicationListParams::Page }
|
|
26
26
|
|
|
27
|
+
# @!attribute page_number
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer, nil]
|
|
30
|
+
optional :page_number, Integer
|
|
31
|
+
|
|
32
|
+
# @!attribute page_size
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :page_size, Integer
|
|
36
|
+
|
|
27
37
|
# @!attribute sort
|
|
28
38
|
# Specifies the sort order for results. By default sorting direction is ascending.
|
|
29
39
|
# To have the results sorted in descending order add the <code> -</code>
|
|
@@ -43,7 +53,7 @@ module Telnyx
|
|
|
43
53
|
# @return [Symbol, Telnyx::Models::CallControlApplicationListParams::Sort, nil]
|
|
44
54
|
optional :sort, enum: -> { Telnyx::CallControlApplicationListParams::Sort }
|
|
45
55
|
|
|
46
|
-
# @!method initialize(filter: nil, page: nil, sort: nil, request_options: {})
|
|
56
|
+
# @!method initialize(filter: nil, page: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
|
|
47
57
|
# Some parameter documentations has been truncated, see
|
|
48
58
|
# {Telnyx::Models::CallControlApplicationListParams} for more details.
|
|
49
59
|
#
|
|
@@ -51,6 +61,10 @@ module Telnyx
|
|
|
51
61
|
#
|
|
52
62
|
# @param page [Telnyx::Models::CallControlApplicationListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
53
63
|
#
|
|
64
|
+
# @param page_number [Integer]
|
|
65
|
+
#
|
|
66
|
+
# @param page_size [Integer]
|
|
67
|
+
#
|
|
54
68
|
# @param sort [Symbol, Telnyx::Models::CallControlApplicationListParams::Sort] Specifies the sort order for results. By default sorting direction is ascending.
|
|
55
69
|
#
|
|
56
70
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -299,19 +313,7 @@ module Telnyx
|
|
|
299
313
|
# @return [Integer, nil]
|
|
300
314
|
optional :limit, Integer
|
|
301
315
|
|
|
302
|
-
# @!
|
|
303
|
-
# The page number to load
|
|
304
|
-
#
|
|
305
|
-
# @return [Integer, nil]
|
|
306
|
-
optional :number, Integer
|
|
307
|
-
|
|
308
|
-
# @!attribute size
|
|
309
|
-
# The size of the page
|
|
310
|
-
#
|
|
311
|
-
# @return [Integer, nil]
|
|
312
|
-
optional :size, Integer
|
|
313
|
-
|
|
314
|
-
# @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
|
|
316
|
+
# @!method initialize(after: nil, before: nil, limit: nil)
|
|
315
317
|
# Consolidated page parameter (deepObject style). Originally: page[after],
|
|
316
318
|
# page[before], page[limit], page[size], page[number]
|
|
317
319
|
#
|
|
@@ -320,10 +322,6 @@ module Telnyx
|
|
|
320
322
|
# @param before [String] Opaque identifier of previous page
|
|
321
323
|
#
|
|
322
324
|
# @param limit [Integer] Limit of records per single page
|
|
323
|
-
#
|
|
324
|
-
# @param number [Integer] The page number to load
|
|
325
|
-
#
|
|
326
|
-
# @param size [Integer] The size of the page
|
|
327
325
|
end
|
|
328
326
|
|
|
329
327
|
# Specifies the sort order for results. By default sorting direction is ascending.
|
|
@@ -24,7 +24,17 @@ module Telnyx
|
|
|
24
24
|
# @return [Telnyx::Models::CallEventListParams::Page, nil]
|
|
25
25
|
optional :page, -> { Telnyx::CallEventListParams::Page }
|
|
26
26
|
|
|
27
|
-
# @!
|
|
27
|
+
# @!attribute page_number
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer, nil]
|
|
30
|
+
optional :page_number, Integer
|
|
31
|
+
|
|
32
|
+
# @!attribute page_size
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :page_size, Integer
|
|
36
|
+
|
|
37
|
+
# @!method initialize(filter: nil, page: nil, page_number: nil, page_size: nil, request_options: {})
|
|
28
38
|
# Some parameter documentations has been truncated, see
|
|
29
39
|
# {Telnyx::Models::CallEventListParams} for more details.
|
|
30
40
|
#
|
|
@@ -32,6 +42,10 @@ module Telnyx
|
|
|
32
42
|
#
|
|
33
43
|
# @param page [Telnyx::Models::CallEventListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
34
44
|
#
|
|
45
|
+
# @param page_number [Integer]
|
|
46
|
+
#
|
|
47
|
+
# @param page_size [Integer]
|
|
48
|
+
#
|
|
35
49
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
36
50
|
|
|
37
51
|
class Filter < Telnyx::Internal::Type::BaseModel
|
|
@@ -277,19 +291,7 @@ module Telnyx
|
|
|
277
291
|
# @return [Integer, nil]
|
|
278
292
|
optional :limit, Integer
|
|
279
293
|
|
|
280
|
-
# @!
|
|
281
|
-
# The page number to load
|
|
282
|
-
#
|
|
283
|
-
# @return [Integer, nil]
|
|
284
|
-
optional :number, Integer
|
|
285
|
-
|
|
286
|
-
# @!attribute size
|
|
287
|
-
# The size of the page
|
|
288
|
-
#
|
|
289
|
-
# @return [Integer, nil]
|
|
290
|
-
optional :size, Integer
|
|
291
|
-
|
|
292
|
-
# @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
|
|
294
|
+
# @!method initialize(after: nil, before: nil, limit: nil)
|
|
293
295
|
# Consolidated page parameter (deepObject style). Originally: page[after],
|
|
294
296
|
# page[before], page[limit], page[size], page[number]
|
|
295
297
|
#
|
|
@@ -298,10 +300,6 @@ module Telnyx
|
|
|
298
300
|
# @param before [String] Opaque identifier of previous page
|
|
299
301
|
#
|
|
300
302
|
# @param limit [Integer] Limit of records per single page
|
|
301
|
-
#
|
|
302
|
-
# @param number [Integer] The page number to load
|
|
303
|
-
#
|
|
304
|
-
# @param size [Integer] The size of the page
|
|
305
303
|
end
|
|
306
304
|
end
|
|
307
305
|
end
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#add_ai_assistant_messages
|
|
7
|
+
class ActionAddAIAssistantMessagesParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute client_state
|
|
12
|
+
# Use this field to add state to every subsequent webhook. It must be a valid
|
|
13
|
+
# Base-64 encoded string.
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :client_state, String
|
|
17
|
+
|
|
18
|
+
# @!attribute command_id
|
|
19
|
+
# Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
20
|
+
# the same `command_id` for the same `call_control_id`.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :command_id, String
|
|
24
|
+
|
|
25
|
+
# @!attribute messages
|
|
26
|
+
# The messages to add to the conversation.
|
|
27
|
+
#
|
|
28
|
+
# @return [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::User, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Tool, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::System, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Developer>, nil]
|
|
29
|
+
optional :messages,
|
|
30
|
+
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message] }
|
|
31
|
+
|
|
32
|
+
# @!method initialize(client_state: nil, command_id: nil, messages: nil, request_options: {})
|
|
33
|
+
# Some parameter documentations has been truncated, see
|
|
34
|
+
# {Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams} for more details.
|
|
35
|
+
#
|
|
36
|
+
# @param client_state [String] Use this field to add state to every subsequent webhook. It must be a valid Base
|
|
37
|
+
#
|
|
38
|
+
# @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
39
|
+
#
|
|
40
|
+
# @param messages [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::User, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Tool, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::System, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Developer>] The messages to add to the conversation.
|
|
41
|
+
#
|
|
42
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
43
|
+
|
|
44
|
+
# Messages sent by an end user
|
|
45
|
+
module Message
|
|
46
|
+
extend Telnyx::Internal::Type::Union
|
|
47
|
+
|
|
48
|
+
discriminator :role
|
|
49
|
+
|
|
50
|
+
# Messages sent by an end user
|
|
51
|
+
variant :user, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::User }
|
|
52
|
+
|
|
53
|
+
# Messages sent by the model in response to user messages.
|
|
54
|
+
variant :assistant, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant }
|
|
55
|
+
|
|
56
|
+
variant :tool, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Tool }
|
|
57
|
+
|
|
58
|
+
# Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
59
|
+
variant :system, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::System }
|
|
60
|
+
|
|
61
|
+
# Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
62
|
+
variant :developer, -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Developer }
|
|
63
|
+
|
|
64
|
+
class User < Telnyx::Internal::Type::BaseModel
|
|
65
|
+
# @!attribute content
|
|
66
|
+
# The contents of the user message.
|
|
67
|
+
#
|
|
68
|
+
# @return [String]
|
|
69
|
+
required :content, String
|
|
70
|
+
|
|
71
|
+
# @!attribute role
|
|
72
|
+
# The role of the messages author, in this case `user`.
|
|
73
|
+
#
|
|
74
|
+
# @return [Symbol, :user]
|
|
75
|
+
required :role, const: :user
|
|
76
|
+
|
|
77
|
+
# @!attribute metadata
|
|
78
|
+
# Metadata to add to the message
|
|
79
|
+
#
|
|
80
|
+
# @return [Object, nil]
|
|
81
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
82
|
+
|
|
83
|
+
# @!method initialize(content:, metadata: nil, role: :user)
|
|
84
|
+
# Messages sent by an end user
|
|
85
|
+
#
|
|
86
|
+
# @param content [String] The contents of the user message.
|
|
87
|
+
#
|
|
88
|
+
# @param metadata [Object] Metadata to add to the message
|
|
89
|
+
#
|
|
90
|
+
# @param role [Symbol, :user] The role of the messages author, in this case `user`.
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
class Assistant < Telnyx::Internal::Type::BaseModel
|
|
94
|
+
# @!attribute role
|
|
95
|
+
# The role of the messages author, in this case `assistant`.
|
|
96
|
+
#
|
|
97
|
+
# @return [Symbol, :assistant]
|
|
98
|
+
required :role, const: :assistant
|
|
99
|
+
|
|
100
|
+
# @!attribute content
|
|
101
|
+
# The contents of the assistant message. Required unless `tool_calls`
|
|
102
|
+
#
|
|
103
|
+
# @return [String, nil]
|
|
104
|
+
optional :content, String
|
|
105
|
+
|
|
106
|
+
# @!attribute metadata
|
|
107
|
+
# Metadata to add to the message
|
|
108
|
+
#
|
|
109
|
+
# @return [Object, nil]
|
|
110
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
111
|
+
|
|
112
|
+
# @!attribute tool_calls
|
|
113
|
+
# The tool calls generated by the model, such as function calls.
|
|
114
|
+
#
|
|
115
|
+
# @return [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall>, nil]
|
|
116
|
+
optional :tool_calls,
|
|
117
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall] }
|
|
118
|
+
|
|
119
|
+
# @!method initialize(content: nil, metadata: nil, tool_calls: nil, role: :assistant)
|
|
120
|
+
# Messages sent by the model in response to user messages.
|
|
121
|
+
#
|
|
122
|
+
# @param content [String] The contents of the assistant message. Required unless `tool_calls`
|
|
123
|
+
#
|
|
124
|
+
# @param metadata [Object] Metadata to add to the message
|
|
125
|
+
#
|
|
126
|
+
# @param tool_calls [Array<Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall>] The tool calls generated by the model, such as function calls.
|
|
127
|
+
#
|
|
128
|
+
# @param role [Symbol, :assistant] The role of the messages author, in this case `assistant`.
|
|
129
|
+
|
|
130
|
+
class ToolCall < Telnyx::Internal::Type::BaseModel
|
|
131
|
+
# @!attribute id
|
|
132
|
+
# The ID of the tool call.
|
|
133
|
+
#
|
|
134
|
+
# @return [String]
|
|
135
|
+
required :id, String
|
|
136
|
+
|
|
137
|
+
# @!attribute function
|
|
138
|
+
# The function that the model called.
|
|
139
|
+
#
|
|
140
|
+
# @return [Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Function]
|
|
141
|
+
required :function,
|
|
142
|
+
-> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Function }
|
|
143
|
+
|
|
144
|
+
# @!attribute type
|
|
145
|
+
# The type of the tool. Currently, only `function` is supported.
|
|
146
|
+
#
|
|
147
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Type]
|
|
148
|
+
required :type,
|
|
149
|
+
enum: -> { Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Type }
|
|
150
|
+
|
|
151
|
+
# @!method initialize(id:, function:, type:)
|
|
152
|
+
# A call to a function tool created by the model.
|
|
153
|
+
#
|
|
154
|
+
# @param id [String] The ID of the tool call.
|
|
155
|
+
#
|
|
156
|
+
# @param function [Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Function] The function that the model called.
|
|
157
|
+
#
|
|
158
|
+
# @param type [Symbol, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall::Type] The type of the tool. Currently, only `function` is supported.
|
|
159
|
+
|
|
160
|
+
# @see Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall#function
|
|
161
|
+
class Function < Telnyx::Internal::Type::BaseModel
|
|
162
|
+
# @!attribute name
|
|
163
|
+
# The name of the function to call.
|
|
164
|
+
#
|
|
165
|
+
# @return [String]
|
|
166
|
+
required :name, String
|
|
167
|
+
|
|
168
|
+
# @!method initialize(name:)
|
|
169
|
+
# The function that the model called.
|
|
170
|
+
#
|
|
171
|
+
# @param name [String] The name of the function to call.
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# The type of the tool. Currently, only `function` is supported.
|
|
175
|
+
#
|
|
176
|
+
# @see Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant::ToolCall#type
|
|
177
|
+
module Type
|
|
178
|
+
extend Telnyx::Internal::Type::Enum
|
|
179
|
+
|
|
180
|
+
FUNCTION = :function
|
|
181
|
+
|
|
182
|
+
# @!method self.values
|
|
183
|
+
# @return [Array<Symbol>]
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
class Tool < Telnyx::Internal::Type::BaseModel
|
|
189
|
+
# @!attribute content
|
|
190
|
+
# The contents of the tool message.
|
|
191
|
+
#
|
|
192
|
+
# @return [String]
|
|
193
|
+
required :content, String
|
|
194
|
+
|
|
195
|
+
# @!attribute role
|
|
196
|
+
# The role of the messages author, in this case `tool`.
|
|
197
|
+
#
|
|
198
|
+
# @return [Symbol, :tool]
|
|
199
|
+
required :role, const: :tool
|
|
200
|
+
|
|
201
|
+
# @!attribute tool_call_id
|
|
202
|
+
# Tool call that this message is responding to.
|
|
203
|
+
#
|
|
204
|
+
# @return [String]
|
|
205
|
+
required :tool_call_id, String
|
|
206
|
+
|
|
207
|
+
# @!attribute metadata
|
|
208
|
+
# Metadata to add to the message
|
|
209
|
+
#
|
|
210
|
+
# @return [Object, nil]
|
|
211
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
212
|
+
|
|
213
|
+
# @!method initialize(content:, tool_call_id:, metadata: nil, role: :tool)
|
|
214
|
+
# @param content [String] The contents of the tool message.
|
|
215
|
+
#
|
|
216
|
+
# @param tool_call_id [String] Tool call that this message is responding to.
|
|
217
|
+
#
|
|
218
|
+
# @param metadata [Object] Metadata to add to the message
|
|
219
|
+
#
|
|
220
|
+
# @param role [Symbol, :tool] The role of the messages author, in this case `tool`.
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
class System < Telnyx::Internal::Type::BaseModel
|
|
224
|
+
# @!attribute content
|
|
225
|
+
# The contents of the system message.
|
|
226
|
+
#
|
|
227
|
+
# @return [String]
|
|
228
|
+
required :content, String
|
|
229
|
+
|
|
230
|
+
# @!attribute role
|
|
231
|
+
# The role of the messages author, in this case `system`.
|
|
232
|
+
#
|
|
233
|
+
# @return [Symbol, :system]
|
|
234
|
+
required :role, const: :system
|
|
235
|
+
|
|
236
|
+
# @!attribute metadata
|
|
237
|
+
# Metadata to add to the message
|
|
238
|
+
#
|
|
239
|
+
# @return [Object, nil]
|
|
240
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
241
|
+
|
|
242
|
+
# @!method initialize(content:, metadata: nil, role: :system)
|
|
243
|
+
# Developer-provided instructions that the model should follow, regardless of
|
|
244
|
+
# messages sent by the user.
|
|
245
|
+
#
|
|
246
|
+
# @param content [String] The contents of the system message.
|
|
247
|
+
#
|
|
248
|
+
# @param metadata [Object] Metadata to add to the message
|
|
249
|
+
#
|
|
250
|
+
# @param role [Symbol, :system] The role of the messages author, in this case `system`.
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
class Developer < Telnyx::Internal::Type::BaseModel
|
|
254
|
+
# @!attribute content
|
|
255
|
+
# The contents of the developer message.
|
|
256
|
+
#
|
|
257
|
+
# @return [String]
|
|
258
|
+
required :content, String
|
|
259
|
+
|
|
260
|
+
# @!attribute role
|
|
261
|
+
# The role of the messages author, in this case developer.
|
|
262
|
+
#
|
|
263
|
+
# @return [Symbol, :developer]
|
|
264
|
+
required :role, const: :developer
|
|
265
|
+
|
|
266
|
+
# @!attribute metadata
|
|
267
|
+
# Metadata to add to the message
|
|
268
|
+
#
|
|
269
|
+
# @return [Object, nil]
|
|
270
|
+
optional :metadata, Telnyx::Internal::Type::Unknown
|
|
271
|
+
|
|
272
|
+
# @!method initialize(content:, metadata: nil, role: :developer)
|
|
273
|
+
# Developer-provided instructions that the model should follow, regardless of
|
|
274
|
+
# messages sent by the user.
|
|
275
|
+
#
|
|
276
|
+
# @param content [String] The contents of the developer message.
|
|
277
|
+
#
|
|
278
|
+
# @param metadata [Object] Metadata to add to the message
|
|
279
|
+
#
|
|
280
|
+
# @param role [Symbol, :developer] The role of the messages author, in this case developer.
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
# @!method self.variants
|
|
284
|
+
# @return [Array(Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::User, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Assistant, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Tool, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::System, Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams::Message::Developer)]
|
|
285
|
+
end
|
|
286
|
+
end
|
|
287
|
+
end
|
|
288
|
+
end
|
|
289
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#add_ai_assistant_messages
|
|
7
|
+
class ActionAddAIAssistantMessagesResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Calls::CallControlCommandResult, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Calls::CallControlCommandResult }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Calls::CallControlCommandResult]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -29,8 +29,9 @@ module Telnyx
|
|
|
29
29
|
optional :direction, enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::Direction }
|
|
30
30
|
|
|
31
31
|
# @!attribute noise_suppression_engine
|
|
32
|
-
# The engine to use for noise suppression. For backward compatibility, engines A
|
|
33
|
-
# and
|
|
32
|
+
# The engine to use for noise suppression. For backward compatibility, engines A,
|
|
33
|
+
# B, and C are also supported, but are deprecated: A - Denoiser B - DeepFilterNet
|
|
34
|
+
# C - Krisp
|
|
34
35
|
#
|
|
35
36
|
# @return [Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngine, nil]
|
|
36
37
|
optional :noise_suppression_engine,
|
|
@@ -71,13 +72,15 @@ module Telnyx
|
|
|
71
72
|
# @return [Array<Symbol>]
|
|
72
73
|
end
|
|
73
74
|
|
|
74
|
-
# The engine to use for noise suppression. For backward compatibility, engines A
|
|
75
|
-
# and
|
|
75
|
+
# The engine to use for noise suppression. For backward compatibility, engines A,
|
|
76
|
+
# B, and C are also supported, but are deprecated: A - Denoiser B - DeepFilterNet
|
|
77
|
+
# C - Krisp
|
|
76
78
|
module NoiseSuppressionEngine
|
|
77
79
|
extend Telnyx::Internal::Type::Enum
|
|
78
80
|
|
|
79
81
|
DENOISER = :Denoiser
|
|
80
82
|
DEEP_FILTER_NET = :DeepFilterNet
|
|
83
|
+
KRISP = :Krisp
|
|
81
84
|
|
|
82
85
|
# @!method self.values
|
|
83
86
|
# @return [Array<Symbol>]
|
|
@@ -24,13 +24,23 @@ module Telnyx
|
|
|
24
24
|
# @return [Telnyx::Models::ConferenceListParams::Page, nil]
|
|
25
25
|
optional :page, -> { Telnyx::ConferenceListParams::Page }
|
|
26
26
|
|
|
27
|
+
# @!attribute page_number
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer, nil]
|
|
30
|
+
optional :page_number, Integer
|
|
31
|
+
|
|
32
|
+
# @!attribute page_size
|
|
33
|
+
#
|
|
34
|
+
# @return [Integer, nil]
|
|
35
|
+
optional :page_size, Integer
|
|
36
|
+
|
|
27
37
|
# @!attribute region
|
|
28
38
|
# Region where the conference data is located
|
|
29
39
|
#
|
|
30
40
|
# @return [Symbol, Telnyx::Models::ConferenceListParams::Region, nil]
|
|
31
41
|
optional :region, enum: -> { Telnyx::ConferenceListParams::Region }
|
|
32
42
|
|
|
33
|
-
# @!method initialize(filter: nil, page: nil, region: nil, request_options: {})
|
|
43
|
+
# @!method initialize(filter: nil, page: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
|
|
34
44
|
# Some parameter documentations has been truncated, see
|
|
35
45
|
# {Telnyx::Models::ConferenceListParams} for more details.
|
|
36
46
|
#
|
|
@@ -38,6 +48,10 @@ module Telnyx
|
|
|
38
48
|
#
|
|
39
49
|
# @param page [Telnyx::Models::ConferenceListParams::Page] Consolidated page parameter (deepObject style). Originally: page[after], page[be
|
|
40
50
|
#
|
|
51
|
+
# @param page_number [Integer]
|
|
52
|
+
#
|
|
53
|
+
# @param page_size [Integer]
|
|
54
|
+
#
|
|
41
55
|
# @param region [Symbol, Telnyx::Models::ConferenceListParams::Region] Region where the conference data is located
|
|
42
56
|
#
|
|
43
57
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -286,19 +300,7 @@ module Telnyx
|
|
|
286
300
|
# @return [Integer, nil]
|
|
287
301
|
optional :limit, Integer
|
|
288
302
|
|
|
289
|
-
# @!
|
|
290
|
-
# The page number to load
|
|
291
|
-
#
|
|
292
|
-
# @return [Integer, nil]
|
|
293
|
-
optional :number, Integer
|
|
294
|
-
|
|
295
|
-
# @!attribute size
|
|
296
|
-
# The size of the page
|
|
297
|
-
#
|
|
298
|
-
# @return [Integer, nil]
|
|
299
|
-
optional :size, Integer
|
|
300
|
-
|
|
301
|
-
# @!method initialize(after: nil, before: nil, limit: nil, number: nil, size: nil)
|
|
303
|
+
# @!method initialize(after: nil, before: nil, limit: nil)
|
|
302
304
|
# Consolidated page parameter (deepObject style). Originally: page[after],
|
|
303
305
|
# page[before], page[limit], page[size], page[number]
|
|
304
306
|
#
|
|
@@ -307,10 +309,6 @@ module Telnyx
|
|
|
307
309
|
# @param before [String] Opaque identifier of previous page
|
|
308
310
|
#
|
|
309
311
|
# @param limit [Integer] Limit of records per single page
|
|
310
|
-
#
|
|
311
|
-
# @param number [Integer] The page number to load
|
|
312
|
-
#
|
|
313
|
-
# @param size [Integer] The size of the page
|
|
314
312
|
end
|
|
315
313
|
|
|
316
314
|
# Region where the conference data is located
|