telnyx 5.168.0 → 5.170.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 +14 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +40 -0
- data/lib/telnyx/internal/email_cursor_pagination.rb +2 -2
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -9
- data/lib/telnyx/models/ai/assistant_tool.rb +316 -13
- data/lib/telnyx/models/ai/assistant_update_params.rb +23 -12
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +23 -12
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
- data/lib/telnyx/models/ai/collection.rb +3 -3
- data/lib/telnyx/models/ai/collections/collections_source.rb +64 -0
- data/lib/telnyx/models/ai/collections/source.rb +25 -29
- data/lib/telnyx/models/ai/collections/source_create_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_list_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_replace_response.rb +3 -3
- data/lib/telnyx/models/ai/flow_node.rb +5 -5
- data/lib/telnyx/models/ai/flow_node_req.rb +3 -3
- data/lib/telnyx/models/ai/inference_embedding.rb +16 -13
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_voice_settings.rb +334 -0
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +33 -11
- data/lib/telnyx/models/ai/memory/namespace_retrieve_params.rb +30 -0
- data/lib/telnyx/models/ai/memory/namespace_retrieve_response.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +63 -0
- data/lib/telnyx/models/ai/memory/namespaces/page_meta.rb +58 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_response.rb +47 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_params.rb +94 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_response.rb +61 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_params.rb +48 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_response.rb +34 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_params.rb +44 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_params.rb +38 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_response.rb +54 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rb +64 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rb +53 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rb +50 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rb +74 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rb +67 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rb +123 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_list_params.rb +28 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rb +69 -0
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +296 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +235 -0
- data/lib/telnyx/models/ai/webhook_tool.rb +16 -1
- data/lib/telnyx/models/artifact_completed_webhook_event.rb +17 -1
- data/lib/telnyx/models/artifact_failed_webhook_event.rb +4 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +11 -3
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +11 -3
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/soniox_voice_settings.rb +46 -0
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/conferences/action_speak_params.rb +11 -3
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +11 -3
- data/lib/telnyx/models/conversation_relay_language.rb +5 -3
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/email_block.rb +8 -1
- data/lib/telnyx/models/email_blocks/email_block_import.rb +7 -2
- data/lib/telnyx/models/email_domain_rotate_dkim_params.rb +20 -0
- data/lib/telnyx/models/email_domain_rotate_dkim_response.rb +243 -0
- data/lib/telnyx/models/email_domains/email_webhook_event.rb +8 -3
- data/lib/telnyx/models/email_event_list_params.rb +33 -10
- data/lib/telnyx/models/email_event_list_response.rb +300 -73
- data/lib/telnyx/models/email_event_type.rb +16 -0
- data/lib/telnyx/models/email_inboxes/email_message.rb +56 -4
- data/lib/telnyx/models/email_message_batch_params.rb +32 -15
- data/lib/telnyx/models/email_message_create_params.rb +44 -12
- data/lib/telnyx/models/{email_message_retrieve_response.rb → email_message_detail_response.rb} +5 -5
- data/lib/telnyx/models/email_message_list_params.rb +26 -1
- data/lib/telnyx/models/email_message_update_schedule_params.rb +29 -0
- data/lib/telnyx/models/email_messages/email_recipient.rb +2 -0
- data/lib/telnyx/models/email_messages/recipient_list_params.rb +2 -0
- data/lib/telnyx/models/email_template.rb +68 -2
- data/lib/telnyx/models/email_template_create_params.rb +71 -1
- data/lib/telnyx/models/email_webhook_recipient.rb +39 -0
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/meeting_session.rb +34 -6
- data/lib/telnyx/models/meeting_session_create_params.rb +73 -39
- data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +77 -13
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +25 -1
- data/lib/telnyx/models/message_event.rb +41 -2
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/numbers_phone_number_detailed.rb +19 -5
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/private_wireless_gateway.rb +0 -1
- data/lib/telnyx/models/private_wireless_gateway_create_params.rb +28 -1
- data/lib/telnyx/models/private_wireless_gateway_create_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_delete_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_retrieve_response.rb +3 -3
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/call_retrieve_calls_params.rb +17 -17
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +129 -3
- data/lib/telnyx/models/text_to_speech_list_voices_params.rb +1 -0
- data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +1 -1
- data/lib/telnyx/models/update_email_template_request.rb +54 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models/wireless_private_wireless_gateway.rb +120 -0
- data/lib/telnyx/models.rb +28 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +2 -2
- data/lib/telnyx/resources/ai/assistants.rb +4 -4
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/memories.rb +122 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/sources.rb +163 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles.rb +244 -0
- data/lib/telnyx/resources/ai/memory/namespaces/settings.rb +76 -0
- data/lib/telnyx/resources/ai/memory/namespaces.rb +55 -0
- data/lib/telnyx/resources/ai/memory.rb +21 -0
- data/lib/telnyx/resources/ai/typesafe/v1.rb +71 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +8 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +5 -5
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +4 -0
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_blocks/imports.rb +17 -3
- data/lib/telnyx/resources/email_blocks.rb +5 -3
- data/lib/telnyx/resources/email_domains.rb +28 -0
- data/lib/telnyx/resources/email_events.rb +21 -9
- data/lib/telnyx/resources/email_messages.rb +61 -15
- data/lib/telnyx/resources/email_templates.rb +33 -3
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/meeting_sessions/actions.rb +7 -1
- data/lib/telnyx/resources/meeting_sessions/artifacts.rb +18 -9
- data/lib/telnyx/resources/meeting_sessions.rb +6 -5
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/private_wireless_gateways.rb +5 -3
- data/lib/telnyx/resources/texml/accounts/calls.rb +9 -9
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/text_to_speech.rb +6 -4
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +75 -1
- data/rbi/telnyx/client.rbi +35 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +24 -16
- data/rbi/telnyx/models/ai/assistant_tool.rbi +479 -25
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +50 -20
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +54 -20
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
- data/rbi/telnyx/models/ai/collection.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/collections_source.rbi +110 -0
- data/rbi/telnyx/models/ai/collections/source.rbi +36 -62
- data/rbi/telnyx/models/ai/collections/source_create_response.rbi +14 -6
- data/rbi/telnyx/models/ai/collections/source_list_response.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/source_replace_response.rbi +11 -4
- data/rbi/telnyx/models/ai/flow_node.rbi +12 -6
- data/rbi/telnyx/models/ai/flow_node_req.rbi +8 -4
- data/rbi/telnyx/models/ai/inference_embedding.rbi +32 -20
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_voice_settings.rbi +803 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +49 -19
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_response.rbi +167 -0
- data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +156 -0
- data/rbi/telnyx/models/ai/memory/namespaces/page_meta.rbi +81 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_response.rbi +97 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbi +149 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbi +113 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_response.rbi +48 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_params.rbi +68 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_response.rbi +109 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_params.rbi +57 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_response.rbi +107 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbi +119 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbi +102 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbi +72 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbi +70 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbi +129 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbi +117 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbi +92 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbi +209 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_list_params.rbi +49 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbi +125 -0
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +566 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +388 -0
- data/rbi/telnyx/models/ai/webhook_tool.rbi +23 -3
- data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +30 -0
- data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +20 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/soniox_voice_settings.rbi +86 -0
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +22 -5
- data/rbi/telnyx/models/conversation_relay_language.rbi +10 -5
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/email_block.rbi +8 -0
- data/rbi/telnyx/models/email_blocks/email_block_import.rbi +6 -2
- data/rbi/telnyx/models/email_domain_rotate_dkim_params.rbi +35 -0
- data/rbi/telnyx/models/email_domain_rotate_dkim_response.rbi +487 -0
- data/rbi/telnyx/models/email_domains/email_webhook_event.rbi +20 -3
- data/rbi/telnyx/models/email_event_list_params.rbi +46 -11
- data/rbi/telnyx/models/email_event_list_response.rbi +599 -97
- data/rbi/telnyx/models/email_event_type.rbi +25 -0
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +81 -3
- data/rbi/telnyx/models/email_message_batch_params.rbi +54 -20
- data/rbi/telnyx/models/email_message_create_params.rbi +80 -16
- data/rbi/telnyx/models/{email_message_retrieve_response.rbi → email_message_detail_response.rbi} +9 -16
- data/rbi/telnyx/models/email_message_list_params.rbi +40 -0
- data/rbi/telnyx/models/email_message_update_schedule_params.rbi +52 -0
- data/rbi/telnyx/models/email_messages/email_recipient.rbi +10 -0
- data/rbi/telnyx/models/email_messages/recipient_list_params.rbi +10 -0
- data/rbi/telnyx/models/email_template.rbi +84 -0
- data/rbi/telnyx/models/email_template_create_params.rbi +124 -0
- data/rbi/telnyx/models/email_webhook_recipient.rbi +68 -0
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/meeting_session.rbi +36 -10
- data/rbi/telnyx/models/meeting_session_create_params.rbi +112 -48
- data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +161 -24
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +30 -0
- data/rbi/telnyx/models/message_event.rbi +48 -1
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/numbers_phone_number_detailed.rbi +24 -4
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/private_wireless_gateway_create_params.rbi +71 -0
- data/rbi/telnyx/models/private_wireless_gateway_create_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_delete_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_retrieve_response.rbi +4 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/call_retrieve_calls_params.rbi +22 -22
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +311 -2
- data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +5 -0
- data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +5 -5
- data/rbi/telnyx/models/update_email_template_request.rbi +90 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models/wireless_private_wireless_gateway.rbi +211 -0
- data/rbi/telnyx/models.rbi +33 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +21 -8
- data/rbi/telnyx/resources/ai/assistants.rbi +27 -14
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/memories.rbi +94 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/sources.rbi +117 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles.rbi +196 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/settings.rbi +67 -0
- data/rbi/telnyx/resources/ai/memory/namespaces.rbi +37 -0
- data/rbi/telnyx/resources/ai/memory.rbi +18 -0
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +71 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +6 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +38 -9
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
- data/rbi/telnyx/resources/conferences/actions.rbi +8 -1
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_blocks/imports.rbi +17 -3
- data/rbi/telnyx/resources/email_blocks.rbi +5 -3
- data/rbi/telnyx/resources/email_domains.rbi +22 -0
- data/rbi/telnyx/resources/email_events.rbi +30 -9
- data/rbi/telnyx/resources/email_messages.rbi +104 -18
- data/rbi/telnyx/resources/email_templates.rbi +71 -0
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/meeting_sessions/actions.rbi +7 -1
- data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +19 -8
- data/rbi/telnyx/resources/meeting_sessions.rbi +15 -7
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/private_wireless_gateways.rbi +9 -1
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +6 -6
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/text_to_speech.rbi +7 -3
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/sig/telnyx/client.rbs +10 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistant_tool.rbs +195 -26
- data/sig/telnyx/models/ai/assistant_update_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +6 -6
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
- data/sig/telnyx/models/ai/collection.rbs +6 -6
- data/sig/telnyx/models/ai/collections/collections_source.rbs +65 -0
- data/sig/telnyx/models/ai/collections/source.rbs +18 -37
- data/sig/telnyx/models/ai/collections/source_create_response.rbs +9 -6
- data/sig/telnyx/models/ai/collections/source_list_response.rbs +8 -6
- data/sig/telnyx/models/ai/collections/source_replace_response.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node_req.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_voice_settings.rbs +308 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +20 -13
- data/sig/telnyx/models/ai/memory/namespace_retrieve_params.rbs +32 -0
- data/sig/telnyx/models/ai/memory/namespace_retrieve_response.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +59 -0
- data/sig/telnyx/models/ai/memory/namespaces/page_meta.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_response.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_params.rbs +42 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_response.rbs +22 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_params.rbs +47 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_response.rbs +53 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_params.rbs +38 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_response.rbs +49 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbs +63 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbs +43 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbs +65 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbs +55 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbs +92 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_list_params.rbs +29 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbs +47 -0
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +215 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +152 -0
- data/sig/telnyx/models/ai/webhook_tool.rbs +10 -3
- data/sig/telnyx/models/artifact_completed_webhook_event.rbs +16 -1
- data/sig/telnyx/models/artifact_failed_webhook_event.rbs +11 -1
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/soniox_voice_settings.rbs +46 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/conversation_relay_embedded_config.rbs +1 -0
- data/sig/telnyx/models/conversation_relay_language.rbs +1 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_params.rbs +23 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_response.rbs +195 -0
- data/sig/telnyx/models/email_domains/email_webhook_event.rbs +6 -0
- data/sig/telnyx/models/email_event_list_params.rbs +7 -7
- data/sig/telnyx/models/email_event_list_response.rbs +235 -59
- data/sig/telnyx/models/email_event_type.rbs +20 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +43 -4
- data/sig/telnyx/models/{email_message_retrieve_response.rbs → email_message_detail_response.rbs} +6 -10
- data/sig/telnyx/models/email_message_list_params.rbs +18 -1
- data/sig/telnyx/models/email_message_update_schedule_params.rbs +28 -0
- data/sig/telnyx/models/email_messages/email_recipient.rbs +4 -0
- data/sig/telnyx/models/email_messages/recipient_list_params.rbs +4 -0
- data/sig/telnyx/models/email_template.rbs +29 -0
- data/sig/telnyx/models/email_template_create_params.rbs +33 -0
- data/sig/telnyx/models/email_webhook_recipient.rbs +46 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/meeting_session.rbs +20 -5
- data/sig/telnyx/models/meeting_session_create_params.rbs +28 -20
- data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +53 -10
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +16 -1
- data/sig/telnyx/models/message_event.rbs +10 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/numbers_phone_number_detailed.rbs +5 -0
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/private_wireless_gateway_create_params.rbs +25 -1
- data/sig/telnyx/models/private_wireless_gateway_create_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_delete_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_retrieve_response.rbs +6 -6
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/call_retrieve_calls_params.rbs +14 -14
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +114 -0
- data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +2 -0
- data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +2 -2
- data/sig/telnyx/models/update_email_template_request.rbs +33 -0
- data/sig/telnyx/models/wireless_private_wireless_gateway.rbs +109 -0
- data/sig/telnyx/models.rbs +28 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -1
- data/sig/telnyx/resources/ai/assistants.rbs +2 -2
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/memories.rbs +32 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/sources.rbs +38 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles.rbs +59 -0
- data/sig/telnyx/resources/ai/memory/namespaces/settings.rbs +24 -0
- data/sig/telnyx/resources/ai/memory/namespaces.rbs +21 -0
- data/sig/telnyx/resources/ai/memory.rbs +11 -0
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +18 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +4 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +2 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/email_domains.rbs +5 -0
- data/sig/telnyx/resources/email_events.rbs +2 -2
- data/sig/telnyx/resources/email_messages.rbs +9 -1
- data/sig/telnyx/resources/email_templates.rbs +9 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +1 -1
- data/sig/telnyx/resources/meeting_sessions.rbs +1 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/private_wireless_gateways.rbs +2 -1
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- data/sig/telnyx/resources/text_to_speech.rbs +1 -0
- metadata +227 -5
|
@@ -11,6 +11,8 @@ module Telnyx
|
|
|
11
11
|
|
|
12
12
|
discriminator :type
|
|
13
13
|
|
|
14
|
+
variant :function, -> { Telnyx::AI::AssistantTool::Function }
|
|
15
|
+
|
|
14
16
|
variant :webhook, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams }
|
|
15
17
|
|
|
16
18
|
variant :client_side_tool, -> { Telnyx::AI::AssistantTool::ClientSideTool }
|
|
@@ -20,7 +22,7 @@ module Telnyx
|
|
|
20
22
|
# The handoff tool allows the assistant to hand off control of the conversation to another AI assistant. By default, this will happen transparently to the end user.
|
|
21
23
|
variant :handoff, -> { Telnyx::AI::AssistantTool::Handoff }
|
|
22
24
|
|
|
23
|
-
variant :hangup, -> { Telnyx::AI::
|
|
25
|
+
variant :hangup, -> { Telnyx::AI::AssistantTool::Hangup }
|
|
24
26
|
|
|
25
27
|
variant :transfer, -> { Telnyx::AI::AssistantTool::Transfer }
|
|
26
28
|
|
|
@@ -41,6 +43,42 @@ module Telnyx
|
|
|
41
43
|
# The update_dynamic_variables tool lets the assistant write values into the conversation's dynamic-variables context during the call. Updated variables are available to later `{{variable}}` interpolation (prompts, speak nodes, message templates) and to flow edge conditions. Declare each variable the assistant is allowed to set under `updatable_variables`.
|
|
42
44
|
variant :update_dynamic_variables, -> { Telnyx::AI::AssistantTool::UpdateDynamicVariables }
|
|
43
45
|
|
|
46
|
+
class Function < Telnyx::Internal::Type::BaseModel
|
|
47
|
+
# @!attribute function
|
|
48
|
+
#
|
|
49
|
+
# @return [Telnyx::Models::AI::OpenAI::FunctionDefinition]
|
|
50
|
+
required :function, -> { Telnyx::AI::OpenAI::FunctionDefinition }
|
|
51
|
+
|
|
52
|
+
# @!attribute type
|
|
53
|
+
#
|
|
54
|
+
# @return [Symbol, :function]
|
|
55
|
+
required :type, const: :function
|
|
56
|
+
|
|
57
|
+
response_only do
|
|
58
|
+
# @!attribute shared
|
|
59
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
60
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
61
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
62
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
63
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
64
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
65
|
+
# per assistant).
|
|
66
|
+
#
|
|
67
|
+
# @return [Boolean, nil]
|
|
68
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# @!method initialize(function:, shared: nil, type: :function)
|
|
72
|
+
# Some parameter documentations has been truncated, see
|
|
73
|
+
# {Telnyx::Models::AI::AssistantTool::Function} for more details.
|
|
74
|
+
#
|
|
75
|
+
# @param function [Telnyx::Models::AI::OpenAI::FunctionDefinition]
|
|
76
|
+
#
|
|
77
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
78
|
+
#
|
|
79
|
+
# @param type [Symbol, :function]
|
|
80
|
+
end
|
|
81
|
+
|
|
44
82
|
class ClientSideTool < Telnyx::Internal::Type::BaseModel
|
|
45
83
|
# @!attribute client_side_tool
|
|
46
84
|
#
|
|
@@ -52,8 +90,28 @@ module Telnyx
|
|
|
52
90
|
# @return [Symbol, :client_side_tool]
|
|
53
91
|
required :type, const: :client_side_tool
|
|
54
92
|
|
|
55
|
-
|
|
93
|
+
response_only do
|
|
94
|
+
# @!attribute shared
|
|
95
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
96
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
97
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
98
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
99
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
100
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
101
|
+
# per assistant).
|
|
102
|
+
#
|
|
103
|
+
# @return [Boolean, nil]
|
|
104
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# @!method initialize(client_side_tool:, shared: nil, type: :client_side_tool)
|
|
108
|
+
# Some parameter documentations has been truncated, see
|
|
109
|
+
# {Telnyx::Models::AI::AssistantTool::ClientSideTool} for more details.
|
|
110
|
+
#
|
|
56
111
|
# @param client_side_tool [Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool]
|
|
112
|
+
#
|
|
113
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
114
|
+
#
|
|
57
115
|
# @param type [Symbol, :client_side_tool]
|
|
58
116
|
|
|
59
117
|
# @see Telnyx::Models::AI::AssistantTool::ClientSideTool#client_side_tool
|
|
@@ -143,12 +201,32 @@ module Telnyx
|
|
|
143
201
|
# @return [Symbol, :handoff]
|
|
144
202
|
required :type, const: :handoff
|
|
145
203
|
|
|
146
|
-
|
|
204
|
+
response_only do
|
|
205
|
+
# @!attribute shared
|
|
206
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
207
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
208
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
209
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
210
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
211
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
212
|
+
# per assistant).
|
|
213
|
+
#
|
|
214
|
+
# @return [Boolean, nil]
|
|
215
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# @!method initialize(handoff:, shared: nil, type: :handoff)
|
|
219
|
+
# Some parameter documentations has been truncated, see
|
|
220
|
+
# {Telnyx::Models::AI::AssistantTool::Handoff} for more details.
|
|
221
|
+
#
|
|
147
222
|
# The handoff tool allows the assistant to hand off control of the conversation to
|
|
148
223
|
# another AI assistant. By default, this will happen transparently to the end
|
|
149
224
|
# user.
|
|
150
225
|
#
|
|
151
226
|
# @param handoff [Telnyx::Models::AI::AssistantTool::Handoff::Handoff]
|
|
227
|
+
#
|
|
228
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
229
|
+
#
|
|
152
230
|
# @param type [Symbol, :handoff]
|
|
153
231
|
|
|
154
232
|
# @see Telnyx::Models::AI::AssistantTool::Handoff#handoff
|
|
@@ -214,6 +292,42 @@ module Telnyx
|
|
|
214
292
|
end
|
|
215
293
|
end
|
|
216
294
|
|
|
295
|
+
class Hangup < Telnyx::Internal::Type::BaseModel
|
|
296
|
+
# @!attribute hangup
|
|
297
|
+
#
|
|
298
|
+
# @return [Telnyx::Models::AI::HangupToolParams]
|
|
299
|
+
required :hangup, -> { Telnyx::AI::HangupToolParams }
|
|
300
|
+
|
|
301
|
+
# @!attribute type
|
|
302
|
+
#
|
|
303
|
+
# @return [Symbol, :hangup]
|
|
304
|
+
required :type, const: :hangup
|
|
305
|
+
|
|
306
|
+
response_only do
|
|
307
|
+
# @!attribute shared
|
|
308
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
309
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
310
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
311
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
312
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
313
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
314
|
+
# per assistant).
|
|
315
|
+
#
|
|
316
|
+
# @return [Boolean, nil]
|
|
317
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
# @!method initialize(hangup:, shared: nil, type: :hangup)
|
|
321
|
+
# Some parameter documentations has been truncated, see
|
|
322
|
+
# {Telnyx::Models::AI::AssistantTool::Hangup} for more details.
|
|
323
|
+
#
|
|
324
|
+
# @param hangup [Telnyx::Models::AI::HangupToolParams]
|
|
325
|
+
#
|
|
326
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
327
|
+
#
|
|
328
|
+
# @param type [Symbol, :hangup]
|
|
329
|
+
end
|
|
330
|
+
|
|
217
331
|
class Transfer < Telnyx::Internal::Type::BaseModel
|
|
218
332
|
# @!attribute transfer
|
|
219
333
|
#
|
|
@@ -225,8 +339,28 @@ module Telnyx
|
|
|
225
339
|
# @return [Symbol, :transfer]
|
|
226
340
|
required :type, const: :transfer
|
|
227
341
|
|
|
228
|
-
|
|
342
|
+
response_only do
|
|
343
|
+
# @!attribute shared
|
|
344
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
345
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
346
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
347
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
348
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
349
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
350
|
+
# per assistant).
|
|
351
|
+
#
|
|
352
|
+
# @return [Boolean, nil]
|
|
353
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
354
|
+
end
|
|
355
|
+
|
|
356
|
+
# @!method initialize(transfer:, shared: nil, type: :transfer)
|
|
357
|
+
# Some parameter documentations has been truncated, see
|
|
358
|
+
# {Telnyx::Models::AI::AssistantTool::Transfer} for more details.
|
|
359
|
+
#
|
|
229
360
|
# @param transfer [Telnyx::Models::AI::AssistantTool::Transfer::Transfer]
|
|
361
|
+
#
|
|
362
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
363
|
+
#
|
|
230
364
|
# @param type [Symbol, :transfer]
|
|
231
365
|
|
|
232
366
|
# @see Telnyx::Models::AI::AssistantTool::Transfer#transfer
|
|
@@ -358,6 +492,16 @@ module Telnyx
|
|
|
358
492
|
# @return [String]
|
|
359
493
|
required :to, String
|
|
360
494
|
|
|
495
|
+
# @!attribute extension
|
|
496
|
+
# DTMF digits to send automatically after the transfer destination answers. Useful
|
|
497
|
+
# for reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once
|
|
498
|
+
# the called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause),
|
|
499
|
+
# `W` (1s pause), `*`, `#`. Maximum 64 characters. When omitted, no automatic DTMF
|
|
500
|
+
# is sent.
|
|
501
|
+
#
|
|
502
|
+
# @return [String, nil]
|
|
503
|
+
optional :extension, String
|
|
504
|
+
|
|
361
505
|
# @!attribute message
|
|
362
506
|
# The warm transfer message to deliver to this specific target. When set, it takes
|
|
363
507
|
# precedence over the message the assistant composes from
|
|
@@ -372,16 +516,36 @@ module Telnyx
|
|
|
372
516
|
# @return [String, nil]
|
|
373
517
|
optional :name, String
|
|
374
518
|
|
|
375
|
-
# @!
|
|
519
|
+
# @!attribute sip_auth_password
|
|
520
|
+
# SIP Authentication password used for SIP challenges. Applies when `to` is a SIP
|
|
521
|
+
# URI.
|
|
522
|
+
#
|
|
523
|
+
# @return [String, nil]
|
|
524
|
+
optional :sip_auth_password, String
|
|
525
|
+
|
|
526
|
+
# @!attribute sip_auth_username
|
|
527
|
+
# SIP Authentication username used for SIP challenges. Applies when `to` is a SIP
|
|
528
|
+
# URI.
|
|
529
|
+
#
|
|
530
|
+
# @return [String, nil]
|
|
531
|
+
optional :sip_auth_username, String
|
|
532
|
+
|
|
533
|
+
# @!method initialize(to:, extension: nil, message: nil, name: nil, sip_auth_password: nil, sip_auth_username: nil)
|
|
376
534
|
# Some parameter documentations has been truncated, see
|
|
377
535
|
# {Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList}
|
|
378
536
|
# for more details.
|
|
379
537
|
#
|
|
380
538
|
# @param to [String] The destination number or SIP URI of the call.
|
|
381
539
|
#
|
|
540
|
+
# @param extension [String] DTMF digits to send automatically after the transfer destination answers. Useful
|
|
541
|
+
#
|
|
382
542
|
# @param message [String] The warm transfer message to deliver to this specific target. When set, it takes
|
|
383
543
|
#
|
|
384
544
|
# @param name [String] The name of the target.
|
|
545
|
+
#
|
|
546
|
+
# @param sip_auth_password [String] SIP Authentication password used for SIP challenges. Applies when `to` is a SIP
|
|
547
|
+
#
|
|
548
|
+
# @param sip_auth_username [String] SIP Authentication username used for SIP challenges. Applies when `to` is a SIP
|
|
385
549
|
end
|
|
386
550
|
|
|
387
551
|
# @!method self.variants
|
|
@@ -733,8 +897,28 @@ module Telnyx
|
|
|
733
897
|
# @return [Symbol, :invite]
|
|
734
898
|
required :type, const: :invite
|
|
735
899
|
|
|
736
|
-
|
|
900
|
+
response_only do
|
|
901
|
+
# @!attribute shared
|
|
902
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
903
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
904
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
905
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
906
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
907
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
908
|
+
# per assistant).
|
|
909
|
+
#
|
|
910
|
+
# @return [Boolean, nil]
|
|
911
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
912
|
+
end
|
|
913
|
+
|
|
914
|
+
# @!method initialize(invite:, shared: nil, type: :invite)
|
|
915
|
+
# Some parameter documentations has been truncated, see
|
|
916
|
+
# {Telnyx::Models::AI::AssistantTool::Invite} for more details.
|
|
917
|
+
#
|
|
737
918
|
# @param invite [Telnyx::Models::AI::AssistantTool::Invite::Invite]
|
|
919
|
+
#
|
|
920
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
921
|
+
#
|
|
738
922
|
# @param type [Symbol, :invite]
|
|
739
923
|
|
|
740
924
|
# @see Telnyx::Models::AI::AssistantTool::Invite#invite
|
|
@@ -936,8 +1120,28 @@ module Telnyx
|
|
|
936
1120
|
# @return [Symbol, :refer]
|
|
937
1121
|
required :type, const: :refer
|
|
938
1122
|
|
|
939
|
-
|
|
1123
|
+
response_only do
|
|
1124
|
+
# @!attribute shared
|
|
1125
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1126
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1127
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
1128
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1129
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1130
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1131
|
+
# per assistant).
|
|
1132
|
+
#
|
|
1133
|
+
# @return [Boolean, nil]
|
|
1134
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
1135
|
+
end
|
|
1136
|
+
|
|
1137
|
+
# @!method initialize(refer:, shared: nil, type: :refer)
|
|
1138
|
+
# Some parameter documentations has been truncated, see
|
|
1139
|
+
# {Telnyx::Models::AI::AssistantTool::Refer} for more details.
|
|
1140
|
+
#
|
|
940
1141
|
# @param refer [Telnyx::Models::AI::AssistantTool::Refer::Refer]
|
|
1142
|
+
#
|
|
1143
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
1144
|
+
#
|
|
941
1145
|
# @param type [Symbol, :refer]
|
|
942
1146
|
|
|
943
1147
|
# @see Telnyx::Models::AI::AssistantTool::Refer#refer
|
|
@@ -1082,8 +1286,28 @@ module Telnyx
|
|
|
1082
1286
|
# @return [Symbol, :send_dtmf]
|
|
1083
1287
|
required :type, const: :send_dtmf
|
|
1084
1288
|
|
|
1085
|
-
|
|
1289
|
+
response_only do
|
|
1290
|
+
# @!attribute shared
|
|
1291
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1292
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1293
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
1294
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1295
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1296
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1297
|
+
# per assistant).
|
|
1298
|
+
#
|
|
1299
|
+
# @return [Boolean, nil]
|
|
1300
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
1301
|
+
end
|
|
1302
|
+
|
|
1303
|
+
# @!method initialize(send_dtmf:, shared: nil, type: :send_dtmf)
|
|
1304
|
+
# Some parameter documentations has been truncated, see
|
|
1305
|
+
# {Telnyx::Models::AI::AssistantTool::SendDtmf} for more details.
|
|
1306
|
+
#
|
|
1086
1307
|
# @param send_dtmf [Hash{Symbol=>Object}]
|
|
1308
|
+
#
|
|
1309
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
1310
|
+
#
|
|
1087
1311
|
# @param type [Symbol, :send_dtmf]
|
|
1088
1312
|
end
|
|
1089
1313
|
|
|
@@ -1098,13 +1322,33 @@ module Telnyx
|
|
|
1098
1322
|
# @return [Symbol, :send_message]
|
|
1099
1323
|
required :type, const: :send_message
|
|
1100
1324
|
|
|
1101
|
-
|
|
1325
|
+
response_only do
|
|
1326
|
+
# @!attribute shared
|
|
1327
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1328
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1329
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
1330
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1331
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1332
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1333
|
+
# per assistant).
|
|
1334
|
+
#
|
|
1335
|
+
# @return [Boolean, nil]
|
|
1336
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
1337
|
+
end
|
|
1338
|
+
|
|
1339
|
+
# @!method initialize(send_message:, shared: nil, type: :send_message)
|
|
1340
|
+
# Some parameter documentations has been truncated, see
|
|
1341
|
+
# {Telnyx::Models::AI::AssistantTool::SendMessage} for more details.
|
|
1342
|
+
#
|
|
1102
1343
|
# The send_message tool allows the assistant to send SMS or MMS messages to the
|
|
1103
1344
|
# end user. The 'to' and 'from' addresses are automatically determined from the
|
|
1104
1345
|
# conversation context, and the message text is generated by the assistant unless
|
|
1105
1346
|
# a message_template is provided for runtime variable substitution.
|
|
1106
1347
|
#
|
|
1107
1348
|
# @param send_message [Telnyx::Models::AI::AssistantTool::SendMessage::SendMessage]
|
|
1349
|
+
#
|
|
1350
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
1351
|
+
#
|
|
1108
1352
|
# @param type [Symbol, :send_message]
|
|
1109
1353
|
|
|
1110
1354
|
# @see Telnyx::Models::AI::AssistantTool::SendMessage#send_message
|
|
@@ -1138,8 +1382,28 @@ module Telnyx
|
|
|
1138
1382
|
# @return [Symbol, :skip_turn]
|
|
1139
1383
|
required :type, const: :skip_turn
|
|
1140
1384
|
|
|
1141
|
-
|
|
1385
|
+
response_only do
|
|
1386
|
+
# @!attribute shared
|
|
1387
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1388
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1389
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
1390
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1391
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1392
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1393
|
+
# per assistant).
|
|
1394
|
+
#
|
|
1395
|
+
# @return [Boolean, nil]
|
|
1396
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
1397
|
+
end
|
|
1398
|
+
|
|
1399
|
+
# @!method initialize(skip_turn:, shared: nil, type: :skip_turn)
|
|
1400
|
+
# Some parameter documentations has been truncated, see
|
|
1401
|
+
# {Telnyx::Models::AI::AssistantTool::SkipTurn} for more details.
|
|
1402
|
+
#
|
|
1142
1403
|
# @param skip_turn [Telnyx::Models::AI::AssistantTool::SkipTurn::SkipTurn]
|
|
1404
|
+
#
|
|
1405
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
1406
|
+
#
|
|
1143
1407
|
# @param type [Symbol, :skip_turn]
|
|
1144
1408
|
|
|
1145
1409
|
# @see Telnyx::Models::AI::AssistantTool::SkipTurn#skip_turn
|
|
@@ -1166,13 +1430,33 @@ module Telnyx
|
|
|
1166
1430
|
# @return [Symbol, :pay]
|
|
1167
1431
|
required :type, const: :pay
|
|
1168
1432
|
|
|
1169
|
-
|
|
1433
|
+
response_only do
|
|
1434
|
+
# @!attribute shared
|
|
1435
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1436
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1437
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
1438
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1439
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1440
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1441
|
+
# per assistant).
|
|
1442
|
+
#
|
|
1443
|
+
# @return [Boolean, nil]
|
|
1444
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
1445
|
+
end
|
|
1446
|
+
|
|
1447
|
+
# @!method initialize(pay:, shared: nil, type: :pay)
|
|
1448
|
+
# Some parameter documentations has been truncated, see
|
|
1449
|
+
# {Telnyx::Models::AI::AssistantTool::Pay} for more details.
|
|
1450
|
+
#
|
|
1170
1451
|
# (BETA) The pay tool allows the assistant to collect card payments from the
|
|
1171
1452
|
# caller via DTMF during the conversation. Recording is automatically paused while
|
|
1172
1453
|
# the pay tool is active and resumes when the payment flow completes. The
|
|
1173
1454
|
# connector_name must reference a pay connector configured in the Telnyx API.
|
|
1174
1455
|
#
|
|
1175
1456
|
# @param pay [Telnyx::Models::AI::PayToolParams]
|
|
1457
|
+
#
|
|
1458
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
1459
|
+
#
|
|
1176
1460
|
# @param type [Symbol, :pay]
|
|
1177
1461
|
end
|
|
1178
1462
|
|
|
@@ -1188,7 +1472,24 @@ module Telnyx
|
|
|
1188
1472
|
# @return [Telnyx::Models::AI::UpdateDynamicVariablesToolParams]
|
|
1189
1473
|
required :update_dynamic_variables, -> { Telnyx::AI::UpdateDynamicVariablesToolParams }
|
|
1190
1474
|
|
|
1191
|
-
|
|
1475
|
+
response_only do
|
|
1476
|
+
# @!attribute shared
|
|
1477
|
+
# Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1478
|
+
# tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1479
|
+
# Read-only: set by the server, not accepted in requests. When updating an
|
|
1480
|
+
# assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1481
|
+
# them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1482
|
+
# duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1483
|
+
# per assistant).
|
|
1484
|
+
#
|
|
1485
|
+
# @return [Boolean, nil]
|
|
1486
|
+
optional :shared, Telnyx::Internal::Type::Boolean
|
|
1487
|
+
end
|
|
1488
|
+
|
|
1489
|
+
# @!method initialize(update_dynamic_variables:, shared: nil, type: :update_dynamic_variables)
|
|
1490
|
+
# Some parameter documentations has been truncated, see
|
|
1491
|
+
# {Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables} for more details.
|
|
1492
|
+
#
|
|
1192
1493
|
# The update_dynamic_variables tool lets the assistant write values into the
|
|
1193
1494
|
# conversation's dynamic-variables context during the call. Updated variables are
|
|
1194
1495
|
# available to later `{{variable}}` interpolation (prompts, speak nodes, message
|
|
@@ -1197,11 +1498,13 @@ module Telnyx
|
|
|
1197
1498
|
#
|
|
1198
1499
|
# @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
|
|
1199
1500
|
#
|
|
1501
|
+
# @param shared [Boolean] Whether this tool comes from the shared Tools Library. Responses merge shared to
|
|
1502
|
+
#
|
|
1200
1503
|
# @param type [Symbol, :update_dynamic_variables]
|
|
1201
1504
|
end
|
|
1202
1505
|
|
|
1203
1506
|
# @!method self.variants
|
|
1204
|
-
# @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
1507
|
+
# @return [Array(Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables)]
|
|
1205
1508
|
end
|
|
1206
1509
|
end
|
|
1207
1510
|
end
|
|
@@ -174,10 +174,10 @@ module Telnyx
|
|
|
174
174
|
# @!attribute post_conversation_settings
|
|
175
175
|
# Configuration for post-conversation processing. When enabled, the assistant
|
|
176
176
|
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
177
|
-
# execute tool calls such as
|
|
178
|
-
#
|
|
179
|
-
#
|
|
180
|
-
#
|
|
177
|
+
# execute final tool calls such as sending a summary or updating a record via
|
|
178
|
+
# webhook or function tools. Integration and MCP server tools are not available
|
|
179
|
+
# post-conversation; call-control tools (e.g. hangup, transfer) are also
|
|
180
|
+
# unavailable. Beta feature.
|
|
181
181
|
#
|
|
182
182
|
# @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
|
|
183
183
|
optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
|
|
@@ -208,7 +208,11 @@ module Telnyx
|
|
|
208
208
|
|
|
209
209
|
# @!attribute tool_ids
|
|
210
210
|
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
211
|
-
# `tool_ids` over inline `tools`.
|
|
211
|
+
# `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
|
|
212
|
+
# replaces the assistant's attached shared tools; omit the field to leave them
|
|
213
|
+
# unchanged. Single-instance tool types are counted across inline `tools` and
|
|
214
|
+
# `tool_ids` combined, so attaching a shared tool of such a type when an instance
|
|
215
|
+
# already exists returns HTTP 400 with error code 10015.
|
|
212
216
|
#
|
|
213
217
|
# @return [Array<String>, nil]
|
|
214
218
|
optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
@@ -216,9 +220,16 @@ module Telnyx
|
|
|
216
220
|
# @!attribute tools
|
|
217
221
|
# Deprecated for new integrations. Inline tool definitions available to the
|
|
218
222
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
219
|
-
# endpoints.
|
|
220
|
-
#
|
|
221
|
-
#
|
|
223
|
+
# endpoints. On update, a sent `tools` array fully replaces the assistant's inline
|
|
224
|
+
# tools; omit the field to leave the inline tools unchanged. Each tool type except
|
|
225
|
+
# `function`, `webhook`, and `client_side_tool` allows at most one instance per
|
|
226
|
+
# assistant, counted across inline `tools` and shared `tool_ids` combined —
|
|
227
|
+
# sending a duplicate of such a type returns HTTP 400 with error code 10015.
|
|
228
|
+
# Responses merge shared tools into `tools` with `shared: true`; when updating,
|
|
229
|
+
# omit those tools from the `tools` array and manage them through `tool_ids`
|
|
230
|
+
# instead.
|
|
231
|
+
#
|
|
232
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>, nil]
|
|
222
233
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
223
234
|
|
|
224
235
|
# @!attribute transcription
|
|
@@ -234,8 +245,8 @@ module Telnyx
|
|
|
234
245
|
|
|
235
246
|
# @!attribute voice_settings
|
|
236
247
|
#
|
|
237
|
-
# @return [Telnyx::Models::AI::
|
|
238
|
-
optional :voice_settings, -> { Telnyx::AI::
|
|
248
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
|
|
249
|
+
optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
|
|
239
250
|
|
|
240
251
|
# @!attribute widget_settings
|
|
241
252
|
# Configuration settings for the assistant's web widget.
|
|
@@ -301,13 +312,13 @@ module Telnyx
|
|
|
301
312
|
#
|
|
302
313
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
303
314
|
#
|
|
304
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
315
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
305
316
|
#
|
|
306
317
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
307
318
|
#
|
|
308
319
|
# @param version_name [String] Human-readable name for the assistant version.
|
|
309
320
|
#
|
|
310
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
321
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings]
|
|
311
322
|
#
|
|
312
323
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
313
324
|
#
|
|
@@ -166,10 +166,10 @@ module Telnyx
|
|
|
166
166
|
# @!attribute post_conversation_settings
|
|
167
167
|
# Configuration for post-conversation processing. When enabled, the assistant
|
|
168
168
|
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
169
|
-
# execute tool calls such as
|
|
170
|
-
#
|
|
171
|
-
#
|
|
172
|
-
#
|
|
169
|
+
# execute final tool calls such as sending a summary or updating a record via
|
|
170
|
+
# webhook or function tools. Integration and MCP server tools are not available
|
|
171
|
+
# post-conversation; call-control tools (e.g. hangup, transfer) are also
|
|
172
|
+
# unavailable. Beta feature.
|
|
173
173
|
#
|
|
174
174
|
# @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
|
|
175
175
|
optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
|
|
@@ -193,7 +193,11 @@ module Telnyx
|
|
|
193
193
|
|
|
194
194
|
# @!attribute tool_ids
|
|
195
195
|
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
196
|
-
# `tool_ids` over inline `tools`.
|
|
196
|
+
# `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
|
|
197
|
+
# replaces the assistant's attached shared tools; omit the field to leave them
|
|
198
|
+
# unchanged. Single-instance tool types are counted across inline `tools` and
|
|
199
|
+
# `tool_ids` combined, so attaching a shared tool of such a type when an instance
|
|
200
|
+
# already exists returns HTTP 400 with error code 10015.
|
|
197
201
|
#
|
|
198
202
|
# @return [Array<String>, nil]
|
|
199
203
|
optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
@@ -201,9 +205,16 @@ module Telnyx
|
|
|
201
205
|
# @!attribute tools
|
|
202
206
|
# Deprecated for new integrations. Inline tool definitions available to the
|
|
203
207
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
204
|
-
# endpoints.
|
|
205
|
-
#
|
|
206
|
-
#
|
|
208
|
+
# endpoints. On update, a sent `tools` array fully replaces the assistant's inline
|
|
209
|
+
# tools; omit the field to leave the inline tools unchanged. Each tool type except
|
|
210
|
+
# `function`, `webhook`, and `client_side_tool` allows at most one instance per
|
|
211
|
+
# assistant, counted across inline `tools` and shared `tool_ids` combined —
|
|
212
|
+
# sending a duplicate of such a type returns HTTP 400 with error code 10015.
|
|
213
|
+
# Responses merge shared tools into `tools` with `shared: true`; when updating,
|
|
214
|
+
# omit those tools from the `tools` array and manage them through `tool_ids`
|
|
215
|
+
# instead.
|
|
216
|
+
#
|
|
217
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>, nil]
|
|
207
218
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
208
219
|
|
|
209
220
|
# @!attribute transcription
|
|
@@ -219,8 +230,8 @@ module Telnyx
|
|
|
219
230
|
|
|
220
231
|
# @!attribute voice_settings
|
|
221
232
|
#
|
|
222
|
-
# @return [Telnyx::Models::AI::
|
|
223
|
-
optional :voice_settings, -> { Telnyx::AI::
|
|
233
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
|
|
234
|
+
optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
|
|
224
235
|
|
|
225
236
|
# @!attribute widget_settings
|
|
226
237
|
# Configuration settings for the assistant's web widget.
|
|
@@ -282,13 +293,13 @@ module Telnyx
|
|
|
282
293
|
#
|
|
283
294
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
284
295
|
#
|
|
285
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
296
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
286
297
|
#
|
|
287
298
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
288
299
|
#
|
|
289
300
|
# @param version_name [String] Human-readable name for the assistant version.
|
|
290
301
|
#
|
|
291
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
302
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings]
|
|
292
303
|
#
|
|
293
304
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
294
305
|
end
|