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
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
module Telnyx
|
|
4
4
|
module Models
|
|
5
|
+
# Bare stored event names returned by message history. In addition to the normal
|
|
6
|
+
# send and delivery lifecycle, polling can expose suppression, scan, and
|
|
7
|
+
# quarantine lifecycle rows. Sharp canonical names gw_reject, injection_timeout,
|
|
8
|
+
# and expired distinguish gateway rejection, ambiguous injection timeout, and MTA
|
|
9
|
+
# expiration. The failed and bounced names remain valid for system/admin failures
|
|
10
|
+
# and hard bounces respectively. Existing stored rows retain their original names.
|
|
5
11
|
module EmailEventType
|
|
6
12
|
extend Telnyx::Internal::Type::Enum
|
|
7
13
|
|
|
@@ -19,12 +25,31 @@ module Telnyx
|
|
|
19
25
|
DELIVERED = T.let(:delivered, Telnyx::EmailEventType::TaggedSymbol)
|
|
20
26
|
BOUNCED = T.let(:bounced, Telnyx::EmailEventType::TaggedSymbol)
|
|
21
27
|
COMPLAINED = T.let(:complained, Telnyx::EmailEventType::TaggedSymbol)
|
|
28
|
+
SUPPRESSED = T.let(:suppressed, Telnyx::EmailEventType::TaggedSymbol)
|
|
22
29
|
REJECTED = T.let(:rejected, Telnyx::EmailEventType::TaggedSymbol)
|
|
23
30
|
OPENED = T.let(:opened, Telnyx::EmailEventType::TaggedSymbol)
|
|
24
31
|
CLICKED = T.let(:clicked, Telnyx::EmailEventType::TaggedSymbol)
|
|
25
32
|
UNSUBSCRIBED = T.let(:unsubscribed, Telnyx::EmailEventType::TaggedSymbol)
|
|
26
33
|
DAILY_LIMIT_EXCEEDED =
|
|
27
34
|
T.let(:daily_limit_exceeded, Telnyx::EmailEventType::TaggedSymbol)
|
|
35
|
+
SCAN_DEFERRED =
|
|
36
|
+
T.let(:scan_deferred, Telnyx::EmailEventType::TaggedSymbol)
|
|
37
|
+
QUARANTINED = T.let(:quarantined, Telnyx::EmailEventType::TaggedSymbol)
|
|
38
|
+
QUARANTINE_RELEASED =
|
|
39
|
+
T.let(:quarantine_released, Telnyx::EmailEventType::TaggedSymbol)
|
|
40
|
+
QUARANTINE_RELEASE_DISPATCHED =
|
|
41
|
+
T.let(
|
|
42
|
+
:quarantine_release_dispatched,
|
|
43
|
+
Telnyx::EmailEventType::TaggedSymbol
|
|
44
|
+
)
|
|
45
|
+
QUARANTINE_REJECTED =
|
|
46
|
+
T.let(:quarantine_rejected, Telnyx::EmailEventType::TaggedSymbol)
|
|
47
|
+
QUARANTINE_EXPIRED =
|
|
48
|
+
T.let(:quarantine_expired, Telnyx::EmailEventType::TaggedSymbol)
|
|
49
|
+
GW_REJECT = T.let(:gw_reject, Telnyx::EmailEventType::TaggedSymbol)
|
|
50
|
+
INJECTION_TIMEOUT =
|
|
51
|
+
T.let(:injection_timeout, Telnyx::EmailEventType::TaggedSymbol)
|
|
52
|
+
EXPIRED = T.let(:expired, Telnyx::EmailEventType::TaggedSymbol)
|
|
28
53
|
|
|
29
54
|
sig { override.returns(T::Array[Telnyx::EmailEventType::TaggedSymbol]) }
|
|
30
55
|
def self.values
|
|
@@ -26,7 +26,7 @@ module Telnyx
|
|
|
26
26
|
sig { returns(Time) }
|
|
27
27
|
attr_accessor :created_at
|
|
28
28
|
|
|
29
|
-
sig { returns(T::Array[Telnyx::
|
|
29
|
+
sig { returns(T::Array[Telnyx::EmailInboxes::EmailMessage::Event]) }
|
|
30
30
|
attr_accessor :events
|
|
31
31
|
|
|
32
32
|
sig { returns(Telnyx::EmailInboxes::EmailAddress) }
|
|
@@ -35,6 +35,10 @@ module Telnyx
|
|
|
35
35
|
sig { params(from: Telnyx::EmailInboxes::EmailAddress::OrHash).void }
|
|
36
36
|
attr_writer :from
|
|
37
37
|
|
|
38
|
+
# Customer-supplied metadata stored with the message.
|
|
39
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
|
40
|
+
attr_accessor :metadata
|
|
41
|
+
|
|
38
42
|
sig do
|
|
39
43
|
returns(Telnyx::EmailInboxes::EmailMessage::RecordType::TaggedSymbol)
|
|
40
44
|
end
|
|
@@ -54,6 +58,10 @@ module Telnyx
|
|
|
54
58
|
sig { returns(String) }
|
|
55
59
|
attr_accessor :subject
|
|
56
60
|
|
|
61
|
+
# Customer-supplied tags stored with the message.
|
|
62
|
+
sig { returns(T::Array[String]) }
|
|
63
|
+
attr_accessor :tags
|
|
64
|
+
|
|
57
65
|
sig { returns(T.nilable(String)) }
|
|
58
66
|
attr_accessor :template_id
|
|
59
67
|
|
|
@@ -115,13 +123,15 @@ module Telnyx
|
|
|
115
123
|
bcc: T::Array[Telnyx::EmailInboxes::EmailAddress::OrHash],
|
|
116
124
|
cc: T::Array[Telnyx::EmailInboxes::EmailAddress::OrHash],
|
|
117
125
|
created_at: Time,
|
|
118
|
-
events: T::Array[Telnyx::
|
|
126
|
+
events: T::Array[Telnyx::EmailInboxes::EmailMessage::Event::OrHash],
|
|
119
127
|
from: Telnyx::EmailInboxes::EmailAddress::OrHash,
|
|
128
|
+
metadata: T::Hash[Symbol, T.anything],
|
|
120
129
|
record_type:
|
|
121
130
|
Telnyx::EmailInboxes::EmailMessage::RecordType::OrSymbol,
|
|
122
131
|
reply_to: T.nilable(String),
|
|
123
132
|
status: Telnyx::EmailInboxes::EmailMessage::Status::OrSymbol,
|
|
124
133
|
subject: String,
|
|
134
|
+
tags: T::Array[String],
|
|
125
135
|
template_id: T.nilable(String),
|
|
126
136
|
template_variables: T::Hash[Symbol, T.anything],
|
|
127
137
|
to: T::Array[Telnyx::EmailInboxes::EmailAddress::OrHash],
|
|
@@ -140,6 +150,8 @@ module Telnyx
|
|
|
140
150
|
created_at:,
|
|
141
151
|
events:,
|
|
142
152
|
from:,
|
|
153
|
+
# Customer-supplied metadata stored with the message.
|
|
154
|
+
metadata:,
|
|
143
155
|
record_type:,
|
|
144
156
|
reply_to:,
|
|
145
157
|
# Current status of an email message. Lifecycle statuses (queued, scheduled, etc.)
|
|
@@ -147,6 +159,8 @@ module Telnyx
|
|
|
147
159
|
# delivery event consumers.
|
|
148
160
|
status:,
|
|
149
161
|
subject:,
|
|
162
|
+
# Customer-supplied tags stored with the message.
|
|
163
|
+
tags:,
|
|
150
164
|
template_id:,
|
|
151
165
|
template_variables:,
|
|
152
166
|
to:,
|
|
@@ -179,13 +193,15 @@ module Telnyx
|
|
|
179
193
|
bcc: T::Array[Telnyx::EmailInboxes::EmailAddress],
|
|
180
194
|
cc: T::Array[Telnyx::EmailInboxes::EmailAddress],
|
|
181
195
|
created_at: Time,
|
|
182
|
-
events: T::Array[Telnyx::
|
|
196
|
+
events: T::Array[Telnyx::EmailInboxes::EmailMessage::Event],
|
|
183
197
|
from: Telnyx::EmailInboxes::EmailAddress,
|
|
198
|
+
metadata: T::Hash[Symbol, T.anything],
|
|
184
199
|
record_type:
|
|
185
200
|
Telnyx::EmailInboxes::EmailMessage::RecordType::TaggedSymbol,
|
|
186
201
|
reply_to: T.nilable(String),
|
|
187
202
|
status: Telnyx::EmailInboxes::EmailMessage::Status::TaggedSymbol,
|
|
188
203
|
subject: String,
|
|
204
|
+
tags: T::Array[String],
|
|
189
205
|
template_id: T.nilable(String),
|
|
190
206
|
template_variables: T::Hash[Symbol, T.anything],
|
|
191
207
|
to: T::Array[Telnyx::EmailInboxes::EmailAddress],
|
|
@@ -282,6 +298,68 @@ module Telnyx
|
|
|
282
298
|
end
|
|
283
299
|
end
|
|
284
300
|
|
|
301
|
+
class Event < Telnyx::Internal::Type::BaseModel
|
|
302
|
+
OrHash =
|
|
303
|
+
T.type_alias do
|
|
304
|
+
T.any(
|
|
305
|
+
Telnyx::EmailInboxes::EmailMessage::Event,
|
|
306
|
+
Telnyx::Internal::AnyHash
|
|
307
|
+
)
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
sig { returns(Time) }
|
|
311
|
+
attr_accessor :occurred_at
|
|
312
|
+
|
|
313
|
+
# Bare stored event names returned by message history. In addition to the normal
|
|
314
|
+
# send and delivery lifecycle, polling can expose suppression, scan, and
|
|
315
|
+
# quarantine lifecycle rows. Sharp canonical names gw_reject, injection_timeout,
|
|
316
|
+
# and expired distinguish gateway rejection, ambiguous injection timeout, and MTA
|
|
317
|
+
# expiration. The failed and bounced names remain valid for system/admin failures
|
|
318
|
+
# and hard bounces respectively. Existing stored rows retain their original names.
|
|
319
|
+
sig { returns(Telnyx::EmailEventType::TaggedSymbol) }
|
|
320
|
+
attr_accessor :type
|
|
321
|
+
|
|
322
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
323
|
+
attr_reader :payload
|
|
324
|
+
|
|
325
|
+
sig { params(payload: T::Hash[Symbol, T.anything]).void }
|
|
326
|
+
attr_writer :payload
|
|
327
|
+
|
|
328
|
+
# An event embedded in a message response. The dedicated per-message events
|
|
329
|
+
# endpoint additionally returns event_type and canonical_event_type.
|
|
330
|
+
sig do
|
|
331
|
+
params(
|
|
332
|
+
occurred_at: Time,
|
|
333
|
+
type: Telnyx::EmailEventType::OrSymbol,
|
|
334
|
+
payload: T::Hash[Symbol, T.anything]
|
|
335
|
+
).returns(T.attached_class)
|
|
336
|
+
end
|
|
337
|
+
def self.new(
|
|
338
|
+
occurred_at:,
|
|
339
|
+
# Bare stored event names returned by message history. In addition to the normal
|
|
340
|
+
# send and delivery lifecycle, polling can expose suppression, scan, and
|
|
341
|
+
# quarantine lifecycle rows. Sharp canonical names gw_reject, injection_timeout,
|
|
342
|
+
# and expired distinguish gateway rejection, ambiguous injection timeout, and MTA
|
|
343
|
+
# expiration. The failed and bounced names remain valid for system/admin failures
|
|
344
|
+
# and hard bounces respectively. Existing stored rows retain their original names.
|
|
345
|
+
type:,
|
|
346
|
+
payload: nil
|
|
347
|
+
)
|
|
348
|
+
end
|
|
349
|
+
|
|
350
|
+
sig do
|
|
351
|
+
override.returns(
|
|
352
|
+
{
|
|
353
|
+
occurred_at: Time,
|
|
354
|
+
type: Telnyx::EmailEventType::TaggedSymbol,
|
|
355
|
+
payload: T::Hash[Symbol, T.anything]
|
|
356
|
+
}
|
|
357
|
+
)
|
|
358
|
+
end
|
|
359
|
+
def to_hash
|
|
360
|
+
end
|
|
361
|
+
end
|
|
362
|
+
|
|
285
363
|
module RecordType
|
|
286
364
|
extend Telnyx::Internal::Type::Enum
|
|
287
365
|
|
|
@@ -17,8 +17,13 @@ module Telnyx
|
|
|
17
17
|
sig { returns(T::Array[Telnyx::EmailMessageBatchParams::Message]) }
|
|
18
18
|
attr_accessor :messages
|
|
19
19
|
|
|
20
|
-
# Applies sandbox mode to all messages in the batch
|
|
21
|
-
# sandbox_mode
|
|
20
|
+
# Applies sandbox mode to all messages in the batch and overrides any per-message
|
|
21
|
+
# `sandbox_mode` value — each message's effective `sandbox_mode` is exactly this
|
|
22
|
+
# envelope value. Reserved recipients at `test.telnyx.com` produce the
|
|
23
|
+
# deterministic event chains documented on CreateEmailRequest.sandbox_mode; no
|
|
24
|
+
# batch item is injected into the MTA or outbound Kafka path. Sandbox batch items
|
|
25
|
+
# are non-billable, consume no daily-send-limit quota, and feed no
|
|
26
|
+
# delivery-reputation signals.
|
|
22
27
|
sig { returns(T.nilable(T::Boolean)) }
|
|
23
28
|
attr_reader :sandbox_mode
|
|
24
29
|
|
|
@@ -44,8 +49,13 @@ module Telnyx
|
|
|
44
49
|
# message is validated and sent independently; per-message failures do not affect
|
|
45
50
|
# other messages in the batch.
|
|
46
51
|
messages:,
|
|
47
|
-
# Applies sandbox mode to all messages in the batch
|
|
48
|
-
# sandbox_mode
|
|
52
|
+
# Applies sandbox mode to all messages in the batch and overrides any per-message
|
|
53
|
+
# `sandbox_mode` value — each message's effective `sandbox_mode` is exactly this
|
|
54
|
+
# envelope value. Reserved recipients at `test.telnyx.com` produce the
|
|
55
|
+
# deterministic event chains documented on CreateEmailRequest.sandbox_mode; no
|
|
56
|
+
# batch item is injected into the MTA or outbound Kafka path. Sandbox batch items
|
|
57
|
+
# are non-billable, consume no daily-send-limit quota, and feed no
|
|
58
|
+
# delivery-reputation signals.
|
|
49
59
|
sandbox_mode: nil,
|
|
50
60
|
idempotency_key: nil,
|
|
51
61
|
request_options: {}
|
|
@@ -170,7 +180,9 @@ module Telnyx
|
|
|
170
180
|
sig { params(inline_css: T::Boolean).void }
|
|
171
181
|
attr_writer :inline_css
|
|
172
182
|
|
|
173
|
-
# Custom metadata.
|
|
183
|
+
# Custom metadata key/value pairs. Stored on the message, returned on message
|
|
184
|
+
# responses, and propagated to Email Detail Records. Usable in `filter[metadata]`
|
|
185
|
+
# when listing messages.
|
|
174
186
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
175
187
|
attr_reader :metadata
|
|
176
188
|
|
|
@@ -191,16 +203,22 @@ module Telnyx
|
|
|
191
203
|
end
|
|
192
204
|
attr_writer :reply_to
|
|
193
205
|
|
|
206
|
+
# Per-message sandbox flag. The batch-level `sandbox_mode` envelope value is
|
|
207
|
+
# authoritative: it overwrites every message's `sandbox_mode` before processing,
|
|
208
|
+
# including the `false` default when the envelope omits the field. A per-item
|
|
209
|
+
# `sandbox_mode: true` inside a non-sandbox batch is therefore a real send. Set
|
|
210
|
+
# the envelope field to run any batch item in sandbox mode.
|
|
194
211
|
sig { returns(T.nilable(T::Boolean)) }
|
|
195
212
|
attr_reader :sandbox_mode
|
|
196
213
|
|
|
197
214
|
sig { params(sandbox_mode: T::Boolean).void }
|
|
198
215
|
attr_writer :sandbox_mode
|
|
199
216
|
|
|
200
|
-
# Future ISO 8601 time
|
|
201
|
-
#
|
|
202
|
-
#
|
|
203
|
-
# `scheduled_at`
|
|
217
|
+
# Future ISO 8601 delivery time. Invalid or non-future timestamps are rejected.
|
|
218
|
+
# Single sends return HTTP 422; in batch sends the invalid item is reported in the
|
|
219
|
+
# 207 per-item errors while other items continue. `send_at` remains a deprecated
|
|
220
|
+
# request alias. A non-null `scheduled_at` takes precedence over `send_at`; when
|
|
221
|
+
# `scheduled_at` is omitted or null, `send_at` is used.
|
|
204
222
|
sig { returns(T.nilable(Time)) }
|
|
205
223
|
attr_accessor :scheduled_at
|
|
206
224
|
|
|
@@ -220,8 +238,9 @@ module Telnyx
|
|
|
220
238
|
sig { params(subject: String).void }
|
|
221
239
|
attr_writer :subject
|
|
222
240
|
|
|
223
|
-
# Tags for categorization and
|
|
224
|
-
# Email Detail Records.
|
|
241
|
+
# Tags for categorization and filtering. Stored on the message, returned on
|
|
242
|
+
# message responses, and propagated to Email Detail Records. Usable in
|
|
243
|
+
# `filter[tags]` when listing messages.
|
|
225
244
|
sig { returns(T.nilable(T::Array[String])) }
|
|
226
245
|
attr_reader :tags
|
|
227
246
|
|
|
@@ -236,7 +255,10 @@ module Telnyx
|
|
|
236
255
|
|
|
237
256
|
# Variables for Liquid template rendering. Non-object values may cause a 422
|
|
238
257
|
# validation error on message creation, but are silently treated as an empty
|
|
239
|
-
# object for template rendering.
|
|
258
|
+
# object for template rendering. When the template enables `strict_variables`, a
|
|
259
|
+
# missing required variable fails the request with 422 (single send) or a per-item
|
|
260
|
+
# `unprocessable_entity` error (batch) naming the variable; no message is
|
|
261
|
+
# persisted for the failed item.
|
|
240
262
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
241
263
|
attr_reader :template_variables
|
|
242
264
|
|
|
@@ -322,16 +344,24 @@ module Telnyx
|
|
|
322
344
|
# be overridden. Requires the `email:override` API scope.
|
|
323
345
|
ignore_suppression: nil,
|
|
324
346
|
inline_css: nil,
|
|
325
|
-
# Custom metadata.
|
|
347
|
+
# Custom metadata key/value pairs. Stored on the message, returned on message
|
|
348
|
+
# responses, and propagated to Email Detail Records. Usable in `filter[metadata]`
|
|
349
|
+
# when listing messages.
|
|
326
350
|
metadata: nil,
|
|
327
351
|
# Reply-to address. If provided as an object with a name, only the email is
|
|
328
352
|
# stored; the name is ignored.
|
|
329
353
|
reply_to: nil,
|
|
354
|
+
# Per-message sandbox flag. The batch-level `sandbox_mode` envelope value is
|
|
355
|
+
# authoritative: it overwrites every message's `sandbox_mode` before processing,
|
|
356
|
+
# including the `false` default when the envelope omits the field. A per-item
|
|
357
|
+
# `sandbox_mode: true` inside a non-sandbox batch is therefore a real send. Set
|
|
358
|
+
# the envelope field to run any batch item in sandbox mode.
|
|
330
359
|
sandbox_mode: nil,
|
|
331
|
-
# Future ISO 8601 time
|
|
332
|
-
#
|
|
333
|
-
#
|
|
334
|
-
# `scheduled_at`
|
|
360
|
+
# Future ISO 8601 delivery time. Invalid or non-future timestamps are rejected.
|
|
361
|
+
# Single sends return HTTP 422; in batch sends the invalid item is reported in the
|
|
362
|
+
# 207 per-item errors while other items continue. `send_at` remains a deprecated
|
|
363
|
+
# request alias. A non-null `scheduled_at` takes precedence over `send_at`; when
|
|
364
|
+
# `scheduled_at` is omitted or null, `send_at` is used.
|
|
335
365
|
scheduled_at: nil,
|
|
336
366
|
# Deprecated alias for `scheduled_at`.
|
|
337
367
|
send_at: nil,
|
|
@@ -339,13 +369,17 @@ module Telnyx
|
|
|
339
369
|
# subject is rendered; if the template has no subject or renders empty, the
|
|
340
370
|
# request returns 400.
|
|
341
371
|
subject: nil,
|
|
342
|
-
# Tags for categorization and
|
|
343
|
-
# Email Detail Records.
|
|
372
|
+
# Tags for categorization and filtering. Stored on the message, returned on
|
|
373
|
+
# message responses, and propagated to Email Detail Records. Usable in
|
|
374
|
+
# `filter[tags]` when listing messages.
|
|
344
375
|
tags: nil,
|
|
345
376
|
template_id: nil,
|
|
346
377
|
# Variables for Liquid template rendering. Non-object values may cause a 422
|
|
347
378
|
# validation error on message creation, but are silently treated as an empty
|
|
348
|
-
# object for template rendering.
|
|
379
|
+
# object for template rendering. When the template enables `strict_variables`, a
|
|
380
|
+
# missing required variable fails the request with 422 (single send) or a per-item
|
|
381
|
+
# `unprocessable_entity` error (batch) naming the variable; no message is
|
|
382
|
+
# persisted for the failed item.
|
|
349
383
|
template_variables: nil,
|
|
350
384
|
# Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
351
385
|
# create and list responses.
|
|
@@ -124,7 +124,9 @@ module Telnyx
|
|
|
124
124
|
sig { params(inline_css: T::Boolean).void }
|
|
125
125
|
attr_writer :inline_css
|
|
126
126
|
|
|
127
|
-
# Custom metadata.
|
|
127
|
+
# Custom metadata key/value pairs. Stored on the message, returned on message
|
|
128
|
+
# responses, and propagated to Email Detail Records. Usable in `filter[metadata]`
|
|
129
|
+
# when listing messages.
|
|
128
130
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
129
131
|
attr_reader :metadata
|
|
130
132
|
|
|
@@ -156,16 +158,42 @@ module Telnyx
|
|
|
156
158
|
sig { returns(T.nilable(T::Boolean)) }
|
|
157
159
|
attr_accessor :reply_to_all
|
|
158
160
|
|
|
161
|
+
# Validates and accepts the message without injecting it into the MTA or outbound
|
|
162
|
+
# Kafka path. Nothing is delivered: sandbox records are non-billable, consume no
|
|
163
|
+
# daily-send-limit quota, and feed no delivery-reputation signals.
|
|
164
|
+
#
|
|
165
|
+
# The reserved sandbox test-recipient domain is `test.telnyx.com`. In sandbox
|
|
166
|
+
# mode, these addresses produce deterministic recipient-scoped lifecycle events:
|
|
167
|
+
#
|
|
168
|
+
# - `delivered@test.telnyx.com`: queued -> sending -> sent -> delivered
|
|
169
|
+
# - `hard-bounce@test.telnyx.com`: queued -> sending -> sent -> bounced
|
|
170
|
+
# (permanent)
|
|
171
|
+
# - `soft-bounce@test.telnyx.com`: queued -> sending -> sent -> bounced
|
|
172
|
+
# (transient)
|
|
173
|
+
# - `complaint@test.telnyx.com`: queued -> sending -> sent -> complained
|
|
174
|
+
# - `suppressed@test.telnyx.com`: queued -> suppressed
|
|
175
|
+
# - `invalid@test.telnyx.com`: queued -> sending -> failed (invalid recipient)
|
|
176
|
+
# - `dkim-fail@test.telnyx.com`: queued -> sending -> failed (DKIM unavailable)
|
|
177
|
+
# - `rate-limit@test.telnyx.com`: queued -> sending -> failed (rate limit
|
|
178
|
+
# exceeded)
|
|
179
|
+
#
|
|
180
|
+
# Matching is case-insensitive for both the local part and the domain and requires
|
|
181
|
+
# the exact domain `test.telnyx.com` — subdomains and other domains do not match.
|
|
182
|
+
# Mixed sandbox sends simulate only reserved test recipients; other recipients
|
|
183
|
+
# retain ordinary sandbox behavior (accepted, no delivery attempted). Hard-bounce
|
|
184
|
+
# and complaint outcomes also use the normal automatic-suppression pipeline.
|
|
185
|
+
# Non-sandbox sends to these addresses use the normal delivery path.
|
|
159
186
|
sig { returns(T.nilable(T::Boolean)) }
|
|
160
187
|
attr_reader :sandbox_mode
|
|
161
188
|
|
|
162
189
|
sig { params(sandbox_mode: T::Boolean).void }
|
|
163
190
|
attr_writer :sandbox_mode
|
|
164
191
|
|
|
165
|
-
# Future ISO 8601 time
|
|
166
|
-
#
|
|
167
|
-
#
|
|
168
|
-
# `scheduled_at`
|
|
192
|
+
# Future ISO 8601 delivery time. Invalid or non-future timestamps are rejected.
|
|
193
|
+
# Single sends return HTTP 422; in batch sends the invalid item is reported in the
|
|
194
|
+
# 207 per-item errors while other items continue. `send_at` remains a deprecated
|
|
195
|
+
# request alias. A non-null `scheduled_at` takes precedence over `send_at`; when
|
|
196
|
+
# `scheduled_at` is omitted or null, `send_at` is used.
|
|
169
197
|
sig { returns(T.nilable(Time)) }
|
|
170
198
|
attr_accessor :scheduled_at
|
|
171
199
|
|
|
@@ -185,8 +213,9 @@ module Telnyx
|
|
|
185
213
|
sig { params(subject: String).void }
|
|
186
214
|
attr_writer :subject
|
|
187
215
|
|
|
188
|
-
# Tags for categorization and
|
|
189
|
-
# Email Detail Records.
|
|
216
|
+
# Tags for categorization and filtering. Stored on the message, returned on
|
|
217
|
+
# message responses, and propagated to Email Detail Records. Usable in
|
|
218
|
+
# `filter[tags]` when listing messages.
|
|
190
219
|
sig { returns(T.nilable(T::Array[String])) }
|
|
191
220
|
attr_reader :tags
|
|
192
221
|
|
|
@@ -201,7 +230,10 @@ module Telnyx
|
|
|
201
230
|
|
|
202
231
|
# Variables for Liquid template rendering. Non-object values may cause a 422
|
|
203
232
|
# validation error on message creation, but are silently treated as an empty
|
|
204
|
-
# object for template rendering.
|
|
233
|
+
# object for template rendering. When the template enables `strict_variables`, a
|
|
234
|
+
# missing required variable fails the request with 422 (single send) or a per-item
|
|
235
|
+
# `unprocessable_entity` error (batch) naming the variable; no message is
|
|
236
|
+
# persisted for the failed item.
|
|
205
237
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
|
206
238
|
attr_reader :template_variables
|
|
207
239
|
|
|
@@ -306,7 +338,9 @@ module Telnyx
|
|
|
306
338
|
# Cannot be combined with `forward_of_message_id` (422).
|
|
307
339
|
in_reply_to_message_id: nil,
|
|
308
340
|
inline_css: nil,
|
|
309
|
-
# Custom metadata.
|
|
341
|
+
# Custom metadata key/value pairs. Stored on the message, returned on message
|
|
342
|
+
# responses, and propagated to Email Detail Records. Usable in `filter[metadata]`
|
|
343
|
+
# when listing messages.
|
|
310
344
|
metadata: nil,
|
|
311
345
|
# Reply-to address. If provided as an object with a name, only the email is
|
|
312
346
|
# stored; the name is ignored.
|
|
@@ -320,11 +354,37 @@ module Telnyx
|
|
|
320
354
|
#
|
|
321
355
|
# Only meaningful alongside `in_reply_to_message_id`.
|
|
322
356
|
reply_to_all: nil,
|
|
357
|
+
# Validates and accepts the message without injecting it into the MTA or outbound
|
|
358
|
+
# Kafka path. Nothing is delivered: sandbox records are non-billable, consume no
|
|
359
|
+
# daily-send-limit quota, and feed no delivery-reputation signals.
|
|
360
|
+
#
|
|
361
|
+
# The reserved sandbox test-recipient domain is `test.telnyx.com`. In sandbox
|
|
362
|
+
# mode, these addresses produce deterministic recipient-scoped lifecycle events:
|
|
363
|
+
#
|
|
364
|
+
# - `delivered@test.telnyx.com`: queued -> sending -> sent -> delivered
|
|
365
|
+
# - `hard-bounce@test.telnyx.com`: queued -> sending -> sent -> bounced
|
|
366
|
+
# (permanent)
|
|
367
|
+
# - `soft-bounce@test.telnyx.com`: queued -> sending -> sent -> bounced
|
|
368
|
+
# (transient)
|
|
369
|
+
# - `complaint@test.telnyx.com`: queued -> sending -> sent -> complained
|
|
370
|
+
# - `suppressed@test.telnyx.com`: queued -> suppressed
|
|
371
|
+
# - `invalid@test.telnyx.com`: queued -> sending -> failed (invalid recipient)
|
|
372
|
+
# - `dkim-fail@test.telnyx.com`: queued -> sending -> failed (DKIM unavailable)
|
|
373
|
+
# - `rate-limit@test.telnyx.com`: queued -> sending -> failed (rate limit
|
|
374
|
+
# exceeded)
|
|
375
|
+
#
|
|
376
|
+
# Matching is case-insensitive for both the local part and the domain and requires
|
|
377
|
+
# the exact domain `test.telnyx.com` — subdomains and other domains do not match.
|
|
378
|
+
# Mixed sandbox sends simulate only reserved test recipients; other recipients
|
|
379
|
+
# retain ordinary sandbox behavior (accepted, no delivery attempted). Hard-bounce
|
|
380
|
+
# and complaint outcomes also use the normal automatic-suppression pipeline.
|
|
381
|
+
# Non-sandbox sends to these addresses use the normal delivery path.
|
|
323
382
|
sandbox_mode: nil,
|
|
324
|
-
# Future ISO 8601 time
|
|
325
|
-
#
|
|
326
|
-
#
|
|
327
|
-
# `scheduled_at`
|
|
383
|
+
# Future ISO 8601 delivery time. Invalid or non-future timestamps are rejected.
|
|
384
|
+
# Single sends return HTTP 422; in batch sends the invalid item is reported in the
|
|
385
|
+
# 207 per-item errors while other items continue. `send_at` remains a deprecated
|
|
386
|
+
# request alias. A non-null `scheduled_at` takes precedence over `send_at`; when
|
|
387
|
+
# `scheduled_at` is omitted or null, `send_at` is used.
|
|
328
388
|
scheduled_at: nil,
|
|
329
389
|
# Deprecated alias for `scheduled_at`.
|
|
330
390
|
send_at: nil,
|
|
@@ -332,13 +392,17 @@ module Telnyx
|
|
|
332
392
|
# subject is rendered; if the template has no subject or renders empty, the
|
|
333
393
|
# request returns 400.
|
|
334
394
|
subject: nil,
|
|
335
|
-
# Tags for categorization and
|
|
336
|
-
# Email Detail Records.
|
|
395
|
+
# Tags for categorization and filtering. Stored on the message, returned on
|
|
396
|
+
# message responses, and propagated to Email Detail Records. Usable in
|
|
397
|
+
# `filter[tags]` when listing messages.
|
|
337
398
|
tags: nil,
|
|
338
399
|
template_id: nil,
|
|
339
400
|
# Variables for Liquid template rendering. Non-object values may cause a 422
|
|
340
401
|
# validation error on message creation, but are silently treated as an empty
|
|
341
|
-
# object for template rendering.
|
|
402
|
+
# object for template rendering. When the template enables `strict_variables`, a
|
|
403
|
+
# missing required variable fails the request with 422 (single send) or a per-item
|
|
404
|
+
# `unprocessable_entity` error (batch) naming the variable; no message is
|
|
405
|
+
# persisted for the failed item.
|
|
342
406
|
template_variables: nil,
|
|
343
407
|
# Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
344
408
|
# create and list responses.
|
data/rbi/telnyx/models/{email_message_retrieve_response.rbi → email_message_detail_response.rbi}
RENAMED
|
@@ -2,37 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
module Telnyx
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class EmailMessageDetailResponse < Telnyx::Internal::Type::BaseModel
|
|
6
6
|
OrHash =
|
|
7
7
|
T.type_alias do
|
|
8
|
-
T.any(
|
|
9
|
-
Telnyx::Models::EmailMessageRetrieveResponse,
|
|
10
|
-
Telnyx::Internal::AnyHash
|
|
11
|
-
)
|
|
8
|
+
T.any(Telnyx::EmailMessageDetailResponse, Telnyx::Internal::AnyHash)
|
|
12
9
|
end
|
|
13
10
|
|
|
14
|
-
sig { returns(Telnyx::
|
|
11
|
+
sig { returns(Telnyx::EmailMessageDetailResponse::Data) }
|
|
15
12
|
attr_reader :data
|
|
16
13
|
|
|
17
14
|
sig do
|
|
18
|
-
params(
|
|
19
|
-
data: Telnyx::Models::EmailMessageRetrieveResponse::Data::OrHash
|
|
20
|
-
).void
|
|
15
|
+
params(data: Telnyx::EmailMessageDetailResponse::Data::OrHash).void
|
|
21
16
|
end
|
|
22
17
|
attr_writer :data
|
|
23
18
|
|
|
24
19
|
sig do
|
|
25
|
-
params(
|
|
26
|
-
|
|
27
|
-
)
|
|
20
|
+
params(data: Telnyx::EmailMessageDetailResponse::Data::OrHash).returns(
|
|
21
|
+
T.attached_class
|
|
22
|
+
)
|
|
28
23
|
end
|
|
29
24
|
def self.new(data:)
|
|
30
25
|
end
|
|
31
26
|
|
|
32
27
|
sig do
|
|
33
|
-
override.returns(
|
|
34
|
-
{ data: Telnyx::Models::EmailMessageRetrieveResponse::Data }
|
|
35
|
-
)
|
|
28
|
+
override.returns({ data: Telnyx::EmailMessageDetailResponse::Data })
|
|
36
29
|
end
|
|
37
30
|
def to_hash
|
|
38
31
|
end
|
|
@@ -41,7 +34,7 @@ module Telnyx
|
|
|
41
34
|
OrHash =
|
|
42
35
|
T.type_alias do
|
|
43
36
|
T.any(
|
|
44
|
-
Telnyx::
|
|
37
|
+
Telnyx::EmailMessageDetailResponse::Data,
|
|
45
38
|
Telnyx::Internal::AnyHash
|
|
46
39
|
)
|
|
47
40
|
end
|
|
@@ -11,6 +11,29 @@ module Telnyx
|
|
|
11
11
|
T.any(Telnyx::EmailMessageListParams, Telnyx::Internal::AnyHash)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
+
# Metadata containment filter, supplied as a JSON object or comma-separated
|
|
15
|
+
# `key=value` pairs. All supplied key/value pairs must be contained in the message
|
|
16
|
+
# metadata. An empty value or empty JSON object omits the filter. Malformed
|
|
17
|
+
# values, valid non-object JSON, pairs without `=`, empty keys, and
|
|
18
|
+
# non-string/nested query shapes return HTTP 400.
|
|
19
|
+
sig { returns(T.nilable(String)) }
|
|
20
|
+
attr_reader :filter_metadata
|
|
21
|
+
|
|
22
|
+
sig { params(filter_metadata: String).void }
|
|
23
|
+
attr_writer :filter_metadata
|
|
24
|
+
|
|
25
|
+
# Comma-separated tags. Each segment is trimmed, and messages having at least one
|
|
26
|
+
# supplied tag are returned; matching is exact and case-sensitive after trimming.
|
|
27
|
+
# Because commas delimit values and surrounding whitespace is removed, this filter
|
|
28
|
+
# cannot represent stored tags containing literal commas or leading/trailing
|
|
29
|
+
# whitespace. An empty value omits the filter. Empty segments and
|
|
30
|
+
# non-string/nested query shapes return HTTP 400.
|
|
31
|
+
sig { returns(T.nilable(String)) }
|
|
32
|
+
attr_reader :filter_tags
|
|
33
|
+
|
|
34
|
+
sig { params(filter_tags: String).void }
|
|
35
|
+
attr_writer :filter_tags
|
|
36
|
+
|
|
14
37
|
# Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
15
38
|
sig { returns(T.nilable(String)) }
|
|
16
39
|
attr_reader :page_cursor
|
|
@@ -28,12 +51,27 @@ module Telnyx
|
|
|
28
51
|
|
|
29
52
|
sig do
|
|
30
53
|
params(
|
|
54
|
+
filter_metadata: String,
|
|
55
|
+
filter_tags: String,
|
|
31
56
|
page_cursor: String,
|
|
32
57
|
page_size: Integer,
|
|
33
58
|
request_options: Telnyx::RequestOptions::OrHash
|
|
34
59
|
).returns(T.attached_class)
|
|
35
60
|
end
|
|
36
61
|
def self.new(
|
|
62
|
+
# Metadata containment filter, supplied as a JSON object or comma-separated
|
|
63
|
+
# `key=value` pairs. All supplied key/value pairs must be contained in the message
|
|
64
|
+
# metadata. An empty value or empty JSON object omits the filter. Malformed
|
|
65
|
+
# values, valid non-object JSON, pairs without `=`, empty keys, and
|
|
66
|
+
# non-string/nested query shapes return HTTP 400.
|
|
67
|
+
filter_metadata: nil,
|
|
68
|
+
# Comma-separated tags. Each segment is trimmed, and messages having at least one
|
|
69
|
+
# supplied tag are returned; matching is exact and case-sensitive after trimming.
|
|
70
|
+
# Because commas delimit values and surrounding whitespace is removed, this filter
|
|
71
|
+
# cannot represent stored tags containing literal commas or leading/trailing
|
|
72
|
+
# whitespace. An empty value omits the filter. Empty segments and
|
|
73
|
+
# non-string/nested query shapes return HTTP 400.
|
|
74
|
+
filter_tags: nil,
|
|
37
75
|
# Opaque URL-safe Base64 cursor returned by a previous list response.
|
|
38
76
|
page_cursor: nil,
|
|
39
77
|
# Number of results to return. Defaults to 25; maximum is 100. Invalid values are
|
|
@@ -46,6 +84,8 @@ module Telnyx
|
|
|
46
84
|
sig do
|
|
47
85
|
override.returns(
|
|
48
86
|
{
|
|
87
|
+
filter_metadata: String,
|
|
88
|
+
filter_tags: String,
|
|
49
89
|
page_cursor: String,
|
|
50
90
|
page_size: Integer,
|
|
51
91
|
request_options: Telnyx::RequestOptions
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class EmailMessageUpdateScheduleParams < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
7
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
8
|
+
|
|
9
|
+
OrHash =
|
|
10
|
+
T.type_alias do
|
|
11
|
+
T.any(
|
|
12
|
+
Telnyx::EmailMessageUpdateScheduleParams,
|
|
13
|
+
Telnyx::Internal::AnyHash
|
|
14
|
+
)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
sig { returns(String) }
|
|
18
|
+
attr_accessor :email_id
|
|
19
|
+
|
|
20
|
+
# New ISO 8601 delivery time. Must be strictly in the future.
|
|
21
|
+
sig { returns(Time) }
|
|
22
|
+
attr_accessor :scheduled_at
|
|
23
|
+
|
|
24
|
+
sig do
|
|
25
|
+
params(
|
|
26
|
+
email_id: String,
|
|
27
|
+
scheduled_at: Time,
|
|
28
|
+
request_options: Telnyx::RequestOptions::OrHash
|
|
29
|
+
).returns(T.attached_class)
|
|
30
|
+
end
|
|
31
|
+
def self.new(
|
|
32
|
+
email_id:,
|
|
33
|
+
# New ISO 8601 delivery time. Must be strictly in the future.
|
|
34
|
+
scheduled_at:,
|
|
35
|
+
request_options: {}
|
|
36
|
+
)
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
sig do
|
|
40
|
+
override.returns(
|
|
41
|
+
{
|
|
42
|
+
email_id: String,
|
|
43
|
+
scheduled_at: Time,
|
|
44
|
+
request_options: Telnyx::RequestOptions
|
|
45
|
+
}
|
|
46
|
+
)
|
|
47
|
+
end
|
|
48
|
+
def to_hash
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|