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
|
@@ -34,7 +34,15 @@ module Telnyx
|
|
|
34
34
|
optional :messages,
|
|
35
35
|
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Calls::ActionAddAIAssistantMessagesParams::Message] }
|
|
36
36
|
|
|
37
|
-
# @!
|
|
37
|
+
# @!attribute trigger_response
|
|
38
|
+
# When `true`, the injected messages immediately trigger an assistant
|
|
39
|
+
# response/turn instead of waiting for the next natural turn or idle timeout. This
|
|
40
|
+
# may interrupt a user who is still speaking.
|
|
41
|
+
#
|
|
42
|
+
# @return [Boolean, nil]
|
|
43
|
+
optional :trigger_response, Telnyx::Internal::Type::Boolean
|
|
44
|
+
|
|
45
|
+
# @!method initialize(call_control_id:, client_state: nil, command_id: nil, messages: nil, trigger_response: nil, request_options: {})
|
|
38
46
|
# Some parameter documentations has been truncated, see
|
|
39
47
|
# {Telnyx::Models::Calls::ActionAddAIAssistantMessagesParams} for more details.
|
|
40
48
|
#
|
|
@@ -46,6 +54,8 @@ module Telnyx
|
|
|
46
54
|
#
|
|
47
55
|
# @param messages [Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>] The messages to add to the conversation.
|
|
48
56
|
#
|
|
57
|
+
# @param trigger_response [Boolean] When `true`, the injected messages immediately trigger an assistant response/tur
|
|
58
|
+
#
|
|
49
59
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
50
60
|
|
|
51
61
|
# Messages sent by an end user
|
|
@@ -141,6 +141,10 @@ module Telnyx
|
|
|
141
141
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
142
142
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
143
143
|
# `ara`, `rex`, `sal`, `leo`.
|
|
144
|
+
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
145
|
+
# `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
|
|
146
|
+
# `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
|
|
147
|
+
# `ModelId` segment.
|
|
144
148
|
#
|
|
145
149
|
# @return [String, nil]
|
|
146
150
|
optional :voice, String
|
|
@@ -69,6 +69,10 @@ module Telnyx
|
|
|
69
69
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
70
70
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
71
71
|
# `ara`, `rex`, `sal`, `leo`.
|
|
72
|
+
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
73
|
+
# `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
|
|
74
|
+
# `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
|
|
75
|
+
# `ModelId` segment.
|
|
72
76
|
#
|
|
73
77
|
# For service_level basic, you may define the gender of the speaker (male or
|
|
74
78
|
# female).
|
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#pay
|
|
7
|
+
class ActionPayParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute call_control_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :call_control_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute amount
|
|
17
|
+
# Amount to charge. Required when `transaction_type` is `charge`.
|
|
18
|
+
#
|
|
19
|
+
# @return [Float, nil]
|
|
20
|
+
optional :amount, Float
|
|
21
|
+
|
|
22
|
+
# @!attribute client_state
|
|
23
|
+
# Base64-encoded state included in subsequent webhooks.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :client_state, String
|
|
27
|
+
|
|
28
|
+
# @!attribute command_id
|
|
29
|
+
# Idempotency key for the command. Telnyx ignores a duplicate command with the
|
|
30
|
+
# same `command_id` for the same `call_control_id`.
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :command_id, String
|
|
34
|
+
|
|
35
|
+
# @!attribute connector_name
|
|
36
|
+
# Name of the Pay connector used to process the transaction.
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :connector_name, String
|
|
40
|
+
|
|
41
|
+
# @!attribute currency
|
|
42
|
+
# Currency used for the transaction. Pay currently supports USD only.
|
|
43
|
+
#
|
|
44
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionPayParams::Currency, nil]
|
|
45
|
+
optional :currency, enum: -> { Telnyx::Calls::ActionPayParams::Currency }
|
|
46
|
+
|
|
47
|
+
# @!attribute description
|
|
48
|
+
# Optional description forwarded with the payment transaction.
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :description, String
|
|
52
|
+
|
|
53
|
+
# @!attribute inter_digit_timeout_millis
|
|
54
|
+
# Time in milliseconds to wait between consecutive DTMF digits.
|
|
55
|
+
#
|
|
56
|
+
# @return [Integer, nil]
|
|
57
|
+
optional :inter_digit_timeout_millis, Integer
|
|
58
|
+
|
|
59
|
+
# @!attribute language
|
|
60
|
+
# Language used for payment prompts.
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :language, String
|
|
64
|
+
|
|
65
|
+
# @!attribute max_attempts
|
|
66
|
+
# Maximum number of attempts for each payment collection step.
|
|
67
|
+
#
|
|
68
|
+
# @return [Integer, nil]
|
|
69
|
+
optional :max_attempts, Integer
|
|
70
|
+
|
|
71
|
+
# @!attribute metadata
|
|
72
|
+
# Metadata forwarded to the Pay connector.
|
|
73
|
+
#
|
|
74
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
75
|
+
optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
76
|
+
|
|
77
|
+
# @!attribute parameters
|
|
78
|
+
# Additional parameters forwarded to the Pay connector.
|
|
79
|
+
#
|
|
80
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
81
|
+
optional :parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
82
|
+
|
|
83
|
+
# @!attribute payment_method
|
|
84
|
+
# Payment method to collect.
|
|
85
|
+
#
|
|
86
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionPayParams::PaymentMethod, nil]
|
|
87
|
+
optional :payment_method, enum: -> { Telnyx::Calls::ActionPayParams::PaymentMethod }
|
|
88
|
+
|
|
89
|
+
# @!attribute payment_token
|
|
90
|
+
# Existing payment token. When supplied, payment-detail collection is skipped.
|
|
91
|
+
#
|
|
92
|
+
# @return [String, nil]
|
|
93
|
+
optional :payment_token, String
|
|
94
|
+
|
|
95
|
+
# @!attribute prompts
|
|
96
|
+
# Custom text-to-speech prompts keyed by payment collection step.
|
|
97
|
+
#
|
|
98
|
+
# @return [Telnyx::Models::Calls::ActionPayParams::Prompts, nil]
|
|
99
|
+
optional :prompts, -> { Telnyx::Calls::ActionPayParams::Prompts }
|
|
100
|
+
|
|
101
|
+
# @!attribute service_level
|
|
102
|
+
# Speech synthesis service level used for payment prompts. Pay defaults to
|
|
103
|
+
# `premium`.
|
|
104
|
+
#
|
|
105
|
+
# @return [String, nil]
|
|
106
|
+
optional :service_level, String
|
|
107
|
+
|
|
108
|
+
# @!attribute timeout_millis
|
|
109
|
+
# Time in milliseconds to wait for DTMF input for each collection step.
|
|
110
|
+
#
|
|
111
|
+
# @return [Integer, nil]
|
|
112
|
+
optional :timeout_millis, Integer
|
|
113
|
+
|
|
114
|
+
# @!attribute transaction_type
|
|
115
|
+
# Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is
|
|
116
|
+
# absent or zero and `charge` when `amount` is positive.
|
|
117
|
+
#
|
|
118
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionPayParams::TransactionType, nil]
|
|
119
|
+
optional :transaction_type, enum: -> { Telnyx::Calls::ActionPayParams::TransactionType }
|
|
120
|
+
|
|
121
|
+
# @!attribute voice
|
|
122
|
+
# Voice used for payment prompts. Accepts `male`, `female`, or a provider voice in
|
|
123
|
+
# `<Provider>.<Model>.<VoiceId>` format, for example `AWS.Polly.Joanna` or
|
|
124
|
+
# `Telnyx.KokoroTTS.af`.
|
|
125
|
+
#
|
|
126
|
+
# @return [String, nil]
|
|
127
|
+
optional :voice, String
|
|
128
|
+
|
|
129
|
+
# @!method initialize(call_control_id:, amount: nil, client_state: nil, command_id: nil, connector_name: nil, currency: nil, description: nil, inter_digit_timeout_millis: nil, language: nil, max_attempts: nil, metadata: nil, parameters: nil, payment_method: nil, payment_token: nil, prompts: nil, service_level: nil, timeout_millis: nil, transaction_type: nil, voice: nil, request_options: {})
|
|
130
|
+
# Some parameter documentations has been truncated, see
|
|
131
|
+
# {Telnyx::Models::Calls::ActionPayParams} for more details.
|
|
132
|
+
#
|
|
133
|
+
# @param call_control_id [String]
|
|
134
|
+
#
|
|
135
|
+
# @param amount [Float] Amount to charge. Required when `transaction_type` is `charge`.
|
|
136
|
+
#
|
|
137
|
+
# @param client_state [String] Base64-encoded state included in subsequent webhooks.
|
|
138
|
+
#
|
|
139
|
+
# @param command_id [String] Idempotency key for the command. Telnyx ignores a duplicate command with the sam
|
|
140
|
+
#
|
|
141
|
+
# @param connector_name [String] Name of the Pay connector used to process the transaction.
|
|
142
|
+
#
|
|
143
|
+
# @param currency [Symbol, Telnyx::Models::Calls::ActionPayParams::Currency] Currency used for the transaction. Pay currently supports USD only.
|
|
144
|
+
#
|
|
145
|
+
# @param description [String] Optional description forwarded with the payment transaction.
|
|
146
|
+
#
|
|
147
|
+
# @param inter_digit_timeout_millis [Integer] Time in milliseconds to wait between consecutive DTMF digits.
|
|
148
|
+
#
|
|
149
|
+
# @param language [String] Language used for payment prompts.
|
|
150
|
+
#
|
|
151
|
+
# @param max_attempts [Integer] Maximum number of attempts for each payment collection step.
|
|
152
|
+
#
|
|
153
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata forwarded to the Pay connector.
|
|
154
|
+
#
|
|
155
|
+
# @param parameters [Hash{Symbol=>Object}] Additional parameters forwarded to the Pay connector.
|
|
156
|
+
#
|
|
157
|
+
# @param payment_method [Symbol, Telnyx::Models::Calls::ActionPayParams::PaymentMethod] Payment method to collect.
|
|
158
|
+
#
|
|
159
|
+
# @param payment_token [String] Existing payment token. When supplied, payment-detail collection is skipped.
|
|
160
|
+
#
|
|
161
|
+
# @param prompts [Telnyx::Models::Calls::ActionPayParams::Prompts] Custom text-to-speech prompts keyed by payment collection step.
|
|
162
|
+
#
|
|
163
|
+
# @param service_level [String] Speech synthesis service level used for payment prompts. Pay defaults to `premiu
|
|
164
|
+
#
|
|
165
|
+
# @param timeout_millis [Integer] Time in milliseconds to wait for DTMF input for each collection step.
|
|
166
|
+
#
|
|
167
|
+
# @param transaction_type [Symbol, Telnyx::Models::Calls::ActionPayParams::TransactionType] Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is absen
|
|
168
|
+
#
|
|
169
|
+
# @param voice [String] Voice used for payment prompts. Accepts `male`, `female`, or a provider voice in
|
|
170
|
+
#
|
|
171
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
172
|
+
|
|
173
|
+
# Currency used for the transaction. Pay currently supports USD only.
|
|
174
|
+
module Currency
|
|
175
|
+
extend Telnyx::Internal::Type::Enum
|
|
176
|
+
|
|
177
|
+
USD = :USD
|
|
178
|
+
USD_2 = :usd
|
|
179
|
+
|
|
180
|
+
# @!method self.values
|
|
181
|
+
# @return [Array<Symbol>]
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
# Payment method to collect.
|
|
185
|
+
module PaymentMethod
|
|
186
|
+
extend Telnyx::Internal::Type::Enum
|
|
187
|
+
|
|
188
|
+
CREDIT_CARD = :"credit-card"
|
|
189
|
+
ACH_DEBIT = :"ach-debit"
|
|
190
|
+
|
|
191
|
+
# @!method self.values
|
|
192
|
+
# @return [Array<Symbol>]
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
class Prompts < Telnyx::Internal::Type::BaseModel
|
|
196
|
+
# @!attribute bank_account_number
|
|
197
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
198
|
+
#
|
|
199
|
+
# @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
|
|
200
|
+
optional :bank_account_number,
|
|
201
|
+
union: -> { Telnyx::Calls::PayPromptValue },
|
|
202
|
+
api_name: :"bank-account-number"
|
|
203
|
+
|
|
204
|
+
# @!attribute bank_routing_number
|
|
205
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
206
|
+
#
|
|
207
|
+
# @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
|
|
208
|
+
optional :bank_routing_number,
|
|
209
|
+
union: -> { Telnyx::Calls::PayPromptValue },
|
|
210
|
+
api_name: :"bank-routing-number"
|
|
211
|
+
|
|
212
|
+
# @!attribute expiration_date
|
|
213
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
214
|
+
#
|
|
215
|
+
# @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
|
|
216
|
+
optional :expiration_date, union: -> { Telnyx::Calls::PayPromptValue }, api_name: :"expiration-date"
|
|
217
|
+
|
|
218
|
+
# @!attribute payment_card_number
|
|
219
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
220
|
+
#
|
|
221
|
+
# @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
|
|
222
|
+
optional :payment_card_number,
|
|
223
|
+
union: -> { Telnyx::Calls::PayPromptValue },
|
|
224
|
+
api_name: :"payment-card-number"
|
|
225
|
+
|
|
226
|
+
# @!attribute postal_code
|
|
227
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
228
|
+
#
|
|
229
|
+
# @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
|
|
230
|
+
optional :postal_code, union: -> { Telnyx::Calls::PayPromptValue }, api_name: :"postal-code"
|
|
231
|
+
|
|
232
|
+
# @!attribute security_code
|
|
233
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
234
|
+
#
|
|
235
|
+
# @return [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>, nil]
|
|
236
|
+
optional :security_code, union: -> { Telnyx::Calls::PayPromptValue }, api_name: :"security-code"
|
|
237
|
+
|
|
238
|
+
# @!method initialize(bank_account_number: nil, bank_routing_number: nil, expiration_date: nil, payment_card_number: nil, postal_code: nil, security_code: nil)
|
|
239
|
+
# Custom text-to-speech prompts keyed by payment collection step.
|
|
240
|
+
#
|
|
241
|
+
# @param bank_account_number [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
|
|
242
|
+
#
|
|
243
|
+
# @param bank_routing_number [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
|
|
244
|
+
#
|
|
245
|
+
# @param expiration_date [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
|
|
246
|
+
#
|
|
247
|
+
# @param payment_card_number [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
|
|
248
|
+
#
|
|
249
|
+
# @param postal_code [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
|
|
250
|
+
#
|
|
251
|
+
# @param security_code [String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>] A default prompt string or an ordered list of qualified prompts.
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is
|
|
255
|
+
# absent or zero and `charge` when `amount` is positive.
|
|
256
|
+
module TransactionType
|
|
257
|
+
extend Telnyx::Internal::Type::Enum
|
|
258
|
+
|
|
259
|
+
CHARGE = :charge
|
|
260
|
+
TOKENIZE = :tokenize
|
|
261
|
+
|
|
262
|
+
# @!method self.values
|
|
263
|
+
# @return [Array<Symbol>]
|
|
264
|
+
end
|
|
265
|
+
end
|
|
266
|
+
end
|
|
267
|
+
end
|
|
268
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#pay
|
|
7
|
+
class ActionPayResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Calls::CallControlCommandResult, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Calls::CallControlCommandResult }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Calls::CallControlCommandResult]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -69,6 +69,10 @@ module Telnyx
|
|
|
69
69
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
70
70
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
71
71
|
# `ara`, `rex`, `sal`, `leo`.
|
|
72
|
+
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
73
|
+
# `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
|
|
74
|
+
# `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
|
|
75
|
+
# `ModelId` segment.
|
|
72
76
|
#
|
|
73
77
|
# For service_level basic, you may define the gender of the speaker (male or
|
|
74
78
|
# female).
|
|
@@ -79,48 +79,7 @@ module Telnyx
|
|
|
79
79
|
# @return [Telnyx::Models::Calls::TranscriptionConfig, nil]
|
|
80
80
|
optional :transcription, -> { Telnyx::Calls::TranscriptionConfig }
|
|
81
81
|
|
|
82
|
-
# @!
|
|
83
|
-
# The voice to be used by the voice assistant. Currently we support ElevenLabs,
|
|
84
|
-
# Telnyx and AWS voices.
|
|
85
|
-
#
|
|
86
|
-
# **Supported Providers:**
|
|
87
|
-
#
|
|
88
|
-
# - **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural
|
|
89
|
-
# voices, which provide more realistic, human-like speech, append `-Neural` to
|
|
90
|
-
# the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
|
|
91
|
-
# [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
|
|
92
|
-
# for compatibility.
|
|
93
|
-
# - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
|
|
94
|
-
# Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
|
|
95
|
-
# Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
|
|
96
|
-
# [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
|
|
97
|
-
# - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
|
|
98
|
-
# `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
|
|
99
|
-
# ElevenLabs, you must provide your ElevenLabs API key as an integration secret
|
|
100
|
-
# under `"voice_settings": {"api_key_ref": "<secret_id>"}`. See
|
|
101
|
-
# [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
102
|
-
# for details. Check
|
|
103
|
-
# [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
104
|
-
# - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
|
|
105
|
-
# - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
106
|
-
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
107
|
-
# `Max`, `TTS2`.
|
|
108
|
-
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
109
|
-
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
110
|
-
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
111
|
-
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
112
|
-
# `ara`, `rex`, `sal`, `leo`.
|
|
113
|
-
#
|
|
114
|
-
# @return [String, nil]
|
|
115
|
-
optional :voice, String
|
|
116
|
-
|
|
117
|
-
# @!attribute voice_settings
|
|
118
|
-
# The settings associated with the voice selected
|
|
119
|
-
#
|
|
120
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
|
|
121
|
-
optional :voice_settings, union: -> { Telnyx::Calls::ActionStartAIAssistantParams::VoiceSettings }
|
|
122
|
-
|
|
123
|
-
# @!method initialize(call_control_id:, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
82
|
+
# @!method initialize(call_control_id:, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, request_options: {})
|
|
124
83
|
# Some parameter documentations has been truncated, see
|
|
125
84
|
# {Telnyx::Models::Calls::ActionStartAIAssistantParams} for more details.
|
|
126
85
|
#
|
|
@@ -144,10 +103,6 @@ module Telnyx
|
|
|
144
103
|
#
|
|
145
104
|
# @param transcription [Telnyx::Models::Calls::TranscriptionConfig] The settings associated with speech to text for the voice assistant. This is onl
|
|
146
105
|
#
|
|
147
|
-
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
148
|
-
#
|
|
149
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
150
|
-
#
|
|
151
106
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
152
107
|
|
|
153
108
|
# Messages sent by an end user
|
|
@@ -173,30 +128,6 @@ module Telnyx
|
|
|
173
128
|
# @!method self.variants
|
|
174
129
|
# @return [Array(Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage)]
|
|
175
130
|
end
|
|
176
|
-
|
|
177
|
-
# The settings associated with the voice selected
|
|
178
|
-
module VoiceSettings
|
|
179
|
-
extend Telnyx::Internal::Type::Union
|
|
180
|
-
|
|
181
|
-
discriminator :type
|
|
182
|
-
|
|
183
|
-
variant :elevenlabs, -> { Telnyx::Calls::ElevenLabsVoiceSettings }
|
|
184
|
-
|
|
185
|
-
variant :telnyx, -> { Telnyx::Calls::TelnyxVoiceSettings }
|
|
186
|
-
|
|
187
|
-
variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
|
|
188
|
-
|
|
189
|
-
variant :azure, -> { Telnyx::AzureVoiceSettings }
|
|
190
|
-
|
|
191
|
-
variant :rime, -> { Telnyx::RimeVoiceSettings }
|
|
192
|
-
|
|
193
|
-
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
194
|
-
|
|
195
|
-
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
196
|
-
|
|
197
|
-
# @!method self.variants
|
|
198
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
|
|
199
|
-
end
|
|
200
131
|
end
|
|
201
132
|
end
|
|
202
133
|
end
|
|
@@ -199,6 +199,10 @@ module Telnyx
|
|
|
199
199
|
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
200
200
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
201
201
|
# `ara`, `rex`, `sal`, `leo`.
|
|
202
|
+
# - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
|
|
203
|
+
# `sara-en`, `abdulaziz-en`, `sara-ar`, `abdulaziz-ar`, `nourah-ar`,
|
|
204
|
+
# `abdullah-ar`. Native Arabic (Saudi dialect) and English voices only — no
|
|
205
|
+
# `ModelId` segment.
|
|
202
206
|
#
|
|
203
207
|
# @return [String, nil]
|
|
204
208
|
optional :voice, String
|
|
@@ -211,6 +211,17 @@ module Telnyx
|
|
|
211
211
|
# @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::RecordTrim, nil]
|
|
212
212
|
optional :record_trim, enum: -> { Telnyx::Calls::ActionTransferParams::RecordTrim }
|
|
213
213
|
|
|
214
|
+
# @!attribute route_to_mobile
|
|
215
|
+
# When set to true, routes the call directly to the mobile device associated with
|
|
216
|
+
# the destination Telnyx Mobile number, bypassing Inbound Calls Interception
|
|
217
|
+
# configured in the Telnyx Portal under Mobile Numbers → select the number → Voice
|
|
218
|
+
# → Call Interception. Use this when transferring an intercepted call to the
|
|
219
|
+
# mobile device to prevent the call from being intercepted again. Defaults to
|
|
220
|
+
# false.
|
|
221
|
+
#
|
|
222
|
+
# @return [Boolean, nil]
|
|
223
|
+
optional :route_to_mobile, Telnyx::Internal::Type::Boolean
|
|
224
|
+
|
|
214
225
|
# @!attribute send_digits_on_answer
|
|
215
226
|
# DTMF digits to send automatically after the transfer destination answers. Useful
|
|
216
227
|
# for reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once
|
|
@@ -324,7 +335,7 @@ module Telnyx
|
|
|
324
335
|
# @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLsMethod, nil]
|
|
325
336
|
optional :webhook_urls_method, enum: -> { Telnyx::Calls::ActionTransferParams::WebhookURLsMethod }
|
|
326
337
|
|
|
327
|
-
# @!method initialize(call_control_id:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
338
|
+
# @!method initialize(call_control_id:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, route_to_mobile: nil, send_digits_on_answer: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
328
339
|
# Some parameter documentations has been truncated, see
|
|
329
340
|
# {Telnyx::Models::Calls::ActionTransferParams} for more details.
|
|
330
341
|
#
|
|
@@ -378,6 +389,8 @@ module Telnyx
|
|
|
378
389
|
#
|
|
379
390
|
# @param record_trim [Symbol, Telnyx::Models::Calls::ActionTransferParams::RecordTrim] When set to `trim-silence`, silence will be removed from the beginning and end o
|
|
380
391
|
#
|
|
392
|
+
# @param route_to_mobile [Boolean] When set to true, routes the call directly to the mobile device associated with
|
|
393
|
+
#
|
|
381
394
|
# @param send_digits_on_answer [String] DTMF digits to send automatically after the transfer destination answers. Useful
|
|
382
395
|
#
|
|
383
396
|
# @param sip_auth_password [String] SIP Authentication password used for SIP challenges.
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# A default prompt string or an ordered list of qualified prompts.
|
|
7
|
+
module PayPromptValue
|
|
8
|
+
extend Telnyx::Internal::Type::Union
|
|
9
|
+
|
|
10
|
+
variant String
|
|
11
|
+
|
|
12
|
+
variant -> { Telnyx::Models::Calls::PayPromptValue::UnionMember1Array }
|
|
13
|
+
|
|
14
|
+
class UnionMember1 < Telnyx::Internal::Type::BaseModel
|
|
15
|
+
# @!attribute text
|
|
16
|
+
# Text spoken for the payment collection step.
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :text, String
|
|
20
|
+
|
|
21
|
+
# @!attribute attempt
|
|
22
|
+
# Space-separated 1-based attempt numbers for which this prompt applies.
|
|
23
|
+
#
|
|
24
|
+
# @return [String, nil]
|
|
25
|
+
optional :attempt, String
|
|
26
|
+
|
|
27
|
+
# @!attribute card_type
|
|
28
|
+
# Lowercase, case-sensitive detected card type for which this prompt applies. Only
|
|
29
|
+
# the listed brands are currently detected; accepted UnionPay and Maestro test
|
|
30
|
+
# cards do not produce a card-type qualifier.
|
|
31
|
+
#
|
|
32
|
+
# @return [Symbol, Telnyx::Models::Calls::PayPromptValue::UnionMember1::CardType, nil]
|
|
33
|
+
optional :card_type, enum: -> { Telnyx::Calls::PayPromptValue::UnionMember1::CardType }
|
|
34
|
+
|
|
35
|
+
# @!attribute error_type
|
|
36
|
+
# Step error for which this prompt applies.
|
|
37
|
+
#
|
|
38
|
+
# @return [Symbol, Telnyx::Models::Calls::PayPromptValue::UnionMember1::ErrorType, nil]
|
|
39
|
+
optional :error_type, enum: -> { Telnyx::Calls::PayPromptValue::UnionMember1::ErrorType }
|
|
40
|
+
|
|
41
|
+
# @!method initialize(text:, attempt: nil, card_type: nil, error_type: nil)
|
|
42
|
+
# Some parameter documentations has been truncated, see
|
|
43
|
+
# {Telnyx::Models::Calls::PayPromptValue::UnionMember1} for more details.
|
|
44
|
+
#
|
|
45
|
+
# A text-to-speech prompt with optional matching qualifiers.
|
|
46
|
+
#
|
|
47
|
+
# @param text [String] Text spoken for the payment collection step.
|
|
48
|
+
#
|
|
49
|
+
# @param attempt [String] Space-separated 1-based attempt numbers for which this prompt applies.
|
|
50
|
+
#
|
|
51
|
+
# @param card_type [Symbol, Telnyx::Models::Calls::PayPromptValue::UnionMember1::CardType] Lowercase, case-sensitive detected card type for which this prompt applies. Only
|
|
52
|
+
#
|
|
53
|
+
# @param error_type [Symbol, Telnyx::Models::Calls::PayPromptValue::UnionMember1::ErrorType] Step error for which this prompt applies.
|
|
54
|
+
|
|
55
|
+
# Lowercase, case-sensitive detected card type for which this prompt applies. Only
|
|
56
|
+
# the listed brands are currently detected; accepted UnionPay and Maestro test
|
|
57
|
+
# cards do not produce a card-type qualifier.
|
|
58
|
+
#
|
|
59
|
+
# @see Telnyx::Models::Calls::PayPromptValue::UnionMember1#card_type
|
|
60
|
+
module CardType
|
|
61
|
+
extend Telnyx::Internal::Type::Enum
|
|
62
|
+
|
|
63
|
+
VISA = :visa
|
|
64
|
+
MASTERCARD = :mastercard
|
|
65
|
+
AMEX = :amex
|
|
66
|
+
DISCOVER = :discover
|
|
67
|
+
DINERS_CLUB = :"diners-club"
|
|
68
|
+
JCB = :jcb
|
|
69
|
+
|
|
70
|
+
# @!method self.values
|
|
71
|
+
# @return [Array<Symbol>]
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Step error for which this prompt applies.
|
|
75
|
+
#
|
|
76
|
+
# @see Telnyx::Models::Calls::PayPromptValue::UnionMember1#error_type
|
|
77
|
+
module ErrorType
|
|
78
|
+
extend Telnyx::Internal::Type::Enum
|
|
79
|
+
|
|
80
|
+
TIMEOUT = :timeout
|
|
81
|
+
INVALID_CARD_NUMBER = :"invalid-card-number"
|
|
82
|
+
INVALID_DATE = :"invalid-date"
|
|
83
|
+
INVALID_SECURITY_CODE = :"invalid-security-code"
|
|
84
|
+
INVALID_POSTAL_CODE = :"invalid-postal-code"
|
|
85
|
+
INVALID_BANK_ROUTING_NUMBER = :"invalid-bank-routing-number"
|
|
86
|
+
INVALID_BANK_ACCOUNT_NUMBER = :"invalid-bank-account-number"
|
|
87
|
+
INPUT_MATCHING_FAILED = :"input-matching-failed"
|
|
88
|
+
|
|
89
|
+
# @!method self.values
|
|
90
|
+
# @return [Array<Symbol>]
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# @!method self.variants
|
|
95
|
+
# @return [Array(String, Array<Telnyx::Models::Calls::PayPromptValue::UnionMember1>)]
|
|
96
|
+
|
|
97
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
98
|
+
UnionMember1Array = Telnyx::Internal::Type::ArrayOf[-> {
|
|
99
|
+
Telnyx::Calls::PayPromptValue::UnionMember1
|
|
100
|
+
}]
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
@@ -16,7 +16,13 @@ module Telnyx
|
|
|
16
16
|
# `assemblyai/universal-streaming`, `auto` (or unset) enables native multilingual
|
|
17
17
|
# code-switching; ISO 639-1 codes (`en`, `es`, `de`, `fr`, `pt`, `it`, `tr`, `nl`,
|
|
18
18
|
# `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`, `he`, `ja`, `zh`) bias the session to
|
|
19
|
-
# that language.
|
|
19
|
+
# that language. For `humain/realtime`, supported values are `ar`, `en`,
|
|
20
|
+
# `codeswitch` (Arabic/English code-switching), and `auto` (resolves server-side
|
|
21
|
+
# to code-switching). Unlike other models, `humain/realtime` does not fall back to
|
|
22
|
+
# `auto` when `language` is omitted — omitting it applies `en` instead. For
|
|
23
|
+
# `reson8/turns`, supported values are `auto` (or unset) for automatic language
|
|
24
|
+
# detection, and the language codes `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`,
|
|
25
|
+
# `pt`, `es`, and `sv` to fix the transcription language.
|
|
20
26
|
#
|
|
21
27
|
# @return [String, nil]
|
|
22
28
|
optional :language, String
|
|
@@ -35,6 +41,10 @@ module Telnyx
|
|
|
35
41
|
# automatic language detection.
|
|
36
42
|
# - `nvidia/parakeet-v3` for multilingual transcription with automatic language
|
|
37
43
|
# detection.
|
|
44
|
+
# - `humain/realtime` for live streaming transcription with native Arabic and
|
|
45
|
+
# Arabic/English code-switching support.
|
|
46
|
+
# - `reson8/turns` for live streaming turn-based transcription of 10 European
|
|
47
|
+
# languages with automatic language detection.
|
|
38
48
|
# - `azure/fast` and `azure/realtime`; Azure models require `region`, and
|
|
39
49
|
# unsupported regions require `api_key_ref`.
|
|
40
50
|
# - `google/latest_long` for non-streaming multilingual transcription.
|
|
@@ -72,6 +82,10 @@ module Telnyx
|
|
|
72
82
|
# automatic language detection.
|
|
73
83
|
# - `nvidia/parakeet-v3` for multilingual transcription with automatic language
|
|
74
84
|
# detection.
|
|
85
|
+
# - `humain/realtime` for live streaming transcription with native Arabic and
|
|
86
|
+
# Arabic/English code-switching support.
|
|
87
|
+
# - `reson8/turns` for live streaming turn-based transcription of 10 European
|
|
88
|
+
# languages with automatic language detection.
|
|
75
89
|
# - `azure/fast` and `azure/realtime`; Azure models require `region`, and
|
|
76
90
|
# unsupported regions require `api_key_ref`.
|
|
77
91
|
# - `google/latest_long` for non-streaming multilingual transcription.
|
|
@@ -94,6 +108,8 @@ module Telnyx
|
|
|
94
108
|
XAI_GROK_STT = :"xai/grok-stt"
|
|
95
109
|
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
96
110
|
NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
|
|
111
|
+
HUMAIN_REALTIME = :"humain/realtime"
|
|
112
|
+
RESON8_TURNS = :"reson8/turns"
|
|
97
113
|
AZURE_FAST = :"azure/fast"
|
|
98
114
|
AZURE_REALTIME = :"azure/realtime"
|
|
99
115
|
GOOGLE_LATEST_LONG = :"google/latest_long"
|