telnyx 5.168.0 → 5.170.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +40 -0
- data/lib/telnyx/internal/email_cursor_pagination.rb +2 -2
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -9
- data/lib/telnyx/models/ai/assistant_tool.rb +316 -13
- data/lib/telnyx/models/ai/assistant_update_params.rb +23 -12
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +23 -12
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
- data/lib/telnyx/models/ai/collection.rb +3 -3
- data/lib/telnyx/models/ai/collections/collections_source.rb +64 -0
- data/lib/telnyx/models/ai/collections/source.rb +25 -29
- data/lib/telnyx/models/ai/collections/source_create_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_list_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_replace_response.rb +3 -3
- data/lib/telnyx/models/ai/flow_node.rb +5 -5
- data/lib/telnyx/models/ai/flow_node_req.rb +3 -3
- data/lib/telnyx/models/ai/inference_embedding.rb +16 -13
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_voice_settings.rb +334 -0
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +33 -11
- data/lib/telnyx/models/ai/memory/namespace_retrieve_params.rb +30 -0
- data/lib/telnyx/models/ai/memory/namespace_retrieve_response.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +63 -0
- data/lib/telnyx/models/ai/memory/namespaces/page_meta.rb +58 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_response.rb +47 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_params.rb +94 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_response.rb +61 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_params.rb +48 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_response.rb +34 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_params.rb +44 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_params.rb +38 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_response.rb +54 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rb +64 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rb +53 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rb +50 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rb +74 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rb +67 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rb +123 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_list_params.rb +28 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rb +69 -0
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +296 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +235 -0
- data/lib/telnyx/models/ai/webhook_tool.rb +16 -1
- data/lib/telnyx/models/artifact_completed_webhook_event.rb +17 -1
- data/lib/telnyx/models/artifact_failed_webhook_event.rb +4 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +11 -3
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +11 -3
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/soniox_voice_settings.rb +46 -0
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/conferences/action_speak_params.rb +11 -3
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +11 -3
- data/lib/telnyx/models/conversation_relay_language.rb +5 -3
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/email_block.rb +8 -1
- data/lib/telnyx/models/email_blocks/email_block_import.rb +7 -2
- data/lib/telnyx/models/email_domain_rotate_dkim_params.rb +20 -0
- data/lib/telnyx/models/email_domain_rotate_dkim_response.rb +243 -0
- data/lib/telnyx/models/email_domains/email_webhook_event.rb +8 -3
- data/lib/telnyx/models/email_event_list_params.rb +33 -10
- data/lib/telnyx/models/email_event_list_response.rb +300 -73
- data/lib/telnyx/models/email_event_type.rb +16 -0
- data/lib/telnyx/models/email_inboxes/email_message.rb +56 -4
- data/lib/telnyx/models/email_message_batch_params.rb +32 -15
- data/lib/telnyx/models/email_message_create_params.rb +44 -12
- data/lib/telnyx/models/{email_message_retrieve_response.rb → email_message_detail_response.rb} +5 -5
- data/lib/telnyx/models/email_message_list_params.rb +26 -1
- data/lib/telnyx/models/email_message_update_schedule_params.rb +29 -0
- data/lib/telnyx/models/email_messages/email_recipient.rb +2 -0
- data/lib/telnyx/models/email_messages/recipient_list_params.rb +2 -0
- data/lib/telnyx/models/email_template.rb +68 -2
- data/lib/telnyx/models/email_template_create_params.rb +71 -1
- data/lib/telnyx/models/email_webhook_recipient.rb +39 -0
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/meeting_session.rb +34 -6
- data/lib/telnyx/models/meeting_session_create_params.rb +73 -39
- data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +77 -13
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +25 -1
- data/lib/telnyx/models/message_event.rb +41 -2
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/numbers_phone_number_detailed.rb +19 -5
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/private_wireless_gateway.rb +0 -1
- data/lib/telnyx/models/private_wireless_gateway_create_params.rb +28 -1
- data/lib/telnyx/models/private_wireless_gateway_create_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_delete_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_retrieve_response.rb +3 -3
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/call_retrieve_calls_params.rb +17 -17
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +129 -3
- data/lib/telnyx/models/text_to_speech_list_voices_params.rb +1 -0
- data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +1 -1
- data/lib/telnyx/models/update_email_template_request.rb +54 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models/wireless_private_wireless_gateway.rb +120 -0
- data/lib/telnyx/models.rb +28 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +2 -2
- data/lib/telnyx/resources/ai/assistants.rb +4 -4
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/memories.rb +122 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/sources.rb +163 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles.rb +244 -0
- data/lib/telnyx/resources/ai/memory/namespaces/settings.rb +76 -0
- data/lib/telnyx/resources/ai/memory/namespaces.rb +55 -0
- data/lib/telnyx/resources/ai/memory.rb +21 -0
- data/lib/telnyx/resources/ai/typesafe/v1.rb +71 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +8 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +5 -5
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +4 -0
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_blocks/imports.rb +17 -3
- data/lib/telnyx/resources/email_blocks.rb +5 -3
- data/lib/telnyx/resources/email_domains.rb +28 -0
- data/lib/telnyx/resources/email_events.rb +21 -9
- data/lib/telnyx/resources/email_messages.rb +61 -15
- data/lib/telnyx/resources/email_templates.rb +33 -3
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/meeting_sessions/actions.rb +7 -1
- data/lib/telnyx/resources/meeting_sessions/artifacts.rb +18 -9
- data/lib/telnyx/resources/meeting_sessions.rb +6 -5
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/private_wireless_gateways.rb +5 -3
- data/lib/telnyx/resources/texml/accounts/calls.rb +9 -9
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/text_to_speech.rb +6 -4
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +75 -1
- data/rbi/telnyx/client.rbi +35 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +24 -16
- data/rbi/telnyx/models/ai/assistant_tool.rbi +479 -25
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +50 -20
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +54 -20
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
- data/rbi/telnyx/models/ai/collection.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/collections_source.rbi +110 -0
- data/rbi/telnyx/models/ai/collections/source.rbi +36 -62
- data/rbi/telnyx/models/ai/collections/source_create_response.rbi +14 -6
- data/rbi/telnyx/models/ai/collections/source_list_response.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/source_replace_response.rbi +11 -4
- data/rbi/telnyx/models/ai/flow_node.rbi +12 -6
- data/rbi/telnyx/models/ai/flow_node_req.rbi +8 -4
- data/rbi/telnyx/models/ai/inference_embedding.rbi +32 -20
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_voice_settings.rbi +803 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +49 -19
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_response.rbi +167 -0
- data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +156 -0
- data/rbi/telnyx/models/ai/memory/namespaces/page_meta.rbi +81 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_response.rbi +97 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbi +149 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbi +113 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_response.rbi +48 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_params.rbi +68 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_response.rbi +109 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_params.rbi +57 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_response.rbi +107 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbi +119 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbi +102 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbi +72 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbi +70 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbi +129 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbi +117 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbi +92 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbi +209 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_list_params.rbi +49 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbi +125 -0
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +566 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +388 -0
- data/rbi/telnyx/models/ai/webhook_tool.rbi +23 -3
- data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +30 -0
- data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +20 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/soniox_voice_settings.rbi +86 -0
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +22 -5
- data/rbi/telnyx/models/conversation_relay_language.rbi +10 -5
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/email_block.rbi +8 -0
- data/rbi/telnyx/models/email_blocks/email_block_import.rbi +6 -2
- data/rbi/telnyx/models/email_domain_rotate_dkim_params.rbi +35 -0
- data/rbi/telnyx/models/email_domain_rotate_dkim_response.rbi +487 -0
- data/rbi/telnyx/models/email_domains/email_webhook_event.rbi +20 -3
- data/rbi/telnyx/models/email_event_list_params.rbi +46 -11
- data/rbi/telnyx/models/email_event_list_response.rbi +599 -97
- data/rbi/telnyx/models/email_event_type.rbi +25 -0
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +81 -3
- data/rbi/telnyx/models/email_message_batch_params.rbi +54 -20
- data/rbi/telnyx/models/email_message_create_params.rbi +80 -16
- data/rbi/telnyx/models/{email_message_retrieve_response.rbi → email_message_detail_response.rbi} +9 -16
- data/rbi/telnyx/models/email_message_list_params.rbi +40 -0
- data/rbi/telnyx/models/email_message_update_schedule_params.rbi +52 -0
- data/rbi/telnyx/models/email_messages/email_recipient.rbi +10 -0
- data/rbi/telnyx/models/email_messages/recipient_list_params.rbi +10 -0
- data/rbi/telnyx/models/email_template.rbi +84 -0
- data/rbi/telnyx/models/email_template_create_params.rbi +124 -0
- data/rbi/telnyx/models/email_webhook_recipient.rbi +68 -0
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/meeting_session.rbi +36 -10
- data/rbi/telnyx/models/meeting_session_create_params.rbi +112 -48
- data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +161 -24
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +30 -0
- data/rbi/telnyx/models/message_event.rbi +48 -1
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/numbers_phone_number_detailed.rbi +24 -4
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/private_wireless_gateway_create_params.rbi +71 -0
- data/rbi/telnyx/models/private_wireless_gateway_create_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_delete_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_retrieve_response.rbi +4 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/call_retrieve_calls_params.rbi +22 -22
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +311 -2
- data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +5 -0
- data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +5 -5
- data/rbi/telnyx/models/update_email_template_request.rbi +90 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models/wireless_private_wireless_gateway.rbi +211 -0
- data/rbi/telnyx/models.rbi +33 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +21 -8
- data/rbi/telnyx/resources/ai/assistants.rbi +27 -14
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/memories.rbi +94 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/sources.rbi +117 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles.rbi +196 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/settings.rbi +67 -0
- data/rbi/telnyx/resources/ai/memory/namespaces.rbi +37 -0
- data/rbi/telnyx/resources/ai/memory.rbi +18 -0
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +71 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +6 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +38 -9
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
- data/rbi/telnyx/resources/conferences/actions.rbi +8 -1
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_blocks/imports.rbi +17 -3
- data/rbi/telnyx/resources/email_blocks.rbi +5 -3
- data/rbi/telnyx/resources/email_domains.rbi +22 -0
- data/rbi/telnyx/resources/email_events.rbi +30 -9
- data/rbi/telnyx/resources/email_messages.rbi +104 -18
- data/rbi/telnyx/resources/email_templates.rbi +71 -0
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/meeting_sessions/actions.rbi +7 -1
- data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +19 -8
- data/rbi/telnyx/resources/meeting_sessions.rbi +15 -7
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/private_wireless_gateways.rbi +9 -1
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +6 -6
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/text_to_speech.rbi +7 -3
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/sig/telnyx/client.rbs +10 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistant_tool.rbs +195 -26
- data/sig/telnyx/models/ai/assistant_update_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +6 -6
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
- data/sig/telnyx/models/ai/collection.rbs +6 -6
- data/sig/telnyx/models/ai/collections/collections_source.rbs +65 -0
- data/sig/telnyx/models/ai/collections/source.rbs +18 -37
- data/sig/telnyx/models/ai/collections/source_create_response.rbs +9 -6
- data/sig/telnyx/models/ai/collections/source_list_response.rbs +8 -6
- data/sig/telnyx/models/ai/collections/source_replace_response.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node_req.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_voice_settings.rbs +308 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +20 -13
- data/sig/telnyx/models/ai/memory/namespace_retrieve_params.rbs +32 -0
- data/sig/telnyx/models/ai/memory/namespace_retrieve_response.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +59 -0
- data/sig/telnyx/models/ai/memory/namespaces/page_meta.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_response.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_params.rbs +42 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_response.rbs +22 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_params.rbs +47 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_response.rbs +53 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_params.rbs +38 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_response.rbs +49 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbs +63 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbs +43 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbs +65 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbs +55 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbs +92 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_list_params.rbs +29 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbs +47 -0
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +215 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +152 -0
- data/sig/telnyx/models/ai/webhook_tool.rbs +10 -3
- data/sig/telnyx/models/artifact_completed_webhook_event.rbs +16 -1
- data/sig/telnyx/models/artifact_failed_webhook_event.rbs +11 -1
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/soniox_voice_settings.rbs +46 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/conversation_relay_embedded_config.rbs +1 -0
- data/sig/telnyx/models/conversation_relay_language.rbs +1 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_params.rbs +23 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_response.rbs +195 -0
- data/sig/telnyx/models/email_domains/email_webhook_event.rbs +6 -0
- data/sig/telnyx/models/email_event_list_params.rbs +7 -7
- data/sig/telnyx/models/email_event_list_response.rbs +235 -59
- data/sig/telnyx/models/email_event_type.rbs +20 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +43 -4
- data/sig/telnyx/models/{email_message_retrieve_response.rbs → email_message_detail_response.rbs} +6 -10
- data/sig/telnyx/models/email_message_list_params.rbs +18 -1
- data/sig/telnyx/models/email_message_update_schedule_params.rbs +28 -0
- data/sig/telnyx/models/email_messages/email_recipient.rbs +4 -0
- data/sig/telnyx/models/email_messages/recipient_list_params.rbs +4 -0
- data/sig/telnyx/models/email_template.rbs +29 -0
- data/sig/telnyx/models/email_template_create_params.rbs +33 -0
- data/sig/telnyx/models/email_webhook_recipient.rbs +46 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/meeting_session.rbs +20 -5
- data/sig/telnyx/models/meeting_session_create_params.rbs +28 -20
- data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +53 -10
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +16 -1
- data/sig/telnyx/models/message_event.rbs +10 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/numbers_phone_number_detailed.rbs +5 -0
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/private_wireless_gateway_create_params.rbs +25 -1
- data/sig/telnyx/models/private_wireless_gateway_create_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_delete_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_retrieve_response.rbs +6 -6
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/call_retrieve_calls_params.rbs +14 -14
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +114 -0
- data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +2 -0
- data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +2 -2
- data/sig/telnyx/models/update_email_template_request.rbs +33 -0
- data/sig/telnyx/models/wireless_private_wireless_gateway.rbs +109 -0
- data/sig/telnyx/models.rbs +28 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -1
- data/sig/telnyx/resources/ai/assistants.rbs +2 -2
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/memories.rbs +32 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/sources.rbs +38 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles.rbs +59 -0
- data/sig/telnyx/resources/ai/memory/namespaces/settings.rbs +24 -0
- data/sig/telnyx/resources/ai/memory/namespaces.rbs +21 -0
- data/sig/telnyx/resources/ai/memory.rbs +11 -0
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +18 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +4 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +2 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/email_domains.rbs +5 -0
- data/sig/telnyx/resources/email_events.rbs +2 -2
- data/sig/telnyx/resources/email_messages.rbs +9 -1
- data/sig/telnyx/resources/email_templates.rbs +9 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +1 -1
- data/sig/telnyx/resources/meeting_sessions.rbs +1 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/private_wireless_gateways.rbs +2 -1
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- data/sig/telnyx/resources/text_to_speech.rbs +1 -0
- metadata +227 -5
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
module Telnyx
|
|
4
4
|
module Models
|
|
5
5
|
class UpdateEmailTemplateRequest < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute autoescape
|
|
7
|
+
# Per-template HTML autoescaping setting.
|
|
8
|
+
#
|
|
9
|
+
# @return [Boolean, nil]
|
|
10
|
+
optional :autoescape, Telnyx::Internal::Type::Boolean
|
|
11
|
+
|
|
6
12
|
# @!attribute html_body
|
|
7
13
|
# Liquid template HTML body.
|
|
8
14
|
#
|
|
@@ -14,6 +20,12 @@ module Telnyx
|
|
|
14
20
|
# @return [String, nil]
|
|
15
21
|
optional :name, String
|
|
16
22
|
|
|
23
|
+
# @!attribute strict_variables
|
|
24
|
+
# Per-template strict variable-validation setting.
|
|
25
|
+
#
|
|
26
|
+
# @return [Boolean, nil]
|
|
27
|
+
optional :strict_variables, Telnyx::Internal::Type::Boolean
|
|
28
|
+
|
|
17
29
|
# @!attribute subject
|
|
18
30
|
# Liquid template subject.
|
|
19
31
|
#
|
|
@@ -26,21 +38,62 @@ module Telnyx
|
|
|
26
38
|
# @return [String, nil]
|
|
27
39
|
optional :text_body, String, nil?: true
|
|
28
40
|
|
|
41
|
+
# @!attribute variable_schema
|
|
42
|
+
# Structured variable requirements. Required variables cannot define defaults;
|
|
43
|
+
# invalid combinations return 422. Set to `null` to clear the schema.
|
|
44
|
+
#
|
|
45
|
+
# @return [Hash{Symbol=>Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema}, nil]
|
|
46
|
+
optional :variable_schema,
|
|
47
|
+
-> { Telnyx::Internal::Type::HashOf[Telnyx::UpdateEmailTemplateRequest::VariableSchema] },
|
|
48
|
+
nil?: true
|
|
49
|
+
|
|
29
50
|
# @!attribute variables
|
|
30
51
|
#
|
|
31
52
|
# @return [Array<String>, nil]
|
|
32
53
|
optional :variables, Telnyx::Internal::Type::ArrayOf[String]
|
|
33
54
|
|
|
34
|
-
# @!method initialize(html_body: nil, name: nil, subject: nil, text_body: nil, variables: nil)
|
|
55
|
+
# @!method initialize(autoescape: nil, html_body: nil, name: nil, strict_variables: nil, subject: nil, text_body: nil, variable_schema: nil, variables: nil)
|
|
56
|
+
# Some parameter documentations has been truncated, see
|
|
57
|
+
# {Telnyx::Models::UpdateEmailTemplateRequest} for more details.
|
|
58
|
+
#
|
|
59
|
+
# @param autoescape [Boolean] Per-template HTML autoescaping setting.
|
|
60
|
+
#
|
|
35
61
|
# @param html_body [String, nil] Liquid template HTML body.
|
|
36
62
|
#
|
|
37
63
|
# @param name [String]
|
|
38
64
|
#
|
|
65
|
+
# @param strict_variables [Boolean] Per-template strict variable-validation setting.
|
|
66
|
+
#
|
|
39
67
|
# @param subject [String, nil] Liquid template subject.
|
|
40
68
|
#
|
|
41
69
|
# @param text_body [String, nil] Liquid template text body.
|
|
42
70
|
#
|
|
71
|
+
# @param variable_schema [Hash{Symbol=>Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema}, nil] Structured variable requirements. Required variables cannot define defaults; inv
|
|
72
|
+
#
|
|
43
73
|
# @param variables [Array<String>]
|
|
74
|
+
|
|
75
|
+
class VariableSchema < Telnyx::Internal::Type::BaseModel
|
|
76
|
+
# @!attribute required
|
|
77
|
+
# Whether the variable must be supplied when strict variable validation is
|
|
78
|
+
# enabled.
|
|
79
|
+
#
|
|
80
|
+
# @return [Boolean]
|
|
81
|
+
required :required, Telnyx::Internal::Type::Boolean
|
|
82
|
+
|
|
83
|
+
# @!attribute default
|
|
84
|
+
# Default value for an optional variable. Rejected when `required` is `true`.
|
|
85
|
+
#
|
|
86
|
+
# @return [String, nil]
|
|
87
|
+
optional :default, String
|
|
88
|
+
|
|
89
|
+
# @!method initialize(required:, default: nil)
|
|
90
|
+
# Some parameter documentations has been truncated, see
|
|
91
|
+
# {Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema} for more details.
|
|
92
|
+
#
|
|
93
|
+
# @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
|
|
94
|
+
#
|
|
95
|
+
# @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
|
|
96
|
+
end
|
|
44
97
|
end
|
|
45
98
|
end
|
|
46
99
|
end
|
|
@@ -160,8 +160,8 @@ module Telnyx
|
|
|
160
160
|
class TelnyxUltraClone < Telnyx::Internal::Type::BaseModel
|
|
161
161
|
# @!attribute audio_file
|
|
162
162
|
# Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
|
|
163
|
-
# For best quality, provide
|
|
164
|
-
# size: 5MB.
|
|
163
|
+
# For best quality, provide up to 60 seconds of clear, uninterrupted speech.
|
|
164
|
+
# Maximum size: 5MB.
|
|
165
165
|
#
|
|
166
166
|
# @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
|
|
167
167
|
required :audio_file, Telnyx::Internal::Type::FileInput
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::PrivateWirelessGateways#list
|
|
6
|
+
class WirelessPrivateWirelessGateway < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute address_mode
|
|
8
|
+
# The address mode of the private wireless gateway. With static, each SIM card
|
|
9
|
+
# gets a fixed IP address from the gateway's IP range that is preserved across
|
|
10
|
+
# sessions. With dynamic, IP addresses are assigned by the network at attach time
|
|
11
|
+
# and may change between sessions.
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Telnyx::Models::WirelessPrivateWirelessGateway::AddressMode, nil]
|
|
14
|
+
optional :address_mode, enum: -> { Telnyx::WirelessPrivateWirelessGateway::AddressMode }
|
|
15
|
+
|
|
16
|
+
# @!attribute assigned_resources
|
|
17
|
+
# A list of the resources that have been assigned to the Private Wireless Gateway.
|
|
18
|
+
#
|
|
19
|
+
# @return [Array<Telnyx::Models::PwgAssignedResourcesSummary>, nil]
|
|
20
|
+
optional :assigned_resources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PwgAssignedResourcesSummary] }
|
|
21
|
+
|
|
22
|
+
# @!attribute name
|
|
23
|
+
# The private wireless gateway name.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :name, String
|
|
27
|
+
|
|
28
|
+
# @!attribute network_id
|
|
29
|
+
# The identification of the related network resource.
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :network_id, String
|
|
33
|
+
|
|
34
|
+
# @!attribute region_code
|
|
35
|
+
# The name of the region where the Private Wireless Gateway is deployed.
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :region_code, String
|
|
39
|
+
|
|
40
|
+
# @!attribute status
|
|
41
|
+
# The current status or failure details of the Private Wireless Gateway.
|
|
42
|
+
#
|
|
43
|
+
# @return [Telnyx::Models::PrivateWirelessGatewayStatus, nil]
|
|
44
|
+
optional :status, -> { Telnyx::PrivateWirelessGatewayStatus }
|
|
45
|
+
|
|
46
|
+
response_only do
|
|
47
|
+
# @!attribute id
|
|
48
|
+
# Identifies the resource.
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :id, String
|
|
52
|
+
|
|
53
|
+
# @!attribute created_at
|
|
54
|
+
# ISO 8601 formatted date-time indicating when the resource was created.
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :created_at, String
|
|
58
|
+
|
|
59
|
+
# @!attribute ip_range
|
|
60
|
+
# IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :ip_range, String
|
|
64
|
+
|
|
65
|
+
# @!attribute record_type
|
|
66
|
+
#
|
|
67
|
+
# @return [String, nil]
|
|
68
|
+
optional :record_type, String
|
|
69
|
+
|
|
70
|
+
# @!attribute updated_at
|
|
71
|
+
# ISO 8601 formatted date-time indicating when the resource was updated.
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :updated_at, String
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# @!method initialize(id: nil, address_mode: nil, assigned_resources: nil, created_at: nil, ip_range: nil, name: nil, network_id: nil, record_type: nil, region_code: nil, status: nil, updated_at: nil)
|
|
78
|
+
# Some parameter documentations has been truncated, see
|
|
79
|
+
# {Telnyx::Models::WirelessPrivateWirelessGateway} for more details.
|
|
80
|
+
#
|
|
81
|
+
# @param id [String] Identifies the resource.
|
|
82
|
+
#
|
|
83
|
+
# @param address_mode [Symbol, Telnyx::Models::WirelessPrivateWirelessGateway::AddressMode] The address mode of the private wireless gateway. With static, each SIM card get
|
|
84
|
+
#
|
|
85
|
+
# @param assigned_resources [Array<Telnyx::Models::PwgAssignedResourcesSummary>] A list of the resources that have been assigned to the Private Wireless Gateway.
|
|
86
|
+
#
|
|
87
|
+
# @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
|
|
88
|
+
#
|
|
89
|
+
# @param ip_range [String] IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
|
|
90
|
+
#
|
|
91
|
+
# @param name [String] The private wireless gateway name.
|
|
92
|
+
#
|
|
93
|
+
# @param network_id [String] The identification of the related network resource.
|
|
94
|
+
#
|
|
95
|
+
# @param record_type [String]
|
|
96
|
+
#
|
|
97
|
+
# @param region_code [String] The name of the region where the Private Wireless Gateway is deployed.
|
|
98
|
+
#
|
|
99
|
+
# @param status [Telnyx::Models::PrivateWirelessGatewayStatus] The current status or failure details of the Private Wireless Gateway.
|
|
100
|
+
#
|
|
101
|
+
# @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
|
|
102
|
+
|
|
103
|
+
# The address mode of the private wireless gateway. With static, each SIM card
|
|
104
|
+
# gets a fixed IP address from the gateway's IP range that is preserved across
|
|
105
|
+
# sessions. With dynamic, IP addresses are assigned by the network at attach time
|
|
106
|
+
# and may change between sessions.
|
|
107
|
+
#
|
|
108
|
+
# @see Telnyx::Models::WirelessPrivateWirelessGateway#address_mode
|
|
109
|
+
module AddressMode
|
|
110
|
+
extend Telnyx::Internal::Type::Enum
|
|
111
|
+
|
|
112
|
+
STATIC = :static
|
|
113
|
+
DYNAMIC = :dynamic
|
|
114
|
+
|
|
115
|
+
# @!method self.values
|
|
116
|
+
# @return [Array<Symbol>]
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
end
|
data/lib/telnyx/models.rb
CHANGED
|
@@ -157,6 +157,14 @@ module Telnyx
|
|
|
157
157
|
|
|
158
158
|
BookAppointmentToolParams = Telnyx::Models::BookAppointmentToolParams
|
|
159
159
|
|
|
160
|
+
BotChallengeCreateParams = Telnyx::Models::BotChallengeCreateParams
|
|
161
|
+
|
|
162
|
+
BotSessionListParams = Telnyx::Models::BotSessionListParams
|
|
163
|
+
|
|
164
|
+
BotSignupCreateParams = Telnyx::Models::BotSignupCreateParams
|
|
165
|
+
|
|
166
|
+
BotSignupResendMagicLinkParams = Telnyx::Models::BotSignupResendMagicLinkParams
|
|
167
|
+
|
|
160
168
|
BrandedCallingPaginationMeta = Telnyx::Models::BrandedCallingPaginationMeta
|
|
161
169
|
|
|
162
170
|
BulkMessagingSettingsUpdatePhoneNumbers = Telnyx::Models::BulkMessagingSettingsUpdatePhoneNumbers
|
|
@@ -477,6 +485,8 @@ module Telnyx
|
|
|
477
485
|
|
|
478
486
|
ConnectionNoiseSuppressionDetails = Telnyx::Models::ConnectionNoiseSuppressionDetails
|
|
479
487
|
|
|
488
|
+
ConnectionRetrieveCountParams = Telnyx::Models::ConnectionRetrieveCountParams
|
|
489
|
+
|
|
480
490
|
ConnectionRetrieveParams = Telnyx::Models::ConnectionRetrieveParams
|
|
481
491
|
|
|
482
492
|
ConnectionRtcpSettings = Telnyx::Models::ConnectionRtcpSettings
|
|
@@ -684,6 +694,8 @@ module Telnyx
|
|
|
684
694
|
|
|
685
695
|
EmailDomainRetrieveParams = Telnyx::Models::EmailDomainRetrieveParams
|
|
686
696
|
|
|
697
|
+
EmailDomainRotateDkimParams = Telnyx::Models::EmailDomainRotateDkimParams
|
|
698
|
+
|
|
687
699
|
EmailDomains = Telnyx::Models::EmailDomains
|
|
688
700
|
|
|
689
701
|
EmailDomainStatus = Telnyx::Models::EmailDomainStatus
|
|
@@ -726,6 +738,8 @@ module Telnyx
|
|
|
726
738
|
|
|
727
739
|
EmailMessageDeleteScheduleParams = Telnyx::Models::EmailMessageDeleteScheduleParams
|
|
728
740
|
|
|
741
|
+
EmailMessageDetailResponse = Telnyx::Models::EmailMessageDetailResponse
|
|
742
|
+
|
|
729
743
|
EmailMessageListParams = Telnyx::Models::EmailMessageListParams
|
|
730
744
|
|
|
731
745
|
EmailMessageRetrieveEventsParams = Telnyx::Models::EmailMessageRetrieveEventsParams
|
|
@@ -734,6 +748,8 @@ module Telnyx
|
|
|
734
748
|
|
|
735
749
|
EmailMessages = Telnyx::Models::EmailMessages
|
|
736
750
|
|
|
751
|
+
EmailMessageUpdateScheduleParams = Telnyx::Models::EmailMessageUpdateScheduleParams
|
|
752
|
+
|
|
737
753
|
EmailTemplate = Telnyx::Models::EmailTemplate
|
|
738
754
|
|
|
739
755
|
EmailTemplateCreateParams = Telnyx::Models::EmailTemplateCreateParams
|
|
@@ -776,6 +792,8 @@ module Telnyx
|
|
|
776
792
|
|
|
777
793
|
EmailValidations = Telnyx::Models::EmailValidations
|
|
778
794
|
|
|
795
|
+
EmailWebhookRecipient = Telnyx::Models::EmailWebhookRecipient
|
|
796
|
+
|
|
779
797
|
EncryptedMedia = Telnyx::Models::EncryptedMedia
|
|
780
798
|
|
|
781
799
|
EnterpriseBrandedCallingParams = Telnyx::Models::EnterpriseBrandedCallingParams
|
|
@@ -1024,6 +1042,8 @@ module Telnyx
|
|
|
1024
1042
|
|
|
1025
1043
|
ListRetrieveByZoneParams = Telnyx::Models::ListRetrieveByZoneParams
|
|
1026
1044
|
|
|
1045
|
+
MachinePaymentAccountCreditParams = Telnyx::Models::MachinePaymentAccountCreditParams
|
|
1046
|
+
|
|
1027
1047
|
ManagedAccount = Telnyx::Models::ManagedAccount
|
|
1028
1048
|
|
|
1029
1049
|
ManagedAccountBalance = Telnyx::Models::ManagedAccountBalance
|
|
@@ -1151,6 +1171,8 @@ module Telnyx
|
|
|
1151
1171
|
|
|
1152
1172
|
MessagingHostedNumberUpdateParams = Telnyx::Models::MessagingHostedNumberUpdateParams
|
|
1153
1173
|
|
|
1174
|
+
MessagingInboundMessage = Telnyx::Models::MessagingInboundMessage
|
|
1175
|
+
|
|
1154
1176
|
MessagingInboundMessagePayload = Telnyx::Models::MessagingInboundMessagePayload
|
|
1155
1177
|
|
|
1156
1178
|
MessagingMessagingProfile = Telnyx::Models::MessagingMessagingProfile
|
|
@@ -1268,6 +1290,8 @@ module Telnyx
|
|
|
1268
1290
|
|
|
1269
1291
|
NetworkUpdateParams = Telnyx::Models::NetworkUpdateParams
|
|
1270
1292
|
|
|
1293
|
+
NoiseSuppressionEngineListParams = Telnyx::Models::NoiseSuppressionEngineListParams
|
|
1294
|
+
|
|
1271
1295
|
NotificationChannel = Telnyx::Models::NotificationChannel
|
|
1272
1296
|
|
|
1273
1297
|
NotificationChannelCreateParams = Telnyx::Models::NotificationChannelCreateParams
|
|
@@ -1886,6 +1910,8 @@ module Telnyx
|
|
|
1886
1910
|
|
|
1887
1911
|
SubNumberOrderUpdateRequirementGroupParams = Telnyx::Models::SubNumberOrderUpdateRequirementGroupParams
|
|
1888
1912
|
|
|
1913
|
+
SuccessResponse = Telnyx::Models::SuccessResponse
|
|
1914
|
+
|
|
1889
1915
|
SuppressedRecipient = Telnyx::Models::SuppressedRecipient
|
|
1890
1916
|
|
|
1891
1917
|
TelephonyCredential = Telnyx::Models::TelephonyCredential
|
|
@@ -2235,6 +2261,8 @@ module Telnyx
|
|
|
2235
2261
|
|
|
2236
2262
|
WirelessError = Telnyx::Models::WirelessError
|
|
2237
2263
|
|
|
2264
|
+
WirelessPrivateWirelessGateway = Telnyx::Models::WirelessPrivateWirelessGateway
|
|
2265
|
+
|
|
2238
2266
|
WirelessRetrieveRegionsParams = Telnyx::Models::WirelessRetrieveRegionsParams
|
|
2239
2267
|
|
|
2240
2268
|
WirelessWirelessBlocklist = Telnyx::Models::WirelessWirelessBlocklist
|
|
@@ -99,13 +99,13 @@ module Telnyx
|
|
|
99
99
|
#
|
|
100
100
|
# @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
|
|
101
101
|
#
|
|
102
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
102
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
|
|
103
103
|
#
|
|
104
104
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
|
|
105
105
|
#
|
|
106
106
|
# @param version_name [String] Body param: Human-readable name for the assistant version.
|
|
107
107
|
#
|
|
108
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
108
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings] Body param
|
|
109
109
|
#
|
|
110
110
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Body param: Configuration settings for the assistant's web widget.
|
|
111
111
|
#
|
|
@@ -91,11 +91,11 @@ module Telnyx
|
|
|
91
91
|
#
|
|
92
92
|
# @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
|
|
93
93
|
#
|
|
94
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
94
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
|
|
95
95
|
#
|
|
96
96
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
|
|
97
97
|
#
|
|
98
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
98
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings] Body param
|
|
99
99
|
#
|
|
100
100
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Body param: Configuration settings for the assistant's web widget.
|
|
101
101
|
#
|
|
@@ -213,13 +213,13 @@ module Telnyx
|
|
|
213
213
|
#
|
|
214
214
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
215
215
|
#
|
|
216
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
216
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
217
217
|
#
|
|
218
218
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
219
219
|
#
|
|
220
220
|
# @param version_name [String] Human-readable name for the assistant version.
|
|
221
221
|
#
|
|
222
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
222
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings]
|
|
223
223
|
#
|
|
224
224
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
225
225
|
#
|
|
@@ -19,9 +19,9 @@ module Telnyx
|
|
|
19
19
|
#
|
|
20
20
|
# @param file_url [String] Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg
|
|
21
21
|
#
|
|
22
|
-
# @param language [String] The language of the audio to be transcribed.
|
|
22
|
+
# @param language [String] The language of the audio to be transcribed. `deepgram/nova-3` supports ~49 lang
|
|
23
23
|
#
|
|
24
|
-
# @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with `
|
|
24
|
+
# @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with the `deepg
|
|
25
25
|
#
|
|
26
26
|
# @param response_format [Symbol, Telnyx::Models::AI::AudioTranscribeParams::ResponseFormat] The format of the transcript output. Use `verbose_json` to take advantage of tim
|
|
27
27
|
#
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class AI
|
|
6
|
+
class Memory
|
|
7
|
+
class Namespaces
|
|
8
|
+
class Profiles
|
|
9
|
+
# What a namespace and a profile hold.
|
|
10
|
+
class Memories
|
|
11
|
+
# Some parameter documentations has been truncated, see
|
|
12
|
+
# {Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveParams} for
|
|
13
|
+
# more details.
|
|
14
|
+
#
|
|
15
|
+
# One memory by its id, as `recall` and the listing return it, together with what
|
|
16
|
+
# it came from. A fact names its `source_id`: read it with
|
|
17
|
+
# `GET .../sources/{source_id}` to see what was stored. A memory derived from
|
|
18
|
+
# other memories names them in `derived_from` instead; read each of those to reach
|
|
19
|
+
# its source.
|
|
20
|
+
#
|
|
21
|
+
# @overload retrieve(memory_id, namespace:, profile_id:, request_options: {})
|
|
22
|
+
#
|
|
23
|
+
# @param memory_id [String] A memory's id, as `recall` and the listing return it.
|
|
24
|
+
#
|
|
25
|
+
# @param namespace [String] The namespace. `default` exists for every organization.
|
|
26
|
+
#
|
|
27
|
+
# @param profile_id [String] The profile: your identifier for the user, caller or agent this memory is about.
|
|
28
|
+
#
|
|
29
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
30
|
+
#
|
|
31
|
+
# @return [Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse]
|
|
32
|
+
#
|
|
33
|
+
# @see Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveParams
|
|
34
|
+
def retrieve(memory_id, params)
|
|
35
|
+
parsed, options = Telnyx::AI::Memory::Namespaces::Profiles::MemoryRetrieveParams.dump_request(params)
|
|
36
|
+
namespace =
|
|
37
|
+
parsed.delete(:namespace) do
|
|
38
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
39
|
+
end
|
|
40
|
+
profile_id =
|
|
41
|
+
parsed.delete(:profile_id) do
|
|
42
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
43
|
+
end
|
|
44
|
+
@client.request(
|
|
45
|
+
method: :get,
|
|
46
|
+
path: [
|
|
47
|
+
"ai/memory/namespaces/%1$s/profiles/%2$s/memories/%3$s",
|
|
48
|
+
namespace,
|
|
49
|
+
profile_id,
|
|
50
|
+
memory_id
|
|
51
|
+
],
|
|
52
|
+
model: Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse,
|
|
53
|
+
options: options
|
|
54
|
+
)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Some parameter documentations has been truncated, see
|
|
58
|
+
# {Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListParams} for more
|
|
59
|
+
# details.
|
|
60
|
+
#
|
|
61
|
+
# Everything stored under one profile, unranked -- ask `recall` for the memories
|
|
62
|
+
# that answer a question. A profile that holds nothing is an empty page rather
|
|
63
|
+
# than a 404: profiles exist by being written to. Each memory names the
|
|
64
|
+
# `source_id` it was extracted from, or null for a memory derived from other
|
|
65
|
+
# memories -- which can read almost the same as the fact it restates. A
|
|
66
|
+
# `source_id` narrows the listing to the memories extracted from that source, and
|
|
67
|
+
# a `session_id` to those extracted from the session, which is the same thing
|
|
68
|
+
# named another way; pass one or the other. Neither is everything the source led
|
|
69
|
+
# to: a memory derived from several sources belongs to no single one and appears
|
|
70
|
+
# only in the unfiltered listing. A memory written while the listing is paged
|
|
71
|
+
# shifts the pages after it, so an entry can be repeated or missed at a page
|
|
72
|
+
# boundary.
|
|
73
|
+
#
|
|
74
|
+
# @overload list(profile_id, namespace:, page_number: nil, page_size: nil, session_id: nil, source_id: nil, request_options: {})
|
|
75
|
+
#
|
|
76
|
+
# @param profile_id [String] Path param
|
|
77
|
+
#
|
|
78
|
+
# @param namespace [String] Path param
|
|
79
|
+
#
|
|
80
|
+
# @param page_number [Integer] Query param: The page to return, counting from 1. Bounded in depth: (page[number
|
|
81
|
+
#
|
|
82
|
+
# @param page_size [Integer] Query param: How many results a page holds.
|
|
83
|
+
#
|
|
84
|
+
# @param session_id [String, nil] Query param: An ingested session, by the `session_id` it was ingested with. Narr
|
|
85
|
+
#
|
|
86
|
+
# @param source_id [String, nil] Query param: Narrows the listing to the memories extracted from one source, a re
|
|
87
|
+
#
|
|
88
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
89
|
+
#
|
|
90
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListResponse>]
|
|
91
|
+
#
|
|
92
|
+
# @see Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListParams
|
|
93
|
+
def list(profile_id, params)
|
|
94
|
+
parsed, options = Telnyx::AI::Memory::Namespaces::Profiles::MemoryListParams.dump_request(params)
|
|
95
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
96
|
+
namespace =
|
|
97
|
+
parsed.delete(:namespace) do
|
|
98
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
99
|
+
end
|
|
100
|
+
@client.request(
|
|
101
|
+
method: :get,
|
|
102
|
+
path: ["ai/memory/namespaces/%1$s/profiles/%2$s/memories", namespace, profile_id],
|
|
103
|
+
query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
104
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
105
|
+
model: Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListResponse,
|
|
106
|
+
options: options
|
|
107
|
+
)
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# @api private
|
|
111
|
+
#
|
|
112
|
+
# @param client [Telnyx::Client]
|
|
113
|
+
def initialize(client:)
|
|
114
|
+
@client = client
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
end
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class AI
|
|
6
|
+
class Memory
|
|
7
|
+
class Namespaces
|
|
8
|
+
class Profiles
|
|
9
|
+
# What a profile stored, and what its memories came from.
|
|
10
|
+
class Sources
|
|
11
|
+
# Some parameter documentations has been truncated, see
|
|
12
|
+
# {Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveParams} for
|
|
13
|
+
# more details.
|
|
14
|
+
#
|
|
15
|
+
# One source and its content, as it was stored: an ingested session's payload or a
|
|
16
|
+
# remembered fact. A source whose ingest is still queued answers 404 until it has
|
|
17
|
+
# been stored.
|
|
18
|
+
#
|
|
19
|
+
# @overload retrieve(source_id, namespace:, profile_id:, request_options: {})
|
|
20
|
+
#
|
|
21
|
+
# @param source_id [String] Identifies one source within its profile: an ingested session, or one remembered
|
|
22
|
+
#
|
|
23
|
+
# @param namespace [String] The namespace. `default` exists for every organization.
|
|
24
|
+
#
|
|
25
|
+
# @param profile_id [String] The profile: your identifier for the user, caller or agent this memory is about.
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
|
+
#
|
|
29
|
+
# @return [Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse]
|
|
30
|
+
#
|
|
31
|
+
# @see Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveParams
|
|
32
|
+
def retrieve(source_id, params)
|
|
33
|
+
parsed, options = Telnyx::AI::Memory::Namespaces::Profiles::SourceRetrieveParams.dump_request(params)
|
|
34
|
+
namespace =
|
|
35
|
+
parsed.delete(:namespace) do
|
|
36
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
37
|
+
end
|
|
38
|
+
profile_id =
|
|
39
|
+
parsed.delete(:profile_id) do
|
|
40
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
41
|
+
end
|
|
42
|
+
@client.request(
|
|
43
|
+
method: :get,
|
|
44
|
+
path: [
|
|
45
|
+
"ai/memory/namespaces/%1$s/profiles/%2$s/sources/%3$s",
|
|
46
|
+
namespace,
|
|
47
|
+
profile_id,
|
|
48
|
+
source_id
|
|
49
|
+
],
|
|
50
|
+
model: Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceRetrieveResponse,
|
|
51
|
+
options: options
|
|
52
|
+
)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Some parameter documentations has been truncated, see
|
|
56
|
+
# {Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceListParams} for more
|
|
57
|
+
# details.
|
|
58
|
+
#
|
|
59
|
+
# Everything a profile has stored and extracts memories from: each ingested
|
|
60
|
+
# session, and each remembered fact, which has no session. Content is not listed;
|
|
61
|
+
# read one source for it. A source whose ingest is still queued is not here yet.
|
|
62
|
+
# Re-ingesting a session moves it to the front, so a listing paged while sessions
|
|
63
|
+
# are written can repeat or miss one at a page boundary. A `session_id` narrows
|
|
64
|
+
# the listing to the source that session was stored as: one source or none, and
|
|
65
|
+
# none -- an empty page, not a 404 -- for a session never ingested, still queued,
|
|
66
|
+
# or another profile's.
|
|
67
|
+
#
|
|
68
|
+
# @overload list(profile_id, namespace:, page_number: nil, page_size: nil, session_id: nil, request_options: {})
|
|
69
|
+
#
|
|
70
|
+
# @param profile_id [String] Path param
|
|
71
|
+
#
|
|
72
|
+
# @param namespace [String] Path param
|
|
73
|
+
#
|
|
74
|
+
# @param page_number [Integer] Query param: The page to return, counting from 1. Bounded in depth: (page[number
|
|
75
|
+
#
|
|
76
|
+
# @param page_size [Integer] Query param: How many results a page holds.
|
|
77
|
+
#
|
|
78
|
+
# @param session_id [String, nil] Query param: An ingested session, by the `session_id` it was ingested with. Narr
|
|
79
|
+
#
|
|
80
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
81
|
+
#
|
|
82
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::Collections::Source>]
|
|
83
|
+
#
|
|
84
|
+
# @see Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceListParams
|
|
85
|
+
def list(profile_id, params)
|
|
86
|
+
parsed, options = Telnyx::AI::Memory::Namespaces::Profiles::SourceListParams.dump_request(params)
|
|
87
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
88
|
+
namespace =
|
|
89
|
+
parsed.delete(:namespace) do
|
|
90
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
91
|
+
end
|
|
92
|
+
@client.request(
|
|
93
|
+
method: :get,
|
|
94
|
+
path: ["ai/memory/namespaces/%1$s/profiles/%2$s/sources", namespace, profile_id],
|
|
95
|
+
query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
96
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
97
|
+
model: Telnyx::AI::Collections::Source,
|
|
98
|
+
options: options
|
|
99
|
+
)
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Some parameter documentations has been truncated, see
|
|
103
|
+
# {Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteParams} for more
|
|
104
|
+
# details.
|
|
105
|
+
#
|
|
106
|
+
# Deletes one source -- an ingested session or a remembered fact -- together with
|
|
107
|
+
# the memories derived from it. A memory derived from this source and others is
|
|
108
|
+
# deleted too, and derived again from what remains in the background. It answers
|
|
109
|
+
# only once the source is gone. A source that is not there -- never stored,
|
|
110
|
+
# another profile's, or already deleted -- answers 404, so on a `502` or a `504`
|
|
111
|
+
# repeat the identical request and read a 404 as done. An ingest of the same
|
|
112
|
+
# session that is still queued is not cancelled, and stores the session again when
|
|
113
|
+
# it runs. Nothing here can be undone.
|
|
114
|
+
#
|
|
115
|
+
# @overload delete(source_id, namespace:, profile_id:, request_options: {})
|
|
116
|
+
#
|
|
117
|
+
# @param source_id [String] Identifies one source within its profile: an ingested session, or one remembered
|
|
118
|
+
#
|
|
119
|
+
# @param namespace [String] The namespace. `default` exists for every organization.
|
|
120
|
+
#
|
|
121
|
+
# @param profile_id [String] The profile: your identifier for the user, caller or agent this memory is about.
|
|
122
|
+
#
|
|
123
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
124
|
+
#
|
|
125
|
+
# @return [Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse]
|
|
126
|
+
#
|
|
127
|
+
# @see Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteParams
|
|
128
|
+
def delete(source_id, params)
|
|
129
|
+
parsed, options = Telnyx::AI::Memory::Namespaces::Profiles::SourceDeleteParams.dump_request(params)
|
|
130
|
+
namespace =
|
|
131
|
+
parsed.delete(:namespace) do
|
|
132
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
133
|
+
end
|
|
134
|
+
profile_id =
|
|
135
|
+
parsed.delete(:profile_id) do
|
|
136
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
137
|
+
end
|
|
138
|
+
@client.request(
|
|
139
|
+
method: :delete,
|
|
140
|
+
path: [
|
|
141
|
+
"ai/memory/namespaces/%1$s/profiles/%2$s/sources/%3$s",
|
|
142
|
+
namespace,
|
|
143
|
+
profile_id,
|
|
144
|
+
source_id
|
|
145
|
+
],
|
|
146
|
+
model: Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse,
|
|
147
|
+
options: options
|
|
148
|
+
)
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# @api private
|
|
152
|
+
#
|
|
153
|
+
# @param client [Telnyx::Client]
|
|
154
|
+
def initialize(client:)
|
|
155
|
+
@client = client
|
|
156
|
+
end
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
end
|
|
162
|
+
end
|
|
163
|
+
end
|