telnyx 5.158.0 → 5.159.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 +12 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +51 -0
- data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +4 -2
- data/lib/telnyx/models/ai/assistant_chat_params.rb +16 -1
- data/lib/telnyx/models/ai/chat_completion_request.rb +11 -1
- data/lib/telnyx/models/ai/openai_create_response_params.rb +11 -1
- data/lib/telnyx/models/ai/transcription_settings.rb +17 -1
- data/lib/telnyx/models/attachment_request.rb +52 -0
- data/lib/telnyx/models/call_assistant_request.rb +8 -1
- data/lib/telnyx/models/call_dial_params.rb +14 -1
- data/lib/telnyx/models/call_payment_completed_webhook_event.rb +344 -0
- data/lib/telnyx/models/call_payment_progress_webhook_event.rb +338 -0
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +11 -1
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -0
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -0
- data/lib/telnyx/models/calls/action_pay_params.rb +268 -0
- data/lib/telnyx/models/calls/action_pay_response.rb +18 -0
- data/lib/telnyx/models/calls/action_speak_params.rb +4 -0
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +1 -70
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +4 -0
- data/lib/telnyx/models/calls/action_transfer_params.rb +14 -1
- data/lib/telnyx/models/calls/pay_prompt_value.rb +104 -0
- data/lib/telnyx/models/calls/transcription_config.rb +17 -1
- data/lib/telnyx/models/calls/transcription_start_request.rb +166 -3
- data/lib/telnyx/models/conferences/action_speak_params.rb +4 -0
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +4 -0
- data/lib/telnyx/models/custom_storage_configuration.rb +65 -3
- data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +19 -1
- data/lib/telnyx/models/dir/reference.rb +5 -3
- data/lib/telnyx/models/dir/reference_create_params.rb +8 -2
- data/lib/telnyx/models/dns_record.rb +101 -0
- data/lib/telnyx/models/domains_tracking_settings.rb +37 -0
- data/lib/telnyx/models/email_address_input.rb +16 -0
- data/lib/telnyx/models/email_block.rb +174 -0
- data/lib/telnyx/models/email_block_create_params.rb +45 -0
- data/lib/telnyx/models/email_block_delete_params.rb +20 -0
- data/lib/telnyx/models/email_block_list_params.rb +118 -0
- data/lib/telnyx/models/email_block_response.rb +21 -0
- data/lib/telnyx/models/email_block_retrieve_events_params.rb +37 -0
- data/lib/telnyx/models/email_block_retrieve_events_response.rb +112 -0
- data/lib/telnyx/models/email_block_retrieve_export_params.rb +100 -0
- data/lib/telnyx/models/email_block_retrieve_export_response.rb +7 -0
- data/lib/telnyx/models/email_block_retrieve_params.rb +20 -0
- data/lib/telnyx/models/email_blocks/email_block_import_response.rb +188 -0
- data/lib/telnyx/models/email_blocks/import_create_params.rb +36 -0
- data/lib/telnyx/models/email_blocks/import_retrieve_params.rb +22 -0
- data/lib/telnyx/models/email_dmarc_policy.rb +77 -0
- data/lib/telnyx/models/email_domain.rb +257 -0
- data/lib/telnyx/models/email_domain_create_params.rb +51 -0
- data/lib/telnyx/models/email_domain_delete_params.rb +29 -0
- data/lib/telnyx/models/email_domain_list_params.rb +111 -0
- data/lib/telnyx/models/email_domain_response.rb +16 -0
- data/lib/telnyx/models/email_domain_retrieve_dns_records_params.rb +20 -0
- data/lib/telnyx/models/email_domain_retrieve_dns_records_response.rb +16 -0
- data/lib/telnyx/models/email_domain_retrieve_health_params.rb +20 -0
- data/lib/telnyx/models/email_domain_retrieve_health_response.rb +104 -0
- data/lib/telnyx/models/email_domain_retrieve_params.rb +20 -0
- data/lib/telnyx/models/email_domain_status.rb +19 -0
- data/lib/telnyx/models/email_domain_type.rb +16 -0
- data/lib/telnyx/models/email_domain_update_params.rb +51 -0
- data/lib/telnyx/models/email_domain_verification.rb +101 -0
- data/lib/telnyx/models/email_domain_verify_params.rb +20 -0
- data/lib/telnyx/models/email_domains/email_webhook.rb +76 -0
- data/lib/telnyx/models/email_domains/email_webhook_event.rb +37 -0
- data/lib/telnyx/models/email_domains/email_webhook_response.rb +18 -0
- data/lib/telnyx/models/email_domains/offset_pagination_meta.rb +35 -0
- data/lib/telnyx/models/email_domains/webhook_create_params.rb +39 -0
- data/lib/telnyx/models/email_domains/webhook_delete_params.rb +28 -0
- data/lib/telnyx/models/email_domains/webhook_list_params.rb +58 -0
- data/lib/telnyx/models/email_domains/webhook_retrieve_params.rb +28 -0
- data/lib/telnyx/models/email_domains/webhook_update_params.rb +40 -0
- data/lib/telnyx/models/email_event_list_params.rb +87 -0
- data/lib/telnyx/models/email_event_list_response.rb +147 -0
- data/lib/telnyx/models/email_event_retrieve_stats_params.rb +34 -0
- data/lib/telnyx/models/email_event_retrieve_stats_response.rb +198 -0
- data/lib/telnyx/models/email_event_type.rb +29 -0
- data/lib/telnyx/models/email_inbox.rb +93 -0
- data/lib/telnyx/models/email_inbox_create_params.rb +36 -0
- data/lib/telnyx/models/email_inbox_delete_params.rb +20 -0
- data/lib/telnyx/models/email_inbox_list_params.rb +30 -0
- data/lib/telnyx/models/email_inbox_list_response.rb +41 -0
- data/lib/telnyx/models/email_inbox_response.rb +16 -0
- data/lib/telnyx/models/email_inbox_retrieve_params.rb +20 -0
- data/lib/telnyx/models/email_inboxes/draft_create_params.rb +22 -0
- data/lib/telnyx/models/email_inboxes/draft_delete_params.rb +28 -0
- data/lib/telnyx/models/email_inboxes/draft_list_params.rb +59 -0
- data/lib/telnyx/models/email_inboxes/draft_list_response.rb +24 -0
- data/lib/telnyx/models/email_inboxes/draft_patch_params.rb +28 -0
- data/lib/telnyx/models/email_inboxes/draft_retrieve_params.rb +28 -0
- data/lib/telnyx/models/email_inboxes/draft_send_params.rb +28 -0
- data/lib/telnyx/models/email_inboxes/draft_update_params.rb +28 -0
- data/lib/telnyx/models/email_inboxes/email_address.rb +23 -0
- data/lib/telnyx/models/email_inboxes/email_draft.rb +219 -0
- data/lib/telnyx/models/email_inboxes/email_draft_request.rb +128 -0
- data/lib/telnyx/models/email_inboxes/email_draft_response.rb +19 -0
- data/lib/telnyx/models/email_inboxes/email_message.rb +252 -0
- data/lib/telnyx/models/email_inboxes/email_message_response.rb +66 -0
- data/lib/telnyx/models/email_inboxes/email_pagination_meta.rb +25 -0
- data/lib/telnyx/models/email_inboxes/filter_add_params.rb +22 -0
- data/lib/telnyx/models/email_inboxes/filter_add_response.rb +51 -0
- data/lib/telnyx/models/email_inboxes/filter_delete_all_params.rb +22 -0
- data/lib/telnyx/models/email_inboxes/filter_delete_all_response.rb +52 -0
- data/lib/telnyx/models/email_inboxes/filter_list_params.rb +22 -0
- data/lib/telnyx/models/email_inboxes/filter_list_response.rb +51 -0
- data/lib/telnyx/models/email_inboxes/filter_replace_params.rb +34 -0
- data/lib/telnyx/models/email_inboxes/filter_replace_response.rb +51 -0
- data/lib/telnyx/models/email_inboxes/inbound_email_address.rb +23 -0
- data/lib/telnyx/models/email_inboxes/inbound_thread.rb +112 -0
- data/lib/telnyx/models/email_inboxes/inbound_thread_detail.rb +17 -0
- data/lib/telnyx/models/email_inboxes/inbound_thread_list_response.rb +24 -0
- data/lib/telnyx/models/email_inboxes/message_drafts_params.rb +28 -0
- data/lib/telnyx/models/email_inboxes/message_list_params.rb +109 -0
- data/lib/telnyx/models/email_inboxes/message_list_response.rb +24 -0
- data/lib/telnyx/models/email_inboxes/message_update_params.rb +65 -0
- data/lib/telnyx/models/email_inboxes/message_update_response.rb +18 -0
- data/lib/telnyx/models/email_inboxes/messages/action_forward_params.rb +117 -0
- data/lib/telnyx/models/email_inboxes/messages/action_reply_all_params.rb +30 -0
- data/lib/telnyx/models/email_inboxes/messages/action_reply_params.rb +30 -0
- data/lib/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rb +38 -0
- data/lib/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rb +46 -0
- data/lib/telnyx/models/email_inboxes/messages/label_create_params.rb +30 -0
- data/lib/telnyx/models/email_inboxes/messages/label_create_response.rb +20 -0
- data/lib/telnyx/models/email_inboxes/messages/label_delete_all_params.rb +30 -0
- data/lib/telnyx/models/email_inboxes/messages/label_delete_all_response.rb +20 -0
- data/lib/telnyx/models/email_inboxes/messages/label_mutation_request.rb +28 -0
- data/lib/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rb +32 -0
- data/lib/telnyx/models/email_inboxes/mutate_inbox_filters_request.rb +38 -0
- data/lib/telnyx/models/email_inboxes/thread_list_params.rb +51 -0
- data/lib/telnyx/models/email_inboxes/thread_message.rb +255 -0
- data/lib/telnyx/models/email_inboxes/thread_retrieve_params.rb +46 -0
- data/lib/telnyx/models/email_inboxes/thread_retrieve_response.rb +24 -0
- data/lib/telnyx/models/email_inboxes/threads/label_create_params.rb +30 -0
- data/lib/telnyx/models/email_inboxes/threads/label_create_response.rb +60 -0
- data/lib/telnyx/models/email_inboxes/threads/label_delete_all_params.rb +30 -0
- data/lib/telnyx/models/email_inboxes/threads/label_delete_all_response.rb +60 -0
- data/lib/telnyx/models/email_message_batch_params.rb +239 -0
- data/lib/telnyx/models/email_message_batch_response.rb +95 -0
- data/lib/telnyx/models/email_message_create_params.rb +257 -0
- data/lib/telnyx/models/email_message_delete_all_params.rb +25 -0
- data/lib/telnyx/models/email_message_delete_params.rb +20 -0
- data/lib/telnyx/models/email_message_delete_schedule_params.rb +20 -0
- data/lib/telnyx/models/email_message_list_params.rb +34 -0
- data/lib/telnyx/models/email_message_list_response.rb +22 -0
- data/lib/telnyx/models/email_message_retrieve_events_params.rb +41 -0
- data/lib/telnyx/models/email_message_retrieve_events_response.rb +22 -0
- data/lib/telnyx/models/email_message_retrieve_params.rb +20 -0
- data/lib/telnyx/models/email_message_retrieve_response.rb +36 -0
- data/lib/telnyx/models/email_messages/email_recipient.rb +143 -0
- data/lib/telnyx/models/email_messages/recipient_list_params.rb +89 -0
- data/lib/telnyx/models/email_messages/recipient_list_response.rb +43 -0
- data/lib/telnyx/models/email_messages/recipient_retrieve_params.rb +28 -0
- data/lib/telnyx/models/email_messages/recipient_retrieve_response.rb +18 -0
- data/lib/telnyx/models/email_template.rb +73 -0
- data/lib/telnyx/models/email_template_create_params.rb +61 -0
- data/lib/telnyx/models/email_template_delete_params.rb +20 -0
- data/lib/telnyx/models/email_template_list_params.rb +34 -0
- data/lib/telnyx/models/email_template_list_response.rb +22 -0
- data/lib/telnyx/models/email_template_render_params.rb +33 -0
- data/lib/telnyx/models/email_template_render_response.rb +30 -0
- data/lib/telnyx/models/email_template_replace_params.rb +20 -0
- data/lib/telnyx/models/email_template_response.rb +16 -0
- data/lib/telnyx/models/email_template_retrieve_params.rb +20 -0
- data/lib/telnyx/models/email_template_update_params.rb +20 -0
- data/lib/telnyx/models/email_thread_list_params.rb +54 -0
- data/lib/telnyx/models/email_thread_retrieve_params.rb +45 -0
- data/lib/telnyx/models/email_thread_retrieve_response.rb +22 -0
- data/lib/telnyx/models/email_unsubscribe_group_create_params.rb +26 -0
- data/lib/telnyx/models/email_unsubscribe_group_delete_params.rb +59 -0
- data/lib/telnyx/models/email_unsubscribe_group_list_params.rb +30 -0
- data/lib/telnyx/models/email_unsubscribe_group_retrieve_params.rb +20 -0
- data/lib/telnyx/models/email_unsubscribe_group_update_params.rb +32 -0
- data/lib/telnyx/models/email_unsubscribe_groups/suppression_create_params.rb +28 -0
- data/lib/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rb +28 -0
- data/lib/telnyx/models/email_unsubscribe_groups/suppression_list_params.rb +39 -0
- data/lib/telnyx/models/email_validation_check.rb +23 -0
- data/lib/telnyx/models/email_validation_create_params.rb +33 -0
- data/lib/telnyx/models/email_validation_create_response.rb +120 -0
- data/lib/telnyx/models/email_validations/batch_create_params.rb +42 -0
- data/lib/telnyx/models/email_validations/batch_create_response.rb +73 -0
- data/lib/telnyx/models/email_validations/batch_retrieve_params.rb +22 -0
- data/lib/telnyx/models/email_validations/batch_retrieve_response.rb +173 -0
- data/lib/telnyx/models/email_validations/email_validation_batch_status.rb +21 -0
- data/lib/telnyx/models/fax.rb +36 -1
- data/lib/telnyx/models/fax_failed.rb +15 -17
- data/lib/telnyx/models/group_list_meta.rb +35 -0
- data/lib/telnyx/models/inbound_message.rb +6 -288
- data/lib/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rb +17 -1
- data/lib/telnyx/models/legacy/reporting/usage_reports/telco_data_usage_report_response.rb +1 -0
- data/lib/telnyx/models/message_event.rb +27 -0
- data/lib/telnyx/models/messaging_10dlc/phone_number_campaign.rb +17 -1
- data/lib/telnyx/models/model_metadata.rb +22 -1
- data/lib/telnyx/models/offset_meta.rb +33 -0
- data/lib/telnyx/models/phone_numbers/action_change_bundle_status_params.rb +3 -3
- data/lib/telnyx/models/pricing/pricing_pagination_meta.rb +37 -0
- data/lib/telnyx/models/pricing/pricing_tier.rb +55 -0
- data/lib/telnyx/models/pricing/product_list_params.rb +32 -0
- data/lib/telnyx/models/pricing/product_list_response.rb +35 -0
- data/lib/telnyx/models/pricing/product_retrieve_params.rb +39 -0
- data/lib/telnyx/models/pricing/product_retrieve_response.rb +192 -0
- data/lib/telnyx/models/s3_configuration_data.rb +17 -17
- data/lib/telnyx/models/short_code.rb +2 -1
- data/lib/telnyx/models/short_code_update_params.rb +2 -1
- data/lib/telnyx/models/speech_to_text_list_providers_params.rb +2 -0
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +4 -0
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +52 -1
- 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 -0
- data/lib/telnyx/models/time_range.rb +21 -0
- data/lib/telnyx/models/tracking_settings.rb +27 -0
- data/lib/telnyx/models/uac_external_settings.rb +10 -1
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/unsubscribe_group.rb +65 -0
- data/lib/telnyx/models/unsubscribe_group_response.rb +16 -0
- data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
- data/lib/telnyx/models/update_email_template_request.rb +46 -0
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rb +2 -2
- data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_list_params.rb +24 -0
- data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rb +72 -0
- data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_params.rb +58 -0
- data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rb +73 -0
- data/lib/telnyx/models.rb +156 -0
- data/lib/telnyx/resources/ai/anthropic/v1.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +6 -1
- data/lib/telnyx/resources/ai/openai/chat.rb +3 -1
- data/lib/telnyx/resources/ai/openai.rb +3 -1
- data/lib/telnyx/resources/calls/actions.rb +87 -8
- data/lib/telnyx/resources/calls.rb +3 -1
- data/lib/telnyx/resources/custom_storage_credentials.rb +2 -2
- data/lib/telnyx/resources/dir/references.rb +31 -9
- data/lib/telnyx/resources/dir.rb +3 -2
- data/lib/telnyx/resources/email_blocks/import.rb +79 -0
- data/lib/telnyx/resources/email_blocks.rb +249 -0
- data/lib/telnyx/resources/email_domains/webhooks.rb +162 -0
- data/lib/telnyx/resources/email_domains.rb +245 -0
- data/lib/telnyx/resources/email_events.rb +81 -0
- data/lib/telnyx/resources/email_inboxes/drafts.rb +329 -0
- data/lib/telnyx/resources/email_inboxes/filters.rb +122 -0
- data/lib/telnyx/resources/email_inboxes/messages/actions.rb +149 -0
- data/lib/telnyx/resources/email_inboxes/messages/labels.rb +98 -0
- data/lib/telnyx/resources/email_inboxes/messages.rb +191 -0
- data/lib/telnyx/resources/email_inboxes/threads/labels.rb +93 -0
- data/lib/telnyx/resources/email_inboxes/threads.rb +97 -0
- data/lib/telnyx/resources/email_inboxes.rb +136 -0
- data/lib/telnyx/resources/email_messages/recipients.rb +84 -0
- data/lib/telnyx/resources/email_messages.rb +294 -0
- data/lib/telnyx/resources/email_templates.rb +213 -0
- data/lib/telnyx/resources/email_threads.rb +91 -0
- data/lib/telnyx/resources/email_unsubscribe_groups/suppressions.rb +111 -0
- data/lib/telnyx/resources/email_unsubscribe_groups.rb +151 -0
- data/lib/telnyx/resources/email_validations/batch.rb +69 -0
- data/lib/telnyx/resources/email_validations.rb +49 -0
- data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb +12 -4
- data/lib/telnyx/resources/phone_numbers/actions.rb +1 -1
- data/lib/telnyx/resources/pricing/products.rb +76 -0
- data/lib/telnyx/resources/pricing.rb +19 -0
- data/lib/telnyx/resources/short_codes.rb +1 -1
- data/lib/telnyx/resources/speech_to_text.rb +1 -1
- data/lib/telnyx/resources/text_to_speech.rb +5 -3
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/resources/whatsapp/phone_numbers/conversational_components.rb +66 -0
- data/lib/telnyx/resources/whatsapp/phone_numbers.rb +6 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +200 -1
- data/rbi/telnyx/client.rbi +41 -0
- data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +6 -2
- data/rbi/telnyx/models/ai/assistant_chat_params.rbi +19 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +15 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +15 -0
- data/rbi/telnyx/models/ai/transcription_settings.rbi +36 -2
- data/rbi/telnyx/models/attachment_request.rbi +83 -0
- data/rbi/telnyx/models/call_assistant_request.rbi +12 -3
- data/rbi/telnyx/models/call_dial_params.rbi +21 -0
- data/rbi/telnyx/models/call_payment_completed_webhook_event.rbi +724 -0
- data/rbi/telnyx/models/call_payment_progress_webhook_event.rbi +793 -0
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +15 -0
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +8 -0
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +8 -0
- data/rbi/telnyx/models/calls/action_pay_params.rbi +484 -0
- data/rbi/telnyx/models/calls/action_pay_response.rbi +39 -0
- data/rbi/telnyx/models/calls/action_speak_params.rbi +8 -0
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +0 -153
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +8 -0
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +21 -0
- data/rbi/telnyx/models/calls/pay_prompt_value.rbi +252 -0
- data/rbi/telnyx/models/calls/transcription_config.rbi +36 -2
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +469 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +8 -0
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +8 -0
- data/rbi/telnyx/models/custom_storage_configuration.rbi +90 -0
- data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +23 -3
- data/rbi/telnyx/models/dir/reference.rbi +8 -4
- data/rbi/telnyx/models/dir/reference_create_params.rbi +14 -2
- data/rbi/telnyx/models/dns_record.rbi +139 -0
- data/rbi/telnyx/models/domains_tracking_settings.rbi +66 -0
- data/rbi/telnyx/models/email_address_input.rbi +16 -0
- data/rbi/telnyx/models/email_block.rbi +218 -0
- data/rbi/telnyx/models/email_block_create_params.rbi +65 -0
- data/rbi/telnyx/models/email_block_delete_params.rbi +35 -0
- data/rbi/telnyx/models/email_block_list_params.rbi +217 -0
- data/rbi/telnyx/models/email_block_response.rbi +32 -0
- data/rbi/telnyx/models/email_block_retrieve_events_params.rbi +66 -0
- data/rbi/telnyx/models/email_block_retrieve_events_response.rbi +223 -0
- data/rbi/telnyx/models/email_block_retrieve_export_params.rbi +216 -0
- data/rbi/telnyx/models/email_block_retrieve_export_response.rbi +7 -0
- data/rbi/telnyx/models/email_block_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/email_blocks/email_block_import_response.rbi +363 -0
- data/rbi/telnyx/models/email_blocks/import_create_params.rbi +61 -0
- data/rbi/telnyx/models/email_blocks/import_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/email_dmarc_policy.rbi +113 -0
- data/rbi/telnyx/models/email_domain.rbi +376 -0
- data/rbi/telnyx/models/email_domain_create_params.rbi +80 -0
- data/rbi/telnyx/models/email_domain_delete_params.rbi +52 -0
- data/rbi/telnyx/models/email_domain_list_params.rbi +177 -0
- data/rbi/telnyx/models/email_domain_response.rbi +28 -0
- data/rbi/telnyx/models/email_domain_retrieve_dns_records_params.rbi +38 -0
- data/rbi/telnyx/models/email_domain_retrieve_dns_records_response.rbi +30 -0
- data/rbi/telnyx/models/email_domain_retrieve_health_params.rbi +38 -0
- data/rbi/telnyx/models/email_domain_retrieve_health_response.rbi +224 -0
- data/rbi/telnyx/models/email_domain_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/email_domain_status.rbi +25 -0
- data/rbi/telnyx/models/email_domain_type.rbi +21 -0
- data/rbi/telnyx/models/email_domain_update_params.rbi +80 -0
- data/rbi/telnyx/models/email_domain_verification.rbi +195 -0
- data/rbi/telnyx/models/email_domain_verify_params.rbi +35 -0
- data/rbi/telnyx/models/email_domains/email_webhook.rbi +114 -0
- data/rbi/telnyx/models/email_domains/email_webhook_event.rbi +124 -0
- data/rbi/telnyx/models/email_domains/email_webhook_response.rbi +35 -0
- data/rbi/telnyx/models/email_domains/offset_pagination_meta.rbi +53 -0
- data/rbi/telnyx/models/email_domains/webhook_create_params.rbi +65 -0
- data/rbi/telnyx/models/email_domains/webhook_delete_params.rbi +48 -0
- data/rbi/telnyx/models/email_domains/webhook_list_params.rbi +119 -0
- data/rbi/telnyx/models/email_domains/webhook_retrieve_params.rbi +48 -0
- data/rbi/telnyx/models/email_domains/webhook_update_params.rbi +81 -0
- data/rbi/telnyx/models/email_event_list_params.rbi +140 -0
- data/rbi/telnyx/models/email_event_list_response.rbi +272 -0
- data/rbi/telnyx/models/email_event_retrieve_stats_params.rbi +58 -0
- data/rbi/telnyx/models/email_event_retrieve_stats_response.rbi +339 -0
- data/rbi/telnyx/models/email_event_type.rbi +34 -0
- data/rbi/telnyx/models/email_inbox.rbi +119 -0
- data/rbi/telnyx/models/email_inbox_create_params.rbi +63 -0
- data/rbi/telnyx/models/email_inbox_delete_params.rbi +35 -0
- data/rbi/telnyx/models/email_inbox_list_params.rbi +57 -0
- data/rbi/telnyx/models/email_inbox_list_response.rbi +82 -0
- data/rbi/telnyx/models/email_inbox_response.rbi +26 -0
- data/rbi/telnyx/models/email_inbox_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/email_inboxes/draft_create_params.rbi +40 -0
- data/rbi/telnyx/models/email_inboxes/draft_delete_params.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/draft_list_params.rbi +129 -0
- data/rbi/telnyx/models/email_inboxes/draft_list_response.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/draft_patch_params.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/draft_retrieve_params.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/draft_send_params.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/draft_update_params.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/email_address.rbi +31 -0
- data/rbi/telnyx/models/email_inboxes/email_draft.rbi +296 -0
- data/rbi/telnyx/models/email_inboxes/email_draft_request.rbi +233 -0
- data/rbi/telnyx/models/email_inboxes/email_draft_response.rbi +39 -0
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +391 -0
- data/rbi/telnyx/models/email_inboxes/email_message_response.rbi +132 -0
- data/rbi/telnyx/models/email_inboxes/email_pagination_meta.rbi +43 -0
- data/rbi/telnyx/models/email_inboxes/filter_add_params.rbi +40 -0
- data/rbi/telnyx/models/email_inboxes/filter_add_response.rbi +119 -0
- data/rbi/telnyx/models/email_inboxes/filter_delete_all_params.rbi +40 -0
- data/rbi/telnyx/models/email_inboxes/filter_delete_all_response.rbi +125 -0
- data/rbi/telnyx/models/email_inboxes/filter_list_params.rbi +40 -0
- data/rbi/telnyx/models/email_inboxes/filter_list_response.rbi +119 -0
- data/rbi/telnyx/models/email_inboxes/filter_replace_params.rbi +64 -0
- data/rbi/telnyx/models/email_inboxes/filter_replace_response.rbi +123 -0
- data/rbi/telnyx/models/email_inboxes/inbound_email_address.rbi +34 -0
- data/rbi/telnyx/models/email_inboxes/inbound_thread.rbi +146 -0
- data/rbi/telnyx/models/email_inboxes/inbound_thread_detail.rbi +36 -0
- data/rbi/telnyx/models/email_inboxes/inbound_thread_list_response.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/message_drafts_params.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/message_list_params.rbi +162 -0
- data/rbi/telnyx/models/email_inboxes/message_list_response.rbi +48 -0
- data/rbi/telnyx/models/email_inboxes/message_update_params.rbi +124 -0
- data/rbi/telnyx/models/email_inboxes/message_update_response.rbi +33 -0
- data/rbi/telnyx/models/email_inboxes/messages/action_forward_params.rbi +312 -0
- data/rbi/telnyx/models/email_inboxes/messages/action_reply_all_params.rbi +50 -0
- data/rbi/telnyx/models/email_inboxes/messages/action_reply_params.rbi +50 -0
- data/rbi/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbi +62 -0
- data/rbi/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbi +74 -0
- data/rbi/telnyx/models/email_inboxes/messages/label_create_params.rbi +50 -0
- data/rbi/telnyx/models/email_inboxes/messages/label_create_response.rbi +37 -0
- data/rbi/telnyx/models/email_inboxes/messages/label_delete_all_params.rbi +50 -0
- data/rbi/telnyx/models/email_inboxes/messages/label_delete_all_response.rbi +37 -0
- data/rbi/telnyx/models/email_inboxes/messages/label_mutation_request.rbi +40 -0
- data/rbi/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rbi +49 -0
- data/rbi/telnyx/models/email_inboxes/mutate_inbox_filters_request.rbi +89 -0
- data/rbi/telnyx/models/email_inboxes/thread_list_params.rbi +81 -0
- data/rbi/telnyx/models/email_inboxes/thread_message.rbi +318 -0
- data/rbi/telnyx/models/email_inboxes/thread_retrieve_params.rbi +74 -0
- data/rbi/telnyx/models/email_inboxes/thread_retrieve_response.rbi +53 -0
- data/rbi/telnyx/models/email_inboxes/threads/label_create_params.rbi +50 -0
- data/rbi/telnyx/models/email_inboxes/threads/label_create_response.rbi +138 -0
- data/rbi/telnyx/models/email_inboxes/threads/label_delete_all_params.rbi +50 -0
- data/rbi/telnyx/models/email_inboxes/threads/label_delete_all_response.rbi +138 -0
- data/rbi/telnyx/models/email_message_batch_params.rbi +386 -0
- data/rbi/telnyx/models/email_message_batch_response.rbi +206 -0
- data/rbi/telnyx/models/email_message_create_params.rbi +391 -0
- data/rbi/telnyx/models/email_message_delete_all_params.rbi +40 -0
- data/rbi/telnyx/models/email_message_delete_params.rbi +35 -0
- data/rbi/telnyx/models/email_message_delete_schedule_params.rbi +38 -0
- data/rbi/telnyx/models/email_message_list_params.rbi +59 -0
- data/rbi/telnyx/models/email_message_list_response.rbi +46 -0
- data/rbi/telnyx/models/email_message_retrieve_events_params.rbi +68 -0
- data/rbi/telnyx/models/email_message_retrieve_events_response.rbi +46 -0
- data/rbi/telnyx/models/email_message_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/email_message_retrieve_response.rbi +81 -0
- data/rbi/telnyx/models/email_messages/email_recipient.rbi +260 -0
- data/rbi/telnyx/models/email_messages/recipient_list_params.rbi +218 -0
- data/rbi/telnyx/models/email_messages/recipient_list_response.rbi +91 -0
- data/rbi/telnyx/models/email_messages/recipient_retrieve_params.rbi +48 -0
- data/rbi/telnyx/models/email_messages/recipient_retrieve_response.rbi +37 -0
- data/rbi/telnyx/models/email_template.rbi +103 -0
- data/rbi/telnyx/models/email_template_create_params.rbi +87 -0
- data/rbi/telnyx/models/email_template_delete_params.rbi +35 -0
- data/rbi/telnyx/models/email_template_list_params.rbi +59 -0
- data/rbi/telnyx/models/email_template_list_response.rbi +46 -0
- data/rbi/telnyx/models/email_template_render_params.rbi +54 -0
- data/rbi/telnyx/models/email_template_render_response.rbi +70 -0
- data/rbi/telnyx/models/email_template_replace_params.rbi +35 -0
- data/rbi/telnyx/models/email_template_response.rbi +28 -0
- data/rbi/telnyx/models/email_template_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/email_template_update_params.rbi +35 -0
- data/rbi/telnyx/models/email_thread_list_params.rbi +89 -0
- data/rbi/telnyx/models/email_thread_retrieve_params.rbi +71 -0
- data/rbi/telnyx/models/email_thread_retrieve_response.rbi +51 -0
- data/rbi/telnyx/models/email_unsubscribe_group_create_params.rbi +46 -0
- data/rbi/telnyx/models/email_unsubscribe_group_delete_params.rbi +121 -0
- data/rbi/telnyx/models/email_unsubscribe_group_list_params.rbi +60 -0
- data/rbi/telnyx/models/email_unsubscribe_group_retrieve_params.rbi +38 -0
- data/rbi/telnyx/models/email_unsubscribe_group_update_params.rbi +54 -0
- data/rbi/telnyx/models/email_unsubscribe_groups/suppression_create_params.rbi +44 -0
- data/rbi/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rbi +48 -0
- data/rbi/telnyx/models/email_unsubscribe_groups/suppression_list_params.rbi +68 -0
- data/rbi/telnyx/models/email_validation_check.rbi +36 -0
- data/rbi/telnyx/models/email_validation_create_params.rbi +54 -0
- data/rbi/telnyx/models/email_validation_create_response.rbi +261 -0
- data/rbi/telnyx/models/email_validations/batch_create_params.rbi +68 -0
- data/rbi/telnyx/models/email_validations/batch_create_response.rbi +161 -0
- data/rbi/telnyx/models/email_validations/batch_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/email_validations/batch_retrieve_response.rbi +386 -0
- data/rbi/telnyx/models/email_validations/email_validation_batch_status.rbi +50 -0
- data/rbi/telnyx/models/fax.rbi +54 -0
- data/rbi/telnyx/models/fax_failed.rbi +21 -46
- data/rbi/telnyx/models/group_list_meta.rbi +47 -0
- data/rbi/telnyx/models/inbound_message.rbi +17 -329
- data/rbi/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rbi +33 -5
- data/rbi/telnyx/models/message_event.rbi +44 -0
- data/rbi/telnyx/models/messaging_10dlc/phone_number_campaign.rbi +25 -3
- data/rbi/telnyx/models/model_metadata.rbi +46 -0
- data/rbi/telnyx/models/offset_meta.rbi +46 -0
- data/rbi/telnyx/models/phone_numbers/action_change_bundle_status_params.rbi +3 -3
- data/rbi/telnyx/models/pricing/pricing_pagination_meta.rbi +55 -0
- data/rbi/telnyx/models/pricing/pricing_tier.rbi +75 -0
- data/rbi/telnyx/models/pricing/product_list_params.rbi +59 -0
- data/rbi/telnyx/models/pricing/product_list_response.rbi +50 -0
- data/rbi/telnyx/models/pricing/product_retrieve_params.rbi +68 -0
- data/rbi/telnyx/models/pricing/product_retrieve_response.rbi +312 -0
- data/rbi/telnyx/models/s3_configuration_data.rbi +19 -31
- data/rbi/telnyx/models/short_code.rbi +2 -0
- data/rbi/telnyx/models/short_code_update_params.rbi +2 -0
- data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +10 -0
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +20 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +136 -0
- 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 -0
- data/rbi/telnyx/models/time_range.rbi +28 -0
- data/rbi/telnyx/models/tracking_settings.rbi +49 -0
- data/rbi/telnyx/models/uac_external_settings.rbi +10 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +2 -0
- data/rbi/telnyx/models/unsubscribe_group.rbi +92 -0
- data/rbi/telnyx/models/unsubscribe_group_response.rbi +28 -0
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +2 -0
- data/rbi/telnyx/models/update_email_template_request.rbi +71 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbi +3 -6
- data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_list_params.rbi +42 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbi +180 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_params.rbi +125 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbi +180 -0
- data/rbi/telnyx/models.rbi +169 -0
- data/rbi/telnyx/resources/ai/anthropic/v1.rbi +3 -1
- data/rbi/telnyx/resources/ai/assistants.rbi +7 -0
- data/rbi/telnyx/resources/ai/openai/chat.rbi +5 -0
- data/rbi/telnyx/resources/ai/openai.rbi +5 -0
- data/rbi/telnyx/resources/calls/actions.rbi +124 -44
- data/rbi/telnyx/resources/calls.rbi +8 -0
- data/rbi/telnyx/resources/conferences/actions.rbi +4 -0
- data/rbi/telnyx/resources/custom_storage_credentials.rbi +2 -0
- data/rbi/telnyx/resources/dir/references.rbi +41 -10
- data/rbi/telnyx/resources/dir.rbi +3 -2
- data/rbi/telnyx/resources/email_blocks/import.rbi +61 -0
- data/rbi/telnyx/resources/email_blocks.rbi +198 -0
- data/rbi/telnyx/resources/email_domains/webhooks.rbi +122 -0
- data/rbi/telnyx/resources/email_domains.rbi +180 -0
- data/rbi/telnyx/resources/email_events.rbi +67 -0
- data/rbi/telnyx/resources/email_inboxes/drafts.rbi +319 -0
- data/rbi/telnyx/resources/email_inboxes/filters.rbi +94 -0
- data/rbi/telnyx/resources/email_inboxes/messages/actions.rbi +155 -0
- data/rbi/telnyx/resources/email_inboxes/messages/labels.rbi +80 -0
- data/rbi/telnyx/resources/email_inboxes/messages.rbi +185 -0
- data/rbi/telnyx/resources/email_inboxes/threads/labels.rbi +75 -0
- data/rbi/telnyx/resources/email_inboxes/threads.rbi +70 -0
- data/rbi/telnyx/resources/email_inboxes.rbi +100 -0
- data/rbi/telnyx/resources/email_messages/recipients.rbi +66 -0
- data/rbi/telnyx/resources/email_messages.rbi +299 -0
- data/rbi/telnyx/resources/email_templates.rbi +167 -0
- data/rbi/telnyx/resources/email_threads.rbi +74 -0
- data/rbi/telnyx/resources/email_unsubscribe_groups/suppressions.rbi +83 -0
- data/rbi/telnyx/resources/email_unsubscribe_groups.rbi +110 -0
- data/rbi/telnyx/resources/email_validations/batch.rbi +59 -0
- data/rbi/telnyx/resources/email_validations.rbi +42 -0
- data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi +15 -3
- data/rbi/telnyx/resources/phone_numbers/actions.rbi +1 -1
- data/rbi/telnyx/resources/pricing/products.rbi +62 -0
- data/rbi/telnyx/resources/pricing.rbi +16 -0
- data/rbi/telnyx/resources/short_codes.rbi +1 -0
- data/rbi/telnyx/resources/speech_to_text.rbi +1 -1
- data/rbi/telnyx/resources/text_to_speech.rbi +7 -2
- data/rbi/telnyx/resources/webhooks.rbi +4 -0
- data/rbi/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbi +58 -0
- data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +8 -0
- data/sig/telnyx/client.rbs +20 -0
- data/sig/telnyx/models/ai/assistant_chat_params.rbs +8 -1
- data/sig/telnyx/models/ai/chat_completion_request.rbs +7 -0
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +7 -0
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/attachment_request.rbs +48 -0
- data/sig/telnyx/models/call_assistant_request.rbs +12 -3
- data/sig/telnyx/models/call_dial_params.rbs +7 -0
- data/sig/telnyx/models/call_payment_completed_webhook_event.rbs +337 -0
- data/sig/telnyx/models/call_payment_progress_webhook_event.rbs +349 -0
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +8 -1
- data/sig/telnyx/models/calls/action_pay_params.rbs +261 -0
- data/sig/telnyx/models/calls/action_pay_response.rbs +20 -0
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -32
- data/sig/telnyx/models/calls/action_transfer_params.rbs +7 -0
- data/sig/telnyx/models/calls/pay_prompt_value.rbs +99 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +158 -0
- data/sig/telnyx/models/custom_storage_configuration.rbs +45 -1
- data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +13 -3
- data/sig/telnyx/models/dns_record.rbs +98 -0
- data/sig/telnyx/models/domains_tracking_settings.rbs +32 -0
- data/sig/telnyx/models/email_address_input.rbs +11 -0
- data/sig/telnyx/models/email_block.rbs +142 -0
- data/sig/telnyx/models/email_block_create_params.rbs +36 -0
- data/sig/telnyx/models/email_block_delete_params.rbs +20 -0
- data/sig/telnyx/models/email_block_list_params.rbs +114 -0
- data/sig/telnyx/models/email_block_response.rbs +13 -0
- data/sig/telnyx/models/email_block_retrieve_events_params.rbs +36 -0
- data/sig/telnyx/models/email_block_retrieve_events_response.rbs +100 -0
- data/sig/telnyx/models/email_block_retrieve_export_params.rbs +100 -0
- data/sig/telnyx/models/email_block_retrieve_export_response.rbs +5 -0
- data/sig/telnyx/models/email_block_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/email_blocks/email_block_import_response.rbs +165 -0
- data/sig/telnyx/models/email_blocks/import_create_params.rbs +32 -0
- data/sig/telnyx/models/email_blocks/import_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/email_dmarc_policy.rbs +65 -0
- data/sig/telnyx/models/email_domain.rbs +216 -0
- data/sig/telnyx/models/email_domain_create_params.rbs +47 -0
- data/sig/telnyx/models/email_domain_delete_params.rbs +29 -0
- data/sig/telnyx/models/email_domain_list_params.rbs +117 -0
- data/sig/telnyx/models/email_domain_response.rbs +13 -0
- data/sig/telnyx/models/email_domain_retrieve_dns_records_params.rbs +23 -0
- data/sig/telnyx/models/email_domain_retrieve_dns_records_response.rbs +14 -0
- data/sig/telnyx/models/email_domain_retrieve_health_params.rbs +20 -0
- data/sig/telnyx/models/email_domain_retrieve_health_response.rbs +91 -0
- data/sig/telnyx/models/email_domain_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/email_domain_status.rbs +19 -0
- data/sig/telnyx/models/email_domain_type.rbs +15 -0
- data/sig/telnyx/models/email_domain_update_params.rbs +47 -0
- data/sig/telnyx/models/email_domain_verification.rbs +102 -0
- data/sig/telnyx/models/email_domain_verify_params.rbs +23 -0
- data/sig/telnyx/models/email_domains/email_webhook.rbs +62 -0
- data/sig/telnyx/models/email_domains/email_webhook_event.rbs +52 -0
- data/sig/telnyx/models/email_domains/email_webhook_response.rbs +15 -0
- data/sig/telnyx/models/email_domains/offset_pagination_meta.rbs +37 -0
- data/sig/telnyx/models/email_domains/webhook_create_params.rbs +38 -0
- data/sig/telnyx/models/email_domains/webhook_delete_params.rbs +30 -0
- data/sig/telnyx/models/email_domains/webhook_list_params.rbs +62 -0
- data/sig/telnyx/models/email_domains/webhook_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/email_domains/webhook_update_params.rbs +49 -0
- data/sig/telnyx/models/email_event_list_params.rbs +75 -0
- data/sig/telnyx/models/email_event_list_response.rbs +149 -0
- data/sig/telnyx/models/email_event_retrieve_stats_params.rbs +31 -0
- data/sig/telnyx/models/email_event_retrieve_stats_response.rbs +164 -0
- data/sig/telnyx/models/email_event_type.rbs +44 -0
- data/sig/telnyx/models/email_inbox.rbs +81 -0
- data/sig/telnyx/models/email_inbox_create_params.rbs +32 -0
- data/sig/telnyx/models/email_inbox_delete_params.rbs +20 -0
- data/sig/telnyx/models/email_inbox_list_params.rbs +32 -0
- data/sig/telnyx/models/email_inbox_list_response.rbs +39 -0
- data/sig/telnyx/models/email_inbox_response.rbs +13 -0
- data/sig/telnyx/models/email_inbox_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/email_inboxes/draft_create_params.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/draft_delete_params.rbs +30 -0
- data/sig/telnyx/models/email_inboxes/draft_list_params.rbs +63 -0
- data/sig/telnyx/models/email_inboxes/draft_list_response.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/draft_patch_params.rbs +34 -0
- data/sig/telnyx/models/email_inboxes/draft_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/email_inboxes/draft_send_params.rbs +30 -0
- data/sig/telnyx/models/email_inboxes/draft_update_params.rbs +34 -0
- data/sig/telnyx/models/email_inboxes/email_address.rbs +19 -0
- data/sig/telnyx/models/email_inboxes/email_draft.rbs +185 -0
- data/sig/telnyx/models/email_inboxes/email_draft_request.rbs +135 -0
- data/sig/telnyx/models/email_inboxes/email_draft_response.rbs +15 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +213 -0
- data/sig/telnyx/models/email_inboxes/email_message_response.rbs +58 -0
- data/sig/telnyx/models/email_inboxes/email_pagination_meta.rbs +19 -0
- data/sig/telnyx/models/email_inboxes/filter_add_params.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/filter_add_response.rbs +57 -0
- data/sig/telnyx/models/email_inboxes/filter_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/filter_delete_all_response.rbs +57 -0
- data/sig/telnyx/models/email_inboxes/filter_list_params.rbs +25 -0
- data/sig/telnyx/models/email_inboxes/filter_list_response.rbs +57 -0
- data/sig/telnyx/models/email_inboxes/filter_replace_params.rbs +42 -0
- data/sig/telnyx/models/email_inboxes/filter_replace_response.rbs +57 -0
- data/sig/telnyx/models/email_inboxes/inbound_email_address.rbs +19 -0
- data/sig/telnyx/models/email_inboxes/inbound_thread.rbs +87 -0
- data/sig/telnyx/models/email_inboxes/inbound_thread_detail.rbs +24 -0
- data/sig/telnyx/models/email_inboxes/inbound_thread_list_response.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/message_drafts_params.rbs +34 -0
- data/sig/telnyx/models/email_inboxes/message_list_params.rbs +98 -0
- data/sig/telnyx/models/email_inboxes/message_list_response.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/message_update_params.rbs +48 -0
- data/sig/telnyx/models/email_inboxes/message_update_response.rbs +15 -0
- data/sig/telnyx/models/email_inboxes/messages/action_forward_params.rbs +99 -0
- data/sig/telnyx/models/email_inboxes/messages/action_reply_all_params.rbs +36 -0
- data/sig/telnyx/models/email_inboxes/messages/action_reply_params.rbs +36 -0
- data/sig/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbs +31 -0
- data/sig/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbs +34 -0
- data/sig/telnyx/models/email_inboxes/messages/label_create_params.rbs +36 -0
- data/sig/telnyx/models/email_inboxes/messages/label_create_response.rbs +17 -0
- data/sig/telnyx/models/email_inboxes/messages/label_delete_all_params.rbs +36 -0
- data/sig/telnyx/models/email_inboxes/messages/label_delete_all_response.rbs +17 -0
- data/sig/telnyx/models/email_inboxes/messages/label_mutation_request.rbs +17 -0
- data/sig/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rbs +23 -0
- data/sig/telnyx/models/email_inboxes/mutate_inbox_filters_request.rbs +38 -0
- data/sig/telnyx/models/email_inboxes/thread_list_params.rbs +49 -0
- data/sig/telnyx/models/email_inboxes/thread_message.rbs +178 -0
- data/sig/telnyx/models/email_inboxes/thread_retrieve_params.rbs +47 -0
- data/sig/telnyx/models/email_inboxes/thread_retrieve_response.rbs +27 -0
- data/sig/telnyx/models/email_inboxes/threads/label_create_params.rbs +36 -0
- data/sig/telnyx/models/email_inboxes/threads/label_create_response.rbs +68 -0
- data/sig/telnyx/models/email_inboxes/threads/label_delete_all_params.rbs +36 -0
- data/sig/telnyx/models/email_inboxes/threads/label_delete_all_response.rbs +68 -0
- data/sig/telnyx/models/email_message_batch_params.rbs +208 -0
- data/sig/telnyx/models/email_message_batch_response.rbs +98 -0
- data/sig/telnyx/models/email_message_create_params.rbs +199 -0
- data/sig/telnyx/models/email_message_delete_all_params.rbs +23 -0
- data/sig/telnyx/models/email_message_delete_params.rbs +20 -0
- data/sig/telnyx/models/email_message_delete_schedule_params.rbs +23 -0
- data/sig/telnyx/models/email_message_list_params.rbs +32 -0
- data/sig/telnyx/models/email_message_list_response.rbs +25 -0
- data/sig/telnyx/models/email_message_retrieve_events_params.rbs +36 -0
- data/sig/telnyx/models/email_message_retrieve_events_response.rbs +25 -0
- data/sig/telnyx/models/email_message_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/email_message_retrieve_response.rbs +34 -0
- data/sig/telnyx/models/email_messages/email_recipient.rbs +126 -0
- data/sig/telnyx/models/email_messages/recipient_list_params.rbs +99 -0
- data/sig/telnyx/models/email_messages/recipient_list_response.rbs +39 -0
- data/sig/telnyx/models/email_messages/recipient_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/email_messages/recipient_retrieve_response.rbs +16 -0
- data/sig/telnyx/models/email_template.rbs +70 -0
- data/sig/telnyx/models/email_template_create_params.rbs +55 -0
- data/sig/telnyx/models/email_template_delete_params.rbs +20 -0
- data/sig/telnyx/models/email_template_list_params.rbs +32 -0
- data/sig/telnyx/models/email_template_list_response.rbs +25 -0
- data/sig/telnyx/models/email_template_render_params.rbs +30 -0
- data/sig/telnyx/models/email_template_render_response.rbs +26 -0
- data/sig/telnyx/models/email_template_replace_params.rbs +22 -0
- data/sig/telnyx/models/email_template_response.rbs +13 -0
- data/sig/telnyx/models/email_template_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/email_template_update_params.rbs +22 -0
- data/sig/telnyx/models/email_thread_list_params.rbs +49 -0
- data/sig/telnyx/models/email_thread_retrieve_params.rbs +45 -0
- data/sig/telnyx/models/email_thread_retrieve_response.rbs +25 -0
- data/sig/telnyx/models/email_unsubscribe_group_create_params.rbs +28 -0
- data/sig/telnyx/models/email_unsubscribe_group_delete_params.rbs +46 -0
- data/sig/telnyx/models/email_unsubscribe_group_list_params.rbs +32 -0
- data/sig/telnyx/models/email_unsubscribe_group_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/email_unsubscribe_group_update_params.rbs +34 -0
- data/sig/telnyx/models/email_unsubscribe_groups/suppression_create_params.rbs +29 -0
- data/sig/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rbs +30 -0
- data/sig/telnyx/models/email_unsubscribe_groups/suppression_list_params.rbs +38 -0
- data/sig/telnyx/models/email_validation_check.rbs +17 -0
- data/sig/telnyx/models/email_validation_create_params.rbs +30 -0
- data/sig/telnyx/models/email_validation_create_response.rbs +121 -0
- data/sig/telnyx/models/email_validations/batch_create_params.rbs +42 -0
- data/sig/telnyx/models/email_validations/batch_create_response.rbs +74 -0
- data/sig/telnyx/models/email_validations/batch_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/email_validations/batch_retrieve_response.rbs +173 -0
- data/sig/telnyx/models/email_validations/email_validation_batch_status.rbs +21 -0
- data/sig/telnyx/models/fax.rbs +10 -0
- data/sig/telnyx/models/fax_failed.rbs +12 -17
- data/sig/telnyx/models/group_list_meta.rbs +35 -0
- data/sig/telnyx/models/inbound_message.rbs +13 -205
- data/sig/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rbs +20 -3
- data/sig/telnyx/models/message_event.rbs +32 -0
- data/sig/telnyx/models/messaging_10dlc/phone_number_campaign.rbs +17 -3
- data/sig/telnyx/models/model_metadata.rbs +21 -0
- data/sig/telnyx/models/offset_meta.rbs +35 -0
- data/sig/telnyx/models/phone_numbers/action_change_bundle_status_params.rbs +4 -4
- data/sig/telnyx/models/pricing/pricing_pagination_meta.rbs +39 -0
- data/sig/telnyx/models/pricing/pricing_tier.rbs +42 -0
- data/sig/telnyx/models/pricing/product_list_params.rbs +34 -0
- data/sig/telnyx/models/pricing/product_list_response.rbs +24 -0
- data/sig/telnyx/models/pricing/product_retrieve_params.rbs +38 -0
- data/sig/telnyx/models/pricing/product_retrieve_response.rbs +164 -0
- data/sig/telnyx/models/s3_configuration_data.rbs +11 -19
- data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +4 -0
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +8 -0
- data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +56 -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 -0
- data/sig/telnyx/models/time_range.rbs +15 -0
- data/sig/telnyx/models/tracking_settings.rbs +19 -0
- data/sig/telnyx/models/uac_external_settings.rbs +5 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/unsubscribe_group.rbs +55 -0
- data/sig/telnyx/models/unsubscribe_group_response.rbs +13 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
- data/sig/telnyx/models/update_email_template_request.rbs +44 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbs +4 -6
- data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_list_params.rbs +27 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbs +86 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_params.rbs +62 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbs +86 -0
- data/sig/telnyx/models.rbs +156 -0
- data/sig/telnyx/resources/ai/assistants.rbs +1 -0
- data/sig/telnyx/resources/ai/openai/chat.rbs +1 -0
- data/sig/telnyx/resources/ai/openai.rbs +1 -0
- data/sig/telnyx/resources/calls/actions.rbs +25 -2
- data/sig/telnyx/resources/calls.rbs +1 -0
- data/sig/telnyx/resources/email_blocks/import.rbs +20 -0
- data/sig/telnyx/resources/email_blocks.rbs +58 -0
- data/sig/telnyx/resources/email_domains/webhooks.rbs +44 -0
- data/sig/telnyx/resources/email_domains.rbs +66 -0
- data/sig/telnyx/resources/email_events.rbs +23 -0
- data/sig/telnyx/resources/email_inboxes/drafts.rbs +100 -0
- data/sig/telnyx/resources/email_inboxes/filters.rbs +35 -0
- data/sig/telnyx/resources/email_inboxes/messages/actions.rbs +38 -0
- data/sig/telnyx/resources/email_inboxes/messages/labels.rbs +25 -0
- data/sig/telnyx/resources/email_inboxes/messages.rbs +57 -0
- data/sig/telnyx/resources/email_inboxes/threads/labels.rbs +25 -0
- data/sig/telnyx/resources/email_inboxes/threads.rbs +27 -0
- data/sig/telnyx/resources/email_inboxes.rbs +34 -0
- data/sig/telnyx/resources/email_messages/recipients.rbs +24 -0
- data/sig/telnyx/resources/email_messages.rbs +76 -0
- data/sig/telnyx/resources/email_templates.rbs +56 -0
- data/sig/telnyx/resources/email_threads.rbs +23 -0
- data/sig/telnyx/resources/email_unsubscribe_groups/suppressions.rbs +28 -0
- data/sig/telnyx/resources/email_unsubscribe_groups.rbs +39 -0
- data/sig/telnyx/resources/email_validations/batch.rbs +21 -0
- data/sig/telnyx/resources/email_validations.rbs +15 -0
- data/sig/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbs +3 -1
- data/sig/telnyx/resources/phone_numbers/actions.rbs +1 -1
- data/sig/telnyx/resources/pricing/products.rbs +22 -0
- data/sig/telnyx/resources/pricing.rbs +9 -0
- data/sig/telnyx/resources/text_to_speech.rbs +1 -0
- data/sig/telnyx/resources/webhooks.rbs +4 -0
- data/sig/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbs +23 -0
- data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +2 -0
- metadata +602 -5
- data/lib/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_response.rb +0 -29
- data/rbi/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_response.rbi +0 -87
- data/sig/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_response.rbs +0 -39
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::EmailMessages#batch
|
|
6
|
+
class EmailMessageBatchParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute messages
|
|
11
|
+
#
|
|
12
|
+
# @return [Array<Telnyx::Models::EmailMessageBatchParams::Message>]
|
|
13
|
+
required :messages, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailMessageBatchParams::Message] }
|
|
14
|
+
|
|
15
|
+
# @!attribute sandbox_mode
|
|
16
|
+
# Applies sandbox mode to all messages in the batch. Overrides any per-message
|
|
17
|
+
# sandbox_mode in the messages array.
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :sandbox_mode, Telnyx::Internal::Type::Boolean
|
|
21
|
+
|
|
22
|
+
# @!attribute idempotency_key
|
|
23
|
+
#
|
|
24
|
+
# @return [String, nil]
|
|
25
|
+
optional :idempotency_key, String
|
|
26
|
+
|
|
27
|
+
# @!method initialize(messages:, sandbox_mode: nil, idempotency_key: nil, request_options: {})
|
|
28
|
+
# Some parameter documentations has been truncated, see
|
|
29
|
+
# {Telnyx::Models::EmailMessageBatchParams} for more details.
|
|
30
|
+
#
|
|
31
|
+
# @param messages [Array<Telnyx::Models::EmailMessageBatchParams::Message>]
|
|
32
|
+
#
|
|
33
|
+
# @param sandbox_mode [Boolean] Applies sandbox mode to all messages in the batch. Overrides any per-message san
|
|
34
|
+
#
|
|
35
|
+
# @param idempotency_key [String]
|
|
36
|
+
#
|
|
37
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
38
|
+
|
|
39
|
+
class Message < Telnyx::Internal::Type::BaseModel
|
|
40
|
+
# @!attribute from
|
|
41
|
+
#
|
|
42
|
+
# @return [String, Telnyx::Models::EmailInboxes::EmailAddress]
|
|
43
|
+
required :from, union: -> { Telnyx::EmailAddressInput }
|
|
44
|
+
|
|
45
|
+
# @!attribute to
|
|
46
|
+
#
|
|
47
|
+
# @return [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
48
|
+
required :to, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }
|
|
49
|
+
|
|
50
|
+
# @!attribute attachments
|
|
51
|
+
#
|
|
52
|
+
# @return [Array<Telnyx::Models::AttachmentRequest>, nil]
|
|
53
|
+
optional :attachments, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AttachmentRequest] }
|
|
54
|
+
|
|
55
|
+
# @!attribute bcc
|
|
56
|
+
#
|
|
57
|
+
# @return [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil]
|
|
58
|
+
optional :bcc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }
|
|
59
|
+
|
|
60
|
+
# @!attribute cc
|
|
61
|
+
#
|
|
62
|
+
# @return [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil]
|
|
63
|
+
optional :cc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }
|
|
64
|
+
|
|
65
|
+
# @!attribute from_name
|
|
66
|
+
# Optional display name for string `from`; overrides `from.name` when provided.
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :from_name, String
|
|
70
|
+
|
|
71
|
+
# @!attribute group_id
|
|
72
|
+
# Optional unsubscribe-group UUID used for group-scoped suppression checks and
|
|
73
|
+
# unsubscribe handling.
|
|
74
|
+
#
|
|
75
|
+
# @return [String, nil]
|
|
76
|
+
optional :group_id, String, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute headers
|
|
79
|
+
# Custom email headers. Write-only; not returned in responses.
|
|
80
|
+
#
|
|
81
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
82
|
+
optional :headers, Telnyx::Internal::Type::HashOf[String]
|
|
83
|
+
|
|
84
|
+
# @!attribute html_body
|
|
85
|
+
# HTML email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
86
|
+
# create and list responses.
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :html_body, String
|
|
90
|
+
|
|
91
|
+
# @!attribute ignore_suppression
|
|
92
|
+
# When true, allows delivery to recipients whose suppressions explicitly permit an
|
|
93
|
+
# override. Hard bounces, spam complaints, and invalid-address suppressions cannot
|
|
94
|
+
# be overridden. Requires the `email:override` API scope.
|
|
95
|
+
#
|
|
96
|
+
# @return [Boolean, nil]
|
|
97
|
+
optional :ignore_suppression, Telnyx::Internal::Type::Boolean
|
|
98
|
+
|
|
99
|
+
# @!attribute inline_css
|
|
100
|
+
#
|
|
101
|
+
# @return [Boolean, nil]
|
|
102
|
+
optional :inline_css, Telnyx::Internal::Type::Boolean
|
|
103
|
+
|
|
104
|
+
# @!attribute metadata
|
|
105
|
+
# Custom metadata. Write-only; not returned in responses.
|
|
106
|
+
#
|
|
107
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
108
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
109
|
+
|
|
110
|
+
# @!attribute reply_to
|
|
111
|
+
# Reply-to address. If provided as an object with a name, only the email is
|
|
112
|
+
# stored; the name is ignored.
|
|
113
|
+
#
|
|
114
|
+
# @return [String, Telnyx::Models::EmailInboxes::EmailAddress, nil]
|
|
115
|
+
optional :reply_to, union: -> { Telnyx::EmailAddressInput }
|
|
116
|
+
|
|
117
|
+
# @!attribute sandbox_mode
|
|
118
|
+
#
|
|
119
|
+
# @return [Boolean, nil]
|
|
120
|
+
optional :sandbox_mode, Telnyx::Internal::Type::Boolean
|
|
121
|
+
|
|
122
|
+
# @!attribute scheduled_at
|
|
123
|
+
# Future ISO 8601 time to schedule sending. Invalid or past timestamps are
|
|
124
|
+
# silently ignored and the email is sent immediately. The legacy alias `send_at`
|
|
125
|
+
# is still accepted for backward compatibility; when both are provided,
|
|
126
|
+
# `scheduled_at` wins.
|
|
127
|
+
#
|
|
128
|
+
# @return [Time, nil]
|
|
129
|
+
optional :scheduled_at, Time, nil?: true
|
|
130
|
+
|
|
131
|
+
# @!attribute send_at
|
|
132
|
+
# @deprecated
|
|
133
|
+
#
|
|
134
|
+
# Deprecated alias for `scheduled_at`.
|
|
135
|
+
#
|
|
136
|
+
# @return [Time, nil]
|
|
137
|
+
optional :send_at, Time
|
|
138
|
+
|
|
139
|
+
# @!attribute subject
|
|
140
|
+
# Required unless `template_id` is supplied. When using a template, the template's
|
|
141
|
+
# subject is rendered; if the template has no subject or renders empty, the
|
|
142
|
+
# request returns 400.
|
|
143
|
+
#
|
|
144
|
+
# @return [String, nil]
|
|
145
|
+
optional :subject, String
|
|
146
|
+
|
|
147
|
+
# @!attribute tags
|
|
148
|
+
# Tags for categorization and reporting. Stored on the message and propagated to
|
|
149
|
+
# Email Detail Records. Not returned in API responses.
|
|
150
|
+
#
|
|
151
|
+
# @return [Array<String>, nil]
|
|
152
|
+
optional :tags, Telnyx::Internal::Type::ArrayOf[String]
|
|
153
|
+
|
|
154
|
+
# @!attribute template_id
|
|
155
|
+
#
|
|
156
|
+
# @return [String, nil]
|
|
157
|
+
optional :template_id, String
|
|
158
|
+
|
|
159
|
+
# @!attribute template_variables
|
|
160
|
+
# Variables for Liquid template rendering. Non-object values may cause a 422
|
|
161
|
+
# validation error on message creation, but are silently treated as an empty
|
|
162
|
+
# object for template rendering.
|
|
163
|
+
#
|
|
164
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
165
|
+
optional :template_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
166
|
+
|
|
167
|
+
# @!attribute text_body
|
|
168
|
+
# Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
169
|
+
# create and list responses.
|
|
170
|
+
#
|
|
171
|
+
# @return [String, nil]
|
|
172
|
+
optional :text_body, String
|
|
173
|
+
|
|
174
|
+
# @!attribute tracking_settings
|
|
175
|
+
# Per-send open and click tracking overrides. Omitted properties inherit the
|
|
176
|
+
# sender domain's tracking settings.
|
|
177
|
+
#
|
|
178
|
+
# @return [Telnyx::Models::TrackingSettings, nil]
|
|
179
|
+
optional :tracking_settings, -> { Telnyx::TrackingSettings }
|
|
180
|
+
|
|
181
|
+
# @!method initialize(from:, to:, attachments: nil, bcc: nil, cc: nil, from_name: nil, group_id: nil, headers: nil, html_body: nil, ignore_suppression: nil, inline_css: nil, metadata: nil, reply_to: nil, sandbox_mode: nil, scheduled_at: nil, send_at: nil, subject: nil, tags: nil, template_id: nil, template_variables: nil, text_body: nil, tracking_settings: nil)
|
|
182
|
+
# Some parameter documentations has been truncated, see
|
|
183
|
+
# {Telnyx::Models::EmailMessageBatchParams::Message} for more details.
|
|
184
|
+
#
|
|
185
|
+
# A single message in a batch create request. This schema mirrors
|
|
186
|
+
# `CreateEmailRequest` EXCEPT it does not accept the reply/forward threading
|
|
187
|
+
# parameters (`in_reply_to_message_id`, `reply_to_all`, `forward_of_message_id`) —
|
|
188
|
+
# those are single-send-only in Phase 1 (MSG-1491) and are not yet implemented on
|
|
189
|
+
# the batch endpoint. Recipient email addresses must be unique across `to`, `cc`,
|
|
190
|
+
# and `bcc` after case-insensitive normalization. Duplicate recipients return
|
|
191
|
+
# `400`.
|
|
192
|
+
#
|
|
193
|
+
# @param from [String, Telnyx::Models::EmailInboxes::EmailAddress]
|
|
194
|
+
#
|
|
195
|
+
# @param to [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
196
|
+
#
|
|
197
|
+
# @param attachments [Array<Telnyx::Models::AttachmentRequest>]
|
|
198
|
+
#
|
|
199
|
+
# @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
200
|
+
#
|
|
201
|
+
# @param cc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
202
|
+
#
|
|
203
|
+
# @param from_name [String] Optional display name for string `from`; overrides `from.name` when provided.
|
|
204
|
+
#
|
|
205
|
+
# @param group_id [String, nil] Optional unsubscribe-group UUID used for group-scoped suppression checks and uns
|
|
206
|
+
#
|
|
207
|
+
# @param headers [Hash{Symbol=>String}] Custom email headers. Write-only; not returned in responses.
|
|
208
|
+
#
|
|
209
|
+
# @param html_body [String] HTML email body. Returned only by `GET /email_messages/{id}`; omitted from creat
|
|
210
|
+
#
|
|
211
|
+
# @param ignore_suppression [Boolean] When true, allows delivery to recipients whose suppressions explicitly
|
|
212
|
+
#
|
|
213
|
+
# @param inline_css [Boolean]
|
|
214
|
+
#
|
|
215
|
+
# @param metadata [Hash{Symbol=>Object}] Custom metadata. Write-only; not returned in responses.
|
|
216
|
+
#
|
|
217
|
+
# @param reply_to [String, Telnyx::Models::EmailInboxes::EmailAddress] Reply-to address. If provided as an object with a name, only the email is stored
|
|
218
|
+
#
|
|
219
|
+
# @param sandbox_mode [Boolean]
|
|
220
|
+
#
|
|
221
|
+
# @param scheduled_at [Time, nil] Future ISO 8601 time to schedule sending. Invalid or past timestamps
|
|
222
|
+
#
|
|
223
|
+
# @param send_at [Time] Deprecated alias for `scheduled_at`.
|
|
224
|
+
#
|
|
225
|
+
# @param subject [String] Required unless `template_id` is supplied. When using a template, the template's
|
|
226
|
+
#
|
|
227
|
+
# @param tags [Array<String>] Tags for categorization and reporting. Stored on the message and propagated to E
|
|
228
|
+
#
|
|
229
|
+
# @param template_id [String]
|
|
230
|
+
#
|
|
231
|
+
# @param template_variables [Hash{Symbol=>Object}] Variables for Liquid template rendering. Non-object values may cause a 422 valid
|
|
232
|
+
#
|
|
233
|
+
# @param text_body [String] Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
234
|
+
#
|
|
235
|
+
# @param tracking_settings [Telnyx::Models::TrackingSettings] Per-send open and click tracking overrides. Omitted properties inherit the sende
|
|
236
|
+
end
|
|
237
|
+
end
|
|
238
|
+
end
|
|
239
|
+
end
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::EmailMessages#batch
|
|
6
|
+
class EmailMessageBatchResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<Telnyx::Models::EmailInboxes::EmailMessage>]
|
|
10
|
+
required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailMessage] }
|
|
11
|
+
|
|
12
|
+
# @!attribute errors
|
|
13
|
+
#
|
|
14
|
+
# @return [Array<Telnyx::Models::EmailMessageBatchResponse::Error>]
|
|
15
|
+
required :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::EmailMessageBatchResponse::Error] }
|
|
16
|
+
|
|
17
|
+
# @!attribute meta
|
|
18
|
+
#
|
|
19
|
+
# @return [Telnyx::Models::EmailMessageBatchResponse::Meta]
|
|
20
|
+
required :meta, -> { Telnyx::Models::EmailMessageBatchResponse::Meta }
|
|
21
|
+
|
|
22
|
+
# @!method initialize(data:, errors:, meta:)
|
|
23
|
+
# @param data [Array<Telnyx::Models::EmailInboxes::EmailMessage>]
|
|
24
|
+
# @param errors [Array<Telnyx::Models::EmailMessageBatchResponse::Error>]
|
|
25
|
+
# @param meta [Telnyx::Models::EmailMessageBatchResponse::Meta]
|
|
26
|
+
|
|
27
|
+
class Error < Telnyx::Internal::Type::BaseModel
|
|
28
|
+
# @!attribute code
|
|
29
|
+
# Batch item errors use `message` (not `detail`) for the human-readable text.
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, Telnyx::Models::EmailMessageBatchResponse::Error::Code]
|
|
32
|
+
required :code, enum: -> { Telnyx::Models::EmailMessageBatchResponse::Error::Code }
|
|
33
|
+
|
|
34
|
+
# @!attribute index
|
|
35
|
+
# Zero-based index of the failed message in the request array.
|
|
36
|
+
#
|
|
37
|
+
# @return [Integer]
|
|
38
|
+
required :index, Integer
|
|
39
|
+
|
|
40
|
+
# @!attribute message
|
|
41
|
+
#
|
|
42
|
+
# @return [String]
|
|
43
|
+
required :message, String
|
|
44
|
+
|
|
45
|
+
# @!method initialize(code:, index:, message:)
|
|
46
|
+
# @param code [Symbol, Telnyx::Models::EmailMessageBatchResponse::Error::Code] Batch item errors use `message` (not `detail`) for the human-readable text.
|
|
47
|
+
#
|
|
48
|
+
# @param index [Integer] Zero-based index of the failed message in the request array.
|
|
49
|
+
#
|
|
50
|
+
# @param message [String]
|
|
51
|
+
|
|
52
|
+
# Batch item errors use `message` (not `detail`) for the human-readable text.
|
|
53
|
+
#
|
|
54
|
+
# @see Telnyx::Models::EmailMessageBatchResponse::Error#code
|
|
55
|
+
module Code
|
|
56
|
+
extend Telnyx::Internal::Type::Enum
|
|
57
|
+
|
|
58
|
+
BAD_REQUEST = :bad_request
|
|
59
|
+
NOT_FOUND = :not_found
|
|
60
|
+
FORBIDDEN = :forbidden
|
|
61
|
+
SERVICE_UNAVAILABLE = :service_unavailable
|
|
62
|
+
VALIDATION_ERROR = :validation_error
|
|
63
|
+
RECIPIENT_SUPPRESSED = :recipient_suppressed
|
|
64
|
+
REPUTATION_SUSPENDED = :reputation_suspended
|
|
65
|
+
|
|
66
|
+
# @!method self.values
|
|
67
|
+
# @return [Array<Symbol>]
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# @see Telnyx::Models::EmailMessageBatchResponse#meta
|
|
72
|
+
class Meta < Telnyx::Internal::Type::BaseModel
|
|
73
|
+
# @!attribute failed
|
|
74
|
+
#
|
|
75
|
+
# @return [Integer]
|
|
76
|
+
required :failed, Integer
|
|
77
|
+
|
|
78
|
+
# @!attribute succeeded
|
|
79
|
+
#
|
|
80
|
+
# @return [Integer]
|
|
81
|
+
required :succeeded, Integer
|
|
82
|
+
|
|
83
|
+
# @!attribute total
|
|
84
|
+
#
|
|
85
|
+
# @return [Integer]
|
|
86
|
+
required :total, Integer
|
|
87
|
+
|
|
88
|
+
# @!method initialize(failed:, succeeded:, total:)
|
|
89
|
+
# @param failed [Integer]
|
|
90
|
+
# @param succeeded [Integer]
|
|
91
|
+
# @param total [Integer]
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
end
|
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::EmailMessages#create
|
|
6
|
+
class EmailMessageCreateParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute from
|
|
11
|
+
#
|
|
12
|
+
# @return [String, Telnyx::Models::EmailInboxes::EmailAddress]
|
|
13
|
+
required :from, union: -> { Telnyx::EmailAddressInput }
|
|
14
|
+
|
|
15
|
+
# @!attribute to
|
|
16
|
+
#
|
|
17
|
+
# @return [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
18
|
+
required :to, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }
|
|
19
|
+
|
|
20
|
+
# @!attribute attachments
|
|
21
|
+
#
|
|
22
|
+
# @return [Array<Telnyx::Models::AttachmentRequest>, nil]
|
|
23
|
+
optional :attachments, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AttachmentRequest] }
|
|
24
|
+
|
|
25
|
+
# @!attribute bcc
|
|
26
|
+
#
|
|
27
|
+
# @return [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil]
|
|
28
|
+
optional :bcc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }
|
|
29
|
+
|
|
30
|
+
# @!attribute cc
|
|
31
|
+
#
|
|
32
|
+
# @return [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil]
|
|
33
|
+
optional :cc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }
|
|
34
|
+
|
|
35
|
+
# @!attribute forward_of_message_id
|
|
36
|
+
# Telnyx message UUID of the message this send forwards. Forwarded messages start
|
|
37
|
+
# a NEW thread per RFC 5322 — NO `In-Reply-To` or `References` headers are set on
|
|
38
|
+
# the outbound MIME. The id is recorded in the message's metadata for EDR
|
|
39
|
+
# provenance only.
|
|
40
|
+
#
|
|
41
|
+
# The id is validated as a UUID but is NOT looked up against the message store —
|
|
42
|
+
# existence is the caller's responsibility (the forward is pure metadata; it does
|
|
43
|
+
# not affect delivery). Cannot be combined with `in_reply_to_message_id` (422).
|
|
44
|
+
#
|
|
45
|
+
# @return [String, nil]
|
|
46
|
+
optional :forward_of_message_id, String, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute from_name
|
|
49
|
+
# Optional display name for string `from`; overrides `from.name` when provided.
|
|
50
|
+
#
|
|
51
|
+
# @return [String, nil]
|
|
52
|
+
optional :from_name, String
|
|
53
|
+
|
|
54
|
+
# @!attribute group_id
|
|
55
|
+
# Optional unsubscribe-group UUID used for group-scoped suppression checks and
|
|
56
|
+
# unsubscribe handling.
|
|
57
|
+
#
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
optional :group_id, String, nil?: true
|
|
60
|
+
|
|
61
|
+
# @!attribute headers
|
|
62
|
+
# Custom email headers. Write-only; not returned in responses.
|
|
63
|
+
#
|
|
64
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
65
|
+
optional :headers, Telnyx::Internal::Type::HashOf[String]
|
|
66
|
+
|
|
67
|
+
# @!attribute html_body
|
|
68
|
+
# HTML email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
69
|
+
# create and list responses.
|
|
70
|
+
#
|
|
71
|
+
# @return [String, nil]
|
|
72
|
+
optional :html_body, String
|
|
73
|
+
|
|
74
|
+
# @!attribute ignore_suppression
|
|
75
|
+
# When true, allows delivery to recipients whose suppressions explicitly permit an
|
|
76
|
+
# override. Hard bounces, spam complaints, and invalid-address suppressions cannot
|
|
77
|
+
# be overridden. Requires the `email:override` API scope.
|
|
78
|
+
#
|
|
79
|
+
# @return [Boolean, nil]
|
|
80
|
+
optional :ignore_suppression, Telnyx::Internal::Type::Boolean
|
|
81
|
+
|
|
82
|
+
# @!attribute in_reply_to_message_id
|
|
83
|
+
# Telnyx message UUID of the message this send replies to. When provided, the API
|
|
84
|
+
# sets RFC 5322 `In-Reply-To` and `References` headers on the outbound MIME so the
|
|
85
|
+
# recipient's mailbox (Gmail/Outlook) threads it correctly. The parent is looked
|
|
86
|
+
# up under the caller's account scope; a UUID belonging to another account yields
|
|
87
|
+
# a non-enumerating 404.
|
|
88
|
+
#
|
|
89
|
+
# Wire-only (Phase 1): the API sets the headers and does NOT resolve or mutate
|
|
90
|
+
# `thread_id` on the server side. Messages sent without this parameter are
|
|
91
|
+
# standalone (no threading headers injected).
|
|
92
|
+
#
|
|
93
|
+
# Cannot be combined with `forward_of_message_id` (422).
|
|
94
|
+
#
|
|
95
|
+
# @return [String, nil]
|
|
96
|
+
optional :in_reply_to_message_id, String, nil?: true
|
|
97
|
+
|
|
98
|
+
# @!attribute inline_css
|
|
99
|
+
#
|
|
100
|
+
# @return [Boolean, nil]
|
|
101
|
+
optional :inline_css, Telnyx::Internal::Type::Boolean
|
|
102
|
+
|
|
103
|
+
# @!attribute metadata
|
|
104
|
+
# Custom metadata. Write-only; not returned in responses.
|
|
105
|
+
#
|
|
106
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
107
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
108
|
+
|
|
109
|
+
# @!attribute reply_to
|
|
110
|
+
# Reply-to address. If provided as an object with a name, only the email is
|
|
111
|
+
# stored; the name is ignored.
|
|
112
|
+
#
|
|
113
|
+
# @return [String, Telnyx::Models::EmailInboxes::EmailAddress, nil]
|
|
114
|
+
optional :reply_to, union: -> { Telnyx::EmailAddressInput }
|
|
115
|
+
|
|
116
|
+
# @!attribute reply_to_all
|
|
117
|
+
# Indicates a reply-all intent. In Phase 1 (wire-only) this does not change the
|
|
118
|
+
# threading headers — recipient selection is customer- controlled (`to`/`cc`), and
|
|
119
|
+
# a thread is not defined by its audience. When the referenced message has no
|
|
120
|
+
# thread context, reply-all degrades to a plain reply (parent ID only in
|
|
121
|
+
# `References`). The resolution engine (separate work) will expand the ancestor
|
|
122
|
+
# chain at a later phase with no API change.
|
|
123
|
+
#
|
|
124
|
+
# Only meaningful alongside `in_reply_to_message_id`.
|
|
125
|
+
#
|
|
126
|
+
# @return [Boolean, nil]
|
|
127
|
+
optional :reply_to_all, Telnyx::Internal::Type::Boolean, nil?: true
|
|
128
|
+
|
|
129
|
+
# @!attribute sandbox_mode
|
|
130
|
+
#
|
|
131
|
+
# @return [Boolean, nil]
|
|
132
|
+
optional :sandbox_mode, Telnyx::Internal::Type::Boolean
|
|
133
|
+
|
|
134
|
+
# @!attribute scheduled_at
|
|
135
|
+
# Future ISO 8601 time to schedule sending. Invalid or past timestamps are
|
|
136
|
+
# silently ignored and the email is sent immediately. The legacy alias `send_at`
|
|
137
|
+
# is still accepted for backward compatibility; when both are provided,
|
|
138
|
+
# `scheduled_at` wins.
|
|
139
|
+
#
|
|
140
|
+
# @return [Time, nil]
|
|
141
|
+
optional :scheduled_at, Time, nil?: true
|
|
142
|
+
|
|
143
|
+
# @!attribute send_at
|
|
144
|
+
# @deprecated
|
|
145
|
+
#
|
|
146
|
+
# Deprecated alias for `scheduled_at`.
|
|
147
|
+
#
|
|
148
|
+
# @return [Time, nil]
|
|
149
|
+
optional :send_at, Time
|
|
150
|
+
|
|
151
|
+
# @!attribute subject
|
|
152
|
+
# Required unless `template_id` is supplied. When using a template, the template's
|
|
153
|
+
# subject is rendered; if the template has no subject or renders empty, the
|
|
154
|
+
# request returns 400.
|
|
155
|
+
#
|
|
156
|
+
# @return [String, nil]
|
|
157
|
+
optional :subject, String
|
|
158
|
+
|
|
159
|
+
# @!attribute tags
|
|
160
|
+
# Tags for categorization and reporting. Stored on the message and propagated to
|
|
161
|
+
# Email Detail Records. Not returned in API responses.
|
|
162
|
+
#
|
|
163
|
+
# @return [Array<String>, nil]
|
|
164
|
+
optional :tags, Telnyx::Internal::Type::ArrayOf[String]
|
|
165
|
+
|
|
166
|
+
# @!attribute template_id
|
|
167
|
+
#
|
|
168
|
+
# @return [String, nil]
|
|
169
|
+
optional :template_id, String
|
|
170
|
+
|
|
171
|
+
# @!attribute template_variables
|
|
172
|
+
# Variables for Liquid template rendering. Non-object values may cause a 422
|
|
173
|
+
# validation error on message creation, but are silently treated as an empty
|
|
174
|
+
# object for template rendering.
|
|
175
|
+
#
|
|
176
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
177
|
+
optional :template_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
178
|
+
|
|
179
|
+
# @!attribute text_body
|
|
180
|
+
# Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
181
|
+
# create and list responses.
|
|
182
|
+
#
|
|
183
|
+
# @return [String, nil]
|
|
184
|
+
optional :text_body, String
|
|
185
|
+
|
|
186
|
+
# @!attribute tracking_settings
|
|
187
|
+
# Per-send open and click tracking overrides. Omitted properties inherit the
|
|
188
|
+
# sender domain's tracking settings.
|
|
189
|
+
#
|
|
190
|
+
# @return [Telnyx::Models::TrackingSettings, nil]
|
|
191
|
+
optional :tracking_settings, -> { Telnyx::TrackingSettings }
|
|
192
|
+
|
|
193
|
+
# @!attribute idempotency_key
|
|
194
|
+
#
|
|
195
|
+
# @return [String, nil]
|
|
196
|
+
optional :idempotency_key, String
|
|
197
|
+
|
|
198
|
+
# @!method initialize(from:, to:, attachments: nil, bcc: nil, cc: nil, forward_of_message_id: nil, from_name: nil, group_id: nil, headers: nil, html_body: nil, ignore_suppression: nil, in_reply_to_message_id: nil, inline_css: nil, metadata: nil, reply_to: nil, reply_to_all: nil, sandbox_mode: nil, scheduled_at: nil, send_at: nil, subject: nil, tags: nil, template_id: nil, template_variables: nil, text_body: nil, tracking_settings: nil, idempotency_key: nil, request_options: {})
|
|
199
|
+
# Some parameter documentations has been truncated, see
|
|
200
|
+
# {Telnyx::Models::EmailMessageCreateParams} for more details.
|
|
201
|
+
#
|
|
202
|
+
# @param from [String, Telnyx::Models::EmailInboxes::EmailAddress]
|
|
203
|
+
#
|
|
204
|
+
# @param to [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
205
|
+
#
|
|
206
|
+
# @param attachments [Array<Telnyx::Models::AttachmentRequest>]
|
|
207
|
+
#
|
|
208
|
+
# @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
209
|
+
#
|
|
210
|
+
# @param cc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
|
|
211
|
+
#
|
|
212
|
+
# @param forward_of_message_id [String, nil] Telnyx message UUID of the message this send forwards. Forwarded
|
|
213
|
+
#
|
|
214
|
+
# @param from_name [String] Optional display name for string `from`; overrides `from.name` when provided.
|
|
215
|
+
#
|
|
216
|
+
# @param group_id [String, nil] Optional unsubscribe-group UUID used for group-scoped suppression checks and uns
|
|
217
|
+
#
|
|
218
|
+
# @param headers [Hash{Symbol=>String}] Custom email headers. Write-only; not returned in responses.
|
|
219
|
+
#
|
|
220
|
+
# @param html_body [String] HTML email body. Returned only by `GET /email_messages/{id}`; omitted from creat
|
|
221
|
+
#
|
|
222
|
+
# @param ignore_suppression [Boolean] When true, allows delivery to recipients whose suppressions explicitly
|
|
223
|
+
#
|
|
224
|
+
# @param in_reply_to_message_id [String, nil] Telnyx message UUID of the message this send replies to. When provided,
|
|
225
|
+
#
|
|
226
|
+
# @param inline_css [Boolean]
|
|
227
|
+
#
|
|
228
|
+
# @param metadata [Hash{Symbol=>Object}] Custom metadata. Write-only; not returned in responses.
|
|
229
|
+
#
|
|
230
|
+
# @param reply_to [String, Telnyx::Models::EmailInboxes::EmailAddress] Reply-to address. If provided as an object with a name, only the email is stored
|
|
231
|
+
#
|
|
232
|
+
# @param reply_to_all [Boolean, nil] Indicates a reply-all intent. In Phase 1 (wire-only) this does not
|
|
233
|
+
#
|
|
234
|
+
# @param sandbox_mode [Boolean]
|
|
235
|
+
#
|
|
236
|
+
# @param scheduled_at [Time, nil] Future ISO 8601 time to schedule sending. Invalid or past timestamps
|
|
237
|
+
#
|
|
238
|
+
# @param send_at [Time] Deprecated alias for `scheduled_at`.
|
|
239
|
+
#
|
|
240
|
+
# @param subject [String] Required unless `template_id` is supplied. When using a template, the template's
|
|
241
|
+
#
|
|
242
|
+
# @param tags [Array<String>] Tags for categorization and reporting. Stored on the message and propagated to E
|
|
243
|
+
#
|
|
244
|
+
# @param template_id [String]
|
|
245
|
+
#
|
|
246
|
+
# @param template_variables [Hash{Symbol=>Object}] Variables for Liquid template rendering. Non-object values may cause a 422 valid
|
|
247
|
+
#
|
|
248
|
+
# @param text_body [String] Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
|
|
249
|
+
#
|
|
250
|
+
# @param tracking_settings [Telnyx::Models::TrackingSettings] Per-send open and click tracking overrides. Omitted properties inherit the sende
|
|
251
|
+
#
|
|
252
|
+
# @param idempotency_key [String]
|
|
253
|
+
#
|
|
254
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
255
|
+
end
|
|
256
|
+
end
|
|
257
|
+
end
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::EmailMessages#delete_all
|
|
6
|
+
class EmailMessageDeleteAllParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute address
|
|
11
|
+
# Sender or recipient address to delete. Matching is trimmed and case-insensitive.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :address, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(address:, request_options: {})
|
|
17
|
+
# Some parameter documentations has been truncated, see
|
|
18
|
+
# {Telnyx::Models::EmailMessageDeleteAllParams} for more details.
|
|
19
|
+
#
|
|
20
|
+
# @param address [String] Sender or recipient address to delete. Matching is trimmed and case-insensitive.
|
|
21
|
+
#
|
|
22
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::EmailMessages#delete
|
|
6
|
+
class EmailMessageDeleteParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(id:, request_options: {})
|
|
16
|
+
# @param id [String]
|
|
17
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::EmailMessages#delete_schedule
|
|
6
|
+
class EmailMessageDeleteScheduleParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute email_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :email_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(email_id:, request_options: {})
|
|
16
|
+
# @param email_id [String]
|
|
17
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|