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
|
@@ -9,6 +9,21 @@ module Telnyx
|
|
|
9
9
|
# @return [String, nil]
|
|
10
10
|
optional :id, String
|
|
11
11
|
|
|
12
|
+
# @!attribute autoresponse_type
|
|
13
|
+
# Automatic response type triggered by an inbound opt-in, opt-out, or help
|
|
14
|
+
# keyword. Examples include START, STOP, and HELP.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :autoresponse_type, String
|
|
18
|
+
|
|
19
|
+
# @!attribute body
|
|
20
|
+
# Message body for RCS and WhatsApp. RCS messages contain text, user_file,
|
|
21
|
+
# location, or suggestion_response. For WhatsApp edits and revocations, inspect
|
|
22
|
+
# type and the corresponding edit or revoke object.
|
|
23
|
+
#
|
|
24
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body, nil]
|
|
25
|
+
optional :body, -> { Telnyx::MessagingInboundMessagePayload::Body }
|
|
26
|
+
|
|
12
27
|
# @!attribute cc
|
|
13
28
|
#
|
|
14
29
|
# @return [Array<Telnyx::Models::MessagingInboundMessagePayload::Cc>, nil]
|
|
@@ -142,12 +157,15 @@ module Telnyx
|
|
|
142
157
|
optional :text, String
|
|
143
158
|
|
|
144
159
|
# @!attribute to
|
|
160
|
+
# Receiving address. SMS, MMS and RCS webhooks use an array of recipients. RCS
|
|
161
|
+
# recipients are identified by agent_id and agent_name. WhatsApp webhooks use one
|
|
162
|
+
# E.164 phone number.
|
|
145
163
|
#
|
|
146
|
-
# @return [Array<Telnyx::Models::MessagingInboundMessagePayload::To>, nil]
|
|
147
|
-
optional :to, -> { Telnyx::
|
|
164
|
+
# @return [Array<Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0>, String, nil]
|
|
165
|
+
optional :to, union: -> { Telnyx::MessagingInboundMessagePayload::To }
|
|
148
166
|
|
|
149
167
|
# @!attribute type
|
|
150
|
-
# The
|
|
168
|
+
# The messaging channel used for the message.
|
|
151
169
|
#
|
|
152
170
|
# @return [Symbol, Telnyx::Models::MessagingInboundMessagePayload::Type, nil]
|
|
153
171
|
optional :type, enum: -> { Telnyx::MessagingInboundMessagePayload::Type }
|
|
@@ -171,12 +189,16 @@ module Telnyx
|
|
|
171
189
|
# @return [String, nil]
|
|
172
190
|
optional :webhook_url, String, nil?: true
|
|
173
191
|
|
|
174
|
-
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
192
|
+
# @!method initialize(id: nil, autoresponse_type: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
175
193
|
# Some parameter documentations has been truncated, see
|
|
176
194
|
# {Telnyx::Models::MessagingInboundMessagePayload} for more details.
|
|
177
195
|
#
|
|
178
196
|
# @param id [String] Identifies the type of resource.
|
|
179
197
|
#
|
|
198
|
+
# @param autoresponse_type [String] Automatic response type triggered by an inbound opt-in, opt-out, or help keyword
|
|
199
|
+
#
|
|
200
|
+
# @param body [Telnyx::Models::MessagingInboundMessagePayload::Body] Message body for RCS and WhatsApp. RCS messages contain text, user_file, locatio
|
|
201
|
+
#
|
|
180
202
|
# @param cc [Array<Telnyx::Models::MessagingInboundMessagePayload::Cc>]
|
|
181
203
|
#
|
|
182
204
|
# @param completed_at [Time, nil] Not used for inbound messages.
|
|
@@ -221,9 +243,9 @@ module Telnyx
|
|
|
221
243
|
#
|
|
222
244
|
# @param text [String] Message body (i.e., content) as a non-empty string.
|
|
223
245
|
#
|
|
224
|
-
# @param to [Array<Telnyx::Models::MessagingInboundMessagePayload::To
|
|
246
|
+
# @param to [Array<Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0>, String] Receiving address. SMS, MMS and RCS webhooks use an array of recipients. RCS rec
|
|
225
247
|
#
|
|
226
|
-
# @param type [Symbol, Telnyx::Models::MessagingInboundMessagePayload::Type] The
|
|
248
|
+
# @param type [Symbol, Telnyx::Models::MessagingInboundMessagePayload::Type] The messaging channel used for the message.
|
|
227
249
|
#
|
|
228
250
|
# @param valid_until [Time, nil] Not used for inbound messages.
|
|
229
251
|
#
|
|
@@ -231,6 +253,289 @@ module Telnyx
|
|
|
231
253
|
#
|
|
232
254
|
# @param webhook_url [String, nil] The URL where webhooks related to this message will be sent.
|
|
233
255
|
|
|
256
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload#body
|
|
257
|
+
class Body < Telnyx::Internal::Type::BaseModel
|
|
258
|
+
# @!attribute id
|
|
259
|
+
# Telnyx identifier for this webhook message.
|
|
260
|
+
#
|
|
261
|
+
# @return [String, nil]
|
|
262
|
+
optional :id, String
|
|
263
|
+
|
|
264
|
+
# @!attribute edit
|
|
265
|
+
# Details for an edited WhatsApp message.
|
|
266
|
+
#
|
|
267
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::Edit, nil]
|
|
268
|
+
optional :edit, -> { Telnyx::MessagingInboundMessagePayload::Body::Edit }
|
|
269
|
+
|
|
270
|
+
# @!attribute foreign_id
|
|
271
|
+
# Meta WhatsApp message identifier for this webhook event.
|
|
272
|
+
#
|
|
273
|
+
# @return [String, nil]
|
|
274
|
+
optional :foreign_id, String
|
|
275
|
+
|
|
276
|
+
# @!attribute from
|
|
277
|
+
# WhatsApp sender in E.164 format.
|
|
278
|
+
#
|
|
279
|
+
# @return [String, nil]
|
|
280
|
+
optional :from, String
|
|
281
|
+
|
|
282
|
+
# @!attribute location
|
|
283
|
+
# Location shared in an RCS message.
|
|
284
|
+
#
|
|
285
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::Location, nil]
|
|
286
|
+
optional :location, -> { Telnyx::MessagingInboundMessagePayload::Body::Location }
|
|
287
|
+
|
|
288
|
+
# @!attribute revoke
|
|
289
|
+
# Details for a revoked WhatsApp message.
|
|
290
|
+
#
|
|
291
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::Revoke, nil]
|
|
292
|
+
optional :revoke, -> { Telnyx::MessagingInboundMessagePayload::Body::Revoke }
|
|
293
|
+
|
|
294
|
+
# @!attribute suggestion_response
|
|
295
|
+
# Selected RCS suggestion.
|
|
296
|
+
#
|
|
297
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::SuggestionResponse, nil]
|
|
298
|
+
optional :suggestion_response, -> { Telnyx::MessagingInboundMessagePayload::Body::SuggestionResponse }
|
|
299
|
+
|
|
300
|
+
# @!attribute text
|
|
301
|
+
# RCS text string or WhatsApp text object.
|
|
302
|
+
#
|
|
303
|
+
# @return [String, Telnyx::Models::MessagingInboundMessagePayload::Body::Text::Body, nil]
|
|
304
|
+
optional :text, union: -> { Telnyx::MessagingInboundMessagePayload::Body::Text }
|
|
305
|
+
|
|
306
|
+
# @!attribute timestamp
|
|
307
|
+
# Unix timestamp supplied by Meta.
|
|
308
|
+
#
|
|
309
|
+
# @return [String, nil]
|
|
310
|
+
optional :timestamp, String
|
|
311
|
+
|
|
312
|
+
# @!attribute type
|
|
313
|
+
# WhatsApp message body type. Edit and revoke events use `edit` and `revoke`,
|
|
314
|
+
# respectively.
|
|
315
|
+
#
|
|
316
|
+
# @return [String, nil]
|
|
317
|
+
optional :type, String
|
|
318
|
+
|
|
319
|
+
# @!attribute user_file
|
|
320
|
+
# RCS file attachment and optional thumbnail.
|
|
321
|
+
#
|
|
322
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile, nil]
|
|
323
|
+
optional :user_file, -> { Telnyx::MessagingInboundMessagePayload::Body::UserFile }
|
|
324
|
+
|
|
325
|
+
# @!method initialize(id: nil, edit: nil, foreign_id: nil, from: nil, location: nil, revoke: nil, suggestion_response: nil, text: nil, timestamp: nil, type: nil, user_file: nil)
|
|
326
|
+
# Some parameter documentations has been truncated, see
|
|
327
|
+
# {Telnyx::Models::MessagingInboundMessagePayload::Body} for more details.
|
|
328
|
+
#
|
|
329
|
+
# Message body for RCS and WhatsApp. RCS messages contain text, user_file,
|
|
330
|
+
# location, or suggestion_response. For WhatsApp edits and revocations, inspect
|
|
331
|
+
# type and the corresponding edit or revoke object.
|
|
332
|
+
#
|
|
333
|
+
# @param id [String] Telnyx identifier for this webhook message.
|
|
334
|
+
#
|
|
335
|
+
# @param edit [Telnyx::Models::MessagingInboundMessagePayload::Body::Edit] Details for an edited WhatsApp message.
|
|
336
|
+
#
|
|
337
|
+
# @param foreign_id [String] Meta WhatsApp message identifier for this webhook event.
|
|
338
|
+
#
|
|
339
|
+
# @param from [String] WhatsApp sender in E.164 format.
|
|
340
|
+
#
|
|
341
|
+
# @param location [Telnyx::Models::MessagingInboundMessagePayload::Body::Location] Location shared in an RCS message.
|
|
342
|
+
#
|
|
343
|
+
# @param revoke [Telnyx::Models::MessagingInboundMessagePayload::Body::Revoke] Details for a revoked WhatsApp message.
|
|
344
|
+
#
|
|
345
|
+
# @param suggestion_response [Telnyx::Models::MessagingInboundMessagePayload::Body::SuggestionResponse] Selected RCS suggestion.
|
|
346
|
+
#
|
|
347
|
+
# @param text [String, Telnyx::Models::MessagingInboundMessagePayload::Body::Text::Body] RCS text string or WhatsApp text object.
|
|
348
|
+
#
|
|
349
|
+
# @param timestamp [String] Unix timestamp supplied by Meta.
|
|
350
|
+
#
|
|
351
|
+
# @param type [String] WhatsApp message body type. Edit and revoke events use `edit` and `revoke`, resp
|
|
352
|
+
#
|
|
353
|
+
# @param user_file [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile] RCS file attachment and optional thumbnail.
|
|
354
|
+
|
|
355
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body#edit
|
|
356
|
+
class Edit < Telnyx::Internal::Type::BaseModel
|
|
357
|
+
# @!attribute message
|
|
358
|
+
# Replacement WhatsApp message content. Its shape depends on the message type.
|
|
359
|
+
#
|
|
360
|
+
# @return [Hash{Symbol=>Object}]
|
|
361
|
+
required :message, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
362
|
+
|
|
363
|
+
# @!attribute original_message_id
|
|
364
|
+
# Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp
|
|
365
|
+
# message ID. Treat this value as opaque.
|
|
366
|
+
#
|
|
367
|
+
# @return [String]
|
|
368
|
+
required :original_message_id, String
|
|
369
|
+
|
|
370
|
+
# @!method initialize(message:, original_message_id:)
|
|
371
|
+
# Some parameter documentations has been truncated, see
|
|
372
|
+
# {Telnyx::Models::MessagingInboundMessagePayload::Body::Edit} for more details.
|
|
373
|
+
#
|
|
374
|
+
# Details for an edited WhatsApp message.
|
|
375
|
+
#
|
|
376
|
+
# @param message [Hash{Symbol=>Object}] Replacement WhatsApp message content. Its shape depends on the message type.
|
|
377
|
+
#
|
|
378
|
+
# @param original_message_id [String] Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp me
|
|
379
|
+
end
|
|
380
|
+
|
|
381
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body#location
|
|
382
|
+
class Location < Telnyx::Internal::Type::BaseModel
|
|
383
|
+
# @!attribute latitude
|
|
384
|
+
#
|
|
385
|
+
# @return [Float, nil]
|
|
386
|
+
optional :latitude, Float
|
|
387
|
+
|
|
388
|
+
# @!attribute longitude
|
|
389
|
+
#
|
|
390
|
+
# @return [Float, nil]
|
|
391
|
+
optional :longitude, Float
|
|
392
|
+
|
|
393
|
+
# @!method initialize(latitude: nil, longitude: nil)
|
|
394
|
+
# Location shared in an RCS message.
|
|
395
|
+
#
|
|
396
|
+
# @param latitude [Float]
|
|
397
|
+
# @param longitude [Float]
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body#revoke
|
|
401
|
+
class Revoke < Telnyx::Internal::Type::BaseModel
|
|
402
|
+
# @!attribute original_message_id
|
|
403
|
+
# Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp
|
|
404
|
+
# message ID. Treat this value as opaque.
|
|
405
|
+
#
|
|
406
|
+
# @return [String]
|
|
407
|
+
required :original_message_id, String
|
|
408
|
+
|
|
409
|
+
# @!method initialize(original_message_id:)
|
|
410
|
+
# Some parameter documentations has been truncated, see
|
|
411
|
+
# {Telnyx::Models::MessagingInboundMessagePayload::Body::Revoke} for more details.
|
|
412
|
+
#
|
|
413
|
+
# Details for a revoked WhatsApp message.
|
|
414
|
+
#
|
|
415
|
+
# @param original_message_id [String] Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp me
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body#suggestion_response
|
|
419
|
+
class SuggestionResponse < Telnyx::Internal::Type::BaseModel
|
|
420
|
+
# @!attribute postback_data
|
|
421
|
+
#
|
|
422
|
+
# @return [String, nil]
|
|
423
|
+
optional :postback_data, String
|
|
424
|
+
|
|
425
|
+
# @!attribute text
|
|
426
|
+
#
|
|
427
|
+
# @return [String, nil]
|
|
428
|
+
optional :text, String
|
|
429
|
+
|
|
430
|
+
# @!method initialize(postback_data: nil, text: nil)
|
|
431
|
+
# Selected RCS suggestion.
|
|
432
|
+
#
|
|
433
|
+
# @param postback_data [String]
|
|
434
|
+
# @param text [String]
|
|
435
|
+
end
|
|
436
|
+
|
|
437
|
+
# RCS text string or WhatsApp text object.
|
|
438
|
+
#
|
|
439
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body#text
|
|
440
|
+
module Text
|
|
441
|
+
extend Telnyx::Internal::Type::Union
|
|
442
|
+
|
|
443
|
+
variant String
|
|
444
|
+
|
|
445
|
+
variant -> { Telnyx::MessagingInboundMessagePayload::Body::Text::Body }
|
|
446
|
+
|
|
447
|
+
class Body < Telnyx::Internal::Type::BaseModel
|
|
448
|
+
# @!attribute body
|
|
449
|
+
#
|
|
450
|
+
# @return [String, nil]
|
|
451
|
+
optional :body, String
|
|
452
|
+
|
|
453
|
+
# @!method initialize(body: nil)
|
|
454
|
+
# @param body [String]
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
# @!method self.variants
|
|
458
|
+
# @return [Array(String, Telnyx::Models::MessagingInboundMessagePayload::Body::Text::Body)]
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body#user_file
|
|
462
|
+
class UserFile < Telnyx::Internal::Type::BaseModel
|
|
463
|
+
# @!attribute payload
|
|
464
|
+
#
|
|
465
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile::Payload, nil]
|
|
466
|
+
optional :payload, -> { Telnyx::MessagingInboundMessagePayload::Body::UserFile::Payload }
|
|
467
|
+
|
|
468
|
+
# @!attribute thumbnail
|
|
469
|
+
#
|
|
470
|
+
# @return [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile::Thumbnail, nil]
|
|
471
|
+
optional :thumbnail, -> { Telnyx::MessagingInboundMessagePayload::Body::UserFile::Thumbnail }
|
|
472
|
+
|
|
473
|
+
# @!method initialize(payload: nil, thumbnail: nil)
|
|
474
|
+
# RCS file attachment and optional thumbnail.
|
|
475
|
+
#
|
|
476
|
+
# @param payload [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile::Payload]
|
|
477
|
+
# @param thumbnail [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile::Thumbnail]
|
|
478
|
+
|
|
479
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile#payload
|
|
480
|
+
class Payload < Telnyx::Internal::Type::BaseModel
|
|
481
|
+
# @!attribute file_name
|
|
482
|
+
#
|
|
483
|
+
# @return [String, nil]
|
|
484
|
+
optional :file_name, String
|
|
485
|
+
|
|
486
|
+
# @!attribute file_size_bytes
|
|
487
|
+
#
|
|
488
|
+
# @return [Integer, nil]
|
|
489
|
+
optional :file_size_bytes, Integer
|
|
490
|
+
|
|
491
|
+
# @!attribute file_uri
|
|
492
|
+
#
|
|
493
|
+
# @return [String, nil]
|
|
494
|
+
optional :file_uri, String
|
|
495
|
+
|
|
496
|
+
# @!attribute mime_type
|
|
497
|
+
#
|
|
498
|
+
# @return [String, nil]
|
|
499
|
+
optional :mime_type, String
|
|
500
|
+
|
|
501
|
+
# @!method initialize(file_name: nil, file_size_bytes: nil, file_uri: nil, mime_type: nil)
|
|
502
|
+
# @param file_name [String]
|
|
503
|
+
# @param file_size_bytes [Integer]
|
|
504
|
+
# @param file_uri [String]
|
|
505
|
+
# @param mime_type [String]
|
|
506
|
+
end
|
|
507
|
+
|
|
508
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile#thumbnail
|
|
509
|
+
class Thumbnail < Telnyx::Internal::Type::BaseModel
|
|
510
|
+
# @!attribute file_name
|
|
511
|
+
#
|
|
512
|
+
# @return [String, nil]
|
|
513
|
+
optional :file_name, String
|
|
514
|
+
|
|
515
|
+
# @!attribute file_size_bytes
|
|
516
|
+
#
|
|
517
|
+
# @return [Integer, nil]
|
|
518
|
+
optional :file_size_bytes, Integer
|
|
519
|
+
|
|
520
|
+
# @!attribute file_uri
|
|
521
|
+
#
|
|
522
|
+
# @return [String, nil]
|
|
523
|
+
optional :file_uri, String
|
|
524
|
+
|
|
525
|
+
# @!attribute mime_type
|
|
526
|
+
#
|
|
527
|
+
# @return [String, nil]
|
|
528
|
+
optional :mime_type, String
|
|
529
|
+
|
|
530
|
+
# @!method initialize(file_name: nil, file_size_bytes: nil, file_uri: nil, mime_type: nil)
|
|
531
|
+
# @param file_name [String]
|
|
532
|
+
# @param file_size_bytes [Integer]
|
|
533
|
+
# @param file_uri [String]
|
|
534
|
+
# @param mime_type [String]
|
|
535
|
+
end
|
|
536
|
+
end
|
|
537
|
+
end
|
|
538
|
+
|
|
234
539
|
class Cc < Telnyx::Internal::Type::BaseModel
|
|
235
540
|
# @!attribute carrier
|
|
236
541
|
# The carrier of the receiver.
|
|
@@ -304,18 +609,18 @@ module Telnyx
|
|
|
304
609
|
# The amount deducted from your account.
|
|
305
610
|
#
|
|
306
611
|
# @return [String, nil]
|
|
307
|
-
optional :amount, String
|
|
612
|
+
optional :amount, String, nil?: true
|
|
308
613
|
|
|
309
614
|
# @!attribute currency
|
|
310
615
|
# The ISO 4217 currency identifier.
|
|
311
616
|
#
|
|
312
617
|
# @return [String, nil]
|
|
313
|
-
optional :currency, String
|
|
618
|
+
optional :currency, String, nil?: true
|
|
314
619
|
|
|
315
620
|
# @!method initialize(amount: nil, currency: nil)
|
|
316
|
-
# @param amount [String] The amount deducted from your account.
|
|
621
|
+
# @param amount [String, nil] The amount deducted from your account.
|
|
317
622
|
#
|
|
318
|
-
# @param currency [String] The ISO 4217 currency identifier.
|
|
623
|
+
# @param currency [String, nil] The ISO 4217 currency identifier.
|
|
319
624
|
end
|
|
320
625
|
|
|
321
626
|
# @see Telnyx::Models::MessagingInboundMessagePayload#cost_breakdown
|
|
@@ -440,6 +745,7 @@ module Telnyx
|
|
|
440
745
|
VO_IP = :VoIP
|
|
441
746
|
PRE_PAID_WIRELESS = :"Pre-Paid Wireless"
|
|
442
747
|
EMPTY = :""
|
|
748
|
+
LONG_CODE = :long_code
|
|
443
749
|
|
|
444
750
|
# @!method self.values
|
|
445
751
|
# @return [Array<Symbol>]
|
|
@@ -451,6 +757,7 @@ module Telnyx
|
|
|
451
757
|
|
|
452
758
|
RECEIVED = :received
|
|
453
759
|
DELIVERED = :delivered
|
|
760
|
+
WEBHOOK_DELIVERED = :webhook_delivered
|
|
454
761
|
|
|
455
762
|
# @!method self.values
|
|
456
763
|
# @return [Array<Symbol>]
|
|
@@ -504,75 +811,112 @@ module Telnyx
|
|
|
504
811
|
# @return [Array<Symbol>]
|
|
505
812
|
end
|
|
506
813
|
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
814
|
+
# Receiving address. SMS, MMS and RCS webhooks use an array of recipients. RCS
|
|
815
|
+
# recipients are identified by agent_id and agent_name. WhatsApp webhooks use one
|
|
816
|
+
# E.164 phone number.
|
|
817
|
+
#
|
|
818
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload#to
|
|
819
|
+
module To
|
|
820
|
+
extend Telnyx::Internal::Type::Union
|
|
513
821
|
|
|
514
|
-
|
|
515
|
-
# The line-type of the receiver.
|
|
516
|
-
#
|
|
517
|
-
# @return [Symbol, Telnyx::Models::MessagingInboundMessagePayload::To::LineType, nil]
|
|
518
|
-
optional :line_type, enum: -> { Telnyx::MessagingInboundMessagePayload::To::LineType }
|
|
822
|
+
variant -> { Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0Array }
|
|
519
823
|
|
|
520
|
-
#
|
|
521
|
-
|
|
522
|
-
#
|
|
523
|
-
# @return [String, nil]
|
|
524
|
-
optional :phone_number, String
|
|
824
|
+
# WhatsApp receiving address in E.164 format.
|
|
825
|
+
variant String
|
|
525
826
|
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
827
|
+
class UnionMember0 < Telnyx::Internal::Type::BaseModel
|
|
828
|
+
# @!attribute agent_id
|
|
829
|
+
# RCS agent identifier.
|
|
830
|
+
#
|
|
831
|
+
# @return [String, nil]
|
|
832
|
+
optional :agent_id, String
|
|
530
833
|
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
# @param phone_number [String] Receiving address (+E.164 formatted phone number or short code).
|
|
537
|
-
#
|
|
538
|
-
# @param status [Symbol, Telnyx::Models::MessagingInboundMessagePayload::To::Status]
|
|
834
|
+
# @!attribute agent_name
|
|
835
|
+
# RCS agent name.
|
|
836
|
+
#
|
|
837
|
+
# @return [String, nil]
|
|
838
|
+
optional :agent_name, String
|
|
539
839
|
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
840
|
+
# @!attribute carrier
|
|
841
|
+
# The carrier of the receiver.
|
|
842
|
+
#
|
|
843
|
+
# @return [String, nil]
|
|
844
|
+
optional :carrier, String
|
|
545
845
|
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
EMPTY = :""
|
|
846
|
+
# @!attribute line_type
|
|
847
|
+
# The line-type of the receiver.
|
|
848
|
+
#
|
|
849
|
+
# @return [Symbol, Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0::LineType, nil]
|
|
850
|
+
optional :line_type, enum: -> { Telnyx::MessagingInboundMessagePayload::To::UnionMember0::LineType }
|
|
552
851
|
|
|
553
|
-
# @!
|
|
554
|
-
#
|
|
555
|
-
|
|
852
|
+
# @!attribute phone_number
|
|
853
|
+
# Receiving address (+E.164 formatted phone number or short code).
|
|
854
|
+
#
|
|
855
|
+
# @return [String, nil]
|
|
856
|
+
optional :phone_number, String
|
|
556
857
|
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
858
|
+
# @!attribute status
|
|
859
|
+
#
|
|
860
|
+
# @return [Symbol, Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0::Status, nil]
|
|
861
|
+
optional :status, enum: -> { Telnyx::MessagingInboundMessagePayload::To::UnionMember0::Status }
|
|
560
862
|
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
863
|
+
# @!method initialize(agent_id: nil, agent_name: nil, carrier: nil, line_type: nil, phone_number: nil, status: nil)
|
|
864
|
+
# @param agent_id [String] RCS agent identifier.
|
|
865
|
+
#
|
|
866
|
+
# @param agent_name [String] RCS agent name.
|
|
867
|
+
#
|
|
868
|
+
# @param carrier [String] The carrier of the receiver.
|
|
869
|
+
#
|
|
870
|
+
# @param line_type [Symbol, Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0::LineType] The line-type of the receiver.
|
|
871
|
+
#
|
|
872
|
+
# @param phone_number [String] Receiving address (+E.164 formatted phone number or short code).
|
|
873
|
+
#
|
|
874
|
+
# @param status [Symbol, Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0::Status]
|
|
569
875
|
|
|
570
|
-
#
|
|
571
|
-
#
|
|
876
|
+
# The line-type of the receiver.
|
|
877
|
+
#
|
|
878
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0#line_type
|
|
879
|
+
module LineType
|
|
880
|
+
extend Telnyx::Internal::Type::Enum
|
|
881
|
+
|
|
882
|
+
WIRELINE = :Wireline
|
|
883
|
+
WIRELESS = :Wireless
|
|
884
|
+
VO_WI_FI = :VoWiFi
|
|
885
|
+
VO_IP = :VoIP
|
|
886
|
+
PRE_PAID_WIRELESS = :"Pre-Paid Wireless"
|
|
887
|
+
EMPTY = :""
|
|
888
|
+
|
|
889
|
+
# @!method self.values
|
|
890
|
+
# @return [Array<Symbol>]
|
|
891
|
+
end
|
|
892
|
+
|
|
893
|
+
# @see Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0#status
|
|
894
|
+
module Status
|
|
895
|
+
extend Telnyx::Internal::Type::Enum
|
|
896
|
+
|
|
897
|
+
QUEUED = :queued
|
|
898
|
+
SENDING = :sending
|
|
899
|
+
SENT = :sent
|
|
900
|
+
DELIVERED = :delivered
|
|
901
|
+
SENDING_FAILED = :sending_failed
|
|
902
|
+
DELIVERY_FAILED = :delivery_failed
|
|
903
|
+
DELIVERY_UNCONFIRMED = :delivery_unconfirmed
|
|
904
|
+
WEBHOOK_DELIVERED = :webhook_delivered
|
|
905
|
+
|
|
906
|
+
# @!method self.values
|
|
907
|
+
# @return [Array<Symbol>]
|
|
908
|
+
end
|
|
572
909
|
end
|
|
910
|
+
|
|
911
|
+
# @!method self.variants
|
|
912
|
+
# @return [Array(Array<Telnyx::Models::MessagingInboundMessagePayload::To::UnionMember0>, String)]
|
|
913
|
+
|
|
914
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
915
|
+
UnionMember0Array =
|
|
916
|
+
Telnyx::Internal::Type::ArrayOf[-> { Telnyx::MessagingInboundMessagePayload::To::UnionMember0 }]
|
|
573
917
|
end
|
|
574
918
|
|
|
575
|
-
# The
|
|
919
|
+
# The messaging channel used for the message.
|
|
576
920
|
#
|
|
577
921
|
# @see Telnyx::Models::MessagingInboundMessagePayload#type
|
|
578
922
|
module Type
|
|
@@ -580,6 +924,8 @@ module Telnyx
|
|
|
580
924
|
|
|
581
925
|
SMS = :SMS
|
|
582
926
|
MMS = :MMS
|
|
927
|
+
WHATSAPP = :WHATSAPP
|
|
928
|
+
RCS = :RCS
|
|
583
929
|
|
|
584
930
|
# @!method self.values
|
|
585
931
|
# @return [Array<Symbol>]
|
|
@@ -36,6 +36,14 @@ module Telnyx
|
|
|
36
36
|
# @return [Boolean, nil]
|
|
37
37
|
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
38
38
|
|
|
39
|
+
# @!attribute features
|
|
40
|
+
# Telnyx product features the messaging customer can enable on the messaging
|
|
41
|
+
# profile. Keys map to individual feature flags; unknown keys are accepted and
|
|
42
|
+
# preserved for forward compatibility with rolling deployments.
|
|
43
|
+
#
|
|
44
|
+
# @return [Telnyx::Models::MessagingProfileFeatures, nil]
|
|
45
|
+
optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
|
|
46
|
+
|
|
39
47
|
# @!attribute health_webhook_url
|
|
40
48
|
# DEPRECATED: health check url service checking
|
|
41
49
|
#
|
|
@@ -187,7 +195,7 @@ module Telnyx
|
|
|
187
195
|
optional :updated_at, Time
|
|
188
196
|
end
|
|
189
197
|
|
|
190
|
-
# @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
198
|
+
# @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
|
|
191
199
|
# Some parameter documentations has been truncated, see
|
|
192
200
|
# {Telnyx::Models::MessagingMessagingProfile} for more details.
|
|
193
201
|
#
|
|
@@ -205,6 +213,8 @@ module Telnyx
|
|
|
205
213
|
#
|
|
206
214
|
# @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
|
|
207
215
|
#
|
|
216
|
+
# @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
|
|
217
|
+
#
|
|
208
218
|
# @param health_webhook_url [String, nil] DEPRECATED: health check url service checking
|
|
209
219
|
#
|
|
210
220
|
# @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
|