telnyx 5.168.0 → 5.170.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +40 -0
- data/lib/telnyx/internal/email_cursor_pagination.rb +2 -2
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -9
- data/lib/telnyx/models/ai/assistant_tool.rb +316 -13
- data/lib/telnyx/models/ai/assistant_update_params.rb +23 -12
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +23 -12
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
- data/lib/telnyx/models/ai/collection.rb +3 -3
- data/lib/telnyx/models/ai/collections/collections_source.rb +64 -0
- data/lib/telnyx/models/ai/collections/source.rb +25 -29
- data/lib/telnyx/models/ai/collections/source_create_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_list_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_replace_response.rb +3 -3
- data/lib/telnyx/models/ai/flow_node.rb +5 -5
- data/lib/telnyx/models/ai/flow_node_req.rb +3 -3
- data/lib/telnyx/models/ai/inference_embedding.rb +16 -13
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_voice_settings.rb +334 -0
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +33 -11
- data/lib/telnyx/models/ai/memory/namespace_retrieve_params.rb +30 -0
- data/lib/telnyx/models/ai/memory/namespace_retrieve_response.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +63 -0
- data/lib/telnyx/models/ai/memory/namespaces/page_meta.rb +58 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_response.rb +47 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_params.rb +94 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_response.rb +61 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_params.rb +48 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_response.rb +34 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_params.rb +44 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_params.rb +38 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_response.rb +54 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rb +64 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rb +53 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rb +50 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rb +74 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rb +67 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rb +123 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_list_params.rb +28 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rb +69 -0
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +296 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +235 -0
- data/lib/telnyx/models/ai/webhook_tool.rb +16 -1
- data/lib/telnyx/models/artifact_completed_webhook_event.rb +17 -1
- data/lib/telnyx/models/artifact_failed_webhook_event.rb +4 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +11 -3
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +11 -3
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/soniox_voice_settings.rb +46 -0
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/conferences/action_speak_params.rb +11 -3
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +11 -3
- data/lib/telnyx/models/conversation_relay_language.rb +5 -3
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/email_block.rb +8 -1
- data/lib/telnyx/models/email_blocks/email_block_import.rb +7 -2
- data/lib/telnyx/models/email_domain_rotate_dkim_params.rb +20 -0
- data/lib/telnyx/models/email_domain_rotate_dkim_response.rb +243 -0
- data/lib/telnyx/models/email_domains/email_webhook_event.rb +8 -3
- data/lib/telnyx/models/email_event_list_params.rb +33 -10
- data/lib/telnyx/models/email_event_list_response.rb +300 -73
- data/lib/telnyx/models/email_event_type.rb +16 -0
- data/lib/telnyx/models/email_inboxes/email_message.rb +56 -4
- data/lib/telnyx/models/email_message_batch_params.rb +32 -15
- data/lib/telnyx/models/email_message_create_params.rb +44 -12
- data/lib/telnyx/models/{email_message_retrieve_response.rb → email_message_detail_response.rb} +5 -5
- data/lib/telnyx/models/email_message_list_params.rb +26 -1
- data/lib/telnyx/models/email_message_update_schedule_params.rb +29 -0
- data/lib/telnyx/models/email_messages/email_recipient.rb +2 -0
- data/lib/telnyx/models/email_messages/recipient_list_params.rb +2 -0
- data/lib/telnyx/models/email_template.rb +68 -2
- data/lib/telnyx/models/email_template_create_params.rb +71 -1
- data/lib/telnyx/models/email_webhook_recipient.rb +39 -0
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/meeting_session.rb +34 -6
- data/lib/telnyx/models/meeting_session_create_params.rb +73 -39
- data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +77 -13
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +25 -1
- data/lib/telnyx/models/message_event.rb +41 -2
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/numbers_phone_number_detailed.rb +19 -5
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/private_wireless_gateway.rb +0 -1
- data/lib/telnyx/models/private_wireless_gateway_create_params.rb +28 -1
- data/lib/telnyx/models/private_wireless_gateway_create_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_delete_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_retrieve_response.rb +3 -3
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/call_retrieve_calls_params.rb +17 -17
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +129 -3
- data/lib/telnyx/models/text_to_speech_list_voices_params.rb +1 -0
- data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +1 -1
- data/lib/telnyx/models/update_email_template_request.rb +54 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models/wireless_private_wireless_gateway.rb +120 -0
- data/lib/telnyx/models.rb +28 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +2 -2
- data/lib/telnyx/resources/ai/assistants.rb +4 -4
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/memories.rb +122 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/sources.rb +163 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles.rb +244 -0
- data/lib/telnyx/resources/ai/memory/namespaces/settings.rb +76 -0
- data/lib/telnyx/resources/ai/memory/namespaces.rb +55 -0
- data/lib/telnyx/resources/ai/memory.rb +21 -0
- data/lib/telnyx/resources/ai/typesafe/v1.rb +71 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +8 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +5 -5
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +4 -0
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_blocks/imports.rb +17 -3
- data/lib/telnyx/resources/email_blocks.rb +5 -3
- data/lib/telnyx/resources/email_domains.rb +28 -0
- data/lib/telnyx/resources/email_events.rb +21 -9
- data/lib/telnyx/resources/email_messages.rb +61 -15
- data/lib/telnyx/resources/email_templates.rb +33 -3
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/meeting_sessions/actions.rb +7 -1
- data/lib/telnyx/resources/meeting_sessions/artifacts.rb +18 -9
- data/lib/telnyx/resources/meeting_sessions.rb +6 -5
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/private_wireless_gateways.rb +5 -3
- data/lib/telnyx/resources/texml/accounts/calls.rb +9 -9
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/text_to_speech.rb +6 -4
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +75 -1
- data/rbi/telnyx/client.rbi +35 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +24 -16
- data/rbi/telnyx/models/ai/assistant_tool.rbi +479 -25
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +50 -20
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +54 -20
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
- data/rbi/telnyx/models/ai/collection.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/collections_source.rbi +110 -0
- data/rbi/telnyx/models/ai/collections/source.rbi +36 -62
- data/rbi/telnyx/models/ai/collections/source_create_response.rbi +14 -6
- data/rbi/telnyx/models/ai/collections/source_list_response.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/source_replace_response.rbi +11 -4
- data/rbi/telnyx/models/ai/flow_node.rbi +12 -6
- data/rbi/telnyx/models/ai/flow_node_req.rbi +8 -4
- data/rbi/telnyx/models/ai/inference_embedding.rbi +32 -20
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_voice_settings.rbi +803 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +49 -19
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_response.rbi +167 -0
- data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +156 -0
- data/rbi/telnyx/models/ai/memory/namespaces/page_meta.rbi +81 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_response.rbi +97 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbi +149 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbi +113 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_response.rbi +48 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_params.rbi +68 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_response.rbi +109 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_params.rbi +57 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_response.rbi +107 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbi +119 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbi +102 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbi +72 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbi +70 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbi +129 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbi +117 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbi +92 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbi +209 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_list_params.rbi +49 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbi +125 -0
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +566 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +388 -0
- data/rbi/telnyx/models/ai/webhook_tool.rbi +23 -3
- data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +30 -0
- data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +20 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/soniox_voice_settings.rbi +86 -0
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +22 -5
- data/rbi/telnyx/models/conversation_relay_language.rbi +10 -5
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/email_block.rbi +8 -0
- data/rbi/telnyx/models/email_blocks/email_block_import.rbi +6 -2
- data/rbi/telnyx/models/email_domain_rotate_dkim_params.rbi +35 -0
- data/rbi/telnyx/models/email_domain_rotate_dkim_response.rbi +487 -0
- data/rbi/telnyx/models/email_domains/email_webhook_event.rbi +20 -3
- data/rbi/telnyx/models/email_event_list_params.rbi +46 -11
- data/rbi/telnyx/models/email_event_list_response.rbi +599 -97
- data/rbi/telnyx/models/email_event_type.rbi +25 -0
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +81 -3
- data/rbi/telnyx/models/email_message_batch_params.rbi +54 -20
- data/rbi/telnyx/models/email_message_create_params.rbi +80 -16
- data/rbi/telnyx/models/{email_message_retrieve_response.rbi → email_message_detail_response.rbi} +9 -16
- data/rbi/telnyx/models/email_message_list_params.rbi +40 -0
- data/rbi/telnyx/models/email_message_update_schedule_params.rbi +52 -0
- data/rbi/telnyx/models/email_messages/email_recipient.rbi +10 -0
- data/rbi/telnyx/models/email_messages/recipient_list_params.rbi +10 -0
- data/rbi/telnyx/models/email_template.rbi +84 -0
- data/rbi/telnyx/models/email_template_create_params.rbi +124 -0
- data/rbi/telnyx/models/email_webhook_recipient.rbi +68 -0
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/meeting_session.rbi +36 -10
- data/rbi/telnyx/models/meeting_session_create_params.rbi +112 -48
- data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +161 -24
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +30 -0
- data/rbi/telnyx/models/message_event.rbi +48 -1
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/numbers_phone_number_detailed.rbi +24 -4
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/private_wireless_gateway_create_params.rbi +71 -0
- data/rbi/telnyx/models/private_wireless_gateway_create_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_delete_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_retrieve_response.rbi +4 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/call_retrieve_calls_params.rbi +22 -22
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +311 -2
- data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +5 -0
- data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +5 -5
- data/rbi/telnyx/models/update_email_template_request.rbi +90 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models/wireless_private_wireless_gateway.rbi +211 -0
- data/rbi/telnyx/models.rbi +33 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +21 -8
- data/rbi/telnyx/resources/ai/assistants.rbi +27 -14
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/memories.rbi +94 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/sources.rbi +117 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles.rbi +196 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/settings.rbi +67 -0
- data/rbi/telnyx/resources/ai/memory/namespaces.rbi +37 -0
- data/rbi/telnyx/resources/ai/memory.rbi +18 -0
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +71 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +6 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +38 -9
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
- data/rbi/telnyx/resources/conferences/actions.rbi +8 -1
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_blocks/imports.rbi +17 -3
- data/rbi/telnyx/resources/email_blocks.rbi +5 -3
- data/rbi/telnyx/resources/email_domains.rbi +22 -0
- data/rbi/telnyx/resources/email_events.rbi +30 -9
- data/rbi/telnyx/resources/email_messages.rbi +104 -18
- data/rbi/telnyx/resources/email_templates.rbi +71 -0
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/meeting_sessions/actions.rbi +7 -1
- data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +19 -8
- data/rbi/telnyx/resources/meeting_sessions.rbi +15 -7
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/private_wireless_gateways.rbi +9 -1
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +6 -6
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/text_to_speech.rbi +7 -3
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/sig/telnyx/client.rbs +10 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistant_tool.rbs +195 -26
- data/sig/telnyx/models/ai/assistant_update_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +6 -6
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
- data/sig/telnyx/models/ai/collection.rbs +6 -6
- data/sig/telnyx/models/ai/collections/collections_source.rbs +65 -0
- data/sig/telnyx/models/ai/collections/source.rbs +18 -37
- data/sig/telnyx/models/ai/collections/source_create_response.rbs +9 -6
- data/sig/telnyx/models/ai/collections/source_list_response.rbs +8 -6
- data/sig/telnyx/models/ai/collections/source_replace_response.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node_req.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_voice_settings.rbs +308 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +20 -13
- data/sig/telnyx/models/ai/memory/namespace_retrieve_params.rbs +32 -0
- data/sig/telnyx/models/ai/memory/namespace_retrieve_response.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +59 -0
- data/sig/telnyx/models/ai/memory/namespaces/page_meta.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_response.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_params.rbs +42 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_response.rbs +22 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_params.rbs +47 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_response.rbs +53 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_params.rbs +38 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_response.rbs +49 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbs +63 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbs +43 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbs +65 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbs +55 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbs +92 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_list_params.rbs +29 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbs +47 -0
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +215 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +152 -0
- data/sig/telnyx/models/ai/webhook_tool.rbs +10 -3
- data/sig/telnyx/models/artifact_completed_webhook_event.rbs +16 -1
- data/sig/telnyx/models/artifact_failed_webhook_event.rbs +11 -1
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/soniox_voice_settings.rbs +46 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/conversation_relay_embedded_config.rbs +1 -0
- data/sig/telnyx/models/conversation_relay_language.rbs +1 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_params.rbs +23 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_response.rbs +195 -0
- data/sig/telnyx/models/email_domains/email_webhook_event.rbs +6 -0
- data/sig/telnyx/models/email_event_list_params.rbs +7 -7
- data/sig/telnyx/models/email_event_list_response.rbs +235 -59
- data/sig/telnyx/models/email_event_type.rbs +20 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +43 -4
- data/sig/telnyx/models/{email_message_retrieve_response.rbs → email_message_detail_response.rbs} +6 -10
- data/sig/telnyx/models/email_message_list_params.rbs +18 -1
- data/sig/telnyx/models/email_message_update_schedule_params.rbs +28 -0
- data/sig/telnyx/models/email_messages/email_recipient.rbs +4 -0
- data/sig/telnyx/models/email_messages/recipient_list_params.rbs +4 -0
- data/sig/telnyx/models/email_template.rbs +29 -0
- data/sig/telnyx/models/email_template_create_params.rbs +33 -0
- data/sig/telnyx/models/email_webhook_recipient.rbs +46 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/meeting_session.rbs +20 -5
- data/sig/telnyx/models/meeting_session_create_params.rbs +28 -20
- data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +53 -10
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +16 -1
- data/sig/telnyx/models/message_event.rbs +10 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/numbers_phone_number_detailed.rbs +5 -0
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/private_wireless_gateway_create_params.rbs +25 -1
- data/sig/telnyx/models/private_wireless_gateway_create_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_delete_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_retrieve_response.rbs +6 -6
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/call_retrieve_calls_params.rbs +14 -14
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +114 -0
- data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +2 -0
- data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +2 -2
- data/sig/telnyx/models/update_email_template_request.rbs +33 -0
- data/sig/telnyx/models/wireless_private_wireless_gateway.rbs +109 -0
- data/sig/telnyx/models.rbs +28 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -1
- data/sig/telnyx/resources/ai/assistants.rbs +2 -2
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/memories.rbs +32 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/sources.rbs +38 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles.rbs +59 -0
- data/sig/telnyx/resources/ai/memory/namespaces/settings.rbs +24 -0
- data/sig/telnyx/resources/ai/memory/namespaces.rbs +21 -0
- data/sig/telnyx/resources/ai/memory.rbs +11 -0
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +18 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +4 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +2 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/email_domains.rbs +5 -0
- data/sig/telnyx/resources/email_events.rbs +2 -2
- data/sig/telnyx/resources/email_messages.rbs +9 -1
- data/sig/telnyx/resources/email_templates.rbs +9 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +1 -1
- data/sig/telnyx/resources/meeting_sessions.rbs +1 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/private_wireless_gateways.rbs +2 -1
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- data/sig/telnyx/resources/text_to_speech.rbs +1 -0
- metadata +227 -5
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
# Agentic (bot) signup for Telnyx accounts. An AI agent solves a reverse-CAPTCHA
|
|
6
|
+
# challenge designed to be easy for LLMs and hard for humans, registers an
|
|
7
|
+
# account, and signs in by consuming a magic link emailed to the account owner.
|
|
8
|
+
# All endpoints are public and unauthenticated; signup endpoints are additionally
|
|
9
|
+
# gated by the freemium feature flags and per-country availability.
|
|
10
|
+
class BotSignup
|
|
11
|
+
# Creates a freemium Telnyx account through the agentic signup flow. The request
|
|
12
|
+
# must carry a valid answer to a previously issued bot challenge
|
|
13
|
+
# (`bot_challenge_nonce` and `bot_challenge_answer`), accept the terms of service,
|
|
14
|
+
# and echo the exact terms-and-conditions and privacy-policy URLs returned by the
|
|
15
|
+
# challenge endpoint. When EU consent enforcement is enabled,
|
|
16
|
+
# `terms_of_service_eu` and `terms_and_conditions_eu_url` are also required. On
|
|
17
|
+
# success a one-time sign-in (magic) link is emailed to the address provided; if
|
|
18
|
+
# the email address belongs to an existing account, a sign-in link is sent instead
|
|
19
|
+
# of creating a duplicate account. `email` may only be omitted when
|
|
20
|
+
# placeholder-email registration is enabled server-side. This endpoint is public
|
|
21
|
+
# and unauthenticated, gated by the freemium feature flags and per-country
|
|
22
|
+
# availability, and subject to per-IP and per-domain registration limits.
|
|
23
|
+
sig do
|
|
24
|
+
params(
|
|
25
|
+
bot_challenge_answer: String,
|
|
26
|
+
bot_challenge_nonce: String,
|
|
27
|
+
privacy_policy_url: String,
|
|
28
|
+
terms_and_conditions_url: String,
|
|
29
|
+
terms_of_service:
|
|
30
|
+
Telnyx::BotSignupCreateParams::TermsOfService::OrBoolean,
|
|
31
|
+
email: String,
|
|
32
|
+
terms_and_conditions_eu_url: String,
|
|
33
|
+
terms_of_service_eu:
|
|
34
|
+
Telnyx::BotSignupCreateParams::TermsOfServiceEu::OrBoolean,
|
|
35
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
36
|
+
).returns(Telnyx::SuccessResponse)
|
|
37
|
+
end
|
|
38
|
+
def create(
|
|
39
|
+
# Answer to the issued bot challenge.
|
|
40
|
+
bot_challenge_answer:,
|
|
41
|
+
# Nonce from a previously issued bot challenge.
|
|
42
|
+
bot_challenge_nonce:,
|
|
43
|
+
# Must exactly match the privacy-policy URL returned by the challenge endpoint.
|
|
44
|
+
privacy_policy_url:,
|
|
45
|
+
# Must exactly match the terms-and-conditions URL returned by the challenge
|
|
46
|
+
# endpoint.
|
|
47
|
+
terms_and_conditions_url:,
|
|
48
|
+
# Must be true to accept the terms of service.
|
|
49
|
+
terms_of_service:,
|
|
50
|
+
# Email address for the new account. The magic link is sent here. May only be
|
|
51
|
+
# omitted when placeholder-email registration is enabled server-side.
|
|
52
|
+
email: nil,
|
|
53
|
+
# EU terms-and-conditions URL. Required when EU consent enforcement is enabled.
|
|
54
|
+
terms_and_conditions_eu_url: nil,
|
|
55
|
+
# EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
|
|
56
|
+
terms_of_service_eu: nil,
|
|
57
|
+
request_options: {}
|
|
58
|
+
)
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# Resends the one-time sign-in (magic) link for an eligible bot signup account.
|
|
62
|
+
# Eligibility (account exists, was registered through bot signup, is active, and
|
|
63
|
+
# has not exceeded the resend limit or rate window) is evaluated server-side; the
|
|
64
|
+
# response is intentionally uniform and does not reveal whether the account exists
|
|
65
|
+
# or whether a link was actually sent. This endpoint is public and
|
|
66
|
+
# unauthenticated, gated by the freemium feature flags and per-country
|
|
67
|
+
# availability.
|
|
68
|
+
sig do
|
|
69
|
+
params(
|
|
70
|
+
email: String,
|
|
71
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
72
|
+
).returns(Telnyx::SuccessResponse)
|
|
73
|
+
end
|
|
74
|
+
def resend_magic_link(
|
|
75
|
+
# Email address of the bot signup account to resend the magic link to.
|
|
76
|
+
email:,
|
|
77
|
+
request_options: {}
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# @api private
|
|
82
|
+
sig { params(client: Telnyx::Client).returns(T.attached_class) }
|
|
83
|
+
def self.new(client:)
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
end
|
|
@@ -467,7 +467,8 @@ module Telnyx
|
|
|
467
467
|
Telnyx::Calls::AwsVoiceSettings::OrHash,
|
|
468
468
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
469
469
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
470
|
-
Telnyx::XaiVoiceSettings::OrHash
|
|
470
|
+
Telnyx::XaiVoiceSettings::OrHash,
|
|
471
|
+
Telnyx::Calls::SonioxVoiceSettings::OrHash
|
|
471
472
|
),
|
|
472
473
|
request_options: Telnyx::RequestOptions::OrHash
|
|
473
474
|
).returns(Telnyx::Models::Calls::ActionGatherUsingAIResponse)
|
|
@@ -547,6 +548,12 @@ module Telnyx
|
|
|
547
548
|
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
548
549
|
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
549
550
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
551
|
+
# - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
|
|
552
|
+
# Supported model: `tts-rt-v2`. Browse the catalog via the
|
|
553
|
+
# [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
|
|
554
|
+
# Every voice speaks all supported languages; set `language` to the two-letter
|
|
555
|
+
# ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
|
|
556
|
+
# `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
|
|
550
557
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
551
558
|
# `ara`, `rex`, `sal`, `leo`.
|
|
552
559
|
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
@@ -686,7 +693,8 @@ module Telnyx
|
|
|
686
693
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
687
694
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
688
695
|
Telnyx::InworldVoiceSettings::OrHash,
|
|
689
|
-
Telnyx::XaiVoiceSettings::OrHash
|
|
696
|
+
Telnyx::XaiVoiceSettings::OrHash,
|
|
697
|
+
Telnyx::Calls::SonioxVoiceSettings::OrHash
|
|
690
698
|
),
|
|
691
699
|
request_options: Telnyx::RequestOptions::OrHash
|
|
692
700
|
).returns(Telnyx::Models::Calls::ActionGatherUsingSpeakResponse)
|
|
@@ -740,6 +748,12 @@ module Telnyx
|
|
|
740
748
|
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
741
749
|
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
742
750
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
751
|
+
# - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
|
|
752
|
+
# Supported model: `tts-rt-v2`. Browse the catalog via the
|
|
753
|
+
# [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
|
|
754
|
+
# Every voice speaks all supported languages; set `language` to the two-letter
|
|
755
|
+
# ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
|
|
756
|
+
# `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
|
|
743
757
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
744
758
|
# `ara`, `rex`, `sal`, `leo`.
|
|
745
759
|
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
@@ -1208,7 +1222,8 @@ module Telnyx
|
|
|
1208
1222
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
1209
1223
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
1210
1224
|
Telnyx::InworldVoiceSettings::OrHash,
|
|
1211
|
-
Telnyx::XaiVoiceSettings::OrHash
|
|
1225
|
+
Telnyx::XaiVoiceSettings::OrHash,
|
|
1226
|
+
Telnyx::Calls::SonioxVoiceSettings::OrHash
|
|
1212
1227
|
),
|
|
1213
1228
|
request_options: Telnyx::RequestOptions::OrHash
|
|
1214
1229
|
).returns(Telnyx::Models::Calls::ActionSpeakResponse)
|
|
@@ -1262,6 +1277,12 @@ module Telnyx
|
|
|
1262
1277
|
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
1263
1278
|
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
1264
1279
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
1280
|
+
# - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
|
|
1281
|
+
# Supported model: `tts-rt-v2`. Browse the catalog via the
|
|
1282
|
+
# [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
|
|
1283
|
+
# Every voice speaks all supported languages; set `language` to the two-letter
|
|
1284
|
+
# ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
|
|
1285
|
+
# `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
|
|
1265
1286
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
1266
1287
|
# `ara`, `rex`, `sal`, `leo`.
|
|
1267
1288
|
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
@@ -1423,7 +1444,8 @@ module Telnyx
|
|
|
1423
1444
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
1424
1445
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
1425
1446
|
Telnyx::InworldVoiceSettings::OrHash,
|
|
1426
|
-
Telnyx::XaiVoiceSettings::OrHash
|
|
1447
|
+
Telnyx::XaiVoiceSettings::OrHash,
|
|
1448
|
+
Telnyx::Calls::SonioxVoiceSettings::OrHash
|
|
1427
1449
|
),
|
|
1428
1450
|
request_options: Telnyx::RequestOptions::OrHash
|
|
1429
1451
|
).returns(Telnyx::Models::Calls::ActionStartConversationRelayResponse)
|
|
@@ -1526,6 +1548,12 @@ module Telnyx
|
|
|
1526
1548
|
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
1527
1549
|
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
1528
1550
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
1551
|
+
# - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
|
|
1552
|
+
# Supported model: `tts-rt-v2`. Browse the catalog via the
|
|
1553
|
+
# [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
|
|
1554
|
+
# Every voice speaks all supported languages; set `language` to the two-letter
|
|
1555
|
+
# ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
|
|
1556
|
+
# `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
|
|
1529
1557
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
1530
1558
|
# `ara`, `rex`, `sal`, `leo`.
|
|
1531
1559
|
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
@@ -2374,11 +2402,12 @@ module Telnyx
|
|
|
2374
2402
|
command_id: nil,
|
|
2375
2403
|
# Custom headers to be added to the SIP INVITE.
|
|
2376
2404
|
custom_headers: nil,
|
|
2377
|
-
# The number
|
|
2378
|
-
#
|
|
2379
|
-
#
|
|
2380
|
-
#
|
|
2381
|
-
# you
|
|
2405
|
+
# The `to` number of an active inbound call, in +E164 format. Telnyx checks
|
|
2406
|
+
# whether there is currently an active inbound call where `to` matches this
|
|
2407
|
+
# `diversion` value and `from` matches the `from` number supplied for this
|
|
2408
|
+
# request. If such a call exists, the `from` number is treated as verified (since
|
|
2409
|
+
# it is already on an active inbound call to you) and can be used as the caller id
|
|
2410
|
+
# for this outbound call.
|
|
2382
2411
|
diversion: nil,
|
|
2383
2412
|
# If set to false, early media will not be passed to the originating leg.
|
|
2384
2413
|
early_media: nil,
|
|
@@ -198,11 +198,12 @@ module Telnyx
|
|
|
198
198
|
# webhook.
|
|
199
199
|
deepfake_detection: nil,
|
|
200
200
|
dialogflow_config: nil,
|
|
201
|
-
# The number
|
|
202
|
-
#
|
|
203
|
-
#
|
|
204
|
-
#
|
|
205
|
-
# you
|
|
201
|
+
# The `to` number of an active inbound call, in +E164 format. Telnyx checks
|
|
202
|
+
# whether there is currently an active inbound call where `to` matches this
|
|
203
|
+
# `diversion` value and `from` matches the `from` number supplied for this
|
|
204
|
+
# request. If such a call exists, the `from` number is treated as verified (since
|
|
205
|
+
# it is already on an active inbound call to you) and can be used as the caller id
|
|
206
|
+
# for this outbound call.
|
|
206
207
|
diversion: nil,
|
|
207
208
|
# Enables Dialogflow for the current call. The default value is false.
|
|
208
209
|
enable_dialogflow: nil,
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Compute
|
|
6
|
+
class Funcs
|
|
7
|
+
class Export
|
|
8
|
+
# Configures the external OTLP endpoint a function's runtime and/or invocation
|
|
9
|
+
# logs are pushed to as they happen. This operation is a **full replace, not a
|
|
10
|
+
# patch**: `endpoint`, `headers`, `runtime_export_enabled`, and
|
|
11
|
+
# `invocation_export_enabled` are all required on every call — omitting any of
|
|
12
|
+
# them is a 422, not "keep the current value". Headers are encrypted at rest and
|
|
13
|
+
# never returned in any response.
|
|
14
|
+
#
|
|
15
|
+
# The endpoint must be an HTTPS URL. When export is configured, new log records
|
|
16
|
+
# are converted to OTLP log records and delivered continuously; export never
|
|
17
|
+
# bypasses platform log storage, and delivery retries with a bounded policy while
|
|
18
|
+
# the destination is unreachable. Only logs generated after configuration are
|
|
19
|
+
# exported — there is no historical replay.
|
|
20
|
+
sig do
|
|
21
|
+
params(
|
|
22
|
+
id: String,
|
|
23
|
+
endpoint: String,
|
|
24
|
+
headers: T::Hash[Symbol, String],
|
|
25
|
+
invocation_export_enabled: T::Boolean,
|
|
26
|
+
runtime_export_enabled: T::Boolean,
|
|
27
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
28
|
+
).returns(Telnyx::Compute::Funcs::FuncLogExportConfigResponse)
|
|
29
|
+
end
|
|
30
|
+
def create(
|
|
31
|
+
# Function ID
|
|
32
|
+
id,
|
|
33
|
+
# HTTPS URL to push logs to
|
|
34
|
+
endpoint:,
|
|
35
|
+
# Headers attached to every export push, as key-value pairs (e.g. an auth token
|
|
36
|
+
# the collector expects). Required even when empty — {} means "no headers".
|
|
37
|
+
# Encrypted at rest; never returned.
|
|
38
|
+
headers:,
|
|
39
|
+
# Export invocation records (one per HTTP request) to this destination
|
|
40
|
+
invocation_export_enabled:,
|
|
41
|
+
# Export runtime logs (function stdout/stderr) to this destination
|
|
42
|
+
runtime_export_enabled:,
|
|
43
|
+
request_options: {}
|
|
44
|
+
)
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Returns the function's configured log export destination and which log types are
|
|
48
|
+
# exported. Headers are never returned. Returns 404 (error code 10005) when no
|
|
49
|
+
# destination is configured for the function.
|
|
50
|
+
sig do
|
|
51
|
+
params(
|
|
52
|
+
id: String,
|
|
53
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
54
|
+
).returns(Telnyx::Compute::Funcs::FuncLogExportConfigResponse)
|
|
55
|
+
end
|
|
56
|
+
def list(
|
|
57
|
+
# Function ID
|
|
58
|
+
id,
|
|
59
|
+
request_options: {}
|
|
60
|
+
)
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Stops exporting a function's logs and removes its destination configuration.
|
|
64
|
+
# Idempotent: deleting when nothing is configured succeeds.
|
|
65
|
+
sig do
|
|
66
|
+
params(
|
|
67
|
+
id: String,
|
|
68
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
69
|
+
).void
|
|
70
|
+
end
|
|
71
|
+
def delete_all(
|
|
72
|
+
# Function ID
|
|
73
|
+
id,
|
|
74
|
+
request_options: {}
|
|
75
|
+
)
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# @api private
|
|
79
|
+
sig { params(client: Telnyx::Client).returns(T.attached_class) }
|
|
80
|
+
def self.new(client:)
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
@@ -4,6 +4,9 @@ module Telnyx
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Compute
|
|
6
6
|
class Funcs
|
|
7
|
+
sig { returns(Telnyx::Resources::Compute::Funcs::Export) }
|
|
8
|
+
attr_reader :export
|
|
9
|
+
|
|
7
10
|
# Returns logs oldest first. `type=runtime` (default) returns function
|
|
8
11
|
# stdout/stderr. `type=invocations` returns one platform-generated record per HTTP
|
|
9
12
|
# request served.
|
|
@@ -534,7 +534,8 @@ module Telnyx
|
|
|
534
534
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
535
535
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
536
536
|
Telnyx::InworldVoiceSettings::OrHash,
|
|
537
|
-
Telnyx::XaiVoiceSettings::OrHash
|
|
537
|
+
Telnyx::XaiVoiceSettings::OrHash,
|
|
538
|
+
Telnyx::Calls::SonioxVoiceSettings::OrHash
|
|
538
539
|
),
|
|
539
540
|
request_options: Telnyx::RequestOptions::OrHash
|
|
540
541
|
).returns(Telnyx::Models::Conferences::ActionSpeakResponse)
|
|
@@ -588,6 +589,12 @@ module Telnyx
|
|
|
588
589
|
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
589
590
|
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
590
591
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
592
|
+
# - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
|
|
593
|
+
# Supported model: `tts-rt-v2`. Browse the catalog via the
|
|
594
|
+
# [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
|
|
595
|
+
# Every voice speaks all supported languages; set `language` to the two-letter
|
|
596
|
+
# ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
|
|
597
|
+
# `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
|
|
591
598
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
592
599
|
# `ara`, `rex`, `sal`, `leo`.
|
|
593
600
|
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
@@ -78,6 +78,17 @@ module Telnyx
|
|
|
78
78
|
)
|
|
79
79
|
end
|
|
80
80
|
|
|
81
|
+
# Returns the number of connections associated with the authenticated user,
|
|
82
|
+
# grouped by connection type, together with the connection limits that apply to
|
|
83
|
+
# the user. Forward-only connections are excluded from the counts.
|
|
84
|
+
sig do
|
|
85
|
+
params(request_options: Telnyx::RequestOptions::OrHash).returns(
|
|
86
|
+
Telnyx::Models::ConnectionRetrieveCountResponse
|
|
87
|
+
)
|
|
88
|
+
end
|
|
89
|
+
def retrieve_count(request_options: {})
|
|
90
|
+
end
|
|
91
|
+
|
|
81
92
|
# @api private
|
|
82
93
|
sig { params(client: Telnyx::Client).returns(T.attached_class) }
|
|
83
94
|
def self.new(client:)
|
|
@@ -21,10 +21,21 @@ module Telnyx
|
|
|
21
21
|
def list(
|
|
22
22
|
# Filter records on a given record attribute and value. <br/>Example:
|
|
23
23
|
# filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
|
|
24
|
+
# <br/>The valid filter fields depend on the record_type: filtering by a field
|
|
25
|
+
# that does not exist for the selected record_type is rejected with a 400 error.
|
|
26
|
+
# Call-control and sip-trunking records use started_at, finished_at and
|
|
27
|
+
# answered_at (they have no created_at); messaging records use created_at. To list
|
|
28
|
+
# the fields available for a record_type, use the /v2/detail_records/options
|
|
29
|
+
# endpoint.
|
|
24
30
|
filter: nil,
|
|
25
31
|
page_number: nil,
|
|
26
32
|
page_size: nil,
|
|
27
|
-
# Specifies the sort order for results. <br/>Example: sort=-created_at
|
|
33
|
+
# Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
|
|
34
|
+
# valid sort fields depend on the record_type: sort by a field that does not exist
|
|
35
|
+
# for the selected record_type is rejected with a 400 error. Call-control and
|
|
36
|
+
# sip-trunking records use started_at, finished_at and answered_at (they have no
|
|
37
|
+
# created_at); messaging records use created_at. To list the fields available for
|
|
38
|
+
# a record_type, use the /v2/detail_records/options endpoint.
|
|
28
39
|
sort: nil,
|
|
29
40
|
request_options: {}
|
|
30
41
|
)
|
|
@@ -13,9 +13,23 @@ module Telnyx
|
|
|
13
13
|
# - header-only / all-blank / undetectable provider → `400` Returns `202` with the
|
|
14
14
|
# import record (status `pending`); an Oban worker (`EmailBlockImportWorker`,
|
|
15
15
|
# max_attempts 3) transitions `pending → processing → completed | failed`.
|
|
16
|
-
#
|
|
17
|
-
#
|
|
18
|
-
#
|
|
16
|
+
#
|
|
17
|
+
# Native Telnyx exports are detected by the stable first-12-column header
|
|
18
|
+
# signature (`id` … `group_id`) and are restored with their original `from`,
|
|
19
|
+
# `domain_id`, `group_id`, `source`, `status`, `expires_at`, plus
|
|
20
|
+
# `bounce_category`, `dsn_code`, and `meta` when present (`scope` is re-derived
|
|
21
|
+
# from `domain_id`/`from`; the exported `scope` cell must be a valid enum value).
|
|
22
|
+
# Lifecycle changes reconcile through the same create path as the API: a row
|
|
23
|
+
# already in the requested state restores its mutable backup fields without a new
|
|
24
|
+
# audit event, and a real transition (e.g. tombstone → active) appends the
|
|
25
|
+
# matching lifecycle event. `block_ttl_days` is not applied to native rows — their
|
|
26
|
+
# exported `expires_at` is preserved verbatim.
|
|
27
|
+
#
|
|
28
|
+
# Competitor and generic imports (SendGrid / Mailgun / SES / generic) remain
|
|
29
|
+
# account-scoped (`from`, `domain_id`, `group_id`, `scope` are not read) and
|
|
30
|
+
# `block_ttl_days` applies only to imported `manual_block` rows; other reasons get
|
|
31
|
+
# `expires_at: nil`. Provider is auto-detected from the CSV header (`sendgrid` /
|
|
32
|
+
# `mailgun` / `ses` / `generic`).
|
|
19
33
|
sig do
|
|
20
34
|
params(
|
|
21
35
|
file: Telnyx::Internal::FileInput,
|
|
@@ -158,9 +158,11 @@ module Telnyx
|
|
|
158
158
|
# stream `ORDER BY created_at ASC, id ASC` with no pagination.
|
|
159
159
|
#
|
|
160
160
|
# CSV columns:
|
|
161
|
-
# `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id
|
|
162
|
-
#
|
|
163
|
-
#
|
|
161
|
+
# `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id,bounce_category,dsn_code, meta`
|
|
162
|
+
# (15 columns). The first 12 columns are the stable native signature;
|
|
163
|
+
# `bounce_category`, `dsn_code`, and `meta` are optional backup fields (empty when
|
|
164
|
+
# unset). The CSV carries the `group_id` column so group-scoped suppressions'
|
|
165
|
+
# group link survives the export (empty for account-scope rows).
|
|
164
166
|
sig do
|
|
165
167
|
params(
|
|
166
168
|
filter_created_after: Time,
|
|
@@ -167,6 +167,28 @@ module Telnyx
|
|
|
167
167
|
)
|
|
168
168
|
end
|
|
169
169
|
|
|
170
|
+
# Generates a new DKIM key for the domain, activates it, and retires the previous
|
|
171
|
+
# key. The response includes the updated DKIM DNS records the customer must
|
|
172
|
+
# publish. Selectors are fixed, so rotation replaces the TXT value at the existing
|
|
173
|
+
# `<selector>._domainkey.<domain>` host rather than adding a second record —
|
|
174
|
+
# `old_selector_retained` is false and the new TXT value must be published
|
|
175
|
+
# promptly, since signing switches to the new key immediately and the old TXT
|
|
176
|
+
# value will no longer match. The previous key is retired to a `retiring` state
|
|
177
|
+
# (retained, not revoked) so it can be revoked after the DNS propagation grace
|
|
178
|
+
# period.
|
|
179
|
+
sig do
|
|
180
|
+
params(
|
|
181
|
+
domain_id: String,
|
|
182
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
183
|
+
).returns(Telnyx::Models::EmailDomainRotateDkimResponse)
|
|
184
|
+
end
|
|
185
|
+
def rotate_dkim(
|
|
186
|
+
# Email domain UUID
|
|
187
|
+
domain_id,
|
|
188
|
+
request_options: {}
|
|
189
|
+
)
|
|
190
|
+
end
|
|
191
|
+
|
|
170
192
|
# Checks the published DNS records against the records required for the email
|
|
171
193
|
# domain and returns the latest verification results.
|
|
172
194
|
sig do
|
|
@@ -5,21 +5,30 @@ module Telnyx
|
|
|
5
5
|
# Retrieve account-level email events and event statistics.
|
|
6
6
|
class EmailEvents
|
|
7
7
|
# Lists account-level email events sorted oldest first by
|
|
8
|
-
# `occurred_at asc, id asc`.
|
|
8
|
+
# `occurred_at asc, id asc`. Each row contains a legacy email.-prefixed event_type
|
|
9
|
+
# and an additive canonical_event_type. Gateway rejection renders email.failed
|
|
10
|
+
# with canonical email.gw_reject; ambiguous injection timeout renders
|
|
11
|
+
# email.injection_timeout in both; MTA expiration renders email.bounced with
|
|
12
|
+
# canonical email.expired. Message-scoped queued, sending, sandbox, cancelled, and
|
|
13
|
+
# daily_limit_exceeded rows fan out per durable recipient with stable derived IDs
|
|
14
|
+
# matching webhook delivery. Scheduled is the cardinality exception: account
|
|
15
|
+
# polling retains one message-scoped scheduled row with its stored event ID, while
|
|
16
|
+
# scheduled webhook publication fans out per recipient with derived IDs; reconcile
|
|
17
|
+
# scheduled events by message ID, event type, and occurrence time rather than
|
|
18
|
+
# event UUID. Recipient-scoped stored rows retain their stored UUIDs across
|
|
19
|
+
# polling and webhook delivery. Legacy names are derived from stored rows; an
|
|
20
|
+
# AdminBounce row stored as failed renders email.failed in polling while its
|
|
21
|
+
# webhook retains email.bounced, both with canonical email.failed.
|
|
9
22
|
sig do
|
|
10
23
|
params(
|
|
11
24
|
email_id: String,
|
|
12
25
|
event_type: Telnyx::EmailEventListParams::EventType::Variants,
|
|
13
26
|
from: Time,
|
|
14
|
-
page_cursor: String,
|
|
15
27
|
page_size: Integer,
|
|
28
|
+
page_cursor: String,
|
|
16
29
|
to: Time,
|
|
17
30
|
request_options: Telnyx::RequestOptions::OrHash
|
|
18
|
-
).returns(
|
|
19
|
-
Telnyx::Internal::EmailCursorPagination[
|
|
20
|
-
Telnyx::Models::EmailEventListResponse
|
|
21
|
-
]
|
|
22
|
-
)
|
|
31
|
+
).returns(Telnyx::Models::EmailEventListResponse)
|
|
23
32
|
end
|
|
24
33
|
def list(
|
|
25
34
|
# Filter events for a specific email message UUID. Invalid UUID values are
|
|
@@ -28,14 +37,26 @@ module Telnyx
|
|
|
28
37
|
# Comma-separated list of event types to include. Also accepts repeated query
|
|
29
38
|
# parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
|
|
30
39
|
# no matches.
|
|
40
|
+
#
|
|
41
|
+
# Dual-name compatibility: values are accepted bare or `email.`-prefixed. A legacy
|
|
42
|
+
# value keeps matching the rows it matched pre-rename — no widening: `failed` also
|
|
43
|
+
# matches the rows that now store the canonical names of the outcomes it covered
|
|
44
|
+
# (`gw_reject`, `injection_timeout`, `expired`); `bounced` matches stored
|
|
45
|
+
# `bounced` rows only (recipient-scoped Expirations stored `failed` pre-rename and
|
|
46
|
+
# never matched `bounced`, so `expired` is deliberately not a `bounced`
|
|
47
|
+
# expansion). A canonical value matches its own rows plus legacy rows whose
|
|
48
|
+
# recorded payload evidence proves that outcome (`expired` also surfaces legacy
|
|
49
|
+
# `bounced` rows with `bounce_category: transient`). The additive
|
|
50
|
+
# `canonical_event_type` field in each response row names the canonical outcome.
|
|
31
51
|
event_type: nil,
|
|
32
52
|
# Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
33
53
|
from: nil,
|
|
34
|
-
# Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
35
|
-
page_cursor: nil,
|
|
36
54
|
# Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
37
55
|
# clamped to the valid range.
|
|
38
56
|
page_size: nil,
|
|
57
|
+
# Opaque URL-safe Base64 cursor returned by a previous event list response. The
|
|
58
|
+
# legacy `page[after]` and flat `page_cursor` forms are also accepted.
|
|
59
|
+
page_cursor: nil,
|
|
39
60
|
# Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
40
61
|
# to `from + 30 days`.
|
|
41
62
|
to: nil,
|