telnyx 5.167.0 → 5.169.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +44 -0
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_a2_a_agent.rb +195 -0
- data/lib/telnyx/models/ai/assistant_create_params.rb +22 -7
- data/lib/telnyx/models/ai/assistant_tool.rb +285 -12
- data/lib/telnyx/models/ai/assistant_update_params.rb +37 -10
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +37 -10
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +128 -74
- data/lib/telnyx/models/ai/flow_node.rb +2 -2
- data/lib/telnyx/models/ai/inference_embedding.rb +29 -11
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +21 -1
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +101 -17
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +268 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +222 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/func_retrieve_logs_params.rb +66 -0
- data/lib/telnyx/models/compute/func_retrieve_logs_response.rb +161 -0
- data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_params.rb +69 -0
- data/lib/telnyx/models/compute/func_retrieve_metric_aggregates_response.rb +137 -0
- data/lib/telnyx/models/compute/func_retrieve_revisions_params.rb +34 -0
- data/lib/telnyx/models/compute/func_retrieve_revisions_response.rb +101 -0
- data/lib/telnyx/models/compute/func_retrieve_ship_inspection_params.rb +22 -0
- data/lib/telnyx/models/compute/func_retrieve_ship_inspection_response.rb +94 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/compute/functions_observability_pagination_meta.rb +35 -0
- data/lib/telnyx/models/compute/logs_meta.rb +23 -0
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/credential_connection.rb +4 -1
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/email_inboxes/email_message.rb +12 -1
- data/lib/telnyx/models/email_message_batch_params.rb +4 -1
- data/lib/telnyx/models/email_message_batch_response.rb +1 -0
- data/lib/telnyx/models/fqdn_connection.rb +5 -2
- data/lib/telnyx/models/fqdn_connections/fqdn_authentication.rb +9 -2
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +412 -66
- data/lib/telnyx/models/messaging_messaging_profile.rb +11 -1
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
- data/lib/telnyx/models/messaging_profile_features.rb +26 -0
- data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/uac_connection.rb +4 -1
- data/lib/telnyx/models/uac_external_settings.rb +6 -2
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rb +104 -1
- data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +103 -1
- data/lib/telnyx/models/whatsapp/phone_number_list_response.rb +103 -1
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rb +22 -0
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rb +207 -0
- data/lib/telnyx/models/whatsapp_account_update.rb +112 -0
- data/lib/telnyx/models/whatsapp_message_echo.rb +340 -0
- data/lib/telnyx/models/x402/credit_account/payment_list_params.rb +34 -0
- data/lib/telnyx/models/x402/credit_account/payment_retrieve_params.rb +24 -0
- data/lib/telnyx/models/x402/credit_account/payment_retrieve_response.rb +21 -0
- data/lib/telnyx/models/x402/credit_account/x402_transaction_record.rb +113 -0
- data/lib/telnyx/models.rb +26 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +4 -2
- data/lib/telnyx/resources/ai/assistants.rb +8 -4
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/openai/chat.rb +2 -8
- data/lib/telnyx/resources/ai/typesafe/v1.rb +62 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +4 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +145 -0
- data/lib/telnyx/resources/compute.rb +18 -0
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_messages.rb +6 -2
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/messaging_profiles.rb +6 -2
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/resources/whatsapp/phone_numbers.rb +22 -0
- data/lib/telnyx/resources/x402/credit_account/payments.rb +71 -0
- data/lib/telnyx/resources/x402/credit_account.rb +8 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +56 -0
- data/rbi/telnyx/client.rbi +38 -0
- data/rbi/telnyx/models/ai/assistant_a2_a_agent.rbi +345 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +45 -12
- data/rbi/telnyx/models/ai/assistant_tool.rbi +423 -20
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +73 -16
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +73 -16
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +228 -150
- data/rbi/telnyx/models/ai/flow_node.rbi +4 -2
- data/rbi/telnyx/models/ai/inference_embedding.rbi +53 -16
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +29 -3
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +197 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +504 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +348 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/func_retrieve_logs_params.rbi +130 -0
- data/rbi/telnyx/models/compute/func_retrieve_logs_response.rbi +410 -0
- data/rbi/telnyx/models/compute/func_retrieve_metric_aggregates_params.rbi +102 -0
- data/rbi/telnyx/models/compute/func_retrieve_metric_aggregates_response.rbi +231 -0
- data/rbi/telnyx/models/compute/func_retrieve_revisions_params.rbi +59 -0
- data/rbi/telnyx/models/compute/func_retrieve_revisions_response.rbi +213 -0
- data/rbi/telnyx/models/compute/func_retrieve_ship_inspection_params.rbi +40 -0
- data/rbi/telnyx/models/compute/func_retrieve_ship_inspection_response.rbi +252 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/compute/functions_observability_pagination_meta.rbi +70 -0
- data/rbi/telnyx/models/compute/logs_meta.rbi +38 -0
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/credential_connection.rbi +8 -2
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +22 -3
- data/rbi/telnyx/models/email_message_batch_params.rbi +6 -0
- data/rbi/telnyx/models/email_message_batch_response.rbi +5 -0
- data/rbi/telnyx/models/fqdn_connection.rbi +8 -2
- data/rbi/telnyx/models/fqdn_connections/fqdn_authentication.rbi +8 -2
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +911 -192
- data/rbi/telnyx/models/messaging_messaging_profile.rbi +19 -0
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +19 -0
- data/rbi/telnyx/models/messaging_profile_features.rbi +43 -0
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +19 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/uac_connection.rbi +8 -2
- data/rbi/telnyx/models/uac_external_settings.rbi +10 -2
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +3 -1
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +3 -1
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi +213 -0
- data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +213 -0
- data/rbi/telnyx/models/whatsapp/phone_number_list_response.rbi +213 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rbi +40 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbi +401 -0
- data/rbi/telnyx/models/whatsapp_account_update.rbi +236 -0
- data/rbi/telnyx/models/whatsapp_message_echo.rbi +611 -0
- data/rbi/telnyx/models/x402/credit_account/payment_list_params.rbi +64 -0
- data/rbi/telnyx/models/x402/credit_account/payment_retrieve_params.rbi +42 -0
- data/rbi/telnyx/models/x402/credit_account/payment_retrieve_response.rbi +53 -0
- data/rbi/telnyx/models/x402/credit_account/x402_transaction_record.rbi +219 -0
- data/rbi/telnyx/models.rbi +29 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +31 -7
- data/rbi/telnyx/resources/ai/assistants.rbi +46 -12
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/openai/chat.rbi +9 -13
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +61 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +3 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +6 -5
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +114 -0
- data/rbi/telnyx/resources/compute.rbi +15 -0
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_messages.rbi +8 -2
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/rbi/telnyx/resources/webhooks.rbi +6 -2
- data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +18 -0
- data/rbi/telnyx/resources/x402/credit_account/payments.rbi +60 -0
- data/rbi/telnyx/resources/x402/credit_account.rbi +5 -0
- data/sig/telnyx/client.rbs +12 -0
- data/sig/telnyx/models/ai/assistant_a2_a_agent.rbs +140 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +9 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +162 -23
- data/sig/telnyx/models/ai/assistant_update_params.rbs +9 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +9 -0
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +90 -79
- data/sig/telnyx/models/ai/inference_embedding.rbs +9 -0
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +10 -3
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +59 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +195 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +141 -0
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/func_retrieve_logs_params.rbs +69 -0
- data/sig/telnyx/models/compute/func_retrieve_logs_response.rbs +210 -0
- data/sig/telnyx/models/compute/func_retrieve_metric_aggregates_params.rbs +66 -0
- data/sig/telnyx/models/compute/func_retrieve_metric_aggregates_response.rbs +149 -0
- data/sig/telnyx/models/compute/func_retrieve_revisions_params.rbs +38 -0
- data/sig/telnyx/models/compute/func_retrieve_revisions_response.rbs +131 -0
- data/sig/telnyx/models/compute/func_retrieve_ship_inspection_params.rbs +22 -0
- data/sig/telnyx/models/compute/func_retrieve_ship_inspection_response.rbs +117 -0
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/compute/functions_observability_pagination_meta.rbs +45 -0
- data/sig/telnyx/models/compute/logs_meta.rbs +21 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +12 -3
- data/sig/telnyx/models/email_message_batch_response.rbs +2 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +438 -97
- data/sig/telnyx/models/messaging_messaging_profile.rbs +5 -0
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/messaging_profile_create_params.rbs +5 -0
- data/sig/telnyx/models/messaging_profile_features.rbs +15 -0
- data/sig/telnyx/models/messaging_profile_update_params.rbs +5 -0
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbs +90 -0
- data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +90 -0
- data/sig/telnyx/models/whatsapp/phone_number_list_response.rbs +90 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_params.rbs +25 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbs +201 -0
- data/sig/telnyx/models/whatsapp_account_update.rbs +107 -0
- data/sig/telnyx/models/whatsapp_message_echo.rbs +291 -0
- data/sig/telnyx/models/x402/credit_account/payment_list_params.rbs +36 -0
- data/sig/telnyx/models/x402/credit_account/payment_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/x402/credit_account/payment_retrieve_response.rbs +26 -0
- data/sig/telnyx/models/x402/credit_account/x402_transaction_record.rbs +104 -0
- data/sig/telnyx/models.rbs +26 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +2 -0
- data/sig/telnyx/resources/ai/openai/chat.rbs +1 -4
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +17 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +2 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +43 -0
- data/sig/telnyx/resources/compute.rbs +9 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- data/sig/telnyx/resources/webhooks.rbs +6 -2
- data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +5 -0
- data/sig/telnyx/resources/x402/credit_account/payments.rbs +22 -0
- data/sig/telnyx/resources/x402/credit_account.rbs +2 -0
- metadata +170 -2
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Typesafe
|
|
7
|
+
# @see Telnyx::Resources::AI::Typesafe::V1#systemone
|
|
8
|
+
class V1SystemoneParams < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute questions
|
|
13
|
+
# Between 1 and 64 named questions. Each key identifies the corresponding answer.
|
|
14
|
+
#
|
|
15
|
+
# @return [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score}]
|
|
16
|
+
required :questions,
|
|
17
|
+
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::AI::Typesafe::V1SystemoneParams::Question] }
|
|
18
|
+
|
|
19
|
+
# @!attribute state
|
|
20
|
+
# Shared context evaluated by every question.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
23
|
+
required :state, union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::State }
|
|
24
|
+
|
|
25
|
+
# @!method initialize(questions:, state:, request_options: {})
|
|
26
|
+
# @param questions [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score}] Between 1 and 64 named questions. Each key identifies the corresponding answer.
|
|
27
|
+
#
|
|
28
|
+
# @param state [String, Hash{Symbol=>Object}, Array<Object>] Shared context evaluated by every question.
|
|
29
|
+
#
|
|
30
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
31
|
+
|
|
32
|
+
# A choice, yes/no, or ordered-score question.
|
|
33
|
+
module Question
|
|
34
|
+
extend Telnyx::Internal::Type::Union
|
|
35
|
+
|
|
36
|
+
discriminator :type
|
|
37
|
+
|
|
38
|
+
# Select one of the supplied options.
|
|
39
|
+
variant :choice, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice }
|
|
40
|
+
|
|
41
|
+
# Evaluate a yes/no question. Omit criteria to use Yes and No descriptions.
|
|
42
|
+
variant :noul, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul }
|
|
43
|
+
|
|
44
|
+
# Rate the state against an ordered rubric.
|
|
45
|
+
variant :score, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score }
|
|
46
|
+
|
|
47
|
+
class Choice < Telnyx::Internal::Type::BaseModel
|
|
48
|
+
# @!attribute criteria
|
|
49
|
+
# Between 2 and 64 option keys mapped to description strings or null. A null
|
|
50
|
+
# description uses the option key as its text.
|
|
51
|
+
#
|
|
52
|
+
# @return [Hash{Symbol=>String, nil}]
|
|
53
|
+
required :criteria, Telnyx::Internal::Type::HashOf[String, nil?: true]
|
|
54
|
+
|
|
55
|
+
# @!attribute instructions
|
|
56
|
+
# Required instructions describing what to decide about the shared state.
|
|
57
|
+
#
|
|
58
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
59
|
+
required :instructions,
|
|
60
|
+
union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions }
|
|
61
|
+
|
|
62
|
+
# @!attribute type
|
|
63
|
+
# Question type.
|
|
64
|
+
#
|
|
65
|
+
# @return [Symbol, :choice]
|
|
66
|
+
required :type, const: :choice
|
|
67
|
+
|
|
68
|
+
# @!method initialize(criteria:, instructions:, type: :choice)
|
|
69
|
+
# Some parameter documentations has been truncated, see
|
|
70
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice} for more
|
|
71
|
+
# details.
|
|
72
|
+
#
|
|
73
|
+
# Select one of the supplied options.
|
|
74
|
+
#
|
|
75
|
+
# @param criteria [Hash{Symbol=>String, nil}] Between 2 and 64 option keys mapped to description strings or null. A null descr
|
|
76
|
+
#
|
|
77
|
+
# @param instructions [String, Hash{Symbol=>Object}, Array<Object>] Required instructions describing what to decide about the shared state.
|
|
78
|
+
#
|
|
79
|
+
# @param type [Symbol, :choice] Question type.
|
|
80
|
+
|
|
81
|
+
# Required instructions describing what to decide about the shared state.
|
|
82
|
+
#
|
|
83
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice#instructions
|
|
84
|
+
module Instructions
|
|
85
|
+
extend Telnyx::Internal::Type::Union
|
|
86
|
+
|
|
87
|
+
variant String
|
|
88
|
+
|
|
89
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::UnionMember1Map }
|
|
90
|
+
|
|
91
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::UnionMember2Array }
|
|
92
|
+
|
|
93
|
+
# @!method self.variants
|
|
94
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
95
|
+
|
|
96
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
97
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
98
|
+
|
|
99
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
100
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
class Noul < Telnyx::Internal::Type::BaseModel
|
|
105
|
+
# @!attribute instructions
|
|
106
|
+
# Required instructions describing what to decide about the shared state.
|
|
107
|
+
#
|
|
108
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
109
|
+
required :instructions,
|
|
110
|
+
union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions }
|
|
111
|
+
|
|
112
|
+
# @!attribute type
|
|
113
|
+
# Question type.
|
|
114
|
+
#
|
|
115
|
+
# @return [Symbol, :noul]
|
|
116
|
+
required :type, const: :noul
|
|
117
|
+
|
|
118
|
+
# @!attribute criteria
|
|
119
|
+
# Optional descriptions for the positive and negative outcomes. Descriptions must
|
|
120
|
+
# be strings.
|
|
121
|
+
#
|
|
122
|
+
# @return [Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria, nil]
|
|
123
|
+
optional :criteria, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria }
|
|
124
|
+
|
|
125
|
+
# @!method initialize(instructions:, criteria: nil, type: :noul)
|
|
126
|
+
# Some parameter documentations has been truncated, see
|
|
127
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul} for more
|
|
128
|
+
# details.
|
|
129
|
+
#
|
|
130
|
+
# Evaluate a yes/no question. Omit criteria to use Yes and No descriptions.
|
|
131
|
+
#
|
|
132
|
+
# @param instructions [String, Hash{Symbol=>Object}, Array<Object>] Required instructions describing what to decide about the shared state.
|
|
133
|
+
#
|
|
134
|
+
# @param criteria [Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria] Optional descriptions for the positive and negative outcomes. Descriptions must
|
|
135
|
+
#
|
|
136
|
+
# @param type [Symbol, :noul] Question type.
|
|
137
|
+
|
|
138
|
+
# Required instructions describing what to decide about the shared state.
|
|
139
|
+
#
|
|
140
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul#instructions
|
|
141
|
+
module Instructions
|
|
142
|
+
extend Telnyx::Internal::Type::Union
|
|
143
|
+
|
|
144
|
+
variant String
|
|
145
|
+
|
|
146
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::UnionMember1Map }
|
|
147
|
+
|
|
148
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::UnionMember2Array }
|
|
149
|
+
|
|
150
|
+
# @!method self.variants
|
|
151
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
152
|
+
|
|
153
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
154
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
155
|
+
|
|
156
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
157
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul#criteria
|
|
161
|
+
class Criteria < Telnyx::Internal::Type::BaseModel
|
|
162
|
+
# @!attribute false_
|
|
163
|
+
# Description of the negative outcome.
|
|
164
|
+
#
|
|
165
|
+
# @return [String, nil]
|
|
166
|
+
optional :false_, String, api_name: :false
|
|
167
|
+
|
|
168
|
+
# @!attribute true_
|
|
169
|
+
# Description of the positive outcome.
|
|
170
|
+
#
|
|
171
|
+
# @return [String, nil]
|
|
172
|
+
optional :true_, String, api_name: :true
|
|
173
|
+
|
|
174
|
+
# @!method initialize(false_: nil, true_: nil)
|
|
175
|
+
# Optional descriptions for the positive and negative outcomes. Descriptions must
|
|
176
|
+
# be strings.
|
|
177
|
+
#
|
|
178
|
+
# @param false_ [String] Description of the negative outcome.
|
|
179
|
+
#
|
|
180
|
+
# @param true_ [String] Description of the positive outcome.
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
class Score < Telnyx::Internal::Type::BaseModel
|
|
185
|
+
# @!attribute criteria
|
|
186
|
+
# Between 2 and 64 description strings in ascending score order. Indices start at
|
|
187
|
+
# zero.
|
|
188
|
+
#
|
|
189
|
+
# @return [Array<String>]
|
|
190
|
+
required :criteria, Telnyx::Internal::Type::ArrayOf[String]
|
|
191
|
+
|
|
192
|
+
# @!attribute instructions
|
|
193
|
+
# Required instructions describing what to decide about the shared state.
|
|
194
|
+
#
|
|
195
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
196
|
+
required :instructions,
|
|
197
|
+
union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions }
|
|
198
|
+
|
|
199
|
+
# @!attribute type
|
|
200
|
+
# Question type.
|
|
201
|
+
#
|
|
202
|
+
# @return [Symbol, :score]
|
|
203
|
+
required :type, const: :score
|
|
204
|
+
|
|
205
|
+
# @!method initialize(criteria:, instructions:, type: :score)
|
|
206
|
+
# Some parameter documentations has been truncated, see
|
|
207
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score} for more
|
|
208
|
+
# details.
|
|
209
|
+
#
|
|
210
|
+
# Rate the state against an ordered rubric.
|
|
211
|
+
#
|
|
212
|
+
# @param criteria [Array<String>] Between 2 and 64 description strings in ascending score order. Indices start at
|
|
213
|
+
#
|
|
214
|
+
# @param instructions [String, Hash{Symbol=>Object}, Array<Object>] Required instructions describing what to decide about the shared state.
|
|
215
|
+
#
|
|
216
|
+
# @param type [Symbol, :score] Question type.
|
|
217
|
+
|
|
218
|
+
# Required instructions describing what to decide about the shared state.
|
|
219
|
+
#
|
|
220
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score#instructions
|
|
221
|
+
module Instructions
|
|
222
|
+
extend Telnyx::Internal::Type::Union
|
|
223
|
+
|
|
224
|
+
variant String
|
|
225
|
+
|
|
226
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::UnionMember1Map }
|
|
227
|
+
|
|
228
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::UnionMember2Array }
|
|
229
|
+
|
|
230
|
+
# @!method self.variants
|
|
231
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
232
|
+
|
|
233
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
234
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
235
|
+
|
|
236
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
237
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
238
|
+
end
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# @!method self.variants
|
|
242
|
+
# @return [Array(Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score)]
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# Shared context evaluated by every question.
|
|
246
|
+
module State
|
|
247
|
+
extend Telnyx::Internal::Type::Union
|
|
248
|
+
|
|
249
|
+
variant String
|
|
250
|
+
|
|
251
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::State::UnionMember1Map }
|
|
252
|
+
|
|
253
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::State::UnionMember2Array }
|
|
254
|
+
|
|
255
|
+
# @!method self.variants
|
|
256
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
257
|
+
|
|
258
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
259
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
260
|
+
|
|
261
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
262
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
263
|
+
end
|
|
264
|
+
end
|
|
265
|
+
end
|
|
266
|
+
end
|
|
267
|
+
end
|
|
268
|
+
end
|
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Typesafe
|
|
7
|
+
# @see Telnyx::Resources::AI::Typesafe::V1#systemone
|
|
8
|
+
class V1SystemoneResponse < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
# @!attribute answers
|
|
10
|
+
# Answers keyed by exactly the question IDs in the request. Each answer type
|
|
11
|
+
# matches its question.
|
|
12
|
+
#
|
|
13
|
+
# @return [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}]
|
|
14
|
+
required :answers,
|
|
15
|
+
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer] }
|
|
16
|
+
|
|
17
|
+
# @!attribute usage
|
|
18
|
+
# Token usage for the completed evaluation.
|
|
19
|
+
#
|
|
20
|
+
# @return [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage]
|
|
21
|
+
required :usage, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage }
|
|
22
|
+
|
|
23
|
+
response_only do
|
|
24
|
+
# @!attribute model
|
|
25
|
+
# Opaque Telnyx-controlled identifier retained for TypeSafe SDK response
|
|
26
|
+
# compatibility. It is not a selectable model name or a guarantee of a particular
|
|
27
|
+
# underlying model.
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :model, String
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# @!method initialize(answers:, model:, usage:)
|
|
34
|
+
# Some parameter documentations has been truncated, see
|
|
35
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse} for more details.
|
|
36
|
+
#
|
|
37
|
+
# A complete synchronous evaluation. Answers are returned directly without a data
|
|
38
|
+
# wrapper.
|
|
39
|
+
#
|
|
40
|
+
# @param answers [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}] Answers keyed by exactly the question IDs in the request. Each answer type match
|
|
41
|
+
#
|
|
42
|
+
# @param model [String] Opaque Telnyx-controlled identifier retained for TypeSafe SDK response compatibi
|
|
43
|
+
#
|
|
44
|
+
# @param usage [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage] Token usage for the completed evaluation.
|
|
45
|
+
|
|
46
|
+
# An answer whose type matches its question.
|
|
47
|
+
module Answer
|
|
48
|
+
extend Telnyx::Internal::Type::Union
|
|
49
|
+
|
|
50
|
+
discriminator :type
|
|
51
|
+
|
|
52
|
+
# A selected option and the distribution across all supplied option keys.
|
|
53
|
+
variant :choice, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice }
|
|
54
|
+
|
|
55
|
+
# A yes/no score with no separate confidence or probabilities fields.
|
|
56
|
+
variant :noul, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul }
|
|
57
|
+
|
|
58
|
+
# An expected rating over the ordered criteria.
|
|
59
|
+
variant :score, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score }
|
|
60
|
+
|
|
61
|
+
class Choice < Telnyx::Internal::Type::BaseModel
|
|
62
|
+
# @!attribute choice
|
|
63
|
+
# The option key with the highest relative score. Ties favor the first option in
|
|
64
|
+
# request order.
|
|
65
|
+
#
|
|
66
|
+
# @return [String]
|
|
67
|
+
required :choice, String
|
|
68
|
+
|
|
69
|
+
# @!attribute confidence
|
|
70
|
+
# Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
71
|
+
# and N is the number of options. Zero indicates a uniform distribution; one
|
|
72
|
+
# indicates concentration on one option. This is neither the winning probability
|
|
73
|
+
# nor calibrated correctness.
|
|
74
|
+
#
|
|
75
|
+
# @return [Float]
|
|
76
|
+
required :confidence, Float
|
|
77
|
+
|
|
78
|
+
# @!attribute probabilities
|
|
79
|
+
# Relative scores normalized across the supplied options, summing approximately
|
|
80
|
+
# to 1. These are not calibrated probabilities of correctness.
|
|
81
|
+
#
|
|
82
|
+
# @return [Hash{Symbol=>Float}]
|
|
83
|
+
required :probabilities, Telnyx::Internal::Type::HashOf[Float]
|
|
84
|
+
|
|
85
|
+
# @!attribute type
|
|
86
|
+
# Answer type.
|
|
87
|
+
#
|
|
88
|
+
# @return [Symbol, :choice]
|
|
89
|
+
required :type, const: :choice
|
|
90
|
+
|
|
91
|
+
# @!method initialize(choice:, confidence:, probabilities:, type: :choice)
|
|
92
|
+
# Some parameter documentations has been truncated, see
|
|
93
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice} for more
|
|
94
|
+
# details.
|
|
95
|
+
#
|
|
96
|
+
# A selected option and the distribution across all supplied option keys.
|
|
97
|
+
#
|
|
98
|
+
# @param choice [String] The option key with the highest relative score. Ties favor the first option in r
|
|
99
|
+
#
|
|
100
|
+
# @param confidence [Float] Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
101
|
+
# an
|
|
102
|
+
#
|
|
103
|
+
# @param probabilities [Hash{Symbol=>Float}] Relative scores normalized across the supplied options, summing approximately to
|
|
104
|
+
#
|
|
105
|
+
# @param type [Symbol, :choice] Answer type.
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
class Noul < Telnyx::Internal::Type::BaseModel
|
|
109
|
+
# @!attribute noul
|
|
110
|
+
# Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
|
|
111
|
+
# This is a number, not a Boolean, and is not calibrated correctness.
|
|
112
|
+
#
|
|
113
|
+
# @return [Float]
|
|
114
|
+
required :noul, Float
|
|
115
|
+
|
|
116
|
+
# @!attribute type
|
|
117
|
+
# Answer type.
|
|
118
|
+
#
|
|
119
|
+
# @return [Symbol, :noul]
|
|
120
|
+
required :type, const: :noul
|
|
121
|
+
|
|
122
|
+
# @!method initialize(noul:, type: :noul)
|
|
123
|
+
# Some parameter documentations has been truncated, see
|
|
124
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul} for more
|
|
125
|
+
# details.
|
|
126
|
+
#
|
|
127
|
+
# A yes/no score with no separate confidence or probabilities fields.
|
|
128
|
+
#
|
|
129
|
+
# @param noul [Float] Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
|
|
130
|
+
#
|
|
131
|
+
# @param type [Symbol, :noul] Answer type.
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
class Score < Telnyx::Internal::Type::BaseModel
|
|
135
|
+
# @!attribute confidence
|
|
136
|
+
# Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
137
|
+
# and N is the number of options. Zero indicates a uniform distribution; one
|
|
138
|
+
# indicates concentration on one option. This is neither the winning probability
|
|
139
|
+
# nor calibrated correctness.
|
|
140
|
+
#
|
|
141
|
+
# @return [Float]
|
|
142
|
+
required :confidence, Float
|
|
143
|
+
|
|
144
|
+
# @!attribute legend
|
|
145
|
+
# Criterion descriptions keyed by stringified zero-based indices, such as "0",
|
|
146
|
+
# "1", and "2".
|
|
147
|
+
#
|
|
148
|
+
# @return [Hash{Symbol=>String}]
|
|
149
|
+
required :legend, Telnyx::Internal::Type::HashOf[String]
|
|
150
|
+
|
|
151
|
+
# @!attribute probabilities
|
|
152
|
+
# Relative scores keyed by the same stringified indices as legend.
|
|
153
|
+
#
|
|
154
|
+
# @return [Hash{Symbol=>Float}]
|
|
155
|
+
required :probabilities, Telnyx::Internal::Type::HashOf[Float]
|
|
156
|
+
|
|
157
|
+
# @!attribute score
|
|
158
|
+
# Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
|
|
159
|
+
# N-1 for N criteria; fractional values are valid.
|
|
160
|
+
#
|
|
161
|
+
# @return [Float]
|
|
162
|
+
required :score, Float
|
|
163
|
+
|
|
164
|
+
# @!attribute type
|
|
165
|
+
# Answer type.
|
|
166
|
+
#
|
|
167
|
+
# @return [Symbol, :score]
|
|
168
|
+
required :type, const: :score
|
|
169
|
+
|
|
170
|
+
# @!method initialize(confidence:, legend:, probabilities:, score:, type: :score)
|
|
171
|
+
# Some parameter documentations has been truncated, see
|
|
172
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score} for more
|
|
173
|
+
# details.
|
|
174
|
+
#
|
|
175
|
+
# An expected rating over the ordered criteria.
|
|
176
|
+
#
|
|
177
|
+
# @param confidence [Float] Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
178
|
+
# an
|
|
179
|
+
#
|
|
180
|
+
# @param legend [Hash{Symbol=>String}] Criterion descriptions keyed by stringified zero-based indices, such as "0", "1"
|
|
181
|
+
#
|
|
182
|
+
# @param probabilities [Hash{Symbol=>Float}] Relative scores keyed by the same stringified indices as legend.
|
|
183
|
+
#
|
|
184
|
+
# @param score [Float] Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
|
|
185
|
+
#
|
|
186
|
+
# @param type [Symbol, :score] Answer type.
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# @!method self.variants
|
|
190
|
+
# @return [Array(Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score)]
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneResponse#usage
|
|
194
|
+
class Usage < Telnyx::Internal::Type::BaseModel
|
|
195
|
+
# @!attribute input_tokens
|
|
196
|
+
# Input tokens processed, including shared-context preparation and question
|
|
197
|
+
# evaluation. This can exceed the token count of the unique input text.
|
|
198
|
+
#
|
|
199
|
+
# @return [Integer]
|
|
200
|
+
required :input_tokens, Integer
|
|
201
|
+
|
|
202
|
+
# @!attribute output_tokens
|
|
203
|
+
# Output tokens used for the evaluation, including shared-context preparation.
|
|
204
|
+
#
|
|
205
|
+
# @return [Integer]
|
|
206
|
+
required :output_tokens, Integer
|
|
207
|
+
|
|
208
|
+
# @!method initialize(input_tokens:, output_tokens:)
|
|
209
|
+
# Some parameter documentations has been truncated, see
|
|
210
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage} for more details.
|
|
211
|
+
#
|
|
212
|
+
# Token usage for the completed evaluation.
|
|
213
|
+
#
|
|
214
|
+
# @param input_tokens [Integer] Input tokens processed, including shared-context preparation and question evalua
|
|
215
|
+
#
|
|
216
|
+
# @param output_tokens [Integer] Output tokens used for the evaluation, including shared-context preparation.
|
|
217
|
+
end
|
|
218
|
+
end
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
end
|
|
222
|
+
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::BotChallenge#create
|
|
6
|
+
class BotChallengeCreateParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute llm_model_name
|
|
11
|
+
# Name of the LLM the client is using.
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :llm_model_name, String
|
|
15
|
+
|
|
16
|
+
# @!attribute llm_parameter_count
|
|
17
|
+
# Parameter count of the client LLM.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :llm_parameter_count, String
|
|
21
|
+
|
|
22
|
+
# @!attribute llm_quantization
|
|
23
|
+
# Quantization of the client LLM.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :llm_quantization, String
|
|
27
|
+
|
|
28
|
+
# @!method initialize(llm_model_name: nil, llm_parameter_count: nil, llm_quantization: nil, request_options: {})
|
|
29
|
+
# @param llm_model_name [String] Name of the LLM the client is using.
|
|
30
|
+
#
|
|
31
|
+
# @param llm_parameter_count [String] Parameter count of the client LLM.
|
|
32
|
+
#
|
|
33
|
+
# @param llm_quantization [String] Quantization of the client LLM.
|
|
34
|
+
#
|
|
35
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::BotChallenge#create
|
|
6
|
+
class BotChallengeCreateResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Telnyx::Models::BotChallengeCreateResponse::Data]
|
|
10
|
+
required :data, -> { Telnyx::Models::BotChallengeCreateResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data:)
|
|
13
|
+
# @param data [Telnyx::Models::BotChallengeCreateResponse::Data]
|
|
14
|
+
|
|
15
|
+
# @see Telnyx::Models::BotChallengeCreateResponse#data
|
|
16
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
17
|
+
# @!attribute challenge_type
|
|
18
|
+
# Type of challenge.
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType]
|
|
21
|
+
required :challenge_type, enum: -> { Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType }
|
|
22
|
+
|
|
23
|
+
# @!attribute nonce
|
|
24
|
+
# Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the
|
|
25
|
+
# signup request.
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :nonce, String
|
|
29
|
+
|
|
30
|
+
# @!attribute privacy_policy_url
|
|
31
|
+
# Current privacy-policy URL. Echo this back on the signup request.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :privacy_policy_url, String
|
|
35
|
+
|
|
36
|
+
# @!attribute problem
|
|
37
|
+
# Problem text to solve. Math problems are obfuscated and end with an unobfuscated
|
|
38
|
+
# rounding instruction; string and binary problems are returned as-is.
|
|
39
|
+
#
|
|
40
|
+
# @return [String]
|
|
41
|
+
required :problem, String
|
|
42
|
+
|
|
43
|
+
# @!attribute terms_and_conditions_url
|
|
44
|
+
# Current terms-and-conditions URL. Echo this back on the signup request.
|
|
45
|
+
#
|
|
46
|
+
# @return [String]
|
|
47
|
+
required :terms_and_conditions_url, String
|
|
48
|
+
|
|
49
|
+
# @!attribute precision
|
|
50
|
+
# Decimal places expected in the answer. Present only for math challenges.
|
|
51
|
+
#
|
|
52
|
+
# @return [Integer, nil]
|
|
53
|
+
optional :precision, Integer
|
|
54
|
+
|
|
55
|
+
# @!method initialize(challenge_type:, nonce:, privacy_policy_url:, problem:, terms_and_conditions_url:, precision: nil)
|
|
56
|
+
# Some parameter documentations has been truncated, see
|
|
57
|
+
# {Telnyx::Models::BotChallengeCreateResponse::Data} for more details.
|
|
58
|
+
#
|
|
59
|
+
# @param challenge_type [Symbol, Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType] Type of challenge.
|
|
60
|
+
#
|
|
61
|
+
# @param nonce [String] Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the signu
|
|
62
|
+
#
|
|
63
|
+
# @param privacy_policy_url [String] Current privacy-policy URL. Echo this back on the signup request.
|
|
64
|
+
#
|
|
65
|
+
# @param problem [String] Problem text to solve. Math problems are obfuscated and end with an unobfuscated
|
|
66
|
+
#
|
|
67
|
+
# @param terms_and_conditions_url [String] Current terms-and-conditions URL. Echo this back on the signup request.
|
|
68
|
+
#
|
|
69
|
+
# @param precision [Integer] Decimal places expected in the answer. Present only for math challenges.
|
|
70
|
+
|
|
71
|
+
# Type of challenge.
|
|
72
|
+
#
|
|
73
|
+
# @see Telnyx::Models::BotChallengeCreateResponse::Data#challenge_type
|
|
74
|
+
module ChallengeType
|
|
75
|
+
extend Telnyx::Internal::Type::Enum
|
|
76
|
+
|
|
77
|
+
MATH = :math
|
|
78
|
+
STRING = :string
|
|
79
|
+
BINARY = :binary
|
|
80
|
+
|
|
81
|
+
# @!method self.values
|
|
82
|
+
# @return [Array<Symbol>]
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::BotSessions#list
|
|
6
|
+
class BotSessionListParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute email
|
|
11
|
+
# Email address associated with the magic link token.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :email, String
|
|
15
|
+
|
|
16
|
+
# @!attribute portal_redirect_token
|
|
17
|
+
# Single-use portal redirect (magic link) token, a UUIDv7 sent to the account
|
|
18
|
+
# owner's email.
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :portal_redirect_token, String
|
|
22
|
+
|
|
23
|
+
# @!method initialize(email:, portal_redirect_token:, request_options: {})
|
|
24
|
+
# Some parameter documentations has been truncated, see
|
|
25
|
+
# {Telnyx::Models::BotSessionListParams} for more details.
|
|
26
|
+
#
|
|
27
|
+
# @param email [String] Email address associated with the magic link token.
|
|
28
|
+
#
|
|
29
|
+
# @param portal_redirect_token [String] Single-use portal redirect (magic link) token, a UUIDv7 sent to the account owne
|
|
30
|
+
#
|
|
31
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::BotSessions#list
|
|
6
|
+
class BotSessionListResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Telnyx::Models::BotSessionListResponse::Data]
|
|
10
|
+
required :data, -> { Telnyx::Models::BotSessionListResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data:)
|
|
13
|
+
# @param data [Telnyx::Models::BotSessionListResponse::Data]
|
|
14
|
+
|
|
15
|
+
# @see Telnyx::Models::BotSessionListResponse#data
|
|
16
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
17
|
+
# @!attribute api_v2_token
|
|
18
|
+
# API v2 session token for the signed-in user. Use it as a bearer token on
|
|
19
|
+
# authenticated endpoints.
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :api_v2_token, String
|
|
23
|
+
|
|
24
|
+
# @!method initialize(api_v2_token:)
|
|
25
|
+
# Some parameter documentations has been truncated, see
|
|
26
|
+
# {Telnyx::Models::BotSessionListResponse::Data} for more details.
|
|
27
|
+
#
|
|
28
|
+
# @param api_v2_token [String] API v2 session token for the signed-in user. Use it as a bearer token on authent
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|