telnyx 5.125.0 → 5.127.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 +31 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +19 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +645 -27
- data/lib/telnyx/models/ai/assistant_retrieve_params.rb +13 -4
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +645 -27
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +123 -3
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +125 -3
- data/lib/telnyx/models/ai/assistants/scheduled_event_create_params.rb +51 -1
- data/lib/telnyx/models/ai/assistants/scheduled_event_list_params.rb +12 -3
- data/lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb +52 -1
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +653 -27
- data/lib/telnyx/models/ai/assistants/version_retrieve_params.rb +5 -1
- data/lib/telnyx/models/ai/cluster_fetch_graph_params.rb +4 -1
- data/lib/telnyx/models/ai/inference_embedding.rb +636 -27
- data/lib/telnyx/models/ai/mcp_server_list_params.rb +12 -4
- data/lib/telnyx/models/ai/mission_list_events_params.rb +2 -1
- data/lib/telnyx/models/ai/missions/run_list_params.rb +2 -1
- data/lib/telnyx/models/ai/missions/run_list_runs_params.rb +2 -1
- data/lib/telnyx/models/ai/missions/runs/event_list_params.rb +6 -3
- data/lib/telnyx/models/ai/openai_list_models_response.rb +210 -3
- data/lib/telnyx/models/ai/tool_list_params.rb +12 -4
- data/lib/telnyx/models/ai/transfer_tool.rb +9 -7
- data/lib/telnyx/models/ai_retrieve_models_response.rb +210 -3
- data/lib/telnyx/models/billing_address.rb +8 -12
- data/lib/telnyx/models/billing_contact.rb +5 -8
- data/lib/telnyx/models/call_dial_params.rb +46 -8
- data/lib/telnyx/models/call_reason_list_params.rb +35 -0
- data/lib/telnyx/models/call_reason_list_response.rb +32 -0
- data/lib/telnyx/models/call_reason_validate_params.rb +27 -0
- data/lib/telnyx/models/call_reason_validate_response.rb +52 -0
- data/lib/telnyx/models/calls/action_answer_params.rb +47 -8
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +23 -4
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +23 -4
- data/lib/telnyx/models/calls/action_speak_params.rb +23 -4
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +23 -4
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +70 -12
- data/lib/telnyx/models/calls/transcription_start_request.rb +167 -5
- data/lib/telnyx/models/conferences/action_speak_params.rb +23 -4
- data/lib/telnyx/models/dir/comment_create_params.rb +39 -0
- data/lib/telnyx/models/dir/comment_create_response.rb +147 -0
- data/lib/telnyx/models/dir/comment_list_params.rb +68 -0
- data/lib/telnyx/models/dir/comment_list_response.rb +136 -0
- data/lib/telnyx/models/dir/phone_number_add_params.rb +105 -0
- data/lib/telnyx/models/dir/phone_number_add_response.rb +206 -0
- data/lib/telnyx/models/dir/phone_number_batch_list_params.rb +66 -0
- data/lib/telnyx/models/dir/phone_number_batch_list_response.rb +349 -0
- data/lib/telnyx/models/dir/phone_number_batch_retrieve_params.rb +28 -0
- data/lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb +369 -0
- data/lib/telnyx/models/dir/phone_number_list_params.rb +66 -0
- data/lib/telnyx/models/dir/phone_number_list_response.rb +182 -0
- data/lib/telnyx/models/dir/phone_number_remove_params.rb +28 -0
- data/lib/telnyx/models/dir/phone_number_remove_response.rb +102 -0
- data/lib/telnyx/models/dir_create_loa_params.rb +158 -0
- data/lib/telnyx/models/dir_delete_params.rb +20 -0
- data/lib/telnyx/models/dir_list_document_types_params.rb +14 -0
- data/lib/telnyx/models/dir_list_document_types_response.rb +95 -0
- data/lib/telnyx/models/dir_list_infringement_claims_params.rb +40 -0
- data/lib/telnyx/models/dir_list_infringement_claims_response.rb +366 -0
- data/lib/telnyx/models/dir_list_params.rb +128 -0
- data/lib/telnyx/models/dir_list_response.rb +321 -0
- data/lib/telnyx/models/dir_retrieve_params.rb +20 -0
- data/lib/telnyx/models/dir_retrieve_response.rb +332 -0
- data/lib/telnyx/models/dir_submit_params.rb +20 -0
- data/lib/telnyx/models/dir_submit_response.rb +332 -0
- data/lib/telnyx/models/dir_update_infringement_params.rb +193 -0
- data/lib/telnyx/models/dir_update_infringement_response.rb +335 -0
- data/lib/telnyx/models/dir_update_params.rb +172 -0
- data/lib/telnyx/models/dir_update_response.rb +332 -0
- data/lib/telnyx/models/enterprise_activate_branded_calling_params.rb +20 -0
- data/lib/telnyx/models/enterprise_activate_branded_calling_response.rb +16 -0
- data/lib/telnyx/models/enterprise_create_params.rb +131 -50
- data/lib/telnyx/models/enterprise_create_response.rb +3 -3
- data/lib/telnyx/models/enterprise_list_params.rb +18 -7
- data/lib/telnyx/models/enterprise_public.rb +76 -128
- data/lib/telnyx/models/enterprise_retrieve_response.rb +3 -3
- data/lib/telnyx/models/enterprise_update_params.rb +75 -62
- data/lib/telnyx/models/enterprise_update_response.rb +3 -3
- data/lib/telnyx/models/enterprises/dir_create_params.rb +203 -0
- data/lib/telnyx/models/enterprises/dir_create_response.rb +337 -0
- data/lib/telnyx/models/enterprises/dir_list_params.rb +147 -0
- data/lib/telnyx/models/enterprises/dir_list_response.rb +324 -0
- data/lib/telnyx/models/enterprises/enterprise_reputation_public.rb +55 -27
- data/lib/telnyx/models/enterprises/reputation/loa_render_params.rb +146 -0
- data/lib/telnyx/models/enterprises/reputation/loa_update_params.rb +38 -0
- data/lib/telnyx/models/enterprises/reputation/loa_update_response.rb +20 -0
- data/lib/telnyx/models/enterprises/reputation/number_associate_params.rb +2 -2
- data/lib/telnyx/models/enterprises/reputation/number_associate_response.rb +91 -30
- data/lib/telnyx/models/enterprises/reputation/number_list_params.rb +22 -11
- data/lib/telnyx/models/enterprises/reputation/number_list_response.rb +59 -0
- data/lib/telnyx/models/enterprises/reputation/number_refresh_params.rb +37 -0
- data/lib/telnyx/models/enterprises/reputation/number_refresh_response.rb +79 -0
- data/lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb +3 -3
- data/lib/telnyx/models/enterprises/reputation/number_retrieve_response.rb +54 -4
- data/lib/telnyx/models/enterprises/reputation/remediation_create_params.rb +62 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_create_response.rb +187 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_list_params.rb +83 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_list_response.rb +89 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_retrieve_params.rb +30 -0
- data/lib/telnyx/models/enterprises/reputation/remediation_retrieve_response.rb +187 -0
- data/lib/telnyx/models/enterprises/reputation_enable_params.rb +9 -6
- data/lib/telnyx/models/enterprises/reputation_enable_response.rb +3 -3
- data/lib/telnyx/models/enterprises/reputation_retrieve_response.rb +3 -3
- data/lib/telnyx/models/enterprises/reputation_update_frequency_params.rb +8 -3
- data/lib/telnyx/models/enterprises/reputation_update_frequency_response.rb +3 -3
- data/lib/telnyx/models/infringement_claim_contest_params.rb +101 -0
- data/lib/telnyx/models/infringement_claim_contest_response.rb +377 -0
- data/lib/telnyx/models/infringement_claim_retrieve_params.rb +20 -0
- data/lib/telnyx/models/infringement_claim_retrieve_response.rb +377 -0
- data/lib/telnyx/models/legacy/reporting/usage_report_retrieve_speech_to_text_params.rb +6 -2
- data/lib/telnyx/models/messaging_10dlc/brand_list_params.rb +10 -5
- data/lib/telnyx/models/messaging_10dlc/campaign/usecase_get_cost_params.rb +3 -1
- data/lib/telnyx/models/messaging_10dlc/campaign_list_params.rb +2 -1
- data/lib/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_list_phone_number_status_params.rb +7 -2
- data/lib/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_retrieve_phone_number_status_params.rb +7 -2
- data/lib/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rb +4 -2
- data/lib/telnyx/models/messaging_hosted_number_list_params.rb +4 -2
- data/lib/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rb +7 -2
- data/lib/telnyx/models/messaging_profiles/autoresp_config_list_params.rb +2 -1
- data/lib/telnyx/models/messaging_tollfree/verification/request_list_params.rb +10 -6
- data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rb +4 -8
- data/lib/telnyx/models/network_list_interfaces_response.rb +2 -112
- data/lib/telnyx/models/organization_contact.rb +9 -16
- data/lib/telnyx/models/physical_address.rb +8 -12
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +8 -3
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +8 -3
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +10 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +8 -3
- data/lib/telnyx/models/report_list_mdrs_params.rb +17 -17
- data/lib/telnyx/models/report_list_wdrs_params.rb +18 -22
- data/lib/telnyx/models/reports/cdr_usage_report_fetch_sync_params.rb +17 -5
- data/lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb +13 -4
- data/lib/telnyx/models/reputation/number_list_params.rb +30 -11
- data/lib/telnyx/models/reputation/number_list_response.rb +57 -0
- data/lib/telnyx/models/reputation/number_retrieve_params.rb +3 -3
- data/lib/telnyx/models/reputation/number_retrieve_response.rb +54 -4
- data/lib/telnyx/models/reputation_data.rb +12 -16
- data/lib/telnyx/models/terms_of_service/agreement_list_params.rb +58 -0
- data/lib/telnyx/models/terms_of_service/agreement_list_response.rb +74 -0
- data/lib/telnyx/models/terms_of_service/agreement_retrieve_params.rb +22 -0
- data/lib/telnyx/models/terms_of_service/agreement_retrieve_response.rb +92 -0
- data/lib/telnyx/models/terms_of_service/branded_calling_agree_params.rb +16 -0
- data/lib/telnyx/models/terms_of_service/branded_calling_agree_response.rb +92 -0
- data/lib/telnyx/models/terms_of_service/number_reputation_agree_response.rb +93 -0
- data/lib/telnyx/models/terms_of_service_retrieve_info_params.rb +33 -0
- data/lib/telnyx/models/terms_of_service_retrieve_info_response.rb +70 -0
- data/lib/telnyx/models/terms_of_service_status_params.rb +33 -0
- data/lib/telnyx/models/terms_of_service_status_response.rb +93 -0
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection_create_params.rb +255 -9
- data/lib/telnyx/models/uac_connection_create_response.rb +878 -3
- data/lib/telnyx/models/uac_connection_delete_response.rb +878 -3
- data/lib/telnyx/models/uac_connection_list_response.rb +876 -0
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +879 -3
- data/lib/telnyx/models/uac_connection_update_params.rb +255 -9
- data/lib/telnyx/models/uac_connection_update_response.rb +878 -3
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +10 -0
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_create_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_list_response.rb +10 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +8 -3
- data/lib/telnyx/models.rb +34 -24
- data/lib/telnyx/resources/access_ip_address.rb +4 -2
- data/lib/telnyx/resources/access_ip_ranges.rb +2 -1
- data/lib/telnyx/resources/advanced_orders.rb +3 -2
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +12 -6
- data/lib/telnyx/resources/ai/assistants/scheduled_events.rb +22 -10
- data/lib/telnyx/resources/ai/assistants/tags.rb +7 -3
- data/lib/telnyx/resources/ai/assistants/tests/runs.rb +6 -4
- data/lib/telnyx/resources/ai/assistants/tests/test_suites/runs.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/tests.rb +5 -3
- data/lib/telnyx/resources/ai/assistants/tools.rb +10 -6
- data/lib/telnyx/resources/ai/assistants/versions.rb +21 -16
- data/lib/telnyx/resources/ai/assistants.rb +37 -23
- data/lib/telnyx/resources/ai/clusters.rb +7 -4
- data/lib/telnyx/resources/ai/conversations/messages.rb +1 -1
- data/lib/telnyx/resources/ai/conversations.rb +2 -1
- data/lib/telnyx/resources/ai/embeddings/buckets.rb +4 -2
- data/lib/telnyx/resources/ai/embeddings.rb +2 -1
- data/lib/telnyx/resources/ai/fine_tuning/jobs.rb +4 -2
- data/lib/telnyx/resources/ai/mcp_servers.rb +21 -7
- data/lib/telnyx/resources/ai/missions/knowledge_bases.rb +16 -8
- data/lib/telnyx/resources/ai/missions/mcp_servers.rb +16 -8
- data/lib/telnyx/resources/ai/missions/runs/events.rb +13 -10
- data/lib/telnyx/resources/ai/missions/runs/plan.rb +17 -12
- data/lib/telnyx/resources/ai/missions/runs/telnyx_agents.rb +12 -7
- data/lib/telnyx/resources/ai/missions/runs.rb +25 -14
- data/lib/telnyx/resources/ai/missions/tools.rb +16 -8
- data/lib/telnyx/resources/ai/missions.rb +15 -5
- data/lib/telnyx/resources/ai/tools.rb +22 -7
- data/lib/telnyx/resources/call_reasons.rb +77 -0
- data/lib/telnyx/resources/calls/actions.rb +6 -6
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/dir/comments.rb +81 -0
- data/lib/telnyx/resources/dir/phone_number_batches.rb +84 -0
- data/lib/telnyx/resources/dir/phone_numbers.rb +111 -0
- data/lib/telnyx/resources/dir.rb +357 -0
- data/lib/telnyx/resources/documents.rb +1 -1
- data/lib/telnyx/resources/enterprises/dir/comments.rb +18 -0
- data/lib/telnyx/resources/enterprises/dir/phone_number_batches.rb +18 -0
- data/lib/telnyx/resources/enterprises/dir/phone_numbers.rb +18 -0
- data/lib/telnyx/resources/enterprises/dir.rb +161 -0
- data/lib/telnyx/resources/enterprises/reputation/loa.rb +84 -0
- data/lib/telnyx/resources/enterprises/reputation/numbers.rb +75 -54
- data/lib/telnyx/resources/enterprises/reputation/remediation.rb +135 -0
- data/lib/telnyx/resources/enterprises/reputation.rb +47 -57
- data/lib/telnyx/resources/enterprises/usage.rb +16 -0
- data/lib/telnyx/resources/enterprises.rb +133 -58
- data/lib/telnyx/resources/infringement_claims.rb +80 -0
- data/lib/telnyx/resources/integration_secrets.rb +2 -1
- data/lib/telnyx/resources/legacy/reporting/batch_detail_records/messaging.rb +4 -2
- data/lib/telnyx/resources/legacy/reporting/batch_detail_records/speech_to_text.rb +4 -2
- data/lib/telnyx/resources/legacy/reporting/batch_detail_records/voice.rb +4 -2
- data/lib/telnyx/resources/legacy/reporting/usage_reports/messaging.rb +4 -2
- data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb +4 -2
- data/lib/telnyx/resources/legacy/reporting/usage_reports/voice.rb +4 -2
- data/lib/telnyx/resources/legacy/reporting/usage_reports.rb +4 -2
- data/lib/telnyx/resources/messaging_10dlc/brand/external_vetting.rb +4 -3
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +16 -11
- data/lib/telnyx/resources/messaging_10dlc/campaign/osr.rb +2 -1
- data/lib/telnyx/resources/messaging_10dlc/campaign/usecase.rb +2 -1
- data/lib/telnyx/resources/messaging_10dlc/campaign.rb +8 -5
- data/lib/telnyx/resources/messaging_10dlc/campaign_builder/brand.rb +4 -2
- data/lib/telnyx/resources/messaging_10dlc/partner_campaigns.rb +3 -2
- data/lib/telnyx/resources/messaging_10dlc/phone_number_assignment_by_profile.rb +14 -7
- data/lib/telnyx/resources/messaging_10dlc/phone_number_campaigns.rb +7 -5
- data/lib/telnyx/resources/messaging_10dlc.rb +2 -1
- data/lib/telnyx/resources/messaging_hosted_numbers.rb +2 -2
- data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +18 -9
- data/lib/telnyx/resources/messaging_profiles.rb +2 -2
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +13 -15
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/reports/cdr_usage_reports.rb +10 -5
- data/lib/telnyx/resources/reports/mdr_usage_reports.rb +12 -6
- data/lib/telnyx/resources/reports.rb +16 -19
- data/lib/telnyx/resources/reputation/numbers.rb +33 -22
- data/lib/telnyx/resources/reputation.rb +1 -2
- data/lib/telnyx/resources/terms_of_service/agreements.rb +79 -0
- data/lib/telnyx/resources/terms_of_service/branded_calling.rb +42 -0
- data/lib/telnyx/resources/terms_of_service/number_reputation.rb +7 -7
- data/lib/telnyx/resources/terms_of_service.rb +69 -1
- data/lib/telnyx/resources/uac_connections.rb +8 -8
- data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
- data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +87 -30
- data/rbi/telnyx/client.rbi +16 -1
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +1325 -135
- data/rbi/telnyx/models/ai/assistant_retrieve_params.rbi +8 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +1325 -135
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +290 -4
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +301 -3
- data/rbi/telnyx/models/ai/assistants/scheduled_event_create_params.rbi +138 -0
- data/rbi/telnyx/models/ai/assistants/scheduled_event_list_params.rbi +6 -0
- data/rbi/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rbi +138 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +1305 -95
- data/rbi/telnyx/models/ai/assistants/version_retrieve_params.rbi +2 -0
- data/rbi/telnyx/models/ai/cluster_fetch_graph_params.rbi +7 -1
- data/rbi/telnyx/models/ai/inference_embedding.rbi +1317 -138
- data/rbi/telnyx/models/ai/mcp_server_list_params.rbi +8 -0
- data/rbi/telnyx/models/ai/mission_list_events_params.rbi +2 -0
- data/rbi/telnyx/models/ai/missions/run_list_params.rbi +2 -0
- data/rbi/telnyx/models/ai/missions/run_list_runs_params.rbi +2 -0
- data/rbi/telnyx/models/ai/missions/runs/event_list_params.rbi +6 -0
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +315 -3
- data/rbi/telnyx/models/ai/tool_list_params.rbi +8 -0
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +310 -3
- data/rbi/telnyx/models/billing_address.rbi +4 -12
- data/rbi/telnyx/models/billing_contact.rbi +2 -8
- data/rbi/telnyx/models/call_dial_params.rbi +82 -10
- data/rbi/telnyx/models/call_reason_list_params.rbi +61 -0
- data/rbi/telnyx/models/call_reason_list_response.rbi +48 -0
- data/rbi/telnyx/models/call_reason_validate_params.rbi +44 -0
- data/rbi/telnyx/models/call_reason_validate_response.rbi +102 -0
- data/rbi/telnyx/models/calls/action_answer_params.rbi +84 -10
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +125 -15
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +480 -10
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +41 -5
- data/rbi/telnyx/models/dir/comment_create_params.rbi +62 -0
- data/rbi/telnyx/models/dir/comment_create_response.rbi +362 -0
- data/rbi/telnyx/models/dir/comment_list_params.rbi +145 -0
- data/rbi/telnyx/models/dir/comment_list_response.rbi +326 -0
- data/rbi/telnyx/models/dir/phone_number_add_params.rbi +226 -0
- data/rbi/telnyx/models/dir/phone_number_add_response.rbi +377 -0
- data/rbi/telnyx/models/dir/phone_number_batch_list_params.rbi +152 -0
- data/rbi/telnyx/models/dir/phone_number_batch_list_response.rbi +730 -0
- data/rbi/telnyx/models/dir/phone_number_batch_retrieve_params.rbi +48 -0
- data/rbi/telnyx/models/dir/phone_number_batch_retrieve_response.rbi +782 -0
- data/rbi/telnyx/models/dir/phone_number_list_params.rbi +139 -0
- data/rbi/telnyx/models/dir/phone_number_list_response.rbi +327 -0
- data/rbi/telnyx/models/dir/phone_number_remove_params.rbi +48 -0
- data/rbi/telnyx/models/dir/phone_number_remove_response.rbi +204 -0
- data/rbi/telnyx/models/dir_create_loa_params.rbi +223 -0
- data/rbi/telnyx/models/dir_delete_params.rbi +35 -0
- data/rbi/telnyx/models/dir_list_document_types_params.rbi +27 -0
- data/rbi/telnyx/models/dir_list_document_types_response.rbi +169 -0
- data/rbi/telnyx/models/dir_list_infringement_claims_params.rbi +66 -0
- data/rbi/telnyx/models/dir_list_infringement_claims_response.rbi +801 -0
- data/rbi/telnyx/models/dir_list_params.rbi +218 -0
- data/rbi/telnyx/models/dir_list_response.rbi +575 -0
- data/rbi/telnyx/models/dir_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/dir_retrieve_response.rbi +643 -0
- data/rbi/telnyx/models/dir_submit_params.rbi +35 -0
- data/rbi/telnyx/models/dir_submit_response.rbi +639 -0
- data/rbi/telnyx/models/dir_update_infringement_params.rbi +419 -0
- data/rbi/telnyx/models/dir_update_infringement_response.rbi +663 -0
- data/rbi/telnyx/models/dir_update_params.rbi +323 -0
- data/rbi/telnyx/models/dir_update_response.rbi +639 -0
- data/rbi/telnyx/models/enterprise_activate_branded_calling_params.rbi +38 -0
- data/rbi/telnyx/models/enterprise_activate_branded_calling_response.rbi +31 -0
- data/rbi/telnyx/models/enterprise_create_params.rbi +306 -79
- data/rbi/telnyx/models/enterprise_create_response.rbi +2 -2
- data/rbi/telnyx/models/enterprise_list_params.rbi +17 -6
- data/rbi/telnyx/models/enterprise_public.rbi +103 -275
- data/rbi/telnyx/models/enterprise_retrieve_response.rbi +2 -2
- data/rbi/telnyx/models/enterprise_update_params.rbi +206 -151
- data/rbi/telnyx/models/enterprise_update_response.rbi +2 -2
- data/rbi/telnyx/models/enterprises/dir_create_params.rbi +424 -0
- data/rbi/telnyx/models/enterprises/dir_create_response.rbi +665 -0
- data/rbi/telnyx/models/enterprises/dir_list_params.rbi +333 -0
- data/rbi/telnyx/models/enterprises/dir_list_response.rbi +625 -0
- data/rbi/telnyx/models/enterprises/enterprise_reputation_public.rbi +90 -26
- data/rbi/telnyx/models/enterprises/reputation/loa_render_params.rbi +238 -0
- data/rbi/telnyx/models/enterprises/reputation/loa_update_params.rbi +60 -0
- data/rbi/telnyx/models/enterprises/reputation/loa_update_response.rbi +45 -0
- data/rbi/telnyx/models/enterprises/reputation/number_associate_params.rbi +2 -2
- data/rbi/telnyx/models/enterprises/reputation/number_associate_response.rbi +123 -41
- data/rbi/telnyx/models/enterprises/reputation/number_list_params.rbi +26 -15
- data/rbi/telnyx/models/enterprises/reputation/number_list_response.rbi +98 -0
- data/rbi/telnyx/models/enterprises/reputation/number_refresh_params.rbi +58 -0
- data/rbi/telnyx/models/enterprises/reputation/number_refresh_response.rbi +166 -0
- data/rbi/telnyx/models/enterprises/reputation/number_retrieve_params.rbi +4 -4
- data/rbi/telnyx/models/enterprises/reputation/number_retrieve_response.rbi +101 -5
- data/rbi/telnyx/models/enterprises/reputation/remediation_create_params.rbi +88 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_create_response.rbi +332 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_list_params.rbi +166 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_list_response.rbi +144 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/enterprises/reputation/remediation_retrieve_response.rbi +332 -0
- data/rbi/telnyx/models/enterprises/reputation_enable_params.rbi +12 -7
- data/rbi/telnyx/models/enterprises/reputation_enable_response.rbi +2 -4
- data/rbi/telnyx/models/enterprises/reputation_retrieve_response.rbi +2 -4
- data/rbi/telnyx/models/enterprises/reputation_update_frequency_params.rbi +6 -3
- data/rbi/telnyx/models/enterprises/reputation_update_frequency_response.rbi +2 -4
- data/rbi/telnyx/models/infringement_claim_contest_params.rbi +234 -0
- data/rbi/telnyx/models/infringement_claim_contest_response.rbi +841 -0
- data/rbi/telnyx/models/infringement_claim_retrieve_params.rbi +38 -0
- data/rbi/telnyx/models/infringement_claim_retrieve_response.rbi +841 -0
- data/rbi/telnyx/models/legacy/reporting/usage_report_retrieve_speech_to_text_params.rbi +9 -1
- data/rbi/telnyx/models/messaging_10dlc/brand_list_params.rbi +10 -0
- data/rbi/telnyx/models/messaging_10dlc/campaign/usecase_get_cost_params.rbi +6 -1
- data/rbi/telnyx/models/messaging_10dlc/campaign_list_params.rbi +2 -0
- data/rbi/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_list_phone_number_status_params.rbi +4 -0
- data/rbi/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_retrieve_phone_number_status_params.rbi +4 -0
- data/rbi/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rbi +4 -0
- data/rbi/telnyx/models/messaging_hosted_number_list_params.rbi +4 -0
- data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbi +10 -1
- data/rbi/telnyx/models/messaging_profiles/autoresp_config_list_params.rbi +2 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_list_params.rbi +10 -2
- data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbi +4 -4
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +4 -181
- data/rbi/telnyx/models/organization_contact.rbi +6 -16
- data/rbi/telnyx/models/physical_address.rbi +4 -12
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +38 -6
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +38 -6
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +23 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +38 -6
- data/rbi/telnyx/models/report_list_mdrs_params.rbi +17 -17
- data/rbi/telnyx/models/report_list_wdrs_params.rbi +18 -20
- data/rbi/telnyx/models/reports/cdr_usage_report_fetch_sync_params.rbi +12 -0
- data/rbi/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rbi +9 -0
- data/rbi/telnyx/models/reputation/number_list_params.rbi +37 -15
- data/rbi/telnyx/models/reputation/number_list_response.rbi +96 -0
- data/rbi/telnyx/models/reputation/number_retrieve_params.rbi +4 -4
- data/rbi/telnyx/models/reputation/number_retrieve_response.rbi +96 -5
- data/rbi/telnyx/models/reputation_data.rbi +7 -16
- data/rbi/telnyx/models/terms_of_service/agreement_list_params.rbi +127 -0
- data/rbi/telnyx/models/terms_of_service/agreement_list_response.rbi +143 -0
- data/rbi/telnyx/models/terms_of_service/agreement_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/terms_of_service/agreement_retrieve_response.rbi +196 -0
- data/rbi/telnyx/models/terms_of_service/branded_calling_agree_params.rbi +32 -0
- data/rbi/telnyx/models/terms_of_service/branded_calling_agree_response.rbi +196 -0
- data/rbi/telnyx/models/terms_of_service/number_reputation_agree_response.rbi +196 -0
- data/rbi/telnyx/models/terms_of_service_retrieve_info_params.rbi +94 -0
- data/rbi/telnyx/models/terms_of_service_retrieve_info_response.rbi +182 -0
- data/rbi/telnyx/models/terms_of_service_status_params.rbi +89 -0
- data/rbi/telnyx/models/terms_of_service_status_response.rbi +167 -0
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection_create_params.rbi +516 -12
- data/rbi/telnyx/models/uac_connection_create_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_list_response.rbi +1727 -0
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_update_params.rbi +516 -12
- data/rbi/telnyx/models/uac_connection_update_response.rbi +1756 -4
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +36 -6
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +36 -6
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +23 -0
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +38 -6
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +23 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +36 -6
- data/rbi/telnyx/models.rbi +39 -25
- data/rbi/telnyx/resources/access_ip_address.rbi +10 -2
- data/rbi/telnyx/resources/access_ip_ranges.rbi +5 -1
- data/rbi/telnyx/resources/advanced_orders.rbi +6 -1
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +26 -6
- data/rbi/telnyx/resources/ai/assistants/scheduled_events.rbi +25 -2
- data/rbi/telnyx/resources/ai/assistants/tags.rbi +13 -2
- data/rbi/telnyx/resources/ai/assistants/tests/runs.rbi +9 -1
- data/rbi/telnyx/resources/ai/assistants/tests/test_suites/runs.rbi +2 -0
- data/rbi/telnyx/resources/ai/assistants/tests.rbi +11 -2
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +16 -4
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +38 -14
- data/rbi/telnyx/resources/ai/assistants.rbi +43 -15
- data/rbi/telnyx/resources/ai/clusters.rbi +13 -2
- data/rbi/telnyx/resources/ai/conversations/messages.rbi +1 -0
- data/rbi/telnyx/resources/ai/conversations.rbi +1 -0
- data/rbi/telnyx/resources/ai/embeddings/buckets.rbi +10 -2
- data/rbi/telnyx/resources/ai/embeddings.rbi +5 -1
- data/rbi/telnyx/resources/ai/fine_tuning/jobs.rbi +10 -2
- data/rbi/telnyx/resources/ai/mcp_servers.rbi +15 -2
- data/rbi/telnyx/resources/ai/missions/knowledge_bases.rbi +16 -2
- data/rbi/telnyx/resources/ai/missions/mcp_servers.rbi +31 -5
- data/rbi/telnyx/resources/ai/missions/runs/events.rbi +10 -7
- data/rbi/telnyx/resources/ai/missions/runs/plan.rbi +17 -8
- data/rbi/telnyx/resources/ai/missions/runs/telnyx_agents.rbi +12 -3
- data/rbi/telnyx/resources/ai/missions/runs.rbi +40 -7
- data/rbi/telnyx/resources/ai/missions/tools.rbi +31 -5
- data/rbi/telnyx/resources/ai/missions.rbi +17 -3
- data/rbi/telnyx/resources/ai/tools.rbi +15 -2
- data/rbi/telnyx/resources/call_reasons.rbi +60 -0
- data/rbi/telnyx/resources/calls/actions.rbi +7 -7
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/dir/comments.rbi +68 -0
- data/rbi/telnyx/resources/dir/phone_number_batches.rbi +63 -0
- data/rbi/telnyx/resources/dir/phone_numbers.rbi +92 -0
- data/rbi/telnyx/resources/dir.rbi +320 -0
- data/rbi/telnyx/resources/enterprises/dir/comments.rbi +16 -0
- data/rbi/telnyx/resources/enterprises/dir/phone_number_batches.rbi +16 -0
- data/rbi/telnyx/resources/enterprises/dir/phone_numbers.rbi +16 -0
- data/rbi/telnyx/resources/enterprises/dir.rbi +161 -0
- data/rbi/telnyx/resources/enterprises/reputation/loa.rbi +70 -0
- data/rbi/telnyx/resources/enterprises/reputation/numbers.rbi +61 -56
- data/rbi/telnyx/resources/enterprises/reputation/remediation.rbi +110 -0
- data/rbi/telnyx/resources/enterprises/reputation.rbi +47 -59
- data/rbi/telnyx/resources/enterprises/usage.rbi +14 -0
- data/rbi/telnyx/resources/enterprises.rbi +130 -74
- data/rbi/telnyx/resources/infringement_claims.rbi +66 -0
- data/rbi/telnyx/resources/integration_secrets.rbi +5 -1
- data/rbi/telnyx/resources/legacy/reporting/batch_detail_records/messaging.rbi +10 -2
- data/rbi/telnyx/resources/legacy/reporting/batch_detail_records/speech_to_text.rbi +10 -2
- data/rbi/telnyx/resources/legacy/reporting/batch_detail_records/voice.rbi +10 -2
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/messaging.rbi +10 -2
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi +10 -2
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/voice.rbi +10 -2
- data/rbi/telnyx/resources/legacy/reporting/usage_reports.rbi +2 -0
- data/rbi/telnyx/resources/messaging_10dlc/brand/external_vetting.rbi +7 -1
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +31 -5
- data/rbi/telnyx/resources/messaging_10dlc/campaign/osr.rbi +5 -1
- data/rbi/telnyx/resources/messaging_10dlc/campaign/usecase.rbi +5 -1
- data/rbi/telnyx/resources/messaging_10dlc/campaign.rbi +17 -3
- data/rbi/telnyx/resources/messaging_10dlc/campaign_builder/brand.rbi +7 -1
- data/rbi/telnyx/resources/messaging_10dlc/partner_campaigns.rbi +6 -1
- data/rbi/telnyx/resources/messaging_10dlc/phone_number_assignment_by_profile.rbi +11 -1
- data/rbi/telnyx/resources/messaging_10dlc/phone_number_campaigns.rbi +13 -2
- data/rbi/telnyx/resources/messaging_10dlc.rbi +5 -1
- data/rbi/telnyx/resources/messaging_hosted_numbers.rbi +2 -0
- data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +19 -4
- data/rbi/telnyx/resources/messaging_profiles.rbi +2 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +19 -5
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/reports/cdr_usage_reports.rbi +5 -0
- data/rbi/telnyx/resources/reports/mdr_usage_reports.rbi +14 -2
- data/rbi/telnyx/resources/reports.rbi +16 -17
- data/rbi/telnyx/resources/reputation/numbers.rbi +26 -23
- data/rbi/telnyx/resources/reputation.rbi +1 -2
- data/rbi/telnyx/resources/terms_of_service/agreements.rbi +67 -0
- data/rbi/telnyx/resources/terms_of_service/branded_calling.rbi +31 -0
- data/rbi/telnyx/resources/terms_of_service/number_reputation.rbi +10 -6
- data/rbi/telnyx/resources/terms_of_service.rbi +51 -1
- data/rbi/telnyx/resources/uac_connections.rbi +13 -7
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
- data/sig/telnyx/client.rbs +6 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +511 -42
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +511 -42
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +113 -6
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +109 -4
- data/sig/telnyx/models/ai/assistants/scheduled_event_create_params.rbs +45 -0
- data/sig/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rbs +45 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +514 -42
- data/sig/telnyx/models/ai/inference_embedding.rbs +512 -41
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +149 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +149 -4
- data/sig/telnyx/models/call_dial_params.rbs +30 -2
- data/sig/telnyx/models/call_reason_list_params.rbs +32 -0
- data/sig/telnyx/models/call_reason_list_response.rbs +28 -0
- data/sig/telnyx/models/call_reason_validate_params.rbs +23 -0
- data/sig/telnyx/models/call_reason_validate_response.rbs +43 -0
- data/sig/telnyx/models/calls/action_answer_params.rbs +30 -2
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_speak_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +45 -3
- data/sig/telnyx/models/calls/transcription_start_request.rbs +184 -2
- data/sig/telnyx/models/conferences/action_speak_params.rbs +15 -1
- data/sig/telnyx/models/dir/comment_create_params.rbs +36 -0
- data/sig/telnyx/models/dir/comment_create_response.rbs +148 -0
- data/sig/telnyx/models/dir/comment_list_params.rbs +74 -0
- data/sig/telnyx/models/dir/comment_list_response.rbs +133 -0
- data/sig/telnyx/models/dir/phone_number_add_params.rbs +102 -0
- data/sig/telnyx/models/dir/phone_number_add_response.rbs +159 -0
- data/sig/telnyx/models/dir/phone_number_batch_list_params.rbs +74 -0
- data/sig/telnyx/models/dir/phone_number_batch_list_response.rbs +312 -0
- data/sig/telnyx/models/dir/phone_number_batch_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/dir/phone_number_batch_retrieve_response.rbs +327 -0
- data/sig/telnyx/models/dir/phone_number_list_params.rbs +74 -0
- data/sig/telnyx/models/dir/phone_number_list_response.rbs +144 -0
- data/sig/telnyx/models/dir/phone_number_remove_params.rbs +30 -0
- data/sig/telnyx/models/dir/phone_number_remove_response.rbs +86 -0
- data/sig/telnyx/models/dir_create_loa_params.rbs +133 -0
- data/sig/telnyx/models/dir_delete_params.rbs +23 -0
- data/sig/telnyx/models/dir_list_document_types_params.rbs +15 -0
- data/sig/telnyx/models/dir_list_document_types_response.rbs +73 -0
- data/sig/telnyx/models/dir_list_infringement_claims_params.rbs +36 -0
- data/sig/telnyx/models/dir_list_infringement_claims_response.rbs +337 -0
- data/sig/telnyx/models/dir_list_params.rbs +142 -0
- data/sig/telnyx/models/dir_list_response.rbs +283 -0
- data/sig/telnyx/models/dir_retrieve_params.rbs +23 -0
- data/sig/telnyx/models/dir_retrieve_response.rbs +294 -0
- data/sig/telnyx/models/dir_submit_params.rbs +23 -0
- data/sig/telnyx/models/dir_submit_response.rbs +293 -0
- data/sig/telnyx/models/dir_update_infringement_params.rbs +175 -0
- data/sig/telnyx/models/dir_update_infringement_response.rbs +298 -0
- data/sig/telnyx/models/dir_update_params.rbs +162 -0
- data/sig/telnyx/models/dir_update_response.rbs +293 -0
- data/sig/telnyx/models/enterprise_activate_branded_calling_params.rbs +23 -0
- data/sig/telnyx/models/enterprise_activate_branded_calling_response.rbs +14 -0
- data/sig/telnyx/models/enterprise_create_params.rbs +120 -28
- data/sig/telnyx/models/enterprise_create_response.rbs +2 -4
- data/sig/telnyx/models/enterprise_list_params.rbs +12 -1
- data/sig/telnyx/models/enterprise_public.rbs +75 -107
- data/sig/telnyx/models/enterprise_retrieve_response.rbs +2 -4
- data/sig/telnyx/models/enterprise_update_params.rbs +130 -76
- data/sig/telnyx/models/enterprise_update_response.rbs +2 -4
- data/sig/telnyx/models/enterprises/dir_create_params.rbs +182 -0
- data/sig/telnyx/models/enterprises/dir_create_response.rbs +300 -0
- data/sig/telnyx/models/enterprises/dir_list_params.rbs +161 -0
- data/sig/telnyx/models/enterprises/dir_list_response.rbs +285 -0
- data/sig/telnyx/models/enterprises/enterprise_reputation_public.rbs +27 -6
- data/sig/telnyx/models/enterprises/reputation/loa_render_params.rbs +135 -0
- data/sig/telnyx/models/enterprises/reputation/loa_update_params.rbs +32 -0
- data/sig/telnyx/models/enterprises/reputation/loa_update_response.rbs +22 -0
- data/sig/telnyx/models/enterprises/reputation/number_associate_response.rbs +51 -20
- data/sig/telnyx/models/enterprises/reputation/number_list_params.rbs +15 -8
- data/sig/telnyx/models/enterprises/reputation/number_list_response.rbs +59 -0
- data/sig/telnyx/models/enterprises/reputation/number_refresh_params.rbs +32 -0
- data/sig/telnyx/models/enterprises/reputation/number_refresh_response.rbs +79 -0
- data/sig/telnyx/models/enterprises/reputation/number_retrieve_response.rbs +58 -8
- data/sig/telnyx/models/enterprises/reputation/remediation_create_params.rbs +54 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_create_response.rbs +163 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_list_params.rbs +82 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_list_response.rbs +74 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_retrieve_params.rbs +32 -0
- data/sig/telnyx/models/enterprises/reputation/remediation_retrieve_response.rbs +163 -0
- data/sig/telnyx/models/enterprises/reputation_enable_response.rbs +2 -6
- data/sig/telnyx/models/enterprises/reputation_retrieve_response.rbs +2 -6
- data/sig/telnyx/models/enterprises/reputation_update_frequency_response.rbs +2 -6
- data/sig/telnyx/models/infringement_claim_contest_params.rbs +104 -0
- data/sig/telnyx/models/infringement_claim_contest_response.rbs +352 -0
- data/sig/telnyx/models/infringement_claim_retrieve_params.rbs +23 -0
- data/sig/telnyx/models/infringement_claim_retrieve_response.rbs +352 -0
- data/sig/telnyx/models/network_list_interfaces_response.rbs +4 -106
- data/sig/telnyx/models/organization_contact.rbs +4 -4
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +18 -6
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +18 -6
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +11 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +18 -6
- data/sig/telnyx/models/reputation/number_list_params.rbs +25 -7
- data/sig/telnyx/models/reputation/number_list_response.rbs +57 -0
- data/sig/telnyx/models/reputation/number_retrieve_response.rbs +56 -8
- data/sig/telnyx/models/terms_of_service/agreement_list_params.rbs +57 -0
- data/sig/telnyx/models/terms_of_service/agreement_list_response.rbs +72 -0
- data/sig/telnyx/models/terms_of_service/agreement_retrieve_params.rbs +25 -0
- data/sig/telnyx/models/terms_of_service/agreement_retrieve_response.rbs +89 -0
- data/sig/telnyx/models/terms_of_service/branded_calling_agree_params.rbs +17 -0
- data/sig/telnyx/models/terms_of_service/branded_calling_agree_response.rbs +89 -0
- data/sig/telnyx/models/terms_of_service/number_reputation_agree_response.rbs +89 -0
- data/sig/telnyx/models/terms_of_service_retrieve_info_params.rbs +41 -0
- data/sig/telnyx/models/terms_of_service_retrieve_info_response.rbs +84 -0
- data/sig/telnyx/models/terms_of_service_status_params.rbs +39 -0
- data/sig/telnyx/models/terms_of_service_status_response.rbs +71 -0
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection_create_params.rbs +211 -17
- data/sig/telnyx/models/uac_connection_create_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_delete_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_list_response.rbs +722 -0
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_update_params.rbs +211 -17
- data/sig/telnyx/models/uac_connection_update_response.rbs +731 -5
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +11 -0
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +11 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +18 -6
- data/sig/telnyx/models.rbs +34 -24
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/ai/assistants/scheduled_events.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +6 -6
- data/sig/telnyx/resources/ai/assistants.rbs +12 -12
- data/sig/telnyx/resources/call_reasons.rbs +18 -0
- data/sig/telnyx/resources/dir/comments.rbs +24 -0
- data/sig/telnyx/resources/dir/phone_number_batches.rbs +23 -0
- data/sig/telnyx/resources/dir/phone_numbers.rbs +30 -0
- data/sig/telnyx/resources/dir.rbs +86 -0
- data/sig/telnyx/resources/enterprises/dir/comments.rbs +11 -0
- data/sig/telnyx/resources/enterprises/dir/phone_number_batches.rbs +11 -0
- data/sig/telnyx/resources/enterprises/dir/phone_numbers.rbs +11 -0
- data/sig/telnyx/resources/enterprises/dir.rbs +44 -0
- data/sig/telnyx/resources/enterprises/reputation/loa.rbs +24 -0
- data/sig/telnyx/resources/enterprises/reputation/numbers.rbs +9 -2
- data/sig/telnyx/resources/enterprises/reputation/remediation.rbs +36 -0
- data/sig/telnyx/resources/enterprises/reputation.rbs +4 -0
- data/sig/telnyx/resources/enterprises/usage.rbs +9 -0
- data/sig/telnyx/resources/enterprises.rbs +24 -12
- data/sig/telnyx/resources/infringement_claims.rbs +19 -0
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/reputation/numbers.rbs +4 -2
- data/sig/telnyx/resources/terms_of_service/agreements.rbs +21 -0
- data/sig/telnyx/resources/terms_of_service/branded_calling.rbs +13 -0
- data/sig/telnyx/resources/terms_of_service/number_reputation.rbs +3 -1
- data/sig/telnyx/resources/terms_of_service.rbs +14 -0
- data/sig/telnyx/resources/uac_connections.rbs +7 -7
- data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
- data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
- metadata +263 -92
- data/lib/telnyx/models/ai/assistant_integration.rb +0 -38
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +0 -35
- data/lib/telnyx/models/ai/assistants/clause.rb +0 -54
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +0 -27
- data/lib/telnyx/models/ai/assistants/rule_input.rb +0 -40
- data/lib/telnyx/models/ai/assistants/rule_output.rb +0 -40
- data/lib/telnyx/models/ai/assistants/serve.rb +0 -33
- data/lib/telnyx/models/ai/external_llm.rb +0 -89
- data/lib/telnyx/models/ai/external_llm_req.rb +0 -89
- data/lib/telnyx/models/ai/fallback_config.rb +0 -37
- data/lib/telnyx/models/ai/fallback_config_req.rb +0 -37
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +0 -47
- data/lib/telnyx/models/ai/post_conversation_settings.rb +0 -30
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +0 -30
- data/lib/telnyx/models/ai/start_speaking_plan.rb +0 -37
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +0 -39
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +0 -64
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +0 -108
- data/lib/telnyx/models/meta_info.rb +0 -40
- data/lib/telnyx/models/model_metadata.rb +0 -212
- data/lib/telnyx/models/public_internet_gateway_read.rb +0 -83
- data/lib/telnyx/models/reputation_phone_number_with_reputation_data.rb +0 -56
- data/lib/telnyx/models/uac_connection.rb +0 -412
- data/lib/telnyx/models/uac_external_settings.rb +0 -101
- data/lib/telnyx/models/uac_inbound.rb +0 -210
- data/lib/telnyx/models/uac_internal_settings.rb +0 -25
- data/lib/telnyx/models/uac_outbound.rb +0 -131
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +0 -212
- data/lib/telnyx/models/wireguard_interface_read.rb +0 -136
- data/lib/telnyx/models/xai_voice_settings.rb +0 -36
- data/rbi/telnyx/models/ai/assistant_integration.rbi +0 -60
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +0 -51
- data/rbi/telnyx/models/ai/assistants/clause.rbi +0 -91
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +0 -36
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +0 -73
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +0 -73
- data/rbi/telnyx/models/ai/assistants/serve.rbi +0 -61
- data/rbi/telnyx/models/ai/external_llm.rbi +0 -161
- data/rbi/telnyx/models/ai/external_llm_req.rbi +0 -161
- data/rbi/telnyx/models/ai/fallback_config.rbi +0 -64
- data/rbi/telnyx/models/ai/fallback_config_req.rbi +0 -64
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +0 -83
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +0 -45
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +0 -45
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +0 -70
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +0 -71
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +0 -155
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +0 -329
- data/rbi/telnyx/models/meta_info.rbi +0 -71
- data/rbi/telnyx/models/model_metadata.rbi +0 -272
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +0 -128
- data/rbi/telnyx/models/reputation_phone_number_with_reputation_data.rbi +0 -98
- data/rbi/telnyx/models/uac_connection.rbi +0 -684
- data/rbi/telnyx/models/uac_external_settings.rbi +0 -146
- data/rbi/telnyx/models/uac_inbound.rbi +0 -410
- data/rbi/telnyx/models/uac_internal_settings.rbi +0 -39
- data/rbi/telnyx/models/uac_outbound.rbi +0 -224
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +0 -345
- data/rbi/telnyx/models/wireguard_interface_read.rbi +0 -213
- data/rbi/telnyx/models/xai_voice_settings.rbi +0 -64
- data/sig/telnyx/models/ai/assistant_integration.rbs +0 -26
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +0 -19
- data/sig/telnyx/models/ai/assistants/clause.rbs +0 -46
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +0 -19
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +0 -33
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +0 -33
- data/sig/telnyx/models/ai/assistants/serve.rbs +0 -35
- data/sig/telnyx/models/ai/external_llm.rbs +0 -75
- data/sig/telnyx/models/ai/external_llm_req.rbs +0 -75
- data/sig/telnyx/models/ai/fallback_config.rbs +0 -38
- data/sig/telnyx/models/ai/fallback_config_req.rbs +0 -40
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +0 -40
- data/sig/telnyx/models/ai/post_conversation_settings.rbs +0 -17
- data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +0 -17
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +0 -33
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +0 -38
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +0 -62
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +0 -130
- data/sig/telnyx/models/meta_info.rbs +0 -43
- data/sig/telnyx/models/model_metadata.rbs +0 -142
- data/sig/telnyx/models/public_internet_gateway_read.rbs +0 -80
- data/sig/telnyx/models/reputation_phone_number_with_reputation_data.rbs +0 -57
- data/sig/telnyx/models/uac_connection.rbs +0 -338
- data/sig/telnyx/models/uac_external_settings.rbs +0 -73
- data/sig/telnyx/models/uac_inbound.rbs +0 -190
- data/sig/telnyx/models/uac_internal_settings.rbs +0 -15
- data/sig/telnyx/models/uac_outbound.rbs +0 -113
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +0 -190
- data/sig/telnyx/models/wireguard_interface_read.rbs +0 -127
- data/sig/telnyx/models/xai_voice_settings.rbs +0 -34
|
@@ -70,13 +70,13 @@ module Telnyx
|
|
|
70
70
|
|
|
71
71
|
# @!attribute external_llm
|
|
72
72
|
#
|
|
73
|
-
# @return [Telnyx::Models::AI::
|
|
74
|
-
optional :external_llm, -> { Telnyx::AI::
|
|
73
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm, nil]
|
|
74
|
+
optional :external_llm, -> { Telnyx::AI::AssistantCreateParams::ExternalLlm }
|
|
75
75
|
|
|
76
76
|
# @!attribute fallback_config
|
|
77
77
|
#
|
|
78
|
-
# @return [Telnyx::Models::AI::
|
|
79
|
-
optional :fallback_config, -> { Telnyx::AI::
|
|
78
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig, nil]
|
|
79
|
+
optional :fallback_config, -> { Telnyx::AI::AssistantCreateParams::FallbackConfig }
|
|
80
80
|
|
|
81
81
|
# @!attribute greeting
|
|
82
82
|
# Text that the assistant will use to start the conversation. This may be
|
|
@@ -100,8 +100,9 @@ module Telnyx
|
|
|
100
100
|
# `/ai/integrations/connections`. Each item references a catalog integration by
|
|
101
101
|
# `integration_id`.
|
|
102
102
|
#
|
|
103
|
-
# @return [Array<Telnyx::Models::AI::
|
|
104
|
-
optional :integrations,
|
|
103
|
+
# @return [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>, nil]
|
|
104
|
+
optional :integrations,
|
|
105
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::Integration] }
|
|
105
106
|
|
|
106
107
|
# @!attribute interruption_settings
|
|
107
108
|
# Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -111,8 +112,8 @@ module Telnyx
|
|
|
111
112
|
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
112
113
|
# `eager_eot_threshold`).
|
|
113
114
|
#
|
|
114
|
-
# @return [Telnyx::Models::AI::
|
|
115
|
-
optional :interruption_settings, -> { Telnyx::AI::
|
|
115
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings, nil]
|
|
116
|
+
optional :interruption_settings, -> { Telnyx::AI::AssistantCreateParams::InterruptionSettings }
|
|
116
117
|
|
|
117
118
|
# @!attribute llm_api_key_ref
|
|
118
119
|
# This is only needed when using third-party inference providers selected by
|
|
@@ -129,8 +130,9 @@ module Telnyx
|
|
|
129
130
|
# MCP servers attached to the assistant. Create MCP servers with
|
|
130
131
|
# `/ai/mcp_servers`, then reference them by `id` here.
|
|
131
132
|
#
|
|
132
|
-
# @return [Array<Telnyx::Models::AI::
|
|
133
|
-
optional :mcp_servers,
|
|
133
|
+
# @return [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>, nil]
|
|
134
|
+
optional :mcp_servers,
|
|
135
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::McpServer] }
|
|
134
136
|
|
|
135
137
|
# @!attribute messaging_settings
|
|
136
138
|
#
|
|
@@ -160,8 +162,8 @@ module Telnyx
|
|
|
160
162
|
# Telephony-control tools (e.g. hangup, transfer) are unavailable
|
|
161
163
|
# post-conversation. Beta feature.
|
|
162
164
|
#
|
|
163
|
-
# @return [Telnyx::Models::AI::
|
|
164
|
-
optional :post_conversation_settings, -> { Telnyx::AI::
|
|
165
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings, nil]
|
|
166
|
+
optional :post_conversation_settings, -> { Telnyx::AI::AssistantCreateParams::PostConversationSettings }
|
|
165
167
|
|
|
166
168
|
# @!attribute privacy_settings
|
|
167
169
|
#
|
|
@@ -231,21 +233,21 @@ module Telnyx
|
|
|
231
233
|
#
|
|
232
234
|
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
233
235
|
#
|
|
234
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
236
|
+
# @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
|
|
235
237
|
#
|
|
236
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
238
|
+
# @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
|
|
237
239
|
#
|
|
238
240
|
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
239
241
|
#
|
|
240
242
|
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
241
243
|
#
|
|
242
|
-
# @param integrations [Array<Telnyx::Models::AI::
|
|
244
|
+
# @param integrations [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>] Connected integrations attached to the assistant. The catalog of available integ
|
|
243
245
|
#
|
|
244
|
-
# @param interruption_settings [Telnyx::Models::AI::
|
|
246
|
+
# @param interruption_settings [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
|
|
245
247
|
#
|
|
246
248
|
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
|
|
247
249
|
#
|
|
248
|
-
# @param mcp_servers [Array<Telnyx::Models::AI::
|
|
250
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
|
|
249
251
|
#
|
|
250
252
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
251
253
|
#
|
|
@@ -253,7 +255,7 @@ module Telnyx
|
|
|
253
255
|
#
|
|
254
256
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
255
257
|
#
|
|
256
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
258
|
+
# @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
|
|
257
259
|
#
|
|
258
260
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
259
261
|
#
|
|
@@ -278,7 +280,7 @@ module Telnyx
|
|
|
278
280
|
# All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
|
|
279
281
|
# (`type: prompt`) or a tool node (`type: tool`).
|
|
280
282
|
#
|
|
281
|
-
# @return [Array<Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Tool>]
|
|
283
|
+
# @return [Array<Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Tool, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak>]
|
|
282
284
|
required :nodes,
|
|
283
285
|
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantCreateParams::ConversationFlow::Node] }
|
|
284
286
|
|
|
@@ -305,7 +307,7 @@ module Telnyx
|
|
|
305
307
|
# unique node/edge IDs, that `start_node_id` references a real node, and that
|
|
306
308
|
# every edge's endpoints reference real nodes.
|
|
307
309
|
#
|
|
308
|
-
# @param nodes [Array<Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Tool>] All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
|
|
310
|
+
# @param nodes [Array<Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Tool, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak>] All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
|
|
309
311
|
#
|
|
310
312
|
# @param start_node_id [String] ID of the node where the conversation begins.
|
|
311
313
|
#
|
|
@@ -334,6 +336,14 @@ module Telnyx
|
|
|
334
336
|
# on the result via outgoing `tool_result` edges.
|
|
335
337
|
variant :tool, -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Node::Tool }
|
|
336
338
|
|
|
339
|
+
# A standalone scripted-message step in a flow, as supplied by clients.
|
|
340
|
+
#
|
|
341
|
+
# Unlike a prompt node, a speak node has no instructions or model — it isn't
|
|
342
|
+
# an LLM turn. Reaching it delivers `message` to the user verbatim (with
|
|
343
|
+
# `{{variable}}` interpolation), then routes via outgoing `llm` /
|
|
344
|
+
# `expression` edges.
|
|
345
|
+
variant :speak, -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Node::Speak }
|
|
346
|
+
|
|
337
347
|
class Prompt < Telnyx::Internal::Type::BaseModel
|
|
338
348
|
# @!attribute id
|
|
339
349
|
# Caller-supplied unique identifier for this node within the flow.
|
|
@@ -353,8 +363,9 @@ module Telnyx
|
|
|
353
363
|
# credentials). Part of the LLM bundle — see `model` for cascade semantics.
|
|
354
364
|
# Mutually exclusive with `model` on the node (a single LLM identity per node).
|
|
355
365
|
#
|
|
356
|
-
# @return [Telnyx::Models::AI::
|
|
357
|
-
optional :external_llm,
|
|
366
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm, nil]
|
|
367
|
+
optional :external_llm,
|
|
368
|
+
-> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm }
|
|
358
369
|
|
|
359
370
|
# @!attribute instructions_mode
|
|
360
371
|
# How `instructions` combine with the assistant-level instructions. `replace`
|
|
@@ -448,7 +459,7 @@ module Telnyx
|
|
|
448
459
|
#
|
|
449
460
|
# @param instructions [String] Prompt that drives the LLM while this node is active. Required.
|
|
450
461
|
#
|
|
451
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
462
|
+
# @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm] Override for `Assistant.external_llm` while this node is active. Use this to rou
|
|
452
463
|
#
|
|
453
464
|
# @param instructions_mode [Symbol, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::InstructionsMode] How `instructions` combine with the assistant-level instructions. `replace` (def
|
|
454
465
|
#
|
|
@@ -470,6 +481,96 @@ module Telnyx
|
|
|
470
481
|
#
|
|
471
482
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings] Per-node voice override. Only fields set here override the assistant-level voice
|
|
472
483
|
|
|
484
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt#external_llm
|
|
485
|
+
class ExternalLlm < Telnyx::Internal::Type::BaseModel
|
|
486
|
+
# @!attribute base_url
|
|
487
|
+
# Base URL for the external LLM endpoint.
|
|
488
|
+
#
|
|
489
|
+
# @return [String]
|
|
490
|
+
required :base_url, String
|
|
491
|
+
|
|
492
|
+
# @!attribute model
|
|
493
|
+
# Model identifier to use with the external LLM endpoint.
|
|
494
|
+
#
|
|
495
|
+
# @return [String]
|
|
496
|
+
required :model, String
|
|
497
|
+
|
|
498
|
+
# @!attribute authentication_method
|
|
499
|
+
# Authentication method used when connecting to the external LLM endpoint.
|
|
500
|
+
#
|
|
501
|
+
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm::AuthenticationMethod, nil]
|
|
502
|
+
optional :authentication_method,
|
|
503
|
+
enum: -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm::AuthenticationMethod }
|
|
504
|
+
|
|
505
|
+
# @!attribute certificate_ref
|
|
506
|
+
# Integration secret identifier for the client certificate used with certificate
|
|
507
|
+
# authentication.
|
|
508
|
+
#
|
|
509
|
+
# @return [String, nil]
|
|
510
|
+
optional :certificate_ref, String
|
|
511
|
+
|
|
512
|
+
# @!attribute forward_metadata
|
|
513
|
+
# When `true`, Telnyx forwards the assistant's dynamic variables to the external
|
|
514
|
+
# LLM endpoint as a top-level `extra_metadata` object on the chat completion
|
|
515
|
+
# request body. Defaults to `false`. Example payload sent to the external
|
|
516
|
+
# endpoint:
|
|
517
|
+
# `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
|
|
518
|
+
# Distinct from OpenAI's native `metadata` field, which has its own size and type
|
|
519
|
+
# limits.
|
|
520
|
+
#
|
|
521
|
+
# @return [Boolean, nil]
|
|
522
|
+
optional :forward_metadata, Telnyx::Internal::Type::Boolean
|
|
523
|
+
|
|
524
|
+
# @!attribute llm_api_key_ref
|
|
525
|
+
# Integration secret identifier for the external LLM API key.
|
|
526
|
+
#
|
|
527
|
+
# @return [String, nil]
|
|
528
|
+
optional :llm_api_key_ref, String
|
|
529
|
+
|
|
530
|
+
# @!attribute token_retrieval_url
|
|
531
|
+
# URL used to retrieve an access token when certificate authentication is enabled.
|
|
532
|
+
#
|
|
533
|
+
# @return [String, nil]
|
|
534
|
+
optional :token_retrieval_url, String
|
|
535
|
+
|
|
536
|
+
# @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
|
|
537
|
+
# Some parameter documentations has been truncated, see
|
|
538
|
+
# {Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm}
|
|
539
|
+
# for more details.
|
|
540
|
+
#
|
|
541
|
+
# Override for `Assistant.external_llm` while this node is active. Use this to
|
|
542
|
+
# route a node's turns to a different external LLM (different `model`, `base_url`,
|
|
543
|
+
# credentials). Part of the LLM bundle — see `model` for cascade semantics.
|
|
544
|
+
# Mutually exclusive with `model` on the node (a single LLM identity per node).
|
|
545
|
+
#
|
|
546
|
+
# @param base_url [String] Base URL for the external LLM endpoint.
|
|
547
|
+
#
|
|
548
|
+
# @param model [String] Model identifier to use with the external LLM endpoint.
|
|
549
|
+
#
|
|
550
|
+
# @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
|
|
551
|
+
#
|
|
552
|
+
# @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
|
|
553
|
+
#
|
|
554
|
+
# @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
|
|
555
|
+
#
|
|
556
|
+
# @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
|
|
557
|
+
#
|
|
558
|
+
# @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
|
|
559
|
+
|
|
560
|
+
# Authentication method used when connecting to the external LLM endpoint.
|
|
561
|
+
#
|
|
562
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt::ExternalLlm#authentication_method
|
|
563
|
+
module AuthenticationMethod
|
|
564
|
+
extend Telnyx::Internal::Type::Enum
|
|
565
|
+
|
|
566
|
+
TOKEN = :token
|
|
567
|
+
CERTIFICATE = :certificate
|
|
568
|
+
|
|
569
|
+
# @!method self.values
|
|
570
|
+
# @return [Array<Symbol>]
|
|
571
|
+
end
|
|
572
|
+
end
|
|
573
|
+
|
|
473
574
|
# How `instructions` combine with the assistant-level instructions. `replace`
|
|
474
575
|
# (default): the node's instructions are used alone. `append`: the node's
|
|
475
576
|
# instructions are concatenated after the assistant's instructions.
|
|
@@ -635,8 +736,105 @@ module Telnyx
|
|
|
635
736
|
end
|
|
636
737
|
end
|
|
637
738
|
|
|
739
|
+
class Speak < Telnyx::Internal::Type::BaseModel
|
|
740
|
+
# @!attribute id
|
|
741
|
+
# Caller-supplied unique identifier for this node within the flow.
|
|
742
|
+
#
|
|
743
|
+
# @return [String]
|
|
744
|
+
required :id, String
|
|
745
|
+
|
|
746
|
+
# @!attribute message
|
|
747
|
+
# Message delivered to the user verbatim when the flow reaches this node. No LLM
|
|
748
|
+
# turn — the text is spoken/sent exactly as written. `{{variable}}` placeholders
|
|
749
|
+
# are interpolated from the conversation's dynamic variables; an unresolved
|
|
750
|
+
# placeholder renders as an empty string. After delivering, the flow routes via
|
|
751
|
+
# the node's outgoing `llm` / `expression` edges (commonly a single unconditional
|
|
752
|
+
# edge).
|
|
753
|
+
#
|
|
754
|
+
# @return [String]
|
|
755
|
+
required :message, String
|
|
756
|
+
|
|
757
|
+
# @!attribute name
|
|
758
|
+
# Optional human-readable label, displayed in authoring UIs.
|
|
759
|
+
#
|
|
760
|
+
# @return [String, nil]
|
|
761
|
+
optional :name, String
|
|
762
|
+
|
|
763
|
+
# @!attribute position
|
|
764
|
+
# Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
765
|
+
# by the runtime; round-trips so frontends can persist graph layout across
|
|
766
|
+
# reloads.
|
|
767
|
+
#
|
|
768
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak::Position, nil]
|
|
769
|
+
optional :position, -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Node::Speak::Position }
|
|
770
|
+
|
|
771
|
+
# @!attribute type
|
|
772
|
+
# Node kind discriminator. Always `speak` for a speak node.
|
|
773
|
+
#
|
|
774
|
+
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak::Type, nil]
|
|
775
|
+
optional :type, enum: -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Node::Speak::Type }
|
|
776
|
+
|
|
777
|
+
# @!method initialize(id:, message:, name: nil, position: nil, type: nil)
|
|
778
|
+
# Some parameter documentations has been truncated, see
|
|
779
|
+
# {Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak} for
|
|
780
|
+
# more details.
|
|
781
|
+
#
|
|
782
|
+
# A standalone scripted-message step in a flow, as supplied by clients.
|
|
783
|
+
#
|
|
784
|
+
# Unlike a prompt node, a speak node has no instructions or model — it isn't an
|
|
785
|
+
# LLM turn. Reaching it delivers `message` to the user verbatim (with
|
|
786
|
+
# `{{variable}}` interpolation), then routes via outgoing `llm` / `expression`
|
|
787
|
+
# edges.
|
|
788
|
+
#
|
|
789
|
+
# @param id [String] Caller-supplied unique identifier for this node within the flow.
|
|
790
|
+
#
|
|
791
|
+
# @param message [String] Message delivered to the user verbatim when the flow reaches this node. No LLM t
|
|
792
|
+
#
|
|
793
|
+
# @param name [String] Optional human-readable label, displayed in authoring UIs.
|
|
794
|
+
#
|
|
795
|
+
# @param position [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak::Position] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
796
|
+
#
|
|
797
|
+
# @param type [Symbol, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak::Type] Node kind discriminator. Always `speak` for a speak node.
|
|
798
|
+
|
|
799
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak#position
|
|
800
|
+
class Position < Telnyx::Internal::Type::BaseModel
|
|
801
|
+
# @!attribute x
|
|
802
|
+
# Horizontal coordinate in the authoring canvas.
|
|
803
|
+
#
|
|
804
|
+
# @return [Float]
|
|
805
|
+
required :x, Float
|
|
806
|
+
|
|
807
|
+
# @!attribute y_
|
|
808
|
+
# Vertical coordinate in the authoring canvas.
|
|
809
|
+
#
|
|
810
|
+
# @return [Float]
|
|
811
|
+
required :y_, Float, api_name: :y
|
|
812
|
+
|
|
813
|
+
# @!method initialize(x:, y_:)
|
|
814
|
+
# Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
815
|
+
# by the runtime; round-trips so frontends can persist graph layout across
|
|
816
|
+
# reloads.
|
|
817
|
+
#
|
|
818
|
+
# @param x [Float] Horizontal coordinate in the authoring canvas.
|
|
819
|
+
#
|
|
820
|
+
# @param y_ [Float] Vertical coordinate in the authoring canvas.
|
|
821
|
+
end
|
|
822
|
+
|
|
823
|
+
# Node kind discriminator. Always `speak` for a speak node.
|
|
824
|
+
#
|
|
825
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak#type
|
|
826
|
+
module Type
|
|
827
|
+
extend Telnyx::Internal::Type::Enum
|
|
828
|
+
|
|
829
|
+
SPEAK = :speak
|
|
830
|
+
|
|
831
|
+
# @!method self.values
|
|
832
|
+
# @return [Array<Symbol>]
|
|
833
|
+
end
|
|
834
|
+
end
|
|
835
|
+
|
|
638
836
|
# @!method self.variants
|
|
639
|
-
# @return [Array(Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Tool)]
|
|
837
|
+
# @return [Array(Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Prompt, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Tool, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Node::Speak)]
|
|
640
838
|
end
|
|
641
839
|
|
|
642
840
|
class Edge < Telnyx::Internal::Type::BaseModel
|
|
@@ -650,7 +848,7 @@ module Telnyx
|
|
|
650
848
|
# Condition that gates the transition. Discriminated by `type`: `llm`,
|
|
651
849
|
# `expression`.
|
|
652
850
|
#
|
|
653
|
-
# @return [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Llm, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression]
|
|
851
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Llm, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Default]
|
|
654
852
|
required :condition, union: -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Edge::Condition }
|
|
655
853
|
|
|
656
854
|
# @!attribute start_node_id
|
|
@@ -680,7 +878,7 @@ module Telnyx
|
|
|
680
878
|
#
|
|
681
879
|
# @param id [String] Caller-supplied unique identifier for this edge within the flow.
|
|
682
880
|
#
|
|
683
|
-
# @param condition [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Llm, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression] Condition that gates the transition. Discriminated by `type`: `llm`, `expression
|
|
881
|
+
# @param condition [Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Llm, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Default] Condition that gates the transition. Discriminated by `type`: `llm`, `expression
|
|
684
882
|
#
|
|
685
883
|
# @param start_node_id [String] ID of the node this edge transitions away from.
|
|
686
884
|
#
|
|
@@ -710,6 +908,17 @@ module Telnyx
|
|
|
710
908
|
variant :expression,
|
|
711
909
|
-> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression }
|
|
712
910
|
|
|
911
|
+
# Fallback edge condition: fires only when no other edge's condition is true.
|
|
912
|
+
#
|
|
913
|
+
# Evaluated after every conditioned (`llm` / `expression`) edge regardless
|
|
914
|
+
# of declaration order, so it routes the flow whenever none of the node's
|
|
915
|
+
# other outgoing edges match. Valid **only** on edges leaving a `tool` or
|
|
916
|
+
# `speak` node, where the deterministic step auto-advances and must always
|
|
917
|
+
# have somewhere to go. A tool/speak node with any outgoing edge is required
|
|
918
|
+
# to carry exactly one `default` edge so it never dead-ends; a tool/speak
|
|
919
|
+
# node with no outgoing edges is a valid terminal step. Carries no parameters.
|
|
920
|
+
variant :default, -> { Telnyx::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Default }
|
|
921
|
+
|
|
713
922
|
class Llm < Telnyx::Internal::Type::BaseModel
|
|
714
923
|
# @!attribute prompt
|
|
715
924
|
# Natural-language criterion the LLM judges as true/false.
|
|
@@ -885,8 +1094,28 @@ module Telnyx
|
|
|
885
1094
|
end
|
|
886
1095
|
end
|
|
887
1096
|
|
|
1097
|
+
class Default < Telnyx::Internal::Type::BaseModel
|
|
1098
|
+
# @!attribute type
|
|
1099
|
+
#
|
|
1100
|
+
# @return [Symbol, :default]
|
|
1101
|
+
required :type, const: :default
|
|
1102
|
+
|
|
1103
|
+
# @!method initialize(type: :default)
|
|
1104
|
+
# Fallback edge condition: fires only when no other edge's condition is true.
|
|
1105
|
+
#
|
|
1106
|
+
# Evaluated after every conditioned (`llm` / `expression`) edge regardless of
|
|
1107
|
+
# declaration order, so it routes the flow whenever none of the node's other
|
|
1108
|
+
# outgoing edges match. Valid **only** on edges leaving a `tool` or `speak` node,
|
|
1109
|
+
# where the deterministic step auto-advances and must always have somewhere to go.
|
|
1110
|
+
# A tool/speak node with any outgoing edge is required to carry exactly one
|
|
1111
|
+
# `default` edge so it never dead-ends; a tool/speak node with no outgoing edges
|
|
1112
|
+
# is a valid terminal step. Carries no parameters.
|
|
1113
|
+
#
|
|
1114
|
+
# @param type [Symbol, :default]
|
|
1115
|
+
end
|
|
1116
|
+
|
|
888
1117
|
# @!method self.variants
|
|
889
|
-
# @return [Array(Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Llm, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression)]
|
|
1118
|
+
# @return [Array(Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Llm, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Expression, Telnyx::Models::AI::AssistantCreateParams::ConversationFlow::Edge::Condition::Default)]
|
|
890
1119
|
end
|
|
891
1120
|
|
|
892
1121
|
# Destination of the transition. Discriminated by `type`: `node` (jump to another
|
|
@@ -1039,6 +1268,395 @@ module Telnyx
|
|
|
1039
1268
|
end
|
|
1040
1269
|
end
|
|
1041
1270
|
end
|
|
1271
|
+
|
|
1272
|
+
class ExternalLlm < Telnyx::Internal::Type::BaseModel
|
|
1273
|
+
# @!attribute base_url
|
|
1274
|
+
# Base URL for the external LLM endpoint.
|
|
1275
|
+
#
|
|
1276
|
+
# @return [String]
|
|
1277
|
+
required :base_url, String
|
|
1278
|
+
|
|
1279
|
+
# @!attribute model
|
|
1280
|
+
# Model identifier to use with the external LLM endpoint.
|
|
1281
|
+
#
|
|
1282
|
+
# @return [String]
|
|
1283
|
+
required :model, String
|
|
1284
|
+
|
|
1285
|
+
# @!attribute authentication_method
|
|
1286
|
+
# Authentication method used when connecting to the external LLM endpoint.
|
|
1287
|
+
#
|
|
1288
|
+
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod, nil]
|
|
1289
|
+
optional :authentication_method,
|
|
1290
|
+
enum: -> { Telnyx::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod }
|
|
1291
|
+
|
|
1292
|
+
# @!attribute certificate_ref
|
|
1293
|
+
# Integration secret identifier for the client certificate used with certificate
|
|
1294
|
+
# authentication.
|
|
1295
|
+
#
|
|
1296
|
+
# @return [String, nil]
|
|
1297
|
+
optional :certificate_ref, String
|
|
1298
|
+
|
|
1299
|
+
# @!attribute forward_metadata
|
|
1300
|
+
# When `true`, Telnyx forwards the assistant's dynamic variables to the external
|
|
1301
|
+
# LLM endpoint as a top-level `extra_metadata` object on the chat completion
|
|
1302
|
+
# request body. Defaults to `false`. Example payload sent to the external
|
|
1303
|
+
# endpoint:
|
|
1304
|
+
# `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
|
|
1305
|
+
# Distinct from OpenAI's native `metadata` field, which has its own size and type
|
|
1306
|
+
# limits.
|
|
1307
|
+
#
|
|
1308
|
+
# @return [Boolean, nil]
|
|
1309
|
+
optional :forward_metadata, Telnyx::Internal::Type::Boolean
|
|
1310
|
+
|
|
1311
|
+
# @!attribute llm_api_key_ref
|
|
1312
|
+
# Integration secret identifier for the external LLM API key.
|
|
1313
|
+
#
|
|
1314
|
+
# @return [String, nil]
|
|
1315
|
+
optional :llm_api_key_ref, String
|
|
1316
|
+
|
|
1317
|
+
# @!attribute token_retrieval_url
|
|
1318
|
+
# URL used to retrieve an access token when certificate authentication is enabled.
|
|
1319
|
+
#
|
|
1320
|
+
# @return [String, nil]
|
|
1321
|
+
optional :token_retrieval_url, String
|
|
1322
|
+
|
|
1323
|
+
# @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
|
|
1324
|
+
# Some parameter documentations has been truncated, see
|
|
1325
|
+
# {Telnyx::Models::AI::AssistantCreateParams::ExternalLlm} for more details.
|
|
1326
|
+
#
|
|
1327
|
+
# @param base_url [String] Base URL for the external LLM endpoint.
|
|
1328
|
+
#
|
|
1329
|
+
# @param model [String] Model identifier to use with the external LLM endpoint.
|
|
1330
|
+
#
|
|
1331
|
+
# @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
|
|
1332
|
+
#
|
|
1333
|
+
# @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
|
|
1334
|
+
#
|
|
1335
|
+
# @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
|
|
1336
|
+
#
|
|
1337
|
+
# @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
|
|
1338
|
+
#
|
|
1339
|
+
# @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
|
|
1340
|
+
|
|
1341
|
+
# Authentication method used when connecting to the external LLM endpoint.
|
|
1342
|
+
#
|
|
1343
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::ExternalLlm#authentication_method
|
|
1344
|
+
module AuthenticationMethod
|
|
1345
|
+
extend Telnyx::Internal::Type::Enum
|
|
1346
|
+
|
|
1347
|
+
TOKEN = :token
|
|
1348
|
+
CERTIFICATE = :certificate
|
|
1349
|
+
|
|
1350
|
+
# @!method self.values
|
|
1351
|
+
# @return [Array<Symbol>]
|
|
1352
|
+
end
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1355
|
+
class FallbackConfig < Telnyx::Internal::Type::BaseModel
|
|
1356
|
+
# @!attribute external_llm
|
|
1357
|
+
#
|
|
1358
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm, nil]
|
|
1359
|
+
optional :external_llm, -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm }
|
|
1360
|
+
|
|
1361
|
+
# @!attribute llm_api_key_ref
|
|
1362
|
+
# Integration secret identifier for the fallback model API key.
|
|
1363
|
+
#
|
|
1364
|
+
# @return [String, nil]
|
|
1365
|
+
optional :llm_api_key_ref, String
|
|
1366
|
+
|
|
1367
|
+
# @!attribute model
|
|
1368
|
+
# Fallback Telnyx-hosted model to use when the primary LLM provider is
|
|
1369
|
+
# unavailable.
|
|
1370
|
+
#
|
|
1371
|
+
# @return [String, nil]
|
|
1372
|
+
optional :model, String
|
|
1373
|
+
|
|
1374
|
+
# @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
|
|
1375
|
+
# Some parameter documentations has been truncated, see
|
|
1376
|
+
# {Telnyx::Models::AI::AssistantCreateParams::FallbackConfig} for more details.
|
|
1377
|
+
#
|
|
1378
|
+
# @param external_llm [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm]
|
|
1379
|
+
#
|
|
1380
|
+
# @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
|
|
1381
|
+
#
|
|
1382
|
+
# @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
|
|
1383
|
+
|
|
1384
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::FallbackConfig#external_llm
|
|
1385
|
+
class ExternalLlm < Telnyx::Internal::Type::BaseModel
|
|
1386
|
+
# @!attribute base_url
|
|
1387
|
+
# Base URL for the external LLM endpoint.
|
|
1388
|
+
#
|
|
1389
|
+
# @return [String]
|
|
1390
|
+
required :base_url, String
|
|
1391
|
+
|
|
1392
|
+
# @!attribute model
|
|
1393
|
+
# Model identifier to use with the external LLM endpoint.
|
|
1394
|
+
#
|
|
1395
|
+
# @return [String]
|
|
1396
|
+
required :model, String
|
|
1397
|
+
|
|
1398
|
+
# @!attribute authentication_method
|
|
1399
|
+
# Authentication method used when connecting to the external LLM endpoint.
|
|
1400
|
+
#
|
|
1401
|
+
# @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
|
|
1402
|
+
optional :authentication_method,
|
|
1403
|
+
enum: -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod }
|
|
1404
|
+
|
|
1405
|
+
# @!attribute certificate_ref
|
|
1406
|
+
# Integration secret identifier for the client certificate used with certificate
|
|
1407
|
+
# authentication.
|
|
1408
|
+
#
|
|
1409
|
+
# @return [String, nil]
|
|
1410
|
+
optional :certificate_ref, String
|
|
1411
|
+
|
|
1412
|
+
# @!attribute forward_metadata
|
|
1413
|
+
# When `true`, Telnyx forwards the assistant's dynamic variables to the external
|
|
1414
|
+
# LLM endpoint as a top-level `extra_metadata` object on the chat completion
|
|
1415
|
+
# request body. Defaults to `false`. Example payload sent to the external
|
|
1416
|
+
# endpoint:
|
|
1417
|
+
# `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
|
|
1418
|
+
# Distinct from OpenAI's native `metadata` field, which has its own size and type
|
|
1419
|
+
# limits.
|
|
1420
|
+
#
|
|
1421
|
+
# @return [Boolean, nil]
|
|
1422
|
+
optional :forward_metadata, Telnyx::Internal::Type::Boolean
|
|
1423
|
+
|
|
1424
|
+
# @!attribute llm_api_key_ref
|
|
1425
|
+
# Integration secret identifier for the external LLM API key.
|
|
1426
|
+
#
|
|
1427
|
+
# @return [String, nil]
|
|
1428
|
+
optional :llm_api_key_ref, String
|
|
1429
|
+
|
|
1430
|
+
# @!attribute token_retrieval_url
|
|
1431
|
+
# URL used to retrieve an access token when certificate authentication is enabled.
|
|
1432
|
+
#
|
|
1433
|
+
# @return [String, nil]
|
|
1434
|
+
optional :token_retrieval_url, String
|
|
1435
|
+
|
|
1436
|
+
# @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
|
|
1437
|
+
# Some parameter documentations has been truncated, see
|
|
1438
|
+
# {Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm} for
|
|
1439
|
+
# more details.
|
|
1440
|
+
#
|
|
1441
|
+
# @param base_url [String] Base URL for the external LLM endpoint.
|
|
1442
|
+
#
|
|
1443
|
+
# @param model [String] Model identifier to use with the external LLM endpoint.
|
|
1444
|
+
#
|
|
1445
|
+
# @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
|
|
1446
|
+
#
|
|
1447
|
+
# @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
|
|
1448
|
+
#
|
|
1449
|
+
# @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
|
|
1450
|
+
#
|
|
1451
|
+
# @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
|
|
1452
|
+
#
|
|
1453
|
+
# @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
|
|
1454
|
+
|
|
1455
|
+
# Authentication method used when connecting to the external LLM endpoint.
|
|
1456
|
+
#
|
|
1457
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm#authentication_method
|
|
1458
|
+
module AuthenticationMethod
|
|
1459
|
+
extend Telnyx::Internal::Type::Enum
|
|
1460
|
+
|
|
1461
|
+
TOKEN = :token
|
|
1462
|
+
CERTIFICATE = :certificate
|
|
1463
|
+
|
|
1464
|
+
# @!method self.values
|
|
1465
|
+
# @return [Array<Symbol>]
|
|
1466
|
+
end
|
|
1467
|
+
end
|
|
1468
|
+
end
|
|
1469
|
+
|
|
1470
|
+
class Integration < Telnyx::Internal::Type::BaseModel
|
|
1471
|
+
# @!attribute integration_id
|
|
1472
|
+
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
1473
|
+
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
1474
|
+
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
1475
|
+
# connection-level `id` from `/ai/integrations/connections`.
|
|
1476
|
+
#
|
|
1477
|
+
# @return [String]
|
|
1478
|
+
required :integration_id, String
|
|
1479
|
+
|
|
1480
|
+
# @!attribute allowed_list
|
|
1481
|
+
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
1482
|
+
# empty, all tools allowed by the connected integration are available to the
|
|
1483
|
+
# assistant.
|
|
1484
|
+
#
|
|
1485
|
+
# @return [Array<String>, nil]
|
|
1486
|
+
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
1487
|
+
|
|
1488
|
+
# @!method initialize(integration_id:, allowed_list: nil)
|
|
1489
|
+
# Some parameter documentations has been truncated, see
|
|
1490
|
+
# {Telnyx::Models::AI::AssistantCreateParams::Integration} for more details.
|
|
1491
|
+
#
|
|
1492
|
+
# Reference to a connected integration attached to an assistant. Discover
|
|
1493
|
+
# available integrations with `/ai/integrations` and connected integrations with
|
|
1494
|
+
# `/ai/integrations/connections`.
|
|
1495
|
+
#
|
|
1496
|
+
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
1497
|
+
#
|
|
1498
|
+
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
1499
|
+
end
|
|
1500
|
+
|
|
1501
|
+
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
1502
|
+
# @!attribute disable_greeting_interruption
|
|
1503
|
+
# When true, disables user interruptions while the assistant greeting is playing.
|
|
1504
|
+
#
|
|
1505
|
+
# @return [Boolean, nil]
|
|
1506
|
+
optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
|
|
1507
|
+
|
|
1508
|
+
# @!attribute enable
|
|
1509
|
+
# Whether users can interrupt the assistant while it is speaking.
|
|
1510
|
+
#
|
|
1511
|
+
# @return [Boolean, nil]
|
|
1512
|
+
optional :enable, Telnyx::Internal::Type::Boolean
|
|
1513
|
+
|
|
1514
|
+
# @!attribute start_speaking_plan
|
|
1515
|
+
# Controls when the assistant starts speaking after the user stops. These
|
|
1516
|
+
# thresholds primarily apply to non turn-taking transcription models. For
|
|
1517
|
+
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1518
|
+
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
1519
|
+
#
|
|
1520
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan, nil]
|
|
1521
|
+
optional :start_speaking_plan,
|
|
1522
|
+
-> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan }
|
|
1523
|
+
|
|
1524
|
+
# @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
|
|
1525
|
+
# Some parameter documentations has been truncated, see
|
|
1526
|
+
# {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings} for more
|
|
1527
|
+
# details.
|
|
1528
|
+
#
|
|
1529
|
+
# Settings for interruptions and how the assistant decides the user has finished
|
|
1530
|
+
# speaking. These timings are most relevant when using non turn-taking
|
|
1531
|
+
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
1532
|
+
# behavior is controlled by the transcription end-of-turn settings under
|
|
1533
|
+
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
1534
|
+
# `eager_eot_threshold`).
|
|
1535
|
+
#
|
|
1536
|
+
# @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
|
|
1537
|
+
#
|
|
1538
|
+
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
1539
|
+
#
|
|
1540
|
+
# @param start_speaking_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
1541
|
+
|
|
1542
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings#start_speaking_plan
|
|
1543
|
+
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
1544
|
+
# @!attribute transcription_endpointing_plan
|
|
1545
|
+
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
1546
|
+
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1547
|
+
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1548
|
+
# `eager_eot_threshold`.
|
|
1549
|
+
#
|
|
1550
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
|
|
1551
|
+
optional :transcription_endpointing_plan,
|
|
1552
|
+
-> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
|
|
1553
|
+
|
|
1554
|
+
# @!attribute wait_seconds
|
|
1555
|
+
# Minimum seconds to wait before the assistant starts speaking.
|
|
1556
|
+
#
|
|
1557
|
+
# @return [Float, nil]
|
|
1558
|
+
optional :wait_seconds, Float
|
|
1559
|
+
|
|
1560
|
+
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
1561
|
+
# Some parameter documentations has been truncated, see
|
|
1562
|
+
# {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan}
|
|
1563
|
+
# for more details.
|
|
1564
|
+
#
|
|
1565
|
+
# Controls when the assistant starts speaking after the user stops. These
|
|
1566
|
+
# thresholds primarily apply to non turn-taking transcription models. For
|
|
1567
|
+
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
1568
|
+
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
1569
|
+
#
|
|
1570
|
+
# @param transcription_endpointing_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
1571
|
+
#
|
|
1572
|
+
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
1573
|
+
|
|
1574
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
|
|
1575
|
+
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
1576
|
+
# @!attribute on_no_punctuation_seconds
|
|
1577
|
+
# Seconds to wait after the transcript ends without punctuation.
|
|
1578
|
+
#
|
|
1579
|
+
# @return [Float, nil]
|
|
1580
|
+
optional :on_no_punctuation_seconds, Float
|
|
1581
|
+
|
|
1582
|
+
# @!attribute on_number_seconds
|
|
1583
|
+
# Seconds to wait after the transcript ends with a number.
|
|
1584
|
+
#
|
|
1585
|
+
# @return [Float, nil]
|
|
1586
|
+
optional :on_number_seconds, Float
|
|
1587
|
+
|
|
1588
|
+
# @!attribute on_punctuation_seconds
|
|
1589
|
+
# Seconds to wait after the transcript ends with punctuation.
|
|
1590
|
+
#
|
|
1591
|
+
# @return [Float, nil]
|
|
1592
|
+
optional :on_punctuation_seconds, Float
|
|
1593
|
+
|
|
1594
|
+
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
1595
|
+
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
1596
|
+
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
1597
|
+
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
1598
|
+
# `eager_eot_threshold`.
|
|
1599
|
+
#
|
|
1600
|
+
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
1601
|
+
#
|
|
1602
|
+
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
1603
|
+
#
|
|
1604
|
+
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
1605
|
+
end
|
|
1606
|
+
end
|
|
1607
|
+
end
|
|
1608
|
+
|
|
1609
|
+
class McpServer < Telnyx::Internal::Type::BaseModel
|
|
1610
|
+
# @!attribute id
|
|
1611
|
+
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
1612
|
+
# by the `/ai/mcp_servers` endpoints.
|
|
1613
|
+
#
|
|
1614
|
+
# @return [String]
|
|
1615
|
+
required :id, String
|
|
1616
|
+
|
|
1617
|
+
# @!attribute allowed_tools
|
|
1618
|
+
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
1619
|
+
# uses the MCP server's configured `allowed_tools`.
|
|
1620
|
+
#
|
|
1621
|
+
# @return [Array<String>, nil]
|
|
1622
|
+
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
1623
|
+
|
|
1624
|
+
# @!method initialize(id:, allowed_tools: nil)
|
|
1625
|
+
# Some parameter documentations has been truncated, see
|
|
1626
|
+
# {Telnyx::Models::AI::AssistantCreateParams::McpServer} for more details.
|
|
1627
|
+
#
|
|
1628
|
+
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
1629
|
+
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
1630
|
+
# ID.
|
|
1631
|
+
#
|
|
1632
|
+
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
1633
|
+
#
|
|
1634
|
+
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
1635
|
+
end
|
|
1636
|
+
|
|
1637
|
+
class PostConversationSettings < Telnyx::Internal::Type::BaseModel
|
|
1638
|
+
# @!attribute enabled
|
|
1639
|
+
# Whether post-conversation processing is enabled. When true, the assistant will
|
|
1640
|
+
# be invoked after the conversation ends to perform any final tool calls. Defaults
|
|
1641
|
+
# to false.
|
|
1642
|
+
#
|
|
1643
|
+
# @return [Boolean, nil]
|
|
1644
|
+
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
1645
|
+
|
|
1646
|
+
# @!method initialize(enabled: nil)
|
|
1647
|
+
# Some parameter documentations has been truncated, see
|
|
1648
|
+
# {Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings} for more
|
|
1649
|
+
# details.
|
|
1650
|
+
#
|
|
1651
|
+
# Configuration for post-conversation processing. When enabled, the assistant
|
|
1652
|
+
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
1653
|
+
# execute tool calls such as logging to a CRM or sending a summary. The assistant
|
|
1654
|
+
# can execute multiple parallel or sequential tools during this phase.
|
|
1655
|
+
# Telephony-control tools (e.g. hangup, transfer) are unavailable
|
|
1656
|
+
# post-conversation. Beta feature.
|
|
1657
|
+
#
|
|
1658
|
+
# @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
|
|
1659
|
+
end
|
|
1042
1660
|
end
|
|
1043
1661
|
end
|
|
1044
1662
|
end
|