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,97 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
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
|
+
# Some parameter documentations has been truncated, see
|
|
12
|
+
# {Telnyx::Models::BotSignupCreateParams} for more details.
|
|
13
|
+
#
|
|
14
|
+
# Creates a freemium Telnyx account through the agentic signup flow. The request
|
|
15
|
+
# must carry a valid answer to a previously issued bot challenge
|
|
16
|
+
# (`bot_challenge_nonce` and `bot_challenge_answer`), accept the terms of service,
|
|
17
|
+
# and echo the exact terms-and-conditions and privacy-policy URLs returned by the
|
|
18
|
+
# challenge endpoint. When EU consent enforcement is enabled,
|
|
19
|
+
# `terms_of_service_eu` and `terms_and_conditions_eu_url` are also required. On
|
|
20
|
+
# success a one-time sign-in (magic) link is emailed to the address provided; if
|
|
21
|
+
# the email address belongs to an existing account, a sign-in link is sent instead
|
|
22
|
+
# of creating a duplicate account. `email` may only be omitted when
|
|
23
|
+
# placeholder-email registration is enabled server-side. This endpoint is public
|
|
24
|
+
# and unauthenticated, gated by the freemium feature flags and per-country
|
|
25
|
+
# availability, and subject to per-IP and per-domain registration limits.
|
|
26
|
+
#
|
|
27
|
+
# @overload create(bot_challenge_answer:, bot_challenge_nonce:, privacy_policy_url:, terms_and_conditions_url:, terms_of_service:, email: nil, terms_and_conditions_eu_url: nil, terms_of_service_eu: nil, request_options: {})
|
|
28
|
+
#
|
|
29
|
+
# @param bot_challenge_answer [String] Answer to the issued bot challenge.
|
|
30
|
+
#
|
|
31
|
+
# @param bot_challenge_nonce [String] Nonce from a previously issued bot challenge.
|
|
32
|
+
#
|
|
33
|
+
# @param privacy_policy_url [String] Must exactly match the privacy-policy URL returned by the challenge endpoint.
|
|
34
|
+
#
|
|
35
|
+
# @param terms_and_conditions_url [String] Must exactly match the terms-and-conditions URL returned by the challenge endpoi
|
|
36
|
+
#
|
|
37
|
+
# @param terms_of_service [Boolean, Telnyx::Models::BotSignupCreateParams::TermsOfService] Must be true to accept the terms of service.
|
|
38
|
+
#
|
|
39
|
+
# @param email [String] Email address for the new account. The magic link is sent here. May only be omit
|
|
40
|
+
#
|
|
41
|
+
# @param terms_and_conditions_eu_url [String] EU terms-and-conditions URL. Required when EU consent enforcement is enabled.
|
|
42
|
+
#
|
|
43
|
+
# @param terms_of_service_eu [Boolean, Telnyx::Models::BotSignupCreateParams::TermsOfServiceEu] EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
|
|
44
|
+
#
|
|
45
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
46
|
+
#
|
|
47
|
+
# @return [Telnyx::Models::SuccessResponse]
|
|
48
|
+
#
|
|
49
|
+
# @see Telnyx::Models::BotSignupCreateParams
|
|
50
|
+
def create(params)
|
|
51
|
+
parsed, options = Telnyx::BotSignupCreateParams.dump_request(params)
|
|
52
|
+
@client.request(
|
|
53
|
+
method: :post,
|
|
54
|
+
path: "v2/bot_signup",
|
|
55
|
+
body: parsed,
|
|
56
|
+
model: Telnyx::SuccessResponse,
|
|
57
|
+
options: 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
|
+
#
|
|
69
|
+
# @overload resend_magic_link(email:, request_options: {})
|
|
70
|
+
#
|
|
71
|
+
# @param email [String] Email address of the bot signup account to resend the magic link to.
|
|
72
|
+
#
|
|
73
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
|
+
#
|
|
75
|
+
# @return [Telnyx::Models::SuccessResponse]
|
|
76
|
+
#
|
|
77
|
+
# @see Telnyx::Models::BotSignupResendMagicLinkParams
|
|
78
|
+
def resend_magic_link(params)
|
|
79
|
+
parsed, options = Telnyx::BotSignupResendMagicLinkParams.dump_request(params)
|
|
80
|
+
@client.request(
|
|
81
|
+
method: :post,
|
|
82
|
+
path: "v2/bot_signup/resend_magic_link",
|
|
83
|
+
body: parsed,
|
|
84
|
+
model: Telnyx::SuccessResponse,
|
|
85
|
+
options: options
|
|
86
|
+
)
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# @api private
|
|
90
|
+
#
|
|
91
|
+
# @param client [Telnyx::Client]
|
|
92
|
+
def initialize(client:)
|
|
93
|
+
@client = client
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|
|
@@ -352,7 +352,7 @@ module Telnyx
|
|
|
352
352
|
#
|
|
353
353
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
354
354
|
#
|
|
355
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
355
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
|
|
356
356
|
#
|
|
357
357
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
358
358
|
#
|
|
@@ -485,7 +485,7 @@ module Telnyx
|
|
|
485
485
|
#
|
|
486
486
|
# @param valid_digits [String] A list of all digits accepted as valid.
|
|
487
487
|
#
|
|
488
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
488
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
|
|
489
489
|
#
|
|
490
490
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
491
491
|
#
|
|
@@ -947,7 +947,7 @@ module Telnyx
|
|
|
947
947
|
#
|
|
948
948
|
# @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
|
|
949
949
|
#
|
|
950
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
950
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
|
|
951
951
|
#
|
|
952
952
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
953
953
|
#
|
|
@@ -1076,7 +1076,7 @@ module Telnyx
|
|
|
1076
1076
|
#
|
|
1077
1077
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
1078
1078
|
#
|
|
1079
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
1079
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
|
|
1080
1080
|
#
|
|
1081
1081
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
1082
1082
|
#
|
|
@@ -1836,7 +1836,7 @@ module Telnyx
|
|
|
1836
1836
|
#
|
|
1837
1837
|
# @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP INVITE.
|
|
1838
1838
|
#
|
|
1839
|
-
# @param diversion [String] The number
|
|
1839
|
+
# @param diversion [String] The `to` number of an active inbound call, in +E164 format. Telnyx checks whethe
|
|
1840
1840
|
#
|
|
1841
1841
|
# @param early_media [Boolean] If set to false, early media will not be passed to the originating leg.
|
|
1842
1842
|
#
|
|
@@ -71,7 +71,7 @@ module Telnyx
|
|
|
71
71
|
#
|
|
72
72
|
# @param dialogflow_config [Telnyx::Models::DialogflowConfig]
|
|
73
73
|
#
|
|
74
|
-
# @param diversion [String] The number
|
|
74
|
+
# @param diversion [String] The `to` number of an active inbound call, in +E164 format. Telnyx checks whethe
|
|
75
75
|
#
|
|
76
76
|
# @param enable_dialogflow [Boolean] Enables Dialogflow for the current call. The default value is false.
|
|
77
77
|
#
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Compute
|
|
6
|
+
class Funcs
|
|
7
|
+
class Export
|
|
8
|
+
# Some parameter documentations has been truncated, see
|
|
9
|
+
# {Telnyx::Models::Compute::Funcs::ExportCreateParams} for more details.
|
|
10
|
+
#
|
|
11
|
+
# Configures the external OTLP endpoint a function's runtime and/or invocation
|
|
12
|
+
# logs are pushed to as they happen. This operation is a **full replace, not a
|
|
13
|
+
# patch**: `endpoint`, `headers`, `runtime_export_enabled`, and
|
|
14
|
+
# `invocation_export_enabled` are all required on every call — omitting any of
|
|
15
|
+
# them is a 422, not "keep the current value". Headers are encrypted at rest and
|
|
16
|
+
# never returned in any response.
|
|
17
|
+
#
|
|
18
|
+
# The endpoint must be an HTTPS URL. When export is configured, new log records
|
|
19
|
+
# are converted to OTLP log records and delivered continuously; export never
|
|
20
|
+
# bypasses platform log storage, and delivery retries with a bounded policy while
|
|
21
|
+
# the destination is unreachable. Only logs generated after configuration are
|
|
22
|
+
# exported — there is no historical replay.
|
|
23
|
+
#
|
|
24
|
+
# @overload create(id, endpoint:, headers:, invocation_export_enabled:, runtime_export_enabled:, request_options: {})
|
|
25
|
+
#
|
|
26
|
+
# @param id [String] Function ID
|
|
27
|
+
#
|
|
28
|
+
# @param endpoint [String] HTTPS URL to push logs to
|
|
29
|
+
#
|
|
30
|
+
# @param headers [Hash{Symbol=>String}] Headers attached to every export push, as key-value pairs (e.g. an auth token th
|
|
31
|
+
#
|
|
32
|
+
# @param invocation_export_enabled [Boolean] Export invocation records (one per HTTP request) to this destination
|
|
33
|
+
#
|
|
34
|
+
# @param runtime_export_enabled [Boolean] Export runtime logs (function stdout/stderr) to this destination
|
|
35
|
+
#
|
|
36
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
37
|
+
#
|
|
38
|
+
# @return [Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse]
|
|
39
|
+
#
|
|
40
|
+
# @see Telnyx::Models::Compute::Funcs::ExportCreateParams
|
|
41
|
+
def create(id, params)
|
|
42
|
+
parsed, options = Telnyx::Compute::Funcs::ExportCreateParams.dump_request(params)
|
|
43
|
+
@client.request(
|
|
44
|
+
method: :put,
|
|
45
|
+
path: ["compute/funcs/%1$s/logs/export", id],
|
|
46
|
+
body: parsed,
|
|
47
|
+
model: Telnyx::Compute::Funcs::FuncLogExportConfigResponse,
|
|
48
|
+
options: options
|
|
49
|
+
)
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Returns the function's configured log export destination and which log types are
|
|
53
|
+
# exported. Headers are never returned. Returns 404 (error code 10005) when no
|
|
54
|
+
# destination is configured for the function.
|
|
55
|
+
#
|
|
56
|
+
# @overload list(id, request_options: {})
|
|
57
|
+
#
|
|
58
|
+
# @param id [String] Function ID
|
|
59
|
+
#
|
|
60
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
61
|
+
#
|
|
62
|
+
# @return [Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse]
|
|
63
|
+
#
|
|
64
|
+
# @see Telnyx::Models::Compute::Funcs::ExportListParams
|
|
65
|
+
def list(id, params = {})
|
|
66
|
+
@client.request(
|
|
67
|
+
method: :get,
|
|
68
|
+
path: ["compute/funcs/%1$s/logs/export", id],
|
|
69
|
+
model: Telnyx::Compute::Funcs::FuncLogExportConfigResponse,
|
|
70
|
+
options: params[:request_options]
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Stops exporting a function's logs and removes its destination configuration.
|
|
75
|
+
# Idempotent: deleting when nothing is configured succeeds.
|
|
76
|
+
#
|
|
77
|
+
# @overload delete_all(id, request_options: {})
|
|
78
|
+
#
|
|
79
|
+
# @param id [String] Function ID
|
|
80
|
+
#
|
|
81
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
82
|
+
#
|
|
83
|
+
# @return [nil]
|
|
84
|
+
#
|
|
85
|
+
# @see Telnyx::Models::Compute::Funcs::ExportDeleteAllParams
|
|
86
|
+
def delete_all(id, params = {})
|
|
87
|
+
@client.request(
|
|
88
|
+
method: :delete,
|
|
89
|
+
path: ["compute/funcs/%1$s/logs/export", id],
|
|
90
|
+
model: NilClass,
|
|
91
|
+
options: params[:request_options]
|
|
92
|
+
)
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# @api private
|
|
96
|
+
#
|
|
97
|
+
# @param client [Telnyx::Client]
|
|
98
|
+
def initialize(client:)
|
|
99
|
+
@client = client
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
@@ -4,6 +4,9 @@ module Telnyx
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Compute
|
|
6
6
|
class Funcs
|
|
7
|
+
# @return [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.
|
|
@@ -134,6 +137,7 @@ module Telnyx
|
|
|
134
137
|
# @param client [Telnyx::Client]
|
|
135
138
|
def initialize(client:)
|
|
136
139
|
@client = client
|
|
140
|
+
@export = Telnyx::Resources::Compute::Funcs::Export.new(client: client)
|
|
137
141
|
end
|
|
138
142
|
end
|
|
139
143
|
end
|
|
@@ -522,7 +522,7 @@ module Telnyx
|
|
|
522
522
|
#
|
|
523
523
|
# @param region [Symbol, Telnyx::Models::Conferences::ConferenceRegion] Region where the conference data is located. Defaults to the region defined in u
|
|
524
524
|
#
|
|
525
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
525
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
|
|
526
526
|
#
|
|
527
527
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
528
528
|
#
|
|
@@ -88,6 +88,26 @@ module Telnyx
|
|
|
88
88
|
)
|
|
89
89
|
end
|
|
90
90
|
|
|
91
|
+
# Returns the number of connections associated with the authenticated user,
|
|
92
|
+
# grouped by connection type, together with the connection limits that apply to
|
|
93
|
+
# the user. Forward-only connections are excluded from the counts.
|
|
94
|
+
#
|
|
95
|
+
# @overload retrieve_count(request_options: {})
|
|
96
|
+
#
|
|
97
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
98
|
+
#
|
|
99
|
+
# @return [Telnyx::Models::ConnectionRetrieveCountResponse]
|
|
100
|
+
#
|
|
101
|
+
# @see Telnyx::Models::ConnectionRetrieveCountParams
|
|
102
|
+
def retrieve_count(params = {})
|
|
103
|
+
@client.request(
|
|
104
|
+
method: :get,
|
|
105
|
+
path: "connections/count",
|
|
106
|
+
model: Telnyx::Models::ConnectionRetrieveCountResponse,
|
|
107
|
+
options: params[:request_options]
|
|
108
|
+
)
|
|
109
|
+
end
|
|
110
|
+
|
|
91
111
|
# @api private
|
|
92
112
|
#
|
|
93
113
|
# @param client [Telnyx::Client]
|
|
@@ -17,7 +17,7 @@ module Telnyx
|
|
|
17
17
|
#
|
|
18
18
|
# @param page_size [Integer]
|
|
19
19
|
#
|
|
20
|
-
# @param sort [Array<String>] Specifies the sort order for results. <br/>Example: sort=-created_at
|
|
20
|
+
# @param sort [Array<String>] Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The va
|
|
21
21
|
#
|
|
22
22
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
23
23
|
#
|
|
@@ -16,9 +16,23 @@ module Telnyx
|
|
|
16
16
|
# - header-only / all-blank / undetectable provider → `400` Returns `202` with the
|
|
17
17
|
# import record (status `pending`); an Oban worker (`EmailBlockImportWorker`,
|
|
18
18
|
# max_attempts 3) transitions `pending → processing → completed | failed`.
|
|
19
|
-
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
19
|
+
#
|
|
20
|
+
# Native Telnyx exports are detected by the stable first-12-column header
|
|
21
|
+
# signature (`id` … `group_id`) and are restored with their original `from`,
|
|
22
|
+
# `domain_id`, `group_id`, `source`, `status`, `expires_at`, plus
|
|
23
|
+
# `bounce_category`, `dsn_code`, and `meta` when present (`scope` is re-derived
|
|
24
|
+
# from `domain_id`/`from`; the exported `scope` cell must be a valid enum value).
|
|
25
|
+
# Lifecycle changes reconcile through the same create path as the API: a row
|
|
26
|
+
# already in the requested state restores its mutable backup fields without a new
|
|
27
|
+
# audit event, and a real transition (e.g. tombstone → active) appends the
|
|
28
|
+
# matching lifecycle event. `block_ttl_days` is not applied to native rows — their
|
|
29
|
+
# exported `expires_at` is preserved verbatim.
|
|
30
|
+
#
|
|
31
|
+
# Competitor and generic imports (SendGrid / Mailgun / SES / generic) remain
|
|
32
|
+
# account-scoped (`from`, `domain_id`, `group_id`, `scope` are not read) and
|
|
33
|
+
# `block_ttl_days` applies only to imported `manual_block` rows; other reasons get
|
|
34
|
+
# `expires_at: nil`. Provider is auto-detected from the CSV header (`sendgrid` /
|
|
35
|
+
# `mailgun` / `ses` / `generic`).
|
|
22
36
|
#
|
|
23
37
|
# @overload create(file:, block_ttl_days: nil, request_options: {})
|
|
24
38
|
#
|
|
@@ -194,9 +194,11 @@ module Telnyx
|
|
|
194
194
|
# stream `ORDER BY created_at ASC, id ASC` with no pagination.
|
|
195
195
|
#
|
|
196
196
|
# CSV columns:
|
|
197
|
-
# `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id
|
|
198
|
-
#
|
|
199
|
-
#
|
|
197
|
+
# `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id,bounce_category,dsn_code, meta`
|
|
198
|
+
# (15 columns). The first 12 columns are the stable native signature;
|
|
199
|
+
# `bounce_category`, `dsn_code`, and `meta` are optional backup fields (empty when
|
|
200
|
+
# unset). The CSV carries the `group_id` column so group-scoped suppressions'
|
|
201
|
+
# group link survives the export (empty for account-scope rows).
|
|
200
202
|
#
|
|
201
203
|
# @overload retrieve_export(filter_created_after: nil, filter_created_before: nil, filter_domain_id: nil, filter_reason: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
|
|
202
204
|
#
|
|
@@ -221,6 +221,34 @@ module Telnyx
|
|
|
221
221
|
)
|
|
222
222
|
end
|
|
223
223
|
|
|
224
|
+
# Generates a new DKIM key for the domain, activates it, and retires the previous
|
|
225
|
+
# key. The response includes the updated DKIM DNS records the customer must
|
|
226
|
+
# publish. Selectors are fixed, so rotation replaces the TXT value at the existing
|
|
227
|
+
# `<selector>._domainkey.<domain>` host rather than adding a second record —
|
|
228
|
+
# `old_selector_retained` is false and the new TXT value must be published
|
|
229
|
+
# promptly, since signing switches to the new key immediately and the old TXT
|
|
230
|
+
# value will no longer match. The previous key is retired to a `retiring` state
|
|
231
|
+
# (retained, not revoked) so it can be revoked after the DNS propagation grace
|
|
232
|
+
# period.
|
|
233
|
+
#
|
|
234
|
+
# @overload rotate_dkim(domain_id, request_options: {})
|
|
235
|
+
#
|
|
236
|
+
# @param domain_id [String] Email domain UUID
|
|
237
|
+
#
|
|
238
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
239
|
+
#
|
|
240
|
+
# @return [Telnyx::Models::EmailDomainRotateDkimResponse]
|
|
241
|
+
#
|
|
242
|
+
# @see Telnyx::Models::EmailDomainRotateDkimParams
|
|
243
|
+
def rotate_dkim(domain_id, params = {})
|
|
244
|
+
@client.request(
|
|
245
|
+
method: :post,
|
|
246
|
+
path: ["email_domains/%1$s/rotate_dkim", domain_id],
|
|
247
|
+
model: Telnyx::Models::EmailDomainRotateDkimResponse,
|
|
248
|
+
options: params[:request_options]
|
|
249
|
+
)
|
|
250
|
+
end
|
|
251
|
+
|
|
224
252
|
# Checks the published DNS records against the records required for the email
|
|
225
253
|
# domain and returns the latest verification results.
|
|
226
254
|
#
|
|
@@ -8,25 +8,38 @@ module Telnyx
|
|
|
8
8
|
# {Telnyx::Models::EmailEventListParams} for more details.
|
|
9
9
|
#
|
|
10
10
|
# Lists account-level email events sorted oldest first by
|
|
11
|
-
# `occurred_at asc, id asc`.
|
|
12
|
-
#
|
|
13
|
-
#
|
|
11
|
+
# `occurred_at asc, id asc`. Each row contains a legacy email.-prefixed event_type
|
|
12
|
+
# and an additive canonical_event_type. Gateway rejection renders email.failed
|
|
13
|
+
# with canonical email.gw_reject; ambiguous injection timeout renders
|
|
14
|
+
# email.injection_timeout in both; MTA expiration renders email.bounced with
|
|
15
|
+
# canonical email.expired. Message-scoped queued, sending, sandbox, cancelled, and
|
|
16
|
+
# daily_limit_exceeded rows fan out per durable recipient with stable derived IDs
|
|
17
|
+
# matching webhook delivery. Scheduled is the cardinality exception: account
|
|
18
|
+
# polling retains one message-scoped scheduled row with its stored event ID, while
|
|
19
|
+
# scheduled webhook publication fans out per recipient with derived IDs; reconcile
|
|
20
|
+
# scheduled events by message ID, event type, and occurrence time rather than
|
|
21
|
+
# event UUID. Recipient-scoped stored rows retain their stored UUIDs across
|
|
22
|
+
# polling and webhook delivery. Legacy names are derived from stored rows; an
|
|
23
|
+
# AdminBounce row stored as failed renders email.failed in polling while its
|
|
24
|
+
# webhook retains email.bounced, both with canonical email.failed.
|
|
25
|
+
#
|
|
26
|
+
# @overload list(email_id: nil, event_type: nil, from: nil, page_size: nil, page_cursor: nil, to: nil, request_options: {})
|
|
14
27
|
#
|
|
15
28
|
# @param email_id [String] Filter events for a specific email message UUID. Invalid UUID values are silentl
|
|
16
29
|
#
|
|
17
|
-
# @param event_type [String, Array<String>] Comma-separated list of event types to include. Also accepts repeated
|
|
30
|
+
# @param event_type [String, Array<String>] Comma-separated list of event types to include. Also accepts repeated
|
|
18
31
|
#
|
|
19
32
|
# @param from [Time] Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
|
|
20
33
|
#
|
|
21
|
-
# @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
22
|
-
#
|
|
23
34
|
# @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
24
35
|
#
|
|
36
|
+
# @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous event list response. The le
|
|
37
|
+
#
|
|
25
38
|
# @param to [Time] Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
|
|
26
39
|
#
|
|
27
40
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
41
|
#
|
|
29
|
-
# @return [Telnyx::
|
|
42
|
+
# @return [Telnyx::Models::EmailEventListResponse]
|
|
30
43
|
#
|
|
31
44
|
# @see Telnyx::Models::EmailEventListParams
|
|
32
45
|
def list(params = {})
|
|
@@ -35,8 +48,7 @@ module Telnyx
|
|
|
35
48
|
@client.request(
|
|
36
49
|
method: :get,
|
|
37
50
|
path: "email_events",
|
|
38
|
-
query: query,
|
|
39
|
-
page: Telnyx::Internal::EmailCursorPagination,
|
|
51
|
+
query: query.transform_keys(page_cursor: "page[cursor]"),
|
|
40
52
|
model: Telnyx::Models::EmailEventListResponse,
|
|
41
53
|
options: options
|
|
42
54
|
)
|
|
@@ -50,21 +50,21 @@ module Telnyx
|
|
|
50
50
|
#
|
|
51
51
|
# @param inline_css [Boolean] Body param
|
|
52
52
|
#
|
|
53
|
-
# @param metadata [Hash{Symbol=>Object}] Body param: Custom metadata.
|
|
53
|
+
# @param metadata [Hash{Symbol=>Object}] Body param: Custom metadata key/value pairs. Stored on the message, returned on
|
|
54
54
|
#
|
|
55
55
|
# @param reply_to [String, Telnyx::Models::EmailInboxes::EmailAddress] Body param: Reply-to address. If provided as an object with a name, only the ema
|
|
56
56
|
#
|
|
57
57
|
# @param reply_to_all [Boolean, nil] Body param: Indicates a reply-all intent. In Phase 1 (wire-only) this does not
|
|
58
58
|
#
|
|
59
|
-
# @param sandbox_mode [Boolean] Body param
|
|
59
|
+
# @param sandbox_mode [Boolean] Body param: Validates and accepts the message without injecting it into the MTA
|
|
60
60
|
#
|
|
61
|
-
# @param scheduled_at [Time, nil] Body param: Future ISO 8601 time
|
|
61
|
+
# @param scheduled_at [Time, nil] Body param: Future ISO 8601 delivery time. Invalid or non-future timestamps are
|
|
62
62
|
#
|
|
63
63
|
# @param send_at [Time] Body param: Deprecated alias for `scheduled_at`.
|
|
64
64
|
#
|
|
65
65
|
# @param subject [String] Body param: Required unless `template_id` is supplied. When using a template, th
|
|
66
66
|
#
|
|
67
|
-
# @param tags [Array<String>] Body param: Tags for categorization and
|
|
67
|
+
# @param tags [Array<String>] Body param: Tags for categorization and filtering. Stored on the message, return
|
|
68
68
|
#
|
|
69
69
|
# @param template_id [String] Body param
|
|
70
70
|
#
|
|
@@ -103,14 +103,14 @@ module Telnyx
|
|
|
103
103
|
#
|
|
104
104
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
105
105
|
#
|
|
106
|
-
# @return [Telnyx::Models::
|
|
106
|
+
# @return [Telnyx::Models::EmailMessageDetailResponse]
|
|
107
107
|
#
|
|
108
108
|
# @see Telnyx::Models::EmailMessageRetrieveParams
|
|
109
109
|
def retrieve(id, params = {})
|
|
110
110
|
@client.request(
|
|
111
111
|
method: :get,
|
|
112
112
|
path: ["email_messages/%1$s", id],
|
|
113
|
-
model: Telnyx::
|
|
113
|
+
model: Telnyx::EmailMessageDetailResponse,
|
|
114
114
|
options: params[:request_options]
|
|
115
115
|
)
|
|
116
116
|
end
|
|
@@ -118,11 +118,15 @@ module Telnyx
|
|
|
118
118
|
# Some parameter documentations has been truncated, see
|
|
119
119
|
# {Telnyx::Models::EmailMessageListParams} for more details.
|
|
120
120
|
#
|
|
121
|
-
# Lists messages sorted newest first by `created_at desc, id desc`.
|
|
122
|
-
#
|
|
123
|
-
# is a backward-compatible alias for this operation.
|
|
121
|
+
# Lists messages sorted newest first by `created_at desc, id desc`. Tags and
|
|
122
|
+
# metadata filters compose with cursor pagination. The legacy `/v2/emails` GET
|
|
123
|
+
# route is a backward-compatible alias for this operation.
|
|
124
124
|
#
|
|
125
|
-
# @overload list(page_cursor: nil, page_size: nil, request_options: {})
|
|
125
|
+
# @overload list(filter_metadata: nil, filter_tags: nil, page_cursor: nil, page_size: nil, request_options: {})
|
|
126
|
+
#
|
|
127
|
+
# @param filter_metadata [String] Metadata containment filter, supplied as a JSON object or comma-separated `key=v
|
|
128
|
+
#
|
|
129
|
+
# @param filter_tags [String] Comma-separated tags. Each segment is trimmed, and messages having at least one
|
|
126
130
|
#
|
|
127
131
|
# @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
128
132
|
#
|
|
@@ -139,7 +143,7 @@ module Telnyx
|
|
|
139
143
|
@client.request(
|
|
140
144
|
method: :get,
|
|
141
145
|
path: "email_messages",
|
|
142
|
-
query: query,
|
|
146
|
+
query: query.transform_keys(filter_metadata: "filter[metadata]", filter_tags: "filter[tags]"),
|
|
143
147
|
page: Telnyx::Internal::EmailCursorPagination,
|
|
144
148
|
model: Telnyx::EmailInboxes::EmailMessage,
|
|
145
149
|
options: options
|
|
@@ -172,15 +176,20 @@ module Telnyx
|
|
|
172
176
|
# Some parameter documentations has been truncated, see
|
|
173
177
|
# {Telnyx::Models::EmailMessageBatchParams} for more details.
|
|
174
178
|
#
|
|
175
|
-
# Creates up to 1,000 email messages in a single request.
|
|
176
|
-
#
|
|
177
|
-
#
|
|
179
|
+
# Creates up to 1,000 email messages in a single request. Request-wide admission
|
|
180
|
+
# checks run first and can reject the whole batch before message creation. After
|
|
181
|
+
# those checks pass, each message is validated and sent independently; item-level
|
|
182
|
+
# failures do not affect other messages, and the processed batch returns 207
|
|
183
|
+
# Multi-Status. Per-message failures include validation errors; when a template
|
|
184
|
+
# has `strict_variables` enabled, a missing required variable produces a per-item
|
|
185
|
+
# `unprocessable_entity` error naming that variable while the other messages
|
|
186
|
+
# continue.
|
|
178
187
|
#
|
|
179
188
|
# @overload batch(messages:, sandbox_mode: nil, idempotency_key: nil, request_options: {})
|
|
180
189
|
#
|
|
181
190
|
# @param messages [Array<Telnyx::Models::EmailMessageBatchParams::Message>] Body param: Array of email messages to send. Up to 1,000 messages per batch requ
|
|
182
191
|
#
|
|
183
|
-
# @param sandbox_mode [Boolean] Body param: Applies sandbox mode to all messages in the batch
|
|
192
|
+
# @param sandbox_mode [Boolean] Body param: Applies sandbox mode to all messages in the batch and overrides any
|
|
184
193
|
#
|
|
185
194
|
# @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
|
|
186
195
|
#
|
|
@@ -260,6 +269,15 @@ module Telnyx
|
|
|
260
269
|
# `occurred_at asc, id asc`. The legacy `/v2/emails/{id}/events` GET route is a
|
|
261
270
|
# backward-compatible alias.
|
|
262
271
|
#
|
|
272
|
+
# For compatibility, each event carries the legacy customer-visible `event_type`
|
|
273
|
+
# (`email.`-prefixed), the additive `canonical_event_type` (`email.`-prefixed),
|
|
274
|
+
# and the deprecated `type` duplicate — whose value keeps the exact legacy format:
|
|
275
|
+
# the bare stored event name, never `email.`-prefixed. Gateway rejections render
|
|
276
|
+
# `email.failed` + canonical `email.gw_reject`; MTA expirations render
|
|
277
|
+
# `email.bounced` + canonical `email.expired`; every unchanged outcome carries
|
|
278
|
+
# identical `event_type` and `canonical_event_type` values (and `type` keeps the
|
|
279
|
+
# stored name).
|
|
280
|
+
#
|
|
263
281
|
# @overload retrieve_events(email_id, page_cursor: nil, page_size: nil, request_options: {})
|
|
264
282
|
#
|
|
265
283
|
# @param email_id [String] Email message UUID.
|
|
@@ -286,6 +304,34 @@ module Telnyx
|
|
|
286
304
|
)
|
|
287
305
|
end
|
|
288
306
|
|
|
307
|
+
# Moves an existing scheduled email to a new future send time. Only the delivery
|
|
308
|
+
# time (`scheduled_at`) changes; the message ID, content, recipients, tags, and
|
|
309
|
+
# metadata remain unchanged. Returns `409 Conflict` if the message is no longer
|
|
310
|
+
# scheduled or its scheduled-send worker has already started processing it. This
|
|
311
|
+
# route emits no dedicated `rescheduled` event.
|
|
312
|
+
#
|
|
313
|
+
# @overload update_schedule(email_id, scheduled_at:, request_options: {})
|
|
314
|
+
#
|
|
315
|
+
# @param email_id [String] Email message UUID.
|
|
316
|
+
#
|
|
317
|
+
# @param scheduled_at [Time] New ISO 8601 delivery time. Must be strictly in the future.
|
|
318
|
+
#
|
|
319
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
320
|
+
#
|
|
321
|
+
# @return [Telnyx::Models::EmailMessageDetailResponse]
|
|
322
|
+
#
|
|
323
|
+
# @see Telnyx::Models::EmailMessageUpdateScheduleParams
|
|
324
|
+
def update_schedule(email_id, params)
|
|
325
|
+
parsed, options = Telnyx::EmailMessageUpdateScheduleParams.dump_request(params)
|
|
326
|
+
@client.request(
|
|
327
|
+
method: :patch,
|
|
328
|
+
path: ["email_messages/%1$s/schedule", email_id],
|
|
329
|
+
body: parsed,
|
|
330
|
+
model: Telnyx::EmailMessageDetailResponse,
|
|
331
|
+
options: options
|
|
332
|
+
)
|
|
333
|
+
end
|
|
334
|
+
|
|
289
335
|
# @api private
|
|
290
336
|
#
|
|
291
337
|
# @param client [Telnyx::Client]
|