telnyx 5.162.0 → 5.164.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/internal/cloudfs_cursor_pagination.rb +114 -0
- data/lib/telnyx/internal/email_bracket_cursor_pagination.rb +104 -0
- data/lib/telnyx/internal/email_cursor_pagination.rb +103 -0
- data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +4 -3
- data/lib/telnyx/models/ai/assistant_clone_params.rb +7 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +8 -1
- data/lib/telnyx/models/ai/assistant_imports_params.rb +8 -1
- data/lib/telnyx/models/ai/assistant_send_sms_params.rb +7 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +93 -2
- data/lib/telnyx/models/ai/assistants/canary_deploy_create_params.rb +7 -1
- data/lib/telnyx/models/ai/assistants/scheduled_event_create_params.rb +8 -1
- data/lib/telnyx/models/ai/assistants/test_create_params.rb +8 -1
- data/lib/telnyx/models/ai/assistants/tests/run_trigger_params.rb +8 -1
- data/lib/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rb +8 -1
- data/lib/telnyx/models/ai/chat_completion_request.rb +35 -1
- data/lib/telnyx/models/ai/collections/retrieval_settings.rb +6 -1
- data/lib/telnyx/models/ai/conversation_add_message_params.rb +8 -1
- data/lib/telnyx/models/ai/conversation_create_params.rb +8 -1
- data/lib/telnyx/models/ai/conversation_flow.rb +55 -0
- data/lib/telnyx/models/ai/conversation_flow_req.rb +6 -327
- data/lib/telnyx/models/ai/conversations/insight_create_params.rb +8 -1
- data/lib/telnyx/models/ai/conversations/insight_group_insight_groups_params.rb +7 -1
- data/lib/telnyx/models/ai/conversations/message_list_response.rb +43 -1
- data/lib/telnyx/models/ai/embedding_create_params.rb +8 -1
- data/lib/telnyx/models/ai/embedding_url_params.rb +8 -1
- data/lib/telnyx/models/ai/flow_edge.rb +5 -5
- data/lib/telnyx/models/ai/flow_node.rb +189 -0
- data/lib/telnyx/models/ai/flow_node_req.rb +184 -0
- data/lib/telnyx/models/ai/inference_embedding.rb +3 -384
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +113 -1
- data/lib/telnyx/models/ai/knowledge/collection_retrieve_documents_params.rb +114 -0
- data/lib/telnyx/models/ai/knowledge/collection_retrieve_documents_response.rb +182 -0
- data/lib/telnyx/models/ai/mcp_server_create_params.rb +7 -1
- data/lib/telnyx/models/ai/openai_create_response_params.rb +42 -1
- data/lib/telnyx/models/ai/speak_node.rb +74 -0
- data/lib/telnyx/models/ai/speak_node_req.rb +79 -0
- data/lib/telnyx/models/ai/telephony_settings.rb +16 -1
- data/lib/telnyx/models/ai/tool_create_params.rb +8 -1
- data/lib/telnyx/models/ai/tool_node.rb +84 -0
- data/lib/telnyx/models/ai/tool_node_req.rb +79 -0
- data/lib/telnyx/models/ai/transcription_settings.rb +6 -1
- data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb +112 -177
- data/lib/telnyx/models/ai_summarize_params.rb +8 -1
- data/lib/telnyx/models/call_answered.rb +3 -35
- data/lib/telnyx/models/call_hangup.rb +3 -35
- data/lib/telnyx/models/call_initiated.rb +3 -35
- data/lib/telnyx/models/call_payment_completed_webhook_event.rb +5 -2
- data/lib/telnyx/models/call_payment_progress_webhook_event.rb +4 -0
- data/lib/telnyx/models/calls/action_gather_params.rb +2 -1
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +3 -5
- data/lib/telnyx/models/calls/action_gather_using_audio_params.rb +2 -1
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +5 -14
- data/lib/telnyx/models/calls/action_pay_params.rb +44 -15
- data/lib/telnyx/models/calls/action_speak_params.rb +3 -13
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +5 -3
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +4 -6
- data/lib/telnyx/models/calls/pay_prompt_value.rb +19 -22
- data/lib/telnyx/models/calls/transcription_config.rb +6 -1
- data/lib/telnyx/models/calls/transcription_engine_cohere_config.rb +78 -0
- data/lib/telnyx/models/calls/transcription_engine_humain_config.rb +80 -0
- data/lib/telnyx/models/calls/transcription_engine_reson8_config.rb +87 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +8 -162
- data/lib/telnyx/models/conferences/action_gather_dtmf_audio_params.rb +4 -2
- data/lib/telnyx/models/conferences/action_speak_params.rb +3 -13
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +3 -5
- data/lib/telnyx/models/conversation_relay_language.rb +3 -5
- data/lib/telnyx/models/custom_storage_configuration.rb +4 -63
- data/lib/telnyx/models/dir/email_verification_status.rb +87 -0
- data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +3 -84
- data/lib/telnyx/models/doc_service_document.rb +6 -9
- data/lib/telnyx/models/document_link_list_response.rb +1 -9
- data/lib/telnyx/models/email_block_retrieve_events_response.rb +69 -86
- data/lib/telnyx/models/email_blocks/email_block_import.rb +171 -0
- data/lib/telnyx/models/email_blocks/email_block_import_response.rb +4 -167
- data/lib/telnyx/models/email_blocks/import_create_params.rb +1 -1
- data/lib/telnyx/models/email_blocks/import_retrieve_params.rb +1 -1
- data/lib/telnyx/models/email_domain_list_params.rb +12 -4
- data/lib/telnyx/models/email_event_list_response.rb +73 -115
- data/lib/telnyx/models/email_inbox.rb +1 -0
- data/lib/telnyx/models/email_inboxes/email_draft.rb +8 -6
- data/lib/telnyx/models/email_inboxes/email_draft_request.rb +7 -6
- data/lib/telnyx/models/email_inboxes/email_message_response.rb +3 -39
- data/lib/telnyx/models/email_inboxes/filter_add_response.rb +3 -36
- data/lib/telnyx/models/email_inboxes/filter_delete_all_response.rb +3 -37
- data/lib/telnyx/models/email_inboxes/filter_list_response.rb +3 -36
- data/lib/telnyx/models/email_inboxes/filter_replace_response.rb +3 -36
- data/lib/telnyx/models/email_inboxes/inbound_thread.rb +1 -0
- data/lib/telnyx/models/email_inboxes/inbound_thread_list_response.rb +0 -1
- data/lib/telnyx/models/email_inboxes/inbox_filters.rb +39 -0
- data/lib/telnyx/models/email_inboxes/message_update_params.rb +11 -22
- data/lib/telnyx/models/email_inboxes/messages/action_forward_params.rb +9 -9
- data/lib/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rb +3 -3
- data/lib/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rb +3 -3
- data/lib/telnyx/models/email_message_batch_params.rb +1 -1
- data/lib/telnyx/models/email_message_create_params.rb +1 -1
- data/lib/telnyx/models/email_messages/email_recipient.rb +1 -0
- data/lib/telnyx/models/email_template.rb +1 -0
- data/lib/telnyx/models/email_unsubscribe_group_delete_params.rb +12 -15
- data/lib/telnyx/models/email_validation_checks.rb +51 -0
- data/lib/telnyx/models/email_validation_create_response.rb +3 -50
- data/lib/telnyx/models/email_validations/batch_retrieve_response.rb +3 -50
- data/lib/telnyx/models/enterprise_create_params.rb +3 -3
- data/lib/telnyx/models/enterprise_public.rb +3 -3
- data/lib/telnyx/models/enterprise_update_params.rb +3 -3
- data/lib/telnyx/models/enterprises/reputation/remediation_per_number_results.rb +47 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_request.rb +116 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_request_wrapped.rb +3 -152
- data/lib/telnyx/models/inbound_message.rb +1 -31
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -594
- data/lib/telnyx/models/inbound_sip_header.rb +37 -0
- data/lib/telnyx/models/meeting_sessions/action_accepted_response.rb +4 -4
- data/lib/telnyx/models/message_event.rb +1 -0
- data/lib/telnyx/models/message_retrieve_response.rb +4 -594
- data/lib/telnyx/models/messaging_10dlc_get_enum_response.rb +3 -2
- data/lib/telnyx/models/messaging_error_0b38e7044b.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +589 -0
- data/lib/telnyx/models/numbers_sub_number_order.rb +301 -0
- data/lib/telnyx/models/{transcribe_client_event.rb → oauth_retrieve_authorize_response.rb} +1 -1
- data/lib/telnyx/models/phone_numbers/job_list_params.rb +67 -4
- data/lib/telnyx/models/pricing/product_retrieve_params.rb +6 -1
- data/lib/telnyx/models/pricing/product_retrieve_response.rb +163 -180
- data/lib/telnyx/models/rcs/agent_configuration.rb +9 -9
- data/lib/telnyx/models/rcs/agent_launch_params.rb +1 -25
- data/lib/telnyx/models/rcs/brand_address.rb +53 -0
- data/lib/telnyx/models/rcs/brand_create_params.rb +4 -65
- data/lib/telnyx/models/rcs/brand_identifier.rb +20 -0
- data/lib/telnyx/models/rcs/brand_response.rb +4 -62
- data/lib/telnyx/models/rcs/brand_update_params.rb +4 -65
- data/lib/telnyx/models/s3_generic_configuration_data.rb +75 -0
- data/lib/telnyx/models/sim_card_groups/sim_card_group_action.rb +9 -1
- data/lib/telnyx/models/speech_to_text_list_providers_params.rb +1 -0
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +19 -3
- data/lib/telnyx/models/storage/bucket_create_presigned_url_params.rb +16 -9
- data/lib/telnyx/models/storage/cloudf_list_response.rb +70 -144
- data/lib/telnyx/models/storage/cloudfs_filesystem.rb +111 -0
- data/lib/telnyx/models/storage/cloudfs_filesystem_detail.rb +109 -0
- data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +3 -107
- data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +3 -109
- data/lib/telnyx/models/storage/sqldbs/action_query_params.rb +1 -3
- data/lib/telnyx/models/sub_number_order_cancel_response.rb +3 -3
- data/lib/telnyx/models/sub_number_order_list_params.rb +15 -3
- data/lib/telnyx/models/sub_number_order_list_response.rb +3 -3
- data/lib/telnyx/models/sub_number_order_retrieve_response.rb +3 -3
- data/lib/telnyx/models/sub_number_order_update_response.rb +3 -3
- data/lib/telnyx/models/suppressed_recipient.rb +40 -0
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +10 -58
- data/lib/telnyx/models/text_to_speech_list_voices_params.rb +0 -1
- data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +13 -16
- data/lib/telnyx/models/transcription.rb +4 -3
- data/lib/telnyx/models/voice_sdk_call_report.rb +7 -6
- data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rb +3 -55
- data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rb +3 -56
- data/lib/telnyx/models/whatsapp/phone_numbers/whatsapp_conversational_component.rb +60 -0
- data/lib/telnyx/models/wireguard_interface_create_params.rb +4 -28
- data/lib/telnyx/models/wireless_blocklist.rb +0 -1
- data/lib/telnyx/models/wireless_blocklist_create_response.rb +3 -3
- data/lib/telnyx/models/wireless_blocklist_list_params.rb +1 -9
- data/lib/telnyx/models/wireless_blocklist_retrieve_response.rb +3 -3
- data/lib/telnyx/models/wireless_blocklist_update_response.rb +3 -3
- data/lib/telnyx/models/wireless_blocklist_value_list_response.rb +15 -45
- data/lib/telnyx/models/wireless_wireless_blocklist.rb +73 -0
- data/lib/telnyx/models.rb +14 -8
- data/lib/telnyx/resources/addresses.rb +6 -3
- data/lib/telnyx/resources/ai/anthropic/v1.rb +1 -1
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +11 -4
- data/lib/telnyx/resources/ai/assistants/scheduled_events.rb +19 -14
- data/lib/telnyx/resources/ai/assistants/tags.rb +2 -1
- data/lib/telnyx/resources/ai/assistants/tests/runs.rb +8 -4
- data/lib/telnyx/resources/ai/assistants/tests/test_suites/runs.rb +8 -4
- data/lib/telnyx/resources/ai/assistants/tests.rb +14 -10
- data/lib/telnyx/resources/ai/assistants/tools.rb +5 -2
- data/lib/telnyx/resources/ai/assistants.rb +72 -47
- data/lib/telnyx/resources/ai/collections/sources.rb +3 -1
- data/lib/telnyx/resources/ai/collections.rb +0 -68
- data/lib/telnyx/resources/ai/conversations/insight_groups/insights.rb +3 -2
- data/lib/telnyx/resources/ai/conversations/insight_groups.rb +25 -10
- data/lib/telnyx/resources/ai/conversations/insights.rb +21 -11
- data/lib/telnyx/resources/ai/conversations.rb +28 -16
- data/lib/telnyx/resources/ai/embeddings/buckets.rb +2 -1
- data/lib/telnyx/resources/ai/embeddings.rb +25 -11
- data/lib/telnyx/resources/ai/fine_tuning/jobs.rb +5 -3
- data/lib/telnyx/resources/ai/integrations/connections.rb +3 -2
- data/lib/telnyx/resources/ai/integrations.rb +4 -2
- data/lib/telnyx/resources/ai/knowledge/collections.rb +92 -0
- data/lib/telnyx/resources/ai/knowledge.rb +22 -0
- data/lib/telnyx/resources/ai/mcp_servers.rb +25 -11
- data/lib/telnyx/resources/ai/missions/knowledge_bases.rb +7 -4
- data/lib/telnyx/resources/ai/missions/mcp_servers.rb +9 -5
- data/lib/telnyx/resources/ai/missions/runs/events.rb +7 -3
- data/lib/telnyx/resources/ai/missions/runs/plan.rb +10 -4
- data/lib/telnyx/resources/ai/missions/runs/telnyx_agents.rb +4 -2
- data/lib/telnyx/resources/ai/missions/runs.rb +18 -8
- data/lib/telnyx/resources/ai/missions/tools.rb +8 -5
- data/lib/telnyx/resources/ai/missions.rb +14 -6
- data/lib/telnyx/resources/ai/openai/chat.rb +3 -1
- data/lib/telnyx/resources/ai/openai.rb +3 -1
- data/lib/telnyx/resources/ai/tools.rb +21 -14
- data/lib/telnyx/resources/ai.rb +18 -6
- data/lib/telnyx/resources/authentication_providers.rb +2 -1
- data/lib/telnyx/resources/bundle_pricing/billing_bundles.rb +4 -2
- data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +5 -3
- data/lib/telnyx/resources/call_control_applications.rb +4 -2
- data/lib/telnyx/resources/calls/actions.rb +20 -12
- data/lib/telnyx/resources/conferences/actions.rb +6 -4
- data/lib/telnyx/resources/conferences.rb +3 -2
- data/lib/telnyx/resources/country_coverage.rb +4 -2
- data/lib/telnyx/resources/credential_connections.rb +2 -1
- data/lib/telnyx/resources/custom_storage_credentials.rb +2 -2
- data/lib/telnyx/resources/customer_service_records.rb +4 -2
- data/lib/telnyx/resources/dialogflow_connections.rb +3 -2
- data/lib/telnyx/resources/documents.rb +4 -3
- data/lib/telnyx/resources/dynamic_emergency_addresses.rb +2 -1
- data/lib/telnyx/resources/dynamic_emergency_endpoints.rb +2 -1
- data/lib/telnyx/resources/email_blocks/{import.rb → imports.rb} +1 -1
- data/lib/telnyx/resources/email_blocks.rb +5 -4
- data/lib/telnyx/resources/email_domains.rb +7 -4
- data/lib/telnyx/resources/email_events.rb +2 -1
- data/lib/telnyx/resources/email_inboxes/drafts.rb +9 -8
- data/lib/telnyx/resources/email_inboxes/messages/actions.rb +3 -3
- data/lib/telnyx/resources/email_inboxes/messages.rb +6 -8
- data/lib/telnyx/resources/email_inboxes/threads.rb +3 -2
- data/lib/telnyx/resources/email_inboxes.rb +3 -2
- data/lib/telnyx/resources/email_messages/recipients.rb +3 -2
- data/lib/telnyx/resources/email_messages.rb +6 -4
- data/lib/telnyx/resources/email_templates.rb +5 -3
- data/lib/telnyx/resources/email_threads.rb +3 -2
- data/lib/telnyx/resources/email_unsubscribe_groups.rb +1 -1
- data/lib/telnyx/resources/enterprises.rb +2 -2
- data/lib/telnyx/resources/faxes.rb +1 -1
- data/lib/telnyx/resources/fqdn_connections.rb +3 -2
- data/lib/telnyx/resources/fqdns.rb +3 -3
- data/lib/telnyx/resources/global_ip_allowed_ports.rb +2 -1
- data/lib/telnyx/resources/global_ip_assignments.rb +11 -5
- data/lib/telnyx/resources/global_ip_health_check_types.rb +2 -1
- data/lib/telnyx/resources/global_ip_health_checks.rb +9 -4
- data/lib/telnyx/resources/global_ip_protocols.rb +2 -1
- data/lib/telnyx/resources/global_ips.rb +8 -4
- data/lib/telnyx/resources/invoices.rb +1 -1
- data/lib/telnyx/resources/ip_connections.rb +5 -3
- data/lib/telnyx/resources/ips.rb +4 -3
- data/lib/telnyx/resources/legacy/reporting/usage_reports/messaging.rb +2 -1
- data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb +2 -1
- data/lib/telnyx/resources/legacy/reporting/usage_reports/voice.rb +2 -1
- data/lib/telnyx/resources/managed_accounts.rb +2 -1
- data/lib/telnyx/resources/media.rb +5 -4
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +2 -1
- data/lib/telnyx/resources/messaging_10dlc.rb +1 -1
- data/lib/telnyx/resources/messaging_optouts.rb +2 -1
- data/lib/telnyx/resources/mobile_push_credentials.rb +4 -2
- data/lib/telnyx/resources/mobile_voice_connections.rb +2 -1
- data/lib/telnyx/resources/networks/default_gateway.rb +4 -3
- data/lib/telnyx/resources/networks.rb +9 -6
- data/lib/telnyx/resources/notification_channels.rb +8 -5
- data/lib/telnyx/resources/notification_profiles.rb +5 -4
- data/lib/telnyx/resources/notification_settings.rb +7 -4
- data/lib/telnyx/resources/number_block_orders.rb +2 -1
- data/lib/telnyx/resources/number_orders.rb +8 -4
- data/lib/telnyx/resources/number_reservations.rb +2 -1
- data/lib/telnyx/resources/oauth.rb +5 -3
- data/lib/telnyx/resources/oauth_clients.rb +6 -4
- data/lib/telnyx/resources/oauth_grants.rb +3 -2
- data/lib/telnyx/resources/organizations/users/actions.rb +2 -1
- data/lib/telnyx/resources/organizations/users.rb +2 -1
- data/lib/telnyx/resources/outbound_voice_profiles.rb +2 -1
- data/lib/telnyx/resources/phone_numbers/jobs.rb +5 -3
- data/lib/telnyx/resources/porting/events.rb +6 -3
- data/lib/telnyx/resources/porting/loa_configurations.rb +13 -6
- data/lib/telnyx/resources/porting/reports.rb +2 -1
- data/lib/telnyx/resources/porting.rb +2 -1
- data/lib/telnyx/resources/porting_orders/actions.rb +3 -2
- data/lib/telnyx/resources/porting_orders/activation_jobs.rb +2 -1
- data/lib/telnyx/resources/porting_orders/phone_number_blocks.rb +3 -2
- data/lib/telnyx/resources/porting_orders/phone_number_extensions.rb +3 -2
- data/lib/telnyx/resources/porting_orders.rb +7 -3
- data/lib/telnyx/resources/portouts/comments.rb +2 -1
- data/lib/telnyx/resources/portouts/events.rb +5 -3
- data/lib/telnyx/resources/portouts/reports.rb +2 -1
- data/lib/telnyx/resources/portouts.rb +2 -1
- data/lib/telnyx/resources/pricing/products.rb +6 -2
- data/lib/telnyx/resources/private_wireless_gateways.rb +1 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +8 -4
- data/lib/telnyx/resources/queues.rb +5 -3
- data/lib/telnyx/resources/rcs/brands.rb +2 -2
- data/lib/telnyx/resources/recordings.rb +4 -2
- data/lib/telnyx/resources/reports/mdr_usage_reports.rb +1 -1
- data/lib/telnyx/resources/reports.rb +4 -2
- data/lib/telnyx/resources/requirement_types.rb +2 -1
- data/lib/telnyx/resources/requirements.rb +3 -1
- data/lib/telnyx/resources/room_recordings.rb +2 -1
- data/lib/telnyx/resources/rooms.rb +4 -2
- data/lib/telnyx/resources/sim_card_groups/actions.rb +6 -4
- data/lib/telnyx/resources/sim_card_groups.rb +4 -3
- data/lib/telnyx/resources/sim_card_order_preview.rb +2 -1
- data/lib/telnyx/resources/sim_card_orders.rb +3 -2
- data/lib/telnyx/resources/sim_cards.rb +1 -1
- data/lib/telnyx/resources/siprec_connectors.rb +1 -1
- data/lib/telnyx/resources/speech_to_text.rb +8 -12
- data/lib/telnyx/resources/storage/buckets.rb +3 -3
- data/lib/telnyx/resources/storage/cloudfs.rb +2 -1
- data/lib/telnyx/resources/storage/migrations/actions.rb +2 -1
- data/lib/telnyx/resources/sub_number_orders.rb +3 -2
- data/lib/telnyx/resources/telephony_credentials.rb +7 -4
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +9 -5
- data/lib/telnyx/resources/texml/accounts/conferences.rb +6 -4
- data/lib/telnyx/resources/texml/accounts/queues.rb +7 -5
- data/lib/telnyx/resources/texml_applications.rb +3 -2
- data/lib/telnyx/resources/text_to_speech.rb +10 -12
- data/lib/telnyx/resources/traffic_policy_profiles.rb +2 -2
- data/lib/telnyx/resources/uac_connections.rb +1 -1
- data/lib/telnyx/resources/user_addresses.rb +4 -2
- data/lib/telnyx/resources/user_tags.rb +2 -1
- data/lib/telnyx/resources/verify_profiles.rb +2 -1
- data/lib/telnyx/resources/virtual_cross_connects.rb +4 -3
- data/lib/telnyx/resources/wireguard_interfaces.rb +4 -3
- data/lib/telnyx/resources/wireguard_peers.rb +4 -4
- data/lib/telnyx/resources/wireless/detail_records_reports.rb +3 -2
- data/lib/telnyx/resources/wireless_blocklist_values.rb +2 -1
- data/lib/telnyx/resources/wireless_blocklists.rb +10 -10
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +37 -20
- data/rbi/telnyx/internal/cloudfs_cursor_pagination.rbi +59 -0
- data/rbi/telnyx/internal/email_bracket_cursor_pagination.rbi +40 -0
- data/rbi/telnyx/internal/email_cursor_pagination.rbi +40 -0
- data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +6 -4
- data/rbi/telnyx/models/ai/assistant_clone_params.rbi +13 -2
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistant_imports_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistant_send_sms_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +185 -2
- data/rbi/telnyx/models/ai/assistants/canary_deploy_create_params.rbi +13 -2
- data/rbi/telnyx/models/ai/assistants/scheduled_event_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistants/test_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistants/tests/run_trigger_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rbi +9 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +93 -0
- data/rbi/telnyx/models/ai/collections/retrieval_settings.rbi +9 -5
- data/rbi/telnyx/models/ai/conversation_add_message_params.rbi +9 -0
- data/rbi/telnyx/models/ai/conversation_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/conversation_flow.rbi +88 -0
- data/rbi/telnyx/models/ai/conversation_flow_req.rbi +12 -648
- data/rbi/telnyx/models/ai/conversations/insight_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/conversations/insight_group_insight_groups_params.rbi +9 -0
- data/rbi/telnyx/models/ai/conversations/message_list_response.rbi +85 -0
- data/rbi/telnyx/models/ai/embedding_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/embedding_url_params.rbi +9 -0
- data/rbi/telnyx/models/ai/flow_edge.rbi +6 -6
- data/rbi/telnyx/models/ai/flow_node.rbi +348 -0
- data/rbi/telnyx/models/ai/flow_node_req.rbi +301 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +4 -843
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +221 -0
- data/rbi/telnyx/models/ai/knowledge/collection_retrieve_documents_params.rbi +206 -0
- data/rbi/telnyx/models/ai/knowledge/collection_retrieve_documents_response.rbi +336 -0
- data/rbi/telnyx/models/ai/mcp_server_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +130 -0
- data/rbi/telnyx/models/ai/speak_node.rbi +114 -0
- data/rbi/telnyx/models/ai/speak_node_req.rbi +119 -0
- data/rbi/telnyx/models/ai/telephony_settings.rbi +25 -0
- data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/tool_node.rbi +167 -0
- data/rbi/telnyx/models/ai/tool_node_req.rbi +119 -0
- data/rbi/telnyx/models/ai/transcription_settings.rbi +14 -2
- data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi +121 -250
- data/rbi/telnyx/models/ai_summarize_params.rbi +9 -0
- data/rbi/telnyx/models/call_answered.rbi +4 -90
- data/rbi/telnyx/models/call_hangup.rbi +4 -88
- data/rbi/telnyx/models/call_initiated.rbi +4 -92
- data/rbi/telnyx/models/call_payment_completed_webhook_event.rbi +16 -1
- data/rbi/telnyx/models/call_payment_progress_webhook_event.rbi +20 -0
- data/rbi/telnyx/models/calls/action_gather_params.rbi +4 -2
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +0 -5
- data/rbi/telnyx/models/calls/action_gather_using_audio_params.rbi +4 -2
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +4 -23
- data/rbi/telnyx/models/calls/action_pay_params.rbi +100 -2
- data/rbi/telnyx/models/calls/action_speak_params.rbi +0 -21
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +8 -4
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +0 -5
- data/rbi/telnyx/models/calls/pay_prompt_value.rbi +57 -40
- data/rbi/telnyx/models/calls/transcription_config.rbi +14 -2
- data/rbi/telnyx/models/calls/transcription_engine_cohere_config.rbi +204 -0
- data/rbi/telnyx/models/calls/transcription_engine_humain_config.rbi +214 -0
- data/rbi/telnyx/models/calls/transcription_engine_reson8_config.rbi +249 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -459
- data/rbi/telnyx/models/conferences/action_gather_dtmf_audio_params.rbi +6 -2
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +0 -21
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +0 -5
- data/rbi/telnyx/models/conversation_relay_language.rbi +0 -5
- data/rbi/telnyx/models/custom_storage_configuration.rbi +2 -85
- data/rbi/telnyx/models/dir/email_verification_status.rbi +155 -0
- data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +6 -171
- data/rbi/telnyx/models/doc_service_document.rbi +0 -11
- data/rbi/telnyx/models/document_link_list_response.rbi +3 -14
- data/rbi/telnyx/models/email_block_retrieve_events_response.rbi +118 -165
- data/rbi/telnyx/models/email_blocks/email_block_import.rbi +307 -0
- data/rbi/telnyx/models/email_blocks/email_block_import_response.rbi +6 -324
- data/rbi/telnyx/models/email_domain_list_params.rbi +10 -0
- data/rbi/telnyx/models/email_event_list_response.rbi +96 -197
- data/rbi/telnyx/models/email_inboxes/email_draft.rbi +8 -8
- data/rbi/telnyx/models/email_inboxes/email_draft_request.rbi +8 -8
- data/rbi/telnyx/models/email_inboxes/email_message_response.rbi +4 -78
- data/rbi/telnyx/models/email_inboxes/filter_add_response.rbi +6 -90
- data/rbi/telnyx/models/email_inboxes/filter_delete_all_response.rbi +6 -96
- data/rbi/telnyx/models/email_inboxes/filter_list_response.rbi +6 -90
- data/rbi/telnyx/models/email_inboxes/filter_replace_response.rbi +6 -94
- data/rbi/telnyx/models/email_inboxes/inbox_filters.rbi +75 -0
- data/rbi/telnyx/models/email_inboxes/message_update_params.rbi +41 -46
- data/rbi/telnyx/models/email_inboxes/messages/action_forward_params.rbi +25 -25
- data/rbi/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbi +3 -3
- data/rbi/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbi +3 -3
- data/rbi/telnyx/models/email_unsubscribe_group_delete_params.rbi +39 -22
- data/rbi/telnyx/models/email_validation_checks.rbi +96 -0
- data/rbi/telnyx/models/email_validation_create_response.rbi +4 -118
- data/rbi/telnyx/models/email_validations/batch_retrieve_response.rbi +4 -124
- data/rbi/telnyx/models/enterprise_create_params.rbi +4 -4
- data/rbi/telnyx/models/enterprise_public.rbi +4 -4
- data/rbi/telnyx/models/enterprise_update_params.rbi +4 -4
- data/rbi/telnyx/models/enterprises/reputation/remediation_per_number_results.rbi +84 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_request.rbi +159 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_request_wrapped.rbi +4 -237
- data/rbi/telnyx/models/inbound_message.rbi +3 -69
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -1433
- data/rbi/telnyx/models/inbound_sip_header.rbi +64 -0
- data/rbi/telnyx/models/meeting_sessions/action_accepted_response.rbi +1 -1
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -1437
- data/rbi/telnyx/models/messaging_10dlc_get_enum_response.rbi +4 -2
- data/rbi/telnyx/models/messaging_error_0b38e7044b.rbi +4 -4
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +1333 -0
- data/rbi/telnyx/models/numbers_sub_number_order.rbi +625 -0
- data/rbi/telnyx/models/oauth_retrieve_authorize_response.rbi +7 -0
- data/rbi/telnyx/models/phone_numbers/job_list_params.rbi +148 -3
- data/rbi/telnyx/models/pricing/product_retrieve_params.rbi +4 -0
- data/rbi/telnyx/models/pricing/product_retrieve_response.rbi +180 -232
- data/rbi/telnyx/models/rcs/agent_configuration.rbi +18 -18
- data/rbi/telnyx/models/rcs/agent_launch_params.rbi +3 -43
- data/rbi/telnyx/models/rcs/brand_address.rbi +69 -0
- data/rbi/telnyx/models/rcs/brand_create_params.rbi +6 -133
- data/rbi/telnyx/models/rcs/brand_identifier.rbi +25 -0
- data/rbi/telnyx/models/rcs/brand_response.rbi +5 -98
- data/rbi/telnyx/models/rcs/brand_update_params.rbi +7 -137
- data/rbi/telnyx/models/s3_generic_configuration_data.rbi +110 -0
- data/rbi/telnyx/models/sim_card_groups/sim_card_group_action.rbi +22 -5
- data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +5 -0
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +41 -2
- data/rbi/telnyx/models/storage/bucket_create_presigned_url_params.rbi +43 -14
- data/rbi/telnyx/models/storage/cloudf_list_response.rbi +89 -270
- data/rbi/telnyx/models/storage/cloudfs_filesystem.rbi +176 -0
- data/rbi/telnyx/models/storage/cloudfs_filesystem_detail.rbi +174 -0
- data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +4 -186
- data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +6 -192
- data/rbi/telnyx/models/storage/sqldbs/action_query_params.rbi +1 -2
- data/rbi/telnyx/models/sub_number_order.rbi +4 -6
- data/rbi/telnyx/models/sub_number_order_cancel_response.rbi +6 -4
- data/rbi/telnyx/models/sub_number_order_list_params.rbi +16 -3
- data/rbi/telnyx/models/sub_number_order_list_response.rbi +4 -4
- data/rbi/telnyx/models/sub_number_order_retrieve_response.rbi +6 -4
- data/rbi/telnyx/models/sub_number_order_update_response.rbi +6 -4
- data/rbi/telnyx/models/suppressed_recipient.rbi +61 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +13 -110
- data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +0 -5
- data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +20 -28
- data/rbi/telnyx/models/transcription.rbi +7 -8
- data/rbi/telnyx/models/voice_sdk_call_report.rbi +5 -5
- data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbi +4 -128
- data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbi +4 -128
- data/rbi/telnyx/models/whatsapp/phone_numbers/whatsapp_conversational_component.rbi +133 -0
- data/rbi/telnyx/models/wireguard_interface_create_params.rbi +6 -59
- data/rbi/telnyx/models/wireless_blocklist.rbi +2 -2
- data/rbi/telnyx/models/wireless_blocklist_create_response.rbi +4 -4
- data/rbi/telnyx/models/wireless_blocklist_list_params.rbi +0 -11
- data/rbi/telnyx/models/wireless_blocklist_retrieve_response.rbi +4 -4
- data/rbi/telnyx/models/wireless_blocklist_update_response.rbi +4 -4
- data/rbi/telnyx/models/wireless_blocklist_value_list_response.rbi +16 -52
- data/rbi/telnyx/models/wireless_wireless_blocklist.rbi +126 -0
- data/rbi/telnyx/models.rbi +15 -8
- data/rbi/telnyx/resources/addresses.rbi +6 -3
- data/rbi/telnyx/resources/ai/anthropic/v1.rbi +3 -2
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +12 -1
- data/rbi/telnyx/resources/ai/assistants/scheduled_events.rbi +31 -15
- data/rbi/telnyx/resources/ai/assistants/tags.rbi +2 -1
- data/rbi/telnyx/resources/ai/assistants/tests/runs.rbi +14 -4
- data/rbi/telnyx/resources/ai/assistants/tests/test_suites/runs.rbi +14 -4
- data/rbi/telnyx/resources/ai/assistants/tests.rbi +26 -16
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +5 -2
- data/rbi/telnyx/resources/ai/assistants.rbi +109 -48
- data/rbi/telnyx/resources/ai/collections/sources.rbi +3 -1
- data/rbi/telnyx/resources/ai/collections.rbi +0 -73
- data/rbi/telnyx/resources/ai/conversations/insight_groups/insights.rbi +3 -2
- data/rbi/telnyx/resources/ai/conversations/insight_groups.rbi +22 -5
- data/rbi/telnyx/resources/ai/conversations/insights.rbi +22 -6
- data/rbi/telnyx/resources/ai/conversations.rbi +34 -4
- data/rbi/telnyx/resources/ai/embeddings/buckets.rbi +2 -1
- data/rbi/telnyx/resources/ai/embeddings.rbi +28 -4
- data/rbi/telnyx/resources/ai/fine_tuning/jobs.rbi +5 -3
- data/rbi/telnyx/resources/ai/integrations/connections.rbi +3 -2
- data/rbi/telnyx/resources/ai/integrations.rbi +4 -2
- data/rbi/telnyx/resources/ai/knowledge/collections.rbi +99 -0
- data/rbi/telnyx/resources/ai/knowledge.rbi +19 -0
- data/rbi/telnyx/resources/ai/mcp_servers.rbi +21 -4
- data/rbi/telnyx/resources/ai/missions/knowledge_bases.rbi +7 -4
- data/rbi/telnyx/resources/ai/missions/mcp_servers.rbi +9 -5
- data/rbi/telnyx/resources/ai/missions/runs/events.rbi +7 -3
- data/rbi/telnyx/resources/ai/missions/runs/plan.rbi +10 -4
- data/rbi/telnyx/resources/ai/missions/runs/telnyx_agents.rbi +4 -2
- data/rbi/telnyx/resources/ai/missions/runs.rbi +18 -8
- data/rbi/telnyx/resources/ai/missions/tools.rbi +8 -5
- data/rbi/telnyx/resources/ai/missions.rbi +14 -6
- data/rbi/telnyx/resources/ai/openai/chat.rbi +8 -0
- data/rbi/telnyx/resources/ai/openai.rbi +3 -0
- data/rbi/telnyx/resources/ai/tools.rbi +22 -2
- data/rbi/telnyx/resources/ai.rbi +21 -4
- data/rbi/telnyx/resources/authentication_providers.rbi +2 -1
- data/rbi/telnyx/resources/bundle_pricing/billing_bundles.rbi +4 -2
- data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +5 -3
- data/rbi/telnyx/resources/call_control_applications.rbi +4 -2
- data/rbi/telnyx/resources/calls/actions.rbi +31 -32
- data/rbi/telnyx/resources/conferences/actions.rbi +7 -12
- data/rbi/telnyx/resources/conferences.rbi +3 -2
- data/rbi/telnyx/resources/country_coverage.rbi +4 -2
- data/rbi/telnyx/resources/credential_connections.rbi +2 -1
- data/rbi/telnyx/resources/custom_storage_credentials.rbi +2 -2
- data/rbi/telnyx/resources/customer_service_records.rbi +4 -2
- data/rbi/telnyx/resources/dialogflow_connections.rbi +3 -2
- data/rbi/telnyx/resources/documents.rbi +4 -3
- data/rbi/telnyx/resources/dynamic_emergency_addresses.rbi +2 -1
- data/rbi/telnyx/resources/dynamic_emergency_endpoints.rbi +2 -1
- data/rbi/telnyx/resources/email_blocks/{import.rbi → imports.rbi} +1 -1
- data/rbi/telnyx/resources/email_blocks.rbi +7 -3
- data/rbi/telnyx/resources/email_domains.rbi +5 -0
- data/rbi/telnyx/resources/email_events.rbi +5 -1
- data/rbi/telnyx/resources/email_inboxes/drafts.rbi +11 -7
- data/rbi/telnyx/resources/email_inboxes/messages/actions.rbi +6 -6
- data/rbi/telnyx/resources/email_inboxes/messages.rbi +11 -10
- data/rbi/telnyx/resources/email_inboxes/threads.rbi +5 -1
- data/rbi/telnyx/resources/email_inboxes.rbi +1 -1
- data/rbi/telnyx/resources/email_messages/recipients.rbi +5 -1
- data/rbi/telnyx/resources/email_messages.rbi +6 -2
- data/rbi/telnyx/resources/email_templates.rbi +5 -2
- data/rbi/telnyx/resources/email_threads.rbi +5 -1
- data/rbi/telnyx/resources/email_unsubscribe_groups.rbi +1 -1
- data/rbi/telnyx/resources/enterprises.rbi +2 -2
- data/rbi/telnyx/resources/faxes.rbi +1 -1
- data/rbi/telnyx/resources/fqdn_connections.rbi +3 -2
- data/rbi/telnyx/resources/fqdns.rbi +3 -3
- data/rbi/telnyx/resources/global_ip_allowed_ports.rbi +2 -1
- data/rbi/telnyx/resources/global_ip_assignments.rbi +11 -5
- data/rbi/telnyx/resources/global_ip_health_check_types.rbi +2 -1
- data/rbi/telnyx/resources/global_ip_health_checks.rbi +9 -4
- data/rbi/telnyx/resources/global_ip_protocols.rbi +2 -1
- data/rbi/telnyx/resources/global_ips.rbi +8 -4
- data/rbi/telnyx/resources/invoices.rbi +1 -1
- data/rbi/telnyx/resources/ip_connections.rbi +5 -3
- data/rbi/telnyx/resources/ips.rbi +4 -3
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/messaging.rbi +2 -1
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi +2 -1
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/voice.rbi +2 -1
- data/rbi/telnyx/resources/managed_accounts.rbi +2 -1
- data/rbi/telnyx/resources/media.rbi +5 -4
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +2 -1
- data/rbi/telnyx/resources/messaging_optouts.rbi +2 -1
- data/rbi/telnyx/resources/mobile_push_credentials.rbi +4 -2
- data/rbi/telnyx/resources/mobile_voice_connections.rbi +2 -1
- data/rbi/telnyx/resources/networks/default_gateway.rbi +4 -3
- data/rbi/telnyx/resources/networks.rbi +9 -6
- data/rbi/telnyx/resources/notification_channels.rbi +8 -5
- data/rbi/telnyx/resources/notification_profiles.rbi +5 -4
- data/rbi/telnyx/resources/notification_settings.rbi +7 -4
- data/rbi/telnyx/resources/number_block_orders.rbi +2 -1
- data/rbi/telnyx/resources/number_orders.rbi +8 -4
- data/rbi/telnyx/resources/number_reservations.rbi +2 -1
- data/rbi/telnyx/resources/oauth.rbi +3 -2
- data/rbi/telnyx/resources/oauth_clients.rbi +6 -4
- data/rbi/telnyx/resources/oauth_grants.rbi +3 -2
- data/rbi/telnyx/resources/organizations/users/actions.rbi +2 -1
- data/rbi/telnyx/resources/organizations/users.rbi +2 -1
- data/rbi/telnyx/resources/outbound_voice_profiles.rbi +2 -1
- data/rbi/telnyx/resources/phone_numbers/jobs.rbi +6 -3
- data/rbi/telnyx/resources/porting/events.rbi +6 -3
- data/rbi/telnyx/resources/porting/loa_configurations.rbi +13 -6
- data/rbi/telnyx/resources/porting/reports.rbi +2 -1
- data/rbi/telnyx/resources/porting.rbi +2 -1
- data/rbi/telnyx/resources/porting_orders/actions.rbi +3 -2
- data/rbi/telnyx/resources/porting_orders/activation_jobs.rbi +2 -1
- data/rbi/telnyx/resources/porting_orders/phone_number_blocks.rbi +3 -2
- data/rbi/telnyx/resources/porting_orders/phone_number_extensions.rbi +3 -2
- data/rbi/telnyx/resources/porting_orders.rbi +7 -3
- data/rbi/telnyx/resources/portouts/comments.rbi +2 -1
- data/rbi/telnyx/resources/portouts/events.rbi +5 -3
- data/rbi/telnyx/resources/portouts/reports.rbi +2 -1
- data/rbi/telnyx/resources/portouts.rbi +2 -1
- data/rbi/telnyx/resources/pricing/products.rbi +7 -1
- data/rbi/telnyx/resources/private_wireless_gateways.rbi +1 -1
- data/rbi/telnyx/resources/public_internet_gateways.rbi +8 -4
- data/rbi/telnyx/resources/queues.rbi +5 -3
- data/rbi/telnyx/resources/rcs/brands.rbi +2 -4
- data/rbi/telnyx/resources/recordings.rbi +4 -2
- data/rbi/telnyx/resources/reports/mdr_usage_reports.rbi +1 -1
- data/rbi/telnyx/resources/reports.rbi +4 -2
- data/rbi/telnyx/resources/requirement_types.rbi +2 -1
- data/rbi/telnyx/resources/requirements.rbi +3 -1
- data/rbi/telnyx/resources/room_recordings.rbi +2 -1
- data/rbi/telnyx/resources/rooms.rbi +4 -2
- data/rbi/telnyx/resources/sim_card_groups/actions.rbi +6 -4
- data/rbi/telnyx/resources/sim_card_groups.rbi +4 -3
- data/rbi/telnyx/resources/sim_card_order_preview.rbi +2 -1
- data/rbi/telnyx/resources/sim_card_orders.rbi +3 -2
- data/rbi/telnyx/resources/sim_cards.rbi +1 -1
- data/rbi/telnyx/resources/siprec_connectors.rbi +1 -1
- data/rbi/telnyx/resources/speech_to_text.rbi +11 -3
- data/rbi/telnyx/resources/storage/buckets.rbi +3 -3
- data/rbi/telnyx/resources/storage/cloudfs.rbi +5 -1
- data/rbi/telnyx/resources/storage/migrations/actions.rbi +2 -1
- data/rbi/telnyx/resources/sub_number_orders.rbi +4 -3
- data/rbi/telnyx/resources/telephony_credentials.rbi +7 -4
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +9 -5
- data/rbi/telnyx/resources/texml/accounts/conferences.rbi +6 -4
- data/rbi/telnyx/resources/texml/accounts/queues.rbi +7 -5
- data/rbi/telnyx/resources/texml_applications.rbi +3 -2
- data/rbi/telnyx/resources/text_to_speech.rbi +21 -26
- data/rbi/telnyx/resources/traffic_policy_profiles.rbi +2 -2
- data/rbi/telnyx/resources/uac_connections.rbi +1 -1
- data/rbi/telnyx/resources/user_addresses.rbi +4 -2
- data/rbi/telnyx/resources/user_tags.rbi +2 -1
- data/rbi/telnyx/resources/verify_profiles.rbi +2 -1
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +4 -3
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +4 -3
- data/rbi/telnyx/resources/wireguard_peers.rbi +4 -4
- data/rbi/telnyx/resources/wireless/detail_records_reports.rbi +3 -2
- data/rbi/telnyx/resources/wireless_blocklist_values.rbi +2 -1
- data/rbi/telnyx/resources/wireless_blocklists.rbi +9 -10
- data/sig/telnyx/internal/cloudfs_cursor_pagination.rbs +36 -0
- data/sig/telnyx/internal/email_bracket_cursor_pagination.rbs +24 -0
- data/sig/telnyx/internal/email_cursor_pagination.rbs +24 -0
- data/sig/telnyx/models/ai/assistant_clone_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_send_sms_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_tool.rbs +59 -3
- data/sig/telnyx/models/ai/assistants/canary_deploy_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistants/scheduled_event_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistants/test_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistants/tests/run_trigger_params.rbs +11 -1
- data/sig/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rbs +11 -1
- data/sig/telnyx/models/ai/chat_completion_request.rbs +26 -0
- data/sig/telnyx/models/ai/collections/retrieval_settings.rbs +1 -2
- data/sig/telnyx/models/ai/conversation_add_message_params.rbs +8 -1
- data/sig/telnyx/models/ai/conversation_create_params.rbs +11 -1
- data/sig/telnyx/models/ai/conversation_flow.rbs +45 -0
- data/sig/telnyx/models/ai/conversation_flow_req.rbs +3 -262
- data/sig/telnyx/models/ai/conversations/insight_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/conversations/insight_group_insight_groups_params.rbs +12 -1
- data/sig/telnyx/models/ai/conversations/message_list_response.rbs +31 -0
- data/sig/telnyx/models/ai/embedding_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/embedding_url_params.rbs +7 -1
- data/sig/telnyx/models/ai/flow_edge.rbs +3 -3
- data/sig/telnyx/models/ai/flow_node.rbs +155 -0
- data/sig/telnyx/models/ai/flow_node_req.rbs +148 -0
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -325
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +85 -0
- data/sig/telnyx/models/ai/knowledge/collection_retrieve_documents_params.rbs +93 -0
- data/sig/telnyx/models/ai/knowledge/collection_retrieve_documents_response.rbs +208 -0
- data/sig/telnyx/models/ai/mcp_server_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +47 -0
- data/sig/telnyx/models/ai/speak_node.rbs +60 -0
- data/sig/telnyx/models/ai/speak_node_req.rbs +60 -0
- data/sig/telnyx/models/ai/telephony_settings.rbs +7 -0
- data/sig/telnyx/models/ai/tool_create_params.rbs +8 -1
- data/sig/telnyx/models/ai/tool_node.rbs +69 -0
- data/sig/telnyx/models/ai/tool_node_req.rbs +60 -0
- data/sig/telnyx/models/ai/transcription_settings.rbs +2 -0
- data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs +68 -122
- data/sig/telnyx/models/ai_summarize_params.rbs +12 -1
- data/sig/telnyx/models/call_answered.rbs +6 -39
- data/sig/telnyx/models/call_hangup.rbs +6 -39
- data/sig/telnyx/models/call_initiated.rbs +6 -39
- data/sig/telnyx/models/call_payment_completed_webhook_event.rbs +13 -2
- data/sig/telnyx/models/call_payment_progress_webhook_event.rbs +14 -1
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +0 -1
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +0 -1
- data/sig/telnyx/models/calls/action_pay_params.rbs +38 -2
- data/sig/telnyx/models/calls/action_speak_params.rbs +0 -1
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +0 -1
- data/sig/telnyx/models/calls/pay_prompt_value.rbs +32 -19
- data/sig/telnyx/models/calls/transcription_config.rbs +2 -0
- data/sig/telnyx/models/calls/transcription_engine_cohere_config.rbs +75 -0
- data/sig/telnyx/models/calls/transcription_engine_humain_config.rbs +77 -0
- data/sig/telnyx/models/calls/transcription_engine_reson8_config.rbs +85 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +5 -154
- data/sig/telnyx/models/conferences/action_speak_params.rbs +0 -1
- data/sig/telnyx/models/conversation_relay_embedded_config.rbs +0 -1
- data/sig/telnyx/models/conversation_relay_language.rbs +0 -1
- data/sig/telnyx/models/custom_storage_configuration.rbs +1 -43
- data/sig/telnyx/models/dir/email_verification_status.rbs +64 -0
- data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +4 -67
- data/sig/telnyx/models/doc_service_document.rbs +0 -7
- data/sig/telnyx/models/document_link_list_response.rbs +3 -10
- data/sig/telnyx/models/email_block_retrieve_events_response.rbs +50 -72
- data/sig/telnyx/models/email_blocks/email_block_import.rbs +150 -0
- data/sig/telnyx/models/email_blocks/email_block_import_response.rbs +4 -151
- data/sig/telnyx/models/email_event_list_response.rbs +59 -110
- data/sig/telnyx/models/email_inboxes/email_draft.rbs +12 -10
- data/sig/telnyx/models/email_inboxes/email_draft_request.rbs +12 -10
- data/sig/telnyx/models/email_inboxes/email_message_response.rbs +6 -33
- data/sig/telnyx/models/email_inboxes/filter_add_response.rbs +4 -46
- data/sig/telnyx/models/email_inboxes/filter_delete_all_response.rbs +4 -45
- data/sig/telnyx/models/email_inboxes/filter_list_response.rbs +4 -46
- data/sig/telnyx/models/email_inboxes/filter_replace_response.rbs +4 -45
- data/sig/telnyx/models/email_inboxes/inbox_filters.rbs +42 -0
- data/sig/telnyx/models/email_inboxes/message_update_params.rbs +17 -7
- data/sig/telnyx/models/email_inboxes/messages/action_forward_params.rbs +3 -3
- data/sig/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbs +3 -3
- data/sig/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbs +3 -3
- data/sig/telnyx/models/email_unsubscribe_group_delete_params.rbs +14 -4
- data/sig/telnyx/models/email_validation_checks.rbs +52 -0
- data/sig/telnyx/models/email_validation_create_response.rbs +4 -53
- data/sig/telnyx/models/email_validations/batch_retrieve_response.rbs +4 -53
- data/sig/telnyx/models/enterprise_create_params.rbs +4 -4
- data/sig/telnyx/models/enterprise_public.rbs +5 -5
- data/sig/telnyx/models/enterprise_update_params.rbs +5 -5
- data/sig/telnyx/models/enterprises/reputation/remediation_per_number_results.rbs +54 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_request.rbs +84 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_request_wrapped.rbs +4 -130
- data/sig/telnyx/models/inbound_message.rbs +3 -45
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -613
- data/sig/telnyx/models/inbound_sip_header.rbs +33 -0
- data/sig/telnyx/models/meeting_sessions/action_accepted_response.rbs +4 -4
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -608
- data/sig/telnyx/models/messaging_10dlc_get_enum_response.rbs +1 -1
- data/sig/telnyx/models/messaging_error_0b38e7044b.rbs +5 -5
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +595 -0
- data/sig/telnyx/models/numbers_sub_number_order.rbs +316 -0
- data/sig/telnyx/models/oauth_retrieve_authorize_response.rbs +5 -0
- data/sig/telnyx/models/phone_numbers/job_list_params.rbs +46 -1
- data/sig/telnyx/models/pricing/product_retrieve_response.rbs +96 -118
- data/sig/telnyx/models/rcs/agent_configuration.rbs +9 -9
- data/sig/telnyx/models/rcs/agent_launch_params.rbs +3 -39
- data/sig/telnyx/models/rcs/brand_address.rbs +47 -0
- data/sig/telnyx/models/rcs/brand_create_params.rbs +7 -72
- data/sig/telnyx/models/rcs/brand_identifier.rbs +15 -0
- data/sig/telnyx/models/rcs/brand_response.rbs +8 -60
- data/sig/telnyx/models/rcs/brand_update_params.rbs +9 -74
- data/sig/telnyx/models/s3_generic_configuration_data.rbs +55 -0
- data/sig/telnyx/models/sim_card_groups/sim_card_group_action.rbs +14 -3
- data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +2 -0
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +15 -2
- data/sig/telnyx/models/storage/bucket_create_presigned_url_params.rbs +23 -5
- data/sig/telnyx/models/storage/cloudf_list_response.rbs +51 -132
- data/sig/telnyx/models/storage/cloudfs_filesystem.rbs +96 -0
- data/sig/telnyx/models/storage/cloudfs_filesystem_detail.rbs +96 -0
- data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +6 -99
- data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +6 -101
- data/sig/telnyx/models/storage/sqldbs/action_query_params.rbs +1 -1
- data/sig/telnyx/models/sub_number_order_cancel_response.rbs +8 -5
- data/sig/telnyx/models/sub_number_order_list_params.rbs +7 -0
- data/sig/telnyx/models/sub_number_order_list_response.rbs +9 -6
- data/sig/telnyx/models/sub_number_order_retrieve_response.rbs +8 -5
- data/sig/telnyx/models/sub_number_order_update_response.rbs +8 -5
- data/sig/telnyx/models/suppressed_recipient.rbs +30 -0
- data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +0 -47
- data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +0 -2
- data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +0 -2
- data/sig/telnyx/models/transcription.rbs +4 -6
- data/sig/telnyx/models/voice_sdk_call_report.rbs +3 -3
- data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbs +6 -64
- data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbs +6 -64
- data/sig/telnyx/models/whatsapp/phone_numbers/whatsapp_conversational_component.rbs +65 -0
- data/sig/telnyx/models/wireguard_interface_create_params.rbs +6 -48
- data/sig/telnyx/models/wireless_blocklist_create_response.rbs +7 -5
- data/sig/telnyx/models/wireless_blocklist_list_params.rbs +0 -7
- data/sig/telnyx/models/wireless_blocklist_retrieve_response.rbs +7 -5
- data/sig/telnyx/models/wireless_blocklist_update_response.rbs +7 -5
- data/sig/telnyx/models/wireless_blocklist_value_list_response.rbs +16 -35
- data/sig/telnyx/models/wireless_wireless_blocklist.rbs +71 -0
- data/sig/telnyx/models.rbs +14 -8
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants/scheduled_events.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants/tests/runs.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants/tests/test_suites/runs.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants/tests.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +4 -0
- data/sig/telnyx/resources/ai/collections.rbs +0 -12
- data/sig/telnyx/resources/ai/conversations/insight_groups.rbs +1 -0
- data/sig/telnyx/resources/ai/conversations/insights.rbs +1 -0
- data/sig/telnyx/resources/ai/conversations.rbs +2 -0
- data/sig/telnyx/resources/ai/embeddings.rbs +2 -0
- data/sig/telnyx/resources/ai/knowledge/collections.rbs +23 -0
- data/sig/telnyx/resources/ai/knowledge.rbs +11 -0
- data/sig/telnyx/resources/ai/mcp_servers.rbs +1 -0
- data/sig/telnyx/resources/ai/openai/chat.rbs +1 -0
- data/sig/telnyx/resources/ai/openai.rbs +1 -0
- data/sig/telnyx/resources/ai/tools.rbs +1 -0
- data/sig/telnyx/resources/ai.rbs +4 -1
- data/sig/telnyx/resources/calls/actions.rbs +1 -0
- data/sig/telnyx/resources/email_blocks/{import.rbs → imports.rbs} +1 -1
- data/sig/telnyx/resources/email_blocks.rbs +2 -2
- data/sig/telnyx/resources/email_events.rbs +1 -1
- data/sig/telnyx/resources/email_inboxes/drafts.rbs +7 -7
- data/sig/telnyx/resources/email_inboxes/messages.rbs +4 -4
- data/sig/telnyx/resources/email_inboxes/threads.rbs +1 -1
- data/sig/telnyx/resources/email_inboxes.rbs +1 -1
- data/sig/telnyx/resources/email_messages/recipients.rbs +1 -1
- data/sig/telnyx/resources/email_messages.rbs +2 -2
- data/sig/telnyx/resources/email_templates.rbs +1 -1
- data/sig/telnyx/resources/email_threads.rbs +1 -1
- data/sig/telnyx/resources/enterprises.rbs +2 -2
- data/sig/telnyx/resources/oauth.rbs +1 -1
- data/sig/telnyx/resources/pricing/products.rbs +1 -1
- data/sig/telnyx/resources/rcs/brands.rbs +2 -2
- data/sig/telnyx/resources/speech_to_text.rbs +1 -0
- data/sig/telnyx/resources/storage/buckets.rbs +1 -1
- data/sig/telnyx/resources/storage/cloudfs.rbs +1 -1
- data/sig/telnyx/resources/text_to_speech.rbs +0 -1
- data/sig/telnyx/resources/wireless_blocklists.rbs +2 -6
- metadata +110 -59
- data/lib/telnyx/models/ai/collection_retrieve_documents_params.rb +0 -104
- data/lib/telnyx/models/ai/collection_retrieve_documents_response.rb +0 -180
- data/lib/telnyx/models/billing_address.rb +0 -52
- data/lib/telnyx/models/email_inbox_list_response.rb +0 -41
- data/lib/telnyx/models/email_inboxes/draft_list_response.rb +0 -24
- data/lib/telnyx/models/email_inboxes/message_list_response.rb +0 -24
- data/lib/telnyx/models/email_message_list_response.rb +0 -22
- data/lib/telnyx/models/email_message_retrieve_events_response.rb +0 -22
- data/lib/telnyx/models/email_messages/recipient_list_response.rb +0 -43
- data/lib/telnyx/models/email_template_list_response.rb +0 -22
- data/lib/telnyx/models/rime_voice_settings.rb +0 -50
- data/lib/telnyx/models/speech_to_text_transcribe_params.rb +0 -14
- data/lib/telnyx/models/stream_client_event.rb +0 -42
- data/lib/telnyx/models/stream_server_event.rb +0 -200
- data/lib/telnyx/models/text_to_speech_stream_params.rb +0 -14
- data/lib/telnyx/models/transcribe_server_event.rb +0 -84
- data/lib/telnyx/models/wireless_blocklist_delete_response.rb +0 -16
- data/rbi/telnyx/models/ai/collection_retrieve_documents_params.rbi +0 -195
- data/rbi/telnyx/models/ai/collection_retrieve_documents_response.rbi +0 -334
- data/rbi/telnyx/models/billing_address.rbi +0 -69
- data/rbi/telnyx/models/email_inbox_list_response.rbi +0 -82
- data/rbi/telnyx/models/email_inboxes/draft_list_response.rbi +0 -48
- data/rbi/telnyx/models/email_inboxes/message_list_response.rbi +0 -48
- data/rbi/telnyx/models/email_message_list_response.rbi +0 -46
- data/rbi/telnyx/models/email_message_retrieve_events_response.rbi +0 -46
- data/rbi/telnyx/models/email_messages/recipient_list_response.rbi +0 -91
- data/rbi/telnyx/models/email_template_list_response.rbi +0 -46
- data/rbi/telnyx/models/rime_voice_settings.rbi +0 -84
- data/rbi/telnyx/models/speech_to_text_transcribe_params.rbi +0 -27
- data/rbi/telnyx/models/stream_client_event.rbi +0 -70
- data/rbi/telnyx/models/stream_server_event.rbi +0 -411
- data/rbi/telnyx/models/text_to_speech_stream_params.rbi +0 -27
- data/rbi/telnyx/models/transcribe_client_event.rbi +0 -7
- data/rbi/telnyx/models/transcribe_server_event.rbi +0 -127
- data/rbi/telnyx/models/wireless_blocklist_delete_response.rbi +0 -33
- data/sig/telnyx/models/ai/collection_retrieve_documents_params.rbs +0 -91
- data/sig/telnyx/models/ai/collection_retrieve_documents_response.rbs +0 -206
- data/sig/telnyx/models/billing_address.rbs +0 -45
- data/sig/telnyx/models/email_inbox_list_response.rbs +0 -39
- data/sig/telnyx/models/email_inboxes/draft_list_response.rbs +0 -27
- data/sig/telnyx/models/email_inboxes/message_list_response.rbs +0 -27
- data/sig/telnyx/models/email_message_list_response.rbs +0 -25
- data/sig/telnyx/models/email_message_retrieve_events_response.rbs +0 -25
- data/sig/telnyx/models/email_messages/recipient_list_response.rbs +0 -39
- data/sig/telnyx/models/email_template_list_response.rbs +0 -25
- data/sig/telnyx/models/rime_voice_settings.rbs +0 -44
- data/sig/telnyx/models/speech_to_text_transcribe_params.rbs +0 -15
- data/sig/telnyx/models/stream_client_event.rbs +0 -30
- data/sig/telnyx/models/stream_server_event.rbs +0 -180
- data/sig/telnyx/models/text_to_speech_stream_params.rbs +0 -15
- data/sig/telnyx/models/transcribe_client_event.rbs +0 -5
- data/sig/telnyx/models/transcribe_server_event.rbs +0 -61
- data/sig/telnyx/models/wireless_blocklist_delete_response.rbs +0 -16
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Knowledge
|
|
7
|
+
# @see Telnyx::Resources::AI::Knowledge::Collections#retrieve_documents
|
|
8
|
+
class CollectionRetrieveDocumentsParams < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute slug
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :slug, String
|
|
16
|
+
|
|
17
|
+
# @!attribute filter
|
|
18
|
+
# Field filters applied before ranking, using `filter[field][operator]=value`.
|
|
19
|
+
# Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
|
|
20
|
+
# Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
|
|
21
|
+
# `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
|
|
22
|
+
# `filter[record_id][eq]=rec_123`.
|
|
23
|
+
#
|
|
24
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
25
|
+
optional :filter, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
26
|
+
|
|
27
|
+
# @!attribute page_number
|
|
28
|
+
# Page number to return (1-based). Defaults to 1.
|
|
29
|
+
#
|
|
30
|
+
# @return [Integer, nil]
|
|
31
|
+
optional :page_number, Integer
|
|
32
|
+
|
|
33
|
+
# @!attribute page_size
|
|
34
|
+
# Number of results per page. Defaults to 20.
|
|
35
|
+
#
|
|
36
|
+
# @return [Integer, nil]
|
|
37
|
+
optional :page_size, Integer
|
|
38
|
+
|
|
39
|
+
# @!attribute query
|
|
40
|
+
# Natural-language search query. When provided, the text is matched against the
|
|
41
|
+
# collection's document chunks using the collection's `retrieval_type` (vector or
|
|
42
|
+
# hybrid). When omitted, documents are returned as a plain catalog listing.
|
|
43
|
+
#
|
|
44
|
+
# @return [String, nil]
|
|
45
|
+
optional :query, String
|
|
46
|
+
|
|
47
|
+
# @!attribute retrieval_type
|
|
48
|
+
# Reserved; not yet functional. A value supplied here is accepted but ignored — it
|
|
49
|
+
# does not override the collection's configured strategy, and it is not echoed
|
|
50
|
+
# back. Searches run `vector` retrieval, and `meta.retrieval_type` reports the
|
|
51
|
+
# mode that actually ran. To change retrieval strategy, set it on the collection's
|
|
52
|
+
# settings subresource.
|
|
53
|
+
#
|
|
54
|
+
# @return [Symbol, Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::RetrievalType, nil]
|
|
55
|
+
optional :retrieval_type,
|
|
56
|
+
enum: -> { Telnyx::AI::Knowledge::CollectionRetrieveDocumentsParams::RetrievalType }
|
|
57
|
+
|
|
58
|
+
# @!attribute sources
|
|
59
|
+
# Comma-separated list of source types to restrict the search to. When omitted,
|
|
60
|
+
# all of the collection's sources are searched.
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :sources, String
|
|
64
|
+
|
|
65
|
+
# @!attribute top_k
|
|
66
|
+
# Maximum number of ranked results to consider. When omitted, the collection's
|
|
67
|
+
# configured `top_k` setting is used.
|
|
68
|
+
#
|
|
69
|
+
# @return [Integer, nil]
|
|
70
|
+
optional :top_k, Integer
|
|
71
|
+
|
|
72
|
+
# @!method initialize(slug:, filter: nil, page_number: nil, page_size: nil, query: nil, retrieval_type: nil, sources: nil, top_k: nil, request_options: {})
|
|
73
|
+
# Some parameter documentations has been truncated, see
|
|
74
|
+
# {Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams} for more
|
|
75
|
+
# details.
|
|
76
|
+
#
|
|
77
|
+
# @param slug [String]
|
|
78
|
+
#
|
|
79
|
+
# @param filter [Hash{Symbol=>Object}] Field filters applied before ranking, using `filter[field][operator]=value`. Sup
|
|
80
|
+
#
|
|
81
|
+
# @param page_number [Integer] Page number to return (1-based). Defaults to 1.
|
|
82
|
+
#
|
|
83
|
+
# @param page_size [Integer] Number of results per page. Defaults to 20.
|
|
84
|
+
#
|
|
85
|
+
# @param query [String] Natural-language search query. When provided, the text is matched against the co
|
|
86
|
+
#
|
|
87
|
+
# @param retrieval_type [Symbol, Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::RetrievalType] Reserved; not yet functional. A value supplied here is accepted but ignored — it
|
|
88
|
+
#
|
|
89
|
+
# @param sources [String] Comma-separated list of source types to restrict the search to. When omitted, al
|
|
90
|
+
#
|
|
91
|
+
# @param top_k [Integer] Maximum number of ranked results to consider. When omitted, the collection's con
|
|
92
|
+
#
|
|
93
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
94
|
+
|
|
95
|
+
# Reserved; not yet functional. A value supplied here is accepted but ignored — it
|
|
96
|
+
# does not override the collection's configured strategy, and it is not echoed
|
|
97
|
+
# back. Searches run `vector` retrieval, and `meta.retrieval_type` reports the
|
|
98
|
+
# mode that actually ran. To change retrieval strategy, set it on the collection's
|
|
99
|
+
# settings subresource.
|
|
100
|
+
module RetrievalType
|
|
101
|
+
extend Telnyx::Internal::Type::Enum
|
|
102
|
+
|
|
103
|
+
VECTOR = :vector
|
|
104
|
+
HYBRID = :hybrid
|
|
105
|
+
KEYWORD = :keyword
|
|
106
|
+
|
|
107
|
+
# @!method self.values
|
|
108
|
+
# @return [Array<Symbol>]
|
|
109
|
+
end
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Knowledge
|
|
7
|
+
# @see Telnyx::Resources::AI::Knowledge::Collections#retrieve_documents
|
|
8
|
+
class CollectionRetrieveDocumentsResponse < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
# @!attribute data
|
|
10
|
+
#
|
|
11
|
+
# @return [Array<Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data>, nil]
|
|
12
|
+
optional :data,
|
|
13
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data] }
|
|
14
|
+
|
|
15
|
+
# @!attribute meta
|
|
16
|
+
#
|
|
17
|
+
# @return [Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta, nil]
|
|
18
|
+
optional :meta, -> { Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta }
|
|
19
|
+
|
|
20
|
+
# @!method initialize(data: nil, meta: nil)
|
|
21
|
+
# @param data [Array<Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data>]
|
|
22
|
+
# @param meta [Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta]
|
|
23
|
+
|
|
24
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
25
|
+
# @!attribute id
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :id, String
|
|
29
|
+
|
|
30
|
+
# @!attribute chunk_index
|
|
31
|
+
#
|
|
32
|
+
# @return [Integer, nil]
|
|
33
|
+
optional :chunk_index, Integer
|
|
34
|
+
|
|
35
|
+
# @!attribute chunk_total
|
|
36
|
+
#
|
|
37
|
+
# @return [Integer, nil]
|
|
38
|
+
optional :chunk_total, Integer
|
|
39
|
+
|
|
40
|
+
# @!attribute ingested_at
|
|
41
|
+
#
|
|
42
|
+
# @return [Time, nil]
|
|
43
|
+
optional :ingested_at, Time
|
|
44
|
+
|
|
45
|
+
# @!attribute metadata
|
|
46
|
+
#
|
|
47
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
48
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
49
|
+
|
|
50
|
+
# @!attribute organization_id
|
|
51
|
+
#
|
|
52
|
+
# @return [String, nil]
|
|
53
|
+
optional :organization_id, String
|
|
54
|
+
|
|
55
|
+
# @!attribute record_created_at
|
|
56
|
+
#
|
|
57
|
+
# @return [Time, nil]
|
|
58
|
+
optional :record_created_at, Time
|
|
59
|
+
|
|
60
|
+
# @!attribute record_id
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :record_id, String
|
|
64
|
+
|
|
65
|
+
# @!attribute record_type
|
|
66
|
+
# The source record kind this chunk came from (e.g. `voice`, `meeting_bot`,
|
|
67
|
+
# `message`).
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :record_type, String
|
|
71
|
+
|
|
72
|
+
# @!attribute region
|
|
73
|
+
#
|
|
74
|
+
# @return [String, nil]
|
|
75
|
+
optional :region, String
|
|
76
|
+
|
|
77
|
+
# @!attribute score
|
|
78
|
+
# Relevance score (higher = more relevant) for ranked search. `0.0` for plain
|
|
79
|
+
# catalog listings (when `query` is omitted).
|
|
80
|
+
#
|
|
81
|
+
# @return [Float, nil]
|
|
82
|
+
optional :score, Float
|
|
83
|
+
|
|
84
|
+
# @!attribute text
|
|
85
|
+
#
|
|
86
|
+
# @return [String, nil]
|
|
87
|
+
optional :text, String
|
|
88
|
+
|
|
89
|
+
# @!attribute user_id
|
|
90
|
+
#
|
|
91
|
+
# @return [String, nil]
|
|
92
|
+
optional :user_id, String
|
|
93
|
+
|
|
94
|
+
# @!method initialize(id: nil, chunk_index: nil, chunk_total: nil, ingested_at: nil, metadata: nil, organization_id: nil, record_created_at: nil, record_id: nil, record_type: nil, region: nil, score: nil, text: nil, user_id: nil)
|
|
95
|
+
# Some parameter documentations has been truncated, see
|
|
96
|
+
# {Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data} for
|
|
97
|
+
# more details.
|
|
98
|
+
#
|
|
99
|
+
# @param id [String]
|
|
100
|
+
#
|
|
101
|
+
# @param chunk_index [Integer]
|
|
102
|
+
#
|
|
103
|
+
# @param chunk_total [Integer]
|
|
104
|
+
#
|
|
105
|
+
# @param ingested_at [Time]
|
|
106
|
+
#
|
|
107
|
+
# @param metadata [Hash{Symbol=>Object}]
|
|
108
|
+
#
|
|
109
|
+
# @param organization_id [String]
|
|
110
|
+
#
|
|
111
|
+
# @param record_created_at [Time]
|
|
112
|
+
#
|
|
113
|
+
# @param record_id [String]
|
|
114
|
+
#
|
|
115
|
+
# @param record_type [String] The source record kind this chunk came from (e.g. `voice`, `meeting_bot`, `messa
|
|
116
|
+
#
|
|
117
|
+
# @param region [String]
|
|
118
|
+
#
|
|
119
|
+
# @param score [Float] Relevance score (higher = more relevant) for ranked search. `0.0` for plain cata
|
|
120
|
+
#
|
|
121
|
+
# @param text [String]
|
|
122
|
+
#
|
|
123
|
+
# @param user_id [String]
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# @see Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse#meta
|
|
127
|
+
class Meta < Telnyx::Internal::Type::BaseModel
|
|
128
|
+
# @!attribute collection_slug
|
|
129
|
+
#
|
|
130
|
+
# @return [String, nil]
|
|
131
|
+
optional :collection_slug, String
|
|
132
|
+
|
|
133
|
+
# @!attribute page_number
|
|
134
|
+
#
|
|
135
|
+
# @return [Integer, nil]
|
|
136
|
+
optional :page_number, Integer
|
|
137
|
+
|
|
138
|
+
# @!attribute page_size
|
|
139
|
+
#
|
|
140
|
+
# @return [Integer, nil]
|
|
141
|
+
optional :page_size, Integer
|
|
142
|
+
|
|
143
|
+
# @!attribute retrieval_type
|
|
144
|
+
#
|
|
145
|
+
# @return [String, nil]
|
|
146
|
+
optional :retrieval_type, String
|
|
147
|
+
|
|
148
|
+
# @!attribute searched_sources
|
|
149
|
+
#
|
|
150
|
+
# @return [Array<String>, nil]
|
|
151
|
+
optional :searched_sources, Telnyx::Internal::Type::ArrayOf[String]
|
|
152
|
+
|
|
153
|
+
# @!attribute top_k
|
|
154
|
+
#
|
|
155
|
+
# @return [Integer, nil]
|
|
156
|
+
optional :top_k, Integer
|
|
157
|
+
|
|
158
|
+
# @!attribute total_pages
|
|
159
|
+
#
|
|
160
|
+
# @return [Integer, nil]
|
|
161
|
+
optional :total_pages, Integer
|
|
162
|
+
|
|
163
|
+
# @!attribute total_results
|
|
164
|
+
#
|
|
165
|
+
# @return [Integer, nil]
|
|
166
|
+
optional :total_results, Integer
|
|
167
|
+
|
|
168
|
+
# @!method initialize(collection_slug: nil, page_number: nil, page_size: nil, retrieval_type: nil, searched_sources: nil, top_k: nil, total_pages: nil, total_results: nil)
|
|
169
|
+
# @param collection_slug [String]
|
|
170
|
+
# @param page_number [Integer]
|
|
171
|
+
# @param page_size [Integer]
|
|
172
|
+
# @param retrieval_type [String]
|
|
173
|
+
# @param searched_sources [Array<String>]
|
|
174
|
+
# @param top_k [Integer]
|
|
175
|
+
# @param total_pages [Integer]
|
|
176
|
+
# @param total_results [Integer]
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|
|
@@ -33,12 +33,18 @@ module Telnyx
|
|
|
33
33
|
# @return [String, nil]
|
|
34
34
|
optional :api_key_ref, String, nil?: true
|
|
35
35
|
|
|
36
|
-
# @!
|
|
36
|
+
# @!attribute idempotency_key
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :idempotency_key, String
|
|
40
|
+
|
|
41
|
+
# @!method initialize(name:, type:, url:, allowed_tools: nil, api_key_ref: nil, idempotency_key: nil, request_options: {})
|
|
37
42
|
# @param name [String]
|
|
38
43
|
# @param type [String]
|
|
39
44
|
# @param url [String]
|
|
40
45
|
# @param allowed_tools [Array<String>, nil]
|
|
41
46
|
# @param api_key_ref [String, nil]
|
|
47
|
+
# @param idempotency_key [String]
|
|
42
48
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
43
49
|
end
|
|
44
50
|
end
|
|
@@ -38,6 +38,11 @@ module Telnyx
|
|
|
38
38
|
# @return [String, nil]
|
|
39
39
|
optional :model, String
|
|
40
40
|
|
|
41
|
+
# @!attribute reasoning
|
|
42
|
+
#
|
|
43
|
+
# @return [Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning, nil]
|
|
44
|
+
optional :reasoning, -> { Telnyx::AI::OpenAICreateResponseParams::Reasoning }
|
|
45
|
+
|
|
41
46
|
# @!attribute service_tier
|
|
42
47
|
# The service tier to use for this request. Supported values vary by model; use
|
|
43
48
|
# `GET /v2/ai/openai/models` and inspect the model's `service_tiers` field. If
|
|
@@ -53,7 +58,7 @@ module Telnyx
|
|
|
53
58
|
# @return [Boolean, nil]
|
|
54
59
|
optional :stream, Telnyx::Internal::Type::Boolean
|
|
55
60
|
|
|
56
|
-
# @!method initialize(conversation: nil, input: nil, instructions: nil, model: nil, service_tier: nil, stream: nil, request_options: {})
|
|
61
|
+
# @!method initialize(conversation: nil, input: nil, instructions: nil, model: nil, reasoning: nil, service_tier: nil, stream: nil, request_options: {})
|
|
57
62
|
# Some parameter documentations has been truncated, see
|
|
58
63
|
# {Telnyx::Models::AI::OpenAICreateResponseParams} for more details.
|
|
59
64
|
#
|
|
@@ -65,11 +70,47 @@ module Telnyx
|
|
|
65
70
|
#
|
|
66
71
|
# @param model [String] Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or a
|
|
67
72
|
#
|
|
73
|
+
# @param reasoning [Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning]
|
|
74
|
+
#
|
|
68
75
|
# @param service_tier [String] The service tier to use for this request. Supported values vary by model; use `G
|
|
69
76
|
#
|
|
70
77
|
# @param stream [Boolean] Set to `true` to stream Server-Sent Events, matching OpenAI's Responses streamin
|
|
71
78
|
#
|
|
72
79
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
80
|
+
|
|
81
|
+
class Reasoning < Telnyx::Internal::Type::BaseModel
|
|
82
|
+
# @!attribute effort
|
|
83
|
+
# Controls the reasoning effort for models that support it. Same values and
|
|
84
|
+
# semantics as reasoning_effort on Chat Completions.
|
|
85
|
+
#
|
|
86
|
+
# @return [Symbol, Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::Effort, nil]
|
|
87
|
+
optional :effort, enum: -> { Telnyx::AI::OpenAICreateResponseParams::Reasoning::Effort }
|
|
88
|
+
|
|
89
|
+
# @!method initialize(effort: nil)
|
|
90
|
+
# Some parameter documentations has been truncated, see
|
|
91
|
+
# {Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning} for more details.
|
|
92
|
+
#
|
|
93
|
+
# @param effort [Symbol, Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::Effort] Controls the reasoning effort for models that support it. Same values and semant
|
|
94
|
+
|
|
95
|
+
# Controls the reasoning effort for models that support it. Same values and
|
|
96
|
+
# semantics as reasoning_effort on Chat Completions.
|
|
97
|
+
#
|
|
98
|
+
# @see Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning#effort
|
|
99
|
+
module Effort
|
|
100
|
+
extend Telnyx::Internal::Type::Enum
|
|
101
|
+
|
|
102
|
+
NONE = :none
|
|
103
|
+
MINIMAL = :minimal
|
|
104
|
+
LOW = :low
|
|
105
|
+
MEDIUM = :medium
|
|
106
|
+
HIGH = :high
|
|
107
|
+
XHIGH = :xhigh
|
|
108
|
+
MAX = :max
|
|
109
|
+
|
|
110
|
+
# @!method self.values
|
|
111
|
+
# @return [Array<Symbol>]
|
|
112
|
+
end
|
|
113
|
+
end
|
|
73
114
|
end
|
|
74
115
|
end
|
|
75
116
|
end
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class SpeakNode < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# Caller-supplied unique identifier for this node within the flow.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute message
|
|
14
|
+
# Message delivered to the user verbatim when the flow reaches this node. No LLM
|
|
15
|
+
# turn — the text is spoken/sent exactly as written. `{{variable}}` placeholders
|
|
16
|
+
# are interpolated from the conversation's dynamic variables; an unresolved
|
|
17
|
+
# placeholder renders as an empty string. After delivering, the flow routes via
|
|
18
|
+
# the node's outgoing `llm` / `expression` edges (commonly a single unconditional
|
|
19
|
+
# edge).
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :message, String
|
|
23
|
+
|
|
24
|
+
# @!attribute name
|
|
25
|
+
# Optional human-readable label, displayed in authoring UIs.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :name, String
|
|
29
|
+
|
|
30
|
+
# @!attribute position
|
|
31
|
+
# Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
32
|
+
# by the runtime; round-trips so frontends can persist graph layout across
|
|
33
|
+
# reloads.
|
|
34
|
+
#
|
|
35
|
+
# @return [Telnyx::Models::AI::NodePosition, nil]
|
|
36
|
+
optional :position, -> { Telnyx::AI::NodePosition }
|
|
37
|
+
|
|
38
|
+
# @!attribute type
|
|
39
|
+
# Node kind discriminator. Always `speak` for a speak node.
|
|
40
|
+
#
|
|
41
|
+
# @return [Symbol, Telnyx::Models::AI::SpeakNode::Type, nil]
|
|
42
|
+
optional :type, enum: -> { Telnyx::AI::SpeakNode::Type }
|
|
43
|
+
|
|
44
|
+
# @!method initialize(id:, message:, name: nil, position: nil, type: nil)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {Telnyx::Models::AI::SpeakNode} for more details.
|
|
47
|
+
#
|
|
48
|
+
# A standalone scripted-message step in a flow, as returned by the API.
|
|
49
|
+
#
|
|
50
|
+
# @param id [String] Caller-supplied unique identifier for this node within the flow.
|
|
51
|
+
#
|
|
52
|
+
# @param message [String] Message delivered to the user verbatim when the flow reaches this node. No LLM t
|
|
53
|
+
#
|
|
54
|
+
# @param name [String] Optional human-readable label, displayed in authoring UIs.
|
|
55
|
+
#
|
|
56
|
+
# @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
57
|
+
#
|
|
58
|
+
# @param type [Symbol, Telnyx::Models::AI::SpeakNode::Type] Node kind discriminator. Always `speak` for a speak node.
|
|
59
|
+
|
|
60
|
+
# Node kind discriminator. Always `speak` for a speak node.
|
|
61
|
+
#
|
|
62
|
+
# @see Telnyx::Models::AI::SpeakNode#type
|
|
63
|
+
module Type
|
|
64
|
+
extend Telnyx::Internal::Type::Enum
|
|
65
|
+
|
|
66
|
+
SPEAK = :speak
|
|
67
|
+
|
|
68
|
+
# @!method self.values
|
|
69
|
+
# @return [Array<Symbol>]
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class SpeakNodeReq < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# Caller-supplied unique identifier for this node within the flow.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute message
|
|
14
|
+
# Message delivered to the user verbatim when the flow reaches this node. No LLM
|
|
15
|
+
# turn — the text is spoken/sent exactly as written. `{{variable}}` placeholders
|
|
16
|
+
# are interpolated from the conversation's dynamic variables; an unresolved
|
|
17
|
+
# placeholder renders as an empty string. After delivering, the flow routes via
|
|
18
|
+
# the node's outgoing `llm` / `expression` edges (commonly a single unconditional
|
|
19
|
+
# edge).
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :message, String
|
|
23
|
+
|
|
24
|
+
# @!attribute name
|
|
25
|
+
# Optional human-readable label, displayed in authoring UIs.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :name, String
|
|
29
|
+
|
|
30
|
+
# @!attribute position
|
|
31
|
+
# Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
32
|
+
# by the runtime; round-trips so frontends can persist graph layout across
|
|
33
|
+
# reloads.
|
|
34
|
+
#
|
|
35
|
+
# @return [Telnyx::Models::AI::NodePosition, nil]
|
|
36
|
+
optional :position, -> { Telnyx::AI::NodePosition }
|
|
37
|
+
|
|
38
|
+
# @!attribute type
|
|
39
|
+
# Node kind discriminator. Always `speak` for a speak node.
|
|
40
|
+
#
|
|
41
|
+
# @return [Symbol, Telnyx::Models::AI::SpeakNodeReq::Type, nil]
|
|
42
|
+
optional :type, enum: -> { Telnyx::AI::SpeakNodeReq::Type }
|
|
43
|
+
|
|
44
|
+
# @!method initialize(id:, message:, name: nil, position: nil, type: nil)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {Telnyx::Models::AI::SpeakNodeReq} for more details.
|
|
47
|
+
#
|
|
48
|
+
# A standalone scripted-message step in a flow, as supplied by clients.
|
|
49
|
+
#
|
|
50
|
+
# Unlike a prompt node, a speak node has no instructions or model — it isn't an
|
|
51
|
+
# LLM turn. Reaching it delivers `message` to the user verbatim (with
|
|
52
|
+
# `{{variable}}` interpolation), then routes via outgoing `llm` / `expression`
|
|
53
|
+
# edges.
|
|
54
|
+
#
|
|
55
|
+
# @param id [String] Caller-supplied unique identifier for this node within the flow.
|
|
56
|
+
#
|
|
57
|
+
# @param message [String] Message delivered to the user verbatim when the flow reaches this node. No LLM t
|
|
58
|
+
#
|
|
59
|
+
# @param name [String] Optional human-readable label, displayed in authoring UIs.
|
|
60
|
+
#
|
|
61
|
+
# @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
62
|
+
#
|
|
63
|
+
# @param type [Symbol, Telnyx::Models::AI::SpeakNodeReq::Type] Node kind discriminator. Always `speak` for a speak node.
|
|
64
|
+
|
|
65
|
+
# Node kind discriminator. Always `speak` for a speak node.
|
|
66
|
+
#
|
|
67
|
+
# @see Telnyx::Models::AI::SpeakNodeReq#type
|
|
68
|
+
module Type
|
|
69
|
+
extend Telnyx::Internal::Type::Enum
|
|
70
|
+
|
|
71
|
+
SPEAK = :speak
|
|
72
|
+
|
|
73
|
+
# @!method self.values
|
|
74
|
+
# @return [Array<Symbol>]
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
@@ -39,6 +39,19 @@ module Telnyx
|
|
|
39
39
|
# @return [Telnyx::Models::AI::TelephonySettings::RecordingSettings, nil]
|
|
40
40
|
optional :recording_settings, -> { Telnyx::AI::TelephonySettings::RecordingSettings }
|
|
41
41
|
|
|
42
|
+
# @!attribute send_message_history_updates
|
|
43
|
+
# Whether the assistant sends a `call.ai_gather.message_history_updated` webhook
|
|
44
|
+
# with the full message history every time the conversation history changes. Leave
|
|
45
|
+
# unset to inherit the `send_message_history_updates` value from the
|
|
46
|
+
# `ai_assistant_start` or `gather_using_ai` command that started the conversation.
|
|
47
|
+
# Setting it here is authoritative: `true` turns the webhooks on even when the
|
|
48
|
+
# start command did not request them, and `false` turns them off even when it did.
|
|
49
|
+
# Messages exchanged during a private warm transfer acceptance phase are never
|
|
50
|
+
# included.
|
|
51
|
+
#
|
|
52
|
+
# @return [Boolean, nil]
|
|
53
|
+
optional :send_message_history_updates, Telnyx::Internal::Type::Boolean
|
|
54
|
+
|
|
42
55
|
# @!attribute supports_unauthenticated_web_calls
|
|
43
56
|
# When enabled, allows users to interact with your AI assistant directly from your
|
|
44
57
|
# website without requiring authentication. This is required for FE widgets that
|
|
@@ -84,7 +97,7 @@ module Telnyx
|
|
|
84
97
|
# @return [Telnyx::Models::AI::TelephonySettings::VoicemailDetection, nil]
|
|
85
98
|
optional :voicemail_detection, -> { Telnyx::AI::TelephonySettings::VoicemailDetection }
|
|
86
99
|
|
|
87
|
-
# @!method initialize(default_texml_app_id: nil, disable_dtmf: nil, noise_suppression: nil, noise_suppression_config: nil, recording_settings: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil, user_idle_reply_secs: nil, user_idle_timeout_secs: nil, voicemail_detection: nil)
|
|
100
|
+
# @!method initialize(default_texml_app_id: nil, disable_dtmf: nil, noise_suppression: nil, noise_suppression_config: nil, recording_settings: nil, send_message_history_updates: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil, user_idle_reply_secs: nil, user_idle_timeout_secs: nil, voicemail_detection: nil)
|
|
88
101
|
# Some parameter documentations has been truncated, see
|
|
89
102
|
# {Telnyx::Models::AI::TelephonySettings} for more details.
|
|
90
103
|
#
|
|
@@ -98,6 +111,8 @@ module Telnyx
|
|
|
98
111
|
#
|
|
99
112
|
# @param recording_settings [Telnyx::Models::AI::TelephonySettings::RecordingSettings] Configuration for call recording format and channel settings.
|
|
100
113
|
#
|
|
114
|
+
# @param send_message_history_updates [Boolean] Whether the assistant sends a `call.ai_gather.message_history_updated` webhook w
|
|
115
|
+
#
|
|
101
116
|
# @param supports_unauthenticated_web_calls [Boolean] When enabled, allows users to interact with your AI assistant directly from your
|
|
102
117
|
#
|
|
103
118
|
# @param time_limit_secs [Integer] Maximum duration in seconds for the AI assistant to participate on the call. Whe
|
|
@@ -64,7 +64,12 @@ module Telnyx
|
|
|
64
64
|
# @return [Hash{Symbol=>Object}, nil]
|
|
65
65
|
optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
66
66
|
|
|
67
|
-
# @!
|
|
67
|
+
# @!attribute idempotency_key
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :idempotency_key, String
|
|
71
|
+
|
|
72
|
+
# @!method initialize(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, update_dynamic_variables: nil, webhook: nil, idempotency_key: nil, request_options: {})
|
|
68
73
|
# @param display_name [String]
|
|
69
74
|
#
|
|
70
75
|
# @param type [String]
|
|
@@ -87,6 +92,8 @@ module Telnyx
|
|
|
87
92
|
#
|
|
88
93
|
# @param webhook [Hash{Symbol=>Object}]
|
|
89
94
|
#
|
|
95
|
+
# @param idempotency_key [String]
|
|
96
|
+
#
|
|
90
97
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
91
98
|
end
|
|
92
99
|
end
|